From 8f6b8d3664a91d8c88d7f22658b20fc5cdc0aaa6 Mon Sep 17 00:00:00 2001 From: zhengxiu Date: Tue, 25 Nov 2025 11:21:12 +0000 Subject: [PATCH] css api 25.6.0 version Reviewed-by: Pruthi, Vineet Co-authored-by: zhengxiu Co-committed-by: zhengxiu --- docs/css/api-ref/ALL_META.TXT.json | 1551 +++++++------- docs/css/api-ref/AddIndependentNode.html | 250 +-- docs/css/api-ref/CLASS.TXT.json | 960 ++++----- docs/css/api-ref/ChangeClusterSubnet.html | 87 +- docs/css/api-ref/ChangeMode.html | 137 +- docs/css/api-ref/ChangeSecurityGroup.html | 105 +- docs/css/api-ref/CreateAiOps.html | 202 +- docs/css/api-ref/CreateAutoCreatePolicy.html | 235 ++- docs/css/api-ref/CreateBindPublic.html | 240 ++- docs/css/api-ref/CreateCluster.html | 912 ++++++--- docs/css/api-ref/CreateClusterMultiRole.html | 1824 ++++++++++------- docs/css/api-ref/CreateClustersTags.html | 168 +- docs/css/api-ref/CreateElbListener.html | 129 +- docs/css/api-ref/CreateLoadIkThesaurus.html | 186 -- docs/css/api-ref/CreateLogBackup.html | 71 +- docs/css/api-ref/CreateSnapshot.html | 171 +- docs/css/api-ref/DeleteAiOps.html | 76 +- docs/css/api-ref/DeleteCluster.html | 82 +- docs/css/api-ref/DeleteClustersTags.html | 99 +- docs/css/api-ref/DeleteIkThesaurus.html | 82 - docs/css/api-ref/DeleteSnapshot.html | 100 +- docs/css/api-ref/DownloadCert.html | 59 +- docs/css/api-ref/EnableOrDisableElb.html | 151 +- docs/css/api-ref/GetRoutes.html | 239 +++ docs/css/api-ref/ListAiOps.html | 296 ++- docs/css/api-ref/ListClustersDetails.html | 1201 ++++++----- docs/css/api-ref/ListClustersTags.html | 105 +- docs/css/api-ref/ListElbCerts.html | 117 +- docs/css/api-ref/ListElbs.html | 124 +- docs/css/api-ref/ListFlavors.html | 159 +- docs/css/api-ref/ListImages.html | 214 +- docs/css/api-ref/ListLogsJob.html | 246 ++- docs/css/api-ref/ListSmnTopics.html | 67 +- docs/css/api-ref/ListSnapshots.html | 299 +-- docs/css/api-ref/ListYmls.html | 86 +- docs/css/api-ref/ListYmlsJob.html | 180 +- docs/css/api-ref/ResetPassword.html | 95 +- docs/css/api-ref/RestartCluster.html | 81 +- docs/css/api-ref/RestartClusterMultiRole.html | 104 +- docs/css/api-ref/RestoreSnapshot.html | 206 +- docs/css/api-ref/RetryUpgradeTask.html | 122 +- docs/css/api-ref/RollingRestart.html | 96 +- docs/css/api-ref/RollingRestartV2.html | 151 ++ docs/css/api-ref/ShowAutoCreatePolicy.html | 253 ++- docs/css/api-ref/ShowClusterDetail.html | 1235 ++++++----- docs/css/api-ref/ShowClusterTag.html | 110 +- docs/css/api-ref/ShowElbDetail.html | 508 +++-- docs/css/api-ref/ShowGetLogSetting.html | 377 ++-- docs/css/api-ref/ShowIkThesaurus.html | 241 --- docs/css/api-ref/ShowLogBackup.html | 255 ++- docs/css/api-ref/ShowVpcepConnection.html | 310 +-- .../css/api-ref/StartAutoCreateSnapshots.html | 159 +- docs/css/api-ref/StartAutoSetting.html | 63 +- docs/css/api-ref/StartKibanaPublic.html | 215 +- .../css/api-ref/StartLogAutoBackupPolicy.html | 97 +- docs/css/api-ref/StartLogs.html | 266 ++- docs/css/api-ref/StartPublicWhitelist.html | 86 +- .../StartTargetClusterConnectivityTest.html | 95 +- docs/css/api-ref/StartVpecp.html | 120 +- docs/css/api-ref/StopAutoCreateSnapshots.html | 72 +- docs/css/api-ref/StopLogAutoBackupPolicy.html | 75 +- docs/css/api-ref/StopLogs.html | 112 +- .../api-ref/StopPublicKibanaWhitelist.html | 69 +- docs/css/api-ref/StopPublicWhitelist.html | 69 +- docs/css/api-ref/StopSnapshot.html | 71 +- docs/css/api-ref/StopVpecp.html | 77 +- docs/css/api-ref/UpdateAlterKibana.html | 168 +- docs/css/api-ref/UpdateAzByInstanceType.html | 199 +- docs/css/api-ref/UpdateBatchClustersTags.html | 256 +-- docs/css/api-ref/UpdateCloseKibana.html | 147 +- docs/css/api-ref/UpdateClusterName.html | 126 +- docs/css/api-ref/UpdateESListener.html | 288 +-- docs/css/api-ref/UpdateExtendCluster.html | 134 +- .../api-ref/UpdateExtendInstanceStorage.html | 214 +- docs/css/api-ref/UpdateFlavor.html | 203 +- docs/css/api-ref/UpdateFlavorByType.html | 262 ++- docs/css/api-ref/UpdateInstance.html | 128 +- docs/css/api-ref/UpdateLogSetting.html | 248 ++- docs/css/api-ref/UpdatePublicBandWidth.html | 182 +- .../api-ref/UpdatePublicKibanaWhitelist.html | 88 +- docs/css/api-ref/UpdateRoute.html | 178 ++ docs/css/api-ref/UpdateShrinkCluster.html | 234 ++- docs/css/api-ref/UpdateShrinkNodes.html | 172 +- docs/css/api-ref/UpdateSnapshotSetting.html | 355 +++- docs/css/api-ref/UpdateUnbindPublic.html | 163 +- docs/css/api-ref/UpdateVpcepConnection.html | 94 +- docs/css/api-ref/UpdateVpcepWhitelist.html | 86 +- docs/css/api-ref/UpdateYmls.html | 225 +- docs/css/api-ref/UpgradeCore.html | 208 +- docs/css/api-ref/UpgradeDetail.html | 477 +++-- docs/css/api-ref/cluster_management.html | 60 +- docs/css/api-ref/cluster_management_0.html | 22 + docs/css/api-ref/css_03_0001.html | 4 +- docs/css/api-ref/css_03_0024.html | 9 +- docs/css/api-ref/css_03_0057.html | 413 ++-- docs/css/api-ref/css_03_0062.html | 4 +- docs/css/api-ref/css_03_0071.html | 2 +- docs/css/api-ref/css_03_0076.html | 30 +- docs/css/api-ref/css_03_0078.html | 6 +- ...0000002083557490.html => css_03_0095.html} | 4 +- docs/css/api-ref/css_03_0101.html | 5 +- docs/css/api-ref/css_03_0102.html | 17 + .../{css_03_0097.html => css_03_0105.html} | 13 +- .../api-ref/en-us_image_0000002105031992.png | Bin 22186 -> 0 bytes .../api-ref/en-us_image_0000002119117513.png | Bin 17384 -> 0 bytes .../api-ref/en-us_image_0000002396491200.png | Bin 0 -> 27793 bytes .../api-ref/en-us_image_0000002396499922.png | Bin 0 -> 6937 bytes .../api-ref/en-us_image_0000002426197049.png | Bin 0 -> 39758 bytes docs/css/api-ref/intelligent_maintenance.html | 2 +- .../api-ref/kibana_public_network_access.html | 2 +- docs/css/api-ref/log_management.html | 6 +- docs/css/api-ref/public_network_access.html | 2 +- docs/css/api-ref/snapshot_management.html | 12 +- docs/css/api-ref/snapshot_management_0.html | 18 + docs/css/api-ref/thesaurus_management.html | 20 - ...ic_300000010.html => topic_300000011.html} | 8 +- docs/css/api-ref/vpecp_management.html | 2 +- docs/css/api-ref/ymls_management.html | 2 +- 118 files changed, 13333 insertions(+), 9165 deletions(-) delete mode 100644 docs/css/api-ref/CreateLoadIkThesaurus.html delete mode 100644 docs/css/api-ref/DeleteIkThesaurus.html create mode 100644 docs/css/api-ref/GetRoutes.html create mode 100644 docs/css/api-ref/RollingRestartV2.html delete mode 100644 docs/css/api-ref/ShowIkThesaurus.html create mode 100644 docs/css/api-ref/UpdateRoute.html create mode 100644 docs/css/api-ref/cluster_management_0.html rename docs/css/api-ref/{en-us_topic_0000002083557490.html => css_03_0095.html} (56%) create mode 100644 docs/css/api-ref/css_03_0102.html rename docs/css/api-ref/{css_03_0097.html => css_03_0105.html} (74%) delete mode 100644 docs/css/api-ref/en-us_image_0000002105031992.png delete mode 100644 docs/css/api-ref/en-us_image_0000002119117513.png create mode 100644 docs/css/api-ref/en-us_image_0000002396491200.png create mode 100644 docs/css/api-ref/en-us_image_0000002396499922.png create mode 100644 docs/css/api-ref/en-us_image_0000002426197049.png create mode 100644 docs/css/api-ref/snapshot_management_0.html delete mode 100644 docs/css/api-ref/thesaurus_management.html rename docs/css/api-ref/{topic_300000010.html => topic_300000011.html} (91%) diff --git a/docs/css/api-ref/ALL_META.TXT.json b/docs/css/api-ref/ALL_META.TXT.json index 45dfd0d81..5014e5e84 100644 --- a/docs/css/api-ref/ALL_META.TXT.json +++ b/docs/css/api-ref/ALL_META.TXT.json @@ -26,7 +26,7 @@ "node_id":"css_03_0057.xml", "product_code":"css", "code":"2", - "des":"CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 1 by calling the corresponding APIs.", + "des":"CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 2 by calling the corresponding APIs.Some APIs of V2 have been release", "doc_type":"api", "kw":"API Overview,API Reference", "search_title":"", @@ -64,7 +64,7 @@ "node_id":"css_03_0078.xml", "product_code":"css", "code":"4", - "des":"This section describes the structure of a RESTful API request, and uses the IAM API for obtain a user token as an example to describe how to call an API.A request URI is ", + "des":"This section describes the structure of a RESTful API request, and uses the IAM API for obtaining a user token as an example to describe how to call an API.A request URI ", "doc_type":"api", "kw":"Making an API Request,Calling APIs,API Reference", "search_title":"", @@ -117,13 +117,13 @@ "githuburl":"" }, { - "uri":"css_03_0097.html", - "node_id":"css_03_0097.xml", + "uri":"css_03_0102.html", + "node_id":"css_03_0102.xml", "product_code":"css", "code":"7", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"APIs", + "kw":"API V2", "search_title":"", "metedata":[ { @@ -132,12 +132,12 @@ "opensource":"true" } ], - "title":"APIs", + "title":"API V2", "githuburl":"" }, { - "uri":"cluster_management.html", - "node_id":"cluster_management.xml", + "uri":"cluster_management_0.html", + "node_id":"cluster_management_0.xml", "product_code":"css", "code":"8", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -146,10 +146,189 @@ "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;RollingRestartV2;StartAutoCreateSnapshots;StopAutoCreateSnapshots;DeleteConfNew;DeleteTemplateNew" + } + ], + "title":"Cluster Management", + "githuburl":"" + }, + { + "uri":"CreateClusterMultiRole.html", + "node_id":"createclustermultirole.xml", + "product_code":"css", + "code":"9", + "des":"This API is used to create a cluster that uses multiple different types of nodes. The cluster engine type can be Elasticsearch, OpenSearch, or Logstash.An Elasticsearch c", + "doc_type":"api", + "kw":"Creating a Cluster (V2),Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;RollingRestartV2;StartAutoCreateSnapshots;StopAutoCreateSnapshots;DeleteConfNew;DeleteTemplateNew" + } + ], + "title":"Creating a Cluster (V2)", + "githuburl":"" + }, + { + "uri":"RestartClusterMultiRole.html", + "node_id":"restartclustermultirole.xml", + "product_code":"css", + "code":"10", + "des":"This API is used to restart nodes of all or some types in the current cluster.For details, see Calling APIs.POST /v2.0/{project_id}/clusters/{cluster_id}/restartStatus co", + "doc_type":"api", + "kw":"Restarting a Cluster (V2),Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;RollingRestartV2;StartAutoCreateSnapshots;StopAutoCreateSnapshots;DeleteConfNew;DeleteTemplateNew" + } + ], + "title":"Restarting a Cluster (V2)", + "githuburl":"" + }, + { + "uri":"RollingRestart.html", + "node_id":"rollingrestart.xml", + "product_code":"css", + "code":"11", + "des":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.For details, see Calling APIs.POST /v2.0/{project_i", + "doc_type":"api", + "kw":"Rolling Restart (Deprecated),Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;RollingRestartV2;StartAutoCreateSnapshots;StopAutoCreateSnapshots;DeleteConfNew;DeleteTemplateNew" + } + ], + "title":"Rolling Restart (Deprecated)", + "githuburl":"" + }, + { + "uri":"RollingRestartV2.html", + "node_id":"rollingrestartv2.xml", + "product_code":"css", + "code":"12", + "des":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.For details, see Calling APIs.POST /v2.0/{project_i", + "doc_type":"api", + "kw":"Rolling Restart,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;RollingRestartV2;StartAutoCreateSnapshots;StopAutoCreateSnapshots;DeleteConfNew;DeleteTemplateNew" + } + ], + "title":"Rolling Restart", + "githuburl":"" + }, + { + "uri":"snapshot_management_0.html", + "node_id":"snapshot_management_0.xml", + "product_code":"css", + "code":"13", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Snapshot Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;RollingRestartV2;StartAutoCreateSnapshots;StopAutoCreateSnapshots;DeleteConfNew;DeleteTemplateNew" + } + ], + "title":"Snapshot Management", + "githuburl":"" + }, + { + "uri":"StartAutoCreateSnapshots.html", + "node_id":"startautocreatesnapshots.xml", + "product_code":"css", + "code":"14", + "des":"CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the clu", + "doc_type":"api", + "kw":"Enabling Automatic Snapshot Creation,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;RollingRestartV2;StartAutoCreateSnapshots;StopAutoCreateSnapshots;DeleteConfNew;DeleteTemplateNew" + } + ], + "title":"Enabling Automatic Snapshot Creation", + "githuburl":"" + }, + { + "uri":"StopAutoCreateSnapshots.html", + "node_id":"stopautocreatesnapshots.xml", + "product_code":"css", + "code":"15", + "des":"CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the clu", + "doc_type":"api", + "kw":"Disabling Automatic Snapshot Creation,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;RollingRestartV2;StartAutoCreateSnapshots;StopAutoCreateSnapshots;DeleteConfNew;DeleteTemplateNew" + } + ], + "title":"Disabling Automatic Snapshot Creation", + "githuburl":"" + }, + { + "uri":"css_03_0105.html", + "node_id":"css_03_0105.xml", + "product_code":"css", + "code":"16", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API V1", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true" + } + ], + "title":"API V1", + "githuburl":"" + }, + { + "uri":"cluster_management.html", + "node_id":"cluster_management.xml", + "product_code":"css", + "code":"17", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Cluster Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Cluster Management", @@ -159,320 +338,140 @@ "uri":"CreateCluster.html", "node_id":"createcluster.xml", "product_code":"css", - "code":"9", - "des":"This API is used to create a cluster.POST /v1.0/{project_id}/clustersStatus code: 200Example request for creating a pay-per-use cluster.Status code: 200Request succeeded.", + "code":"18", + "des":"This API can only be used to create clusters that contain a single type of nodes. To create clusters that contain multiple types of nodes (ess, ess-cold, ess-client, and ", "doc_type":"api", - "kw":"Creating a cluster,Cluster Management,API Reference", + "kw":"Creating a Cluster (Discarded),Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Creating a cluster", - "githuburl":"" - }, - { - "uri":"ListClustersDetails.html", - "node_id":"listclustersdetails.xml", - "product_code":"css", - "code":"10", - "des":"This API is used to query and display the cluster list and cluster status.GET /v1.0/{project_id}/clustersNoneStatus code: 200Query the first two clusters.- Method 1: GET ", - "doc_type":"api", - "kw":"Querying the Cluster List,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Querying the Cluster List", - "githuburl":"" - }, - { - "uri":"ShowClusterDetail.html", - "node_id":"showclusterdetail.xml", - "product_code":"css", - "code":"11", - "des":"This API is used to query and display the details of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200Whether the details of a cluster are obtain", - "doc_type":"api", - "kw":"Querying Cluster Details,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Querying Cluster Details", - "githuburl":"" - }, - { - "uri":"DeleteCluster.html", - "node_id":"deletecluster.xml", - "product_code":"css", - "code":"12", - "des":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluste", - "doc_type":"api", - "kw":"Deleting a Cluster,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Deleting a Cluster", - "githuburl":"" - }, - { - "uri":"UpdateClusterName.html", - "node_id":"updateclustername.xml", - "product_code":"css", - "code":"13", - "des":"This API is used to change the name of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameNoneChange the display name of the current cluster.NoneSee Error ", - "doc_type":"api", - "kw":"Renaming a Cluster,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Renaming a Cluster", - "githuburl":"" - }, - { - "uri":"ResetPassword.html", - "node_id":"resetpassword.xml", - "product_code":"css", - "code":"14", - "des":"This API is used to change the password of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneChange the administrator password of the current clus", - "doc_type":"api", - "kw":"Changing the Password of a Cluster,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Changing the Password of a Cluster", - "githuburl":"" - }, - { - "uri":"RestartCluster.html", - "node_id":"restartcluster.xml", - "product_code":"css", - "code":"15", - "des":"This API is used to restart a data node in a cluster, which will interrupt services. To restart all nodes in a cluster, you are advised to use [Restart Cluster V2] (Resta", - "doc_type":"api", - "kw":"Restarting a Cluster (Deprecated),Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Restarting a Cluster (Deprecated)", - "githuburl":"" - }, - { - "uri":"UpdateExtendCluster.html", - "node_id":"updateextendcluster.xml", - "product_code":"css", - "code":"16", - "des":"This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters wit", - "doc_type":"api", - "kw":"Scaling Out a Cluster,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Scaling Out a Cluster", + "title":"Creating a Cluster (Discarded)", "githuburl":"" }, { "uri":"UpdateExtendInstanceStorage.html", "node_id":"updateextendinstancestorage.xml", "product_code":"css", - "code":"17", + "code":"19", "des":"This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold da", "doc_type":"api", "kw":"Adding Instances and Expanding Instance Storage Capacity,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Adding Instances and Expanding Instance Storage Capacity", "githuburl":"" }, + { + "uri":"ListClustersDetails.html", + "node_id":"listclustersdetails.xml", + "product_code":"css", + "code":"20", + "des":"This API is used to query the cluster list and cluster status, including cluster nodes, Kibana public network access information, public network IP address, and IPv4 addr", + "doc_type":"api", + "kw":"Querying the Cluster List,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Querying the Cluster List", + "githuburl":"" + }, + { + "uri":"AddIndependentNode.html", + "node_id":"addindependentnode.xml", + "product_code":"css", + "code":"21", + "des":"This API is used to add dedicated master and client nodes to an existing cluster that previously does not have such nodes.For details, see Calling APIs.POST /v1.0/{projec", + "doc_type":"api", + "kw":"Adding Independent Masters and Clients,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Adding Independent Masters and Clients", + "githuburl":"" + }, + { + "uri":"ShowClusterDetail.html", + "node_id":"showclusterdetail.xml", + "product_code":"css", + "code":"22", + "des":"This API is used to query and display details about a single cluster, including the cluster's search type, node list, network information, cluster name, cluster ID, and c", + "doc_type":"api", + "kw":"Querying Cluster Details,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Querying Cluster Details", + "githuburl":"" + }, { "uri":"UpdateFlavor.html", "node_id":"updateflavor.xml", "product_code":"css", - "code":"18", - "des":"This API is used to modify the specifications of a cluster. Only the nodes of the ESS type can be modified.POST /v1.0/{project_id}/clusters/{cluster_id}/flavorNonePOST /v", - "doc_type":"api", - "kw":"Changing Specifications,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Changing Specifications", - "githuburl":"" - }, - { - "uri":"ListFlavors.html", - "node_id":"listflavors.xml", - "product_code":"css", - "code":"19", - "des":"This API is used to query and display the IDs of supported instance specifications.GET /v1.0/{project_id}/es-flavorsNoneStatus code: 200Obtain the specifications of all i", - "doc_type":"api", - "kw":"Obtaining the Instance Specifications List,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Obtaining the Instance Specifications List", - "githuburl":"" - }, - { - "uri":"ListClustersTags.html", - "node_id":"listclusterstags.xml", - "product_code":"css", - "code":"20", - "des":"This API is used to query all tags in a specified region.GET /v1.0/{project_id}/{resource_type}/tagsNoneStatus code: 200Query all CSS cluster tags in a project.Status cod", - "doc_type":"api", - "kw":"Querying All Tags,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Querying All Tags", - "githuburl":"" - }, - { - "uri":"ShowClusterTag.html", - "node_id":"showclustertag.xml", - "product_code":"css", - "code":"21", - "des":"This API is used to query the tags of a specified cluster.GET /v1.0/{project_id}/{resource_type}/{cluster_id}/tagsNoneStatus code: 200Query the tags of a cluster.Status c", - "doc_type":"api", - "kw":"Querying Tags of a Specified Cluster,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Querying Tags of a Specified Cluster", - "githuburl":"" - }, - { - "uri":"CreateClustersTags.html", - "node_id":"createclusterstags.xml", - "product_code":"css", - "code":"22", - "des":"This API is used to add tags to a cluster.POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tagsNoneCreate a cluster tag.NoneSee Error Codes.", - "doc_type":"api", - "kw":"Adding Tags to a Cluster,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Adding Tags to a Cluster", - "githuburl":"" - }, - { - "uri":"DeleteClustersTags.html", - "node_id":"deleteclusterstags.xml", - "product_code":"css", "code":"23", - "des":"This API is used to delete a cluster tag.DELETE /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/{key}NoneNoneNoneNoneSee Error Codes.", + "des":"This API is used to modify the node specifications of a cluster. It can only change the specifications of ess nodes (data nodes). If you need to change other types of nod", "doc_type":"api", - "kw":"Deleting a Cluster Tag,Cluster Management,API Reference", + "kw":"Changing Node Specifications (Discarded),Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Deleting a Cluster Tag", + "title":"Changing Node Specifications (Discarded)", "githuburl":"" }, { - "uri":"UpdateBatchClustersTags.html", - "node_id":"updatebatchclusterstags.xml", + "uri":"DeleteCluster.html", + "node_id":"deletecluster.xml", "product_code":"css", "code":"24", - "des":"This API is used to add tags to or delete tags from a cluster in batches.POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/actionNoneCreate or delete cluster tags", + "des":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluste", "doc_type":"api", - "kw":"Adding or Deleting Cluster Tags in Batches,Cluster Management,API Reference", + "kw":"Deleting a Cluster,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Adding or Deleting Cluster Tags in Batches", + "title":"Deleting a Cluster", "githuburl":"" }, { @@ -480,16 +479,16 @@ "node_id":"updateshrinknodes.xml", "product_code":"css", "code":"25", - "des":"This API is used to scale in a cluster by removing a specified node. Yearly/Monthly clusters do not support the removal of specified nodes by calling this API.POST /v1.0/", + "des":"During a scale-in, the data on the to-be-removed nodes needs to be migrated to the remaining nodes. The timeout for data migration per node is 48 hours. Scale-in will fai", "doc_type":"api", "kw":"Scaling In a Cluster by Removing a Specific Node,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Scaling In a Cluster by Removing a Specific Node", @@ -500,136 +499,236 @@ "node_id":"updateflavorbytype.xml", "product_code":"css", "code":"26", - "des":"This API is used to modify cluster specifications. Supported node types:ess: data nodeess: data nodeess-cold: cold data nodeess-cold: cold data nodeess-client: client nod", + "des":"If the workloads on a cluster's data plane change, you can scale the cluster vertically by changing its node specifications or node storage type.Cluster types that suppor", "doc_type":"api", "kw":"Change the specifications of a specified node type.,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Change the specifications of a specified node type.", "githuburl":"" }, + { + "uri":"UpdateClusterName.html", + "node_id":"updateclustername.xml", + "product_code":"css", + "code":"27", + "des":"This API is used to change cluster names.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameStatus code: 200Request succeeded.NoneChang", + "doc_type":"api", + "kw":"Renaming a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Renaming a Cluster", + "githuburl":"" + }, { "uri":"UpdateShrinkCluster.html", "node_id":"updateshrinkcluster.xml", "product_code":"css", - "code":"27", - "des":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster. Yearly/Monthly clusters do not support the removal of specified ", + "code":"28", + "des":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster.All mission-critical data has been backed up before a cluster sca", "doc_type":"api", "kw":"Scaling In Nodes of a Specific Type,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Scaling In Nodes of a Specific Type", "githuburl":"" }, { - "uri":"DownloadCert.html", - "node_id":"downloadcert.xml", + "uri":"ResetPassword.html", + "node_id":"resetpassword.xml", "product_code":"css", - "code":"28", - "des":"This API is used to download a security certificate.GET /v1.0/{project_id}/cer/downloadNoneStatus code: 200Download the security certificate.Status code: 200Request succe", + "code":"29", + "des":"This API is used to change cluster passwords to enhance cluster security.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetStatus ", "doc_type":"api", - "kw":"Downloading a Security Certificate,Cluster Management,API Reference", + "kw":"Changing the Password of a Cluster,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Downloading a Security Certificate", + "title":"Changing the Password of a Cluster", "githuburl":"" }, { "uri":"UpdateInstance.html", "node_id":"updateinstance.xml", "product_code":"css", - "code":"29", - "des":"This API is used to replace a failed node.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replaceNoneNoneNoneSee Error Codes.", + "code":"30", + "des":"This API is used to replace a failed node.If a node in an Elasticsearch cluster is faulty, you can replace it to restore services.The node replacement process is as follo", "doc_type":"api", "kw":"Replacing a Node,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Replacing a Node", "githuburl":"" }, + { + "uri":"RestartCluster.html", + "node_id":"restartcluster.xml", + "product_code":"css", + "code":"31", + "des":"This API is used to restart a data node in a cluster, which will interrupt services. To restart all nodes in a cluster, you are advised to use [Restart Cluster V2] (Resta", + "doc_type":"api", + "kw":"Restarting a Cluster (Deprecated),Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Restarting a Cluster (Deprecated)", + "githuburl":"" + }, { "uri":"ChangeMode.html", "node_id":"changemode.xml", "product_code":"css", - "code":"30", - "des":"This API is used to configure the security mode of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/mode/changeNoneChange the security mode of the current cluster.", + "code":"32", + "des":"This API is used to configure the security mode of a cluster. The security mode settings for clusters include:Security mode + HTTP: strikes a balance between performance ", "doc_type":"api", "kw":"Configuring the Security Mode.,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Configuring the Security Mode.", "githuburl":"" }, { - "uri":"AddIndependentNode.html", - "node_id":"addindependentnode.xml", + "uri":"UpdateExtendCluster.html", + "node_id":"updateextendcluster.xml", "product_code":"css", - "code":"31", - "des":"This API is used to add dedicated master and client nodes to an existing cluster that previously does not have such nodes.POST /v1.0/{project_id}/clusters/{cluster_id}/ty", + "code":"33", + "des":"This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters wit", "doc_type":"api", - "kw":"Adding Independent Masters and Clients,Cluster Management,API Reference", + "kw":"Scaling Out a Cluster (Discarded),Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Adding Independent Masters and Clients", + "title":"Scaling Out a Cluster (Discarded)", + "githuburl":"" + }, + { + "uri":"ListFlavors.html", + "node_id":"listflavors.xml", + "product_code":"css", + "code":"34", + "des":"This API is used to obtain the node specifications, including the node specifications version, cluster data search engine, number of vCPUs per node, and node memory size.", + "doc_type":"api", + "kw":"Obtaining the Instance Specifications List,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Obtaining the Instance Specifications List", + "githuburl":"" + }, + { + "uri":"DownloadCert.html", + "node_id":"downloadcert.xml", + "product_code":"css", + "code":"35", + "des":"The certificate obtained through this API can be used for HTTPS-based secure cluster connections, where encryption and user authentication occur.For details, see Calling ", + "doc_type":"api", + "kw":"Downloading a Security Certificate,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Downloading a Security Certificate", + "githuburl":"" + }, + { + "uri":"ListClustersTags.html", + "node_id":"listclusterstags.xml", + "product_code":"css", + "code":"36", + "des":"This API is used to query all tags of a user in the current project, including the keys and values. This facilitates tag management by group.For details, see Calling APIs", + "doc_type":"api", + "kw":"Querying All Tags,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Querying All Tags", "githuburl":"" }, { "uri":"UpgradeCore.html", "node_id":"upgradecore.xml", "product_code":"css", - "code":"32", - "des":"This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_typ", + "code":"37", + "des":"This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{c", "doc_type":"api", "kw":"Upgrading a Cluster Kernel,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Upgrading a Cluster Kernel", @@ -639,17 +738,17 @@ "uri":"ListImages.html", "node_id":"listimages.xml", "product_code":"css", - "code":"33", - "des":"This API is used to obtain the ID of an image that can be upgraded in the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/imagesNoneSta", + "code":"38", + "des":"This API is used to obtain the IDs of target images the current cluster can be upgraded to. The upgrade types are as follows:During a same-version upgrade, kernel patches", "doc_type":"api", "kw":"Obtaining the ID of the Target Image to Upgrade To,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Obtaining the ID of the Target Image to Upgrade To", @@ -659,257 +758,237 @@ "uri":"UpgradeDetail.html", "node_id":"upgradedetail.xml", "product_code":"css", - "code":"34", - "des":"The upgrade may take a long time. This API can be used to check phase-by-phase information during a cluster upgrade or AZ switchover.GET /v1.0/{project_id}/clusters/{clus", + "code":"39", + "des":"By deploying a CSS cluster across multiple AZs, you can increase the cluster's availability, lower the likelihood of data loss, and minimize service downtime. You can dep", "doc_type":"api", "kw":"Obtaining Details About a Cluster Upgrade or AZ Switchover,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Obtaining Details About a Cluster Upgrade or AZ Switchover", "githuburl":"" }, + { + "uri":"ShowClusterTag.html", + "node_id":"showclustertag.xml", + "product_code":"css", + "code":"40", + "des":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources. You can add tags to a cluster when creating a cluster or add them on ", + "doc_type":"api", + "kw":"Querying Tags of a Specified Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Querying Tags of a Specified Cluster", + "githuburl":"" + }, { "uri":"RetryUpgradeTask.html", "node_id":"retryupgradetask.xml", "product_code":"css", - "code":"35", - "des":"The upgrade may fail due to network problems. In this case, you can call this API to retry.PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retryNoneNoneE", + "code":"41", + "des":"The upgrade may fail due to network problems. In this case, you can call this API to retry.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/upgr", "doc_type":"api", "kw":"Retrying a Failed Upgrade Task,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Retrying a Failed Upgrade Task", "githuburl":"" }, + { + "uri":"CreateClustersTags.html", + "node_id":"createclusterstags.xml", + "product_code":"css", + "code":"42", + "des":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources.You can add tags to a cluster when creating a cluster or add them on t", + "doc_type":"api", + "kw":"Adding Tags to a Cluster,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Adding Tags to a Cluster", + "githuburl":"" + }, { "uri":"ChangeSecurityGroup.html", "node_id":"changesecuritygroup.xml", "product_code":"css", - "code":"36", - "des":"This API is used to change the security group after a cluster is created.POST /v1.0/{project_id}/clusters/{cluster_id}/sg/changeNoneChange the security group that the cur", + "code":"43", + "des":"This API is used to change the security group after a cluster is created.Before changing the security group, ensure that port 9200 has been enabled. Incorrect security gr", "doc_type":"api", "kw":"Changing the Security Group,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Changing the Security Group", "githuburl":"" }, + { + "uri":"DeleteClustersTags.html", + "node_id":"deleteclusterstags.xml", + "product_code":"css", + "code":"44", + "des":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources.You can add tags to a cluster when creating a cluster or add them on t", + "doc_type":"api", + "kw":"Deleting a Cluster Tag,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Deleting a Cluster Tag", + "githuburl":"" + }, { "uri":"ChangeClusterSubnet.html", "node_id":"changeclustersubnet.xml", "product_code":"css", - "code":"37", - "des":"This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.POST /v1.0/{project_id}/clusters/{cluster_id}", + "code":"45", + "des":"This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.For details, see Calling APIs.POST /v1.0/{pro", "doc_type":"api", "kw":"Changing the Subnet of a Cluster,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Changing the Subnet of a Cluster", "githuburl":"" }, + { + "uri":"UpdateBatchClustersTags.html", + "node_id":"updatebatchclusterstags.xml", + "product_code":"css", + "code":"46", + "des":"This API is used to add or delete tags in batches for Elasticsearch, Logstash, and OpenSearch clusters.For details, see Calling APIs.POST /v1.0/{project_id}/{resource_typ", + "doc_type":"api", + "kw":"Adding or Deleting Cluster Tags in Batches,Cluster Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Adding or Deleting Cluster Tags in Batches", + "githuburl":"" + }, { "uri":"UpdateAzByInstanceType.html", "node_id":"updateazbyinstancetype.xml", "product_code":"css", - "code":"38", - "des":"This API is used to change the AZ by specifying node types.POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/azmigrateNoneSwitch the AZ of the current c", + "code":"47", + "des":"An availability zone (AZ) is a physical region where resources use independent power supplies and networks. AZs in the same region can communicate with each other through", "doc_type":"api", - "kw":"Changing the AZ of a Cluster Instance,Cluster Management,API Reference", + "kw":"Changing AZs for a Cluster Instance,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Changing the AZ of a Cluster Instance", + "title":"Changing AZs for a Cluster Instance", "githuburl":"" }, { - "uri":"CreateClusterMultiRole.html", - "node_id":"createclustermultirole.xml", + "uri":"UpdateRoute.html", + "node_id":"updateroute.xml", "product_code":"css", - "code":"39", - "des":"This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, ess-master).POST /v2.0/{project_id}/clustersStatus code: 200Example", + "code":"48", + "des":"This interface is used to update a cluster route.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/routeStatus code: 200Request succeeded.NoneUp", "doc_type":"api", - "kw":"Creating a Cluster (V2),Cluster Management,API Reference", + "kw":"Updating Cluster Routes,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Creating a Cluster (V2)", + "title":"Updating Cluster Routes", "githuburl":"" }, { - "uri":"RestartClusterMultiRole.html", - "node_id":"restartclustermultirole.xml", + "uri":"GetRoutes.html", + "node_id":"getroutes.xml", "product_code":"css", - "code":"40", - "des":"This API is used to restart nodes of all or some types in the current cluster.POST /v2.0/{project_id}/clusters/{cluster_id}/restartNoneRestart nodes of all or some types ", + "code":"49", + "des":"By default, a CSS Elasticsearch cluster cannot access a target service—such as a client program or a Lightweight Directory Access Protocol (LDAP) service—that is located ", "doc_type":"api", - "kw":"Restarting a Cluster (V2),Cluster Management,API Reference", + "kw":"Obtaining a Cluster Route,Cluster Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Restarting a Cluster (V2)", - "githuburl":"" - }, - { - "uri":"RollingRestart.html", - "node_id":"rollingrestart.xml", - "product_code":"css", - "code":"41", - "des":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.POST /v2.0/{project_id}/clusters/{cluster_id}/rolli", - "doc_type":"api", - "kw":"Rolling Restart,Cluster Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Rolling Restart", - "githuburl":"" - }, - { - "uri":"thesaurus_management.html", - "node_id":"thesaurus_management.xml", - "product_code":"css", - "code":"42", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Word Dictionary Management", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Word Dictionary Management", - "githuburl":"" - }, - { - "uri":"CreateLoadIkThesaurus.html", - "node_id":"createloadikthesaurus.xml", - "product_code":"css", - "code":"43", - "des":"This API is used to load a custom word dictionary stored in OBS.POST /v1.0/{project_id}/clusters/{cluster_id}/thesaurusNoneEnable and configure the word dictionary.NoneSe", - "doc_type":"api", - "kw":"Loading Custom Word Dictionaries,Word Dictionary Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Loading Custom Word Dictionaries", - "githuburl":"" - }, - { - "uri":"ShowIkThesaurus.html", - "node_id":"showikthesaurus.xml", - "product_code":"css", - "code":"44", - "des":"This API is used to query the loading status of a custom word dictionary.GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurusNoneStatus code: 200Query the loading statu", - "doc_type":"api", - "kw":"Querying the Status of a Custom Word Dictionary,Word Dictionary Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Querying the Status of a Custom Word Dictionary", - "githuburl":"" - }, - { - "uri":"DeleteIkThesaurus.html", - "node_id":"deleteikthesaurus.xml", - "product_code":"css", - "code":"45", - "des":"This API is used to clear custom word dictionaries (main word dictionary, stop word dictionary, and synonym dictionary).DELETE /v1.0/{project_id}/clusters/{cluster_id}/th", - "doc_type":"api", - "kw":"Disabling a Word Dictionary,Word Dictionary Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Disabling a Word Dictionary", + "title":"Obtaining a Cluster Route", "githuburl":"" }, { "uri":"kibana_public_network_access.html", "node_id":"kibana_public_network_access.xml", "product_code":"css", - "code":"46", + "code":"50", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Kibana Public Network Access", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Kibana Public Network Access", @@ -919,17 +998,17 @@ "uri":"StartKibanaPublic.html", "node_id":"startkibanapublic.xml", "product_code":"css", - "code":"47", - "des":"This API is used to enable public network access to Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openNoneNoneSee Error Codes.", + "code":"51", + "des":"This API is used to enable public network access to Kibana.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openStatus code: 200Re", "doc_type":"api", "kw":"Enabling Kibana Public Access,Kibana Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Enabling Kibana Public Access", @@ -939,17 +1018,17 @@ "uri":"UpdateCloseKibana.html", "node_id":"updateclosekibana.xml", "product_code":"css", - "code":"48", - "des":"This API is used to disable public network access to Kibana. Kibana public network access cannot be disabled for yearly/monthly clusters by calling this API.PUT /v1.0/{pr", + "code":"52", + "des":"This API is used to disable public network access to Kibana.If you disable Kibana public network access and then re-enable it, the public IP address for accessing Kibana ", "doc_type":"api", "kw":"Disabling Kibana Public Access,Kibana Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Disabling Kibana Public Access", @@ -959,17 +1038,17 @@ "uri":"UpdateAlterKibana.html", "node_id":"updatealterkibana.xml", "product_code":"css", - "code":"49", - "des":"This API is used to modify the public network bandwidth of Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthNoneModify the Kibana public network", + "code":"53", + "des":"This API is used to modify the public network bandwidth of Kibana.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthStatus", "doc_type":"api", "kw":"Modifying the Kibana Public Network Bandwidth,Kibana Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Modifying the Kibana Public Network Bandwidth", @@ -979,17 +1058,17 @@ "uri":"UpdatePublicKibanaWhitelist.html", "node_id":"updatepublickibanawhitelist.xml", "product_code":"css", - "code":"50", - "des":"This API is used to modify the Kibana access permission by modifying the Kibana whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/updateNoneT", + "code":"54", + "des":"This API is used to modify the Kibana access permission by modifying the Kibana whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publ", "doc_type":"api", "kw":"Modifying Kibana Public Access Control,Kibana Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Modifying Kibana Public Access Control", @@ -999,17 +1078,17 @@ "uri":"StopPublicKibanaWhitelist.html", "node_id":"stoppublickibanawhitelist.xml", "product_code":"css", - "code":"51", - "des":"This API is used to disable public network access control for Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/closeNoneNoneNoneNoneSee Error Co", + "code":"55", + "des":"This API is used to disable public network access control for Kibana.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/clo", "doc_type":"api", "kw":"Disabling Kibana Public Network Access Control,Kibana Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Disabling Kibana Public Network Access Control", @@ -1019,17 +1098,17 @@ "uri":"log_management.html", "node_id":"log_management.xml", "product_code":"css", - "code":"52", + "code":"56", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Log Management", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Log Management", @@ -1039,57 +1118,57 @@ "uri":"StartLogs.html", "node_id":"startlogs.xml", "product_code":"css", - "code":"53", - "des":"This API is used to enable the log function.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneEnable the log function.POST /v1.0/6204a5bd270343b5885144cf9c8c158d", + "code":"57", + "des":"This API is used to enable log backup or log ingestion for a cluster. Log backup and log ingestion can be enabled separately. After log backup is enabled, you can configu", "doc_type":"api", - "kw":"Enabling the Log Function,Log Management,API Reference", + "kw":"Enabling Log Backup or Log Collection,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Enabling the Log Function", + "title":"Enabling Log Backup or Log Collection", "githuburl":"" }, { "uri":"StopLogs.html", "node_id":"stoplogs.xml", "product_code":"css", - "code":"54", - "des":"This API is used to disable the log function.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNoneNoneNoneNoneSee Error Codes.", + "code":"58", + "des":"This API is used to disable log backup or log ingestion for a cluster. Log backup and log ingestion can be disabled separately. After log backup is disabled, any automati", "doc_type":"api", - "kw":"Disabling the Log Function,Log Management,API Reference", + "kw":"Disabling the Log Backup or Collection Function,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Disabling the Log Function", + "title":"Disabling the Log Backup or Collection Function", "githuburl":"" }, { "uri":"ListLogsJob.html", "node_id":"listlogsjob.xml", "product_code":"css", - "code":"55", - "des":"This API is used to query the log backup task list of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/recordsNoneStatus code: 200Querying the First 10 Log Bac", + "code":"59", + "des":"This API is used to query the log backup task list of a cluster. To be able to use this API, the target cluster must have log backup enabled, and log backup tasks were tr", "doc_type":"api", "kw":"Querying the Log Backup Task List,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Querying the Log Backup Task List", @@ -1099,17 +1178,17 @@ "uri":"ShowGetLogSetting.html", "node_id":"showgetlogsetting.xml", "product_code":"css", - "code":"56", - "des":"This API is used to query basic cluster log configurations.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneStatus code: 200Query basic cluster log configura", + "code":"60", + "des":"This API is used to query the basic configuration of cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the ", "doc_type":"api", "kw":"Querying Basic Log Configurations,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Querying Basic Log Configurations", @@ -1119,17 +1198,17 @@ "uri":"UpdateLogSetting.html", "node_id":"updatelogsetting.xml", "product_code":"css", - "code":"57", - "des":"This API is used to modify basic log configurations.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneModify basic log configurations.POST /v1.0/6204a5bd2703", + "code":"61", + "des":"This API is used to modify basic configurations for cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the c", "doc_type":"api", "kw":"Modifying Basic Log Configurations,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Modifying Basic Log Configurations", @@ -1139,17 +1218,17 @@ "uri":"StartLogAutoBackupPolicy.html", "node_id":"startlogautobackuppolicy.xml", "product_code":"css", - "code":"58", - "des":"This API is used to enable the automatic log backup policy.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/updateNoneEnable the automatic log backup policy.None", + "code":"62", + "des":"CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.Log ", "doc_type":"api", "kw":"Enabling the Automatic Log Backup Policy,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Enabling the Automatic Log Backup Policy", @@ -1159,17 +1238,17 @@ "uri":"StopLogAutoBackupPolicy.html", "node_id":"stoplogautobackuppolicy.xml", "product_code":"css", - "code":"59", - "des":"This API is used to disable the automatic log backup policy.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/closeNoneNoneNoneNoneSee Error Codes.", + "code":"63", + "des":"CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.Log ", "doc_type":"api", "kw":"Disabling the Automatic Log Backup Policy,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Disabling the Automatic Log Backup Policy", @@ -1179,17 +1258,17 @@ "uri":"CreateLogBackup.html", "node_id":"createlogbackup.xml", "product_code":"css", - "code":"60", - "des":"This API is used to back up logs.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneNoneSee Error Codes.", + "code":"64", + "des":"This API is used to back up logs. If log backup is enabled for a cluster, you can call this API to back up the cluster's run logs to the specified OBS bucket. This ensure", "doc_type":"api", "kw":"Backing Up Logs,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Backing Up Logs", @@ -1199,17 +1278,17 @@ "uri":"ShowLogBackup.html", "node_id":"showlogbackup.xml", "product_code":"css", - "code":"61", - "des":"This API is used to query log information.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatus code: 200Query logs.Status code: 200Request succeeded.See Error ", + "code":"65", + "des":"CSS supports log backup and query, helping you efficiently locate issues. You can periodically back up cluster logs to OBS buckets for long-term storage, from which you d", "doc_type":"api", "kw":"Searching for Logs,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Searching for Logs", @@ -1219,17 +1298,17 @@ "uri":"StartTargetClusterConnectivityTest.html", "node_id":"starttargetclusterconnectivitytest.xml", "product_code":"css", - "code":"62", - "des":"This API is used to test connectivity.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/connectivityNoneTest connectivity to the target cluster.Status code: 200Request s", + "code":"66", + "des":"This API is used to test the connectivity between two clusters. CSS clusters provide a log collection function, allowing users to collect clusters' run logs in real time ", "doc_type":"api", "kw":"Test connectivity.,Log Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Test connectivity.", @@ -1239,17 +1318,17 @@ "uri":"public_network_access.html", "node_id":"public_network_access.xml", "product_code":"css", - "code":"63", + "code":"67", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Public Network Access", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Public Network Access", @@ -1259,17 +1338,17 @@ "uri":"CreateBindPublic.html", "node_id":"createbindpublic.xml", "product_code":"css", - "code":"64", - "des":"This API is used to enable public network access.POST /v1.0/{project_id}/clusters/{cluster_id}/public/openStatus code: 200Status code: 200Request succeeded.See Error Code", + "code":"68", + "des":"Public network access is supported only when Security Mode and HTTPS Access are enabled for a cluster. When Public IP Address is enabled, a public IP address is automatic", "doc_type":"api", "kw":"Enabling Public Network Access,Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Enabling Public Network Access", @@ -1279,17 +1358,17 @@ "uri":"UpdateUnbindPublic.html", "node_id":"updateunbindpublic.xml", "product_code":"css", - "code":"65", - "des":"This API is used to disable public network access. Public network access cannot be disabled for yearly/monthly clusters by calling this API.PUT /v1.0/{project_id}/cluster", + "code":"69", + "des":"This API is used to disable public network access.After public network access is disabled, users can no longer access the cluster via a public IP address. If you disable ", "doc_type":"api", "kw":"Disabling Public Network Access,Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Disabling Public Network Access", @@ -1299,17 +1378,17 @@ "uri":"UpdatePublicBandWidth.html", "node_id":"updatepublicbandwidth.xml", "product_code":"css", - "code":"66", - "des":"This API is used to modify the public network access bandwidth.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthNoneModify public network access bandwidth.No", + "code":"70", + "des":"This API is used to modify the public network access bandwidth.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthStatus code: 20", "doc_type":"api", "kw":"Modifying Public Network Access Bandwidth,Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Modifying Public Network Access Bandwidth", @@ -1319,17 +1398,17 @@ "uri":"StartPublicWhitelist.html", "node_id":"startpublicwhitelist.xml", "product_code":"css", - "code":"67", - "des":"This API is used to enable the public network access control whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/updateNoneEnable the public network ", + "code":"71", + "des":"This API is used to enable the public network access control whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update", "doc_type":"api", "kw":"Enabling the Public Network Access Control Whitelist,Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Enabling the Public Network Access Control Whitelist", @@ -1339,17 +1418,17 @@ "uri":"StopPublicWhitelist.html", "node_id":"stoppublicwhitelist.xml", "product_code":"css", - "code":"68", - "des":"This API is used to disable the public network access control whitelist.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeNoneNoneNoneNoneSee Error Codes", + "code":"72", + "des":"This API is used to disable the public network access control whitelist.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeN", "doc_type":"api", "kw":"Disabling the Public Network Access Control Whitelist,Public Network Access,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Disabling the Public Network Access Control Whitelist", @@ -1359,57 +1438,37 @@ "uri":"snapshot_management.html", "node_id":"snapshot_management.xml", "product_code":"css", - "code":"69", + "code":"73", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Snapshot Management", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Snapshot Management", "githuburl":"" }, - { - "uri":"StartAutoSetting.html", - "node_id":"startautosetting.xml", - "product_code":"css", - "code":"70", - "des":"This API is used to automatically set basic configurations for a cluster snapshot, including configuring OBS buckets and IAM agency.OBS Bucket: Enter the location of the ", - "doc_type":"api", - "kw":"(Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot,Snapshot Manageme", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"(Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot", - "githuburl":"" - }, { "uri":"UpdateSnapshotSetting.html", "node_id":"updatesnapshotsetting.xml", "product_code":"css", - "code":"71", - "des":"This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.You can also use this API to enable the snapshot function", + "code":"74", + "des":"This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.OBS Bucket: Enter the location of the OBS bucket used for", "doc_type":"api", "kw":"Modifying Basic Configurations of a Cluster Snapshot,Snapshot Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Modifying Basic Configurations of a Cluster Snapshot", @@ -1419,17 +1478,17 @@ "uri":"CreateSnapshot.html", "node_id":"createsnapshot.xml", "product_code":"css", - "code":"72", - "des":"This API is used to manually create a snapshot.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotStatus code: 201Create a snapshot.Status code: 201Resource crea", + "code":"75", + "des":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ", "doc_type":"api", "kw":"Manually Creating a Snapshot,Snapshot Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Manually Creating a Snapshot", @@ -1439,17 +1498,17 @@ "uri":"RestoreSnapshot.html", "node_id":"restoresnapshot.xml", "product_code":"css", - "code":"73", - "des":"This API is used to manually restore a snapshot.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restoreNoneRestore a snapshot.NoneSee Error Cod", + "code":"76", + "des":"This API is used to manually restore a snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restoreStatus cod", "doc_type":"api", "kw":"Restoring a Snapshot,Snapshot Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Restoring a Snapshot", @@ -1459,77 +1518,77 @@ "uri":"DeleteSnapshot.html", "node_id":"deletesnapshot.xml", "product_code":"css", - "code":"74", - "des":"This API is used to delete a snapshot.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}NoneNoneNoneNoneSee Error Codes.", + "code":"77", + "des":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ", "doc_type":"api", "kw":"Deleting a Snapshot,Snapshot Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Deleting a Snapshot", "githuburl":"" }, - { - "uri":"CreateAutoCreatePolicy.html", - "node_id":"createautocreatepolicy.xml", - "product_code":"css", - "code":"75", - "des":"This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy", - "doc_type":"api", - "kw":"Configuring the Automatic Snapshot Creation Policy,Snapshot Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Configuring the Automatic Snapshot Creation Policy", - "githuburl":"" - }, { "uri":"ShowAutoCreatePolicy.html", "node_id":"showautocreatepolicy.xml", "product_code":"css", - "code":"76", - "des":"This API is used to query the automatic snapshot creation policy.GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policyNoneStatus code: 200Query the automatic", + "code":"78", + "des":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ", "doc_type":"api", "kw":"Querying the Automatic Snapshot Creation Policy,Snapshot Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Querying the Automatic Snapshot Creation Policy", "githuburl":"" }, + { + "uri":"CreateAutoCreatePolicy.html", + "node_id":"createautocreatepolicy.xml", + "product_code":"css", + "code":"79", + "des":"This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{clu", + "doc_type":"api", + "kw":"Configuring the Automatic Snapshot Creation Policy,Snapshot Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Configuring the Automatic Snapshot Creation Policy", + "githuburl":"" + }, { "uri":"ListSnapshots.html", "node_id":"listsnapshots.xml", "product_code":"css", - "code":"77", - "des":"This API is used to query all the snapshots of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneStatus code: 200Query the cluster snapshot list.S", + "code":"80", + "des":"This API is used to query all snapshots of a cluster, including the snapshot creation time, data engine, snapshot ID, and snapshot status, helping you manage the lifecycl", "doc_type":"api", "kw":"Querying a Snapshot List,Snapshot Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Querying a Snapshot List", @@ -1539,77 +1598,57 @@ "uri":"StopSnapshot.html", "node_id":"stopsnapshot.xml", "product_code":"css", - "code":"78", - "des":"This API is used to disable the snapshot function.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneNoneNoneNoneSee Error Codes.", + "code":"81", + "des":"This API is used to disable the snapshot function.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneStatus code: 200Request", "doc_type":"api", "kw":"Disabling the Snapshot Function,Snapshot Management,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Disabling the Snapshot Function", "githuburl":"" }, { - "uri":"StartAutoCreateSnapshots.html", - "node_id":"startautocreatesnapshots.xml", + "uri":"StartAutoSetting.html", + "node_id":"startautosetting.xml", "product_code":"css", - "code":"79", - "des":"This API is used to enable automatic snapshot creation.POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/openNoneEnable the automatic backup function.NoneSee", + "code":"82", + "des":"This API is used to automatically set basic configurations for a cluster snapshot, including configuring OBS buckets and IAM agency.OBS Bucket: Enter the location of the ", "doc_type":"api", - "kw":"Enabling Automatic Snapshot Creation,Snapshot Management,API Reference", + "kw":"(Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot,Snapshot Manageme", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], - "title":"Enabling Automatic Snapshot Creation", - "githuburl":"" - }, - { - "uri":"StopAutoCreateSnapshots.html", - "node_id":"stopautocreatesnapshots.xml", - "product_code":"css", - "code":"80", - "des":"This API is used to disable the automatic snapshot creation function.PUT /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/closeNoneNoneDisable the automatic back", - "doc_type":"api", - "kw":"Disabling Automatic Snapshot Creation,Snapshot Management,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Disabling Automatic Snapshot Creation", + "title":"(Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot", "githuburl":"" }, { "uri":"vpecp_management.html", "node_id":"vpecp_management.xml", "product_code":"css", - "code":"81", + "code":"83", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"VPC Endpoint", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"VPC Endpoint", @@ -1619,17 +1658,17 @@ "uri":"StartVpecp.html", "node_id":"startvpecp.xml", "product_code":"css", - "code":"82", - "des":"This API is used to enable the VPCEP service for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200Enable the VPC endpoint service.", + "code":"84", + "des":"This API is used to enable the VPCEP service for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200En", "doc_type":"api", "kw":"Enabling the VPC Endpoint Service,VPC Endpoint,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Enabling the VPC Endpoint Service", @@ -1639,17 +1678,17 @@ "uri":"StopVpecp.html", "node_id":"stopvpecp.xml", "product_code":"css", - "code":"83", - "des":"This API is used to disable the VPCEP service for a cluster.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: 200NoneStatus code: 200Request", + "code":"85", + "des":"This API is used to disable the VPCEP service for a cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: ", "doc_type":"api", "kw":"Disabling the VPC Endpoint Service,VPC Endpoint,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Disabling the VPC Endpoint Service", @@ -1659,17 +1698,17 @@ "uri":"ShowVpcepConnection.html", "node_id":"showvpcepconnection.xml", "product_code":"css", - "code":"84", - "des":"This API is used to obtain the VPCEP connection of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneStatus code: 200Obtain the VPCEP con", + "code":"86", + "des":"The VPC endpoint service enables secure and reliable access across VPCs through a dedicated gateway, without exposing the network information of servers. The VPC endpoint", "doc_type":"api", "kw":"Obtaining an Endpoint Connection,VPC Endpoint,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Obtaining an Endpoint Connection", @@ -1679,17 +1718,17 @@ "uri":"UpdateVpcepConnection.html", "node_id":"updatevpcepconnection.xml", "product_code":"css", - "code":"85", - "des":"This API is used to update the VPCEP connection of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneUpdate an endpoint connection.NoneS", + "code":"87", + "des":"This API is used to update the VPCEP connection of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsStatus co", "doc_type":"api", "kw":"Updating an Endpoint Connection,VPC Endpoint,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Updating an Endpoint Connection", @@ -1699,17 +1738,17 @@ "uri":"UpdateVpcepWhitelist.html", "node_id":"updatevpcepwhitelist.xml", "product_code":"css", - "code":"86", - "des":"This API is used to modify the endpoint service whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsNoneModify the endpoint service whitelist.", + "code":"88", + "des":"This API is used to modify the endpoint service whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsStatus code:", "doc_type":"api", "kw":"Modifying the VPCEP Service Whitelist of a Cluster,VPC Endpoint,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Modifying the VPCEP Service Whitelist of a Cluster", @@ -1719,17 +1758,17 @@ "uri":"ymls_management.html", "node_id":"ymls_management.xml", "product_code":"css", - "code":"87", + "code":"89", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Parameter Configuration", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Parameter Configuration", @@ -1739,17 +1778,17 @@ "uri":"UpdateYmls.html", "node_id":"updateymls.xml", "product_code":"css", - "code":"88", - "des":"This API is used to modify the parameter settings of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/updateStatus code: 200Modify parameter settings.Status c", + "code":"90", + "des":"This API is used to modify the parameter settings of a cluster. Before calling this API, obtain the parameter configuration list, check the parameter settings, and modify", "doc_type":"api", "kw":"Modifying Cluster Parameters,Parameter Configuration,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Modifying Cluster Parameters", @@ -1759,17 +1798,17 @@ "uri":"ListYmlsJob.html", "node_id":"listymlsjob.xml", "product_code":"css", - "code":"89", - "des":"This API is used to obtain the parameter configuration task list of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblistsNoneStatus code: 200Obtaining the ", + "code":"91", + "des":"This API is used to obtain the parameter configuration task list of a cluster. It can obtain the parameter configuration list ID, cluster ID, and parameter modification r", "doc_type":"api", "kw":"Obtaining the Task List of Parameter Configurations,Parameter Configuration,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Obtaining the Task List of Parameter Configurations", @@ -1779,17 +1818,17 @@ "uri":"ListYmls.html", "node_id":"listymls.xml", "product_code":"css", - "code":"90", - "des":"This API is used to obtain the YAML parameter configuration list of the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/templateNoneStatus code: 200Obta", + "code":"92", + "des":"This API is used to obtain the YAML parameter configuration list of the current cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/te", "doc_type":"api", "kw":"Obtaining the Parameter Configuration List,Parameter Configuration,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Obtaining the Parameter Configuration List", @@ -1799,17 +1838,17 @@ "uri":"intelligent_maintenance.html", "node_id":"intelligent_maintenance.xml", "product_code":"css", - "code":"91", + "code":"93", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Intelligent O&M", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Intelligent O&M", @@ -1819,17 +1858,17 @@ "uri":"ListAiOps.html", "node_id":"listaiops.xml", "product_code":"css", - "code":"92", - "des":"This API is used to obtain the intelligent O&M task list and details.GET /v1.0/{project_id}/clusters/{cluster_id}/ai-opsNoneStatus code: 200This API is used to obtain the", + "code":"94", + "des":"CSS provides intelligent O&M to check potential risks in clusters. After a scan task is completed, check the risks identified by the task, confirm and handle these risks ", "doc_type":"api", "kw":"Obtaining the Intelligent O&M Task List and Details,Intelligent O&M,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Obtaining the Intelligent O&M Task List and Details", @@ -1839,17 +1878,17 @@ "uri":"CreateAiOps.html", "node_id":"createaiops.xml", "product_code":"css", - "code":"93", - "des":"This API is used to create a cluster detection task.POST /v1.0/{project_id}/clusters/{cluster_id}/ai-opsNoneCreate a cluster detection task.NoneSee Error Codes.", + "code":"95", + "des":"This API is used to create a cluster detection task. A maximum of 30 detection tasks can be created for a single cluster.For details, see Calling APIs.POST /v1.0/{project", "doc_type":"api", "kw":"Creating a Cluster Detection Task,Intelligent O&M,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Creating a Cluster Detection Task", @@ -1859,17 +1898,17 @@ "uri":"DeleteAiOps.html", "node_id":"deleteaiops.xml", "product_code":"css", - "code":"94", - "des":"This API is used to delete a detection task.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneNoneDelete a detection task.NoneSee Error Codes.", + "code":"96", + "des":"This API is used to delete a detection task.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneStatus code: 200Request suc", "doc_type":"api", "kw":"Deleting a Detection Task,Intelligent O&M,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Deleting a Detection Task", @@ -1879,37 +1918,37 @@ "uri":"ListSmnTopics.html", "node_id":"listsmntopics.xml", "product_code":"css", - "code":"95", - "des":"This API is used to obtain SMN topics available for intelligent O&M alarms.GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topicsNoneStatus code: 200Obtain the inte", + "code":"97", + "des":"This API is used to obtain SMN topics available for intelligent O&M alarms.For details, see Calling APIs.GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topicsNoneS", "doc_type":"api", "kw":"Obtaining SMN Topics Available for Intelligent O&M Alarms,Intelligent O&M,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Obtaining SMN Topics Available for Intelligent O&M Alarms", "githuburl":"" }, { - "uri":"topic_300000010.html", - "node_id":"topic_300000010.xml", + "uri":"topic_300000011.html", + "node_id":"topic_300000011.xml", "product_code":"css", - "code":"96", + "code":"98", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Load Balancing", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Load Balancing", @@ -1919,17 +1958,17 @@ "uri":"ListElbs.html", "node_id":"listelbs.xml", "product_code":"css", - "code":"97", - "des":"Query the ELB V3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200Query ELB V3 load balancers supported", + "code":"99", + "des":"Query the ELB V3 load balancers supported by a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200Query E", "doc_type":"api", "kw":"Querying ELB V3 Load Balancers Supported by a Cluster,Load Balancing,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Querying ELB V3 Load Balancers Supported by a Cluster", @@ -1939,77 +1978,77 @@ "uri":"EnableOrDisableElb.html", "node_id":"enableordisableelb.xml", "product_code":"css", - "code":"98", - "des":"This API is used to enable or disable load balancers for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load ba", + "code":"100", + "des":"This API is used to enable or disable load balancers for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStat", "doc_type":"api", "kw":"Enabling or Disabling Load Balancers for a Cluster,Load Balancing,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Enabling or Disabling Load Balancers for a Cluster", "githuburl":"" }, - { - "uri":"CreateElbListener.html", - "node_id":"createelblistener.xml", - "product_code":"css", - "code":"99", - "des":"This API is used to configure load balancing listeners for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200Request suc", - "doc_type":"api", - "kw":"Configuring Load Balancing Listeners for a Cluster,Load Balancing,API Reference", - "search_title":"", - "metedata":[ - { - "prodname":"css", - "documenttype":"api", - "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" - } - ], - "title":"Configuring Load Balancing Listeners for a Cluster", - "githuburl":"" - }, { "uri":"ShowElbDetail.html", "node_id":"showelbdetail.xml", "product_code":"css", - "code":"100", - "des":"This API is used to obtain information about the load balancers of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus code: 200NoneStatus code:", + "code":"101", + "des":"CSS integrates shared load balancers and allows you to bind public network access and enable the VPC Endpoint service. Dedicated load balancers provide more functions and", "doc_type":"api", "kw":"Obtain information about the load balancers of a cluster.,Load Balancing,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Obtain information about the load balancers of a cluster.", "githuburl":"" }, + { + "uri":"CreateElbListener.html", + "node_id":"createelblistener.xml", + "product_code":"css", + "code":"102", + "des":"This API is used to configure load balancing listeners for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: ", + "doc_type":"api", + "kw":"Configuring Load Balancing Listeners for a Cluster,Load Balancing,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" + } + ], + "title":"Configuring Load Balancing Listeners for a Cluster", + "githuburl":"" + }, { "uri":"UpdateESListener.html", "node_id":"updateeslistener.xml", "product_code":"css", - "code":"101", - "des":"This API is used to update load balancing listeners for a cluster.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200Status code: 200R", + "code":"103", + "des":"This API is used to update load balancing listeners for a cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Sta", "doc_type":"api", "kw":"Updating Load Balancing Listeners for a Cluster,Load Balancing,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Updating Load Balancing Listeners for a Cluster", @@ -2019,27 +2058,27 @@ "uri":"ListElbCerts.html", "node_id":"listelbcerts.xml", "product_code":"css", - "code":"102", - "des":"This API is used to query the certificate list.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200NoneStatus code: 200Request succeeded.See ", + "code":"104", + "des":"This API is used to query the certificate list.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200This API is ", "doc_type":"api", "kw":"Querying the Certificate List,Load Balancing,API Reference", "search_title":"", "metedata":[ { - "prodname":"css", "documenttype":"api", + "prodname":"css", "opensource":"true", - "operation_id":"CreateCluster;ListClustersDetails;ShowClusterDetail;DeleteCluster;UpdateOndemandClusterToPeriod;UpdateClusterName;ResetPassword;RestartCluster;UpdateExtendCluster;UpdateExtendInstanceStorage;UpdateFlavor;ListFlavors;ListClustersTags;ShowClusterTag;CreateClustersTags;DeleteClustersTags;UpdateBatchClustersTags;UpdateShrinkNodes;UpdateFlavorByType;UpdateShrinkCluster;DownloadCert;UpdateInstance;ChangeMode;AddIndependentNode;UpgradeCore;ListImages;UpgradeDetail;RetryUpgradeTask;ChangeSecurityGroup;ChangeClusterSubnet;UpdateAzByInstanceType;CreateClusterMultiRole;RestartClusterMultiRole;RollingRestart;CreateLoadIkThesaurus;ShowIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;StartConnectivityTest;ListTemplates;ListConfs;ListPipelines;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UpdateRoute;GetRoutes;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;DeleteConfV2;DeleteTemplateV2;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;StartAutoSetting;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;CreateAutoCreatePolicy;ShowAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoCreateSnapshots;StopAutoCreateSnapshots;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;ListElbs;EnableOrDisableElb;CreateElbListener;ShowElbDetail;UpdateESListener;ListElbCerts" + "operation_id":"CreateCluster;UpdateExtendInstanceStorage;ListClustersDetails;AddIndependentNode;ShowClusterDetail;UpdateFlavor;DeleteCluster;UpdateShrinkNodes;UpdateOndemandClusterToPeriod;UpdateFlavorByType;UpdateClusterName;UpdateShrinkCluster;ResetPassword;UpdateInstance;RestartCluster;ChangeMode;UpdateExtendCluster;ListFlavors;DownloadCert;ListClustersTags;UpgradeCore;ListImages;UpgradeDetail;ShowClusterTag;RetryUpgradeTask;CreateClustersTags;ChangeSecurityGroup;DeleteClustersTags;ChangeClusterSubnet;UpdateBatchClustersTags;UpdateAzByInstanceType;ShowIkThesaurus;CreateLoadIkThesaurus;DeleteIkThesaurus;StartKibanaPublic;UpdateCloseKibana;UpdateAlterKibana;UpdatePublicKibanaWhitelist;StopPublicKibanaWhitelist;CreateCnf;UpdateCnf;StartPipeline;StopPipeline;AddFavorite;ListPipelines;ListConfs;StartConnectivityTest;ListTemplates;ListActions;ShowGetConfDetail;DeleteConf;DeleteTemplate;StartHotPipeline;StopHotPipeline;UploadCerts;ListCerts;ShowCertsDetail;DeleteCerts;RebootCluster;StartLogs;StopLogs;ListLogsJob;ShowGetLogSetting;UpdateLogSetting;StartLogAutoBackupPolicy;StopLogAutoBackupPolicy;CreateLogBackup;ShowLogBackup;StartTargetClusterConnectivityTest;CreateBindPublic;UpdateUnbindPublic;UpdatePublicBandWidth;StartPublicWhitelist;StopPublicWhitelist;UpdateSnapshotSetting;CreateSnapshot;RestoreSnapshot;DeleteSnapshot;ShowAutoCreatePolicy;CreateAutoCreatePolicy;ListSnapshots;StopSnapshot;StartAutoSetting;StartVpecp;StopVpecp;ShowVpcepConnection;UpdateVpcepConnection;UpdateVpcepWhitelist;UpdateYmls;ListYmlsJob;ListYmls;ListAiOps;CreateAiOps;DeleteAiOps;ListSmnTopics;UpdateRoute;GetRoutes;ListElbs;EnableOrDisableElb;ShowElbDetail;CreateElbListener;UpdateESListener;ListElbCerts" } ], "title":"Querying the Certificate List", "githuburl":"" }, { - "uri":"en-us_topic_0000002083557490.html", - "node_id":"en-us_topic_0000002083557490.xml", + "uri":"css_03_0095.html", + "node_id":"css_03_0095.xml", "product_code":"css", - "code":"103", + "code":"105", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Examples", @@ -2058,7 +2097,7 @@ "uri":"css_03_0062.html", "node_id":"css_03_0062.xml", "product_code":"css", - "code":"104", + "code":"106", "des":"This section describes how to create a CSS cluster by using APIs. Figure 1 illustrates the API calling process.The token obtained on IAM is valid for only 24 hours. If yo", "doc_type":"api", "kw":"Creating a Pay-per-Use Elasticsearch Cluster,Examples,API Reference", @@ -2077,7 +2116,7 @@ "uri":"css_03_0040.html", "node_id":"css_03_0040.xml", "product_code":"css", - "code":"105", + "code":"107", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendixes", @@ -2096,7 +2135,7 @@ "uri":"css_03_0075.html", "node_id":"css_03_0075.xml", "product_code":"css", - "code":"106", + "code":"108", "des":"Table 1 describes the status codes.", "doc_type":"api", "kw":"Status Codes,Appendixes,API Reference", @@ -2115,7 +2154,7 @@ "uri":"css_03_0076.html", "node_id":"css_03_0076.xml", "product_code":"css", - "code":"107", + "code":"109", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Error Codes,Appendixes,API Reference", @@ -2134,8 +2173,8 @@ "uri":"css_03_0071.html", "node_id":"css_03_0071.xml", "product_code":"css", - "code":"108", - "des":"A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.Log in to the console.In the upper right c", + "code":"110", + "des":"A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.Log in to the CSS management console.In th", "doc_type":"api", "kw":"Obtaining a Project ID and Name,Appendixes,API Reference", "search_title":"", @@ -2153,7 +2192,7 @@ "uri":"css_03_0101.html", "node_id":"css_03_0101.xml", "product_code":"css", - "code":"109", + "code":"111", "des":"A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:You can obtain the cluster ID by calling ", "doc_type":"api", "kw":"Obtaining the Cluster ID,Appendixes,API Reference", @@ -2172,7 +2211,7 @@ "uri":"css_03_0024.html", "node_id":"css_03_0024.xml", "product_code":"css", - "code":"110", + "code":"112", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/css/api-ref/AddIndependentNode.html b/docs/css/api-ref/AddIndependentNode.html index 57297ffa9..582fb9d09 100644 --- a/docs/css/api-ref/AddIndependentNode.html +++ b/docs/css/api-ref/AddIndependentNode.html @@ -3,98 +3,11 @@

Adding Independent Masters and Clients

Function

This API is used to add dedicated master and client nodes to an existing cluster that previously does not have such nodes.

-

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independent

+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independent

-
- - - - - - - - - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Parameter description:

-

The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

-

Constraints:

-

N/A

-

Options:

-

For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

-

Default value:

-

N/A

-

cluster_id

-

Yes

-

String

-

Parameter description:

-

Specifies the ID of the cluster to add dedicated master and client nodes for. For details, see Obtaining the Cluster ID.

-

Constraints:

-

N/A

-

Options:

-

For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

-

Default value:

-

N/A

-

type

-

Yes

-

String

-

Parameter description:

-

Types of dedicated nodes to add.

-

Constraints:

-

N/A

-

Options:

-
  • ess-master: master node

    -
  • ess-client: client node

    -

    Default value:

    -

    N/A

    -
-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

type

-

Yes

-

IndependentTypeReq object

-

Parameter description:

-

Master/Client request body parameter.

-
-
- -
Table 3 IndependentTypeReq

Parameter

+
@@ -104,47 +17,142 @@ - + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

Mandatory

flavor_ref

+

project_id

+

Yes

+

String

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition:

+

ID of the cluster that needs an independent master or client. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

+

Constraints:

+

N/A

+

Value range:

+

Cluster ID.

+

Default value:

+

N/A

+

type

Yes

String

Parameter description:

-

Specifies the flavor ID.

+

Types of dedicated nodes to add.

Constraints:

N/A

Options:

+
  • ess-master: master node

    +
  • ess-client: client node

    +
+

Default value:

+

N/A

+
+
+ +

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

IndependentTypeReq object

+

Definition:

+

Master/Client request body parameter.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + - - - - - - - -
Table 3 IndependentTypeReq

Parameter

+

Mandatory

+

Type

+

Description

+

flavor_ref

+

Yes

+

String

+

Definition:

+

Flavor ID.

+

Constraints:

+

N/A

+

Value range:

You can obtain the value of this parameter by calling the API for Obtaining the Instance Specifications List. Select the flavor ID suitable for your cluster version.

Default value:

N/A

node_size

+

node_size

Yes

+

Yes

Integer

+

Integer

Parameter description:

+

Definition:

Number of nodes.

Constraints:

-

N/A.

-

Options:

+

N/A

+

Value range:

  • If the node type is ess-master, the number of nodes must be an odd number in the range 3 to 10.

  • If the node type is ess-client, the number of nodes must be in the range 1 to 32.

    +

Default value:

N/A

-

volume_type

+

volume_type

Yes

+

Yes

String

+

String

Parameter description:

+

Parameter description:

Node storage type.

Constraints:

N/A

@@ -164,19 +172,22 @@

Response Parameters

Status code: 200

-
Table 4 Response body parameters

Parameter

+
- - - - - @@ -184,7 +195,7 @@

Example Requests

Add independent master and client nodes.

-
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent
+
POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent
 
 {
   "type" : {
@@ -201,25 +212,26 @@
 }

Status Codes

-
Table 4 Response body parameters

Parameter

Type

+

Type

Description

+

Description

id

+

id

String

+

String

Cluster ID.

+

Definition:

+

Cluster ID.

+

Value range:

+

N/A

Status Code

+
- - - - - - - diff --git a/docs/css/api-ref/CLASS.TXT.json b/docs/css/api-ref/CLASS.TXT.json index f64116a6e..7fc3c5af1 100644 --- a/docs/css/api-ref/CLASS.TXT.json +++ b/docs/css/api-ref/CLASS.TXT.json @@ -9,7 +9,7 @@ "code":"1" }, { - "desc":"CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 1 by calling the corresponding APIs.", + "desc":"CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 2 by calling the corresponding APIs.Some APIs of V2 have been release", "product_code":"css", "title":"API Overview", "uri":"css_03_0057.html", @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"This section describes the structure of a RESTful API request, and uses the IAM API for obtain a user token as an example to describe how to call an API.A request URI is ", + "desc":"This section describes the structure of a RESTful API request, and uses the IAM API for obtaining a user token as an example to describe how to call an API.A request URI ", "product_code":"css", "title":"Making an API Request", "uri":"css_03_0078.html", @@ -56,8 +56,8 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"css", - "title":"APIs", - "uri":"css_03_0097.html", + "title":"API V2", + "uri":"css_03_0102.html", "doc_type":"api", "p_code":"", "code":"7" @@ -66,343 +66,379 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"css", "title":"Cluster Management", - "uri":"cluster_management.html", + "uri":"cluster_management_0.html", "doc_type":"api", "p_code":"7", "code":"8" }, { - "desc":"This API is used to create a cluster.POST /v1.0/{project_id}/clustersStatus code: 200Example request for creating a pay-per-use cluster.Status code: 200Request succeeded.", + "desc":"This API is used to create a cluster that uses multiple different types of nodes. The cluster engine type can be Elasticsearch, OpenSearch, or Logstash.An Elasticsearch c", "product_code":"css", - "title":"Creating a cluster", - "uri":"CreateCluster.html", + "title":"Creating a Cluster (V2)", + "uri":"CreateClusterMultiRole.html", "doc_type":"api", "p_code":"8", "code":"9" }, { - "desc":"This API is used to query and display the cluster list and cluster status.GET /v1.0/{project_id}/clustersNoneStatus code: 200Query the first two clusters.- Method 1: GET ", + "desc":"This API is used to restart nodes of all or some types in the current cluster.For details, see Calling APIs.POST /v2.0/{project_id}/clusters/{cluster_id}/restartStatus co", "product_code":"css", - "title":"Querying the Cluster List", - "uri":"ListClustersDetails.html", + "title":"Restarting a Cluster (V2)", + "uri":"RestartClusterMultiRole.html", "doc_type":"api", "p_code":"8", "code":"10" }, { - "desc":"This API is used to query and display the details of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200Whether the details of a cluster are obtain", + "desc":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.For details, see Calling APIs.POST /v2.0/{project_i", "product_code":"css", - "title":"Querying Cluster Details", - "uri":"ShowClusterDetail.html", + "title":"Rolling Restart (Deprecated)", + "uri":"RollingRestart.html", "doc_type":"api", "p_code":"8", "code":"11" }, { - "desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluste", + "desc":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.For details, see Calling APIs.POST /v2.0/{project_i", "product_code":"css", - "title":"Deleting a Cluster", - "uri":"DeleteCluster.html", + "title":"Rolling Restart", + "uri":"RollingRestartV2.html", "doc_type":"api", "p_code":"8", "code":"12" }, { - "desc":"This API is used to change the name of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameNoneChange the display name of the current cluster.NoneSee Error ", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"css", - "title":"Renaming a Cluster", - "uri":"UpdateClusterName.html", + "title":"Snapshot Management", + "uri":"snapshot_management_0.html", "doc_type":"api", - "p_code":"8", + "p_code":"7", "code":"13" }, { - "desc":"This API is used to change the password of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneChange the administrator password of the current clus", + "desc":"CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the clu", "product_code":"css", - "title":"Changing the Password of a Cluster", - "uri":"ResetPassword.html", + "title":"Enabling Automatic Snapshot Creation", + "uri":"StartAutoCreateSnapshots.html", "doc_type":"api", - "p_code":"8", + "p_code":"13", "code":"14" }, { - "desc":"This API is used to restart a data node in a cluster, which will interrupt services. To restart all nodes in a cluster, you are advised to use [Restart Cluster V2] (Resta", + "desc":"CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the clu", "product_code":"css", - "title":"Restarting a Cluster (Deprecated)", - "uri":"RestartCluster.html", + "title":"Disabling Automatic Snapshot Creation", + "uri":"StopAutoCreateSnapshots.html", "doc_type":"api", - "p_code":"8", + "p_code":"13", "code":"15" }, { - "desc":"This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters wit", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"css", - "title":"Scaling Out a Cluster", - "uri":"UpdateExtendCluster.html", + "title":"API V1", + "uri":"css_03_0105.html", "doc_type":"api", - "p_code":"8", + "p_code":"", "code":"16" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"css", + "title":"Cluster Management", + "uri":"cluster_management.html", + "doc_type":"api", + "p_code":"16", + "code":"17" + }, + { + "desc":"This API can only be used to create clusters that contain a single type of nodes. To create clusters that contain multiple types of nodes (ess, ess-cold, ess-client, and ", + "product_code":"css", + "title":"Creating a Cluster (Discarded)", + "uri":"CreateCluster.html", + "doc_type":"api", + "p_code":"17", + "code":"18" + }, { "desc":"This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold da", "product_code":"css", "title":"Adding Instances and Expanding Instance Storage Capacity", "uri":"UpdateExtendInstanceStorage.html", "doc_type":"api", - "p_code":"8", - "code":"17" - }, - { - "desc":"This API is used to modify the specifications of a cluster. Only the nodes of the ESS type can be modified.POST /v1.0/{project_id}/clusters/{cluster_id}/flavorNonePOST /v", - "product_code":"css", - "title":"Changing Specifications", - "uri":"UpdateFlavor.html", - "doc_type":"api", - "p_code":"8", - "code":"18" - }, - { - "desc":"This API is used to query and display the IDs of supported instance specifications.GET /v1.0/{project_id}/es-flavorsNoneStatus code: 200Obtain the specifications of all i", - "product_code":"css", - "title":"Obtaining the Instance Specifications List", - "uri":"ListFlavors.html", - "doc_type":"api", - "p_code":"8", + "p_code":"17", "code":"19" }, { - "desc":"This API is used to query all tags in a specified region.GET /v1.0/{project_id}/{resource_type}/tagsNoneStatus code: 200Query all CSS cluster tags in a project.Status cod", + "desc":"This API is used to query the cluster list and cluster status, including cluster nodes, Kibana public network access information, public network IP address, and IPv4 addr", "product_code":"css", - "title":"Querying All Tags", - "uri":"ListClustersTags.html", + "title":"Querying the Cluster List", + "uri":"ListClustersDetails.html", "doc_type":"api", - "p_code":"8", + "p_code":"17", "code":"20" }, { - "desc":"This API is used to query the tags of a specified cluster.GET /v1.0/{project_id}/{resource_type}/{cluster_id}/tagsNoneStatus code: 200Query the tags of a cluster.Status c", - "product_code":"css", - "title":"Querying Tags of a Specified Cluster", - "uri":"ShowClusterTag.html", - "doc_type":"api", - "p_code":"8", - "code":"21" - }, - { - "desc":"This API is used to add tags to a cluster.POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tagsNoneCreate a cluster tag.NoneSee Error Codes.", - "product_code":"css", - "title":"Adding Tags to a Cluster", - "uri":"CreateClustersTags.html", - "doc_type":"api", - "p_code":"8", - "code":"22" - }, - { - "desc":"This API is used to delete a cluster tag.DELETE /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/{key}NoneNoneNoneNoneSee Error Codes.", - "product_code":"css", - "title":"Deleting a Cluster Tag", - "uri":"DeleteClustersTags.html", - "doc_type":"api", - "p_code":"8", - "code":"23" - }, - { - "desc":"This API is used to add tags to or delete tags from a cluster in batches.POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/actionNoneCreate or delete cluster tags", - "product_code":"css", - "title":"Adding or Deleting Cluster Tags in Batches", - "uri":"UpdateBatchClustersTags.html", - "doc_type":"api", - "p_code":"8", - "code":"24" - }, - { - "desc":"This API is used to scale in a cluster by removing a specified node. Yearly/Monthly clusters do not support the removal of specified nodes by calling this API.POST /v1.0/", - "product_code":"css", - "title":"Scaling In a Cluster by Removing a Specific Node", - "uri":"UpdateShrinkNodes.html", - "doc_type":"api", - "p_code":"8", - "code":"25" - }, - { - "desc":"This API is used to modify cluster specifications. Supported node types:ess: data nodeess: data nodeess-cold: cold data nodeess-cold: cold data nodeess-client: client nod", - "product_code":"css", - "title":"Change the specifications of a specified node type.", - "uri":"UpdateFlavorByType.html", - "doc_type":"api", - "p_code":"8", - "code":"26" - }, - { - "desc":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster. Yearly/Monthly clusters do not support the removal of specified ", - "product_code":"css", - "title":"Scaling In Nodes of a Specific Type", - "uri":"UpdateShrinkCluster.html", - "doc_type":"api", - "p_code":"8", - "code":"27" - }, - { - "desc":"This API is used to download a security certificate.GET /v1.0/{project_id}/cer/downloadNoneStatus code: 200Download the security certificate.Status code: 200Request succe", - "product_code":"css", - "title":"Downloading a Security Certificate", - "uri":"DownloadCert.html", - "doc_type":"api", - "p_code":"8", - "code":"28" - }, - { - "desc":"This API is used to replace a failed node.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replaceNoneNoneNoneSee Error Codes.", - "product_code":"css", - "title":"Replacing a Node", - "uri":"UpdateInstance.html", - "doc_type":"api", - "p_code":"8", - "code":"29" - }, - { - "desc":"This API is used to configure the security mode of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/mode/changeNoneChange the security mode of the current cluster.", - "product_code":"css", - "title":"Configuring the Security Mode.", - "uri":"ChangeMode.html", - "doc_type":"api", - "p_code":"8", - "code":"30" - }, - { - "desc":"This API is used to add dedicated master and client nodes to an existing cluster that previously does not have such nodes.POST /v1.0/{project_id}/clusters/{cluster_id}/ty", + "desc":"This API is used to add dedicated master and client nodes to an existing cluster that previously does not have such nodes.For details, see Calling APIs.POST /v1.0/{projec", "product_code":"css", "title":"Adding Independent Masters and Clients", "uri":"AddIndependentNode.html", "doc_type":"api", - "p_code":"8", + "p_code":"17", + "code":"21" + }, + { + "desc":"This API is used to query and display details about a single cluster, including the cluster's search type, node list, network information, cluster name, cluster ID, and c", + "product_code":"css", + "title":"Querying Cluster Details", + "uri":"ShowClusterDetail.html", + "doc_type":"api", + "p_code":"17", + "code":"22" + }, + { + "desc":"This API is used to modify the node specifications of a cluster. It can only change the specifications of ess nodes (data nodes). If you need to change other types of nod", + "product_code":"css", + "title":"Changing Node Specifications (Discarded)", + "uri":"UpdateFlavor.html", + "doc_type":"api", + "p_code":"17", + "code":"23" + }, + { + "desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluste", + "product_code":"css", + "title":"Deleting a Cluster", + "uri":"DeleteCluster.html", + "doc_type":"api", + "p_code":"17", + "code":"24" + }, + { + "desc":"During a scale-in, the data on the to-be-removed nodes needs to be migrated to the remaining nodes. The timeout for data migration per node is 48 hours. Scale-in will fai", + "product_code":"css", + "title":"Scaling In a Cluster by Removing a Specific Node", + "uri":"UpdateShrinkNodes.html", + "doc_type":"api", + "p_code":"17", + "code":"25" + }, + { + "desc":"If the workloads on a cluster's data plane change, you can scale the cluster vertically by changing its node specifications or node storage type.Cluster types that suppor", + "product_code":"css", + "title":"Change the specifications of a specified node type.", + "uri":"UpdateFlavorByType.html", + "doc_type":"api", + "p_code":"17", + "code":"26" + }, + { + "desc":"This API is used to change cluster names.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameStatus code: 200Request succeeded.NoneChang", + "product_code":"css", + "title":"Renaming a Cluster", + "uri":"UpdateClusterName.html", + "doc_type":"api", + "p_code":"17", + "code":"27" + }, + { + "desc":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster.All mission-critical data has been backed up before a cluster sca", + "product_code":"css", + "title":"Scaling In Nodes of a Specific Type", + "uri":"UpdateShrinkCluster.html", + "doc_type":"api", + "p_code":"17", + "code":"28" + }, + { + "desc":"This API is used to change cluster passwords to enhance cluster security.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetStatus ", + "product_code":"css", + "title":"Changing the Password of a Cluster", + "uri":"ResetPassword.html", + "doc_type":"api", + "p_code":"17", + "code":"29" + }, + { + "desc":"This API is used to replace a failed node.If a node in an Elasticsearch cluster is faulty, you can replace it to restore services.The node replacement process is as follo", + "product_code":"css", + "title":"Replacing a Node", + "uri":"UpdateInstance.html", + "doc_type":"api", + "p_code":"17", + "code":"30" + }, + { + "desc":"This API is used to restart a data node in a cluster, which will interrupt services. To restart all nodes in a cluster, you are advised to use [Restart Cluster V2] (Resta", + "product_code":"css", + "title":"Restarting a Cluster (Deprecated)", + "uri":"RestartCluster.html", + "doc_type":"api", + "p_code":"17", "code":"31" }, { - "desc":"This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_typ", + "desc":"This API is used to configure the security mode of a cluster. The security mode settings for clusters include:Security mode + HTTP: strikes a balance between performance ", + "product_code":"css", + "title":"Configuring the Security Mode.", + "uri":"ChangeMode.html", + "doc_type":"api", + "p_code":"17", + "code":"32" + }, + { + "desc":"This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters wit", + "product_code":"css", + "title":"Scaling Out a Cluster (Discarded)", + "uri":"UpdateExtendCluster.html", + "doc_type":"api", + "p_code":"17", + "code":"33" + }, + { + "desc":"This API is used to obtain the node specifications, including the node specifications version, cluster data search engine, number of vCPUs per node, and node memory size.", + "product_code":"css", + "title":"Obtaining the Instance Specifications List", + "uri":"ListFlavors.html", + "doc_type":"api", + "p_code":"17", + "code":"34" + }, + { + "desc":"The certificate obtained through this API can be used for HTTPS-based secure cluster connections, where encryption and user authentication occur.For details, see Calling ", + "product_code":"css", + "title":"Downloading a Security Certificate", + "uri":"DownloadCert.html", + "doc_type":"api", + "p_code":"17", + "code":"35" + }, + { + "desc":"This API is used to query all tags of a user in the current project, including the keys and values. This facilitates tag management by group.For details, see Calling APIs", + "product_code":"css", + "title":"Querying All Tags", + "uri":"ListClustersTags.html", + "doc_type":"api", + "p_code":"17", + "code":"36" + }, + { + "desc":"This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{c", "product_code":"css", "title":"Upgrading a Cluster Kernel", "uri":"UpgradeCore.html", "doc_type":"api", - "p_code":"8", - "code":"32" + "p_code":"17", + "code":"37" }, { - "desc":"This API is used to obtain the ID of an image that can be upgraded in the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/imagesNoneSta", + "desc":"This API is used to obtain the IDs of target images the current cluster can be upgraded to. The upgrade types are as follows:During a same-version upgrade, kernel patches", "product_code":"css", "title":"Obtaining the ID of the Target Image to Upgrade To", "uri":"ListImages.html", "doc_type":"api", - "p_code":"8", - "code":"33" + "p_code":"17", + "code":"38" }, { - "desc":"The upgrade may take a long time. This API can be used to check phase-by-phase information during a cluster upgrade or AZ switchover.GET /v1.0/{project_id}/clusters/{clus", + "desc":"By deploying a CSS cluster across multiple AZs, you can increase the cluster's availability, lower the likelihood of data loss, and minimize service downtime. You can dep", "product_code":"css", "title":"Obtaining Details About a Cluster Upgrade or AZ Switchover", "uri":"UpgradeDetail.html", "doc_type":"api", - "p_code":"8", - "code":"34" + "p_code":"17", + "code":"39" }, { - "desc":"The upgrade may fail due to network problems. In this case, you can call this API to retry.PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retryNoneNoneE", + "desc":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources. You can add tags to a cluster when creating a cluster or add them on ", + "product_code":"css", + "title":"Querying Tags of a Specified Cluster", + "uri":"ShowClusterTag.html", + "doc_type":"api", + "p_code":"17", + "code":"40" + }, + { + "desc":"The upgrade may fail due to network problems. In this case, you can call this API to retry.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/upgr", "product_code":"css", "title":"Retrying a Failed Upgrade Task", "uri":"RetryUpgradeTask.html", "doc_type":"api", - "p_code":"8", - "code":"35" + "p_code":"17", + "code":"41" }, { - "desc":"This API is used to change the security group after a cluster is created.POST /v1.0/{project_id}/clusters/{cluster_id}/sg/changeNoneChange the security group that the cur", + "desc":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources.You can add tags to a cluster when creating a cluster or add them on t", + "product_code":"css", + "title":"Adding Tags to a Cluster", + "uri":"CreateClustersTags.html", + "doc_type":"api", + "p_code":"17", + "code":"42" + }, + { + "desc":"This API is used to change the security group after a cluster is created.Before changing the security group, ensure that port 9200 has been enabled. Incorrect security gr", "product_code":"css", "title":"Changing the Security Group", "uri":"ChangeSecurityGroup.html", "doc_type":"api", - "p_code":"8", - "code":"36" + "p_code":"17", + "code":"43" }, { - "desc":"This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.POST /v1.0/{project_id}/clusters/{cluster_id}", + "desc":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources.You can add tags to a cluster when creating a cluster or add them on t", + "product_code":"css", + "title":"Deleting a Cluster Tag", + "uri":"DeleteClustersTags.html", + "doc_type":"api", + "p_code":"17", + "code":"44" + }, + { + "desc":"This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.For details, see Calling APIs.POST /v1.0/{pro", "product_code":"css", "title":"Changing the Subnet of a Cluster", "uri":"ChangeClusterSubnet.html", "doc_type":"api", - "p_code":"8", - "code":"37" + "p_code":"17", + "code":"45" }, { - "desc":"This API is used to change the AZ by specifying node types.POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/azmigrateNoneSwitch the AZ of the current c", + "desc":"This API is used to add or delete tags in batches for Elasticsearch, Logstash, and OpenSearch clusters.For details, see Calling APIs.POST /v1.0/{project_id}/{resource_typ", "product_code":"css", - "title":"Changing the AZ of a Cluster Instance", + "title":"Adding or Deleting Cluster Tags in Batches", + "uri":"UpdateBatchClustersTags.html", + "doc_type":"api", + "p_code":"17", + "code":"46" + }, + { + "desc":"An availability zone (AZ) is a physical region where resources use independent power supplies and networks. AZs in the same region can communicate with each other through", + "product_code":"css", + "title":"Changing AZs for a Cluster Instance", "uri":"UpdateAzByInstanceType.html", "doc_type":"api", - "p_code":"8", - "code":"38" + "p_code":"17", + "code":"47" }, { - "desc":"This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, ess-master).POST /v2.0/{project_id}/clustersStatus code: 200Example", + "desc":"This interface is used to update a cluster route.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/routeStatus code: 200Request succeeded.NoneUp", "product_code":"css", - "title":"Creating a Cluster (V2)", - "uri":"CreateClusterMultiRole.html", + "title":"Updating Cluster Routes", + "uri":"UpdateRoute.html", "doc_type":"api", - "p_code":"8", - "code":"39" + "p_code":"17", + "code":"48" }, { - "desc":"This API is used to restart nodes of all or some types in the current cluster.POST /v2.0/{project_id}/clusters/{cluster_id}/restartNoneRestart nodes of all or some types ", + "desc":"By default, a CSS Elasticsearch cluster cannot access a target service—such as a client program or a Lightweight Directory Access Protocol (LDAP) service—that is located ", "product_code":"css", - "title":"Restarting a Cluster (V2)", - "uri":"RestartClusterMultiRole.html", + "title":"Obtaining a Cluster Route", + "uri":"GetRoutes.html", "doc_type":"api", - "p_code":"8", - "code":"40" - }, - { - "desc":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.POST /v2.0/{project_id}/clusters/{cluster_id}/rolli", - "product_code":"css", - "title":"Rolling Restart", - "uri":"RollingRestart.html", - "doc_type":"api", - "p_code":"8", - "code":"41" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"css", - "title":"Word Dictionary Management", - "uri":"thesaurus_management.html", - "doc_type":"api", - "p_code":"7", - "code":"42" - }, - { - "desc":"This API is used to load a custom word dictionary stored in OBS.POST /v1.0/{project_id}/clusters/{cluster_id}/thesaurusNoneEnable and configure the word dictionary.NoneSe", - "product_code":"css", - "title":"Loading Custom Word Dictionaries", - "uri":"CreateLoadIkThesaurus.html", - "doc_type":"api", - "p_code":"42", - "code":"43" - }, - { - "desc":"This API is used to query the loading status of a custom word dictionary.GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurusNoneStatus code: 200Query the loading statu", - "product_code":"css", - "title":"Querying the Status of a Custom Word Dictionary", - "uri":"ShowIkThesaurus.html", - "doc_type":"api", - "p_code":"42", - "code":"44" - }, - { - "desc":"This API is used to clear custom word dictionaries (main word dictionary, stop word dictionary, and synonym dictionary).DELETE /v1.0/{project_id}/clusters/{cluster_id}/th", - "product_code":"css", - "title":"Disabling a Word Dictionary", - "uri":"DeleteIkThesaurus.html", - "doc_type":"api", - "p_code":"42", - "code":"45" + "p_code":"17", + "code":"49" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -410,53 +446,53 @@ "title":"Kibana Public Network Access", "uri":"kibana_public_network_access.html", "doc_type":"api", - "p_code":"7", - "code":"46" + "p_code":"16", + "code":"50" }, { - "desc":"This API is used to enable public network access to Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openNoneNoneSee Error Codes.", + "desc":"This API is used to enable public network access to Kibana.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openStatus code: 200Re", "product_code":"css", "title":"Enabling Kibana Public Access", "uri":"StartKibanaPublic.html", "doc_type":"api", - "p_code":"46", - "code":"47" + "p_code":"50", + "code":"51" }, { - "desc":"This API is used to disable public network access to Kibana. Kibana public network access cannot be disabled for yearly/monthly clusters by calling this API.PUT /v1.0/{pr", + "desc":"This API is used to disable public network access to Kibana.If you disable Kibana public network access and then re-enable it, the public IP address for accessing Kibana ", "product_code":"css", "title":"Disabling Kibana Public Access", "uri":"UpdateCloseKibana.html", "doc_type":"api", - "p_code":"46", - "code":"48" + "p_code":"50", + "code":"52" }, { - "desc":"This API is used to modify the public network bandwidth of Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthNoneModify the Kibana public network", + "desc":"This API is used to modify the public network bandwidth of Kibana.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthStatus", "product_code":"css", "title":"Modifying the Kibana Public Network Bandwidth", "uri":"UpdateAlterKibana.html", "doc_type":"api", - "p_code":"46", - "code":"49" + "p_code":"50", + "code":"53" }, { - "desc":"This API is used to modify the Kibana access permission by modifying the Kibana whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/updateNoneT", + "desc":"This API is used to modify the Kibana access permission by modifying the Kibana whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publ", "product_code":"css", "title":"Modifying Kibana Public Access Control", "uri":"UpdatePublicKibanaWhitelist.html", "doc_type":"api", - "p_code":"46", - "code":"50" + "p_code":"50", + "code":"54" }, { - "desc":"This API is used to disable public network access control for Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/closeNoneNoneNoneNoneSee Error Co", + "desc":"This API is used to disable public network access control for Kibana.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/clo", "product_code":"css", "title":"Disabling Kibana Public Network Access Control", "uri":"StopPublicKibanaWhitelist.html", "doc_type":"api", - "p_code":"46", - "code":"51" + "p_code":"50", + "code":"55" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -464,98 +500,98 @@ "title":"Log Management", "uri":"log_management.html", "doc_type":"api", - "p_code":"7", - "code":"52" + "p_code":"16", + "code":"56" }, { - "desc":"This API is used to enable the log function.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneEnable the log function.POST /v1.0/6204a5bd270343b5885144cf9c8c158d", + "desc":"This API is used to enable log backup or log ingestion for a cluster. Log backup and log ingestion can be enabled separately. After log backup is enabled, you can configu", "product_code":"css", - "title":"Enabling the Log Function", + "title":"Enabling Log Backup or Log Collection", "uri":"StartLogs.html", "doc_type":"api", - "p_code":"52", - "code":"53" + "p_code":"56", + "code":"57" }, { - "desc":"This API is used to disable the log function.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNoneNoneNoneNoneSee Error Codes.", + "desc":"This API is used to disable log backup or log ingestion for a cluster. Log backup and log ingestion can be disabled separately. After log backup is disabled, any automati", "product_code":"css", - "title":"Disabling the Log Function", + "title":"Disabling the Log Backup or Collection Function", "uri":"StopLogs.html", "doc_type":"api", - "p_code":"52", - "code":"54" + "p_code":"56", + "code":"58" }, { - "desc":"This API is used to query the log backup task list of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/recordsNoneStatus code: 200Querying the First 10 Log Bac", + "desc":"This API is used to query the log backup task list of a cluster. To be able to use this API, the target cluster must have log backup enabled, and log backup tasks were tr", "product_code":"css", "title":"Querying the Log Backup Task List", "uri":"ListLogsJob.html", "doc_type":"api", - "p_code":"52", - "code":"55" + "p_code":"56", + "code":"59" }, { - "desc":"This API is used to query basic cluster log configurations.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneStatus code: 200Query basic cluster log configura", + "desc":"This API is used to query the basic configuration of cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the ", "product_code":"css", "title":"Querying Basic Log Configurations", "uri":"ShowGetLogSetting.html", "doc_type":"api", - "p_code":"52", - "code":"56" + "p_code":"56", + "code":"60" }, { - "desc":"This API is used to modify basic log configurations.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneModify basic log configurations.POST /v1.0/6204a5bd2703", + "desc":"This API is used to modify basic configurations for cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the c", "product_code":"css", "title":"Modifying Basic Log Configurations", "uri":"UpdateLogSetting.html", "doc_type":"api", - "p_code":"52", - "code":"57" + "p_code":"56", + "code":"61" }, { - "desc":"This API is used to enable the automatic log backup policy.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/updateNoneEnable the automatic log backup policy.None", + "desc":"CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.Log ", "product_code":"css", "title":"Enabling the Automatic Log Backup Policy", "uri":"StartLogAutoBackupPolicy.html", "doc_type":"api", - "p_code":"52", - "code":"58" + "p_code":"56", + "code":"62" }, { - "desc":"This API is used to disable the automatic log backup policy.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/closeNoneNoneNoneNoneSee Error Codes.", + "desc":"CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.Log ", "product_code":"css", "title":"Disabling the Automatic Log Backup Policy", "uri":"StopLogAutoBackupPolicy.html", "doc_type":"api", - "p_code":"52", - "code":"59" + "p_code":"56", + "code":"63" }, { - "desc":"This API is used to back up logs.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneNoneSee Error Codes.", + "desc":"This API is used to back up logs. If log backup is enabled for a cluster, you can call this API to back up the cluster's run logs to the specified OBS bucket. This ensure", "product_code":"css", "title":"Backing Up Logs", "uri":"CreateLogBackup.html", "doc_type":"api", - "p_code":"52", - "code":"60" + "p_code":"56", + "code":"64" }, { - "desc":"This API is used to query log information.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatus code: 200Query logs.Status code: 200Request succeeded.See Error ", + "desc":"CSS supports log backup and query, helping you efficiently locate issues. You can periodically back up cluster logs to OBS buckets for long-term storage, from which you d", "product_code":"css", "title":"Searching for Logs", "uri":"ShowLogBackup.html", "doc_type":"api", - "p_code":"52", - "code":"61" + "p_code":"56", + "code":"65" }, { - "desc":"This API is used to test connectivity.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/connectivityNoneTest connectivity to the target cluster.Status code: 200Request s", + "desc":"This API is used to test the connectivity between two clusters. CSS clusters provide a log collection function, allowing users to collect clusters' run logs in real time ", "product_code":"css", "title":"Test connectivity.", "uri":"StartTargetClusterConnectivityTest.html", "doc_type":"api", - "p_code":"52", - "code":"62" + "p_code":"56", + "code":"66" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -563,53 +599,53 @@ "title":"Public Network Access", "uri":"public_network_access.html", "doc_type":"api", - "p_code":"7", - "code":"63" + "p_code":"16", + "code":"67" }, { - "desc":"This API is used to enable public network access.POST /v1.0/{project_id}/clusters/{cluster_id}/public/openStatus code: 200Status code: 200Request succeeded.See Error Code", + "desc":"Public network access is supported only when Security Mode and HTTPS Access are enabled for a cluster. When Public IP Address is enabled, a public IP address is automatic", "product_code":"css", "title":"Enabling Public Network Access", "uri":"CreateBindPublic.html", "doc_type":"api", - "p_code":"63", - "code":"64" + "p_code":"67", + "code":"68" }, { - "desc":"This API is used to disable public network access. Public network access cannot be disabled for yearly/monthly clusters by calling this API.PUT /v1.0/{project_id}/cluster", + "desc":"This API is used to disable public network access.After public network access is disabled, users can no longer access the cluster via a public IP address. If you disable ", "product_code":"css", "title":"Disabling Public Network Access", "uri":"UpdateUnbindPublic.html", "doc_type":"api", - "p_code":"63", - "code":"65" + "p_code":"67", + "code":"69" }, { - "desc":"This API is used to modify the public network access bandwidth.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthNoneModify public network access bandwidth.No", + "desc":"This API is used to modify the public network access bandwidth.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthStatus code: 20", "product_code":"css", "title":"Modifying Public Network Access Bandwidth", "uri":"UpdatePublicBandWidth.html", "doc_type":"api", - "p_code":"63", - "code":"66" + "p_code":"67", + "code":"70" }, { - "desc":"This API is used to enable the public network access control whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/updateNoneEnable the public network ", + "desc":"This API is used to enable the public network access control whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update", "product_code":"css", "title":"Enabling the Public Network Access Control Whitelist", "uri":"StartPublicWhitelist.html", "doc_type":"api", - "p_code":"63", - "code":"67" + "p_code":"67", + "code":"71" }, { - "desc":"This API is used to disable the public network access control whitelist.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeNoneNoneNoneNoneSee Error Codes", + "desc":"This API is used to disable the public network access control whitelist.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeN", "product_code":"css", "title":"Disabling the Public Network Access Control Whitelist", "uri":"StopPublicWhitelist.html", "doc_type":"api", - "p_code":"63", - "code":"68" + "p_code":"67", + "code":"72" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -617,8 +653,80 @@ "title":"Snapshot Management", "uri":"snapshot_management.html", "doc_type":"api", - "p_code":"7", - "code":"69" + "p_code":"16", + "code":"73" + }, + { + "desc":"This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.OBS Bucket: Enter the location of the OBS bucket used for", + "product_code":"css", + "title":"Modifying Basic Configurations of a Cluster Snapshot", + "uri":"UpdateSnapshotSetting.html", + "doc_type":"api", + "p_code":"73", + "code":"74" + }, + { + "desc":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ", + "product_code":"css", + "title":"Manually Creating a Snapshot", + "uri":"CreateSnapshot.html", + "doc_type":"api", + "p_code":"73", + "code":"75" + }, + { + "desc":"This API is used to manually restore a snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restoreStatus cod", + "product_code":"css", + "title":"Restoring a Snapshot", + "uri":"RestoreSnapshot.html", + "doc_type":"api", + "p_code":"73", + "code":"76" + }, + { + "desc":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ", + "product_code":"css", + "title":"Deleting a Snapshot", + "uri":"DeleteSnapshot.html", + "doc_type":"api", + "p_code":"73", + "code":"77" + }, + { + "desc":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ", + "product_code":"css", + "title":"Querying the Automatic Snapshot Creation Policy", + "uri":"ShowAutoCreatePolicy.html", + "doc_type":"api", + "p_code":"73", + "code":"78" + }, + { + "desc":"This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{clu", + "product_code":"css", + "title":"Configuring the Automatic Snapshot Creation Policy", + "uri":"CreateAutoCreatePolicy.html", + "doc_type":"api", + "p_code":"73", + "code":"79" + }, + { + "desc":"This API is used to query all snapshots of a cluster, including the snapshot creation time, data engine, snapshot ID, and snapshot status, helping you manage the lifecycl", + "product_code":"css", + "title":"Querying a Snapshot List", + "uri":"ListSnapshots.html", + "doc_type":"api", + "p_code":"73", + "code":"80" + }, + { + "desc":"This API is used to disable the snapshot function.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneStatus code: 200Request", + "product_code":"css", + "title":"Disabling the Snapshot Function", + "uri":"StopSnapshot.html", + "doc_type":"api", + "p_code":"73", + "code":"81" }, { "desc":"This API is used to automatically set basic configurations for a cluster snapshot, including configuring OBS buckets and IAM agency.OBS Bucket: Enter the location of the ", @@ -626,98 +734,8 @@ "title":"(Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot", "uri":"StartAutoSetting.html", "doc_type":"api", - "p_code":"69", - "code":"70" - }, - { - "desc":"This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.You can also use this API to enable the snapshot function", - "product_code":"css", - "title":"Modifying Basic Configurations of a Cluster Snapshot", - "uri":"UpdateSnapshotSetting.html", - "doc_type":"api", - "p_code":"69", - "code":"71" - }, - { - "desc":"This API is used to manually create a snapshot.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotStatus code: 201Create a snapshot.Status code: 201Resource crea", - "product_code":"css", - "title":"Manually Creating a Snapshot", - "uri":"CreateSnapshot.html", - "doc_type":"api", - "p_code":"69", - "code":"72" - }, - { - "desc":"This API is used to manually restore a snapshot.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restoreNoneRestore a snapshot.NoneSee Error Cod", - "product_code":"css", - "title":"Restoring a Snapshot", - "uri":"RestoreSnapshot.html", - "doc_type":"api", - "p_code":"69", - "code":"73" - }, - { - "desc":"This API is used to delete a snapshot.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}NoneNoneNoneNoneSee Error Codes.", - "product_code":"css", - "title":"Deleting a Snapshot", - "uri":"DeleteSnapshot.html", - "doc_type":"api", - "p_code":"69", - "code":"74" - }, - { - "desc":"This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy", - "product_code":"css", - "title":"Configuring the Automatic Snapshot Creation Policy", - "uri":"CreateAutoCreatePolicy.html", - "doc_type":"api", - "p_code":"69", - "code":"75" - }, - { - "desc":"This API is used to query the automatic snapshot creation policy.GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policyNoneStatus code: 200Query the automatic", - "product_code":"css", - "title":"Querying the Automatic Snapshot Creation Policy", - "uri":"ShowAutoCreatePolicy.html", - "doc_type":"api", - "p_code":"69", - "code":"76" - }, - { - "desc":"This API is used to query all the snapshots of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneStatus code: 200Query the cluster snapshot list.S", - "product_code":"css", - "title":"Querying a Snapshot List", - "uri":"ListSnapshots.html", - "doc_type":"api", - "p_code":"69", - "code":"77" - }, - { - "desc":"This API is used to disable the snapshot function.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneNoneNoneNoneSee Error Codes.", - "product_code":"css", - "title":"Disabling the Snapshot Function", - "uri":"StopSnapshot.html", - "doc_type":"api", - "p_code":"69", - "code":"78" - }, - { - "desc":"This API is used to enable automatic snapshot creation.POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/openNoneEnable the automatic backup function.NoneSee", - "product_code":"css", - "title":"Enabling Automatic Snapshot Creation", - "uri":"StartAutoCreateSnapshots.html", - "doc_type":"api", - "p_code":"69", - "code":"79" - }, - { - "desc":"This API is used to disable the automatic snapshot creation function.PUT /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/closeNoneNoneDisable the automatic back", - "product_code":"css", - "title":"Disabling Automatic Snapshot Creation", - "uri":"StopAutoCreateSnapshots.html", - "doc_type":"api", - "p_code":"69", - "code":"80" + "p_code":"73", + "code":"82" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -725,53 +743,53 @@ "title":"VPC Endpoint", "uri":"vpecp_management.html", "doc_type":"api", - "p_code":"7", - "code":"81" + "p_code":"16", + "code":"83" }, { - "desc":"This API is used to enable the VPCEP service for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200Enable the VPC endpoint service.", + "desc":"This API is used to enable the VPCEP service for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200En", "product_code":"css", "title":"Enabling the VPC Endpoint Service", "uri":"StartVpecp.html", "doc_type":"api", - "p_code":"81", - "code":"82" + "p_code":"83", + "code":"84" }, { - "desc":"This API is used to disable the VPCEP service for a cluster.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: 200NoneStatus code: 200Request", + "desc":"This API is used to disable the VPCEP service for a cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: ", "product_code":"css", "title":"Disabling the VPC Endpoint Service", "uri":"StopVpecp.html", "doc_type":"api", - "p_code":"81", - "code":"83" + "p_code":"83", + "code":"85" }, { - "desc":"This API is used to obtain the VPCEP connection of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneStatus code: 200Obtain the VPCEP con", + "desc":"The VPC endpoint service enables secure and reliable access across VPCs through a dedicated gateway, without exposing the network information of servers. The VPC endpoint", "product_code":"css", "title":"Obtaining an Endpoint Connection", "uri":"ShowVpcepConnection.html", "doc_type":"api", - "p_code":"81", - "code":"84" + "p_code":"83", + "code":"86" }, { - "desc":"This API is used to update the VPCEP connection of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneUpdate an endpoint connection.NoneS", + "desc":"This API is used to update the VPCEP connection of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsStatus co", "product_code":"css", "title":"Updating an Endpoint Connection", "uri":"UpdateVpcepConnection.html", "doc_type":"api", - "p_code":"81", - "code":"85" + "p_code":"83", + "code":"87" }, { - "desc":"This API is used to modify the endpoint service whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsNoneModify the endpoint service whitelist.", + "desc":"This API is used to modify the endpoint service whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsStatus code:", "product_code":"css", "title":"Modifying the VPCEP Service Whitelist of a Cluster", "uri":"UpdateVpcepWhitelist.html", "doc_type":"api", - "p_code":"81", - "code":"86" + "p_code":"83", + "code":"88" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -779,35 +797,35 @@ "title":"Parameter Configuration", "uri":"ymls_management.html", "doc_type":"api", - "p_code":"7", - "code":"87" + "p_code":"16", + "code":"89" }, { - "desc":"This API is used to modify the parameter settings of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/updateStatus code: 200Modify parameter settings.Status c", + "desc":"This API is used to modify the parameter settings of a cluster. Before calling this API, obtain the parameter configuration list, check the parameter settings, and modify", "product_code":"css", "title":"Modifying Cluster Parameters", "uri":"UpdateYmls.html", "doc_type":"api", - "p_code":"87", - "code":"88" + "p_code":"89", + "code":"90" }, { - "desc":"This API is used to obtain the parameter configuration task list of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblistsNoneStatus code: 200Obtaining the ", + "desc":"This API is used to obtain the parameter configuration task list of a cluster. It can obtain the parameter configuration list ID, cluster ID, and parameter modification r", "product_code":"css", "title":"Obtaining the Task List of Parameter Configurations", "uri":"ListYmlsJob.html", "doc_type":"api", - "p_code":"87", - "code":"89" + "p_code":"89", + "code":"91" }, { - "desc":"This API is used to obtain the YAML parameter configuration list of the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/templateNoneStatus code: 200Obta", + "desc":"This API is used to obtain the YAML parameter configuration list of the current cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/te", "product_code":"css", "title":"Obtaining the Parameter Configuration List", "uri":"ListYmls.html", "doc_type":"api", - "p_code":"87", - "code":"90" + "p_code":"89", + "code":"92" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -815,116 +833,116 @@ "title":"Intelligent O&M", "uri":"intelligent_maintenance.html", "doc_type":"api", - "p_code":"7", - "code":"91" + "p_code":"16", + "code":"93" }, { - "desc":"This API is used to obtain the intelligent O&M task list and details.GET /v1.0/{project_id}/clusters/{cluster_id}/ai-opsNoneStatus code: 200This API is used to obtain the", + "desc":"CSS provides intelligent O&M to check potential risks in clusters. After a scan task is completed, check the risks identified by the task, confirm and handle these risks ", "product_code":"css", "title":"Obtaining the Intelligent O&M Task List and Details", "uri":"ListAiOps.html", "doc_type":"api", - "p_code":"91", - "code":"92" + "p_code":"93", + "code":"94" }, { - "desc":"This API is used to create a cluster detection task.POST /v1.0/{project_id}/clusters/{cluster_id}/ai-opsNoneCreate a cluster detection task.NoneSee Error Codes.", + "desc":"This API is used to create a cluster detection task. A maximum of 30 detection tasks can be created for a single cluster.For details, see Calling APIs.POST /v1.0/{project", "product_code":"css", "title":"Creating a Cluster Detection Task", "uri":"CreateAiOps.html", "doc_type":"api", - "p_code":"91", - "code":"93" + "p_code":"93", + "code":"95" }, { - "desc":"This API is used to delete a detection task.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneNoneDelete a detection task.NoneSee Error Codes.", + "desc":"This API is used to delete a detection task.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneStatus code: 200Request suc", "product_code":"css", "title":"Deleting a Detection Task", "uri":"DeleteAiOps.html", "doc_type":"api", - "p_code":"91", - "code":"94" + "p_code":"93", + "code":"96" }, { - "desc":"This API is used to obtain SMN topics available for intelligent O&M alarms.GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topicsNoneStatus code: 200Obtain the inte", + "desc":"This API is used to obtain SMN topics available for intelligent O&M alarms.For details, see Calling APIs.GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topicsNoneS", "product_code":"css", "title":"Obtaining SMN Topics Available for Intelligent O&M Alarms", "uri":"ListSmnTopics.html", "doc_type":"api", - "p_code":"91", - "code":"95" + "p_code":"93", + "code":"97" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"css", "title":"Load Balancing", - "uri":"topic_300000010.html", + "uri":"topic_300000011.html", "doc_type":"api", - "p_code":"7", - "code":"96" + "p_code":"16", + "code":"98" }, { - "desc":"Query the ELB V3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200Query ELB V3 load balancers supported", + "desc":"Query the ELB V3 load balancers supported by a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200Query E", "product_code":"css", "title":"Querying ELB V3 Load Balancers Supported by a Cluster", "uri":"ListElbs.html", "doc_type":"api", - "p_code":"96", - "code":"97" + "p_code":"98", + "code":"99" }, { - "desc":"This API is used to enable or disable load balancers for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load ba", + "desc":"This API is used to enable or disable load balancers for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStat", "product_code":"css", "title":"Enabling or Disabling Load Balancers for a Cluster", "uri":"EnableOrDisableElb.html", "doc_type":"api", - "p_code":"96", - "code":"98" + "p_code":"98", + "code":"100" }, { - "desc":"This API is used to configure load balancing listeners for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200Request suc", - "product_code":"css", - "title":"Configuring Load Balancing Listeners for a Cluster", - "uri":"CreateElbListener.html", - "doc_type":"api", - "p_code":"96", - "code":"99" - }, - { - "desc":"This API is used to obtain information about the load balancers of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus code: 200NoneStatus code:", + "desc":"CSS integrates shared load balancers and allows you to bind public network access and enable the VPC Endpoint service. Dedicated load balancers provide more functions and", "product_code":"css", "title":"Obtain information about the load balancers of a cluster.", "uri":"ShowElbDetail.html", "doc_type":"api", - "p_code":"96", - "code":"100" + "p_code":"98", + "code":"101" }, { - "desc":"This API is used to update load balancing listeners for a cluster.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200Status code: 200R", + "desc":"This API is used to configure load balancing listeners for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: ", + "product_code":"css", + "title":"Configuring Load Balancing Listeners for a Cluster", + "uri":"CreateElbListener.html", + "doc_type":"api", + "p_code":"98", + "code":"102" + }, + { + "desc":"This API is used to update load balancing listeners for a cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Sta", "product_code":"css", "title":"Updating Load Balancing Listeners for a Cluster", "uri":"UpdateESListener.html", "doc_type":"api", - "p_code":"96", - "code":"101" + "p_code":"98", + "code":"103" }, { - "desc":"This API is used to query the certificate list.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200NoneStatus code: 200Request succeeded.See ", + "desc":"This API is used to query the certificate list.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200This API is ", "product_code":"css", "title":"Querying the Certificate List", "uri":"ListElbCerts.html", "doc_type":"api", - "p_code":"96", - "code":"102" + "p_code":"98", + "code":"104" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"css", "title":"Examples", - "uri":"en-us_topic_0000002083557490.html", + "uri":"css_03_0095.html", "doc_type":"api", "p_code":"", - "code":"103" + "code":"105" }, { "desc":"This section describes how to create a CSS cluster by using APIs. Figure 1 illustrates the API calling process.The token obtained on IAM is valid for only 24 hours. If yo", @@ -932,8 +950,8 @@ "title":"Creating a Pay-per-Use Elasticsearch Cluster", "uri":"css_03_0062.html", "doc_type":"api", - "p_code":"103", - "code":"104" + "p_code":"105", + "code":"106" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -942,7 +960,7 @@ "uri":"css_03_0040.html", "doc_type":"api", "p_code":"", - "code":"105" + "code":"107" }, { "desc":"Table 1 describes the status codes.", @@ -950,8 +968,8 @@ "title":"Status Codes", "uri":"css_03_0075.html", "doc_type":"api", - "p_code":"105", - "code":"106" + "p_code":"107", + "code":"108" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -959,17 +977,17 @@ "title":"Error Codes", "uri":"css_03_0076.html", "doc_type":"api", - "p_code":"105", - "code":"107" + "p_code":"107", + "code":"109" }, { - "desc":"A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.Log in to the console.In the upper right c", + "desc":"A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.Log in to the CSS management console.In th", "product_code":"css", "title":"Obtaining a Project ID and Name", "uri":"css_03_0071.html", "doc_type":"api", - "p_code":"105", - "code":"108" + "p_code":"107", + "code":"110" }, { "desc":"A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:You can obtain the cluster ID by calling ", @@ -977,8 +995,8 @@ "title":"Obtaining the Cluster ID", "uri":"css_03_0101.html", "doc_type":"api", - "p_code":"105", - "code":"109" + "p_code":"107", + "code":"111" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -987,6 +1005,6 @@ "uri":"css_03_0024.html", "doc_type":"api", "p_code":"", - "code":"110" + "code":"112" } ] \ No newline at end of file diff --git a/docs/css/api-ref/ChangeClusterSubnet.html b/docs/css/api-ref/ChangeClusterSubnet.html index 6ebd34277..92dd34b81 100644 --- a/docs/css/api-ref/ChangeClusterSubnet.html +++ b/docs/css/api-ref/ChangeClusterSubnet.html @@ -4,34 +4,50 @@

Function

This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.

By default, subnets with the same VPC are connected. Ensure that the new subnet can reach your service system. Note that a cluster with automatic IPv6 address creation enabled can only be switched to a new subnet that uses IPv6 addresses.
-

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/subnet/change

+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/subnet/change

-

Status Code

Description

+

Description

200

+

200

Request succeeded.

+

Request succeeded.

403

+

403

Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

+

Request rejected.

+

The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

500

+

500

The server has received the request but could not understand it.

+

The server has received the request but could not understand it.

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - @@ -39,29 +55,39 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

cluster_id

+

cluster_id

Yes

+

Yes

String

+

String

ID of the cluster that you want to change the security group

+

Definition:

+

ID of the cluster whose subnet is to be changed. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

+

Constraints:

+

N/A

+

Value range:

+

Cluster ID.

+

Default value:

+

N/A

Table 2 Request body parameters

Parameter

+
- - - - - - + -
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

-

+

subnet_id

Yes

+

Yes

Object

+

String

+

Definition:

+

Subnet ID.

+

Constraints:

+

The value must be standard UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

+

Value range:

+

The value must be standard UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

+

Default value:

+

N/A

-

Response Parameters

None

+

Response Parameters

Status code: 200

+

Request succeeded.

+

None

Example Requests

Modify the subnet of a cluster.

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/subnet/change
@@ -73,26 +99,27 @@
 

Example Responses

None

Status Codes

-

Status Code

+
- - - - - - - diff --git a/docs/css/api-ref/ChangeMode.html b/docs/css/api-ref/ChangeMode.html index 2d0aa69e6..a2137b58a 100644 --- a/docs/css/api-ref/ChangeMode.html +++ b/docs/css/api-ref/ChangeMode.html @@ -1,36 +1,55 @@

Configuring the Security Mode.

-

Function

This API is used to configure the security mode of a cluster.

+

Function

This API is used to configure the security mode of a cluster. The security mode settings for clusters include:

+
  • Security mode + HTTP: strikes a balance between performance and security. Make sure the cluster is deployed in a secure environment. Do not expose the cluster's network interface to the public network.

    +
  • Security mode + HTTPS: prioritizes security and in-transit data encryption, and allows public network access.

    +
-

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/mode/change

+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/mode/change

-

Status Code

Description

+

Description

200

+

200

Request succeeded.

+

Request succeeded.

400

+

400

Invalid request.

+

Invalid request.

Modify the request and then retry.

403

+

403

Request rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

+

Request rejected.

+

The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - @@ -38,89 +57,109 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

cluster_id

+

cluster_id

Yes

+

Yes

String

+

String

Cluster ID.

+

Definition:

+

ID of the target cluster For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

+

Constraints:

+

N/A

+

Value range:

+

Cluster ID.

+

Default value:

+

N/A

Table 2 Request body parameters

Parameter

+
- - - - - - - - - - - - - - -
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

authorityEnable

+

authority_enable

Yes

+

Yes

Boolean

+

Boolean

Security mode. Its value can be:

-
  • true: enabled

    -
  • false: disabled

    -

    Default value: true

    +

Definition:

+

Whether to enable the security mode for the cluster.

+

Constraints:

+

Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter.

+

Value range:

+
  • true: enable.

    +
  • false: disable.

+

Default value:

+

true

adminPwd

+

admin_pwd

No

+

No

String

+

String

Cluster password in security mode.

+

Definition:

+

Cluster password in security mode.

+

Constraints:

+

Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter.

+

Value range:

+

N/A

+

Default value:

+

N/A

httpsEnable

+

https_enable

Yes

+

Yes

Boolean

+

Boolean

Enable HTTPS. Its value can be:

-
  • true: enabled

    -
  • false: disabled

    -

    Default value: true

    +

Definition:

+

Whether to enable HTTPS for the cluster.

+

Constraints:

+
  • Elasticsearch: Only Elasticsearch 6.5.4 and later versions support security-mode clusters.

    +
  • HTTPS access can be disabled only for OpenSearch 1.3.6 and 2.19.0 security-mode clusters. For other versions, HTTPS access is forcibly enabled and cannot be disabled.

    +
  • true: Enable HTTPS.

    +
  • false: Disable HTTPS.

+

Value range:

+

Default value:

+

true

-

Response Parameters

None

+

Response Parameters

Status code: 200

+

Request succeeded.

+

None

Example Requests

Change the security mode of the current cluster.

-
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/mode/change
+
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/mode/change
 
 {
-  "authorityEnable" : true,
-  "adminPwd" : "admin@1234",
-  "httpsEnable" : true
+  "authority_enable" : true,
+  "admin_pwd" : "admin@1234",
+  "https_enable" : true
 }

Example Responses

None

Status Codes

-

Status Code

+
- - - - - - - diff --git a/docs/css/api-ref/ChangeSecurityGroup.html b/docs/css/api-ref/ChangeSecurityGroup.html index 369018a3d..b16e8aa5a 100644 --- a/docs/css/api-ref/ChangeSecurityGroup.html +++ b/docs/css/api-ref/ChangeSecurityGroup.html @@ -1,106 +1,133 @@

Changing the Security Group

-

Function

This API is used to change the security group after a cluster is created.

-
Before changing the security group, ensure that port 9200 has been enabled. Incorrect security group configuration may cause service access failures. Exercise caution when performing this operation.
+

Function

This API is used to change the security group after a cluster is created.

+

Before changing the security group, ensure that port 9200 has been enabled. Incorrect security group configuration may cause service access failures. Exercise caution when performing this operation.

+
-

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/sg/change

+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/sg/change

-

Status Code

Description

+

Description

200

+

200

Request succeeded.

+

Request succeeded.

400

+

400

Invalid request.

+

Invalid request.

Modify the request before retry.

404

+

404

The requested resource could not be found.

+

The requested resource could not be found.

Modify the request before retry.

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

cluster_id

+

cluster_id

Yes

+

Yes

String

+

String

Cluster ID.

+

Definition:

+

ID of the cluster that you want to change the security group. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

+

Constraints:

+

N/A

+

Value range:

+

Cluster ID.

+

Default value:

+

N/A

-

Request Parameters

-
Table 2 Request body parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

security_group_ids

+

security_group_ids

Yes

+

Yes

String

+

String

Security group ID.

+

Definition:

+

Security group ID.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

-

Response Parameters

None

+

Response Parameters

Status code: 200

+

Request succeeded.

+

None

-

Example Requests

Change the security group that the current cluster belongs to.

-
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/sg/change
+

Example Requests

Change the security group that the current cluster belongs to.

+
POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/sg/change
 
 {
   "security_group_ids" : "b1038649-1f77-4ae9-b64d-9af56e422652"
 }
-

Example Responses

None

+

Example Responses

None

-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - -

Status Code

Description

+

Description

200

+

200

Request succeeded.

+

Request succeeded.

400

+

400

Invalid request.

-

The client should not repeat the request without modifications.

+

Invalid request.

+

The client should not repeat the request without modifications.

403

+

403

Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

+

Request rejected.

+

The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/css/api-ref/CreateAiOps.html b/docs/css/api-ref/CreateAiOps.html index 95d702583..136ba9b84 100644 --- a/docs/css/api-ref/CreateAiOps.html +++ b/docs/css/api-ref/CreateAiOps.html @@ -1,67 +1,13 @@

Creating a Cluster Detection Task

-

Function

This API is used to create a cluster detection task.

+

Function

This API is used to create a cluster detection task. A maximum of 30 detection tasks can be created for a single cluster.

-

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/ai-ops

+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/ai-ops

-
- - - - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

-

cluster_id

-

Yes

-

String

-

ID of the target cluster

-
-
-
-

Request Parameters

-
- - - - - - - - - - - -
Table 2 Request header parameters

Parameter

-

Mandatory

-

Type

-

Description

-

X-Language

-

No

-

String

-

Language

-
-
- -
Table 3 Request body parameters

Parameter

+
@@ -71,54 +17,124 @@ - - - - - - +
Table 1 Path Parameters

Parameter

Mandatory

name

+

project_id

Yes

String

Detection task name

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

description

+

cluster_id

No

+

Yes

String

Detection task description

+

Definition:

+

ID of the target cluster. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

+

Constraints:

+

N/A

+

Value range:

+

Cluster ID.

+

Default value:

+

N/A

alarm

+
+
+ +

Request Parameters

+
+ + + + + + - - -
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Language

No

+

No

alarm object

+

String

After the detection task is complete, an SMN alarm message is sent.

+

Language

-
Table 4 alarm

Parameter

+
- - - - - - - + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

level

+

name

Yes

+

Yes

String

+

String

Sensitivity of an SMN alarm message.

+

Detection task name

+

description

+

No

+

String

+

Detection task description

+

alarm

+

No

+

alarm object

+

After the detection task is complete, an SMN alarm message is sent.

+
+
+ +
+ + + + + + + + + - - - -
Table 4 alarm

Parameter

+

Mandatory

+

Type

+

Description

+

level

+

Yes

+

String

+

Sensitivity of an SMN alarm message.

  • high

  • medium

  • suggestion

    @@ -126,23 +142,25 @@

smn_topic

+

smn_topic

Yes

+

Yes

String

+

String

SMN topic name

+

SMN topic name

-

Response Parameters

None

+

Response Parameters

Status code: 200

+

Request succeeded.

+

None

Example Requests

Create a cluster detection task.

-
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops
+
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops
 
 {
     "name": " aiops-test ",
@@ -157,32 +175,32 @@
 

Example Responses

None

Status Codes

-

Status Code

+
- - - - - - - - - diff --git a/docs/css/api-ref/CreateAutoCreatePolicy.html b/docs/css/api-ref/CreateAutoCreatePolicy.html index bdd7b6348..d6ab83b97 100644 --- a/docs/css/api-ref/CreateAutoCreatePolicy.html +++ b/docs/css/api-ref/CreateAutoCreatePolicy.html @@ -3,34 +3,50 @@

Configuring the Automatic Snapshot Creation Policy

Function

This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.

-

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

-

Status Code

Description

+

Description

200

+

200

Request succeeded.

+

Request succeeded.

400

+

400

Invalid request.

+

Invalid request.

Modify the request instead of retrying.

409

+

409

The request cannot be processed due to a conflict.

+

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

412

+

412

The server does not meet one of the requirements that the requester puts on the request.

+

The server does not meet one of the requirements that the requester puts on the request.

Table 1 Path Parameters

Parameter

+
- - - - - - - - - - - @@ -38,95 +54,152 @@

Request Parameters

-
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

cluster_id

+

cluster_id

Yes

+

Yes

String

+

String

ID of the cluster for which you want to create snapshots automatically.

+

Definition:

+

ID of the cluster for which you want to create snapshots automatically. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

+

Constraints:

+

N/A

+

Value range:

+

Cluster ID.

+

Default value:

+

N/A

Table 2 Request body parameters

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

indices

+

indices

No

+

No

String

+

String

Name of the index to be backed up. * indicates all indexes.

-

prefix

-

No

-

String

-

Prefix of a snapshot that is automatically created, which is manually entered.

-

Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

-
NOTE:
This parameter is mandatory when enable is set to true.
-

period

-

No

-

String

-

Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

-
NOTE:
The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful. This parameter is mandatory when enable is set to true.
-

keepday

-

No

-

Integer

-

Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

-
NOTE:
This parameter is mandatory when enable is set to true.
-

enable

-

Yes

-

String

-

Whether to enable the automatic snapshot creation policy.

-
  • true: The automatic snapshot creation policy is enabled.

    -
  • false:The automatic snapshot creation policy is disabled, and other parameters do not need to be delivered.

    +

Definition:

+

Specify the name of the index you want to restore.

+

Constraints:

+

You can use "*" to match multiple indexes. For example, index* indicates that all indexes with the prefix index will be restored.

+
  • Or you can restore indexes by specifying their names, for example, index1,index2,index3.

    +
  • When "*" is used for index matching, the .opendistro_security index and any system indexes whose name is prefixed with .kibana are filtered out by default. The .opendistro_security index cannot be restored. To restore an index whose name is prefixed with .kibana, you need to specify the index name.

+

Value range:

+

The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: "\<|>/?

+

Default value:

+

By default, this parameter is left blank.

+

If you do not specify any index name, all indexes in snapshots will be restored by default.

deleteAuto

+

prefix

No

+

No

String

+

String

Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled. The default value is false, indicating that automatically created snapshots will not be deleted. If this parameter is set to true, all created snapshots will be deleted when the automatic snapshot creation policy is disabled.

+

Definition:

+

Prefix of a snapshot that is automatically created, which is manually entered.

+

Constraints:

+

This parameter is mandatory when enable is set to true.

+

Value range:

+

Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

+

Default value:

+

N/A

frequency

+

period

No

+

No

String

+

String

Frequency of automatically creating snapshots.

-
NOTE:
The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
+

Definition:

+

Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

00:00 GMT+08:00

+
NOTE:
The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful. This parameter is mandatory when enable is set to true.
+

keepday

+

No

+

Integer

+

Definition:

+

Customize the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

+

Constraints:

+

N/A

+

Value range:

+

1–90

+

Default value:

+

N/A

+
NOTE:
This parameter is mandatory when enable is set to true.
+

enable

+

Yes

+

String

+

Definition:

+

Whether to enable the automatic snapshot creation policy.

+

Constraints:

+

N/A

+

Value range:

+
  • true: The automatic snapshot creation policy is enabled.

    +
  • false: The automatic snapshot creation policy is disabled.

    +
+

Default value:

+

N/A

+

delete_auto

+

No

+

String

+

Definition:

+

Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled.

+

Constraints:

+

N/A

+

Value range:

+
  • true: Delete all automatically created snapshots when an automatic snapshot creation policy is disabled.

    +
  • false: Retain automatically created snapshots when an automatic snapshot creation policy is disabled.

    +
+

Default value:

+

false

+

frequency

+

No

+

String

+

Definition:

+

Frequency of automatically creating snapshots.

+

Constraints:

+

N/A

+

Value range:

+
  • HOUR: Execute once every hour on the hour.

    +
  • DAY: Execute once every day.

    +
  • SUN, MON, TUE, WED, THU, FRI, and SAT: Execute the task at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday.

    +
  • The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.

    +
+

Default value:

+

DAY

-

Response Parameters

None

+

Response Parameters

Status code: 200

+

Request succeeded.

+

None

Example Requests

Configure the automatic snapshot creation policy.

-
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy
+
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy
 
 {
   "prefix" : "snapshot",
@@ -134,26 +207,26 @@
   "keepday" : 7,
   "frequency" : "DAY",
   "enable" : "true",
-  "deleteAuto" : "false"
+  "delete_auto" : "false"
 }

Example Responses

None

Status Codes

-

Status Code

+
- - - - - diff --git a/docs/css/api-ref/CreateBindPublic.html b/docs/css/api-ref/CreateBindPublic.html index 6068c172b..7acaad8d6 100644 --- a/docs/css/api-ref/CreateBindPublic.html +++ b/docs/css/api-ref/CreateBindPublic.html @@ -1,67 +1,14 @@

Enabling Public Network Access

-

Function

This API is used to enable public network access.

+

Function

Public network access is supported only when Security Mode and HTTPS Access are enabled for a cluster. When Public IP Address is enabled, a public IP address is automatically assigned, which will enable access to the security cluster from the public network. Additionally, you can configure access control from the public network by IP addresses or IP address ranges.

+

To enable public network access for Elasticsearch or OpenSearch clusters, a shared load balancer is typically used for load balancing. If your workloads require quicker access, you are advised to use a dedicated load balancer to connect to your clusters. For details about its configuration, see section "Configuring a Dedicated Load Balancer for an Elasticsearch Cluster."

-

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/public/open

+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/public/open

-

Status Code

Description

+

Description

200

+

200

Request succeeded.

+

Request succeeded.

406

+

406

The server could not fulfill the request according to the content characteristics of the request.

+

The server could not fulfill the request according to the content characteristics of the request.

- - - - - - - - - - - - - - - - -
Table 1 Path Parameters

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

-

cluster_id

-

Yes

-

String

-

ID of the cluster whose public network access you want to enable.

-
-
- -

Request Parameters

-
- - - - - - - - - - - -
Table 2 Request body parameters

Parameter

-

Mandatory

-

Type

-

Description

-

eip

-

Yes

-

BindPublicReqEip object

-

EIP information.

-
-
- -
Table 3 BindPublicReqEip

Parameter

+
@@ -71,36 +18,143 @@ - - - + + + + + + + +
Table 1 Path Parameters

Parameter

Mandatory

bandWidth

+

project_id

Yes

BindPublicReqEipBandWidth object

+

String

Public network bandwidth.

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

+

cluster_id

+

Yes

+

String

+

Definition:

+

ID of the cluster whose public network access you want to enable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

+

Constraints:

+

N/A

+

Value range:

+

Cluster ID.

+

Default value:

+

N/A

+
+
+ +

Request Parameters

+
+ + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

eip

+

Yes

+

BindPublicReqEip object

+

Definition:

+

EIP for public network access.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+

white_list

+

No

+

String

+

Definition:

+

Public network access control whitelist.

+

Constraints:

+

Separate the whitelisted CIDR blocks or IP addresses with commas (,), and make sure each of them is unique.

+

Value range:

+

N/A

+

Default value:

+

N/A

-
Table 4 BindPublicReqEipBandWidth

Parameter

+
- - - - - - - + + +
Table 3 BindPublicReqEip

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

size

+

band_width

Yes

+

Yes

Integer

+

BindPublicReqEipBandWidth object

Bandwidth range. Unit: Mbit/s

+

Definition:

+

Public network bandwidth.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + @@ -109,31 +163,39 @@

Response Parameters

Status code: 200

-
Table 4 BindPublicReqEipBandWidth

Parameter

+

Mandatory

+

Type

+

Description

+

size

+

Yes

+

Integer

+

Definition:

+

Public network bandwidth, in Mbit/s.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

Table 5 Response body parameters

Parameter

+
- - - - -
Table 5 Response body parameters

Parameter

Type

+

Type

Description

+

Description

action

+

action

String

+

String

Operations. The fixed value is bindZone, indicating that the binding is successful.

+

Definition:

+

A setting required to enable public network access.

+

Value range:

+

The fixed value is bindZone, indicating that the binding is successful.

-

Example Requests

{
+

Example Requests

Enable public network access.

+
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/open
+
+{
   "eip" : {
-    "bandWidth" : {
+    "band_width" : {
       "size" : 5
     }
-  }
+  },
+  "white_list" : "127.0.0.1",
+  "is_auto_pay" : 1
 }

Example Responses

Status code: 200

@@ -143,32 +205,32 @@ }

Status Codes

-

Status Code

+
- - - - - - - - - diff --git a/docs/css/api-ref/CreateCluster.html b/docs/css/api-ref/CreateCluster.html index ba6ae0b5e..3903e5b96 100644 --- a/docs/css/api-ref/CreateCluster.html +++ b/docs/css/api-ref/CreateCluster.html @@ -1,572 +1,839 @@ -

Creating a cluster

-

Function

This API is used to create a cluster.

+

Creating a Cluster (Discarded)

+

Function

This API can only be used to create clusters that contain a single type of nodes. To create clusters that contain multiple types of nodes (ess, ess-cold, ess-client, and ess-master), use the API for Creating a Cluster v2.

-

URI

POST /v1.0/{project_id}/clusters

+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters

-

Status Code

Description

+

Description

200

+

200

Request succeeded.

+

Request succeeded.

400

+

400

Invalid request.

+

Invalid request.

Modify the request before retry.

409

+

409

The request could not be completed due to a conflict with the current state of the resource.

+

The request could not be completed due to a conflict with the current state of the resource.

The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

412

+

412

The server did not meet one of the preconditions contained in the request.

+

The server did not meet one of the preconditions contained in the request.

Table 1 Path Parameters

Parameter

+
- - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

-

Request Parameters

-
Table 2 Request body parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

cluster

+

cluster

Yes

+

Yes

CreateClusterBody object

+

CreateClusterBody object

Cluster object.

+

Parameter description:

+

Cluster object.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

-
Table 3 CreateClusterBody

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 CreateClusterBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

instance

+

instance

Yes

+

Yes

CreateClusterInstanceBody object

+

CreateClusterInstanceBody object

Instance.

+

Parameter description:

+

Array of Buffer instances, whose memory is to be shared.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

datastore

+

datastore

Yes

+

Yes

CreateClusterDatastoreBody object

+

CreateClusterDatastoreBody object

Search engine.

+

Definition:

+

Search engine.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

name

+

name

Yes

+

Yes

String

+

String

Cluster name It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

+

Definition:

+

Cluster name.

+

Constraints:

+

N/A

+

Value range:

+

It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

+

Default value:

+

N/A

instanceNum

+

desc

Yes

+

No

Integer

+

String

Number of clusters. The value range is 1 to 32.

+

Definition:

+

Cluster description.

+

Constraints:

+

Enter a maximum of 128 characters.

+

Value range:

+

The value can contain digits, letters, periods (.), hyphens (-), underscores (_), and other special characters.

+

Default value:

+

N/A

backupStrategy

+

instanceNum

No

+

Yes

CreateClusterBackupStrategyBody object

+

Integer

Automatic snapshot creation policy, which is disabled by default.

-

The automatic snapshot creation policy is enabled only if backupStrategy is not left blank.

+

Definition:

+

Number of cluster instances.

+

Constraints:

+

N/A

+

Value range:

+

1–32.

+

Default value:

+

N/A

httpsEnable

+

backupStrategy

No

+

No

Boolean

+

CreateClusterBackupStrategyBody object

Whether communication is encrypted on the cluster. The value can be true or false. By default, communication encryption is disabled. If httpsEnable is set to true, authorityEnable must be set to true.

-
  • true: Communication is encrypted on the cluster.

    -
  • false: Communication is not encrypted on the cluster.

    +

Parameter description:

+

Automatic snapshot creation policy, which is disabled by default.

+

The automatic snapshot creation policy is enabled only when backupStrategy is not left blank.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

+

httpsEnable

+

No

+

Boolean

+

Definition:

+

Whether communication is encrypted on the cluster. The value can be true or false. By default, communication encryption is disabled. When httpsEnable is set to true, authorityEnable must be set to true.

+

Constraints:

+

Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter.

+

HTTPS access can be disabled only for OpenSearch 1.3.6 and 2.19.0 security-mode clusters. For other versions, HTTPS access is forcibly enabled and cannot be disabled.

+

Value range:

+
  • true: Communication is encrypted on the cluster.

    +
  • false: Communication is not encrypted for the cluster.

-

This parameter is supported in clusters 6.5.4 or later.

+

Default value:

+

false

authorityEnable

+

authorityEnable

No

+

No

Boolean

+

Boolean

Whether to enable authentication. The value can be true or false. Authentication is disabled by default.

-
  • true indicates that authentication is enabled for the cluster.

    -
  • true indicates that authentication is enabled for the cluster.

    +

Definition:

+

Whether to enable authentication. Available values include true and false. Authentication is disabled by default.

+

Constraints:

+

Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter.

+

Value range:

+
  • true: Authentication is enabled for the cluster.

    +
  • false: Authentication is disabled for the cluster.

-

This parameter is supported in clusters 6.5.4 or later.

+

Default value:

+

false

adminPwd

+

adminPwd

No

+

No

String

+

String

Password of the cluster user admin in security mode. This parameter is mandatory only if authorityEnable is set to true.

-
  • The administrator password must meet the following requirements:

    -
    • The password can contain 8 to 32 characters.

      -
    • Passwords must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^&*()-_=+\|[{}];:,<.>/?).

      -
    -
  • Weak password verification is required for a security cluster. You are advised to set a strong password.

    +

Parameter description:

+

Password of the cluster user admin in security mode. This parameter is mandatory only when authorityEnable is set to true. Weak password verification is required for a security cluster. You are advised to set a strong password.

+

Constraints:

+

The administrator password must meet the following requirements:

+
  • The password can contain 8 to 32 characters.

    +
  • Passwords must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters ~!@#$%^&*()-_=+\|[{}];:,<.>/?

+

Options:

+

See Constraints.

+

Default value:

+

N/A

enterprise_project_id

+

enterprise_project_id

No

+

No

String

+

String

Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-). Value 0 indicates the default enterprise project.

+

Parameter description:

+

Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-). Value 0 indicates the default enterprise project.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

tags

+

tags

No

+

No

Array of CreateClusterTagsBody objects

+

Array of CreateClusterTagsBody objects

Cluster tag.

+

Parameter description:

+

Cluster tags.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

ipv6_enable

+

ipv6_enable

No

+

No

Boolean

+

Boolean

Whether to enable automatic IPv6 address assignment for the cluster. The default value is false.

-

diskEncryption

-

No

-

diskEncryptionInfo object

-

Disk encryption information.

+

Definition:

+

Whether to enable automatic IPv6 address assignment for the cluster. The default value is false.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

false

-
Table 4 CreateClusterInstanceBody

Parameter

+
- - - - - - - - - - - - - - - - - - - + + +
Table 4 CreateClusterInstanceBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

flavorRef

+

flavorRef

Yes

+

Yes

String

+

String

Instance flavor. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.

+

Parameter description:

+

Instance flavor name. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

volume

+

volume

Yes

+

Yes

CreateClusterInstanceVolumeBody object

+

CreateClusterInstanceVolumeBody object

Volume information. You do not need to set this parameter when flavorRef is set to a local disk flavor. Currently, the following local disk flavors are supported:

-
  • ess.spec-i3small

    -
  • ess.spec-i3medium

    -
  • ess.spec-i3.8xlarge.8

    -
  • ess.spec-ds.xlarge.8

    -
  • ess.spec-ds.2xlarge.8

    -
  • ess.spec-ds.4xlarge.8

    +

Parameter description:

+

Volume information. You do not need to set this parameter when flavorRef is set to a local disk flavor. Currently, the following local disk flavors are supported:

+
  • ess.spec-i3small

    +
  • ess.spec-i3medium

    +
  • ess.spec-i3.8xlarge.8

    +
  • ess.spec-ds.xlarge.8

    +
  • ess.spec-ds.2xlarge.8

    +
  • ess.spec-ds.4xlarge.8

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

nics

+

nics

Yes

+

Yes

CreateClusterInstanceNicsBody object

+

CreateClusterInstanceNicsBody object

Subnet ID.

+

Parameter description:

+

Subnet information.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

availability_zone

+

availability_zone

Yes

+

Yes

String

+

String

One or more AZs. You need to specify the AZ names.

-

By default, a single AZ is specified. If multiple AZs are specified, use commas (,) to separate different AZ names. For example, if three AZs are selected under region-1, the value of availability_zone is region-1a,region-1b,region-1c. If a single AZ is used, the value of availability_zone is empty by default.

-
NOTE:
Note:

- If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.

-

- If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ.

+

Definition:

+

AZ of the node. The AZ name needs to be specified.

+

Constraints:

+

When specifying the AZs of nodes, use commas (,) to separate different AZ names. For example, if multiple AZs are selected for general AZs, the value of availability_zone is region-1a,region-1b,region-1c.

+

Value range:

+

N/A

+

Default value:

+

availability_zone is empty by default, indicating that a single AZ is used.

+
NOTE:

If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.

+

If the number of nodes is evenly divisible by the number of AZs, the nodes will be evenly distributed among all AZs.

+

If the number of nodes is not evenly divisible by the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.

+

AZ name. Obtain it from Regions and Endpoints in section "Before You Start".

-
  • If the number of nodes is not a multiple of the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.

    -
  • Obtain the AZ names from Regions and Endpoints in section "Before You Start".

    +
+
+ +
+ + + + + + + + + - -
Table 5 CreateClusterInstanceVolumeBody

Parameter

+

Mandatory

+

Type

+

Description

+

volume_type

+

Yes

+

String

+

Parameter description:

+

Volume type.

+

Constraints:

+

N/A

+

Options:

+
  • COMMON: common I/O

    +
  • HIGH: high I/O

    +
  • ULTRAHIGH: ultra-high I/O

    +
  • ESSD: ultra-fast SSD

+

Default value:

+

N/A

-
- -
- - - - - - - - - - - - - -
Table 5 CreateClusterInstanceVolumeBody

Parameter

-

Mandatory

-

Type

-

Description

-

volume_type

+

size

Yes

+

Yes

String

+

Integer

Volume type

-
  • COMMON: common I/O

    -
  • HIGH: high I/O

    -
  • ULTRAHIGH: ultra-high I/O

    -
  • ESSD: ultra-fast SSD

    +

Definition:

+

Disk size.

+

Constraints:

+

The value must be greater than 0 and a common multiple of 4 and 10, in GB.

+

Value range:

+

You can obtain the disk size from the diskrange attribute in Obtaining the Instance Specifications List.

+

Default value:

+
  • ess and ess-cold nodes: 100 GB or the minimum disk capacity supported by the selected node flavor, whichever is larger.

    +
  • ess-master and ess-client nodes: The default volume size is 40 GB and cannot be changed.

-

size

-

Yes

-

Integer

-

Volume size. The value must be greater than 0 and a multiple of 4 and 10. For details about the local disk size, see the diskrange attribute in Obtaining the Instance Specifications List. Unit: GB

+
NOTE:

For ess and ess-cold nodes, 100 GB or a larger value is recommended.

+
-
Table 6 CreateClusterInstanceNicsBody

Parameter

+
- - - - - - - - - - - - - - - - - - - -
Table 6 CreateClusterInstanceNicsBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

vpcId

+

vpcId

Yes

+

Yes

String

+

String

VPC ID, which is used for configuring cluster network.

+

Parameter description:

+

VPC ID, which is used for configuring cluster network.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

netId

+

netId

Yes

+

Yes

String

+

String

Subnet ID (network ID).

+

Parameter description:

+

Subnet ID (network ID).

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

securityGroupId

+

securityGroupId

Yes

+

Yes

String

+

String

Security group ID.

-

ip

-

No

-

String

-

Node IP address.

+

Parameter description:

+

Security group ID

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

-
Table 7 CreateClusterDatastoreBody

Parameter

+
- - - - - - - - - - -
Table 7 CreateClusterDatastoreBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

version

+

version

Yes

+

Yes

String

+

String

Elasticsearch/Logstash engine version. For details, see the supported versions in Before You Start.

+

Parameter description:

+

Elasticsearch/Logstash engine version. For details, see the supported versions in Before You Start.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

type

+

type

Yes

+

Yes

String

+

String

Engine type. The value can be elasticsearch, logstash, or opensearch.

+

Definition:

+

Engine type of the cluster to be created.

+

Constraints:

+

N/A

+

Value range:

+
  • elasticsearch: Elasticsearch cluster.

    +
  • opensearch: OpenSearch cluster.

    +
  • logstash: Logstash cluster.

    +
+

Default value:

+

N/A

-
Table 8 CreateClusterBackupStrategyBody

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + +
Table 8 CreateClusterBackupStrategyBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

period

+

period

Yes

+

Yes

String

+

String

Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

-
NOTE:
The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.
+

Definition:

+

Time when a snapshot is generated every day.

+

Constraints:

+

N/A

+

Value range:

+

Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

+

Default value:

+

00:00 GMT+08:00

+
NOTE:

When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.

+

prefix

+

prefix

Yes

+

Yes

String

+

String

Prefix of a snapshot that is automatically created, which is manually entered. Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

+

Definition:

+

Prefix of a snapshot that is automatically created, which is manually entered.

+

Constraints:

+

N/A

+

Value range:

+

Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

+

Default value:

+

N/A

keepday

+

keepday

Yes

+

Yes

Integer

+

Integer

Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

+

Definition:

+

Set the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

+

Constraints:

+

N/A

+

Value range:

+

1–90

+

Default value:

+

N/A

bucket

+

bucket

No

+

No

String

+

String

Name of the OBS bucket used for backup.

+

Parameter description:

+

Name of the OBS bucket used for backup.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

basePath

+

basePath

No

+

No

String

+

String

Storage path of the snapshot in the OBS bucket.

+

Parameter description:

+

Storage path of the snapshot in the OBS bucket.

+

Constraints:

+

N/A

+

Options:

+

N/A

+

Default value:

+

N/A

agency

+

agency

No

+

No

String

+

String

Agency name. You can create an agency to allow CSS to call other cloud services. The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.

-
NOTE:
If none of the bucket, basePath, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.
+

Definition:

+

Agency name. You can create an agency to allow CSS to call other cloud services. An agency name cannot contain special characters or Chinese characters.

+

Constraints:

+

N/A

+

Value range:

+

Only a-z, A-Z, 0-9, hyphens (-) and underscores (_) are allowed.

+

Default value:

+

N/A

+
NOTE:

If none of the bucket, basePath, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.

+

frequency

+

frequency

No

+

No

String

+

String

Frequency of automatically creating snapshots.

-
NOTE:
The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
+

Definition:

+

Frequency of automatically creating snapshots.

+

Constraints:

+

N/A

+

Value range:

+
  • HOUR: Execute once every hour on the hour.

    +
  • DAY: Execute once every day.

    +
  • SUN, MON, TUE, WED, THU, FRI, and SAT: Execute the task at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday.

    +
  • The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.

    +
+

Default value:

+

DAY

+

maxSnapshotBytesPerSeconds

+

No

+

String

+

Definition:

+

This parameter sets the maximum backup speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

+

Constraints:

+

N/A

+

Value range:

+

The following values and formats are allowed:

+
  • Number + Unit

    +
+

The number ranges from 0 to 9999.

+

The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

+

0mb means there is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

+
  • 0

    +
+

There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

+
  • -1

    +
+

There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

+

Default value:

+

The default value is 40 MB. If this parameter is left blank, the default value is used.

+

maxRestoreBytesPerSeconds

+

No

+

String

+

Definition:

+

This parameter sets the maximum recovery speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

+

Constraints:

+

For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached.

+

Value range:

+

The following values and formats are allowed:

+
  • Number + Unit

    +
+

The number ranges from 0 to 9999.

+

The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

+

0mb means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

+
  • 0

    +
+

There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

+
  • -1

    +
+

There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

+

Default value:

+

For Elasticsearch clusters of 7.6.2 or earlier, the default setting is 40mb.

+

For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter.

+

If this parameter is left blank, the default setting is used.

-
Table 9 CreateClusterTagsBody

Parameter

+
- - - - - - - - - - - + + +
Table 9 CreateClusterTagsBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

key

+

key

Yes

+

Yes

String

+

String

Separate multiple AZs with commas (,). For example, to specify three AZs in CN North-Beijing4, you can set availability_zone to cn-north-4a,cn-north-4b,cn-north-4c. By default, a single AZ is created when this parameter is not specified.

+

Definition:

+

Tag key.

+

Constraints:

+

N/A

+

Value range:

+

The value can contain 1 to 36 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

+

Default value:

+

N/A

value

+

value

Yes

+

Yes

String

+

String

Tag value. The value can contain 0 to 43 characters. It can only contain digits, letters, hyphens (-), and underscores (_).

+

Definition:

+

Tag value.

+

Constraints:

+

N/A

+

Value range:

+
  • Length: 0 to 255 characters.

    +
  • The value can contain UTF-8 letters, digits, spaces, and special characters _.://=+-@

    +
+

Default value:

+

N/A

+
+
+ +

Response Parameters

Status code: 200

+ +
+ + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

cluster

+

CreateClusterClusterResponse object

+

Parameter description:

+

Cluster object. For a pay-per-use cluster, only the cluster parameter is returned.

+

Options:

+

N/A

-
Table 10 diskEncryptionInfo

Parameter

+
- - - - - - - - - - -
Table 11 CreateClusterClusterResponse

Parameter

Mandatory

+

Type

Type

-

Description

+

Description

systemEncrypted

+

id

No

+

String

String

-

Whether to enable disk encryption. The value can be 0 or 1. The default value is 0.

-

0: Disable disk encryption.

-

1: Enable disk encryption.

+

Parameter description:

+

Cluster ID.

+

Options:

+

N/A

systemCmkid

+

name

No

+

String

String

-

KMS key ID. This parameter is valid only when systemEncrypted is set to 1.

+

Parameter description:

+

Cluster name.

+

Options:

+

N/A

-

Response Parameters

Status code: 200

- -
- - - - - - - - - -
Table 11 Response body parameters

Parameter

-

Type

-

Description

-

cluster

-

CreateClusterClusterResponse object

-

Cluster object.

-
-
- -
- - - - - - - - - - - - - -
Table 12 CreateClusterClusterResponse

Parameter

-

Type

-

Description

-

id

-

String

-

Cluster ID.

-

name

-

String

-

Cluster name

-
-
-
-

Example Requests

Example request for creating a pay-per-use cluster.

-
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters
+

Example Requests

  • Example request for creating a pay-per-use cluster.

    +
    POST https://{Endpoint}/v1.0/{project_id}/clusters
     
     {
       "cluster" : {
    @@ -588,6 +855,7 @@
           "type" : "elasticsearch"
         },
         "name" : "cluster-name",
    +    "desc" : "Cluster testing",
         "instanceNum" : 3,
         "backupStrategy" : {
           "period" : "16:00 GMT+08:00",
    @@ -596,7 +864,9 @@
           "frequency" : "DAY",
           "bucket" : "css-obs-backup",
           "basePath" : "css_repository/obs-path",
    -      "agency" : "css_obs_agency"
    +      "agency" : "css_obs_agency",
    +      "maxSnapshotBytesPerSeconds" : 40,
    +      "maxRestoreBytesPerSeconds" : 40
         },
         "httpsEnable" : true,
         "authorityEnable" : true,
    @@ -611,51 +881,53 @@
         } ]
       }
     }
    +
-

Example Responses

Status code: 200

-

Request succeeded.

-

Example response for creating a pay-per-use cluster.

-
{
+

Example Responses

Status code: 200

+

Request succeeded.

+
  • Example response for creating a pay-per-use cluster.

    +
    {
       "cluster" : {
         "id" : "ef683016-871e-48bc-bf93-74a29d60d214",
         "name" : "ES-Test"
       }
     }
    +
-

Status Codes

-

Status Code

+

Status Codes

+
- - - - - - - - -

Status Code

Description

+

Description

200

+

200

Request succeeded.

+

Request succeeded.

400

+

400

Invalid request.

-

Modify the request before retry.

+

Invalid request.

+

Modify the request before retry.

409

+

409

The request could not be completed due to a conflict with the current state of the resource.

-

The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

+

The request could not be completed due to a conflict with the current state of the resource.

+

The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

412

+

412

The server did not meet one of the preconditions contained in the request.

+

The server did not meet one of the preconditions contained in the request.

-

Error Codes

See Error Codes.

+

Error Codes

See Error Codes.

diff --git a/docs/css/api-ref/CreateClusterMultiRole.html b/docs/css/api-ref/CreateClusterMultiRole.html index 8c5dd9c83..7330ffd40 100644 --- a/docs/css/api-ref/CreateClusterMultiRole.html +++ b/docs/css/api-ref/CreateClusterMultiRole.html @@ -1,876 +1,1325 @@

Creating a Cluster (V2)

-

Function

This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, ess-master).

+

Function

This API is used to create a cluster that uses multiple different types of nodes. The cluster engine type can be Elasticsearch, OpenSearch, or Logstash.

+
  • An Elasticsearch cluster supports the following nodes:

    +
  • Data node (ess): mandatory. Data nodes store the data of a cluster. If there are no client nodes in the cluster, data nodes will need to additionally handle cluster access and data analytics requests; if there are no master nodes, data nodes will need to provide cluster management.

    +
  • Master nodes (ess-master): optional. Master nodes manage cluster-wide operations, including metadata, indexes, and shard allocation. For large-scale deployments, using dedicated master nodes enhances cluster stability, service availability, and centralized control.

    +
  • Client nodes (ess-client): Client nodes route and coordinate search and index requests, offloading processing from data nodes for enhanced query performance and cluster scalability when there are heavy loads.

    +
  • Cold data nodes (ess-cold): Cold data nodes are used to store and query large quantities of latency-insensitive data. They offer an effective way to manage large datasets while cutting storage costs.

    +
  • OpenSearch clusters support the same nodes as Elasticsearch clusters.

    +
  • Logstash clusters support the creation of Logstash nodes (lgs). Logstash nodes ingest, parse, process, and transmit data.

    +
-

URI

POST /v2.0/{project_id}/clusters

+

Constraints

  • Before creating a cluster, make sure you have planned its configuration, including the cluster size, node specifications, and storage capacity requirements.

    +
  • You have created a VPC, subnet, and security group beforehand, or you can create them when creating the cluster.

    +
+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v2.0/{project_id}/clusters

-
Table 1 Path Parameters

Parameter

+
- - - - - - -
Table 1 Path Parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Definition:

+

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

+

Constraints:

+

N/A

+

Value range:

+

Project ID of the account.

+

Default value:

+

N/A

-

Request Parameters

-
Table 2 Request body parameters

Parameter

+

Request Parameters

+
- - - - - - -
Table 2 Request body parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

cluster

+

cluster

Yes

+

Yes

CreateClusterBody object

+

CreateClusterBody object

Cluster object.

+

Definition:

+

Cluster object.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

-
Table 3 CreateClusterBody

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 CreateClusterBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

name

+

name

Yes

+

Yes

String

+

String

Cluster name It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

+

Definition:

+

Cluster name.

+

Constraints:

+

N/A

+

Value range:

+

The value must consist of 4 to 32 characters, and must start with a letter. It can only contain digits, letters, periods (.), hyphens (-), and underscores (_).

+

Default value:

+

N/A

backupStrategy

+

desc

No

+

No

CreateClusterBackupStrategyBody object

+

String

Automatic snapshot creation.

-

The automatic snapshot creation policy is enabled only if backupStrategy is not left blank.

+

Definition:

+

Cluster description.

+

Constraints:

+

Enter a maximum of 128 characters.

+

Value range:

+

Digits, letters, periods (.), hyphens (-), underscores (_), and other special characters are allowed.

+

Default value:

+

N/A

roles

+

backupStrategy

Yes

+

No

Array of CreateClusterRolesBody objects

+

CreateClusterBackupStrategyBody object

Cluster information

+

Definition:

+

Automatic snapshot creation.

+

Constraints:

+

The automatic snapshot creation policy is enabled only when backupStrategy is not left blank.

+

Value range:

+

N/A

+

Default value:

+

N/A

nics

+

roles

Yes

+

Yes

CreateClusterInstanceNicsBody object

+

Array of CreateClusterRolesBody objects

Subnet ID.

+

Definition:

+

Cluster node information.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

enterprise_project_id

+

nics

No

+

Yes

String

+

CreateClusterInstanceNicsBody object

Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-). Value 0 indicates the default enterprise project.

+

Definition:

+

Network configuration information.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

tags

+

enterprise_project_id

No

+

No

Array of CreateClusterTagsBody objects

+

String

Cluster tag.

+

Definition:

+

Enterprise project ID. When you create a cluster, associate the enterprise project ID with the cluster.

+

Constraints:

+

N/A

+

Value range:

+

The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-).

+

Default value:

+

0 indicates an enterprise project.

availability_zone

+

tags

Yes

+

No

String

+

Array of CreateClusterTagsBody objects

One or more AZs. You need to specify the AZ names.

-

By default, a single AZ is specified. If multiple AZs are specified, use commas (,) to separate different AZ names. For example, if three AZs are selected under region-1, the value of availability_zone is region-1a,region-1b,region-1c. If a single AZ is used, the value of availability_zone is empty by default.

-
NOTE:
Note:

- If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.

-

- If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ.

+

Definition:

+

Cluster tags.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+

availability_zone

+

Yes

+

String

+

Definition:

+

AZ of the node. The AZ name needs to be specified.

+

Constraints:

+

If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.

+

If the number of nodes is evenly divisible by the number of AZs, the nodes will be evenly distributed among all AZs.

+

If the number of nodes is not evenly divisible by the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.

+

To learn more about AZs, see Basic Concepts in CSS Before You Start.

+

Value range:

+

When specifying the AZs of nodes, use commas (,) to separate different AZ names. For example, if multiple AZs are selected for general AZs, the value of availability_zone is region-1a,region-1b,region-1c.

+

Default value:

+

N/A

+

datastore

+

Yes

+

CreateClusterDatastoreBody object

+

Definition:

+

Engine type of the cluster to be created.

+

Constraints:

+

N/A

+

Value range:

+

The value can be elasticsearch, opensearch, or logstash.

+

Default value:

+

N/A

+

authorityEnable

+

No

+

Boolean

+

Definition:

+

Whether to enable security authentication for a cluster.

+

Constraints:

+

This parameter is available only for Elasticsearch and OpenSearch clusters.

+
  • Elasticsearch: Only Elasticsearch 6.5.4 and later versions support security-mode clusters.

    +
  • OpenSearch: No constraints.

    +
  • true: Authentication is enabled for the cluster.

    +
  • false: Authentication is disabled for the cluster.

    +
+

Value range:

+

Default value:

+

false

+

httpsEnable

+

No

+

Boolean

+

Definition:

+

Whether communication is encrypted on the cluster.

+

Constraints:

+

When httpsEnable is set to true, authorityEnable must be set to true.

+

Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter.

+

HTTPS access can be disabled only for OpenSearch 1.3.6 and 2.19.0 security-mode clusters. For other versions, HTTPS access is forcibly enabled and cannot be disabled.

+

Value range:

+
  • true: Communication is encrypted on the cluster.

    +
  • false: Communication is not encrypted for the cluster.

    +
+

Default value:

+

false

+

adminPwd

+

No

+

String

+

Definition:

+

Password of the administrator admin for a security-mode cluster.

+

Constraints:

+

This parameter is mandatory only when authorityEnable is set to true during cluster creation.

+

Value range:

+

A string of 8 to 32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters ~!@#$%&*()-_=|[{}];:,<.>/?

+

Default value:

+

N/A

+

publicIPReq

+

No

+

CreateClusterPublicIpReq object

+

Definition:

+

Public network access information.

+

Constraints:

+

This parameter is valid only when httpsEnable is set to true.

+

Value range:

+

N/A

+

Default value:

+

N/A

+

loadBalance

+

No

+

CreateClusterLoadBalance object

+

Definition:

+

VPC endpoint service information.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+

publicKibanaReq

+

No

+

CreateClusterPublicKibanaReq object

+

Definition:

+

Kibana public network access information.

+

Constraints:

+

This parameter is valid only when authorityEnable is set to true.

+

Value range:

+

N/A

+

Default value:

+

N/A

+

ipv6_enable

+

No

+

Boolean

+

Definition:

+

Whether to enable automatic IPv6 address assignment for the cluster.

+

Constraints:

+

N/A

+

Value range:

+
  • true: Automatic IPv6 address assignment is enabled for the cluster.

    +
  • false: Automatic IPv6 address assignment is disabled for the cluster.

    +
+

Default value:

+

false

+
+
+ +
+ + + + + + + + + + + + + + - - - - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateClusterBackupStrategyBody

Parameter

+

Mandatory

+

Type

+

Description

+

period

+

Yes

+

String

+

Definition:

+

Time when a snapshot is created every day.

+

Constraints:

+

Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

+

Value range:

+

N/A

+

Default value:

+

00:00 GMT+08:00.

+
NOTE:

When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.

-
  • If the number of nodes is not a multiple of the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.

    -
  • Obtain the AZ names from Regions and Endpoints in section "Before You Start".

    +

frequency

+

No

+

String

+

Definition:

+

Frequency of automatically creating snapshots.

+

Constraints:

+

The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.

+

Value range:

+
  • HOUR: Execute once every hour on the hour.

    +
  • DAY: Execute once every day.

    +
  • SUN, MON, TUE, WED, THU, FRI, and SAT: Execute once on the specified day of a week. For example, SUN indicates that the task is executed once every Sunday.

+

Default value:

+

DAY

datastore

+

prefix

Yes

+

Yes

CreateClusterDatastoreBody object

+

String

Engine type. Its value can be elasticsearch, opensearch, or logstash.

+

Definition:

+

Prefix of a snapshot that is automatically created, which is manually entered.

+

Constraints:

+

Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

+

Value range:

+

N/A

+

Default value:

+

N/A

authorityEnable

+

keepday

No

+

Yes

Boolean

+

Integer

Whether to enable authentication. The value can be true or false. Authentication is disabled by default.

-
  • true: Authentication is enabled for the cluster.

    -
  • false: Authentication is disabled for the cluster.

    +

Definition:

+

Customize the number of snapshots to be retained.

+

Constraints:

+

Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

+

Value range:

+

1–90

+

Default value:

+

N/A

+

bucket

+

No

+

String

+

Definition:

+

Name of the OBS bucket used for backup.

+

Constraints:

+

Select an OBS bucket that meets the following requirements:

+
  • Storage class: Standard.

    +
  • Region: the same as that of the cluster.

-

This parameter is supported in clusters 6.5.4 or later.

+

Value range:

+

N/A

+

Default value:

+

N/A

httpsEnable

+

basePath

No

+

No

Boolean

+

String

Whether communication is encrypted on the cluster. The value can be true or false. By default, communication encryption is disabled. When httpsEnable is set to true, authorityEnable must be set to true.- true: Communication is encrypted on the cluster.- false: Communication is not encrypted for the cluster.This parameter is supported in clusters 6.5.4 or later.

-

adminPwd

-

No

-

String

-

Password of the cluster user admin in security mode. This parameter is mandatory only when authorityEnable is set to true. Input requirements:

-
  • Must contain 8 to 32 characters.

    -
  • Must contain at least three of the following character types: letters, digits, and special characters ~!@#$%^&*()-_=+\|[{}];:,<.>/?

    +

Definition:

+

Storage path of the snapshot in the OBS bucket.

+

Constraints:

+

The backup path cannot:

+
  • Contain the following characters: :*?"<>|'{}

    +
  • Start with a slash (/).

    +
  • Start or end with a period (.).

    +
  • Contain more than two consecutive slashes (/) or periods (.).

    +
  • Exceed 512 characters.

+

Value range:

+

N/A

+

Default value:

+

N/A

publicIPReq

+

agency

No

+

No

CreateClusterPublicIpReq object

+

String

Public network access information. This parameter is valid only when httpsEnable is set to true.

+

Definition:

+

Select an IAM agency to grant the current account the permission to access and use OBS.

+

Constraints:

+

N/A

+

Value range:

+

The agency name can contain only letters (case-sensitive), digits, underscores (_), and hyphens (-).

+

Default value:

+

N/A

+
NOTE:

If none of the bucket, basePath, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.

+

loadBalance

+

maxSnapshotBytesPerSeconds

No

+

No

CreateClusterLoadBalance object

+

String

VPC endpoint service information

-

publicKibanaReq

-

No

-

CreateClusterPublicKibanaReq object

-

Kibana public network access information. This parameter is valid only when authorityEnable is set to true.

-

ipv6_enable

-

No

-

Boolean

-

Whether to enable automatic IPv6 address assignment for the cluster. The default value is false.

-

diskEncryption

-

No

-

diskEncryptionInfo object

-

Disk encryption information.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 CreateClusterBackupStrategyBody

Parameter

-

Mandatory

-

Type

-

Description

-

period

-

Yes

-

String

-

Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

-
NOTE:
The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.
-

frequency

-

No

-

String

-

Frequency of automatically creating snapshots.

-
NOTE:
The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
-

prefix

-

Yes

-

String

-

Prefix of a snapshot that is automatically created, which is manually entered. Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

-

keepday

-

Yes

-

Integer

-

Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

-

bucket

-

No

-

String

-

Name of the OBS bucket used for backup.

-

basePath

-

No

-

String

-

Storage path of the snapshot in the OBS bucket.

-

agency

-

No

-

String

-

IAM agency used to access OBS.

-

If none of the bucket, base_path, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + - - -
Table 5 CreateClusterRolesBody

Parameter

-

Mandatory

-

Type

-

Description

-

flavorRef

-

Yes

-

String

-

Instance flavor. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.

-

volume

-

Yes

-

CreateClusterInstanceVolumeBody object

-

Volume information. If flavorRef is set to a local disk flavor, leave this parameter blank. Obtain the the local disk flavor by referring to the diskrange attribute in Obtaining the Instance Specifications List. Currently, the following local disk flavors are supported:

-
  • ess.spec-i3small

    -
  • ess.spec-i3medium

    -
  • ess.spec-i3.8xlarge.8

    -
  • ess.spec-ds.xlarge.8

    -
  • ess.spec-ds.2xlarge.8

    -
  • ess.spec-ds.4xlarge.8

    +

Parameter description:

+

This parameter sets the maximum backup speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

+

Constraints

+

N/A

+

Value range:

+

The following values and formats are allowed:

+
  • Number + Unit

-

type

-

Yes

-

String

-
  • ess-master indicates a master node.

    -
  • ess-client indicates a client node.

    -
  • ess-cold indicates a cold data node.

    -
  • ess indicates a data node.

    -
  • lgs indicates a Logstash node.

    -

    [- chinese indicates a Chinese language model.

    -
  • english indicates an English language model.

    -
  • arabic indicates an Arabic model.

    -
  • thai indicates a Thai model.

    -
  • turkish indicates a Turkish language model.

    -
  • tools indicates a tools model.] (tag:white)

    +

    The number ranges from 0 to 9999.

    +

    The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

    +

    0mb means there is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

    +
    • 0

    -

instanceNum

-

Yes

-

Integer

-

Number of instances.

-
  • If ess is selected, you can set the value to 1 to 32.

    -
    • If both ess and ess-master are selected, you can set the value to 1 to 200.

      -
    • If both ess and ess-client are selected, you can set the value to 1 to 32.

      -
    • If both ess and ess-cold are selected, you can set the value to 32.

      +

      There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

      +
      • -1

      -
    • If ess-master is selected, you can set the value to 3 to 10.

      -
    • If ess-client is selected, you can set the value to 1 to 32.

      -
    • If ess-cold is selected, you can set the value to 1 to 32.

      +

      There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

      +

      Default value:

      +

      40mb

      +

maxRestoreBytesPerSeconds

+

No

+

String

+

Parameter description:

+

This parameter sets the maximum recovery speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

+

Constraints

+

For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached.

+

Value range:

+

The following values and formats are allowed:

+
  • Number + Unit

-
-
- -
- - - - - - - - - - - - - - - - -
Table 6 CreateClusterInstanceVolumeBody

Parameter

-

Mandatory

-

Type

-

Description

-

volume_type

-

Yes

-

String

-

Volume type

-
  • COMMON: common I/O

    -
  • HIGH: high I/O

    -
  • ULTRAHIGH: ultra-high I/O

    -
  • ESSD: ultra-fast SSD

    +

    The number ranges from 0 to 9999.

    +

    The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

    +

    0mb means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

    +
    • 0

    -

size

-

Yes

-

Integer

-

Volume size. The value must be greater than 0 and a multiple of 4 and 10. Unit: GB

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 CreateClusterInstanceNicsBody

Parameter

-

Mandatory

-

Type

-

Description

-

vpcId

-

Yes

-

String

-

VPC ID, which is used for configuring cluster network.

-

netId

-

Yes

-

String

-

Subnet ID (network ID).

-

securityGroupId

-

Yes

-

String

-

Security group ID.

-

ips

-

No

-

Array of strings

-

Node IP address.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 8 CreateClusterTagsBody

Parameter

-

Mandatory

-

Type

-

Description

-

key

-

Yes

-

String

-

Tag key. The value can contain 1 to 36 characters. It can only contain digits, letters, hyphens (-), and underscores (_).

-

value

-

Yes

-

String

-

Tag value. The value can contain 0 to 43 characters. It can only contain digits, letters, hyphens (-), and underscores (_).

-
-
- -
- - - - - - - - - - - - - - - - -
Table 9 CreateClusterDatastoreBody

Parameter

-

Mandatory

-

Type

-

Description

-

version

-

Yes

-

String

-

Version of the CSS cluster engine. For details, see the supported versions in Before You Start.

-

[For a serverless cluster, logs, search, and vector are supported.] (tag:white)

-

type

-

Yes

-

String

-

Engine type. Its value can be elasticsearch, opensearch, or logstash.

-

[For a serverless cluster, serverless-opensearch is used.] (tag:white)

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 10 CreateClusterPublicIpReq

Parameter

-

Mandatory

-

Type

-

Description

-

eip

-

Yes

-

CreateClusterPublicEip object

-

Public network bandwidth.

-

elbWhiteListReq

-

Yes

-

CreateClusterElbWhiteList object

-

EIP whitelist.

-

publicBindType

-

Yes

-

String

-

Whether to automatically bind an EIP. Specifies whether to automatically bind an EIP. Currently, only auto_assign is supported.

-

eipId

-

No

-

String

-

EIP ID.

-
-
- -
- - - - - - - - - - - -
Table 11 CreateClusterPublicEip

Parameter

-

Mandatory

-

Type

-

Description

-

bandWidth

-

Yes

-

CreateClusterPublicEipSize object

-

Public network bandwidth.

-
-
- -
- - - - - - - - - - - -
Table 12 CreateClusterPublicEipSize

Parameter

-

Mandatory

-

Type

-

Description

-

size

-

Yes

-

Integer

-

Bandwidth range.

-
-
- -
- - - - - - - - - - - - - - - - -
Table 13 CreateClusterElbWhiteList

Parameter

-

Mandatory

-

Type

-

Description

-

enableWhiteList

-

Yes

-

Boolean

-

Whether to enable the public network access control.

-

whiteList

-

No

-

String

-

Public network access control whitelist. Separate the whitelisted network segments or IP addresses with commas (,), and each of them must be unique.

-
-
- -
- - - - - - - - - - +
Table 14 CreateClusterLoadBalance

Parameter

-

Mandatory

-

Type

-

Description

-

endpointWithDnsName

-

Yes

-

Boolean

-

Whether to enable the private domain name.

-
  • true: The private zone is enabled.

    -
  • false: The private zone is disabled.

    +

    There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

    +
    • -1

    +

    There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

    +

    Default value:

    +

    For Elasticsearch clusters of 7.6.2 or earlier, the default setting is 40mb.

    +

    For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter.

vpcPermissions

+
+
+ +
+ + + + + + - - - - - - - + + + + + - - - -
Table 5 CreateClusterRolesBody

Parameter

+

Mandatory

+

Type

+

Description

+

flavorRef

No

+

Yes

Array of strings

+

String

Access control.

+

Definition:

+

Name flavor name. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.

+

Constraints:

+

For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.

+

Value range:

+

N/A

+

Default value:

+

N/A

professionVpcep

+

volume

No

+

Yes

Boolean

+

CreateClusterInstanceVolumeBody object

Create a professional VPC endpoint.

-
  • true: enabled.

    -
  • false: disabled.

    +

Definition:

+

Volume information.

+

Constraints:

+

If flavorRef is set to a local disk flavor, leave this parameter blank. Obtain the local disk flavor by referring to the diskrange attribute in Obtaining the Instance Specifications List.

+

Value range:

+

N/A

+

Default value:

+

N/A

+

type

+

Yes

+

String

+

Definition:

+

Node type.

+

Constraints:

+

N/A

+

Value range:

+
  • ess-master indicates a master node.

    +
  • ess-client indicates a client node.

    +
  • ess-cold indicates a cold data node.

    +
  • ess indicates a data node.

    +
  • lgs indicates a Logstash node.

    +
  • english indicates an English language model.

    +
  • arabic indicates an Arabic model.

    +
  • thai indicates a Thai model.

    +
  • turkish indicates a Turkish language model.

    +
  • tools indicates a tools model.

    +
  • portuguese indicates a Portuguese model.

    +
  • spanish indicates a Spanish model.

    +
  • chinese-english: general model for Chinese and English.

    +
  • spanish-portuguese: general model for Spanish and Portuguese.] (tag:white)

+

[- chinese indicates a Chinese language model.

+

Default value:

+

N/A

dualstackEnable

+

instanceNum

No

+

Yes

Boolean

+

Integer

Whether to enable the IPv4/IPv6 dual-stack network. The IPv4/IPv6 dual-stack network can be enabled only when a professional VPC endpoint is created and the VPC of the cluster supports IPv6.

-
  • true: enabled.

    -
  • false: disabled.

    +

Definition:

+

Number of instances.

+

Constraints:

+

See the value range.

+

Value range:

+
  • If ess is selected, you can set the value to 1 to 32.

    +
    • If both ess and ess-master are selected, you can set the value to 1 to 200.

      +
    • If both ess and ess-client are selected, you can set the value to 1 to 32.

      +
    • If both ess and ess-cold are selected, you can set the value to 32.

    +
  • If ess-master is selected, you can set the value to 3 to 10.

    +
  • If ess-client is selected, you can set the value to 1 to 32.

    +
  • If ess-cold is selected, you can set the value to 1 to 32.

    +
  • For Logstash nodes, the value ranges from 1 to 100.

    +
+

Default value:

+

N/A

-
Table 15 CreateClusterPublicKibanaReq

Parameter

+
- - - - - - - - - - -
Table 6 CreateClusterInstanceVolumeBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

eipSize

+

volume_type

Yes

+

Yes

Integer

+

String

Bandwidth range.

+

Definition:

+

Disk type.

+

Constraints:

+

N/A

+

Value range:

+
  • COMMON: common I/O

    +
  • HIGH: high I/O

    +
  • ULTRAHIGH: ultra-high I/O

    +
  • ESSD: ultra-fast SSD

    +
+

Default value:

+

N/A

elbWhiteList

+

size

Yes

+

Yes

CreateClusterPublicKibanaElbWhiteList object

+

Integer

Kibana whitelist information.

+

Definition:

+

Disk size.

+

Constraints:

+

The value must be greater than 0 and a common multiple of 4 and 10, in GB.

+

Value range:

+

You can obtain the disk size from the diskrange attribute in Obtaining the Instance Specifications List.

+

Default value:

+
  • ess and ess-cold nodes: 100 GB or the minimum disk capacity supported by the selected node flavor, whichever is larger.

    +
  • ess-master and ess-client nodes: The default volume size is 40 GB and cannot be changed.

    +
+
NOTE:

For ess and ess-cold nodes, 100 GB or a larger value is recommended.

+
-
Table 16 CreateClusterPublicKibanaElbWhiteList

Parameter

+
- - - - - - - - - - - + + + + + + + + + +
Table 7 CreateClusterInstanceNicsBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

whiteList

+

vpcId

Yes

+

Yes

String

+

String

Whitelist. Separate the whitelisted network segments or IP addresses with commas (,), and each of them must be unique.

+

Definition:

+

VPC ID, which is used for configuring cluster network.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

enableWhiteList

+

netId

Yes

+

Yes

Boolean

+

String

Whether to enable the Kibana access control.

+

Definition:

+

Subnet ID (network ID).

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+

securityGroupId

+

Yes

+

String

+

Definition:

+

Security group ID.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+

ips

+

No

+

Array of strings

+

Definition:

+

Node IP address, which is configured when a cluster is created.

+

Constraints:

+

N/A

+

Value range:

+

Only Elasticsearch and OpenSearch support this parameter.

+

Assign automatically: Private IPv4 addresses will be automatically assigned to cluster nodes.

+

Assign manually: Manually assign private IPv4 addresses to cluster nodes. Before assigning an IP address, click View In-Use IP Address to check IP addresses that are already in use.

+

Default value:

+

N/A

-
Table 17 diskEncryptionInfo

Parameter

+
- - - - - - - - - - - - - -
Table 8 CreateClusterTagsBody

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

systemEncrypted

+

key

No

+

Yes

String

+

String

Whether to enable disk encryption. The value can be 0 or 1. The default value is 0.

-

0: Disable disk encryption.

-

1: Enable disk encryption.

+

Definition:

+

Tag key.

+

Constraints:

+

N/A

+

Value range:

+

The value can contain 1 to 36 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

+

Default value:

+

N/A

systemCmkid

+

value

No

+

Yes

String

+

String

KMS key ID. This parameter is valid only when systemEncrypted is set to 1.

-
-
- -

Response Parameters

Status code: 200

- -
- - - - - - -
Table 18 Response body parameters

Parameter

-

Type

-

Description

-

cluster

-

CreateClusterResp object

-

Cluster object.

+

Definition:

+

Tag value.

+

Constraints:

+

N/A

+

Value range:

+

The value can contain 0 to 43 characters. It can only contain digits, letters, hyphens (-), and underscores (_).

+

Default value:

+

N/A

-
Table 19 CreateClusterResp

Parameter

+
- - + - - - + - - - + + + +
Table 9 CreateClusterDatastoreBody

Parameter

Type

+

Mandatory

Description

+

Type

+

Description

id

+

version

String

+

Yes

Cluster ID.

+

String

+

Definition:

+

Version of the CSS cluster engine. For details, see the supported versions in Before You Start.

+

Constraints:

+

N/A

+

Value range:

+

N/A[For a serverless cluster, logs, search, and vector are supported.] (tag:white)

+

Default value:

+

N/A

name

+

type

String

+

Yes

Cluster name

+

String

+

Definition:

+

Engine type of the cluster to be created.

+

Constraints:

+

N/A

+

Value range:

+
  • elasticsearch: Elasticsearch cluster.

    +
  • opensearch: OpenSearch cluster.

    +
  • logstash: Logstash cluster.

    +
+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 CreateClusterPublicIpReq

Parameter

+

Mandatory

+

Type

+

Description

+

eip

+

Yes

+

CreateClusterPublicEip object

+

Definition:

+

Public network bandwidth.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+

elbWhiteListReq

+

Yes

+

CreateClusterElbWhiteList object

+

Definition:

+

EIP whitelist.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+

publicBindType

+

Yes

+

String

+

Definition:

+

Whether to automatically bind an EIP.

+

Constraints:

+

N/A

+

Value range:

+

Currently, only auto_assign is supported.

+

Default value:

+

N/A

+

eipId

+

No

+

String

+

Definition:

+

EIP ID.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 11 CreateClusterPublicEip

Parameter

+

Mandatory

+

Type

+

Description

+

bandWidth

+

Yes

+

CreateClusterPublicEipSize object

+

Definition:

+

Set the public network bandwidth.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + +
Table 12 CreateClusterPublicEipSize

Parameter

+

Mandatory

+

Type

+

Description

+

size

+

Yes

+

Integer

+

Definition:

+

Bandwidth size, in Mbit/s.

+

Constraints:

+

N/A

+

Value range:

+

1-200

+

Default value:

+

1

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 13 CreateClusterElbWhiteList

Parameter

+

Mandatory

+

Type

+

Description

+

enableWhiteList

+

Yes

+

Boolean

+

Definition:

+

Whether to enable public network access control.

+

Constraints:

+

N/A

+

Value range:

+
  • true: A whitelist is set. Only IP addresses or CIDR blocks on this whitelist can access the cluster from the public network.

    +
  • false: No whitelist is set. All public IP addresses can access the cluster.

    +
+

Click +Add. In the displayed text box, enter IP addresses or CIDR blocks that are allowed to access the cluster from the public network. Separate them using commas (,). Each value must be unique. An example of valid values: 192.168.1.1,10.0.0.0/24. Examples of invalid values: 0.0.0.0, x.x.x.x0, 172.16.0.0-172.16.255.255, non-standard formats (e.g., 192.168.1), and duplicate values.

+

Default value:

+

false

+

whiteList

+

No

+

String

+

Definition:

+

Public network access control whitelist.

+

Constraints:

+

Separate the whitelisted CIDR blocks or IP addresses with commas (,), and make sure each of them is unique.

+

Value range:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 14 CreateClusterLoadBalance

Parameter

+

Mandatory

+

Type

+

Description

+

endpointWithDnsName

+

Yes

+

Boolean

+

Definition:

+

Specifies the private domain name for accessing the VPC endpoint.

+

Constraints:

+

N/A

+

Value range:

+
  • true: Internal domain names are supported. The system automatically assigns a private domain name to the VPC endpoint. After cluster creation, you can check this private domain name on the VPC Endpoint tab of the cluster details page.

    +
  • false: Internal domain names are not supported. No private domain name is assigned for the VPC endpoint. The cluster can only be accessed through an IP address assigned to the VPC endpoint.

    +
+

Default value:

+

false

+

vpcPermissions

+

No

+

Array of strings

+

Definition:

+

Access control.

+

Constraints:

+

N/A

+

Value range:

+

N/A.

+

Default value:

+

N/A

+

professionVpcep

+

No

+

Boolean

+

Definition:

+

Create a professional VPC endpoint.

+

Constraints:

+

N/A

+

Value range:

+
  • true: Yes. Create professional VPC endpoints that support the IPv4/IPv6 dual-stack network.

    +
  • false: No. Create basic VPC endpoints that support IPv4 only.

    +
+

Default value:

+

false

+

dualstackEnable

+

No

+

Boolean

+

Definition:

+

Whether to enable IPv4/IPv6 dual-stack networking.

+

Constraints:

+

The IPv4/IPv6 dual-stack network can be enabled only when a professional VPC endpoint is created and the VPC of the cluster supports IPv6.

+

Value range:

+
  • true: Yes The system automatically assigns an IPv6 address to the VPC endpoint.

    +
  • false: No The VPC endpoint does not support IPv6 addresses.

    +
+

Default value:

+

false

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 15 CreateClusterPublicKibanaReq

Parameter

+

Mandatory

+

Type

+

Description

+

eipSize

+

Yes

+

Integer

+

Definition:

+

Bandwidth size, in Mbit/s.

+

Constraints:

+

N/A

+

Value range:

+

1-200

+

Default value:

+

1

+

elbWhiteList

+

Yes

+

CreateClusterPublicKibanaElbWhiteList object

+

Definition:

+

Kibana whitelist information.

+

Constraints:

+

N/A

+

Value range:

+

N/A

+

Default value:

+

N/A

+
+
+ +
+ + + + + + + + + + + + + +
Table 16 CreateClusterPublicKibanaElbWhiteList

Parameter

+

Mandatory

+

Type

+

Description

+

whiteList

+

Yes

+

String

+

Definition:

+

Whitelists

+

Constraints:

+

Separate the whitelisted CIDR blocks or IP addresses with commas (,), and make sure each of them is unique.

+

Value range:

+

N/A

+

Default value:

+

N/A

+

enableWhiteList

+

Yes

+

Boolean

+

Definition:

+

Whether to enable Kibana access control.

+

Constraints:

+

N/A

+

Value range:

+
  • true: A whitelist is set. Only IP addresses or CIDR blocks on this whitelist can access the cluster's Kibana console from the public network.

    +
  • false: No whitelist is set. All public IP addresses can access the cluster through Kibana.

    +
+

Click +Add. In the displayed text box, enter IP addresses or CIDR blocks that are allowed to access the cluster's Kibana console from the public network. Separate them using commas (,). Each value must be unique. An example of valid values: 192.168.1.1,10.0.0.0/24. Examples of invalid values: 0.0.0.0, x.x.x.x0, 172.16.0.0-172.16.255.255, non-standard formats (e.g., 192.168.1), and duplicate values.

+

Default value:

+

false

-

Example Requests

Example request for creating a pay-per-use cluster.

-
{
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 17 Response body parameters

Parameter

+

Type

+

Description

+

cluster

+

CreateClusterResp object

+

Definition:

+

Cluster object. For a pay-per-use cluster, only the cluster parameter is returned.

+

Value range:

+

N/A.

+
+
+ +
+ + + + + + + + + + + + + +
Table 18 CreateClusterResp

Parameter

+

Type

+

Description

+

id

+

String

+

Definition:

+

Cluster ID.

+

Value range:

+

N/A.

+

name

+

String

+

Definition:

+

Cluster name.

+

Value range:

+

N/A.

+
+
+
+

Example Requests

  • Example request for creating a pay-per-use Elasticsearch cluster

    +
    POST https://{Endpoint}/v2.0/{project_id}/clusters
    +
    +{
       "cluster" : {
         "name" : "css-cluster",
    +    "desc" : "Cluster testing",
         "backupStrategy" : {
           "period" : "16:00 GMT+08:00",
           "prefix" : "snapshot",
    @@ -878,7 +1327,9 @@
           "frequency" : "DAY",
           "bucket" : "OBS-obsName",
           "basePath" : "css_repository/obs-path",
    -      "agency" : "css_obs_agency"
    +      "agency" : "css_obs_agency",
    +      "maxSnapshotBytesPerSeconds" : 40,
    +      "maxRestoreBytesPerSeconds" : 40
         },
         "roles" : [ {
           "flavorRef" : "ess.spec-4u8g",
    @@ -936,19 +1387,12 @@
         }
       }
     }
    +
-

Example Responses

Status code: 200

-

Request succeeded.

-
  • Example response for creating a pay-per-use cluster.

    -
    {
    -  "cluster" : {
    -    "id" : "ef683016-871e-48bc-bf93-74a29d60d214",
    -    "name" : "ES-Test"
    -  }
    -}
    -
  • Example response for creating a yearly/monthly cluster.

    -
    {
    -  "orderId" : "CS2208241141LY94J",
    +

    Example Responses

    Status code: 200

    +

    Request succeeded.

    +
    • Example response for creating a pay-per-use cluster.

      +
      {
         "cluster" : {
           "id" : "ef683016-871e-48bc-bf93-74a29d60d214",
           "name" : "ES-Test"
      @@ -956,45 +1400,45 @@
       }
    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request before retry.

    409

    +

    409

    The request could not be completed due to a conflict with the current state of the resource.

    -

    The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

    +

    The request could not be completed due to a conflict with the current state of the resource.

    +

    The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

    412

    +

    412

    The server did not meet one of the preconditions contained in the request.

    +

    The server did not meet one of the preconditions contained in the request.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/css/api-ref/CreateClustersTags.html b/docs/css/api-ref/CreateClustersTags.html index e35d21765..e1f5c5824 100644 --- a/docs/css/api-ref/CreateClustersTags.html +++ b/docs/css/api-ref/CreateClustersTags.html @@ -1,111 +1,165 @@

    Adding Tags to a Cluster

    -

    Function

    This API is used to add tags to a cluster.

    +

    Function

    Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources.

    +

    You can add tags to a cluster when creating a cluster or add them on the details page of a created cluster.

    +

    This API is used to add tags to a cluster.

    -

    URI

    POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags

    -
    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster that you want to add tags to.

    +

    Definition:

    +

    ID of the cluster that you want to add tags to. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    resource_type

    +

    resource_type

    Yes

    +

    Yes

    String

    +

    String

    Resource type. Currently, its value can only be css-cluster.

    +

    Definition:

    +

    Resource type. Currently, its value can only be css-cluster.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    css-cluster: Indicates the cluster type.

    +

    Default value:

    +

    N/A

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    tag

    +

    tag

    Yes

    +

    Yes

    Tag object

    +

    Tag object

    Tag object you want to add.

    +

    Definition:

    +

    Tag object you want to add.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    N/A

    +

    Default value:

    +

    N/A

    -
    Table 3 Tag

    Parameter

    +
    - - - - - - - - - - -
    Table 3 Tag

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    key

    Yes

    +

    Yes

    String

    +

    String

    Tag name.

    +

    Definition:

    +

    Tag key.

    +

    Constraints:

    +
    • The key cannot be empty. Its length is 1 to 128 characters.

      +
    • The value can contain UTF-8 letters, digits, spaces, and special characters _ . : = + - @.

      +
    • Tags starting with sys are system tags and cannot be used by tenants.

      +
    • Do not use spaces to start or end the key.

      +
    +

    Value range:

    +

    N/A

    +

    Default value:

    +

    N/A

    value

    +

    value

    Yes

    +

    Yes

    String

    +

    String

    Tag value.

    +

    Definition:

    +

    Tag value.

    +

    Constraints:

    +
    • The value contains 0 to 255 characters.

      +
    • The value can contain UTF-8 letters, digits, spaces, and special characters _.://=+-@

      +
    +

    Value range:

    +

    N/A

    +

    Default value:

    +

    N/A

    -

    Response Parameters

    None

    +

    Response Parameters

    Status code: 204

    +

    Request succeeded.

    +

    None

    -

    Example Requests

    Create a cluster tag.

    -
    POST /v1.0/6204a5bd270343b5885144cf9c8c158d/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags
    +

    Example Requests

    Add tags to a cluster.

    +
    POST https://{Endpoint}/v1.0/{project_id}/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags
     
     {
       "tag" : {
    @@ -114,42 +168,42 @@
       }
     }
    -

    Example Responses

    None

    +

    Example Responses

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - -

    Status Code

    Description

    +

    Description

    204

    +

    204

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    -

    The client should modify the request instead of re-initiating it.

    +

    Invalid request.

    +

    The client should modify the request instead of re-initiating it.

    409

    +

    409

    The request could not be completed due to a conflict with the current state of the resource.

    -

    This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

    +

    The request could not be completed due to a conflict with the current state of the resource.

    +

    This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

    412

    +

    412

    The server did not meet one of the preconditions contained in the request.

    +

    The server did not meet one of the preconditions contained in the request.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/css/api-ref/CreateElbListener.html b/docs/css/api-ref/CreateElbListener.html index 83bdaf12c..85b71302c 100644 --- a/docs/css/api-ref/CreateElbListener.html +++ b/docs/css/api-ref/CreateElbListener.html @@ -3,34 +3,50 @@

    Configuring Load Balancing Listeners for a Cluster

    Function

    This API is used to configure load balancing listeners for a cluster.

    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/es-listeners

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/es-listeners

    -
    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - - @@ -38,59 +54,59 @@

    Request Parameters

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster that you want to rename.

    +

    Definition:

    +

    ID of the cluster that you want to rename. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    Table 2 Request body parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - @@ -99,30 +115,31 @@

    Response Parameters

    Status code: 200

    -
    Table 2 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    protocol

    +

    protocol

    Yes

    +

    Yes

    String

    +

    String

    Protocol type. HTTP and HTTPS are supported.

    +

    Protocol type. HTTP and HTTPS are supported.

    protocol_port

    +

    protocol_port

    Yes

    +

    Yes

    Integer

    +

    Integer

    Port

    +

    Port

    server_cert_id

    +

    server_cert_id

    No

    +

    No

    String

    +

    String

    Server certificate ID. This parameter is mandatory when protocol is set to HTTPS.

    +

    Server certificate ID. This parameter is mandatory when protocol is set to HTTPS.

    ca_cert_id

    +

    ca_cert_id

    No

    +

    No

    String

    +

    String

    CA certificate ID. This parameter is mandatory when protocol is set to HTTPS and bidirectional authentication is used.

    +

    ID of the CA certificate. This parameter is mandatory when protocol is set to HTTPS and bidirectional authentication is used.

    type

    +

    type

    No

    +

    No

    String

    +

    String

    Type: searchTool indicates that the listener is configured for Elasticsearch/OpenSearch. viewTool indicates that the listener is configured for Kibana/OpenSearch Dashboards. The default value is searchTool.

    +

    Type: searchTool indicates that the listener is configured for Elasticsearch/OpenSearch. viewTool indicates that the listener is configured for Kibana/OpenSearch Dashboards. The default value is searchTool.

    Table 3 Response body parameters

    Parameter

    +
    - - - - -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    elb_id

    +

    elb_id

    String

    +

    String

    Load balancer ID

    +

    Load balancer ID.

    -

    Example Requests

    POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/es-listeners
    +

    Example Requests

    Configure ELB listeners for a cluster.

    +
    POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/es-listeners
     
     {
       "protocol" : "HTTPS",
    -  "protocol_port" : "9200",
    +  "protocol_port" : 9200,
       "server_cert_id" : "1b74ae4afad741e6bc9497429d3d0838",
       "ca_cert_id" : "2a7b050f598e4ea8a61cffbe2bdb312f"
     }
    @@ -134,32 +151,32 @@ }

    Status Codes

    -

    Status Code

    +
    - - - - - - - - - @@ -171,7 +188,7 @@
    diff --git a/docs/css/api-ref/CreateLoadIkThesaurus.html b/docs/css/api-ref/CreateLoadIkThesaurus.html deleted file mode 100644 index eb25ad45c..000000000 --- a/docs/css/api-ref/CreateLoadIkThesaurus.html +++ /dev/null @@ -1,186 +0,0 @@ - - -

    Loading Custom Word Dictionaries

    -

    Function

    This API is used to load a custom word dictionary stored in OBS.

    -
    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

    - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    +

    Invalid request.

    Modify the request instead of retrying.

    409

    +

    409

    The request cannot be processed due to a conflict.

    +

    The request cannot be processed due to a conflict.

    This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

    412

    +

    412

    The server does not meet one of the requirements that the requester puts on the request.

    +

    The server does not meet one of the requirements that the requester puts on the request.

    - - - - - - - - - - - - - - - - -
    Table 1 Path Parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    -

    cluster_id

    -

    Yes

    -

    String

    -

    ID of the cluster where a custom word dictionary you want to configure.

    -
    -
    - -

    Request Parameters

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Request body parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    bucketName

    -

    Yes

    -

    String

    -

    OBS bucket where the word dictionary file is stored. (The bucket type must be Standard or Infrequent Access. Archive is not supported).

    -

    mainObject

    -

    No

    -

    String

    -

    Main word dictionary file, which must be a text file encoded in UTF-8 without BOM. Each line contains one word. The maximum file size is 100 MB.

    -

    Modify the parameters of at least one of the seven word dictionaries. Note: Passing an empty "" character string will clear the word dictionary. Passing nothing or null will leave the word dictionary unchanged.

    -

    stopObject

    -

    No

    -

    String

    -

    Stop word dictionary file, which must be a text file encoded in UTF-8 without BOM. Each line contains one sub-word. The maximum file size is 100 MB.

    -

    At least one of the seven word dictionary parameters must be modified. Note: Passing an empty "" character string will clear the word dictionary. Passing nothing or null will leave the word dictionary unchanged.

    -

    synonymObject

    -

    No

    -

    String

    -

    Synonym dictionary file, which must be a text file encoded in UTF-8 without BOM. Each line contains one group of synonyms. The maximum file size is 100 MB.

    -

    At least one of the seven word dictionary parameters must be modified. Note: Passing an empty "" character string will clear the word dictionary. Passing nothing or null will leave the word dictionary unchanged.

    -

    static_main_object

    -

    No

    -

    String

    -

    Static main word dictionary file, which must be a text file encoded in UTF-8 without BOM. Each line contains one word. The maximum file size is 100 MB.

    -

    Modify the parameters of at least one of the seven word dictionaries. Note: Passing an empty "" character string will clear the word dictionary. Passing nothing or null will leave the word dictionary unchanged. Only new clusters created after this word dictionary function was brought online are supported.

    -

    static_stop_object

    -

    No

    -

    String

    -

    Static stop word dictionary file, which must be a text file encoded in UTF-8 without BOM. Each line contains one word. The maximum file size is 100 MB.

    -

    Modify the parameters of at least one of the seven word dictionaries. Note: Passing an empty "" character string will clear the word dictionary. Passing nothing or null will leave the word dictionary unchanged. Only new clusters created after this word dictionary function was brought online are supported.

    -

    extra_main_object

    -

    No

    -

    String

    -

    Extra main word dictionary file, which must be a text file encoded in UTF-8 without BOM. Each line contains one word. The maximum file size is 100 MB.

    -

    At least one of the seven word dictionary parameters must be modified. Note: Passing an empty "" character string will clear the word dictionary. Passing nothing or null will leave the word dictionary unchanged. Only new clusters created after this word dictionary function was brought online are supported.

    -

    extra_stop_object

    -

    No

    -

    String

    -

    Extra stop word dictionary file, which must be a text file encoded in UTF-8 without BOM. Each line contains one word. The maximum file size is 100 MB.

    -

    At least one of the seven word dictionary parameters must be modified. Note: Passing an empty "" character string will clear the word dictionary. Passing nothing or null will leave the word dictionary unchanged. Only new clusters created after this word dictionary function was brought online are supported.

    -
    -
    -
    -

    Response Parameters

    None

    -
    -

    Example Requests

    Enable and configure the word dictionary.

    -
    POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/thesaurus
    -
    -{
    -  "bucketName" : "test-bucket",
    -  "mainObject" : "word/main.txt",
    -  "stopObject" : "word/stop.txt",
    -  "synonymObject" : "word/synonym.txt",
    -  "static_main_object" : "word/staticMain.txt",
    -  "static_stop_object" : "word/staticStop.txt",
    -  "extra_main_object" : "word/extraMain.txt",
    -  "extra_stop_object" : "word/extraStop.txt"
    -}
    -
    -

    Example Responses

    None

    -
    -

    Status Codes

    -
    - - - - - - - - - - - - - -

    Status Code

    -

    Description

    -

    200

    -

    Request succeeded.

    -

    403

    -

    Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

    -

    500

    -

    The server is able to receive the request but unable to understand the request.

    -
    -
    -
    -

    Error Codes

    See Error Codes.

    -
    - -
    - -
    - diff --git a/docs/css/api-ref/CreateLogBackup.html b/docs/css/api-ref/CreateLogBackup.html index 08ba75f03..539d80eea 100644 --- a/docs/css/api-ref/CreateLogBackup.html +++ b/docs/css/api-ref/CreateLogBackup.html @@ -1,36 +1,52 @@

    Backing Up Logs

    -

    Function

    This API is used to back up logs.

    +

    Function

    This API is used to back up logs. If log backup is enabled for a cluster, you can call this API to back up the cluster's run logs to the specified OBS bucket. This ensures traceability, security, and reliability of cluster data.

    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collect

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collect

    -
    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - - @@ -39,39 +55,42 @@

    Request Parameters

    None

    -

    Response Parameters

    None

    +

    Response Parameters

    Status code: 200

    +

    Request succeeded.

    +

    None

    -

    Example Requests

    None

    +

    Example Requests

    Back up logs.

    +
    POST https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/collect

    Example Responses

    None

    Status Codes

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster whose logs you want to back up.

    +

    Definition:

    +

    ID of the cluster whose logs you want to back up. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    Status Code

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/CreateSnapshot.html b/docs/css/api-ref/CreateSnapshot.html index 266c044cc..2d7453390 100644 --- a/docs/css/api-ref/CreateSnapshot.html +++ b/docs/css/api-ref/CreateSnapshot.html @@ -1,36 +1,56 @@

    Manually Creating a Snapshot

    -

    Function

    This API is used to manually create a snapshot.

    +

    Function

    CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's data. By restoring this snapshot, you can restore the cluster to a previous state. There are two ways to create snapshots to back up a CSS cluster: automatic and manual.

    +
    • Automatic snapshot creation: Snapshots are created periodically based on a preset time policy, for example, daily or weekly, to ensure continuous data protection. This reduces manual effort and improves backup reliability and efficiency.

      +
    • Manual snapshot creation: You can manually create snapshots when necessary, for example, before performing a mission-critical operation (such as a cluster upgrade), so you can use these snapshots to quickly restore the cluster to a previous state in case anything goes wrong. Manual snapshots provide more flexibility.

      +
    +

    This API is used to manually create a snapshot.

    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    +

    Invalid request.

    Modify the request before retry.

    409

    +

    409

    The request could not be completed due to a conflict with the current state of the resource.

    +

    The request could not be completed due to a conflict with the current state of the resource.

    The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

    412

    +

    412

    The server did not meet one of the preconditions contained in the request.

    +

    The server did not meet one of the preconditions contained in the request.

    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - - @@ -38,41 +58,62 @@

    Request Parameters

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster for which you want to create a snapshot.

    +

    Definition:

    +

    ID of the cluster for which you want to create a snapshot. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    Table 2 Request body parameters

    Parameter

    +
    - - - - - - - - - - - - - - - @@ -81,45 +122,54 @@

    Response Parameters

    Status code: 201

    -
    Table 2 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    name

    +

    name

    Yes

    +

    Yes

    String

    +

    String

    Snapshot name. Enter 4 to 64 characters. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

    +

    Definition:

    +

    Snapshot name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Snapshot name. Enter 4 to 64 characters. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

    +

    Default value:

    +

    N/A

    description

    +

    description

    No

    +

    No

    String

    +

    String

    Snapshot description. The value can contain up to 256 characters and cannot contain the following characters: !<>=&"'

    +

    Definition:

    +

    Snapshot description.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    The value contains 0 to 256 characters and cannot contain !<>=&"'

    +

    Default value:

    +

    N/A

    indices

    +

    indices

    No

    +

    No

    String

    +

    String

    Name of an index to be backed up. Multiple indexes are separated by commas (,). By default, all indexes are backed up. You can use the combination of a backslash and an asterisk (*) to back up data of certain indexes. For example, if you specify 2018-06*, then the data of the indexes with the prefix 2018-06 will be backed up.The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?

    +

    Definition:

    +

    Name of an index to be backed up. Multiple indexes are separated by commas (,). By default, all indexes are backed up. You can use the combination of a backslash and an asterisk (*) to back up data of certain indexes. For example, if you specify 2018-06*, then the data of the indexes with the prefix 2018-06 will be backed up.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?

    +

    Default value:

    +

    *, indicating all indexes.

    Table 3 Response body parameters

    Parameter

    +
    - - - - -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    backup

    +

    backup

    backupRsp object

    +

    backupRsp object

    Snapshot information.

    +

    Definition:

    +

    The snapshot information.

    +

    Value range:

    +

    N/A

    -
    Table 4 backupRsp

    Parameter

    +
    - - - - - - - - @@ -127,7 +177,7 @@

    Example Requests

    Create a snapshot.

    -
    POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot
    +
    POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot
     
     {
       "name" : "snapshot_001",
    @@ -144,41 +194,42 @@
     }

    Status Codes

    -
    Table 4 backupRsp

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Snapshot ID

    +

    Definition:

    +

    Snapshot ID.

    +

    Value range:

    +

    N/A

    name

    +

    name

    String

    +

    String

    Snapshot name

    +

    Definition:

    +

    Snapshot name.

    +

    Value range:

    +

    Snapshot name. Enter 4 to 64 characters. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

    Status Code

    +
    - - - - - - - - - - - - - diff --git a/docs/css/api-ref/DeleteAiOps.html b/docs/css/api-ref/DeleteAiOps.html index 887c95e1b..f6add9895 100644 --- a/docs/css/api-ref/DeleteAiOps.html +++ b/docs/css/api-ref/DeleteAiOps.html @@ -3,43 +3,59 @@

    Deleting a Detection Task

    Function

    This API is used to delete a detection task.

    -

    URI

    DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}

    -

    Status Code

    Description

    +

    Description

    201

    +

    201

    Resource created.

    +

    Resource created.

    400

    +

    400

    Invalid request.

    +

    Invalid request.

    Modify the request before retry.

    403

    +

    403

    Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

    +

    Request rejected.

    +

    The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

    406

    +

    406

    The server could not fulfill the request according to the content characteristics of the request.

    +

    The server could not fulfill the request according to the content characteristics of the request.

    500

    +

    500

    The server has received the request but could not understand it.

    +

    The server has received the request but could not understand it.

    501

    +

    501

    The server does not support the function required to fulfill the request.

    +

    The server does not support the function required to fulfill the request.

    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - - - - - - @@ -48,40 +64,42 @@

    Request Parameters

    None

    -

    Response Parameters

    None

    +

    Response Parameters

    Status code: 200

    +

    Request succeeded.

    +

    None

    Example Requests

    Delete a detection task.

    -
    DELETE /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops/e19c9298-465e-42ad-a0ae-b6b552222925
    +
    DELETE https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops/e19c9298-465e-42ad-a0ae-b6b552222925

    Example Responses

    None

    Status Codes

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster to be deleted

    +

    Definition:

    +

    ID of the cluster to be deleted. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    aiops_id

    +

    aiops_id

    Yes

    +

    Yes

    String

    +

    String

    ID of a detection task

    +

    ID of a detection task

    Status Code

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/DeleteCluster.html b/docs/css/api-ref/DeleteCluster.html index 673e47206..04de6aa9f 100644 --- a/docs/css/api-ref/DeleteCluster.html +++ b/docs/css/api-ref/DeleteCluster.html @@ -1,80 +1,100 @@

    Deleting a Cluster

    -

    Function

    This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluster, create a snapshot before deleting the cluster.

    -
    This API can also be used to unsubscribe from yearly/monthly clusters. Clusters frozen for public security reasons cannot be deleted. Deleting a cluster will also clear its data. Exercise caution.
    +

    Function

    This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluster, create a snapshot before deleting the cluster.

    +

    Clusters frozen for public security reasons cannot be deleted. Deleting a cluster will also clear its data. Exercise caution.

    +
    -

    URI

    DELETE /v1.0/{project_id}/clusters/{cluster_id}

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    DELETE /v1.0/{project_id}/clusters/{cluster_id}

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    +

    Invalid request.

    Modify the request instead of retrying.

    409

    +

    409

    The request cannot be processed due to a conflict.

    +

    The request cannot be processed due to a conflict.

    This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

    412

    +

    412

    The server does not meet one of the requirements that the requester puts on the request.

    +

    The server does not meet one of the requirements that the requester puts on the request.

    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster you want to delete.

    +

    Definition:

    +

    ID of the cluster you want to delete. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    -

    Request Parameters

    None

    +

    Request Parameters

    None

    -

    Response Parameters

    None

    +

    Response Parameters

    Status code: 200

    +

    Request succeeded.

    +

    None

    -

    Example Requests

    None

    +

    Example Requests

    Delete a cluster.

    +
    DELETE https://{Endpoint}/v1.0/{project_id}/clusters/2a197c4d-5467-4003-931d-83ec49939cf
    -

    Example Responses

    None

    +

    Example Responses

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request before retry.

    404

    +

    404

    The requested resource could not be found.

    -

    Modify the request before retry.

    +

    The requested resource could not be found.

    +

    Modify the request before retry.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/css/api-ref/DeleteClustersTags.html b/docs/css/api-ref/DeleteClustersTags.html index b65262300..84d1ea206 100644 --- a/docs/css/api-ref/DeleteClustersTags.html +++ b/docs/css/api-ref/DeleteClustersTags.html @@ -1,54 +1,86 @@

    Deleting a Cluster Tag

    -

    Function

    This API is used to delete a cluster tag.

    +

    Function

    Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources.

    +

    You can add tags to a cluster when creating a cluster or add them on the details page of a created cluster.

    +

    This API is used to delete cluster tags. You can delete unnecessary cluster tags to facilitate cluster management.

    -

    URI

    DELETE /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/{key}

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    DELETE /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/{key}

    -
    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - @@ -57,33 +89,36 @@

    Request Parameters

    None

    -

    Response Parameters

    None

    +

    Response Parameters

    Status code: 204

    +

    Request succeeded.

    +

    None

    -

    Example Requests

    None

    +

    Example Requests

    Delete the tags of a cluster.

    +
    DELETE https://{Endpoint}/v1.0/{project_id}/css-cluster/2a197c4d-5467-4003-931d-83ec49939cf/tags/K1

    Example Responses

    None

    Status Codes

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster that you want to delete tags from.

    +

    Definition:

    +

    ID of the cluster that you want to delete tags from. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    resource_type

    +

    resource_type

    Yes

    +

    Yes

    String

    +

    String

    Resource type. Currently, its value can only be css-cluster.

    +

    Definition:

    +

    Resource type. Currently, its value can only be css-cluster.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    css-cluster: Indicates the cluster type.

    +

    Default value:

    +

    N/A

    key

    +

    key

    Yes

    +

    Yes

    String

    +

    String

    Name of the tag you want to delete. If the tag name is in Chinese, encode the tag name using URL before calling the API.

    +

    Definition:

    +

    Name of the tag you want to delete

    +

    Constraints:

    +

    If the tag name is in Chinese, encode the tag name using URL before calling the API.

    +

    Value range:

    +

    N/A

    +

    Default value:

    +

    N/A

    Status Code

    +
    - - - - - - - diff --git a/docs/css/api-ref/DeleteIkThesaurus.html b/docs/css/api-ref/DeleteIkThesaurus.html deleted file mode 100644 index 1833e7936..000000000 --- a/docs/css/api-ref/DeleteIkThesaurus.html +++ /dev/null @@ -1,82 +0,0 @@ - - -

    Disabling a Word Dictionary

    -

    Function

    This API is used to clear custom word dictionaries (main word dictionary, stop word dictionary, and synonym dictionary).

    -
    -

    URI

    DELETE /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

    - -

    Status Code

    Description

    +

    Description

    204

    +

    204

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    +

    Invalid request.

    The client should modify the request instead of re-initiating it.

    404

    +

    404

    The requested resource could not be found.

    +

    The requested resource could not be found.

    The client should not repeat the request without modifications.

    - - - - - - - - - - - - - - - - -
    Table 1 Path Parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    -

    cluster_id

    -

    Yes

    -

    String

    -

    ID of the cluster whose custom word dictionary you want to delete.

    -
    -
    - -

    Request Parameters

    None

    -
    -

    Response Parameters

    None

    -
    -

    Example Requests

    None

    -
    -

    Example Responses

    None

    -
    -

    Status Codes

    -
    - - - - - - - - - - - - - -

    Status Code

    -

    Description

    -

    200

    -

    Request succeeded.

    -

    403

    -

    Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

    -

    500

    -

    The server is able to receive but unable to understand the request.

    -
    -
    -
    -

    Error Codes

    See Error Codes.

    -
    - -
    - -
    - diff --git a/docs/css/api-ref/DeleteSnapshot.html b/docs/css/api-ref/DeleteSnapshot.html index ebb9cce24..d555510ca 100644 --- a/docs/css/api-ref/DeleteSnapshot.html +++ b/docs/css/api-ref/DeleteSnapshot.html @@ -1,88 +1,120 @@

    Deleting a Snapshot

    -

    Function

    This API is used to delete a snapshot.

    -
    After a snapshot is deleted, its data cannot be restored. Exercise caution.
    +

    Function

    CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's data. By restoring this snapshot, you can restore the cluster to a previous state. There are two ways to create snapshots to back up a CSS cluster: automatic and manual.

    +
    • Automatic snapshot creation: Snapshots are created periodically based on a preset time policy, for example, daily or weekly, to ensure continuous data protection. This reduces manual effort and improves backup reliability and efficiency.

      +
    • Manual snapshot creation: You can manually create snapshots when necessary, for example, before performing a mission-critical operation (such as a cluster upgrade), so you can use these snapshots to quickly restore the cluster to a previous state in case anything goes wrong. Manual snapshots provide more flexibility.

      +
    +

    This API is used to delete a snapshot.

    +

    After a snapshot is deleted, its data cannot be restored. Exercise caution.

    +
    -

    URI

    DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}

    -
    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster whose snapshot you want to delete.

    +

    Definition:

    +

    ID of the cluster to which the to-be-deleted snapshot belongs. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    snapshot_id

    +

    snapshot_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the snapshot you want to delete.

    +

    Definition:

    +

    ID of the snapshot you want to delete.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    N/A

    +

    Default value:

    +

    N/A

    -

    Request Parameters

    None

    +

    Request Parameters

    None

    -

    Response Parameters

    None

    +

    Response Parameters

    Status code: 200

    +

    Request succeeded.

    +

    None

    -

    Example Requests

    None

    +

    Example Requests

    Delete a snapshot.

    +
    DELETE https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/29a2254e-947f-4463-b65a-5f0b17515fae
    -

    Example Responses

    None

    +

    Example Responses

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request before retry.

    403

    +

    403

    Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

    +

    Request rejected.

    +

    The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

    -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/css/api-ref/DownloadCert.html b/docs/css/api-ref/DownloadCert.html index 612bce0de..7aca3aa2f 100644 --- a/docs/css/api-ref/DownloadCert.html +++ b/docs/css/api-ref/DownloadCert.html @@ -1,32 +1,34 @@

    Downloading a Security Certificate

    -

    Function

    This API is used to download a security certificate.

    +

    Function

    The certificate obtained through this API can be used for HTTPS-based secure cluster connections, where encryption and user authentication occur.

    -

    URI

    GET /v1.0/{project_id}/cer/download

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    GET /v1.0/{project_id}/cer/download

    -
    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - @@ -39,19 +41,22 @@

    Response Parameters

    Status code: 200

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Parameter description:

    -

    The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    Constraints:

    N/A

    -

    Options:

    -

    For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Value range:

    +

    Project ID of the account.

    Default value:

    N/A

    Table 2 Response body parameters

    Parameter

    +
    - - - - - @@ -66,26 +71,26 @@
    "Certificate:xxxx"

    Status Codes

    -
    Table 2 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    -

    +

    file

    File

    +

    String

    File stream

    +

    Definition:

    +

    File stream

    +

    Default value:

    +

    N/A

    Status Code

    +
    - - - - - - - diff --git a/docs/css/api-ref/EnableOrDisableElb.html b/docs/css/api-ref/EnableOrDisableElb.html index 34c996d0c..9c03171a2 100644 --- a/docs/css/api-ref/EnableOrDisableElb.html +++ b/docs/css/api-ref/EnableOrDisableElb.html @@ -3,34 +3,50 @@

    Enabling or Disabling Load Balancers for a Cluster

    Function

    This API is used to enable or disable load balancers for a cluster.

    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switch

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switch

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    +

    Invalid request.

    Modify the request before retry.

    404

    +

    404

    The requested resource could not be found.

    +

    The requested resource could not be found.

    Modify the request before retry.

    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - - @@ -38,53 +54,82 @@

    Request Parameters

    -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster to be modified

    +

    Definition:

    +

    ID of the cluster to be modified. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    Table 2 Request body parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - @@ -93,19 +138,19 @@

    Response Parameters

    Status code: 200

    -
    Table 2 Request body parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    enable

    +

    enable

    Yes

    +

    Yes

    Boolean

    +

    Boolean

    Enable or disable the ES load balancer.

    -
    • true: enable the ES load balancer.

      -
    • false: disable the ES load balancer.

      +

    Definition:

    +

    Enable or disable the ES load balancer.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +
    • true: Yes

      +
    • false: This option will be disabled.

    +

    Default value:

    +

    N/A

    agency

    +

    agency

    No

    +

    No

    String

    +

    String

    Agency name

    +

    Definition:

    +

    Name of the agency used to configure load balancing. This parameter is mandatory when enable is set to true.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    N/A

    +

    Default value:

    +

    N/A

    elb_id

    +

    elb_id

    No

    +

    No

    String

    +

    String

    Load balancer ID

    +

    Definition:

    +

    Load balancer ID. This parameter is mandatory when enable is set to true.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    N/A

    +

    Default value:

    +

    N/A

    type

    +

    type

    No

    +

    No

    String

    +

    String

    Type: searchTool indicates that the load balancer is enabled or disabled for Elasticsearch/OpenSearch. viewTool indicates that the load balancer is enabled or disabled for Kibana/OpenSearch Dashboards. The default value is searchTool.

    +

    Definition:

    +

    Load balancer type. This parameter is not required for an observability cluster.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +
    • searchTool: Enable or disable an Elasticsearch/OpenSearch load balancer.

      +
    • viewTool: Enable or disable the Kibana/OpenSearch Dashboards load balancer.

      +
    +

    Default value:

    +

    searchTool

    Table 3 Response body parameters

    Parameter

    +
    - - - - - @@ -113,7 +158,7 @@

    Example Requests

    Enable the load balancer.

    -
    POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/loadbalancers/es-switch
    +
    POST https://{Endpoint}/v1.0/{project_id}/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/loadbalancers/es-switch
     
     {
       "enable" : true,
    @@ -128,32 +173,32 @@
     }

    Status Codes

    -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    elb_id

    +

    elb_id

    String

    +

    String

    Load balancer ID

    +

    Load balancer ID.

    Status Code

    +
    - - - - - - - - - @@ -165,7 +210,7 @@
    diff --git a/docs/css/api-ref/GetRoutes.html b/docs/css/api-ref/GetRoutes.html new file mode 100644 index 000000000..659bcf236 --- /dev/null +++ b/docs/css/api-ref/GetRoutes.html @@ -0,0 +1,239 @@ + + +

    Obtaining a Cluster Route

    +

    Function

    By default, a CSS Elasticsearch cluster cannot access a target service—such as a client program or a Lightweight Directory Access Protocol (LDAP) service—that is located in a different VPC. To enable this access, you need to configure cluster routes. This API is used to obtain cluster route information, including the route IP address and the total number of routes.

    +
    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    GET /v1.0/{project_id}/clusters/{cluster_id}/route

    + +

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    +

    Invalid request.

    Modify the request instead of retrying.

    409

    +

    409

    The request cannot be processed due to a conflict.

    +

    The request cannot be processed due to a conflict.

    This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

    412

    +

    412

    The server does not meet one of the requirements that the requester puts on the request.

    +

    The server does not meet one of the requirements that the requester puts on the request.

    + + + + + + + + + + + + + + + + +
    Table 1 Path Parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    project_id

    +

    Yes

    +

    String

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    +

    cluster_id

    +

    Yes

    +

    String

    +

    Definition:

    +

    ID of the target cluster. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 2 Query Parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    offset

    +

    No

    +

    Integer

    +

    Definition:

    +

    The start value of the query. The default value is 1, indicating that the query starts from the first route.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    1-1000

    +

    Default value:

    +

    1

    +

    limit

    +

    No

    +

    Integer

    +

    Parameter description:

    +

    Number of routes to be queried. The default value is 10, indicating that 10 routes are queried at a time.

    +

    Constraints:

    +

    N/A

    +

    Options:

    +

    1-1000

    +

    Default value:

    +

    10

    +
    +
    + +

    Request Parameters

    None

    +
    +

    Response Parameters

    Status code: 200

    + +
    + + + + + + + + + + + + + +
    Table 3 Response body parameters

    Parameter

    +

    Type

    +

    Description

    +

    routeResps

    +

    Array of RouteRespsResource objects

    +

    Definition:

    +

    Route IP address.

    +

    Value range:

    +

    N/A

    +

    totalSize

    +

    Integer

    +

    Definition:

    +

    Total number of routes.

    +

    Value range:

    +

    N/A

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 4 RouteRespsResource

    Parameter

    +

    Type

    +

    Description

    +

    ipAddress

    +

    String

    +

    Definition:

    +

    IP address.

    +

    Value range:

    +

    N/A

    +

    ipNetMask

    +

    String

    +

    Definition:

    +

    Subnet mask.

    +

    Value range:

    +

    N/A

    +

    updateAt

    +

    String

    +

    Definition:

    +

    Route IP address update time.

    +

    Value range:

    +

    N/A

    +
    +
    +
    +

    Example Requests

    Obtain cluster routes.

    +
    GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/route
    +
    +

    Example Responses

    Status code: 200

    +

    Request succeeded.

    +
    {
    +  "routeResps" : [ {
    +    "ipAddress" : "1.2.3.65",
    +    "ipNetMask" : "255.255.255.255",
    +    "updateAt" : "2023-07-17T08:09:20"
    +  }, {
    +    "ipAddress" : "1.1.1.1",
    +    "ipNetMask" : "255.255.255.255",
    +    "updateAt" : "2023-07-17T08:08:50"
    +  } ],
    +  "totalSize" : 2
    +}
    +
    +

    Status Codes

    +
    + + + + + + + + + + + + + + + + +

    Status Code

    +

    Description

    +

    200

    +

    Request succeeded.

    +

    400

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    +

    409

    +

    The request cannot be processed due to a conflict.

    +

    This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

    +

    412

    +

    The server does not meet one of the requirements that the requester puts on the request.

    +
    +
    +
    +

    Error Codes

    See Error Codes.

    +
    + +
    + +
    + diff --git a/docs/css/api-ref/ListAiOps.html b/docs/css/api-ref/ListAiOps.html index cc92b2157..7b92b1aa5 100644 --- a/docs/css/api-ref/ListAiOps.html +++ b/docs/css/api-ref/ListAiOps.html @@ -1,68 +1,98 @@

    Obtaining the Intelligent O&M Task List and Details

    -

    Function

    This API is used to obtain the intelligent O&M task list and details.

    +

    Function

    CSS provides intelligent O&M to check potential risks in clusters. After a scan task is completed, check the risks identified by the task, confirm and handle these risks in a timely manner based on risk handling suggestions. This API is used to obtain the intelligent O&M task list and details.

    -

    URI

    GET /v1.0/{project_id}/clusters/{cluster_id}/ai-ops

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    GET /v1.0/{project_id}/clusters/{cluster_id}/ai-ops

    -
    Table 1 Path Parameters

    Parameter

    +
    - - - - - - - - - - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster you want to query

    +

    Definition:

    +

    ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Cluster ID.

    +

    Default value:

    +

    N/A

    -
    Table 2 Query Parameters

    Parameter

    +
    - - - - - - - - - - - @@ -73,91 +103,116 @@

    Response Parameters

    Status code: 200

    -
    Table 2 Query Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    Integer

    Pagination parameter, indicating the maximum number of records on a page.

    +

    Definition:

    +

    Pagination parameter, indicating the maximum number of records on a page. The default value is 10, indicating that 10 tasks are queried at a time.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    1-1000

    +

    Default value:

    +

    10

    start

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Offset. All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

    +

    Definition:

    +

    Offset. All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    0-1000

    +

    Default value:

    +

    0

    Table 3 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    total_size

    +

    total_size

    Integer

    +

    Integer

    Number of detection tasks

    +

    Definition:

    +

    Number of cluster risk detection tasks.

    +

    Value range:

    +

    1-1000

    aiops_list

    +

    aiops_list

    Array of aiops_list objects

    +

    Array of aiops_list objects

    Detection task details list

    +

    Definition:

    +

    Cluster risk detection task details.

    +

    Value range:

    +

    N/A

    -
    Table 4 aiops_list

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 4 aiops_list

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Detection task ID

    +

    Definition:

    +

    ID of a cluster risk detection task.

    +

    Value range:

    +

    N/A

    name

    +

    name

    String

    +

    String

    Detection task name

    +

    Definition:

    +

    Name of a cluster risk detection task.

    +

    Value range:

    +

    N/A

    desc

    +

    desc

    String

    +

    String

    Detection task description

    +

    Definition:

    +

    Description of a cluster risk detection task.

    +

    Value range:

    +

    N/A

    status

    +

    status

    Integer

    +

    Integer

    Task execution status.

    +

    Definition:

    +

    Task execution status.

    +

    Value range:

    • 150: The function is disabled.

    • 200: The function is enabled.

    • 300: A message has been sent.

    summary

    +

    summary

    summary object

    +

    summary object

    Risk summary

    +

    Definition:

    +

    Cluster risk overview.

    +

    Value range:

    +

    N/A

    create_time

    +

    create_time

    String

    +

    String

    Timestamp when a detection task is created

    +

    Definition:

    +

    Time when a cluster risk detection task was created.

    +

    Value range:

    +

    Format: Unix timestamp.

    smn_status

    +

    smn_status

    String

    +

    String

    Status of the SMN alarm message sending task.

    +

    Definition:

    +

    Status of the task that sends cluster risk information via SMN.

    +

    Value range:

    • not_open

    • not_trigger

    • sent

      @@ -165,95 +220,121 @@

    smn_fail_reason

    +

    smn_fail_reason

    String

    +

    String

    Cause of the message sending failure

    +

    Definition:

    +

    Reason why cluster risk information failed to be sent via SMN.

    +

    Value range:

    +

    N/A

    task_risks

    +

    task_risks

    Array of AIOpsRiskInfo objects

    +

    Array of AIOpsRiskInfo objects

    Risk item details

    +

    Definition:

    +

    Cluster risk details.

    +

    Value range:

    +

    N/A

    -
    Table 5 summary

    Parameter

    +
    - - - - - - - - - - -
    Table 5 summary

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    high

    +

    high

    Integer

    +

    Integer

    Number of high-risk detection items

    +

    Definition:

    +

    Number of high-risk items.

    +

    Value range:

    +

    0-100

    medium

    +

    medium

    Integer

    +

    Integer

    Number of medium-risk detection items

    +

    Definition:

    +

    Number of medium-risk items.

    +

    Value range:

    +

    0-100

    suggestion

    +

    suggestion

    Integer

    +

    Integer

    Number of suggestion detection items

    +

    Definition:

    +

    Number of items that are just informational.

    +

    Value range:

    +

    0-100

    -
    Table 6 AIOpsRiskInfo

    Parameter

    +
    - - - - - - - - - - - - - - @@ -261,7 +342,7 @@

    Example Requests

    This API is used to obtain the intelligent O&M task list and details.

    -
    GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops
    +
    GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops

    Example Responses

    Status code: 200

    Request succeeded.

    @@ -278,14 +359,13 @@ }, "create_time" : 1687944156750, "smn_status" : "not_open", - "smn_fail_reason" : null, "task_risks" : [ { "riskType" : "Check for snapshot creation failures and snapshot records in the cluster in the last seven days.", "level" : "suggestion", "desc" : "There are no snapshot records in the cluster in the last seven days.", "suggestion" : "You are advised to enable cluster snapshot and ensure that snapshots are successfully created within seven days. If snapshot creation fails, click the cluster name, and check the failure details on the Cluster Snapshots and Logs pages." }, { - "riskType" : "Check the number of nodes in the cluster and the number of AZs to evaluate the high availability status of the distributed Elasticsearch cluster.", + "riskType" : "Check the number of nodes in a cluster and the number of AZs to evaluate the high availability status of a distributed Elasticsearch cluster.", "level" : "high", "desc" : "The current cluster has one or two nodes. If a node is faulty, the entire cluster may become unavailable. The service availability risk is high.", "suggestion" : "You are advised to change the cluster to a multi-AZ cluster. Procedure: On the CSS cluster console, choose Clusters > Elasticsearch. In the Operation column of a cluster, choose More > Modify Configuration. Click the Change AZ tab and add AZs. Click the Scale Cluster tab and change the number of nodes." @@ -295,32 +375,32 @@ }

    Status Codes

    -
    Table 6 AIOpsRiskInfo

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    riskType

    +

    riskType

    String

    +

    String

    Check item description

    +

    Definition:

    +

    Cluster risk detection items.

    +

    Value range:

    +

    N/A

    level

    +

    level

    String

    +

    String

    Risk level.

    -
    • high

      -
    • medium

      -
    • suggestion

      +

    Definition:

    +

    Cluster risk level.

    +

    Value range:

    +
    • high: high risk for the cluster.

      +
    • medium: medium risk for the cluster.

      +
    • suggestion: suggestion.

    desc

    +

    desc

    String

    +

    String

    Risk description

    +

    Definition:

    +

    Cluster risk description.

    +

    Value range:

    +

    N/A

    suggestion

    +

    suggestion

    String

    +

    String

    Risk suggestion

    +

    Definition:

    +

    Cluster risk handling suggestions.

    +

    Value range:

    +

    N/A

    Status Code

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/ListClustersDetails.html b/docs/css/api-ref/ListClustersDetails.html index 327a2ef31..bf13504ae 100644 --- a/docs/css/api-ref/ListClustersDetails.html +++ b/docs/css/api-ref/ListClustersDetails.html @@ -1,748 +1,966 @@

    Querying the Cluster List

    -

    Function

    This API is used to query and display the cluster list and cluster status.

    +

    Function

    This API is used to query the cluster list and cluster status, including cluster nodes, Kibana public network access information, public network IP address, and IPv4 address and port number for private network access. After a cluster is created, check the cluster information and update the cluster in a timely manner.

    -

    URI

    GET /v1.0/{project_id}/clusters

    +

    Calling Method

    For details, see Calling APIs.

    +
    +

    URI

    GET /v1.0/{project_id}/clusters

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    Request succeeded.

    400

    +

    400

    Invalid request.

    +

    Invalid request.

    Modify the request instead of retrying.

    409

    +

    409

    The request cannot be processed due to a conflict.

    +

    The request cannot be processed due to a conflict.

    This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

    412

    +

    412

    The server does not meet one of the requirements that the requester puts on the request.

    +

    The server does not meet one of the requirements that the requester puts on the request.

    Table 1 Path Parameters

    Parameter

    +
    - - - - - - -
    Table 1 Path Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Parameter description:

    -

    The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    -

    Constraints:

    -

    N/A

    -

    Options:

    -

    For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    -

    Default value:

    -

    N/A

    +

    Definition:

    +

    Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    Project ID of the account.

    +

    Default value:

    +

    N/A

    -
    Table 2 Query Parameters

    Parameter

    +
    - - - - - - - - - - - - - - -
    Table 2 Query Parameters

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    start

    +

    offset

    No

    +

    No

    Integer

    +

    Integer

    Parameter description:

    -

    The start value of the query. The default value is 1, indicating that the query starts from the first cluster.

    -

    Constraints:

    -

    N/A

    -

    Options:

    -

    1-1000

    -

    Default value:

    -

    1

    +

    Definition:

    +

    The start value of the query.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    1-1000

    +

    Default value:

    +

    The default value is 1, indicating that the query starts from the first cluster.

    limit

    +

    limit

    No

    +

    No

    Integer

    +

    Integer

    Parameter description:

    -

    Number of clusters to be queried. The default value is 10, indicating that the information about 10 clusters is queried at a time.

    -

    Constraints:

    -

    N/A

    -

    Options:

    -

    1-1000

    -

    Default value:

    -

    10

    +

    Definition:

    +

    Number of clusters to be queried.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +

    1-1000

    +

    Default value:

    +

    The default value is 10, indicating that 10 clusters are queried at a time.

    datastoreType

    +

    datastoreType

    No

    +

    No

    String

    +

    String

    Parameter description:

    -

    Cluster engine type.

    -

    Constraints:

    -

    N/A

    -

    Options:

    -

    elasticsearch, logstash, or opensearch.

    -

    Default value:

    -

    This parameter has no default value. When this parameter is left blank, all types of clusters are queried.

    +

    Definition:

    +

    Cluster engine type.

    +

    Constraints:

    +

    N/A

    +

    Value range:

    +
    • elasticsearch: Provides distributed search capabilities, log analytics, reporting, and semantic search based on open-source Elasticsearch.

      +
    • logstash: Provides functions such as data ingestion, transformation, cleaning, and parsing based on open-source Logstash.

      +
    • opensearch: Provides distributed search, log analytics, reporting, and semantic search based on open-source OpenSearch. It is the future version of CSS's Elasticsearch clusters.

      +
    • When this parameter is left blank, all types of clusters are queried.

      +
    +

    Default value:

    +

    The default value is empty.

    -

    Request Parameters

    None

    +

    Request Parameters

    None

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    -
    Table 3 Response body parameters

    Parameter

    +
    - - - - - - - -
    Table 3 Response body parameters

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    totalSize

    +

    totalSize

    Integer

    +

    Integer

    Parameter description:

    -

    Number of clusters.

    +

    Definition:

    +

    Number of clusters. If datastoreType is specified, the number of clusters of the specified type is displayed. Otherwise, the number of all clusters is displayed.

    +

    Value range:

    +

    N/A

    clusters

    +

    clusters

    Array of ClusterList objects

    +

    Array of ClusterList objects

    Parameter description:

    -

    List of cluster objects.

    +

    Definition:

    +

    Cluster object list.

    +

    Value range:

    +

    N/A

    -
    Table 4 ClusterList

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
    Table 4 ClusterList

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    datastore

    +

    datastore

    ClusterListDatastore object

    +

    ClusterListDatastore object

    Parameter description:

    -

    Search engine.

    +

    Definition:

    +

    Cluster data search engine type.

    +

    Value range:

    +

    N/A

    instances

    +

    snapshotPolicy

    Array of ClusterListInstances objects

    +

    SnapshotPolicyResp object

    Parameter description:

    -

    List of node objects.

    +

    Definition:

    +

    Information about an automatic snapshot creation policy.

    +

    Value range:

    +

    N/A

    publicKibanaResp

    +

    instances

    publicKibanaRespBody object

    +

    Array of ClusterListInstances objects

    Parameter description:

    -

    Kibana public network access information.

    +

    Definition:

    +

    Cluster node list.

    +

    Value range:

    +

    N/A

    elbWhiteList

    +

    publicKibanaResp

    elbWhiteListResp object

    +

    publicKibanaRespBody object

    Parameter description:

    -

    Public network access control information.

    +

    Definition:

    +

    Kibana public network access information.

    +

    Value range:

    +

    N/A

    updated

    +

    elbWhiteList

    String

    +

    elbWhiteListResp object

    Parameter description:

    -

    Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

    +

    Definition:

    +

    Public network access control information.

    +

    Value range:

    +

    N/A

    name

    +

    updated

    String

    +

    String

    Parameter description:

    -

    Cluster name.

    +

    Definition:

    +

    Time when the cluster was last modified.

    +

    Value range:

    +

    The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

    publicIp

    +

    name

    String

    +

    String

    Parameter description:

    -

    Public IP address information.

    +

    Definition:

    +

    Cluster name.

    +

    Value range:

    +

    N/A

    created

    +

    publicIp

    String

    +

    String

    Parameter description:

    -

    Cluster creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

    -

    The returned cluster list is sorted by creation time in descending order. The latest cluster is displayed at the top.

    +

    Definition:

    +

    Public IP address information.

    +

    Value range:

    +

    N/A

    id

    +

    created

    String

    +

    String

    Parameter description:

    -

    Cluster ID.

    +

    Definition:

    +

    Cluster creation time. The returned cluster list is sorted by creation time in descending order. The latest cluster is displayed at the top.

    +

    Value range:

    +

    The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

    status

    +

    id

    String

    +

    String

    Parameter description:

    -

    Cluster status.

    -

    Options:

    -
    • 100: creating

      -
    • 200: Available

      -
    • 303: Unavailable, for example, due to a creation failure.

      +

    Definition:

    +

    Cluster ID.

    +

    Value range:

    +

    N/A

    +

    status

    +

    String

    +

    Definition:

    +

    Cluster status.

    +

    Value range:

    +
    • 100: creating

      +
    • 200: available

      +
    • 300: unavailable

      +
    • 303: creation failed

    endpoint

    +

    endpoint

    String

    +

    String

    Parameter description:

    -

    IPv4 address and port number accessed from the cluster's private network. [If the cluster type is KooSearch, this field indicates the internal address and port number for accessing the knowledge management service.] (tag:white)

    +

    Definition:

    +

    IPv4 address and port number accessed from the cluster's private network. [If the cluster type is KooSearch, this field indicates the internal address and port number for accessing the knowledge management service.] (tag:white)

    +

    Value range:

    +

    N/A

    vpcId

    +

    vpcId

    String

    +

    String

    Parameter description:

    -

    VPC ID.

    +

    Definition:

    +

    VPC ID.

    +

    Value range:

    +

    N/A

    subnetId

    +

    subnetId

    String

    +

    String

    Parameter description:

    -

    Subnet ID

    +

    Definition:

    +

    Current subnet of a cluster. The subnet is used for adding nodes, including scaling, adding dedicated master/client nodes, and enabling VPC Endpoint. IP addresses will be allocated to newly added nodes from the new subnet.

    +

    Value range:

    +

    N/A

    securityGroupId

    +

    securityGroupId

    String

    +

    String

    Parameter description:

    -

    Security group ID.

    +

    Definition:

    +

    Security group ID.

    +

    Value range:

    +

    N/A

    bandwidthSize

    +

    bandwidthSize

    Integer

    +

    Integer

    Parameter description:

    -

    Public network bandwidth. Unit: Mbit/s

    +

    Definition:

    +

    Public network bandwidth. Unit (Mbit/s).

    +

    Value range:

    +

    N/A

    httpsEnable

    +

    httpsEnable

    Boolean

    +

    Boolean

    Parameter description:

    -

    Communication encryption status.

    -

    Options:

    -
    • false: Communication encryption is not enabled.

      -
    • true: Communication encryption is enabled.

      +

    Definition:

    +

    Whether HTTPS access is enabled.

    +

    Value range:

    +
    • false: HTTPS access is disabled.

      +
    • true: HTTPS access is enabled.

    authorityEnable

    +

    authorityEnable

    Boolean

    +

    Boolean

    Parameter description:

    -

    Whether to enable authentication.

    -

    Options:

    -
    • true: Authentication is enabled for the cluster.

      -
    • false: Authentication is disabled for the cluster.

      +

    Definition:

    +

    Whether to enable security mode-based authentication for the cluster.

    +

    Value range:

    +
    • true: Enable security mode-based authentication.

      +
    • false: Disable security mode-based authentication.

    diskEncrypted

    +

    diskEncrypted

    Boolean

    +

    Boolean

    Parameter description:

    -

    Whether disks are encrypted.

    -

    Options:

    -
    • true: Disks are encrypted.

      -
    • false: Disk are not encrypted.

      +

    Definition:

    +

    Whether disk encryption is enabled. To enable it, submit a service ticket.

    +

    Value range:

    +
    • true: Disks are encrypted.

      +
    • false: Disk are not encrypted.

    backupAvailable

    +

    backupAvailable

    Boolean

    +

    Boolean

    Parameter description:

    -

    Whether the snapshot function is enabled.

    -

    Options:

    -
    • true: The snapshot function is enabled.

      -
    • false: The snapshot function is disabled.

      +

    Definition:

    +

    Whether to enable cluster snapshots.

    +

    Value range:

    +
    • true: Cluster snapshots are enabled.

      +
    • false: Cluster snapshots are disabled.

    actionProgress

    +

    actionProgress

    Object

    +

    Object

    Parameter description:

    -

    Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage. CREATING indicates the progress of creation.

    +

    Definition:

    +

    Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage. CREATING indicates the progress of creation.

    +

    Value range:

    +

    N/A

    actions

    +

    actions

    Array of strings

    +

    Array of strings

    Parameter description:

    -

    Current behavior of a cluster. REBOOTING indicates that the cluster is being restarted. GROWING indicates that the cluster is being scaled. RESTORING indicates that the cluster is being restored. SNAPSHOTTING indicates that the snapshot is being created.

    +

    Definition:

    +

    Current behavior of a cluster.

    +

    Value range:

    +
    • REBOOTING

      +
    • GROWING

      +
    • RESTORING: The cluster is being restored.

      +
    • SNAPSHOTTING: A snapshot is being created.

      +

    enterpriseProjectId

    +

    enterpriseProjectId

    String

    +

    String

    Parameter description:

    -

    ID of the enterprise project that a cluster belongs.

    -

    If the user of the cluster has not enabled the enterprise project, the setting of this parameter is not returned.

    +

    Definition:

    +

    ID of the enterprise project that a cluster belongs.

    +

    If the user of the cluster has not enabled the enterprise project, the setting of this parameter is not returned.

    +

    Value range:

    +

    N/A

    tags

    +

    tags

    Array of ClusterListTags objects

    +

    Array of ClusterListTags objects

    Parameter description:

    -

    Cluster tags.

    +

    Definition:

    +

    Cluster tags.

    +

    Value range:

    +

    N/A

    failedReason

    +

    failedReason

    ClusterListFailedReasons object

    +

    ClusterListFailedReasons object

    Parameter description:

    -

    Failure cause. If the cluster is in the available status, this parameter is not returned.

    +

    Definition:

    +

    Cluster failure cause. If the cluster status is available, this parameter is not returned.

    +

    Value range:

    +

    N/A

    bandwidthResourceId

    +

    bandwidthResourceId

    String

    +

    String

    Parameter description:

    -

    ID of the resource accessed from the ES public network

    +

    Definition:

    +

    ID of the Elasticsearch resource accessible from the public network.

    +

    Value range:

    +

    N/A

    ipv6Endpoint

    +

    ipv6Endpoint

    String

    +

    String

    Parameter description:

    -

    IPv6 address and port number accessed from the cluster's private network.

    +

    Definition:

    +

    IPv6 address and port number accessed from the cluster's private network.

    +

    Value range:

    +

    N/A

    cmkId

    +

    cmkId

    String

    +

    String

    Parameter description:

    -

    Encryption key ID used by the current cluster.

    +

    Definition:

    +

    Encryption key ID used by the current cluster.

    +

    Value range:

    +

    N/A

    +

    currentSubnetIds

    +

    String

    +

    Definition:

    +

    Subnets used by all nodes in the cluster. If there are multiple subnets (two at most), separate them with a comma (,).

    +

    Value range:

    +

    N/A

    +

    desc

    +

    String

    +

    Definition:

    +

    Cluster description.

    +

    Constraints:

    +

    The value can contain up to 128 characters. display_name and desc cannot be null at the same time.

    +

    Value range:

    +

    N/A

    +

    Default value:

    +

    N/A

    -
    Table 5 ClusterListDatastore

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 ClusterListDatastore

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    type

    +

    type

    String

    +

    String

    Parameter description:

    -

    Cluster engine type.

    -

    Options:

    -

    elasticsearch, logstash, or opensearch.

    -

    version

    -

    String

    -

    Parameter description:

    -

    Version of the CSS cluster engine.

    -

    Options:

    -

    For details, see the supported versions in Before You Start.

    -

    supportSecuritymode

    -

    Boolean

    -

    Parameter description:

    -

    Whether the security mode is supported.

    -

    Options:

    -

    The value can be true (supported) or false (not supported).

    -

    subVersion

    -

    String

    -

    Parameter description:

    -

    Cluster image version.

    -

    isEosCluster

    -

    Boolean

    -

    Parameter description:

    -

    Whether the cluster image version has reached EOS.

    -

    Options:

    -

    true indicates that the image version has reached EOS; false indicates that the image version has not reached EOS.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 ClusterListInstances

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Parameter description:

    -

    Node status.

    -

    Options:

    -
    • 100: creating

      -
    • 200: Available

      -
    • 303: Unavailable, for example, due to a creation failure.

      +

    Definition:

    +

    Cluster engine type.

    +

    Value range:

    +
    • elasticsearch: Elasticsearch cluster.

      +
    • logstash: Logstash cluster.

      +
    • opensearch: OpenSearch cluster.

    type

    +

    version

    String

    +

    String

    Parameter description:

    -

    Type of the current node.

    +

    Definition:

    +

    Cluster engine version.

    +

    Value range:

    +

    For details, see the supported versions in Before You Start.

    id

    +

    supportSecuritymode

    String

    +

    Boolean

    Parameter description:

    -

    Instance ID.

    -

    name

    -

    String

    -

    Parameter description:

    -

    Instance name.

    -

    specCode

    -

    String

    -

    Parameter description:

    -

    Node flavor name.

    -

    azCode

    -

    String

    -

    Parameter description:

    -

    AZ of a node.

    -

    ip

    -

    String

    -

    Parameter description:

    -

    Instance IP address.

    -

    volume

    -

    ClusterVolumeRsp object

    -

    Parameter description:

    -

    Instance disk information.

    -

    resourceId

    -

    String

    -

    Parameter description:

    -

    Instance resource ID.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - -
    Table 7 ClusterVolumeRsp

    Parameter

    -

    Type

    -

    Description

    -

    type

    -

    String

    -

    Parameter description:

    -

    Instance disk type.

    -

    size

    -

    Integer

    -

    Parameter description:

    -

    Instance disk size.

    -

    resourceIds

    -

    Array of strings

    -

    Parameter description:

    -

    Instance disk resource ID.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - -
    Table 8 publicKibanaRespBody

    Parameter

    -

    Type

    -

    Description

    -

    eipSize

    -

    Integer

    -

    Bandwidth range. Unit: Mbit/s

    -

    elbWhiteListResp

    -

    kibanaElbWhiteListResp object

    -

    Parameter description:

    -

    Kibana public network access control information.

    -

    publicKibanaIp

    -

    String

    -

    Parameter description:

    -

    Specifies the IP address for accessing Kibana.

    -

    bandwidthResourceId

    -

    String

    -

    Parameter description:

    -

    Resource ID corresponding to the Kibana public network

    -
    -
    - -
    - - - - - - - - - - + + + +
    Table 9 kibanaElbWhiteListResp

    Parameter

    -

    Type

    -

    Description

    -

    enableWhiteList

    -

    Boolean

    -

    Whether to enable Kibana access control.

    -

    Options:

    -
    • true: Access control is enabled.

      -
    • false: Access control is disabled.

      +

    Definition:

    +

    Whether the cluster supports the security mode.

    +

    Value range:

    +
    • true: supported.

      +
    • false: not supported.

    whiteList

    +

    subVersion

    String

    +

    String

    Parameter description:

    -

    Whitelist for Kibana public network access.

    +

    Definition:

    +

    Cluster image version.

    +

    Value range:

    +

    N/A

    +

    isEosCluster

    +

    Boolean

    +

    Definition:

    +

    Whether the cluster image version has reached EOS.

    +

    Value range:

    +
    • true: yes.

      +
    • false: no.

      +
    -
    Table 10 elbWhiteListResp

    Parameter

    +
    - - - - - - - - + + + + + + + +
    Table 6 SnapshotPolicyResp

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    enableWhiteList

    +

    backupEnable

    Boolean

    +

    Boolean

    Parameter description:

    -

    Whether to enable public network access control.

    -

    Options:

    -
    • true: Public network access control is enabled.

      -
    • false: Public network access control is disabled.

      +

    Definition:

    +

    Whether to enable automatic snapshots for the cluster.

    +

    Value range:

    +
    • true: Yes

      +
    • false: No

    whiteList

    +

    bakPeriod

    String

    +

    String

    Parameter description:

    -

    Whitelist for public network access.

    +

    Definition:

    +

    Snapshot creation time.

    +

    Value range:

    +

    N/A

    +

    bakFrequency

    +

    String

    +

    Definition:

    +

    Snapshot creation interval.

    +

    Value range:

    +
    • DAY: every day

      +
    • MON: every Monday

      +
    • TUR: every Tuesday

      +
    • WED: every Wednesday

      +
    • THU: every Thursday

      +
    • FRI: every Friday

      +
    • SAT: every Saturday

      +
    • SUN: every Sunday

      +
    • HOUR: every hour

      +
    +

    bakKeepDay

    +

    Integer

    +

    Definition:

    +

    Number of retained snapshots.

    +

    Value range:

    +

    N/A

    -
    Table 11 ClusterListTags

    Parameter

    +
    - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 7 ClusterListInstances

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    key

    +

    status

    String

    +

    String

    Parameter description:

    -

    Tag key.

    +

    Definition:

    +

    Cluster node status.

    +

    Value range:

    +
    • 100: creating

      +
    • 200: available

      +
    • 303: unavailable, for example, due to a creation failure.

      +

    value

    +

    type

    String

    +

    String

    Parameter description:

    -

    Tag value.

    +

    Definition:

    +

    Type of the current node.

    +

    Value range:

    +

    N/A

    +

    id

    +

    String

    +

    Definition:

    +

    Instance ID.

    +

    Value range:

    +

    N/A

    +

    name

    +

    String

    +

    Definition:

    +

    Instance name.

    +

    Value range:

    +

    N/A

    +

    specCode

    +

    String

    +

    Definition:

    +

    Node flavor name.

    +

    Value range:

    +

    N/A

    +

    azCode

    +

    String

    +

    Definition:

    +

    AZ of the node.

    +

    Value range:

    +

    N/A

    +

    ip

    +

    String

    +

    Definition:

    +

    Instance IP address.

    +

    Value range:

    +

    N/A

    +

    volume

    +

    ClusterVolumeRsp object

    +

    Definition:

    +

    Instance disk information.

    +

    Value range:

    +

    N/A

    +

    resourceId

    +

    String

    +

    Definition:

    +

    Instance resource ID.

    +

    Value range:

    +

    N/A

    +

    subnetId

    +

    String

    +

    Definition:

    +

    Subnet ID of the current node.

    +

    Value range:

    +

    N/A

    -
    Table 12 ClusterListFailedReasons

    Parameter

    +
    - - - - - + + + + + + + + + + +
    Table 8 ClusterVolumeRsp

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    errorCode

    +

    type

    String

    +

    String

    Parameter description:

    -

    Error code.

    -

    Options:

    -
    • CSS.6000: A cluster fails to be created.

      -
    • CSS.6001: A cluster fails to be scaled out.

      -
    • CSS.6002: A cluster fails to be restarted.

      -
    • CSS.6004: A node fails to be created in a cluster.

      -
    • CSS.6005: A service fails to be initialized.

      +

    Definition:

    +

    Instance disk type.

    +

    Value range:

    +

    N/A

    +

    size

    +

    Integer

    +

    Definition:

    +

    Instance disk size.

    +

    Value range:

    +

    N/A

    +

    resourceIds

    +

    Array of strings

    +

    Definition:

    +

    Instance disk resource ID.

    +

    Value range:

    +

    N/A

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 9 publicKibanaRespBody

    Parameter

    +

    Type

    +

    Description

    +

    eipSize

    +

    Integer

    +

    Definition:

    +

    The bandwidth size in Mbit/s.

    +

    Value range:

    +

    N/A

    +

    elbWhiteListResp

    +

    kibanaElbWhiteListResp object

    +

    Definition:

    +

    Kibana public network access control information.

    +

    Value range:

    +

    N/A

    +

    publicKibanaIp

    +

    String

    +

    Definition:

    +

    Specifies the IP address for accessing Kibana.

    +

    Value range:

    +

    N/A

    +

    bandwidthResourceId

    +

    String

    +

    Definition:

    +

    Resource ID corresponding to the Kibana public network.

    +

    Value range:

    +

    N/A

    +
    +
    + +
    + + + + + + + - - - + + +
    Table 10 kibanaElbWhiteListResp

    Parameter

    +

    Type

    +

    Description

    +

    enableWhiteList

    +

    Boolean

    +

    Definition:

    +

    Whether to enable Kibana access control.

    +

    Value range:

    +
    • true: Access control is enabled.

      +
    • false: Access control is disabled.

    errorMsg

    +

    whiteList

    String

    +

    String

    Parameter description:

    -

    Error details.

    +

    Definition:

    +

    Whitelist for Kibana public network access.

    +

    Value range:

    +

    N/A

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 11 elbWhiteListResp

    Parameter

    +

    Type

    +

    Description

    +

    enableWhiteList

    +

    Boolean

    +

    Definition:

    +

    Whether to enable public network access control via ELB. If a whitelist is set, only IP addresses on the whitelist can access the cluster. If no whitelist is set, all IP addresses can access the cluster.

    +

    Value range:

    +
    • true: Public network access control is enabled.

      +
    • false: Public network access control is disabled.

      +
    +

    whiteList

    +

    String

    +

    Definition:

    +

    Whitelist for public network access.

    +

    Value range:

    +

    N/A

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 12 ClusterListTags

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Definition:

    +

    Tag key.

    +

    Value range:

    +

    N/A

    +

    value

    +

    String

    +

    Definition:

    +

    Tag value.

    +

    Value range:

    +

    N/A

    +
    +
    + +
    + + + + + + + + + + +
    Table 13 ClusterListFailedReasons

    Parameter

    +

    Type

    +

    Description

    +

    errorCode

    +

    String

    +

    Parameter description:

    +

    Error code.

    +

    Options:

    +
    • CSS.6000: A cluster fails to be created.

      +
    • CSS.6001: A cluster fails to be scaled out.

      +
    • CSS.6002: A cluster fails to be restarted.

      +
    • CSS.6004: A node fails to be created in a cluster.

      +
    • CSS.6005: A service fails to be initialized.

      +
    +

    errorMsg

    +

    String

    +

    Definition:

    +

    Error details.

    +

    Value range:

    +

    N/A

    -

    Example Requests

    • Query the first two clusters.

      -
      - Method 1: GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=2- Method 2: GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=2
      -
    • Query the first ten clusters.

      -
      - Method 1: GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?start=1&limit=10- Method 2: GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters?limit=10
      +

      Example Requests

      • Querying the First Two Clusters

        +
        - Method 1: GET https://{Endpoint}/v1.0/{project_id}/clusters?start=1&limit=2
        +- Method 2: GET https://{Endpoint}/v1.0/{project_id}/clusters?limit=2
        +
      • Querying the First 10 Clusters

        +
        - Method 1: GET https://{Endpoint}/v1.0/{project_id}/clusters?start=1&limit=10
        +- Method 2: GET https://{Endpoint}/v1.0/{project_id}/clusters?limit=10
      -

      Example Responses

      Status code: 200

      -

      Request succeeded.

      -
      {
      +

      Example Responses

      Status code: 200

      +

      Request succeeded. This is only an example. The responses to the four requests are similar. In the example, there is only one cluster list.

      +
      {
         "totalSize" : 1,
         "clusters" : [ {
           "datastore" : {
      @@ -765,12 +983,12 @@
               "resourceIds" : [ "{RESOURCE_ID}" ]
             },
             "ip" : "192.168.0.122",
      -      "resourceId" : "{RESOURCE_ID}"
      +      "resourceId" : "{RESOURCE_ID}",
      +      "subnetId" : "{SUBNET_ID}"
           } ],
           "publicKibanaResp" : {
             "eipSize" : 10,
             "publicKibanaIp" : "100.95.152.28:9200",
      -      "elbWhiteListResp" : null,
             "bandwidthResourceId" : "18bec13f-5cc1-4631-867f-33505d15be12"
           },
           "elbWhiteList" : {
      @@ -786,6 +1004,7 @@
           "endpoint" : "192.168.0.122:9200",
           "vpcId" : "{VPC_ID}",
           "subnetId" : "{SUBNET_ID}",
      +    "currentSubnetIds" : "{SUBNET_ID}",
           "securityGroupId" : "{SECURITY_GROUP_ID}",
           "bandwidthResourceId" : "{BANDWIDTH_RESOURCE_ID}",
           "bandwidthSize" : 3,
      @@ -801,35 +1020,35 @@
         } ]
       }
      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - - - - - -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded. This is only an example. The responses to the four requests are similar. In the example, there is only one cluster list.

      400

      +

      400

      Invalid request.

      -

      Modify the request before retry.

      +

      Invalid request.

      +

      Modify the request before retry.

      404

      +

      404

      The requested resource could not be found.

      -

      Modify the request before retry.

      +

      The requested resource could not be found.

      +

      Modify the request before retry.

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/css/api-ref/ListClustersTags.html b/docs/css/api-ref/ListClustersTags.html index e8b271452..dfe300719 100644 --- a/docs/css/api-ref/ListClustersTags.html +++ b/docs/css/api-ref/ListClustersTags.html @@ -1,49 +1,52 @@

      Querying All Tags

      -

      Function

      This API is used to query all tags in a specified region.

      +

      Function

      This API is used to query all tags of a user in the current project, including the keys and values. This facilitates tag management by group.

      -

      URI

      GET /v1.0/{project_id}/{resource_type}/tags

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/{resource_type}/tags

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -54,56 +57,62 @@

      Response Parameters

      Status code: 200

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Value range:

      +

      Project ID.

      Default value:

      -

      N/A.

      +

      N/A

      resource_type

      +

      resource_type

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      +

      Definition:

      Resource type. Currently, its value can only be css-cluster.

      -

      Options:

      -
      • css-cluster: cluster type.

        -
      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      css-cluster: Indicates the cluster type.

      Default value:

      -

      N/A.

      +

      N/A

      Table 2 Response body parameters

      Parameter

      +
      - - - - -
      Table 2 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      tags

      +

      tags

      Array of ShowAllTagsTagsResp objects

      +

      Array of ShowAllTagsTagsResp objects

      Parameter description:

      -

      List of cluster tags

      +

      Definition:

      +

      List of cluster tags.

      +

      Value range:

      +

      N/A

      -
      Table 3 ShowAllTagsTagsResp

      Parameter

      +
      - - - - - - - -
      Table 3 ShowAllTagsTagsResp

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      key

      +

      key

      String

      +

      String

      Parameter description:

      +

      Definition:

      Tag key.

      +

      Value range:

      +

      N/A

      values

      +

      values

      Array of strings

      +

      Array of strings

      Parameter description:

      +

      Definition:

      Tag values.

      +

      Value range:

      +

      N/A

      -

      Example Requests

      Query all CSS cluster tags in a project.

      -
      GET https://{Endpoint}/v1.0/{project_id}/{resource_type}/tags
      +

      Example Requests

      Query all cluster tags in a project.

      +
      GET https://{Endpoint}/v1.0/{project_id}/css-cluster/tags

      Example Responses

      Status code: 200

      Request succeeded.

      @@ -118,26 +127,26 @@ }

      Status Codes

      -

      Status Code

      +
      - - - - - - - diff --git a/docs/css/api-ref/ListElbCerts.html b/docs/css/api-ref/ListElbCerts.html index 344255ec4..f7106e5c6 100644 --- a/docs/css/api-ref/ListElbCerts.html +++ b/docs/css/api-ref/ListElbCerts.html @@ -3,34 +3,50 @@

      Querying the Certificate List

      Function

      This API is used to query the certificate list.

      -

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificates

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificates

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      The client should modify the request instead of re-initiating it.

      404

      +

      404

      The requested resource could not be found.

      +

      The requested resource could not be found.

      The client should not repeat the request without modifications.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -41,59 +57,74 @@

      Response Parameters

      Status code: 200

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Project ID of the account.

      +

      Default value:

      +

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      ID of the cluster you want to query

      +

      Definition:

      +

      ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Cluster ID.

      +

      Default value:

      +

      N/A

      Table 2 Response body parameters

      Parameter

      +
      - - - - -
      Table 2 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      certificates

      +

      certificates

      CertificatesResource object

      +

      Array of CertificatesResource objects

      Certificate list information.

      +

      Definition:

      +

      Certificate list information.

      +

      Value range:

      +

      N/A

      -
      Table 3 CertificatesResource

      Parameter

      +
      - - - - - - - - - - -
      Table 3 CertificatesResource

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Certificate ID

      +

      Definition:

      +

      Certificate ID.

      +

      Value range:

      +

      N/A

      name

      +

      name

      String

      +

      String

      Certificate name

      +

      Definition:

      +

      Certificate name.

      +

      Value range:

      +

      N/A

      type

      +

      type

      String

      +

      String

      Type of the SL certificate. The value can be server or client. server indicates server certificates, and client indicates CA certificates.

      +

      Definition:

      +

      Type of the SL certificate.

      +

      Value range:

      +
      • server: server certificates

        +
      • client: CA certificates

        +
      -

      Example Requests

      None

      +

      Example Requests

      This API is used to query the certificate list.

      +
      GET https://{Endpoint}/v1.0/{project_id}/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/elb/certificates

      Example Responses

      Status code: 200

      Request succeeded.

      @@ -114,32 +145,32 @@ }

      Status Codes

      -

      Status Code

      +
      - - - - - - - - - @@ -151,7 +182,7 @@
      diff --git a/docs/css/api-ref/ListElbs.html b/docs/css/api-ref/ListElbs.html index 5e76b95b6..9d35b6efa 100644 --- a/docs/css/api-ref/ListElbs.html +++ b/docs/css/api-ref/ListElbs.html @@ -3,46 +3,48 @@

      Querying ELB V3 Load Balancers Supported by a Cluster

      Function

      Query the ELB V3 load balancers supported by a cluster.

      -

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request instead of retrying.

      409

      +

      409

      The request cannot be processed due to a conflict.

      +

      The request cannot be processed due to a conflict.

      This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

      412

      +

      412

      The server does not meet one of the requirements that the requester puts on the request.

      +

      The server does not meet one of the requirements that the requester puts on the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -55,64 +57,74 @@

      Response Parameters

      Status code: 200

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Value range:

      +

      Project ID of the account.

      Default value:

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      ID of the cluster you want to query.

      +

      Definition:

      +

      ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Value range:

      +

      Cluster ID.

      Default value:

      N/A

      Table 2 Response body parameters

      Parameter

      +
      - - - - -
      Table 2 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      loadbalancers

      +

      loadbalancers

      Array of LoadbalancersResource objects

      +

      Array of LoadbalancersResource objects

      Parameter description:

      +

      Definition:

      Load balancer list.

      +

      Value range:

      +

      N/A

      -
      Table 3 LoadbalancersResource

      Parameter

      +
      - - - - - - - - - - - - - - @@ -120,7 +132,7 @@

      Example Requests

      Query ELB V3 load balancers supported by a cluster.

      -
      GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/loadbalancers
      +
      GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/loadbalancers

      Example Responses

      Status code: 200

      Request succeeded.

      @@ -139,32 +151,32 @@ }

      Status Codes

      -
      Table 3 LoadbalancersResource

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Parameter description:

      -

      Specifies the load balancer ID.

      +

      Definition:

      +

      Load balancer ID.

      +

      Value range:

      +

      N/A

      name

      +

      name

      String

      +

      String

      Parameter description:

      -

      Load balancer name

      +

      Definition:

      +

      Load balancer name.

      +

      Value range:

      +

      N/A

      l7_flavor_id

      +

      l7_flavor_id

      String

      +

      String

      Parameter description:

      -

      Layer 7 protocol ID.

      +

      Definition:

      +

      Layer-7 protocol ID.

      +

      Value range:

      +

      N/A

      ip_target_enable

      +

      ip_target_enable

      Boolean

      +

      Boolean

      Parameter description:

      -

      Indicates whether to enable the cross-VPC backend.

      +

      Definition:

      +

      Whether to enable the cross-VPC backend.

      +

      Value range:

      +

      N/A

      Status Code

      +
      - - - - - - - - - @@ -176,7 +188,7 @@
      diff --git a/docs/css/api-ref/ListFlavors.html b/docs/css/api-ref/ListFlavors.html index b702d4ff7..88d04d67e 100644 --- a/docs/css/api-ref/ListFlavors.html +++ b/docs/css/api-ref/ListFlavors.html @@ -1,32 +1,34 @@

      Obtaining the Instance Specifications List

      -

      Function

      This API is used to query and display the IDs of supported instance specifications.

      +

      Function

      This API is used to obtain the node specifications, including the node specifications version, cluster data search engine, number of vCPUs per node, and node memory size. You may use this API to check node specifications after a cluster is created.

      -

      URI

      GET /v1.0/{project_id}/es-flavors

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/es-flavors

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request instead of retrying.

      409

      +

      409

      The request cannot be processed due to a conflict.

      +

      The request cannot be processed due to a conflict.

      This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

      412

      +

      412

      The server does not meet one of the requirements that the requester puts on the request.

      +

      The server does not meet one of the requirements that the requester puts on the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - @@ -39,61 +41,68 @@

      Response Parameters

      Status code: 200

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Value range:

      +

      Project ID of the account.

      Default value:

      N/A

      Table 2 Response body parameters

      Parameter

      +
      - - - - -
      Table 2 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      versions

      +

      versions

      Array of EsflavorsVersionsResp objects

      +

      Array of EsflavorsVersionsResp objects

      Parameter description:

      +

      Definition:

      Flavor version list.

      +

      Value range:

      +

      N/A

      -
      Table 3 EsflavorsVersionsResp

      Parameter

      +
      - - - - - - - - - - - @@ -101,75 +110,89 @@
      Table 3 EsflavorsVersionsResp

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      version

      +

      version

      String

      +

      String

      Parameter description:

      +

      Definition:

      Elasticsearch engine version. For details, see the supported versions in Before You Start.

      +

      Value range:

      +

      N/A

      flavors

      +

      flavors

      Array of EsflavorsVersionsFlavorsResp objects

      +

      Array of EsflavorsVersionsFlavorsResp objects

      Parameter description:

      +

      Definition:

      Flavor list.

      +

      Value range:

      +

      N/A

      type

      +

      type

      String

      +

      String

      Parameter description:

      +

      Parameter description:

      Instance type.

      Options:

      • ess: data node

      • ess-cold: cold data node

      • ess-master: master node.

        -
      • ess-client: client node

        +
        • ess-client: client node

          +
      -
      Table 4 EsflavorsVersionsFlavorsResp

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - -
      Table 4 EsflavorsVersionsFlavorsResp

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      cpu

      +

      cpu

      Integer

      +

      Integer

      Parameter description:

      +

      Definition:

      Number of CPU cores of an instance.

      +

      Value range:

      +

      N/A

      ram

      +

      ram

      Integer

      +

      Integer

      Parameter description:

      -

      Memory size of an instance. Unit: GB

      +

      Definition:

      +

      Memory size of an instance. Unit: GB.

      +

      Value range:

      +

      N/A

      name

      +

      name

      String

      +

      String

      Parameter description:

      +

      Definition:

      Flavor name.

      +

      Value range:

      +

      N/A

      region

      +

      region

      String

      +

      String

      Parameter description:

      -

      Available region

      +

      Definition:

      +

      Available region.

      +

      Value range:

      +

      N/A

      diskrange

      +

      diskrange

      String

      +

      String

      Parameter description:

      +

      Definition:

      Disk capacity range of an instance.

      +

      Value range:

      +

      N/A

      availableAZ

      +

      availableAZ

      String

      +

      String

      Parameter description:

      -

      The AZ.

      +

      Definition:

      +

      AZ.

      +

      Value range:

      +

      N/A

      flavor_id

      +

      flavor_id

      String

      +

      String

      Parameter description:

      +

      Definition:

      Flavor ID.

      +

      Value range:

      +

      N/A

      -

      Example Requests

      Obtain the specifications of all instances.

      +

      Example Requests

      Obtain the specifications of all nodes in the project space.

      GET https://{Endpoint}/v1.0/{project_id}/es-flavors

      Example Responses

      Status code: 200

      @@ -207,26 +230,26 @@ }

      Status Codes

      -

      Status Code

      +
      - - - - - - - diff --git a/docs/css/api-ref/ListImages.html b/docs/css/api-ref/ListImages.html index 0aa006dbf..0338d484f 100644 --- a/docs/css/api-ref/ListImages.html +++ b/docs/css/api-ref/ListImages.html @@ -1,59 +1,65 @@

      Obtaining the ID of the Target Image to Upgrade To

      -

      Function

      This API is used to obtain the ID of an image that can be upgraded in the current cluster.

      +

      Function

      This API is used to obtain the IDs of target images the current cluster can be upgraded to. The upgrade types are as follows:

      +
      • During a same-version upgrade, kernel patches are updated for a cluster. The cluster is upgraded to the latest image of the current version to fix known issues or optimize performance. For example, if the current cluster version is 7.10.2(7.10.2_24.3.3_0102), upon a same-version upgrade, the cluster will be upgraded to the latest image 7.10.2(7.10.2_24.3.4_0109) of version 7.10.2. (The version numbers used here are examples only.)

        +
      • Cross-version upgrade: Upgrade the cluster version. The cluster will be upgraded to the latest image of the target version to enhance functions or incorporate versions. For example, if the current cluster version is 7.6.2(7.6.2_24.3.3_1224), upon a cross-version upgrade, the cluster will be upgraded to the latest image 7.10.2(7.10.2_24.3.4_0109) of version 7.10.2. (The version numbers used here are examples only.)

        +
      • Cross-engine upgrade: Change an Elasticsearch cluster to an OpenSearch cluster. Cross-engine upgrade means to upgrade an Elasticsearch cluster to the latest image of the target OpenSearch version. For example, if the Elasticsearch cluster version is 7.10.2(7.10.2_24.3.3_0102), upon a cross-engine upgrade, the Elasticsearch cluster will be upgraded to the latest image 1.3.6(1.3.6_24.3.4_0109) of OpenSearch 1.3.6. (The version numbers used here are examples only.) This feature is not supported currently.

        +
      -

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request before retry.

      404

      +

      404

      The requested resource could not be found.

      +

      The requested resource could not be found.

      Modify the request before retry.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - - - - - + + +
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Value range:

      +

      Project ID of the account.

      Default value:

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      ID of the cluster to be upgraded.

      +

      Definition:

      +

      ID of the cluster to be upgraded. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Value range:

      +

      Cluster ID.

      Default value:

      N/A

      upgrade_type

      +

      upgrade_type

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      +

      Parameter description:

      Upgrade type.

      Constraints:

      N/A

      @@ -61,9 +67,55 @@
      • same: same-version upgrade.

      • cross: cross-version upgrade.

      • cross-engine: cross-engine upgrade.

        +

      Default value:

      N/A

      - +
      +
      + +
      + + + + + + + + + + + + + + @@ -74,88 +126,117 @@

      Response Parameters

      Status code: 200

      -
      Table 2 Query Parameters

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      offset

      +

      No

      +

      Integer

      +

      Definition:

      +

      Start value of the query. The default value is 0.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      0-1000

      +

      Default value:

      +

      0

      +

      limit

      +

      No

      +

      Integer

      +

      Definition:

      +

      Number of images to be queried. The default value is 10, indicating that 10 images are queried at a time.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      1-1000

      +

      Default value:

      +

      10

      Table 2 Response body parameters

      Parameter

      +
      - - - - - - - - + + + +
      Table 3 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      needUploadUpgradePlugin

      +

      needUploadUpgradePlugin

      Boolean

      +

      Boolean

      Parameter description:

      +

      Definition:

      Whether to upload the plug-in of the target version.

      +

      Value range:

      +

      N/A

      imageInfoList

      +

      imageInfoList

      Array of GetTargetImageIdDetail objects

      +

      Array of GetTargetImageIdDetail objects

      Parameter description:

      +

      Definition:

      Image details.

      +

      Value range:

      +

      N/A

      +

      totalSize

      +

      Integer

      +

      Definition:

      +

      Number of target images.

      +

      Value range:

      +

      N/A

      -
      Table 3 GetTargetImageIdDetail

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - @@ -163,36 +244,37 @@

      Example Requests

      Obtain the target image for a cross-version upgrade of the cluster.

      -
      GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images
      +
      GET https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images

      Example Responses

      Status code: 200

      Request succeeded.

      {
         "needUploadUpgradePlugin" : false,
      -  "imageInfoList" : [ ]
      +  "imageInfoList" : [ ],
      +  "totalSize" : 0
       }

      Status Codes

      -
      Table 4 GetTargetImageIdDetail

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Parameter description:

      +

      Definition:

      ID of an image that can be upgraded.

      +

      Value range:

      +

      N/A

      displayName

      +

      displayName

      String

      +

      String

      Parameter description:

      +

      Definition:

      Name of an image that can be upgraded.

      +

      Value range:

      +

      N/A

      imageDesc

      +

      imageDesc

      String

      +

      String

      Parameter description:

      +

      Definition:

      Image description.

      +

      Value range:

      +

      N/A

      datastoreType

      +

      datastoreType

      String

      +

      String

      Parameter description:

      -

      Image engine type.

      +

      Definition:

      +

      Cluster engine type.

      +

      Value range:

      +
      • elasticsearch: Cloud Search Service (CSS) provides distributed search capabilities, log analytics, reporting, and semantic search based on open-source Elasticsearch.

        +
      • logstash: Provides functions such as data ingestion, transformation, cleaning, and parsing based on open-source Logstash.

        +
      • opensearch: Provides distributed search, log analytics, reporting, and semantic search based on open-source OpenSearch. It is the future version of CSS's Elasticsearch clusters.

        +

      datastoreVersion

      +

      datastoreVersion

      String

      +

      String

      Parameter description:

      +

      Definition:

      Image engine version.

      +

      Value range:

      +

      N/A

      priority

      +

      priority

      Integer

      +

      Integer

      Parameter description:

      +

      Definition:

      Priority of the target image. A larger value indicates a higher priority.

      +

      Value range:

      +

      N/A

      Status Code

      +
      - - - - - - - diff --git a/docs/css/api-ref/ListLogsJob.html b/docs/css/api-ref/ListLogsJob.html index 0ac00827e..0902c2b72 100644 --- a/docs/css/api-ref/ListLogsJob.html +++ b/docs/css/api-ref/ListLogsJob.html @@ -1,48 +1,50 @@

      Querying the Log Backup Task List

      -

      Function

      This API is used to query the log backup task list of a cluster.

      +

      Function

      This API is used to query the log backup task list of a cluster. To be able to use this API, the target cluster must have log backup enabled, and log backup tasks were triggered earlier. This allows you to keep track of operations that were performed on the cluster.

      -

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      The client should not repeat the request without modifications.

      403

      +

      403

      Request rejected.

      +

      Request rejected.

      The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -51,63 +53,65 @@
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Value range:

      +

      Project ID of the account.

      Default value:

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      ID of the cluster you want to query.

      +

      Definition:

      +

      ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Value range:

      +

      Cluster ID.

      Default value:

      N/A

      -
      Table 2 Query Parameters

      Parameter

      +
      - - - - - - - - - - - - - - - @@ -118,113 +122,129 @@

      Response Parameters

      Status code: 200

      -
      Table 2 Query Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      start

      +

      offset

      No

      +

      No

      Integer

      +

      Integer

      Parameter description:

      -

      The start value of the query. The default value is 1, indicating that the query starts from the first task.

      +

      Definition:

      +

      Start value for log query. The default value is 1, indicating that the query starts from the first log record.

      Constraints:

      N/A

      -

      Options:

      +

      Value range:

      1-1000

      Default value:

      1

      limit

      +

      limit

      No

      +

      No

      Integer

      +

      Integer

      Parameter description:

      -

      Number of tasks to be queried. The default value is 10, indicating that 10 tasks are queried at a time.

      +

      Definition:

      +

      Number of log records to be queried. The default value is 10, indicating that 10 log records are queried at a time.

      Constraints:

      N/A

      -

      Options:

      +

      Value range:

      1-1000

      Default value:

      10

      status

      +

      status

      No

      +

      No

      String

      +

      String

      Parameter description:

      +

      Definition:

      Status of the log tasks to be queried. If this parameter is not specified, all log task records of the cluster are queried.

      -

      Options:

      +

      Constraints:

      +

      N/A

      +

      Value range:

      • FAIL: failed log tasks.

      • NOT_FAIL: ongoing or successful log tasks.

      • If this parameter is not specified, all tasks are queried.

        +

      Default value:

      Empty string: Tasks of all states are queried.

      -
      Table 3 Response body parameters

      Parameter

      +
      - - - - -
      Table 3 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      clusterLogRecord

      +

      clusterLogRecord

      Array of clusterLogRecord objects

      +

      Array of clusterLogRecord objects

      Parameter description:

      -

      Cluster log entity object.

      +

      Parameter description:

      +

      List of cluster log backup tasks.

      +

      Options:

      +

      N/A

      -
      Table 4 clusterLogRecord

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - - - - - - - @@ -232,7 +252,7 @@

      Example Requests

      Querying the First 10 Log Backup Tasks

      -
      GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records
      +
      GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/records

      Example Responses

      Status code: 200

      Request succeeded.

      @@ -251,32 +271,32 @@ }

      Status Codes

      -
      Table 4 clusterLogRecord

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Parameter description:

      -

      Log task ID, which is generated based on the system UUID.

      +

      Definition:

      +

      Cluster log task ID, which is generated based on the system UUID.

      +

      Value range:

      +

      N/A

      clusterId

      +

      clusterId

      String

      +

      String

      Parameter description:

      +

      Parameter description:

      Cluster ID.

      -

      createAt

      -

      String

      -

      Parameter description:

      -

      Creation time. Format: Unix timestamp.

      -

      logPath

      -

      String

      -

      Parameter description:

      -

      Storage path of backed up logs in the OBS bucket.

      -

      status

      -

      String

      -

      Parameter description:

      -

      Task status.

      Options:

      +

      N/A

      +

      createAt

      +

      String

      +

      Definition:

      +

      Cluster log creation time.

      +

      Value range:

      +

      Format: Unix timestamp.

      +

      logPath

      +

      String

      +

      Parameter description:

      +

      Storage path of backed up logs in the OBS bucket.

      +

      Options:

      +

      N/A

      +

      status

      +

      String

      +

      Definition:

      +

      Cluster log task status.

      +

      Value range:

      • RUNNING: The backup is ongoing.

      • SUCCESS: The backup is successful.

      • FAIL: The backup failed.

      finishedAt

      +

      finishedAt

      Long

      +

      Long

      Parameter description:

      -

      End time. If the creation has not been completed, the end time is null. Format: Unix timestamp.

      +

      Definition:

      +

      End time of cluster log creation. If it is still ongoing, the value is null.

      +

      Value range:

      +

      Format: Unix timestamp.

      jobTypes

      +

      jobTypes

      String

      +

      String

      Parameter description:

      -

      Task type.

      -

      Options:

      -
      • Manual: Manual backup.

        -
      • Auto: Automatic backup.

        +

      Definition:

      +

      Type of a log creation task.

      +

      Value range:

      +
      • Manual: Manual backup.

        +
      • Auto: Automatic backup.

      failedMsg

      +

      failedMsg

      String

      +

      String

      Parameter description:

      -

      Error message. If the task is not failed, the value of this parameter is null.

      +

      Definition:

      +

      Error returned for log creation. If the task status is not failed, this parameter is null.

      +

      Value range:

      +

      N/A

      jobId

      +

      jobId

      String

      +

      String

      Parameter description:

      -

      Task ID.

      +

      Definition:

      +

      ID of a log creation task.

      +

      Value range:

      +

      N/A

      Status Code

      +
      - - - - - - - - - diff --git a/docs/css/api-ref/ListSmnTopics.html b/docs/css/api-ref/ListSmnTopics.html index ae236fe3c..b2bb28887 100644 --- a/docs/css/api-ref/ListSmnTopics.html +++ b/docs/css/api-ref/ListSmnTopics.html @@ -3,34 +3,43 @@

      Obtaining SMN Topics Available for Intelligent O&M Alarms

      Function

      This API is used to obtain SMN topics available for intelligent O&M alarms.

      -

      URI

      GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topics

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topics

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request before retry.

      409

      +

      409

      The request could not be completed due to a conflict with the current state of the resource.

      +

      The request could not be completed due to a conflict with the current state of the resource.

      The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

      412

      +

      412

      The server did not meet one of the preconditions contained in the request.

      +

      The server did not meet one of the preconditions contained in the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -41,19 +50,19 @@

      Response Parameters

      Status code: 200

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Project ID of the account.

      +

      Default value:

      +

      N/A

      domain_id

      +

      domain_id

      Yes

      +

      Yes

      String

      +

      String

      Domain account ID

      +

      Domain account ID

      Table 2 Response body parameters

      Parameter

      +
      - - - - - @@ -70,32 +79,32 @@ }

      Status Codes

      -
      Table 2 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      topicsName

      +

      topicsName

      Array of strings

      +

      Array of strings

      Subject name

      +

      Subject name

      Status Code

      +
      - - - - - - - - - diff --git a/docs/css/api-ref/ListSnapshots.html b/docs/css/api-ref/ListSnapshots.html index 0e263a2a2..e879fb180 100644 --- a/docs/css/api-ref/ListSnapshots.html +++ b/docs/css/api-ref/ListSnapshots.html @@ -1,48 +1,50 @@

      Querying a Snapshot List

      -

      Function

      This API is used to query all the snapshots of a cluster.

      +

      Function

      This API is used to query all snapshots of a cluster, including the snapshot creation time, data engine, snapshot ID, and snapshot status, helping you manage the lifecycle of cluster snapshots. This API enables you to quickly obtain the details of a specified snapshot, verify snapshot availability, and help you restore data, roll back versions, or analyze storage costs. This API also provides structured data support required for automatic monitoring and warning for the O&M team, significantly improving cluster O&M efficiency and stability.

      -

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request instead of retrying.

      409

      +

      409

      The request cannot be processed due to a conflict.

      +

      The request cannot be processed due to a conflict.

      This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

      412

      +

      412

      The server does not meet one of the requirements that the requester puts on the request.

      +

      The server does not meet one of the requirements that the requester puts on the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -55,117 +57,125 @@

      Response Parameters

      Status code: 200

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Value range:

      +

      Project ID of the account.

      Default value:

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      ID of the cluster whose snapshots you want to query.

      +

      Definition:

      +

      ID of the cluster whose snapshots you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Value range:

      +

      Cluster ID.

      Default value:

      N/A

      Table 2 Response body parameters

      Parameter

      +
      - - - - -
      Table 2 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      backups

      +

      backups

      Array of ListSnapshotBackupsResp objects

      +

      Array of ListSnapshotBackupsResp objects

      Parameter description:

      +

      Definition:

      Snapshot list.

      +

      Value range:

      +

      N/A

      -
      Table 3 ListSnapshotBackupsResp

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 3 ListSnapshotBackupsResp

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      created

      +

      created

      String

      +

      String

      Parameter description:

      +

      Definition:

      Snapshot creation time.

      +

      Value range:

      +

      The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

      datastore

      +

      datastore

      ListSnapshotBackupsDatastoreResp object

      +

      ListSnapshotBackupsDatastoreResp object

      Parameter description:

      +

      Definition:

      Search engine.

      +

      Value range:

      +

      N/A

      description

      +

      description

      String

      +

      String

      Parameter description:

      +

      Definition:

      Snapshot description.

      +

      Value range:

      +

      N/A

      id

      +

      id

      String

      +

      String

      Parameter description:

      -

      Snapshot ID

      +

      Definition:

      +

      Snapshot ID.

      +

      Value range:

      +

      N/A

      clusterId

      +

      clusterId

      String

      +

      String

      Parameter description:

      -

      Cluster ID

      +

      Definition:

      +

      Cluster ID.

      +

      Value range:

      +

      N/A

      clusterName

      +

      clusterName

      String

      +

      String

      Parameter description:

      +

      Definition:

      Cluster name.

      +

      Value range:

      +

      N/A

      name

      +

      name

      String

      +

      String

      Parameter description:

      -

      The snapshot name.

      +

      Definition:

      +

      Snapshot name.

      +

      Value range:

      +

      N/A

      status

      +

      status

      String

      +

      String

      Parameter description:

      +

      Definition:

      Snapshot status.

      -

      Options:

      -
      • **BUILDING": creating

        -
      • COMPLETED: available

        -
      • FAILED: unavailable

        -
      • PART_FAILED: partially available

        +

        Value range:

        +
        • **BUILDING": creating.

          +
        • COMPLETED: available.

          +
        • FAILED: unavailable.

          +
        • PART_FAILED: partially available.

      updated

      +

      backupType

      String

      +

      String

      Parameter description:

      -

      Time when the snapshot was updated. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

      -

      backupType

      -

      String

      -

      Parameter description:

      +

      Parameter description:

      Snapshot type.

      Options:

      • 0: Automatic creation.

        @@ -173,11 +183,11 @@

      backupMethod

      +

      backupMethod

      String

      +

      String

      Parameter description:

      +

      Parameter description:

      Snapshot creation mode.

      Options:

      • auto: automatic creation.

        @@ -185,125 +195,123 @@

      backupExpectedStartTime

      +

      backupFrequency

      String

      +

      String

      Parameter description:

      -

      Snapshot start time.

      +

      Definition:

      +

      Cluster snapshot creation frequency.

      +

      Value range:

      +
      • HOUR

        +
      • DAY

        +

      backupKeepDay

      +

      indices

      Integer

      +

      String

      Parameter description:

      -

      Snapshot retention period.

      -

      backupPeriod

      -

      String

      -

      Parameter description:

      -

      Time when a snapshot is executed every day.

      -

      indices

      -

      String

      -

      Parameter description:

      +

      Definition:

      Index you want to back up.

      +

      Value range:

      +

      N/A

      totalShards

      +

      totalShards

      Integer

      +

      Integer

      Parameter description:

      +

      Definition:

      Total number of shards of the index you want to back up.

      +

      Value range:

      +

      N/A

      failedShards

      +

      failedShards

      Integer

      +

      Integer

      Parameter description:

      +

      Definition:

      Number of shards that fail to be backed up.

      +

      Value range:

      +

      N/A

      version

      +

      restoreStatus

      String

      +

      String

      Parameter description:

      -

      Snapshot version.

      -

      restoreStatus

      -

      String

      -

      Parameter description:

      +

      Definition:

      Snapshot restoration status.

      -

      Options:

      +

      Value range:

      • restoring: restoration in progress.

      • success: successful restoration.

      • failed: restoration failed.

      startTime

      +

      startTime

      Long

      +

      Long

      Parameter description:

      +

      Definition:

      Snapshot start timestamp.

      +

      Value range:

      +

      N/A

      endTime

      +

      endTime

      Long

      +

      Long

      Parameter description:

      +

      Definition:

      Snapshot end timestamp.

      +

      Value range:

      +

      N/A

      bucketName

      +

      bucketName

      String

      +

      String

      Parameter description:

      +

      Definition:

      Name of the bucket that stores snapshot data.

      +

      Value range:

      +

      N/A

      -
      Table 4 ListSnapshotBackupsDatastoreResp

      Parameter

      +
      - - - - - - - - @@ -311,7 +319,7 @@

      Example Requests

      Query the cluster snapshot list.

      -
      GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/index_snapshots
      +
      GET https://{Endpoint}/v1.0/{project_id}/clusters/37cb1075-c38e-4cd8-81df-442d52df3786/index_snapshots

      Example Responses

      Status code: 200

      Request succeeded.

      @@ -331,9 +339,7 @@ "updated" : "2018-03-07T07:40:12", "backupType" : "1", "backupMethod" : "manual", - "backupExpectedStartTime" : null, - "backupKeepDay" : null, - "backupPeriod" : null, + "backupFrequency" : "HOUR", "indices" : ".kibanawebsite2", "totalShards" : 6, "failedShards" : 0, @@ -357,9 +363,6 @@ "updated" : "2018-03-06T15:48:04", "backupType" : "1", "backupMethod" : "manual", - "backupExpectedStartTime" : null, - "backupKeepDay" : null, - "backupPeriod" : null, "indices" : ".kibana", "totalShards" : 1, "failedShards" : 0, @@ -372,20 +375,20 @@ }

      Status Codes

      -
      Table 4 ListSnapshotBackupsDatastoreResp

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      type

      +

      type

      String

      +

      String

      Parameter description:

      -

      Engine type. Currently, only Elasticsearch is supported.

      +

      Definition:

      +

      Cluster engine type.

      +

      Value range:

      +
      • elasticsearch: Elasticsearch cluster.

        +
      • openSearch: OpenSearch cluster.

        +

      version

      +

      version

      String

      +

      String

      Parameter description:

      +

      Definition:

      Elasticsearch engine version. For details, see the supported versions in Before You Start.

      +

      Value range:

      +

      N/A

      Status Code

      +
      - - - - - diff --git a/docs/css/api-ref/ListYmls.html b/docs/css/api-ref/ListYmls.html index 241429b03..c77d5e156 100644 --- a/docs/css/api-ref/ListYmls.html +++ b/docs/css/api-ref/ListYmls.html @@ -3,46 +3,48 @@

      Obtaining the Parameter Configuration List

      Function

      This API is used to obtain the YAML parameter configuration list of the current cluster.

      -

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/template

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/template

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      406

      +

      406

      The server could not fulfill the request according to the content characteristics of the request.

      +

      The server could not fulfill the request according to the content characteristics of the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -55,33 +57,36 @@

      Response Parameters

      Status code: 200

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      Specifies the ID of the cluster to be queried. For details, see Obtaining the Cluster ID.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Value range:

      +

      Project ID of the account.

      Default value:

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      Specifies the ID of the cluster to be queried. For details, see Obtaining the Cluster ID.

      +

      Definition:

      +

      ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Value range:

      +

      Cluster ID.

      Default value:

      N/A

      Table 2 Response body parameters

      Parameter

      +
      - - - - - @@ -90,7 +95,7 @@

      Example Requests

      Obtain the YAML parameter configuration list of the current cluster.

      -
      GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/ymls/template
      +
      GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/ymls/template

      Example Responses

      Status code: 200

      Request succeeded.

      @@ -108,7 +113,6 @@ "modifyEnable" : "true", "enableValue" : "true,false", "fileName" : "elasticsearch.yml", - "version" : null, "descENG" : "Whether to return the Access-Control-Allow-Credentials of the header during cross-domain access. The value is a Boolean value and the options are true and false.", "moduleDescENG" : "Cross-domain Access" } @@ -116,32 +120,32 @@ }

      Status Codes

      -
      Table 2 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      configurations

      +

      configurations

      Object

      +

      Object

      Cluster parameter configuration list. The key value in the object is subject to the actual situation. The value has the following attributes:

      +

      Definition:

      +

      Cluster parameter configuration list.

      +

      Value range:

      +

      The key value in the object is subject to the actual situation. The value has the following attributes:

      • id: parameter ID.

      • key: parameter name.

      • value: parameter value.

      • defaultValue: parameter default value.

      • regex: parameter constraint.

        -
      • desc: parameter description.

        +
      • desc: parameter description in Chinese.

      • type: parameter type description.

        -
      • moduleDesc: parameter function description.

        +
      • moduleDesc: parameter function description in Chinese.

      • modifyEnable: whether a parameter can be modified. true: The value can be changed. false: The value cannot be changed.

      • enableValue: parameter value that can be changed.

      • fileName: name of the file where parameters exist. The default value is elasticsearch.yml.

      • version: version information.

        -
      • descENG: parameter description.

        -
      • moduleDescENG: parameter function description.

        +
      • descENG: parameter description in English.

        +
      • moduleDescENG: parameter function description in English.

      Status Code

      +
      - - - - - - - - - diff --git a/docs/css/api-ref/ListYmlsJob.html b/docs/css/api-ref/ListYmlsJob.html index 1e34f183d..b32eed5b5 100644 --- a/docs/css/api-ref/ListYmlsJob.html +++ b/docs/css/api-ref/ListYmlsJob.html @@ -1,48 +1,50 @@

      Obtaining the Task List of Parameter Configurations

      -

      Function

      This API is used to obtain the parameter configuration task list of a cluster.

      +

      Function

      This API is used to obtain the parameter configuration task list of a cluster. It can obtain the parameter configuration list ID, cluster ID, and parameter modification records. After a cluster is created, you can call this API to check the cluster parameter settings.

      -

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request before retry.

      409

      +

      409

      The request could not be completed due to a conflict with the current state of the resource.

      +

      The request could not be completed due to a conflict with the current state of the resource.

      The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

      412

      +

      412

      The server did not meet one of the preconditions contained in the request.

      +

      The server did not meet one of the preconditions contained in the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -51,39 +53,39 @@
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Value range:

      +

      Project ID of the account.

      Default value:

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      ID of the cluster you want to query.

      +

      Definition:

      +

      ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      Constraints:

      N/A

      -

      Options:

      -

      For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Value range:

      +

      Cluster ID.

      Default value:

      N/A

      -
      Table 2 Query Parameters

      Parameter

      +
      - - - - - - - - - - -
      Table 2 Query Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      start

      +

      offset

      No

      +

      No

      Integer

      +

      Integer

      Parameter description:

      +

      Definition:

      The start value of the query. The default value is 1, indicating that the query starts from the first task.

      Constraints:

      N/A

      -

      Options:

      +

      Value range:

      1-1000

      Default value:

      1

      limit

      +

      limit

      No

      +

      No

      Integer

      +

      Integer

      Parameter description:

      +

      Parameter description:

      Number of tasks to be queried. The default value is 10, indicating that 10 tasks are queried at a time.

      Constraints:

      N/A

      @@ -101,93 +103,107 @@

      Response Parameters

      Status code: 200

      -
      Table 3 Response body parameters

      Parameter

      +
      - - - - -
      Table 3 Response body parameters

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      configList

      +

      configList

      Array of configListRsp objects

      +

      Array of configListRsp objects

      Parameter description:

      -

      List of historical configuration changes

      +

      Definition:

      +

      List of historical configuration changes.

      +

      Value range:

      +

      N/A

      -
      Table 4 configListRsp

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - @@ -195,7 +211,7 @@

      Example Requests

      Obtaining the Parameter Configuration Task List of a Cluster

      -
      GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists
      +
      GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/ymls/joblists

      Example Responses

      Status code: 200

      Request succeeded.

      @@ -203,41 +219,41 @@ "configList" : [ { "id" : "7ed7258a-60a8-46fe-8814-52819d491b80", "clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c", - "createAt" : 1633658735000, + "createAt" : "1755745344000,", "status" : "success", - "finishedAt" : null, + "finishedAt" : "1755745355000,", "modifyDeleteReset" : "{\"modify\":{\"elasticsearch.yml\":{\"thread_pool.force_merge.size\":\"1\"}}}", "failedMsg" : "" } ] }

      Status Codes

      -
      Table 4 configListRsp

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      id

      +

      id

      String

      +

      String

      Parameter description:

      -

      Operation ID

      +

      Definition:

      +

      Configuration list ID.

      +

      Value range:

      +

      N/A

      clusterId

      +

      clusterId

      String

      +

      String

      Parameter description:

      +

      Definition:

      Cluster ID.

      +

      Value range:

      +

      N/A

      createAt

      +

      createAt

      String

      +

      String

      Parameter description:

      -

      Creation time. Format: Unix timestamp.

      +

      Definition:

      +

      Configuration list creation time

      +

      Value range:

      +

      Format: Unix timestamp.

      status

      +

      status

      String

      +

      String

      Parameter description:

      -

      Task execution status.

      -

      Options:

      +

      Definition:

      +

      Cluster task execution status.

      +

      Value range:

      • success: The task is successful.

      • failed: The task failed.

      • running: The task is being executed.

      finishedAt

      +

      finishedAt

      String

      +

      String

      Parameter description:

      -

      End time. If the creation has not been completed, the end time is null. Format: Unix timestamp.

      +

      Definition:

      +

      End time. If the creation has not been completed, the end time is null.

      +

      Value range:

      +

      Format: Unix timestamp.

      modifyDeleteReset

      +

      modifyDeleteReset

      String

      +

      String

      Parameter description:

      +

      Definition:

      History of parameter setting modifications.

      +

      Value range:

      +

      N/A

      failedMsg

      +

      failedMsg

      String

      +

      String

      Parameter description:

      +

      Definition:

      Returned error message. If the status is success, the value of this parameter is null.

      +

      Value range:

      +

      N/A

      Status Code

      +
      - - - - - - - - - diff --git a/docs/css/api-ref/ResetPassword.html b/docs/css/api-ref/ResetPassword.html index c51a77d18..d18694002 100644 --- a/docs/css/api-ref/ResetPassword.html +++ b/docs/css/api-ref/ResetPassword.html @@ -1,36 +1,52 @@

      Changing the Password of a Cluster

      -

      Function

      This API is used to change the password of a cluster.

      +

      Function

      This API is used to change cluster passwords to enhance cluster security.

      -

      URI

      POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request before retry.

      409

      +

      409

      The request could not be completed due to a conflict with the current state of the resource.

      +

      The request could not be completed due to a conflict with the current state of the resource.

      The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

      412

      +

      412

      The server did not meet one of the preconditions contained in the request.

      +

      The server did not meet one of the preconditions contained in the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -38,36 +54,45 @@

      Request Parameters

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Project ID of the account.

      +

      Default value:

      +

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      ID of the cluster whose password you want to change.

      +

      Definition:

      +

      ID of the cluster whose password you want to change. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Cluster ID.

      +

      Default value:

      +

      N/A

      Table 2 Request body parameters

      Parameter

      +
      - - - - - - -
      Table 2 Request body parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      newpassword

      +

      newpassword

      Yes

      +

      Yes

      String

      +

      String

      Password of the cluster user admin in security mode. This API is available only if authorityEnable is set to true.

      +

      Definition:

      +

      Password of the administrator admin for a security-mode cluster.

      +

      Constraints:

      +

      This API is available only when authorityEnable is set to true during cluster creation.

      +

      Value range:

      • Must contain 8 to 32 characters.

        -
      • Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^&*()-_=+\|[{}];:,<.>/?).

        +
      • Must contain at least three of the following character types: letters, digits, and special characters ~!@#$%^&*()-_=+\|[{}];:,<.>/?

        +
      • Do not use the administrator name, or the administrator name spelled backwards, as the password.

      +

      Default value:

      +

      N/A

      -

      Response Parameters

      None

      +

      Response Parameters

      Status code: 200

      +

      Request succeeded.

      +

      None

      Example Requests

      Change the administrator password of the current cluster.

      -
      POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/password/reset
      +
      POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/password/reset
       
       {
         "newpassword" : "xxxxxx"
      @@ -76,32 +101,32 @@
       

      Example Responses

      None

      Status Codes

      -

      Status Code

      +
      - - - - - - - - - diff --git a/docs/css/api-ref/RestartCluster.html b/docs/css/api-ref/RestartCluster.html index 2866c44b2..584721e77 100644 --- a/docs/css/api-ref/RestartCluster.html +++ b/docs/css/api-ref/RestartCluster.html @@ -1,80 +1,99 @@

      Restarting a Cluster (Deprecated)

      -

      Function

      This API is used to restart a data node in a cluster, which will interrupt services. To restart all nodes in a cluster, you are advised to use [Restart Cluster V2] (RestartClusterMultiRole.xml).

      -
      When the cluster is available, ensure that the cluster has stopped processing service data (such as importing data and searching for data). Otherwise, data may be lost when the cluster is restarted.
      +

      Function

      This API is used to restart a data node in a cluster, which will interrupt services. To restart all nodes in a cluster, you are advised to use [Restart Cluster V2] (RestartClusterMultiRole.xml).

      +

      When the cluster is available, ensure that the cluster has stopped processing service data (such as importing data and searching for data). Otherwise, data may be lost when the cluster is restarted.

      +
      -

      URI

      POST /v1.0/{project_id}/clusters/{cluster_id}/restart

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      POST /v1.0/{project_id}/clusters/{cluster_id}/restart

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request before retry.

      409

      +

      409

      The request could not be completed due to a conflict with the current state of the resource.

      +

      The request could not be completed due to a conflict with the current state of the resource.

      The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

      412

      +

      412

      The server did not meet one of the preconditions contained in the request.

      +

      The server did not meet one of the preconditions contained in the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Project ID of the account.

      +

      Default value:

      +

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      ID of the cluster you want to restart.

      +

      Definition:

      +

      ID of the cluster you want to restart. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Cluster ID.

      +

      Default value:

      +

      N/A

      -

      Request Parameters

      None

      +

      Request Parameters

      None

      -

      Response Parameters

      None

      +

      Response Parameters

      Status code: 200

      +

      Request succeeded.

      +

      None

      -

      Example Requests

      None

      +

      Example Requests

      POST https://{Endpoint}/v1.0/{project_id}/clusters/47e49a5e-8ced-4d0d-ae15-2af62ac468e3/restart
      -

      Example Responses

      None

      +

      Example Responses

      None

      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - - - - - -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      -

      Modify the request before retry.

      +

      Invalid request.

      +

      Modify the request before retry.

      404

      +

      404

      The requested resource could not be found.

      -

      Modify the request before retry.

      +

      The requested resource could not be found.

      +

      Modify the request before retry.

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/css/api-ref/RestartClusterMultiRole.html b/docs/css/api-ref/RestartClusterMultiRole.html index 31aded281..f0341514d 100644 --- a/docs/css/api-ref/RestartClusterMultiRole.html +++ b/docs/css/api-ref/RestartClusterMultiRole.html @@ -4,34 +4,50 @@

      Function

      This API is used to restart nodes of all or some types in the current cluster.

      If a cluster is available, ensure that it has stopped handling service requests, such as importing and searching for data. Otherwise, the cluster restart may cause data loss.
      -

      URI

      POST /v2.0/{project_id}/clusters/{cluster_id}/restart

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      POST /v2.0/{project_id}/clusters/{cluster_id}/restart

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - @@ -39,37 +55,39 @@

      Request Parameters

      -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Project ID of the account.

      +

      Default value:

      +

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      ID of the cluster you want to restart.

      +

      Definition:

      +

      ID of the cluster you want to restart. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Cluster ID.

      +

      Default value:

      +

      N/A

      Table 2 Request body parameters

      Parameter

      +
      - - - - - - - - - - - @@ -77,10 +95,12 @@
      Table 2 Request body parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      type

      +

      type

      Yes

      +

      Yes

      String

      +

      String

      Operation role. Value range:

      -
      • node

        -
      • role

        +

      Definition:

      +

      Restart mode.

      +

      Value range:

      +
      • node: restarts nodes.

        +
      • role: restarts roles.

      value

      +

      value

      Yes

      +

      Yes

      String

      +

      String

      Operation parameter. Parameter description:

      -
      • If the operation role is node, the value is the node ID. You can obtain the ID attribute in instances by referring to Querying Cluster Details.

        -
      • If the operation role is role, the value is one or multiple node types (such as ess, ess-master, ess-client, and ess-cold).

        +

      Operation parameters. Parameter description:

      +
      • When the operation role is node, the value is the node ID. You can obtain the ID attribute in instances by referring to Querying Cluster Details.

        +
      • When the operation role is role, the value is one or multiple node types (such as ess, ess-master, ess-client, and ess-cold).

      -

      Response Parameters

      None

      +

      Response Parameters

      Status code: 200

      +

      Request succeeded.

      +

      None

      Example Requests

      Restart nodes of all or some types in the current cluster.

      -
      POST /v2.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/restart
      +
      POST https://{Endpoint}/v2.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/restart
       
       {
         "type" : "role",
      @@ -90,32 +110,32 @@
       

      Example Responses

      None

      Status Codes

      -

      Status Code

      +
      - - - - - - - - - @@ -127,7 +147,7 @@
      diff --git a/docs/css/api-ref/RestoreSnapshot.html b/docs/css/api-ref/RestoreSnapshot.html index d226d551c..d76c9af75 100644 --- a/docs/css/api-ref/RestoreSnapshot.html +++ b/docs/css/api-ref/RestoreSnapshot.html @@ -1,164 +1,226 @@

      Restoring a Snapshot

      -

      Function

      This API is used to manually restore a snapshot.

      +

      Function

      This API is used to manually restore a snapshot.

      -

      URI

      POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restore

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restore

      -

      Status Code

      Description

      +

      Description

      200

      +

      200

      Request succeeded.

      +

      Request succeeded.

      400

      +

      400

      Invalid request.

      +

      Invalid request.

      Modify the request before retry.

      409

      +

      409

      The request could not be completed due to a conflict with the current state of the resource.

      +

      The request could not be completed due to a conflict with the current state of the resource.

      The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

      412

      +

      412

      The server did not meet one of the preconditions contained in the request.

      +

      The server did not meet one of the preconditions contained in the request.

      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - - - - -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Project ID of the account.

      +

      Default value:

      +

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      ID of the cluster whose snapshot you want to restore.

      +

      Definition:

      +

      ID of the cluster whose snapshot you want to restore. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Cluster ID.

      +

      Default value:

      +

      N/A

      snapshot_id

      +

      snapshot_id

      Yes

      +

      Yes

      String

      +

      String

      Snapshot ID.

      +

      Definition:

      +

      Snapshot ID.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      N/A

      +

      Default value:

      +

      N/A

      -

      Request Parameters

      -
      Table 2 Request body parameters

      Parameter

      +

      Request Parameters

      +
      - - - - - - - - - - - - - - - - - - - - - - -
      Table 2 Request body parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      targetCluster

      +

      target_cluster

      Yes

      +

      Yes

      String

      +

      String

      Parameter description:

      -

      ID of the cluster that a snapshot is to be restored to.

      +

      Definition:

      +

      ID of the cluster that a snapshot is to be restored to.

      +

      Constraints:

      +
      • If the current cluster is available, snapshots are restored to the current cluster by default. Alternatively, you can choose to restore them to another specified cluster.

        +
      • The destination cluster must be in the same region as the current cluster, and must have a later version than the current cluster.

        +
      +

      Value range:

      +

      N/A

      +

      Default value:

      +

      N/A

      indices

      +

      indices

      No

      +

      No

      String

      +

      String

      Parameter description:

      -

      Enter the name of the index you want to restore. The default value is empty.

      -

      If you do not specify any index name, all indexes in snapshots will be restored by default. You can use * to match multiple indexes. For example, index* indicates that all indexes with the prefix index will be restored. Or you can restore indexes by specifying their names, for example, index1,index2,index3. When * is used for index matching, the .opendistro_security index and any system indexes whose name is prefixed with .kibana are filtered out by default. The .opendistro_security index cannot be restored. To restore an index whose name is prefixed with .kibana, you need to specify the index name.

      -

      Options:

      -

      The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: "\<|>/?

      +

      Definition:

      +

      Specify the name of the index you want to restore.

      +

      Constraints:

      +

      You can use "*" to match multiple indexes. For example, index* indicates that all indexes with the prefix index will be restored.

      +
      • Or you can restore indexes by specifying their names, for example, index1,index2,index3.

        +
      • When "*" is used for index matching, the .opendistro_security index and any system indexes whose name is prefixed with .kibana are filtered out by default. The .opendistro_security index cannot be restored. To restore an index whose name is prefixed with .kibana, you need to specify the index name.

        +
      +

      Value range:

      +

      The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: "\<|>/?

      +

      Default value:

      +

      By default, this parameter is left blank.

      +

      If you do not specify any index name, all indexes in snapshots will be restored by default.

      renamePattern

      +

      rename_pattern

      No

      +

      No

      String

      +

      String

      ** Parameter description**:

      -

      Rule for defining the indices to be restored. The value contains a maximum of 1,024 characters. Restore the indexes that meet the filter criteria. Use regular expressions as the filter criteria. The renamePattern and renameReplacement parameters must be set at the same time to take effect.

      -

      ** Value range**:

      -

      The value contains 0 to 1024 characters and cannot contain spaces, uppercase letters, or the following special characters: "\<|>/?,

      +

      Definition:

      +

      Rule for defining the indexes to be restored.

      +

      Constraints:

      +
      • Indexes that match this rule will be restored. The filtering condition must be a regular expression.

        +
      • The renamePattern and renameReplacement parameters must be set at the same time in order for them to take effect.

        +
      +

      Value range:

      +

      The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?

      +

      Default value:

      +

      N/A

      renameReplacement

      +

      rename_replacement

      No

      +

      No

      String

      +

      String

      ** Parameter description**:

      -
      NOTE:
      Rule for renaming an index. The value contains 0 to 1024 characters and cannot contain spaces, uppercase letters, or the following special characters: "\<|>/?, For example, restored_index_$1 indicates that restored_ is added before the names of all restored indexes.

      The renamePattern and renameReplacement parameters must be set at the same time to take effect.

      -
      +

      Definition:

      +

      Rule for renaming an index.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +
      • The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/? For example, restored_index_$1 indicates adding the restored_ prefix to the names of all the restored indexes.

        +
      • The renamePattern and renameReplacement parameters must be set at the same time in order for them to take effect.

        +
      +

      Default value:

      +

      N/A

      replace_exist_indices

      +

      replace_exist_indices

      No

      +

      No

      Boolean

      +

      Boolean

      ** Parameter description**:

      -

      Replace the existing index.

      +

      Definition:

      +

      Whether to replace existing indexes.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +
      • false: Do not replace existing indexes.

        +
      • true: Replace existing indexes.

        +
      +

      Default value:

      +

      false

      -

      Response Parameters

      None

      +

      Response Parameters

      Status code: 201

      +

      Resource created.

      +

      None

      -

      Example Requests

      Restore a snapshot.

      -
      POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/653c086f-ebe7-4383-b902-c031b354f1dd/restore
      +

      Example Requests

      Restore a snapshot.

      +
      POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/653c086f-ebe7-4383-b902-c031b354f1dd/restore
       
       {
      -  "targetCluster" : "ea244205-d641-45d9-9dcb-ab2236bcd07e",
      +  "target_cluster" : "ea244205-d641-45d9-9dcb-ab2236bcd07e",
         "indices" : "myindex1,myindex2",
      -  "renamePattern" : "index",
      -  "renameReplacement" : "restored_index_$1"
      +  "rename_pattern" : "index",
      +  "rename_replacement" : "restored_index_$1"
       }
      -

      Example Responses

      None

      +

      Example Responses

      None

      -

      Status Codes

      -

      Status Code

      +

      Status Codes

      +
      - - - - - - -

      Status Code

      Description

      +

      Description

      201

      +

      201

      Resource created.

      +

      Resource created.

      400

      +

      400

      Invalid request.

      -

      Modify the request before retry.

      +

      Invalid request.

      +

      Modify the request before retry.

      403

      +

      403

      Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

      +

      Request rejected.

      +

      The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

      -

      Error Codes

      See Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/css/api-ref/RetryUpgradeTask.html b/docs/css/api-ref/RetryUpgradeTask.html index a9f3e2c47..4a2488537 100644 --- a/docs/css/api-ref/RetryUpgradeTask.html +++ b/docs/css/api-ref/RetryUpgradeTask.html @@ -1,115 +1,147 @@

      Retrying a Failed Upgrade Task

      -

      Function

      The upgrade may fail due to network problems. In this case, you can call this API to retry.

      +

      Function

      The upgrade may fail due to network problems. In this case, you can call this API to retry.

      -

      URI

      PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retry

      +

      Calling Method

      For details, see Calling APIs.

      +
      +

      URI

      PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retry

      -
      Table 1 Path Parameters

      Parameter

      +
      - - - - - - - - - - - - - - -
      Table 1 Path Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      project_id

      +

      project_id

      Yes

      +

      Yes

      String

      +

      String

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Definition:

      +

      Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Project ID of the account.

      +

      Default value:

      +

      N/A

      cluster_id

      +

      cluster_id

      Yes

      +

      Yes

      String

      +

      String

      ID of the cluster to retry upgrade.

      +

      Definition:

      +

      ID of the cluster to retry upgrade. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      Cluster ID.

      +

      Default value:

      +

      N/A

      action_id

      +

      action_id

      Yes

      +

      Yes

      String

      +

      String

      ID of the task to be retried.

      +

      Definition:

      +

      ID of the task to be retried.

      +

      Constraints:

      +

      N/A

      +

      Value range:

      +

      N/A

      +

      Default value:

      +

      N/A

      -
      Table 2 Query Parameters

      Parameter

      +
      - - - - - - -
      Table 2 Query Parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      retry_mode

      +

      retry_mode

      No

      +

      No

      String

      +

      String

      Impact of terminating the task. Currently, its value can only be abort.

      +

      Definition:

      +

      If this parameter is not left blank, the task will be terminated.

      +

      Constraints:

      +

      Currently, its value can only be abort.

      +

      Value range:

      +

      abort: Abort the task.

      +

      Default value:

      +

      N/A

      -

      Request Parameters

      None

      +

      Request Parameters

      None

      -

      Response Parameters

      None

      +

      Response Parameters

      Status code: 200

      +

      Request succeeded.

      +

      None

      -

      Example Requests

      • Example of an upgrade task retry request.

        -
        PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry
        -
      • Example of an upgrade task termination request.

        -
        PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry?retry_mode=abort
        +

        Example Requests

        • Example of an upgrade task retry request.

          +
          PUT https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry
          +
        • Example of an upgrade task termination request.

          +
          PUT https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry?retry_mode=abort
        -

        Example Responses

        None

        +

        Example Responses

        None

        -

        Status Codes

        -

        Status Code

        +

        Status Codes

        +
        - - - - - - -

        Status Code

        Description

        +

        Description

        200

        +

        200

        Request succeeded.

        +

        Request succeeded.

        400

        +

        400

        Invalid request.

        -

        The client should not repeat the request without modifications.

        +

        Invalid request.

        +

        The client should not repeat the request without modifications.

        403

        +

        403

        Request rejected.

        -

        The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

        +

        Request rejected.

        +

        The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

        -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/css/api-ref/RollingRestart.html b/docs/css/api-ref/RollingRestart.html index 35dc848fd..ea89b16cb 100644 --- a/docs/css/api-ref/RollingRestart.html +++ b/docs/css/api-ref/RollingRestart.html @@ -1,37 +1,53 @@ -

        Rolling Restart

        +

        Rolling Restart (Deprecated)

        Function

        This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.

        Rolling restart is supported only when the cluster has more than three nodes (including master nodes, client nodes, and cold data nodes). When the cluster is available, ensure that the cluster has stopped handling service requests (such as importing data and searching for data). Otherwise, the cluster restart may cause data loss.
        -

        URI

        POST /v2.0/{project_id}/clusters/{cluster_id}/rolling_restart

        +

        Calling Method

        For details, see Calling APIs.

        +
        +

        URI

        POST /v2.0/{project_id}/clusters/{cluster_id}/rolling_restart

        -
        Table 1 Path Parameters

        Parameter

        +
        - - - - - - - - - - - @@ -39,32 +55,32 @@

        Request Parameters

        -
        Table 1 Path Parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        project_id

        +

        project_id

        Yes

        +

        Yes

        String

        +

        String

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Definition:

        +

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +

        Project ID of the account.

        +

        Default value:

        +

        N/A

        cluster_id

        +

        cluster_id

        Yes

        +

        Yes

        String

        +

        String

        ID of the cluster you want to restart.

        +

        Definition:

        +

        ID of the cluster you want to restart. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +

        Cluster ID.

        +

        Default value:

        +

        N/A

        Table 2 Request body parameters

        Parameter

        +
        - - - - - - - - - - -
        Table 2 Request body parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        type

        +

        type

        Yes

        +

        Yes

        String

        +

        String

        Operation role. Its type can only be role.

        +

        Operation role. Its type can only be role.

        value

        +

        value

        Yes

        +

        Yes

        String

        +

        String

        Instance type. (At least one data node is required when you configure instance types.) Use commas (,) to separate multiple types. For example:

        +

        Instance type. (At least one data node is required when you configure instance types.) Use commas (,) to separate multiple types. For example:

        • ess-master indicates a master node.

        • ess-client indicates a client node.

        • ess-cold indicates a cold data node.

          @@ -77,10 +93,12 @@
        -

        Response Parameters

        None

        +

        Response Parameters

        Status code: 200

        +

        Request succeeded.

        +

        None

        Example Requests

        Restart a node.

        -
        POST /v2.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/rolling_restart
        +
        POST https://{Endpoint}/v2.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/rolling_restart
         
         {
           "type" : "role",
        @@ -90,32 +108,32 @@
         

        Example Responses

        None

        Status Codes

        -

        Status Code

        +
        - - - - - - - - - @@ -127,7 +145,7 @@
        diff --git a/docs/css/api-ref/RollingRestartV2.html b/docs/css/api-ref/RollingRestartV2.html new file mode 100644 index 000000000..52db8e9b1 --- /dev/null +++ b/docs/css/api-ref/RollingRestartV2.html @@ -0,0 +1,151 @@ + + +

        Rolling Restart

        +

        Function

        This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.

        +
        Rolling restart is supported only when the cluster has more than three nodes (including master nodes, client nodes, and cold data nodes). When the cluster is available, ensure that the cluster has stopped handling service requests (such as importing data and searching for data). Otherwise, the cluster restart may cause data loss.
        +
        +

        Calling Method

        For details, see Calling APIs.

        +
        +

        URI

        POST /v2.0/{project_id}/clusters/{cluster_id}/rolling-restart

        + +

        Status Code

        Description

        +

        Description

        200

        +

        200

        Request succeeded.

        +

        Request succeeded.

        400

        +

        400

        Invalid request.

        +

        Invalid request.

        Modify the request before retry.

        409

        +

        409

        The request could not be completed due to a conflict with the current state of the resource.

        +

        The request could not be completed due to a conflict with the current state of the resource.

        The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

        412

        +

        412

        The server did not meet one of the preconditions contained in the request.

        +

        The server did not meet one of the preconditions contained in the request.

        + + + + + + + + + + + + + + + + +
        Table 1 Path Parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        project_id

        +

        Yes

        +

        String

        +

        Definition:

        +

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +

        Project ID of the account.

        +

        Default value:

        +

        N/A

        +

        cluster_id

        +

        Yes

        +

        String

        +

        Definition:

        +

        ID of the cluster you want to restart. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +

        Cluster ID.

        +

        Default value:

        +

        N/A

        +
        +
        + +

        Request Parameters

        +
        + + + + + + + + + + + + + + + + +
        Table 2 Request body parameters

        Parameter

        +

        Mandatory

        +

        Type

        +

        Description

        +

        type

        +

        Yes

        +

        String

        +

        Operation role. Its type can only be role.

        +

        value

        +

        Yes

        +

        String

        +

        Instance type. (At least one data node is required when you configure instance types.) Use commas (,) to separate multiple types. For example:

        +
        • ess-master indicates a master node.

          +
        • ess-client indicates a client node.

          +
        • ess-cold indicates a cold data node.

          +
        • ess indicates a data node.

          +
        • all indicates all nodes.

          +
        +
        +
        +
        +

        Response Parameters

        Status code: 200

        +

        Request succeeded.

        +

        None

        +
        +

        Example Requests

        Restart the node.

        +
        POST https://{Endpoint}/v2.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/rolling-restart
        +
        +{
        +  "type" : "role",
        +  "value" : "ess"
        +}
        +
        +

        Example Responses

        None

        +
        +

        Status Codes

        +
        + + + + + + + + + + + + + + + + +

        Status Code

        +

        Description

        +

        200

        +

        Request succeeded.

        +

        400

        +

        The request is invalid.

        +

        Do not retry the request without modifying it.

        +

        409

        +

        The request cannot be processed due to a conflict.

        +

        This status code indicates that the resource that the client attempts to create already exists, or the request failed to be processed because of the update of the conflict request.

        +

        412

        +

        The server did not meet one of the preconditions contained in the request.

        +
        +
        +
        +

        Error Codes

        See Error Codes.

        +
        + +
        + +
        + diff --git a/docs/css/api-ref/ShowAutoCreatePolicy.html b/docs/css/api-ref/ShowAutoCreatePolicy.html index df3082e0a..80da0a85b 100644 --- a/docs/css/api-ref/ShowAutoCreatePolicy.html +++ b/docs/css/api-ref/ShowAutoCreatePolicy.html @@ -1,48 +1,53 @@

        Querying the Automatic Snapshot Creation Policy

        -

        Function

        This API is used to query the automatic snapshot creation policy.

        +

        Function

        CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's data. By restoring this snapshot, you can restore the cluster to a previous state. There are two ways to create snapshots to back up a CSS cluster: automatic and manual. This API is used to query the automatic snapshot creation policy.

        +
        • Automatic snapshot creation: Snapshots are automatically created daily or weekly based on a preset time schedule, ensuring ongoing data protection. By configuring an automatic snapshot policy, you reduce manual operations while improving backup reliability and efficiency.

          +
        • Manual snapshot creation: You create snapshots manually for special occasions, for example, prior to a high-risk operation (such as a cluster upgrade). This ensures you can restore data using snapshots in case anything should go wrong. Manual snapshots provide additional flexibility.

          +
        -

        URI

        GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

        +

        Calling Method

        For details, see Calling APIs.

        +
        +

        URI

        GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

        -
        Table 1 Path Parameters

        Parameter

        +
        - - - - - - - - - - - @@ -55,79 +60,39 @@

        Response Parameters

        Status code: 200

        -
        Table 1 Path Parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        project_id

        +

        project_id

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        -

        The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Definition:

        +

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        Constraints:

        N/A

        -

        Options:

        -

        For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Value range:

        +

        Project ID of the account.

        Default value:

        N/A

        cluster_id

        +

        cluster_id

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        -

        ID of the cluster where snapshots are to be automatically created.

        +

        Definition:

        +

        ID of the cluster where snapshots are to be automatically created. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        Constraints:

        N/A

        -

        Options:

        -

        For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        +

        Value range:

        +

        Cluster ID.

        Default value:

        N/A

        Table 2 Response body parameters

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Table 2 Response body parameters

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        keepday

        +

        keepday

        Integer

        +

        Integer

        Parameter description:

        +

        Definition:

        Customize the number of snapshots to be retained.

        +

        Value range:

        +

        N/A

        period

        +

        period

        String

        +

        String

        Parameter description:

        +

        Definition:

        Time when a snapshot is created every day.

        +

        Value range:

        +

        N/A

        prefix

        +

        frequency

        String

        +

        String

        Parameter description:

        -

        Snapshot name prefix, which needs to be manually entered.

        -

        bucket

        -

        String

        -

        Parameter description:

        -

        Name of the OBS bucket where snapshots are stored.

        -

        basePath

        -

        String

        -

        Parameter description:

        -

        Storage path of the snapshot in the OBS bucket.

        -

        agency

        -

        String

        -

        Parameter description:

        -

        Agency used to access OBS buckets.

        -

        enable

        -

        String

        -

        Parameter description:

        -

        Whether to enable the automatic snapshot creation policy.

        -

        Options:

        -
        • true: The automatic snapshot creation policy is enabled.

          -
        • false: The automatic snapshot creation policy is disabled.

          -
        -

        frequency

        -

        String

        -

        Parameter description:

        +

        Parameter description:

        Frequency of automatically creating snapshots.

        Options:

        • DAY: days.

          @@ -142,41 +107,159 @@

        prefix

        +

        String

        +

        Definition:

        +

        Snapshot name prefix, which needs to be manually entered.

        +

        Value range:

        +

        N/A

        +

        bucket

        +

        String

        +

        Definition:

        +

        Name of the OBS bucket where snapshots are stored.

        +

        Value range:

        +

        N/A

        +

        basePath

        +

        String

        +

        Definition:

        +

        Storage path of the snapshot in the OBS bucket.

        +

        Value range:

        +

        N/A

        +

        agency

        +

        String

        +

        Definition:

        +

        Agency name. You can create an agency to allow CSS to call other cloud services. An agency name cannot contain special characters or Chinese characters.

        +

        Value range:

        +

        Only a-z, A-Z, 0-9, hyphens (-) and underscores (_) are allowed.

        +

        enable

        +

        String

        +

        Parameter description:

        +

        Whether to enable the automatic snapshot creation policy.

        +

        Options:

        +
        • true: The automatic snapshot creation policy is enabled.

          +
        • false: The automatic snapshot creation policy is disabled.

          +
        +

        indices

        +

        String

        +

        Definition:

        +

        Name of an index to be backed up. Multiple indexes are separated by commas (,). By default, all indexes are backed up. You can use the combination of a backslash and an asterisk (*) to back up data of certain indexes. For example, if you specify 2018-06*, then the data of the indexes with the prefix 2018-06 will be backed up.

        +

        Value range:

        +

        The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?

        +

        snapshotCmkId

        +

        String

        +

        Definition:

        +

        Snapshot ID.

        +

        Value range:

        +

        N/A

        +

        maxSnapshotBytesPerSeconds

        +

        String

        +

        Definition:

        +

        This parameter sets the maximum backup speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

        +

        Value range:

        +

        The following values and formats are allowed:

        +
        • Number + Unit

          +
        +

        The number ranges from 0 to 9999.

        +

        The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

        +

        0mb means there is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

        +
        • 0

          +
        +

        There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

        +
        • -1

          +
        +

        There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

        +

        maxRestoreBytesPerSeconds

        +

        String

        +

        Definition:

        +

        This parameter sets the maximum recovery speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

        +

        Value range:

        +

        The following values and formats are allowed:

        +
        • Number + Unit

          +
        +

        The number ranges from 0 to 9999.

        +

        The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

        +

        0mb means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

        +
        • 0

          +
        +

        There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

        +
        • -1

          +
        +

        There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

        +

        Example Requests

        Query the automatic snapshot creation policy.

        -
        GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
        +
        GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy

        Example Responses

        Status code: 200

        Request succeeded.

        {
           "keepday" : 2,
        -  "frequency" : "DAY",
           "period" : "16:00 GMT+08:00",
        +  "frequency" : "DAY",
           "prefix" : "snapshot",
           "bucket" : "es-backup",
           "basePath" : "css_repository/tests",
           "agency" : "usearch",
        -  "enable" : "true"
        +  "enable" : "true",
        +  "indices" : "*",
        +  "snapshotCmkId" : null,
        +  "maxSnapshotBytesPerSeconds" : "40MB",
        +  "maxRestoreBytesPerSeconds" : "0MB"
         }

        Status Codes

        -

        Status Code

        +
        - - - - - diff --git a/docs/css/api-ref/ShowClusterDetail.html b/docs/css/api-ref/ShowClusterDetail.html index f8c633aad..a3d706a48 100644 --- a/docs/css/api-ref/ShowClusterDetail.html +++ b/docs/css/api-ref/ShowClusterDetail.html @@ -1,777 +1,932 @@

        Querying Cluster Details

        -

        Function

        This API is used to query and display the details of a cluster.

        +

        Function

        This API is used to query and display details about a single cluster, including the cluster's search type, node list, network information, cluster name, cluster ID, and cluster status, so that you can check whether the created cluster meets your expectation. You can also log in to the official website, access the CSS console, and obtain the cluster's private IP address, public IP address, version, and node information on the cluster information page.

        -

        URI

        GET /v1.0/{project_id}/clusters/{cluster_id}

        +

        Calling Method

        For details, see Calling APIs.

        +
        +

        URI

        GET /v1.0/{project_id}/clusters/{cluster_id}

        -

        Status Code

        Description

        +

        Description

        200

        +

        200

        Request succeeded.

        +

        Request succeeded.

        406

        +

        406

        The server could not fulfill the request according to the content characteristics of the request.

        +

        The server could not fulfill the request according to the content characteristics of the request.

        Table 1 Path Parameters

        Parameter

        +
        - - - - - - - - - - -
        Table 1 Path Parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        project_id

        +

        project_id

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        -

        The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        -

        Constraints:

        -

        N/A

        -

        Options:

        -

        For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        -

        Default value:

        -

        N/A

        +

        Definition:

        +

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +

        Project ID of the account.

        +

        Default value:

        +

        N/A

        cluster_id

        +

        cluster_id

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        -

        Specifies the ID of the cluster to be queried. For details, see Obtaining the Cluster ID.

        -

        Constraints:

        -

        N/A

        -

        Options:

        -

        For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        -

        Default value:

        -

        N/A

        +

        Definition:

        +

        ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +

        Cluster ID.

        +

        Default value:

        +

        N/A

        -

        Request Parameters

        None

        +

        Request Parameters

        None

        -

        Response Parameters

        Status code: 200

        +

        Response Parameters

        Status code: 200

        -
        Table 2 Response body parameters

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + +
        Table 2 Response body parameters

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        datastore

        +

        datastore

        ClusterDetailDatastore object

        +

        ClusterDetailDatastore object

        Parameter description:

        -

        Search engine.

        +

        Definition:

        +

        Cluster data search engine type.

        +

        Value range:

        +

        N/A

        instances

        +

        instances

        Array of ClusterDetailInstances objects

        +

        Array of ClusterDetailInstances objects

        Parameter description:

        -

        List of node objects.

        +

        Definition:

        +

        List of node objects.

        +

        Value range:

        +

        N/A

        publicKibanaResp

        +

        publicKibanaResp

        publicKibanaRespBody object

        +

        publicKibanaRespBody object

        Parameter description:

        -

        Kibana public network access information.

        +

        Definition:

        +

        Kibana public network access information.

        +

        Value range:

        +

        N/A

        elbWhiteList

        +

        elbWhiteList

        elbWhiteListResp object

        +

        elbWhiteListResp object

        Parameter description:

        -

        Public network access control information.

        +

        Definition:

        +

        Kibana public network access control information.

        +

        Value range:

        +

        N/A

        updated

        +

        updated

        String

        +

        String

        Parameter description:

        -

        Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

        +

        Definition:

        +

        Time when the cluster was last modified.

        +

        Value range:

        +

        The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

        name

        +

        name

        String

        +

        String

        Parameter description:

        -

        Cluster name.

        +

        Definition:

        +

        Cluster name.

        +

        Value range:

        +

        N/A

        publicIp

        +

        publicIp

        String

        +

        String

        Parameter description:

        -

        Public IP address and port number.

        +

        Definition:

        +

        Public IP address and port number.

        +

        Value range:

        +

        N/A

        created

        +

        created

        String

        +

        String

        Parameter description:

        -

        Cluster creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

        +

        Definition:

        +

        Time when a cluster was created.

        +

        Value range:

        +

        The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

        id

        +

        id

        String

        +

        String

        Parameter description:

        -

        Cluster ID.

        +

        Definition:

        +

        Cluster ID.

        +

        Value range:

        +

        N/A

        status

        +

        status

        String

        +

        String

        Parameter description:

        -

        Cluster status.

        -

        Options:

        -

        100: An operation, such as creation, is in progress.

        -
        • 200: Available

          -
        • 303: Unavailable, for example, due to a creation failure.

          +

        Parameter description:

        +

        Cluster status.

        +

        Options:

        +

        100: An operation, such as creation, is in progress.

        +
        • 200: Available

          +
        • 303: unavailable, for example, due to a creation failure.

        endpoint

        +

        endpoint

        String

        +

        String

        Parameter description:

        -

        IPv4 address and port number accessed from the cluster's private network. [If the cluster type is KooSearch, this field indicates the internal address and port number for accessing the knowledge management service.] (tag:white)

        +

        Definition:

        +

        IPv4 address and port number accessed from the cluster's private network. [If the cluster type is KooSearch, this field indicates the internal address and port number for accessing the knowledge management service.] (tag:white)

        +

        Value range:

        +

        N/A

        vpcId

        +

        vpcId

        String

        +

        String

        Parameter description:

        -

        VPC ID.

        +

        Definition:

        +

        VPC ID.

        +

        Value range:

        +

        N/A

        subnetId

        +

        subnetId

        String

        +

        String

        Parameter description:

        -

        Subnet ID.

        +

        Definition:

        +

        Current subnet of a cluster. This subnet is used to add nodes, including scaling, adding dedicated master/client nodes, and enabling the VPC Endpoint service. IP addresses will be allocated to newly added nodes from the current subnet.

        +

        Value range:

        +

        N/A

        securityGroupId

        +

        securityGroupId

        String

        +

        String

        Parameter description:

        -

        Security group ID.

        +

        Definition:

        +

        Security group ID.

        +

        Value range:

        +

        N/A

        vpcepIp

        +

        vpcepIp

        String

        +

        String

        Parameter description:

        -

        VPC endpoint IP address.

        +

        Definition:

        +

        VPC endpoint IP address.

        +

        Value range:

        +

        N/A

        vpcepIpv6Address

        +

        vpcepIpv6Address

        String

        +

        String

        Parameter description:

        -

        IPv6 address of the VPC endpoint.

        +

        Definition:

        +

        IPv6 address of the VPC endpoint.

        +

        Value range:

        +

        N/A

        bandwidthSize

        +

        bandwidthSize

        Integer

        +

        Integer

        Parameter description:

        -

        Public network bandwidth. Unit: Mbit/s

        +

        Definition:

        +

        Public network bandwidth, in Mbit/s.

        +

        Value range:

        +

        N/A

        httpsEnable

        +

        httpsEnable

        Boolean

        +

        Boolean

        Parameter description:

        -

        Communication encryption status.

        -

        Options:

        -
        • false: Communication encryption is not enabled.

          -
        • true: Communication encryption is enabled.

          +

        Parameter description:

        +

        Communication encryption status.

        +

        Options:

        +
        • false: Communication encryption is not enabled.

          +
        • true: Communication encryption is enabled.

        diskEncrypted

        +

        diskEncrypted

        Boolean

        +

        Boolean

        Parameter description:

        -

        Whether disks are encrypted.

        -

        Options:

        -
        • true: Disks are encrypted.

          -
        • false: Disk are not encrypted.

          +

        Parameter description:

        +

        Whether disks are encrypted.

        +

        Options:

        +
        • true: Disks are encrypted.

          +
        • false: Disk are not encrypted.

        authorityEnable

        +

        authorityEnable

        Boolean

        +

        Boolean

        Parameter description:

        -

        Whether to enable authentication. Available values include true and false. Authentication is disabled by default.

        -

        Options:

        -
        • true: Authentication is enabled for the cluster.

          -
        • false: Authentication is disabled for the cluster.

          +

        Definition:

        +

        Whether to enable security mode-based authentication for the cluster.

        +

        Value range:

        +
        • true: Enable security mode-based authentication.

          +
        • false: Disable security mode-based authentication.

        backupAvailable

        +

        backupAvailable

        Boolean

        +

        Boolean

        Parameter description:

        -

        Whether the snapshot function is enabled.

        -

        Options:

        -
        • true: The snapshot function is enabled.

          -
        • false: The snapshot function is disabled.

          +

        Definition:

        +

        Whether snapshot is enabled.

        +

        Value range:

        +
        • true: The snapshot function is enabled.

          +
        • false: The snapshot function is disabled.

        actionProgress

        +

        actionProgress

        Object

        +

        Object

        Parameter description:

        -

        Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage.

        +

        Definition:

        +

        Cluster behavior progress, which shows the progress of cluster creation and scaling in percentage.

        +

        Value range:

        +

        N/A

        actions

        +

        actions

        Array of strings

        +

        Array of strings

        Parameter description:

        -

        Current behavior of a cluster. REBOOTING indicates that the cluster is being restarted. GROWING indicates that the cluster is being scaled. RESTORING indicates that the cluster is being restored. SNAPSHOTTING indicates that the snapshot is being created.

        +

        Definition:

        +

        List of ongoing tasks in the cluster.

        +

        Value range:

        +
        • REBOOTING

          +
        • GROWING

          +
        • RESTORING: The cluster is being restored.

          +
        • SNAPSHOTTING: A snapshot is being created.

          +

        enterpriseProjectId

        +

        enterpriseProjectId

        String

        +

        String

        Parameter description:

        -

        ID of the enterprise project that a cluster belongs.

        -

        If the user of the cluster has not enabled the enterprise project, the setting of this parameter is not returned.

        +

        Definition:

        +

        ID of the enterprise project that a cluster belongs. If the user of the cluster has not enabled the enterprise project, the setting of this parameter is not returned.

        +

        Value range:

        +

        N/A

        tags

        +

        tags

        Array of ClusterDetailTags objects

        +

        Array of ClusterDetailTags objects

        Parameter description:

        -

        Cluster tags.

        +

        Definition:

        +

        Cluster tags.

        +

        Value range:

        +

        N/A

        failedReason

        +

        failedReason

        ClusterDetailFailedReasons object

        +

        ClusterDetailFailedReasons object

        Parameter description:

        -

        Failure cause. If the cluster is in the available status, this parameter is not returned.

        +

        Definition:

        +

        Failure cause of a cluster change task. If the cluster status is available, this parameter is not returned.

        +

        Value range:

        +

        N/A

        bandwidthResourceId

        +

        bandwidthResourceId

        String

        +

        String

        Parameter description:

        -

        ID of the resource accessible from the public network.

        +

        Definition:

        +

        ID of the resource accessible from the public network.

        +

        Value range:

        +

        N/A

        ipv6Endpoint

        +

        ipv6Endpoint

        String

        +

        String

        Parameter description:

        -

        IPv6 address and port number accessed from the cluster's private network.

        +

        Definition:

        +

        IPv6 address and port number accessed from the cluster's private network.

        +

        Value range:

        +

        N/A

        supportVpcep

        +

        supportVpcep

        Boolean

        +

        Boolean

        Parameter description:

        -

        Whether the VPCEP service can be enabled for the current cluster.

        +

        Definition:

        +

        Whether the VPCEP service can be enabled for the current cluster.

        +

        Value range:

        +
        • true: supported.

          +
        • false: not supported.

          +

        cmkId

        +

        cmkId

        String

        +

        String

        Parameter description:

        -

        Encryption key ID used by the current cluster.

        +

        Definition:

        +

        Encryption key ID used by the current cluster.

        +

        Value range:

        +

        N/A

        +

        currentSubnetIds

        +

        String

        +

        Definition:

        +

        Subnets used by all nodes in the cluster. If there are multiple subnets (two at most), separate them with a comma (,).

        +

        Value range:

        +

        N/A

        +

        desc

        +

        String

        +

        Definition:

        +

        Cluster description.

        +

        Constraints:

        +

        The value can contain up to 128 characters. display_name and desc cannot be null at the same time.

        +

        Value range:

        +

        N/A

        +

        Default value:

        +

        N/A

        -
        Table 3 ClusterDetailDatastore

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - -
        Table 3 ClusterDetailDatastore

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        type

        +

        type

        String

        +

        String

        Parameter description:

        -

        Engine type.

        -

        Options:

        -

        elasticsearch, logstash, or opensearch.

        -

        version

        -

        String

        -

        Parameter description:

        -

        Version of the CSS cluster engine. For details, see the supported versions in Before You Start.

        -

        subVersion

        -

        String

        -

        Parameter description:

        -

        Cluster image version.

        -

        isEosCluster

        -

        Boolean

        -

        Parameter description:

        -

        Whether the cluster image version has reached EOS.

        -

        Options:

        -

        true indicates that the image version has reached EOS; false indicates that the image version has not reached EOS.

        -

        supportSecuritymode

        -

        Boolean

        -

        Parameter description:

        -

        Whether the security mode is supported.

        -

        Options:

        -

        The value can be true (supported) or false (not supported).

        -
        -
        - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 4 ClusterDetailInstances

        Parameter

        -

        Type

        -

        Description

        -

        status

        -

        String

        -

        Parameter description:

        -

        Node status.

        -

        Options:

        -
        • 100: creating

          -
        • 200: available

          -
        • 303: unavailable, for example, due to a creation failure.

          +

        Definition:

        +

        Engine type.

        +

        Value range:

        +
        • elasticsearch: Provides distributed search capabilities, log analytics, reporting, and semantic search based on open-source Elasticsearch.

          +
        • logstash: provides distributed search, log analytics, reporting, and semantic search based on open-source OpenSearch.

          +
        • opensearch: Provides functions such as data ingestion, transformation, cleaning, and parsing based on open-source Logstash.

        resourceId

        +

        version

        String

        +

        String

        Parameter description:

        -

        Instance resource ID.

        +

        Definition:

        +

        Version of the CSS cluster engine. For details, see the supported versions in Before You Start.

        +

        Value range:

        +

        N/A

        type

        +

        subVersion

        String

        +

        String

        Parameter description:

        -

        Type of the current node.

        +

        Definition:

        +

        Cluster image version.

        +

        Value range:

        +

        N/A

        id

        +

        isEosCluster

        String

        +

        Boolean

        Parameter description:

        -

        Instance ID.

        -

        name

        -

        String

        -

        Parameter description:

        -

        Instance name.

        -

        specCode

        -

        String

        -

        Parameter description:

        -

        Node flavor name.

        -

        azCode

        -

        String

        -

        Parameter description:

        -

        AZ of a node.

        -

        privateIp

        -

        String

        -

        Parameter description:

        -

        Instance IP address.

        -

        volume

        -

        ShowClusterVolumeRsp object

        -

        Parameter description:

        -

        Instance disk information.

        -
        -
        - -
        - - - - - - - - - - - - - - - - - -
        Table 5 ShowClusterVolumeRsp

        Parameter

        -

        Type

        -

        Description

        -

        type

        -

        String

        -

        Parameter description:

        -

        Instance disk type

        -

        size

        -

        Integer

        -

        Parameter description:

        -

        Instance disk size

        -

        resourceIds

        -

        Array of strings

        -

        Parameter description:

        -

        Instance disk resource ID

        -
        -
        - -
        - - - - - - - - - - - - - - - - - - - - - -
        Table 6 publicKibanaRespBody

        Parameter

        -

        Type

        -

        Description

        -

        eipSize

        -

        Integer

        -

        Bandwidth range. Unit: Mbit/s

        -

        elbWhiteListResp

        -

        kibanaElbWhiteListResp object

        -

        Parameter description:

        -

        Kibana public network access control information.

        -

        publicKibanaIp

        -

        String

        -

        Parameter description:

        -

        Specifies the IP address for accessing Kibana.

        -

        bandwidthResourceId

        -

        String

        -

        Parameter description:

        -

        Resource ID corresponding to the Kibana public network

        -
        -
        - -
        - - - - - - - - - - - - -
        Table 7 kibanaElbWhiteListResp

        Parameter

        -

        Type

        -

        Description

        -

        enableWhiteList

        -

        Boolean

        -

        Whether to enable Kibana access control.

        -

        Options:

        -
        • true: Access control is enabled.

          -
        • false: Access control is disabled.

          +

        Definition:

        +

        Whether the cluster image version has reached EOS.

        +

        Value range:

        +
        • true: yes.

          +
        • false: no.

        whiteList

        +

        supportSecuritymode

        String

        +

        Boolean

        Parameter description:

        -

        Whitelist for Kibana public network access.

        -
        -
        - -
        - - - - - - - - - - -
        Table 8 elbWhiteListResp

        Parameter

        -

        Type

        -

        Description

        -

        enableWhiteList

        -

        Boolean

        -

        Parameter description:

        -

        Whether to enable public network access control.

        -

        Options:

        -
        • true: Public network access control is enabled.

          -
        • false: Public network access control is disabled.

          +

        'Definition:

        +

        Whether the cluster supports the security mode.

        +

        Value range:

        +
        • true: supported.

          +
        • false: not supported.

        whiteList

        -

        String

        -

        Parameter description:

        -

        Whitelist for public network access.

        -
        -
        Table 9 ClusterDetailTags

        Parameter

        +
        - - - - - - - - - - - -
        Table 4 ClusterDetailInstances

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        key

        +

        status

        String

        +

        String

        Parameter description:

        -

        Tag key.

        -

        value

        -

        String

        -

        Parameter description:

        -

        Tag value.

        -
        -
        - -
        - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Table 10 ClusterDetailFailedReasons

        Parameter

        -

        Type

        -

        Description

        -

        errorCode

        -

        String

        -

        Parameter description:

        -

        Error code.

        -

        Options:

        -
        • CSS.6000: A cluster fails to be created.

          -
        • CSS.6001: A cluster fails to be scaled out.

          -
        • CSS.6002: A cluster fails to be restarted.

          -
        • CSS.6004: A node fails to be created in a cluster.

          -
        • CSS.6005: A service fails to be initialized.

          +

        Parameter description:

        +

        Node status.

        +

        Options:

        +
        • 100: creating

          +
        • 200: Available

          +
        • 303: unavailable, for example, due to a creation failure.

        errorMsg

        +

        resourceId

        String

        +

        String

        Parameter description:

        -

        Error details.

        +

        Definition:

        +

        Instance resource ID.

        +

        Value range:

        +

        N/A

        +

        type

        +

        String

        +

        Definition:

        +

        Node type.

        +

        Value range:

        +
        • ess: data node

          +
        • ess-cold: cold data node

          +
        • ess-client: client node

          +
        • ess-master: master node

          +
        • lgs: Logstash node

          +
        +

        id

        +

        String

        +

        Definition:

        +

        Instance ID.

        +

        Value range:

        +

        N/A

        +

        name

        +

        String

        +

        Definition:

        +

        Instance name.

        +

        Value range:

        +

        N/A

        +

        specCode

        +

        String

        +

        Definition:

        +

        Node flavor name.

        +

        Value range:

        +

        N/A

        +

        azCode

        +

        String

        +

        Definition:

        +

        AZ of the node.

        +

        Value range:

        +

        N/A

        +

        ip

        +

        String

        +

        Definition:

        +

        Instance IP address.

        +

        Value range:

        +

        N/A

        +

        volume

        +

        ShowClusterVolumeRsp object

        +

        Definition:

        +

        Instance disk information.

        +

        Value range:

        +

        N/A

        +

        subnetId

        +

        String

        +

        Definition:

        +

        Subnet ID of the current node.

        +

        Value range:

        +

        N/A

        +
        +
        + +
        + + + + + + + + + + + + + + + + + +
        Table 5 ShowClusterVolumeRsp

        Parameter

        +

        Type

        +

        Description

        +

        type

        +

        String

        +

        Definition:

        +

        Instance disk type.

        +

        Value range:

        +

        N/A

        +

        size

        +

        Integer

        +

        Definition:

        +

        Instance disk size.

        +

        Value range:

        +

        N/A

        +

        resourceIds

        +

        Array of strings

        +

        Definition:

        +

        Instance disk resource ID.

        +

        Value range:

        +

        N/A

        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + + + +
        Table 6 publicKibanaRespBody

        Parameter

        +

        Type

        +

        Description

        +

        eipSize

        +

        Integer

        +

        Definition:

        +

        The bandwidth size in Mbit/s.

        +

        Value range:

        +

        N/A

        +

        elbWhiteListResp

        +

        kibanaElbWhiteListResp object

        +

        Definition:

        +

        Kibana public network access control information.

        +

        Value range:

        +

        N/A

        +

        publicKibanaIp

        +

        String

        +

        Definition:

        +

        Specifies the IP address for accessing Kibana.

        +

        Value range:

        +

        N/A

        +

        bandwidthResourceId

        +

        String

        +

        Definition:

        +

        Resource ID corresponding to the Kibana public network.

        +

        Value range:

        +

        N/A

        +
        +
        + +
        + + + + + + + + + + + + + +
        Table 7 kibanaElbWhiteListResp

        Parameter

        +

        Type

        +

        Description

        +

        enableWhiteList

        +

        Boolean

        +

        Definition:

        +

        Whether to enable Kibana access control.

        +

        Value range:

        +
        • true: Access control is enabled.

          +
        • false: Access control is disabled.

          +
        +

        whiteList

        +

        String

        +

        Definition:

        +

        Whitelist for Kibana public network access.

        +

        Value range:

        +

        N/A

        +
        +
        + +
        + + + + + + + + + + + + + +
        Table 8 elbWhiteListResp

        Parameter

        +

        Type

        +

        Description

        +

        enableWhiteList

        +

        Boolean

        +

        Definition:

        +

        Whether to enable public network access control via ELB. If a whitelist is set, only IP addresses on the whitelist can access the cluster. If no whitelist is set, all IP addresses can access the cluster.

        +

        Value range:

        +
        • true: Public network access control is enabled.

          +
        • false: Public network access control is disabled.

          +
        +

        whiteList

        +

        String

        +

        Definition:

        +

        Whitelist for public network access.

        +

        Value range:

        +

        N/A

        +
        +
        + +
        + + + + + + + + + + + + + +
        Table 9 ClusterDetailTags

        Parameter

        +

        Type

        +

        Description

        +

        key

        +

        String

        +

        Definition:

        +

        Tag key.

        +

        Value range:

        +

        N/A

        +

        value

        +

        String

        +

        Definition:

        +

        Tag value.

        +

        Value range:

        +

        N/A

        +
        +
        + +
        + + + + + + + + + + +
        Table 10 ClusterDetailFailedReasons

        Parameter

        +

        Type

        +

        Description

        +

        errorCode

        +

        String

        +

        Parameter description:

        +

        Error code.

        +

        Options:

        +
        • CSS.6000: A cluster fails to be created.

          +
        • CSS.6001: A cluster fails to be scaled out.

          +
        • CSS.6002: A cluster fails to be restarted.

          +
        • CSS.6004: A node fails to be created in a cluster.

          +
        • CSS.6005: A service fails to be initialized.

          +
        +

        errorMsg

        +

        String

        +

        Definition:

        +

        Error details.

        +

        Value range:

        +

        N/A

        -

        Example Requests

        Whether the details of a cluster are obtained

        -
        GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/5c2bab0d-ec5f-491f-9418-b8da38a26760
        +

        Example Requests

        Whether the details of a cluster are obtained

        +
        GET https://{Endpoint}/v1.0/{project_id}/clusters/5c2bab0d-ec5f-491f-9418-b8da38a26760
        -

        Example Responses

        Status code: 200

        -

        Request succeeded.

        -
        {
        -  "datastore" : {
        -    "type" : "elasticsearch",
        -    "version" : "7.10.2",
        -    "subVersion" : "7.10.2_24.3.0_0827",
        -    "isEosCluster" : false,
        -    "supportSecuritymode" : false
        +

        Example Responses

        Status code: 200

        +

        Request succeeded.

        +
        {
        +  "datastore": {
        +    "type": "elasticsearch",
        +    "version": "7.10.2",
        +    "subVersion": "7.10.2_24.3.0_0827",
        +    "isEosCluster": false,
        +    "supportSecuritymode": false
           },
        -  "instances" : [ {
        -    "status" : "200",
        -    "type" : "ess",
        -    "id" : "{INSTANCE_ID}",
        -    "name" : "css-8bc5-ess-esn-1-1",
        -    "specCode" : "ess.spec-4u8g",
        -    "azCode" : "{AZ_CODE}",
        -    "volume" : {
        -      "type" : "ULTRAHIGH",
        -      "size" : 40,
        -      "resourceIds" : [ "{RESOURCE_ID}" ]
        -    },
        -    "privateIp" : "192.168.0.122",
        -    "resourceId" : "{RESOURCE_ID}"
        -  } ],
        -  "publicKibanaResp" : {
        -    "eipSize" : 10,
        -    "publicKibanaIp" : "100.95.152.28",
        -    "elbWhiteListResp" : null,
        -    "bandwidthResourceId" : "18bec13f-5cc1-4631-867f-33505d15be12"
        +  "instances": [
        +    {
        +      "status": "200",
        +      "type": "ess",
        +      "id": "{INSTANCE_ID}",
        +      "name": "css-8bc5-ess-esn-1-1",
        +      "specCode": "ess.spec-4u8g",
        +      "azCode": "{AZ_CODE}",
        +      "volume": {
        +        "type": "ULTRAHIGH",
        +        "size": 40,
        +        "resourceIds": [
        +          "{RESOURCE_ID}"
        +        ]
        +      },
        +      "ip": "192.168.0.122",
        +      "resourceId": "{RESOURCE_ID}",
        +	 "subnetId": "{SUBNET_ID}" //Subnet ID used by the node
        +    }
        +  ],
        +  "publicKibanaResp": {
        +    "eipSize": 10,
        +    "publicKibanaIp": "100.95.152.28",
        +    "elbWhiteListResp": null,
        +    "bandwidthResourceId": "18bec13f-5cc1-4631-867f-33505d15be12"
           },
        -  "elbWhiteList" : {
        -    "whiteList" : "",
        -    "enableWhiteList" : false
        +  "elbWhiteList": {
        +    "whiteList": "",
        +    "enableWhiteList": false
           },
        -  "updated" : "2023-10-09T02:07:13",
        -  "name" : "css-8bc5",
        -  "publicIp" : "100.85.222.202",
        -  "created" : "2023-10-09T02:07:13",
        -  "id" : "{CLUSTER_ID}",
        -  "status" : "200",
        -  "endpoint" : "192.168.0.122:9200",
        -  "vpcId" : "{VPC_ID}",
        -  "subnetId" : "{SUBNET_ID}",
        -  "securityGroupId" : "{SECURITY_GROUP_ID}",
        -  "bandwidthResourceId" : "{BANDWIDTH_RESOURCE_ID}",
        -  "bandwidthSize" : 3,
        -  "httpsEnable" : true,
        -  "authorityEnable" : true,
        -  "diskEncrypted" : false,
        -  "backupAvailable" : false,
        -  "actionProgress" : { },
        -  "actions" : [ ],
        -  "enterpriseProjectId" : "0",
        -  "tags" : [ ],
        -  "period" : true,
        -  "supportVpcep" : true
        +  "updated": "2023-10-09T02:07:13",
        +  "name": "css-8bc5",
        +  "publicIp": "100.85.222.202",
        +  "created": "2023-10-09T02:07:13",
        +  "id": "{CLUSTER_ID}",
        +  "status": "200",
        +  "endpoint": "192.168.0.122:9200",
        +"vpcId": "{VPC_ID}", //VPC ID used by the cluster
        +"subnetId": "{SUBNET_ID}", //Subnet ID used by all nodes in the cluster. Typically, a cluster uses only one subnet.
        +  "securityGroupId": "{SECURITY_GROUP_ID}",
        +  "bandwidthResourceId": "{BANDWIDTH_RESOURCE_ID}",
        +  "bandwidthSize": 3,
        +  "httpsEnable": true,
        +  "authorityEnable": true,
        +  "diskEncrypted": false,
        +  "backupAvailable": false,
        +  "actionProgress": {},
        +  "actions": [],
        +  "enterpriseProjectId": "0",
        +  "tags": [],
        +  "period": true,
        +  "supportVpcep": true,
        +"currentSubnetIds":"{SUBNET_ID}" //Default subnet ID of the cluster, which is used to assign new IP addresses to newly added nodes during a cluster scale-out operation when a VPC endpoint is created.
         }
        -

        Status Codes

        -

        Status Code

        +

        Status Codes

        +
        - - - - - - -

        Status Code

        Description

        +

        Description

        200

        +

        200

        Request succeeded.

        +

        Request succeeded.

        400

        +

        400

        Invalid request.

        -

        Modify the request before retry.

        +

        Invalid request.

        +

        Modify the request before retry.

        404

        +

        404

        The requested resource could not be found.

        -

        Modify the request before retry.

        +

        The requested resource could not be found.

        +

        Modify the request before retry.

        -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/css/api-ref/ShowClusterTag.html b/docs/css/api-ref/ShowClusterTag.html index 73685e246..99b0584b5 100644 --- a/docs/css/api-ref/ShowClusterTag.html +++ b/docs/css/api-ref/ShowClusterTag.html @@ -1,64 +1,66 @@

        Querying Tags of a Specified Cluster

        -

        Function

        This API is used to query the tags of a specified cluster.

        +

        Function

        Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources. You can add tags to a cluster when creating a cluster or add them on the details page of a created cluster. This API is used to query the tags of a specified cluster. It facilitates tag management.

        -

        URI

        GET /v1.0/{project_id}/{resource_type}/{cluster_id}/tags

        +

        Calling Method

        For details, see Calling APIs.

        +
        +

        URI

        GET /v1.0/{project_id}/{resource_type}/{cluster_id}/tags

        -
        Table 1 Path Parameters

        Parameter

        +
        - - - - - - - - - - - - - - - @@ -71,48 +73,54 @@

        Response Parameters

        Status code: 200

        -
        Table 1 Path Parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        project_id

        +

        project_id

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        -

        The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Definition:

        +

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        Constraints:

        N/A

        -

        Options:

        -

        For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Value range:

        +

        Project ID of the account.

        Default value:

        N/A

        cluster_id

        +

        cluster_id

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        -

        ID of the cluster you want to query.

        +

        Definition:

        +

        ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        Constraints:

        N/A

        -

        Options:

        -

        For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        +

        Value range:

        +

        Cluster ID.

        Default value:

        N/A

        resource_type

        +

        resource_type

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        +

        Definition:

        Resource type. Currently, its value can only be css-cluster.

        Constraints:

        N/A

        -

        Options:

        -

        css-cluster

        +

        Value range:

        +

        css-cluster: Indicates the cluster type.

        Default value:

        N/A

        Table 2 Response body parameters

        Parameter

        +
        - - - - -
        Table 2 Response body parameters

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        tags

        +

        tags

        Array of ShowTagsTagsResp objects

        +

        Array of ShowTagsTagsResp objects

        Parameter description:

        -

        List of cluster tags

        +

        Definition:

        +

        List of cluster tags.

        +

        Value range:

        +

        N/A

        -
        Table 3 ShowTagsTagsResp

        Parameter

        +
        - - - - - - - - @@ -120,7 +128,7 @@

        Example Requests

        Query the tags of a cluster.

        -
        GET https://{Endpoint}/v1.0/{project_id}/{resource_type}/{resource_id}/tags
        +
        GET https://{Endpoint}/v1.0/{project_id}/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags

        Example Responses

        Status code: 200

        Request succeeded.

        @@ -135,26 +143,26 @@ }

        Status Codes

        -
        Table 3 ShowTagsTagsResp

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        key

        +

        key

        String

        +

        String

        Parameter description:

        +

        Definition:

        Tag key.

        +

        Value range:

        +

        N/A

        value

        +

        value

        String

        +

        String

        Parameter description:

        +

        Definition:

        Tag value.

        +

        Value range:

        +

        N/A

        Status Code

        +
        - - - - - - - diff --git a/docs/css/api-ref/ShowElbDetail.html b/docs/css/api-ref/ShowElbDetail.html index 17118ff74..510901d6a 100644 --- a/docs/css/api-ref/ShowElbDetail.html +++ b/docs/css/api-ref/ShowElbDetail.html @@ -1,417 +1,571 @@

        Obtain information about the load balancers of a cluster.

        -

        Function

        This API is used to obtain information about the load balancers of a cluster.

        +

        Function

        CSS integrates shared load balancers and allows you to bind public network access and enable the VPC Endpoint service. Dedicated load balancers provide more functions and higher performance than shared load balancers.

        +

        This API is used to obtain the ELB load balancer information of a cluster, including the server certificate name, server certificate ID, ELB switch information, load balancers, listeners, and health check results.

        -

        URI

        GET /v1.0/{project_id}/clusters/{cluster_id}/es-listeners

        +

        Calling Method

        For details, see Calling APIs.

        +
        +

        URI

        GET /v1.0/{project_id}/clusters/{cluster_id}/es-listeners

        -

        Status Code

        Description

        +

        Description

        200

        +

        200

        Request succeeded.

        +

        Request succeeded.

        400

        +

        400

        Invalid request.

        +

        Invalid request.

        The client should modify the request instead of re-initiating it.

        404

        +

        404

        The requested resource could not be found.

        +

        The requested resource could not be found.

        The client should not repeat the request without modifications.

        Table 1 Path Parameters

        Parameter

        +
        - - - - - - - - - - -
        Table 1 Path Parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        project_id

        +

        project_id

        Yes

        +

        Yes

        String

        +

        String

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Definition:

        +

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +

        Project ID of the account.

        +

        Default value:

        +

        N/A

        cluster_id

        +

        cluster_id

        Yes

        +

        Yes

        String

        +

        String

        ID of the cluster you want to query.

        +

        Definition:

        +

        ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +

        Cluster ID.

        +

        Default value:

        +

        N/A

        -
        Table 2 Query Parameters

        Parameter

        +
        - - - - - - -
        Table 2 Query Parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        type

        +

        type

        No

        +

        No

        String

        +

        String

        Type: searchTool indicates that load balancer information is queried for Elasticsearch/OpenSearch. viewTool indicates that load balancer information is queried for Kibana/OpenSearch Dashboards. The default value is searchTool.

        +

        Definition:

        +

        Search type.

        +

        Constraints:

        +

        N/A

        +

        Value range:

        +
        • searchTool: Query details about the load balancers of an Elasticsearch/OpenSearch cluster.

          +
        +

        [- viewTool: Query details about the load balancers of Kibana/OpenSearch Dashboards.] (tag:white)

        +

        Default value:

        +

        searchTool

        -

        Request Parameters

        None

        +

        Request Parameters

        None

        -

        Response Parameters

        Status code: 200

        +

        Response Parameters

        Status code: 200

        -
        Table 3 Response body parameters

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 3 Response body parameters

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        serverCertName

        +

        serverCertName

        String

        +

        String

        Server certificate name

        +

        Definition:

        +

        Server certificate name.

        +

        Value range:

        +

        N/A

        serverCertId

        +

        serverCertId

        String

        +

        String

        Server certificate ID

        +

        Definition:

        +

        Server certificate ID.

        +

        Value range:

        +

        N/A

        cacertName

        +

        cacertName

        String

        +

        String

        CA certificate name

        +

        Definition:

        +

        The name of the CA certificate.

        +

        Value range:

        +

        N/A

        cacertId

        +

        cacertId

        String

        +

        String

        CA certificate ID

        +

        Definition:

        +

        ID of the CA certificate.

        +

        Value range:

        +

        N/A

        elb_enable

        +

        elb_enable

        Boolean

        +

        Boolean

        Indicates whether ELB is enabled.

        +

        Definition:

        +

        Whether ELB is enabled.

        +

        Value range:

        +
        • true: ELB is enabled.

          +
        • false: ELB is disabled.

          +

        authentication_type

        +

        authentication_type

        String

        +

        String

        Authentication mode

        +

        Definition:

        +

        Authentication mode.

        +

        Value range:

        +
        • single: one-way authentication.

          +
        • double: two-way authentication.

          +

        loadBalancer

        +

        loadBalancer

        LoadBalancer object

        +

        LoadBalancer object

        Load balancer object information

        +

        Definition:

        +

        Load balancer information.

        +

        Value range:

        +

        N/A

        listener

        +

        listener

        Elbv3Listener object

        +

        Elbv3Listener object

        Listener object information.

        +

        Definition:

        +

        Listener object information.

        +

        Value range:

        +

        N/A

        healthmonitors

        +

        healthmonitors

        Array of Member objects

        +

        Array of Member objects

        Health check result set

        +

        Definition:

        +

        Health check result set.

        +

        Value range:

        +

        N/A

        -
        Table 4 LoadBalancer

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        Table 4 LoadBalancer

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        id

        +

        id

        String

        +

        String

        Load balancer ID.

        +

        Definition:

        +

        Load balancer ID.

        +

        Value range:

        +

        N/A

        name

        +

        name

        String

        +

        String

        Load balancer name

        +

        Definition:

        +

        Load balancer name.

        +

        Value range:

        +

        N/A

        guaranteed

        +

        guaranteed

        String

        +

        String

        Whether the LB is for dedicated use. The value can be false (shared) or true (dedicated).

        +

        Definition:

        +

        Whether a dedicated load balancer is used.

        +

        Value range:

        +
        • false: The load balancer is a shared load balancer.

          +
        • true: The load balancer is a dedicated load balancer.

          +

        billing_info

        +

        billing_info

        String

        +

        String

        Resource billing information. If the value is left blank, the resource will be billed in pay-per-use mode. If the value is not left blank, the resource is billed on a yearly/monthly basis.

        +

        Definition:

        +

        Specifies the resource billing information.

        +

        Value range:

        +
        • If the value is left blank, the resource is billed on a pay-per-use basis.

          +

        description

        +

        description

        String

        +

        String

        Description.

        +

        Definition:

        +

        Description.

        +

        Value range:

        +

        N/A

        vpc_id

        +

        vpc_id

        String

        +

        String

        ID of the VPC to which the load balancer belongs

        +

        Definition:

        +

        ID of the VPC to which the ELB instance belongs.

        +

        Value range:

        +

        N/A

        provisioning_status

        +

        provisioning_status

        String

        +

        String

        Provisioning status of the load balancer

        +

        Definition:

        +

        Provisioning status of the load balancer

        +

        Value range:

        +
        • ACTIVE: in use

          +
        • PENDING_DELETE: deleting

          +

        listeners

        +

        listeners

        Array of IdListWrapper objects

        +

        Array of IdListWrapper objects

        Associated listener list

        +

        Definition:

        +

        Associated listener list.

        +

        Value range:

        +

        N/A

        vip_address

        +

        vip_address

        String

        +

        String

        IPv4 virtual IP address bound to the load balancer

        +

        Definition:

        +

        IPv4 virtual IP address bound to the load balancer.

        +

        Value range:

        +

        N/A

        vip_port_id

        +

        vip_port_id

        String

        +

        String

        Port ID bound to the private IPv4 IP address of the load balancer.

        +

        Definition:

        +

        Port ID bound to the private IPv4 IP address of the load balancer.

        +

        Value range:

        +

        N/A

        ipv6_vip_address

        +

        ipv6_vip_address

        String

        +

        String

        IPv6 address of the load balancer.

        +

        Definition:

        +

        IPv6 address of the load balancer.

        +

        Value range:

        +

        N/A

        publicips

        +

        publicips

        Array of PublicIpInfo objects

        +

        Array of PublicIpInfo objects

        EIP bound to the load balancer

        +

        Definition:

        +

        The EIP bound to the load balancer

        +

        Value range:

        +

        N/A

        -
        Table 5 IdListWrapper

        Parameter

        +
        - - - - -
        Table 5 IdListWrapper

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        id

        +

        id

        String

        +

        String

        Listener id.

        +

        Definition:

        +

        Listener ID.

        +

        Value range:

        +

        N/A

        -
        Table 6 PublicIpInfo

        Parameter

        +
        - - - - - - - - - - -
        Table 6 PublicIpInfo

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        publicip_id

        +

        publicip_id

        String

        +

        String

        EIP configuration ID

        +

        Definition:

        +

        EIP configuration ID.

        +

        Value range:

        +

        N/A

        publicip_address

        +

        publicip_address

        String

        +

        String

        Specifies the EIP.

        +

        Definition:

        +

        Specifies the EIP.

        +

        Value range:

        +

        N/A

        ip_version

        +

        ip_version

        Integer

        +

        Integer

        IP address version. Value range: 4 and 6. 4 indicates IPv4, and 6 indicates IPv6.

        +

        Definition:

        +

        IP address version.

        +

        Value range:

        +
        • 4: IPv4.

          +
        • 6: IPv6.

          +
        -
        Table 7 Elbv3Listener

        Parameter

        +
        - - - - - - - - - - - - - - - - -
        Table 7 Elbv3Listener

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        id

        +

        id

        String

        +

        String

        Listener ID.

        +

        Definition:

        +

        Listener ID.

        +

        Value range:

        +

        N/A

        name

        +

        name

        String

        +

        String

        Listener name.

        +

        Definition:

        +

        Listener name.

        +

        Value range:

        +

        N/A

        protocol

        +

        protocol

        String

        +

        String

        Protocol used by the listener

        +

        Definition:

        +

        Protocol used by the listener.

        +

        Value range:

        +

        N/A

        protocol_port

        +

        protocol_port

        Integer

        +

        Integer

        Port used by the listener.

        +

        Definition:

        +

        Port used by the listener.

        +

        Value range:

        +

        N/A

        ipgroup

        +

        ipgroup

        ListenerIpGroup object

        +

        ListenerIpGroup object

        ipgroup information in the listener object.

        +

        Definition:

        +

        ipgroup information in the listener object.

        +

        Value range:

        +

        N/A

        -
        Table 8 ListenerIpGroup

        Parameter

        +
        - - - - - - - -
        Table 8 ListenerIpGroup

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        ipgroup_id

        +

        ipgroup_id

        String

        +

        String

        ID of the IP address group associated with the listener This parameter is mandatory during creation and is optional during update.

        +

        Definition:

        +

        ID of the access control group associated with the listener. This parameter is mandatory during creation and is optional during update.

        +

        Value range:

        +

        N/A

        enable_ipgroup

        +

        enable_ipgroup

        Boolean

        +

        Boolean

        Status of an access control group. True: Enable access control. False: Disable access control.

        +

        Definition:

        +

        Status of an access control group.

        +

        Value range:

        +
        • True: Access control is enabled.

          +
        • False: Access control is disabled.

          +
        -
        Table 9 Member

        Parameter

        +
        - - - - - - - - - - - - - - - - -
        Table 9 Member

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        name

        +

        name

        String

        +

        String

        Specifies the backend server name.

        +

        Definition:

        +

        Specifies the backend server name.

        +

        Value range:

        +

        N/A

        address

        +

        address

        String

        +

        String

        Private IP address bound to the backend server.

        +

        Definition:

        +

        Specifies the IP address bound to the backend server.

        +

        Value range:

        +

        N/A

        protocol_port

        +

        protocol_port

        Integer

        +

        Integer

        Specifies the port used by the backend server.

        +

        Definition:

        +

        Specifies the port used by the backend server.

        +

        Value range:

        +

        N/A

        operating_status

        +

        operating_status

        String

        +

        String

        Specifies the operating status of the backend server. - ONLINE: The backend server is running normally. - NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs. - OFFLINE: The cloud server used as the backend server is stopped or does not exist.

        +

        Definition:

        +

        Specifies the operating status of the backend server.

        +

        Value range:

        +
        • ONLINE: The backend server is running normally.

          +
        • NO_MONITOR: No health check is configured for the backend server group to which the backend server belongs.

          +
        • OFFLINE: The cloud server used as the backend server is stopped or does not exist.

          +

        instance_id

        +

        instance_id

        String

        +

        String

        ID of the instance used as the backend server. If this parameter is left blank, the backend server is not an ECS.

        +

        Definition:

        +

        ID of the instance used as the backend server.

        +

        Value range:

        +

        An empty value indicates that the instance associated with the member is not a real device.

        -

        Example Requests

        None

        +

        Example Requests

        Obtain information about the load balancers of a cluster.

        +
        GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/es-listeners
        -

        Example Responses

        Status code: 200

        -

        Request succeeded.

        -
        {
        +

        Example Responses

        Status code: 200

        +

        Request succeeded.

        +
        {
           "loadBalancer" : {
             "id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
             "name" : "elb-css",
        @@ -427,7 +581,6 @@
               "publicip_address" : "100.1.1.1",
               "ip_version" : 4
             } ],
        -    "billing_info" : null,
             "vpc_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3",
             "provisioning_status" : "ACTIVE",
             "vip_address" : "10.0.0.1",
        @@ -437,7 +590,6 @@
             "id" : "41ff041d-c7b9-4142-9167-fa93d54f97da",
             "name" : "css-searchServer",
             "protocol" : "HTTPS",
        -    "ipgroup" : null,
             "protocol_port" : 9265
           },
           "healthmonitors" : [ {
        @@ -455,51 +607,49 @@
           } ],
           "serverCertName" : "server1",
           "serverCertId" : "82375af01c0d40f6a44c15962c570625",
        -  "cacertName" : null,
        -  "cacertId" : null,
           "elb_enable" : true,
           "authentication_type" : "single"
         }
        -

        Status Codes

        -

        Status Code

        +

        Status Codes

        +
        - - - - - - - - -

        Status Code

        Description

        +

        Description

        200

        +

        200

        Request succeeded.

        +

        Request succeeded.

        400

        +

        400

        Invalid request.

        -

        Modify the request instead of retrying.

        +

        Invalid request.

        +

        Modify the request instead of retrying.

        409

        +

        409

        The request cannot be processed due to a conflict.

        -

        This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

        +

        The request cannot be processed due to a conflict.

        +

        This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

        412

        +

        412

        The server does not meet one of the requirements that the requester puts on the request.

        +

        The server does not meet one of the requirements that the requester puts on the request.

        -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/css/api-ref/ShowGetLogSetting.html b/docs/css/api-ref/ShowGetLogSetting.html index 5859fcccb..77418be3c 100644 --- a/docs/css/api-ref/ShowGetLogSetting.html +++ b/docs/css/api-ref/ShowGetLogSetting.html @@ -1,48 +1,50 @@

        Querying Basic Log Configurations

        -

        Function

        This API is used to query basic cluster log configurations.

        +

        Function

        This API is used to query the basic configuration of cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the cluster, you can use this API to query the basic configurations of log backup and log collection.

        -

        URI

        GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

        +

        Calling Method

        For details, see Calling APIs.

        +
        +

        URI

        GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

        -
        Table 1 Path Parameters

        Parameter

        +
        - - - - - - - - - - - @@ -51,29 +53,29 @@
        Table 1 Path Parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        project_id

        +

        project_id

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        -

        The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Definition:

        +

        Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        Constraints:

        N/A

        -

        Options:

        -

        For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

        +

        Value range:

        +

        Project ID of the account.

        Default value:

        N/A

        cluster_id

        +

        cluster_id

        Yes

        +

        Yes

        String

        +

        String

        Parameter description:

        -

        ID of the cluster you want to query.

        +

        Definition:

        +

        ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        Constraints:

        N/A

        -

        Options:

        -

        For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

        +

        Value range:

        +

        Cluster ID.

        Default value:

        N/A

        -
        Table 2 Query Parameters

        Parameter

        +
        - - - - - - -
        Table 2 Query Parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        action

        +

        action

        No

        +

        No

        String

        +

        String

        Parameter description:

        -

        action can be base_log_collect or real_time_log_collect. base_log_collect indicates non-real-time log ingestion, and real_time_log_collect indicates real-time log ingestion.

        +

        Parameter description:

        +

        Queries the log backup or log collection settings of a cluster.

        Constraints:

        N/A

        Options:

        -
        • base_log_collect: non-real-time log ingestion.

          -
        • real_time_log_collect: real-time log ingestion.

          +
          • base_log_collect: Queries cluster log backup settings.

            +
          • real_time_log_collect: Queries cluster log collection settings.

          Default value:

          base_log_collect

          @@ -87,119 +89,137 @@

          Response Parameters

          Status code: 200

          -
          Table 3 Response body parameters

          Parameter

          +
          - - - - - - - -
          Table 3 Response body parameters

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          logConfiguration

          +

          logConfiguration

          logConfiguration object

          +

          logConfiguration object

          Parameter description:

          -

          Log configuration entity object.

          +

          Parameter description:

          +

          Log backup configuration.

          +

          Options:

          +

          N/A

          realTimeLogCollectRecord

          +

          realTimeLogCollectRecord

          realTimeLogCollect object

          +

          realTimeLogCollect object

          Parameter description:

          -

          Configure real-time log collection.

          +

          Parameter description:

          +

          Real-time log ingestion configuration.

          +

          Options:

          +

          N/A

          -
          Table 4 logConfiguration

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - @@ -207,102 +227,115 @@
          Table 4 logConfiguration

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Parameter description:

          +

          Parameter description:

          Log backup ID, which is generated using the system UUID.

          -

          clusterId

          -

          String

          -

          Parameter description:

          -

          Cluster ID.

          -

          obsBucket

          -

          String

          -

          Parameter description:

          -

          Name of the OBS bucket for storing logs.

          -

          agency

          -

          String

          -

          Parameter description:

          -

          Agency name. You can create an agency to allow CSS to call other cloud services.

          -

          updateAt

          -

          Long

          -

          Parameter description:

          -

          Update time. Format: Unix timestamp.

          -

          basePath

          -

          String

          -

          Parameter description:

          -

          Storage path of backed up logs in the OBS bucket.

          -

          autoEnable

          -

          Boolean

          -

          Parameter description:

          -

          Whether to enable automatic backup.

          Options:

          -
          • true: Automatic backup is enabled.

            -
          • false: Automatic backup is disabled.

            +

            N/A

            +

          clusterId

          +

          String

          +

          Parameter description:

          +

          Cluster ID.

          +

          Options:

          +

          N/A

          +

          obsBucket

          +

          String

          +

          Parameter description:

          +

          Name of the OBS bucket for storing logs.

          +

          Options:

          +

          N/A

          +

          agency

          +

          String

          +

          Definition:

          +

          Agency name. You can create an agency to allow CSS to call other cloud services. An agency name cannot contain special characters or Chinese characters.

          +

          Value range:

          +

          Only a-z, A-Z, 0-9, hyphens (-) and underscores (_) are allowed.

          +

          updateAt

          +

          Long

          +

          Definition:

          +

          Update time.

          +

          Value range:

          +

          The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

          +

          basePath

          +

          String

          +

          Parameter description:

          +

          Storage path of backed up logs in the OBS bucket.

          +

          Options:

          +

          N/A

          +

          autoEnable

          +

          Boolean

          +

          Definition:

          +

          Whether to enable automatic backup.

          +

          Value range:

          +
          • true: Enable automatic backup.

            +
          • false: Disable automatic backup.

          period

          +

          period

          String

          +

          String

          Parameter description:

          -

          Start time of automatic log backup. When autoEnable is set to false, the value of this parameter is null. Format: GMT

          +

          Definition:

          +

          Start time of automatic log backup.

          +

          Value range:

          +

          Format: Greenwich Mean Time (GMT). When autoEnable is set to false, the value of this parameter is null.

          logSwitch

          +

          logSwitch

          Boolean

          +

          Boolean

          Parameter description:

          -

          Whether to enable the log function.

          -

          Options:

          -
          • true: The log function is enabled.

            -
          • false: The log function is disabled.

            +

          Definition:

          +

          Whether to enable logging.

          +

          Value range:

          +
          • true: Enable logging.

            +
          • false: Disable logging.

          -
          Table 5 realTimeLogCollect

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 5 realTimeLogCollect

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Parameter description:

          +

          Parameter description:

          Log collection ID, which is generated using the system UUID.

          +

          Options:

          +

          N/A

          clusterId

          +

          clusterId

          String

          +

          String

          Parameter description:

          -

          Cluster ID.

          +

          Definition:

          +

          Cluster ID

          +

          Value range:

          +

          N/A

          indexPrefix

          +

          indexPrefix

          String

          +

          String

          Parameter description:

          +

          Parameter description:

          Prefix of the index for saving logs.

          +

          Options:

          +

          N/A

          keepDays

          +

          keepDays

          Integer

          +

          Integer

          Parameter description:

          +

          Parameter description:

          Log retention duration.

          +

          Options:

          +

          N/A

          targetClusterId

          +

          targetClusterId

          String

          +

          String

          Parameter description:

          +

          Parameter description:

          ID of the target cluster where logs are saved.

          +

          Options:

          +

          N/A

          status

          +

          status

          String

          +

          String

          Parameter description:

          -

          Status of a real-time log collection task.

          +

          Definition:

          +

          Status of a real-time log ingestion task.

          +

          Value range:

          +
          • 100: A real-time log ingestion task is being created.

            +
          • 150: Real-time log ingestion is available.

            +
          • 200: The real-time log ingestion task is activated.

            +
          • 300: Real-time log ingestion failed.

            +
          • 302: The real-time log ingestion task failed to be deleted.

            +
          • 303: The real-time log ingestion task failed to be created.

            +
          • 304: The real-time log ingestion task is being disabled.

            +
          • 400: The real-time log ingestion task is disabled.

            +

          createAt

          +

          createAt

          Long

          +

          Long

          Parameter description:

          +

          Parameter description:

          Start time of a real-time log collection task.

          +

          Options:

          +

          N/A

          updateAt

          +

          updateAt

          Long

          +

          Long

          Parameter description:

          +

          Parameter description:

          Update time of a real-time log collection task.

          +

          Options:

          +

          N/A

          -

          Example Requests

          Query basic cluster log configurations.

          -
          GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/logs/settings
          +

          Example Requests

          • Query the cluster's log backup settings.

            +
            GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/settings?action=base_log_collect
            +
          • Query the cluster's log ingestion settings.

            +
            GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/settings?action=real_time_log_collect
            +

          Example Responses

          Status code: 200

          Request succeeded.

          -
          • Example response to a real-time log collection request.

            -
            {
            -  "logConfiguration" : null,
            -  "realTimeLogCollectRecord" : {
            -    "id" : "17939b7b-5a93-4ca5-8d3c-b9f2d0e715b4",
            -    "clusterId" : "e3201ceb-1a3e-49f3-bb2f-23a816440b20",
            -    "keepDays" : 30,
            -    "updateAt" : 1717666418870,
            -    "createAt" : 1717666405897,
            -    "targetClusterId" : "8c19644b-f2ef-44fc-abef-230a4c578ce7",
            -    "indexPrefix" : "aaa",
            -    "status" : "200"
            -  }
            -}
            -
          • Example response to a log backup request.

            +
            • Example response to a request to query the cluster's log backup settings.

              {
                 "logConfiguration" : {
                   "id" : "00032118-aff5-40e8-b19a-dd4bb576e572",
              @@ -317,35 +350,49 @@
                 },
                 "realTimeLogCollectRecord" : null
               }
              +
            • Example response to a request to query the cluster's log ingestion settings.

              +
              {
              +  "logConfiguration" : null,
              +  "realTimeLogCollectRecord" : {
              +    "id" : "17939b7b-5a93-4ca5-8d3c-b9f2d0e715b4",
              +    "clusterId" : "e3201ceb-1a3e-49f3-bb2f-23a816440b20",
              +    "keepDays" : 30,
              +    "updateAt" : 1717666418870,
              +    "createAt" : 1717666405897,
              +    "targetClusterId" : "8c19644b-f2ef-44fc-abef-230a4c578ce7",
              +    "indexPrefix" : "aaa",
              +    "status" : "200"
              +  }
              +}

          Status Codes

          -

          Status Code

          +
          - - - - - - - - - diff --git a/docs/css/api-ref/ShowIkThesaurus.html b/docs/css/api-ref/ShowIkThesaurus.html deleted file mode 100644 index da98c4db6..000000000 --- a/docs/css/api-ref/ShowIkThesaurus.html +++ /dev/null @@ -1,241 +0,0 @@ - - -

          Querying the Status of a Custom Word Dictionary

          -

          Function

          This API is used to query the loading status of a custom word dictionary.

          -
          -

          URI

          GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

          - -

          Status Code

          Description

          +

          Description

          200

          +

          200

          Request succeeded.

          +

          Request succeeded.

          400

          +

          400

          Invalid request.

          +

          Invalid request.

          Modify the request before retry.

          409

          +

          409

          The request could not be completed due to a conflict with the current state of the resource.

          +

          The request could not be completed due to a conflict with the current state of the resource.

          The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

          412

          +

          412

          The server did not meet one of the preconditions contained in the request.

          +

          The server did not meet one of the preconditions contained in the request.

          - - - - - - - - - - - - - - - - -
          Table 1 Path Parameters

          Parameter

          -

          Mandatory

          -

          Type

          -

          Description

          -

          project_id

          -

          Yes

          -

          String

          -

          Parameter description:

          -

          The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          -

          Constraints:

          -

          N/A

          -

          Options:

          -

          For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          -

          Default value:

          -

          N/A

          -

          cluster_id

          -

          Yes

          -

          String

          -

          Parameter description:

          -

          ID of the cluster whose word dictionary status you want to query

          -

          Constraints:

          -

          N/A

          -

          Options:

          -

          For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          -

          Default value:

          -

          N/A

          -
          -
          - -

          Request Parameters

          None

          -
          -

          Response Parameters

          Status code: 200

          - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 2 Response body parameters

          Parameter

          -

          Type

          -

          Description

          -

          status

          -

          String

          -

          Parameter description:

          -

          Loading status.

          -

          Options:

          -
          • Init indicates initialization is in progress.

            -
          • Loaded indicates that the loading succeeded.

            -
          • Loading indicates that the loading is in progress.

            -
          • Failed indicates that the loading failed.

            -
          • NeedReboot indicates that a cluster restart is required.

            -
          • Undefined indicates an undefined state.

            -
          -

          bucket

          -

          String

          -

          Parameter description:

          -

          The OBS bucket that stores the word dictionary file that is last updated.

          -

          mainObj

          -

          String

          -

          Parameter description:

          -

          Main word dictionary file

          -

          stopObj

          -

          String

          -

          Parameter description:

          -

          Stop word dictionary file.

          -

          synonymObj

          -

          String

          -

          Parameter description:

          -

          Synonym dictionary file.

          -

          staticMainObj

          -

          String

          -

          Parameter description:

          -

          Static main word dictionary file

          -

          staticStopObj

          -

          String

          -

          Parameter description:

          -

          Static main word dictionary file

          -

          extraMainObj

          -

          String

          -

          Parameter description:

          -

          Extra main word dictionary file

          -

          extraStopObj

          -

          String

          -

          Parameter description:

          -

          Extra stop word dictionary

          -

          updateTime

          -

          String

          -

          Parameter description:

          -

          Latest update time of a dictionary.

          -

          updateDetails

          -

          String

          -

          Parameter description:

          -

          Update details.

          -

          clusterId

          -

          String

          -

          Parameter description:

          -

          ID of the cluster where a custom word dictionary you want to configure.

          -

          operateStatus

          -

          String

          -

          Parameter description:

          -

          Operation status.

          -

          id

          -

          String

          -

          Parameter description:

          -

          ID of the word dictionary.

          -
          -
          -
          -

          Example Requests

          Query the loading status of a custom word dictionary.

          -
          GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/thesaurus
          -
          -

          Example Responses

          Status code: 200

          -

          Request succeeded.

          -
          {
          -  "status" : "Loaded",
          -  "operateStatus" : "success",
          -  "id" : "e766bd5a-79b0-4d1a-8402-fdeb017a36d1",
          -  "bucket" : "test-bucket",
          -  "mainObj" : "word/main.txt",
          -  "stopObj" : "word/stop.txt",
          -  "synonymObj" : "word/synonym.txt",
          -  "staticMainObj" : "Unused",
          -  "staticStopObj" : "Unused",
          -  "extraMainObj" : "Unused",
          -  "extraStopObj" : "Unused",
          -  "updateTime" : 1521184757000,
          -  "updateDetails" : "allinstancesareloadedsuccessfully.",
          -  "clusterId" : "ea244205-d641-45d9-9dcb-ab2236bcd07e"
          -}
          -
          -

          Status Codes

          -
          - - - - - - - - - - -

          Status Code

          -

          Description

          -

          200

          -

          Request succeeded.

          -

          500

          -

          The server is able to receive but unable to understand the request.

          -
          -
          -
          -

          Error Codes

          See Error Codes.

          -
          - -
          - -
          - diff --git a/docs/css/api-ref/ShowLogBackup.html b/docs/css/api-ref/ShowLogBackup.html index b982e11c5..eec5fe7ac 100644 --- a/docs/css/api-ref/ShowLogBackup.html +++ b/docs/css/api-ref/ShowLogBackup.html @@ -1,36 +1,52 @@

          Searching for Logs

          -

          Function

          This API is used to query log information.

          +

          Function

          CSS supports log backup and query, helping you efficiently locate issues. You can periodically back up cluster logs to OBS buckets for long-term storage, from which you download log data for troubleshooting or auditing purposes. You can also query cluster logs through an API. You can search for specific run logs by specifying a time period, node names, and log levels. This helps you quickly locate faults or performance bottlenecks. This API is used to query cluster logs by specifying the node name, log level, and log type.

          -

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/logs/search

          +

          Calling Method

          For details, see Calling APIs.

          +
          +

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/logs/search

          -
          Table 1 Path Parameters

          Parameter

          +
          - - - - - - - - - - - @@ -38,41 +54,120 @@

          Request Parameters

          -
          Table 1 Path Parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          project_id

          +

          project_id

          Yes

          +

          Yes

          String

          +

          String

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Definition:

          +

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Project ID of the account.

          +

          Default value:

          +

          N/A

          cluster_id

          +

          cluster_id

          Yes

          +

          Yes

          String

          +

          String

          ID of the cluster you want to query.

          +

          Definition:

          +

          ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Cluster ID.

          +

          Default value:

          +

          N/A

          Table 2 Request body parameters

          Parameter

          +
          - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + @@ -81,65 +176,98 @@

          Response Parameters

          Status code: 200

          -
          Table 2 Request body parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          instanceName

          +

          instance_name

          Yes

          +

          Yes

          String

          +

          String

          Node name. Obtain the name attribute in instances by referring to Querying Cluster Details.

          +

          Definition:

          +

          Node name. Obtain the name attribute in instances by referring to Querying Cluster Details.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          N/A

          +

          Default value:

          +

          N/A

          level

          +

          level

          Yes

          +

          No

          String

          +

          String

          Log level. The levels of logs that can be queried are INFO, ERROR, DEBUG, and WARN.

          +

          Definition:

          +

          Queried log level.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +
          • DEBUG: Queries DEBUG logs.

            +
          • INFO: Queries INFO logs.

            +
          • WARN: Queries WARN logs.

            +
          • ERROR: Queries ERROR logs.

            +
          • ALL: Queries logs of all levels.

            +
          +
          NOTE:
          If multiple log levels are required, separate them with vertical bars (|), for example, WARN|ERROR.
          +

          Default value:

          +

          ALL

          logType

          +

          log_type

          Yes

          +

          Yes

          String

          +

          String

          Log type. The types of logs that can be queried are deprecation, indexingSlow, searchSlow, and instance.

          +

          Definition:

          +

          Queried log type.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +
          • deprecation: Queries deprecation logs. (Deprecation operation logs can be queried only when all log levels are selected.)

            +
          • indexingSlow: Queries slow indexing logs.

            +
          • searchSlow: Queries slow query logs.

            +
          • instance: Queries run logs.

            +
          +

          Default value:

          +

          N/A

          +

          limit

          +

          No

          +

          Integer

          +

          Definition:

          +

          Number of log records returned. By default, 100 log records are returned. A maximum of 10,000 log records can be returned, and the log size cannot exceed 1 MB.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          1-10000

          +

          Default value:

          +

          100

          +

          time_index

          +

          No

          +

          String

          +

          Definition:

          +

          Returns logs generated before a specified time.

          +

          Constraints:

          +

          The time format is yyyy-MM-ddTHH:mm:ss,SSS.

          +

          Value range:

          +

          N/A

          +

          Default value:

          +

          N/A

          +

          keyword

          +

          No

          +

          String

          +

          Definition:

          +

          Keyword used for filtering.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Only letters, digits, underscores (_), hyphens (-), periods (.), spaces, and square brackets are allowed. Maximum length: 64 characters.

          +

          Default value:

          +

          N/A

          Table 3 Response body parameters

          Parameter

          +
          - - - - - + + + +
          Table 3 Response body parameters

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          logList

          +

          logList

          Array of logList objects

          +

          Array of logList objects

          Log list.

          +

          Parameter description:

          +

          Log list.

          +

          Options:

          +

          N/A

          +

          type

          +

          String

          +

          Definition:

          +

          Queried log type.

          +

          Value range:

          +
          • deprecation: Queries deprecation logs.

            +
          • indexingSlow: Queries slow indexing logs.

            +
          • searchSlow: Queries slow query logs.

            +
          • instance: Queries run logs.

            +
          -
          Table 4 logList

          Parameter

          +
          - - - - - - - - - - -
          Table 4 logList

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          content

          +

          content

          String

          +

          String

          Log content.

          +

          Parameter description:

          +

          Log content.

          +

          Options:

          +

          N/A

          date

          +

          date

          String

          +

          String

          Date.

          +

          Definition:

          +

          Date

          +

          Value range:

          +

          N/A

          level

          +

          level

          String

          +

          String

          Log level.

          +

          Definition:

          +

          Queried log level.

          +

          Value range:

          +
          • DEBUG: Queries DEBUG logs.

            +
          • INFO: Queries INFO logs.

            +
          • WARN: Queries WARN logs.

            +
          • ERROR: Queries ERROR logs.

            +
          -

          Example Requests

          Query logs.

          -
          POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/search
          +

          Example Requests

          Query logs by node name, log level, and log type.

          +
          POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/search
           
           {
          -  "instanceName" : "css-4312-ess-esn-1-1",
          +  "instance_name" : "css-4312-ess-esn-1-1",
             "level" : "INFO",
          -  "logType" : "instance"
          +  "log_type" : "instance",
          +  "limit" : 10,
          +  "time_index" : "2025-08-25T01:07:19,082",
          +  "keyword" : "received"
           }

          Example Responses

          Status code: 200

          @@ -149,36 +277,37 @@ "content" : "xxxxxx", "date" : "2021-10-08T03:55:54,718", "level" : "INFO" - } ] + } ], + "type" : "instance" }

          Status Codes

          -

          Status Code

          +
          - - - - - - - - - diff --git a/docs/css/api-ref/ShowVpcepConnection.html b/docs/css/api-ref/ShowVpcepConnection.html index 747ab88a9..f8200289e 100644 --- a/docs/css/api-ref/ShowVpcepConnection.html +++ b/docs/css/api-ref/ShowVpcepConnection.html @@ -1,48 +1,50 @@

          Obtaining an Endpoint Connection

          -

          Function

          This API is used to obtain the VPCEP connection of a cluster.

          +

          Function

          The VPC endpoint service enables secure and reliable access across VPCs through a dedicated gateway, without exposing the network information of servers. The VPC endpoint address can be an IPv4 address (automatically allocated when the VPC endpoint service is enabled), an IPv6 address (allocated when a professional VPC endpoint is created and dual-stack networking is enabled), or an internal domain name (allocated when DNS is enabled). This API is used to obtain the VPCEP connection of a cluster.

          -

          URI

          GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections

          +

          Calling Method

          For details, see Calling APIs.

          +
          +

          URI

          GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections

          -

          Status Code

          Description

          +

          Description

          200

          +

          200

          Request succeeded.

          +

          Request succeeded.

          400

          +

          400

          Invalid request.

          +

          Invalid request.

          Modify the request before retry.

          409

          +

          409

          The request could not be completed due to a conflict with the current state of the resource.

          +

          The request could not be completed due to a conflict with the current state of the resource.

          The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

          412

          +

          412

          The server did not meet one of the preconditions contained in the request.

          +

          The server did not meet one of the preconditions contained in the request.

          Table 1 Path Parameters

          Parameter

          +
          - - - - - - - - - - - @@ -51,46 +53,46 @@
          Table 1 Path Parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          project_id

          +

          project_id

          Yes

          +

          Yes

          String

          +

          String

          Parameter description:

          -

          The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Definition:

          +

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          Constraints:

          N/A

          -

          Options:

          -

          For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Value range:

          +

          Project ID of the account.

          Default value:

          N/A

          cluster_id

          +

          cluster_id

          Yes

          +

          Yes

          String

          +

          String

          Parameter description:

          -

          ID of the cluster you want to query.

          +

          Definition:

          +

          ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          Constraints:

          N/A

          -

          Options:

          -

          For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          +

          Value range:

          +

          Cluster ID.

          Default value:

          N/A

          -
          Table 2 Query Parameters

          Parameter

          +
          - - - - - - - - - - - @@ -101,196 +103,230 @@

          Response Parameters

          Status code: 200

          -
          Table 2 Query Parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          start

          +

          offset

          No

          +

          No

          Integer

          +

          Integer

          Parameter description:

          -

          The start value of the query. The default value is 1, indicating that the query starts from the first task.

          +

          Definition:

          +

          Start value for querying VPC endpoint connections.

          Constraints:

          N/A

          -

          Options:

          -

          1-1000

          +

          Value range:

          +

          0-1000

          Default value:

          -

          1

          +

          0

          limit

          +

          limit

          No

          +

          No

          Integer

          +

          Integer

          Parameter description:

          -

          Number of tasks to be queried. The default value is 10, indicating that 10 tasks are queried at a time.

          +

          Definition:

          +

          The number of VPC endpoint connections to be queried.

          Constraints:

          N/A

          -

          Options:

          +

          Value range:

          1-1000

          Default value:

          -

          10

          +

          The default value is 10, indicating that 10 tasks are queried at a time.

          Table 3 Response body parameters

          Parameter

          +
          - - - - - - - - - - - - - - - - -
          Table 3 Response body parameters

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          connections

          +

          connections

          Array of connections objects

          +

          Array of connections objects

          Parameter description:

          -

          Connection information

          +

          Definition:

          +

          Cluster VPC endpoint connection information.

          +

          Value range:

          +

          N/A

          vpcServiceName

          +

          vpcServiceName

          String

          +

          String

          Parameter description:

          -

          Endpoint service name.

          +

          Definition:

          +

          Name of the VPC endpoint service.

          +

          Value range:

          +

          N/A

          permissions

          +

          permissions

          Array of permissions objects

          +

          Array of permissions objects

          Parameter description:

          -

          Permissions list for the VPCEP connection whitelist.

          +

          Definition:

          +

          Permissions of the cluster VPC endpoint whitelist.

          +

          Value range:

          +

          N/A

          vpcepUpdateSwitch

          +

          vpcepUpdateSwitch

          Boolean

          +

          Boolean

          Parameter description:

          -

          Whether to update endpoints.

          -

          Options:

          +

          Definition:

          +

          Whether to enable VPC endpoint.

          +

          Value range:

          • true: The VPC endpoint is enabled.

          • false: The VPC endpoint is disabled.

          total_count

          +

          total_count

          Integer

          +

          Integer

          Parameter description:

          -

          Number of endpoints.

          +

          Definition:

          +

          Number of cluster VPC endpoints.

          +

          Value range:

          +

          N/A

          -
          Table 4 connections

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 4 connections

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Parameter description:

          -

          VPC endpoint ID.

          +

          Definition:

          +

          Cluster VPC endpoint ID.

          +

          Value range:

          +

          N/A

          status

          +

          status

          String

          +

          String

          Parameter description:

          -

          Endpoint status.

          -

          Options:

          +

          Definition:

          +

          Cluster VPC endpoint status.

          +

          Value range:

          • accepted: The VPC endpoint connection is enabled.

          • rejected: The VPC endpoint connection is disabled.

          maxSession

          +

          maxSession

          String

          +

          String

          Parameter description:

          -

          Maximum number of connections.

          +

          Definition:

          +

          Maximum number of connections to a VPC endpoint.

          +

          Value range:

          +

          N/A

          specificationName

          +

          specificationName

          String

          +

          String

          Parameter description:

          -

          Endpoint name.

          +

          Definition:

          +

          Cluster VPC endpoint name.

          +

          Value range:

          +

          N/A

          created_at

          +

          created_at

          String

          +

          String

          Parameter description:

          -

          Creation time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

          +

          Definition:

          +

          Creation time.

          +

          Value range

          +

          The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

          update_at

          +

          update_at

          String

          +

          String

          Parameter description:

          +

          Definition:

          Update time. The default value is null.

          +

          Value range

          +

          The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

          domain_id

          +

          domain_id

          String

          +

          String

          Parameter description:

          +

          Definition:

          Account ID of the owner.

          +

          Value range:

          +

          N/A

          vpcepIp

          +

          vpcepIp

          String

          +

          String

          Parameter description:

          -

          IPv4 address of the VPC endpoint.

          +

          Definition:

          +

          IPv4 address of a cluster VPC endpoint.

          +

          Value range:

          +

          N/A

          vpcepIpv6Address

          +

          vpcepIpv6Address

          String

          +

          String

          Parameter description:

          -

          IPv6 address of the VPC endpoint.

          +

          Definition:

          +

          IPv6 address of a cluster VPC endpoint.

          +

          Value range:

          +

          N/A

          vpcepDnsName

          +

          vpcepDnsName

          String

          +

          String

          Parameter description:

          -

          Private domain name for accessing the VPC endpoint.

          +

          Definition:

          +

          Private domain name of a cluster VPC endpoint.

          +

          Value range:

          +

          N/A

          -
          Table 5 permissions

          Parameter

          +
          - - - - - - - - - - - - - - @@ -298,7 +334,7 @@

          Example Requests

          Obtain the VPCEP connection of a cluster.

          -
          GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections
          +
          GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/vpcepservice/connections

          Example Responses

          Status code: 200

          Request succeeded.

          @@ -309,10 +345,7 @@ "maxSession" : "3000", "specificationName" : "default", "vpcepIp" : "192.168.0.122", - "vpcepIpv6Address" : null, - "vpcepDnsName" : null, "created_at" : "2024-06-11T09:36:24Z", - "update_at" : null, "domain_id" : "db9b76a0d9ae431f8e85e89da2ca867c" }, { "id" : "e88ad0bc-c2c7-419c-bd9b-a961111f0a42", @@ -320,10 +353,7 @@ "maxSession" : "3000", "specificationName" : "default", "vpcepIp" : "192.168.0.133", - "vpcepIpv6Address" : null, - "vpcepDnsName" : null, "created_at" : "2023-10-12T07:33:16Z", - "update_at" : null, "domain_id" : "db9b76a0d9ae431f8e85e89da2ca867c" } ], "vpcepUpdateSwitch" : false, @@ -338,32 +368,32 @@ }

          Status Codes

          -
          Table 5 permissions

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Parameter description:

          -

          ID.

          +

          Definition:

          +

          Unique ID of the permission.

          +

          Value range:

          +

          N/A

          permission

          +

          permission

          String

          +

          String

          Parameter description:

          +

          Definition:

          Permission details for the VPCEP connection whitelist.

          +

          Value range:

          +

          N/A

          permission_type

          +

          permission_type

          String

          +

          String

          Parameter description:

          -

          Permission type

          +

          Definition:

          +

          VPC endpoint permission type.

          +

          Value range:

          +

          domainId: user account ID.

          created_at

          +

          created_at

          String

          +

          String

          Parameter description:

          -

          Creation time.

          +

          Definition:

          +

          Specifies when the VPC endpoint was created.

          +

          Value range:

          +

          The format is CCYY-MM-DDThh:mm:ss (ISO 8601).

          Status Code

          +
          - - - - - - - - - diff --git a/docs/css/api-ref/StartAutoCreateSnapshots.html b/docs/css/api-ref/StartAutoCreateSnapshots.html index a12637c9c..68e1531c5 100644 --- a/docs/css/api-ref/StartAutoCreateSnapshots.html +++ b/docs/css/api-ref/StartAutoCreateSnapshots.html @@ -1,36 +1,56 @@

          Enabling Automatic Snapshot Creation

          -

          Function

          This API is used to enable automatic snapshot creation.

          +

          Function

          CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's data. By restoring this snapshot, you can restore the cluster to a previous state. There are two ways to create snapshots to back up a CSS cluster: automatic and manual.

          +
          • Automatic snapshot creation: Snapshots are created periodically based on a preset time policy, for example, daily or weekly, to ensure continuous data protection. This reduces manual effort and improves backup reliability and efficiency.

            +
          • Manual snapshot creation: You create snapshots manually for special occasions, for example, prior to a high-risk operation (such as a cluster upgrade). This ensures you can restore data using snapshots in case anything should go wrong. Manual snapshots provide additional flexibility.

            +
          +

          This API is used to enable automatic snapshot creation.

          -

          URI

          POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/open

          +

          Calling Method

          For details, see Calling APIs.

          +
          +

          URI

          POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/open

          -

          Status Code

          Description

          +

          Description

          200

          +

          200

          Request succeeded.

          +

          Request succeeded.

          400

          +

          400

          Invalid request.

          +

          Invalid request.

          Modify the request before retry.

          409

          +

          409

          The request could not be completed due to a conflict with the current state of the resource.

          +

          The request could not be completed due to a conflict with the current state of the resource.

          The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

          412

          +

          412

          The server did not meet one of the preconditions contained in the request.

          +

          The server did not meet one of the preconditions contained in the request.

          Table 1 Path Parameters

          Parameter

          +
          - - - - - - - - - - - @@ -38,71 +58,108 @@

          Request Parameters

          -
          Table 1 Path Parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          project_id

          +

          project_id

          Yes

          +

          Yes

          String

          +

          String

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Definition:

          +

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Project ID of the account.

          +

          Default value:

          +

          N/A

          cluster_id

          +

          cluster_id

          Yes

          +

          Yes

          String

          +

          String

          ID of the cluster that the snapshot belongs to.

          +

          Definition:

          +

          ID of the cluster that the snapshot belongs to. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Cluster ID.

          +

          Default value:

          +

          N/A

          Table 2 Request body parameters

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - -
          Table 2 Request body parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          indices

          +

          indices

          No

          +

          No

          String

          +

          String

          Name of an index to be backed up/restored. Multiple indexes are separated by commas (,). By default, all indexes are restored. You can use the combination of a backslash and an asterisk (*) to back up data of certain indexes. For example, if you specify 2018-06*, then the data of the indexes with the prefix 2018-06 will be restored.The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?The default value is *, indicating that all indexes are backed up.

          +

          Definition:

          +

          Name of an index to be backed up. Multiple indexes are separated by commas (,). By default, all indexes are backed up. You can use the combination of a backslash and an asterisk (*) to back up data of certain indexes. For example, if you specify 2018-06*, then the data of the indexes with the prefix 2018-06 will be backed up.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?

          +

          Default value:

          +

          N/A

          keepday

          +

          keepday

          Yes

          +

          Yes

          Integer

          +

          Integer

          Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

          +

          Definition:

          +

          Set the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to auto snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          1–90

          +

          Default value:

          +

          N/A

          frequency

          +

          frequency

          No

          +

          No

          String

          +

          String

          Frequency of automatically creating snapshots.

          -
          NOTE:
          The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
          +

          Definition:

          +

          Frequency of automatically creating snapshots.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          N/A

          +

          Default value:

          +

          DAY

          +

          When the value is HOUR, the task is executed every hour. When the value is DAY, the scheduled task is executed every day. When the parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.

          period

          +

          period

          Yes

          +

          Yes

          String

          +

          String

          Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

          -
          NOTE:
          The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.
          +

          Definition:

          +

          Time when a snapshot is created every day.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

          +

          Default value:

          +

          00:00 GMT+08:00

          +
          NOTE:
          When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.

          prefix

          +

          prefix

          Yes

          +

          Yes

          String

          +

          String

          Prefix of a snapshot that is automatically created, which is manually entered. Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

          +

          Definition:

          +

          Prefix of a snapshot that is automatically created, which is manually entered.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

          +

          Default value:

          +

          N/A

          -

          Response Parameters

          None

          +

          Response Parameters

          Status code: 200

          +

          Request succeeded.

          +

          None

          Example Requests

          Enable the automatic backup function.

          -
          POST /v2.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/snapshots/policy/open
          +
          POST https://{Endpoint}/v2.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/snapshots/policy/open
           
           {
             "indices" : "*",
          @@ -115,26 +172,26 @@
           

          Example Responses

          None

          Status Codes

          -

          Status Code

          +
          - - - - - - - @@ -146,7 +203,7 @@
          diff --git a/docs/css/api-ref/StartAutoSetting.html b/docs/css/api-ref/StartAutoSetting.html index 821606e0d..d4211865b 100644 --- a/docs/css/api-ref/StartAutoSetting.html +++ b/docs/css/api-ref/StartAutoSetting.html @@ -6,36 +6,52 @@
        • Backup Path: Enter the storage path of the snapshot in the OBS bucket.

        • IAM Agency: Authorize you to use OBS in IAM so that snapshots must be stored in OBS.

        • -

          This API automatically creates an OBS bucket and an agency for the snapshot. If there are multiple clusters, an OBS bucket will be created for each cluster via this API. As a result, the OBS quota may be insufficient, and many OBS buckets are difficult to maintain. You are advised to perform the operations in Modifying Basic Configurations of a Cluster Snapshot.

          +
          The API will automatically create an OBS bucket and an agency for automatic snapshot creation. If there are multiple clusters, each cluster will create a different OBS bucket using this API, which may exhaust the OBS quota and create the inconvenience of maintaining a large number of OBS buckets. You are advised to use the API for Modifying Basic Settings of Cluster Snapshots.
          -

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/auto_setting

          +

          Calling Method

          For details, see Calling APIs.

          +
          +

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/auto_setting

          -

          Status Code

          Description

          +

          Description

          200

          +

          200

          Request succeeded.

          +

          Request succeeded.

          400

          +

          400

          Invalid request.

          +

          Invalid request.

          Modify the request before retry.

          403

          +

          403

          Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

          +

          Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

          Table 1 Path Parameters

          Parameter

          +
          - - - - - - - - - - - @@ -44,27 +60,30 @@

          Request Parameters

          None

          -

          Response Parameters

          None

          +

          Response Parameters

          Status code: 200

          +

          Request succeeded.

          +

          None

          -

          Example Requests

          None

          +

          Example Requests

          Automatically configure basic settings of a cluster snapshot.

          +
          POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/auto_setting

          Example Responses

          None

          Status Codes

          -
          Table 1 Path Parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          project_id

          +

          project_id

          Yes

          +

          Yes

          String

          +

          String

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Definition:

          +

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Project ID of the account.

          +

          Default value:

          +

          N/A

          cluster_id

          +

          cluster_id

          Yes

          +

          Yes

          String

          +

          String

          ID of the cluster where snapshots you want to back up.

          +

          Definition:

          +

          ID of the cluster where snapshots you want to back up. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Cluster ID.

          +

          Default value:

          +

          N/A

          Status Code

          +
          - - - - - diff --git a/docs/css/api-ref/StartKibanaPublic.html b/docs/css/api-ref/StartKibanaPublic.html index 5635af18f..72701bc42 100644 --- a/docs/css/api-ref/StartKibanaPublic.html +++ b/docs/css/api-ref/StartKibanaPublic.html @@ -3,74 +3,11 @@

          Enabling Kibana Public Access

          Function

          This API is used to enable public network access to Kibana.

          -

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/open

          +

          Calling Method

          For details, see Calling APIs.

          +
          +

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/open

          -

          Status Code

          Description

          +

          Description

          200

          +

          200

          Request succeeded.

          +

          Request succeeded.

          406

          +

          406

          The server could not fulfill the request according to the content characteristics of the request.

          +

          The server could not fulfill the request according to the content characteristics of the request.

          - - - - - - - - - - - - - - - - -
          Table 1 Path Parameters

          Parameter

          -

          Mandatory

          -

          Type

          -

          Description

          -

          project_id

          -

          Yes

          -

          String

          -

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          -

          cluster_id

          -

          Yes

          -

          String

          -

          ID of the cluster whose Kibana public access you want to enable.

          -
          -
          - -

          Request Parameters

          -
          - - - - - - - - - - - - - - - - -
          Table 2 Request body parameters

          Parameter

          -

          Mandatory

          -

          Type

          -

          Description

          -

          eipSize

          -

          Yes

          -

          Integer

          -

          Bandwidth. Unit: Mbit/s

          -

          elbWhiteList

          -

          Yes

          -

          StartKibanaPublicReqElbWhitelist object

          -

          ELB whitelist.

          -
          -
          - -
          Table 3 StartKibanaPublicReqElbWhitelist

          Parameter

          +
          @@ -80,73 +17,155 @@ - - - - - - - + + + + +
          Table 1 Path Parameters

          Parameter

          Mandatory

          enableWhiteList

          -

          Yes

          -

          Boolean

          -

          Whether to enable the whitelist function.

          -
          • true: The whitelist is enabled.

            -
          • false: The whitelist is disabled.

            -
          -

          whiteList

          +

          project_id

          Yes

          String

          Whitelist.

          +

          Definition:

          +

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Project ID of the account.

          +

          Default value:

          +

          N/A

          +

          cluster_id

          +

          Yes

          +

          String

          +

          Definition:

          +

          ID of the cluster whose Kibana public access you want to enable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Cluster ID.

          +

          Default value:

          +

          N/A

          -

          Response Parameters

          None

          +

          Request Parameters

          +
          + + + + + + + + + + + + + + + + +
          Table 2 Request body parameters

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          eip_size

          +

          Yes

          +

          Integer

          +

          Bandwidth. Unit: Mbit/s

          +

          elb_white_list

          +

          Yes

          +

          StartKibanaPublicReqElbWhitelist object

          +

          ELB whitelist.

          +
          -

          Example Requests

          POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/open
          +
          +
          + + + + + + + + + + + + + + + + +
          Table 3 StartKibanaPublicReqElbWhitelist

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          enable_white_list

          +

          Yes

          +

          Boolean

          +

          Whether to enable the whitelist function.

          +
          • true: The whitelist is enabled.

            +
          • false: The whitelist is disabled.

            +
          +

          white_list

          +

          Yes

          +

          String

          +

          Whitelist.

          +
          +
          +
          +

          Response Parameters

          Status code: 200

          +

          Request succeeded.

          +

          None

          +
          +

          Example Requests

          Enable Kibana public network access.

          +
          POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/open
           
           {
          -  "eipSize" : 5,
          -  "elbWhiteList" : {
          -    "enableWhiteList" : true,
          -    "whiteList" : "192.168.0.xx"
          +  "eip_size" : 5,
          +  "elb_white_list" : {
          +    "enable_white_list" : true,
          +    "white_list" : "192.168.0.xx"
             },
          -  "isAutoPay" : 1
          +  "is_auto_pay" : 1
           }

          Example Responses

          None

          Status Codes

          -

          Status Code

          +
          - - - - - - - - - diff --git a/docs/css/api-ref/StartLogAutoBackupPolicy.html b/docs/css/api-ref/StartLogAutoBackupPolicy.html index 6f30458da..16f877671 100644 --- a/docs/css/api-ref/StartLogAutoBackupPolicy.html +++ b/docs/css/api-ref/StartLogAutoBackupPolicy.html @@ -1,36 +1,56 @@

          Enabling the Automatic Log Backup Policy

          -

          Function

          This API is used to enable the automatic log backup policy.

          +

          Function

          CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.

          +
          • Log query: On the log management page of the CSS management console, you can query the latest 10,000 log records by node type and other criteria. A maximum of 100 results are displayed, enabling you to quickly locate issues.

            +
          • Log backup: Cluster logs are periodically synchronized to OBS buckets. You can download them for in-depth analysis at any time. You can configure custom log backup policies by specifying backup schedules and storage locations. The system backs up all critical logs, including run logs and deprecation logs. They provide comprehensive data for auditing and troubleshooting purposes.

            +
          +

          This API is used to enable an automatic log backup policy. If log backup is enabled for a cluster, you can use this API to configure an automatic backup policy to periodically back up cluster logs to a specified OBS bucket and directory.

          -

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/update

          +

          Calling Method

          For details, see Calling APIs.

          +
          +

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/update

          -

          Status Code

          Description

          +

          Description

          200

          +

          200

          Request succeeded.

          +

          Request succeeded.

          400

          +

          400

          Invalid request.

          +

          Invalid request.

          Modify the request before retry.

          409

          +

          409

          The request could not be completed due to a conflict with the current state of the resource.

          +

          The request could not be completed due to a conflict with the current state of the resource.

          The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

          412

          +

          412

          The server did not meet one of the preconditions contained in the request.

          +

          The server did not meet one of the preconditions contained in the request.

          Table 1 Path Parameters

          Parameter

          +
          - - - - - - - - - - - @@ -38,33 +58,42 @@

          Request Parameters

          -
          Table 1 Path Parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          project_id

          +

          project_id

          Yes

          +

          Yes

          String

          +

          String

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Definition:

          +

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Project ID of the account.

          +

          Default value:

          +

          N/A

          cluster_id

          +

          cluster_id

          Yes

          +

          Yes

          String

          +

          String

          ID of the cluster whose log backup policy you want to enable.

          +

          Definition:

          +

          ID of the cluster for which automatic log backup is to be enabled. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Cluster ID.

          +

          Default value:

          +

          N/A

          Table 2 Request body parameters

          Parameter

          +
          - - - - - - -
          Table 2 Request body parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          period

          +

          period

          Yes

          +

          Yes

          String

          +

          String

          Backup start time. Format: GMT

          +

          Definition:

          +

          Log backup start time. Format: Greenwich Mean Time (GMT).

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          N/A

          +

          Default value:

          +

          N/A

          -

          Response Parameters

          None

          +

          Response Parameters

          Status code: 200

          +

          Request succeeded.

          +

          None

          Example Requests

          Enable the automatic log backup policy.

          -
          POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/policy/update
          +
          POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/policy/update
           
           {
             "period" : "00:00 GMT+08:00"
          @@ -73,32 +102,32 @@
           

          Example Responses

          None

          Status Codes

          -

          Status Code

          +
          - - - - - - - - - diff --git a/docs/css/api-ref/StartLogs.html b/docs/css/api-ref/StartLogs.html index 8fb283577..b525561ea 100644 --- a/docs/css/api-ref/StartLogs.html +++ b/docs/css/api-ref/StartLogs.html @@ -1,152 +1,258 @@ -

          Enabling the Log Function

          -

          Function

          This API is used to enable the log function.

          +

          Enabling Log Backup or Log Collection

          +

          Function

          This API is used to enable log backup or log ingestion for a cluster. Log backup and log ingestion can be enabled separately. After log backup is enabled, you can configure an automatic backup policy or manually trigger backup to back up the cluster's run logs to a specified OBS bucket and directory. After log collection is enabled, the cluster's run logs will be collected in real time and saved to a specified index of a specified cluster.

          -

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/logs/open

          +

          Calling Method

          For details, see Calling APIs.

          +
          +

          URI

          POST /v1.0/{project_id}/clusters/{cluster_id}/logs/open

          -

          Status Code

          Description

          +

          Description

          200

          +

          200

          Request succeeded.

          +

          Request succeeded.

          400

          +

          400

          Invalid request.

          +

          Invalid request.

          Modify the request before retry.

          409

          +

          409

          The request could not be completed due to a conflict with the current state of the resource.

          +

          The request could not be completed due to a conflict with the current state of the resource.

          The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

          412

          +

          412

          The server did not meet one of the preconditions contained in the request.

          +

          The server did not meet one of the preconditions contained in the request.

          Table 1 Path Parameters

          Parameter

          +
          - - - - - - - - - - -
          Table 1 Path Parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          project_id

          +

          project_id

          Yes

          +

          Yes

          String

          +

          String

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Definition:

          +

          Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Project ID of the account.

          +

          Default value:

          +

          N/A

          cluster_id

          +

          cluster_id

          Yes

          +

          Yes

          String

          +

          String

          ID of the cluster whose log function you want to enable.

          +

          Definition:

          +

          ID of the cluster for which log backup or ingestion is to be enabled. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +

          Cluster ID.

          +

          Default value:

          +

          N/A

          -
          Table 2 Query Parameters

          Parameter

          +
          - - - - - - -
          Table 2 Query Parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          action

          +

          action

          No

          +

          No

          String

          +

          String

          The action can be base_log_collect or real_time_log_collect. base indicates the historical capability, and real_time indicates the real-time collection capability. If this parameter is not passed, base is used by default, which is compatible with the previous logic.

          +

          Parameter description:

          +

          Configure log backup or log collection for a cluster.

          +

          Constraints:

          +

          N/A

          +

          Options:

          +
          • base_log_collect: Backs up logs to OBS.

            +
          • real_time_log_collect: Saves logs to an Elasticsearch cluster in real time.

            +
          +

          Default value:

          +

          base_log_collect

          -

          Request Parameters

          -
          Table 3 Request body parameters

          Parameter

          +

          Request Parameters

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + +
          Table 3 Request body parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          agency

          +

          agency

          No

          +

          No

          String

          +

          String

          Agency name. You can create an agency to allow CSS to call other cloud services. The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters. This parameter is mandatory when action is not set to real_time_log_collect.

          +

          Parameter description:

          +

          Agency name. Through this agency, you delete OBS permissions to CSS, so that CSS will be able to back up log files to your OBS buckets.

          +

          Constraints:

          +

          This parameter is mandatory when action is not set to real_time_log_collect.

          +

          Options:

          +

          The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.

          +

          Default value:

          +

          N/A

          logBasePath

          +

          log_base_path

          No

          +

          No

          String

          +

          String

          Storage path of backed up logs in the OBS bucket.

          -

          The backup path cannot contain the following characters: \:*?"<>|'{}. Additionally, it cannot:

          -

          Start with a slash (/).

          -

          Start or end with a period (.).

          -

          Contain more than two consecutive slashes (/) or periods (.).

          -

          Exceed 512 characters.

          -

          This parameter is mandatory when action is not set to real_time_log_collect.

          +

          Definition:

          +

          Storage path of backed up logs in the OBS bucket.

          +

          Constraints:

          +

          This parameter is mandatory when action is not set to real_time_log_collect.

          +

          Value range:

          +
          • The backup path cannot contain the following characters: \:*?"<>|'{}. Additionally, it cannot:

            +
          • Start with a slash (/).

            +
          • Start or end with a period (.).

            +
          • Contain more than two consecutive slashes (/) or periods (.).

            +
          • Exceed 512 characters.

            +
          +

          Default value:

          +

          N/A

          logBucket

          +

          log_bucket

          No

          +

          No

          String

          +

          String

          Name of the OBS bucket for storing logs. This parameter is mandatory when action is not set to real_time_log_collect.

          +

          Definition:

          +

          OBS bucket name for log backup.

          +

          Constraints:

          +

          This parameter is mandatory when action is not set to real_time_log_collect.

          +

          Value range:

          +

          N/A

          +

          Default value:

          +

          N/A

          index_prefix

          +

          auto_enable

          No

          +

          No

          String

          +

          Boolean

          Index prefix for saving logs. This parameter is mandatory when action is set to real_time_log_collect.

          +

          Definition:

          +

          Whether to enable automatic backup of cluster logs.

          +

          Constraints:

          +

          N/A

          +

          Value range:

          +
          • true: Enable automatic backup of cluster logs.

            +
          • false: Disable automatic backup of cluster logs.

            +
          +

          Default value:

          +

          false

          keep_days

          +

          period

          No

          +

          No

          Integer

          +

          String

          Log retention duration. This parameter is mandatory when action is set to real_time_log_collect.

          +

          Definition:

          +

          Cluster log backup start time.

          +

          Constraints:

          +

          Format: Greenwich Mean Time (GMT).

          +

          Value range:

          +

          N/A

          +

          Default value:

          +

          N/A

          target_cluster_id

          +

          index_prefix

          No

          +

          No

          String

          +

          String

          Specifies the target cluster for saving logs. This parameter is mandatory when action is set to real_time_log_collect.

          +

          Parameter description:

          +

          Index prefix for storing logs.

          +

          Constraints:

          +

          This parameter is mandatory when action is set to real_time_log_collect.

          +

          Options:

          +

          N/A

          +

          Default value:

          +

          N/A

          +

          keep_days

          +

          No

          +

          Integer

          +

          Parameter description:

          +

          Number of days for log retention.

          +

          Constraints:

          +

          This parameter is mandatory when action is set to real_time_log_collect.

          +

          Options:

          +

          1-3650

          +

          Default value:

          +

          N/A

          +

          target_cluster_id

          +

          No

          +

          String

          +

          Definition:

          +

          ID of the target cluster for log storage.

          +

          Constraints:

          +
          • The target cluster can be the current cluster or another Elasticsearch cluster. If logs are saved to another cluster, you need to use the connectivity testing API to test connectivity to the target cluster. If status code 200 is returned, the target cluster can be reached. Otherwise, you need to select another target cluster.

            +
          • This parameter is mandatory when action is set to real_time_log_collect.

            +
          +

          Value range:

          +

          N/A

          +

          Default value:

          +

          N/A

          -

          Response Parameters

          None

          +

          Response Parameters

          Status code: 200

          +

          Request succeeded.

          +

          None

          -

          Example Requests

          • Enable the log function.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/open
            +

            Example Requests

            • Enable the log backup function.

              +
              POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/open
               
               {
                 "agency" : "css_obs_agency",
              -  "logBasePath" : "css/log",
              -  "logBucket" : "000-words"
              +  "log_base_path" : "css_repository/logs",
              +  "log_Bucket" : "000-words",
              +  "auto_enable" : true,
              +  "period" : "00:00 GMT+08:00"
               }
              -
            • Enable real-time log collection function.

              -
              POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/open?action=real_time_log_collect
              +
            • Enable real-time log collection function.

              +
              POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/open?action=real_time_log_collect
               
               {
                 "index_prefix" : "css_log",
              @@ -155,42 +261,42 @@
               }
            -

            Example Responses

            None

            +

            Example Responses

            None

            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - - - - - - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            -

            Modify the request before retry.

            +

            Invalid request.

            +

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            -

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/css/api-ref/StartPublicWhitelist.html b/docs/css/api-ref/StartPublicWhitelist.html index e295745d3..606229ddf 100644 --- a/docs/css/api-ref/StartPublicWhitelist.html +++ b/docs/css/api-ref/StartPublicWhitelist.html @@ -3,34 +3,50 @@

            Enabling the Public Network Access Control Whitelist

            Function

            This API is used to enable the public network access control whitelist.

            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update

            -
            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - @@ -38,67 +54,69 @@

            Request Parameters

            -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose public network access control whitelist you want to enable.

            +

            Definition:

            +

            ID of the cluster whose public network access control whitelist you want to enable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            Table 2 Request body parameters

            Parameter

            +
            - - - - - - -
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            whiteList

            +

            white_list

            Yes

            +

            Yes

            String

            +

            String

            IP address of the user for whom the whitelist is enabled.

            +

            IP address of the user for whom the whitelist is enabled.

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            Example Requests

            Enable the public network access control whitelist.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/whitelist/update
            +
            POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/whitelist/update
             
             {
            -  "whiteList" : "192.168.0.xx"
            +  "white_list" : "192.168.0.xx"
             }

            Example Responses

            None

            Status Codes

            -

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/StartTargetClusterConnectivityTest.html b/docs/css/api-ref/StartTargetClusterConnectivityTest.html index 1d9592451..73b9ee727 100644 --- a/docs/css/api-ref/StartTargetClusterConnectivityTest.html +++ b/docs/css/api-ref/StartTargetClusterConnectivityTest.html @@ -1,36 +1,52 @@

            Test connectivity.

            -

            Function

            This API is used to test connectivity.

            +

            Function

            This API is used to test the connectivity between two clusters. CSS clusters provide a log collection function, allowing users to collect clusters' run logs in real time and save them to a specified index of a specified CSS cluster. The target cluster can be the current cluster or another cluster. If logs are to be saved to another cluster, you need to use the connectivity testing API to test connectivity to the target cluster. If the target cluster cannot be reached, you need to select another cluster.

            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/logs/connectivity

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/logs/connectivity

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - @@ -38,30 +54,39 @@

            Request Parameters

            -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            Cluster ID.

            +

            Definition:

            +

            Cluster ID. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            Table 2 Request body parameters

            Parameter

            +
            - - - - - - -
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            target_cluster_id

            +

            target_cluster_id

            Yes

            +

            Yes

            String

            +

            String

            Target cluster ID.

            +

            Definition:

            +

            Target cluster ID.

            +

            Constraints:

            +

            Only cluster IDs are supported.

            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            Example Requests

            Test connectivity to the target cluster.

            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/connectivity
            @@ -70,37 +95,35 @@
               "target_cluster_id" : "4f3deec3-efa8-4598-bf91-560aad1377a4"
             }
            -

            Example Responses

            Status code: 200

            -

            Request succeeded.

            -
            { }
            +

            Example Responses

            None

            Status Codes

            -

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/StartVpecp.html b/docs/css/api-ref/StartVpecp.html index 3327a460e..e8f760e46 100644 --- a/docs/css/api-ref/StartVpecp.html +++ b/docs/css/api-ref/StartVpecp.html @@ -3,34 +3,50 @@

            Enabling the VPC Endpoint Service

            Function

            This API is used to enable the VPCEP service for a cluster.

            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/open

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/open

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            The request could not be understood by the server due to malformed syntax.

            +

            The request could not be understood by the server due to malformed syntax.

            Modify the request instead of retrying.

            409

            +

            409

            The request cannot be processed due to a conflict.

            +

            The request cannot be processed due to a conflict.

            This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

            412

            +

            412

            The server does not meet one of the requirements that the requester puts on the request.

            +

            The server does not meet one of the requirements that the requester puts on the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - @@ -38,46 +54,46 @@

            Request Parameters

            -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose VPC endpoint you want to enable.

            +

            Definition:

            +

            ID of the cluster whose VPC endpoint you want to enable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            Table 2 Request body parameters

            Parameter

            +
            - - - - - - - - - - - - - - - @@ -87,20 +103,20 @@

            Response Parameters

            Status code: 200

            -
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            endpointWithDnsName

            +

            endpoint_with_dns_name

            No

            +

            No

            Boolean

            +

            Boolean

            Enable the VPC endpoint.

            +

            Enable the VPC endpoint.

            professionVpcep

            +

            profession_vpcep

            No

            +

            No

            Boolean

            +

            Boolean

            Create a professional VPC endpoint.

            -
            • true: enabled.

              -
            • false: disabled.

              +

            Create a professional VPC endpoint.

            +
            • true: This option will be enabled.

              +
            • false: This option will be disabled.

            dualstackEnable

            +

            dualstack_enable

            No

            +

            No

            Boolean

            +

            Boolean

            Whether to enable the IPv4/IPv6 dual-stack network. The IPv4/IPv6 dual-stack network can be enabled only when a professional VPC endpoint is created and the VPC of the cluster supports IPv6.

            -
            • true: enabled.

              -
            • false: disabled.

              +

            Whether to enable the IPv4/IPv6 dual-stack network. The IPv4/IPv6 dual-stack network can be enabled only when a professional VPC endpoint is created and the VPC of the cluster supports IPv6.

            +
            • true: This option will be enabled.

              +
            • false: This option will be disabled.

            Table 3 Response body parameters

            Parameter

            +
            - - - - - @@ -108,10 +124,10 @@

            Example Requests

            Enable the VPC endpoint service.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/open
            +
            POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/open
             
             {
            -  "endpointWithDnsName" : true
            +  "endpoint_with_dns_name" : true
             }

            Example Responses

            Status code: 200

            @@ -121,32 +137,32 @@ }

            Status Codes

            -
            Table 3 Response body parameters

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            action

            +

            action

            String

            +

            String

            Parameter description:

            -

            Action. The fixed value is createVpcepservice, indicating that the VPC endpoint is enabled.

            +

            Parameter description:

            +

            Operation. The fixed value is createVpcepservice, indicating that the VPC endpoint is enabled.

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/StopAutoCreateSnapshots.html b/docs/css/api-ref/StopAutoCreateSnapshots.html index 7b00398be..895984123 100644 --- a/docs/css/api-ref/StopAutoCreateSnapshots.html +++ b/docs/css/api-ref/StopAutoCreateSnapshots.html @@ -1,36 +1,56 @@

            Disabling Automatic Snapshot Creation

            -

            Function

            This API is used to disable the automatic snapshot creation function.

            +

            Function

            CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's data. By restoring this snapshot, you can restore the cluster to a previous state. There are two ways to create snapshots to back up a CSS cluster: automatic and manual.

            +
            • Automatic snapshot creation: Snapshots are created periodically based on a preset time policy, for example, daily or weekly, to ensure continuous data protection. This reduces manual effort and improves backup reliability and efficiency.

              +
            • Manual snapshot creation: You create snapshots manually for special occasions, for example, prior to a high-risk operation (such as a cluster upgrade). This ensures you can restore data using snapshots in case anything should go wrong. Manual snapshots provide additional flexibility.

              +
            +

            This API is used to disable automatic snapshot creation.

            -

            URI

            PUT /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/close

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            PUT /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/close

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - @@ -39,34 +59,36 @@

            Request Parameters

            None

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            Example Requests

            Disable the automatic backup function.

            -
            PUT /v2.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/snapshots/policy/close
            +
            PUT https://{Endpoint}/v2.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/snapshots/policy/close

            Example Responses

            None

            Status Codes

            -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster that the snapshot belongs to.

            +

            Definition:

            +

            ID of the cluster that the snapshot belongs to. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            Status Code

            +
            - - - - - - - @@ -78,7 +100,7 @@
            diff --git a/docs/css/api-ref/StopLogAutoBackupPolicy.html b/docs/css/api-ref/StopLogAutoBackupPolicy.html index 12d4748ea..95e7a8f5b 100644 --- a/docs/css/api-ref/StopLogAutoBackupPolicy.html +++ b/docs/css/api-ref/StopLogAutoBackupPolicy.html @@ -1,36 +1,56 @@

            Disabling the Automatic Log Backup Policy

            -

            Function

            This API is used to disable the automatic log backup policy.

            +

            Function

            CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.

            +
            • Log query: On the log management page of the CSS management console, you can query the latest 10,000 log records by node type and other criteria. A maximum of 100 results are displayed, enabling you to quickly locate issues.

              +
            • Log backup: Cluster logs are periodically synchronized to OBS buckets. You can download them for in-depth analysis at any time. You can configure custom log backup policies by specifying backup schedules and storage locations. The system backs up all critical logs, including run logs and deprecation logs. They provide comprehensive data for auditing and troubleshooting purposes.

              +
            +

            This API is used to disable an automatic log backup policy. If an automatic log backup policy is enabled for a cluster, you can use this API to disable it.

            -

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/close

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/close

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request before retry.

            403

            +

            403

            Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

            +

            Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - @@ -39,39 +59,42 @@

            Request Parameters

            None

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            None

            +

            Example Requests

            Disable an automatic log backup policy.

            +
            PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/policy/close

            Example Responses

            None

            Status Codes

            -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose automatic log backup policy you want to disable.

            +

            Definition:

            +

            ID of the cluster whose automatic log backup policy you want to disable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/StopLogs.html b/docs/css/api-ref/StopLogs.html index f2a5fc399..8ac7711fc 100644 --- a/docs/css/api-ref/StopLogs.html +++ b/docs/css/api-ref/StopLogs.html @@ -1,107 +1,137 @@ -

            Disabling the Log Function

            -

            Function

            This API is used to disable the log function.

            +

            Disabling the Log Backup or Collection Function

            +

            Function

            This API is used to disable log backup or log ingestion for a cluster. Log backup and log ingestion can be disabled separately. After log backup is disabled, any automatic log backup policy configured earlier becomes invalid, and cluster logs cannot be manually back up to OBS either. Disabling log collection for a cluster stops the logs of that cluster from being collected and saved to a specified cluster.

            -

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/close

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/close

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose log function you want to disable.

            +

            Definition:

            +

            ID of the cluster for which log backup or ingestion is to be disabled. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            -
            Table 2 Query Parameters

            Parameter

            +
            - - - - - - -
            Table 2 Query Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            action

            +

            action

            No

            +

            No

            String

            +

            String

            The action can be base_log_collect or real_time_log_collect. base indicates the historical capability, and real_time indicates the real-time collection capability. If this parameter is not passed, base is used by default, which is compatible with the previous logic.

            +

            Definition:

            +

            Disables log backup or log collection.

            +

            Constraints:

            +

            You can disable log backup or log ingestion only when they have been enabled for the cluster. For details about how to enable log backup or log ingestion, see Enabling Logs.

            +

            Value range:

            +
            • base_log_collect: Disables log backup.

              +
            • real_time_log_collect: Stops log collection.

              +
            +

            Default value:

            +

            base_log_collect

            -

            Request Parameters

            None

            +

            Request Parameters

            None

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            None

            +

            Example Requests

            • Disable log backup or log ingestion.

              +
              PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/close?action=base_log_collect
              +
            • PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/close?action=real_time_log_collect
              +
            -

            Example Responses

            None

            +

            Example Responses

            None

            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - - - - - - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            -

            Modify the request before retry.

            +

            Invalid request.

            +

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            -

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/css/api-ref/StopPublicKibanaWhitelist.html b/docs/css/api-ref/StopPublicKibanaWhitelist.html index 62c197001..d67681e7b 100644 --- a/docs/css/api-ref/StopPublicKibanaWhitelist.html +++ b/docs/css/api-ref/StopPublicKibanaWhitelist.html @@ -3,34 +3,50 @@

            Disabling Kibana Public Network Access Control

            Function

            This API is used to disable public network access control for Kibana.

            -

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/close

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/close

            -
            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - @@ -39,39 +55,42 @@

            Request Parameters

            None

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            None

            +

            Example Requests

            Disable Kibana public network access control.

            +
            PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/publickibana/whitelist/close

            Example Responses

            None

            Status Codes

            -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose Kibana public network access control you want to disable.

            +

            Definition:

            +

            ID of the cluster whose Kibana public network access control you want to disable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/StopPublicWhitelist.html b/docs/css/api-ref/StopPublicWhitelist.html index 632a2822d..6fed11f80 100644 --- a/docs/css/api-ref/StopPublicWhitelist.html +++ b/docs/css/api-ref/StopPublicWhitelist.html @@ -3,34 +3,50 @@

            Disabling the Public Network Access Control Whitelist

            Function

            This API is used to disable the public network access control whitelist.

            -

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/close

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/close

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - @@ -39,39 +55,42 @@

            Request Parameters

            None

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            None

            +

            Example Requests

            Disable the public network access control whitelist.

            +
            PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/public/whitelist/close

            Example Responses

            None

            Status Codes

            -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose public network access control whitelist you want to disable.

            +

            Definition:

            +

            ID of the cluster whose public network access control whitelist you want to disable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/StopSnapshot.html b/docs/css/api-ref/StopSnapshot.html index b4bdd2626..2d794f31d 100644 --- a/docs/css/api-ref/StopSnapshot.html +++ b/docs/css/api-ref/StopSnapshot.html @@ -1,72 +1,91 @@

            Disabling the Snapshot Function

            -

            Function

            This API is used to disable the snapshot function.

            +

            Function

            This API is used to disable the snapshot function.

            -

            URI

            DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose snapshot function you want to disable.

            +

            Definition:

            +

            ID of the cluster for which snapshots are disabled. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            -

            Request Parameters

            None

            +

            Request Parameters

            None

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            None

            +

            Example Requests

            Disable snapshots.

            +
            DELETE https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshots
            -

            Example Responses

            None

            +

            Example Responses

            None

            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            406

            +

            406

            The server could not fulfill the request according to the content characteristics of the request.

            +

            The server could not fulfill the request according to the content characteristics of the request.

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/css/api-ref/StopVpecp.html b/docs/css/api-ref/StopVpecp.html index 5c9e7b28c..21406b8eb 100644 --- a/docs/css/api-ref/StopVpecp.html +++ b/docs/css/api-ref/StopVpecp.html @@ -4,34 +4,50 @@

            Function

            This API is used to disable the VPCEP service for a cluster.

            After the VPCEP service is disabled, users can no longer access the cluster via the VPCEP IP address or a private domain name. If you disable the VPCEP service and then re-enable it, the VPCEP IP address or private domain name may change. Exercise caution.
            -

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/close

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/close

            -
            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - @@ -42,19 +58,19 @@

            Response Parameters

            Status code: 200

            -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose VPC endpoint you want to disable.

            +

            Definition:

            +

            ID of the cluster whose VPC endpoint you want to disable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            Table 2 Response body parameters

            Parameter

            +
            - - - - - @@ -62,7 +78,8 @@
            Table 2 Response body parameters

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            action

            +

            action

            String

            +

            String

            Parameter description:

            +

            Parameter description:

            Action. The fixed value is deleteVpcepservice, indicating that the VPC endpoint is disabled.

            -

            Example Requests

            None

            +

            Example Requests

            Disable the VPC endpoint service.

            +
            PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/vpcepservice/close

            Example Responses

            Status code: 200

            Request succeeded.

            @@ -71,32 +88,32 @@ }

            Status Codes

            -

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/UpdateAlterKibana.html b/docs/css/api-ref/UpdateAlterKibana.html index 769ac67e0..4c21b1a27 100644 --- a/docs/css/api-ref/UpdateAlterKibana.html +++ b/docs/css/api-ref/UpdateAlterKibana.html @@ -3,65 +3,11 @@

            Modifying the Kibana Public Network Bandwidth

            Function

            This API is used to modify the public network bandwidth of Kibana.

            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidth

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidth

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            - - - - - - - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            -

            Mandatory

            -

            Type

            -

            Description

            -

            project_id

            -

            Yes

            -

            String

            -

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            -

            cluster_id

            -

            Yes

            -

            String

            -

            ID of the cluster whose Kibana public network bandwidth you want to modify.

            -
            -
            - -

            Request Parameters

            -
            - - - - - - - - - - - -
            Table 2 Request body parameters

            Parameter

            -

            Mandatory

            -

            Type

            -

            Description

            -

            bandWidth

            -

            Yes

            -

            UpdatePublicKibanaBandwidthReqBandWidth object

            -

            Bandwidth.

            -
            -
            - -
            Table 3 UpdatePublicKibanaBandwidthReqBandWidth

            Parameter

            +
            @@ -71,60 +17,132 @@ - - - + + + + +
            Table 1 Path Parameters

            Parameter

            Mandatory

            size

            +

            project_id

            Yes

            Integer

            +

            String

            New bandwidth size.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            +

            cluster_id

            +

            Yes

            +

            String

            +

            Definition:

            +

            ID of the cluster whose Kibana public network bandwidth you want to modify. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            -

            Response Parameters

            None

            +

            Request Parameters

            +
            + + + + + + + + + + + +
            Table 2 Request body parameters

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            band_width

            +

            Yes

            +

            UpdatePublicKibanaBandwidthReqBandWidth object

            +

            Bandwidth.

            +
            +
            + +
            + + + + + + + + + + + +
            Table 3 UpdatePublicKibanaBandwidthReqBandWidth

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            size

            +

            Yes

            +

            Integer

            +

            New bandwidth size.

            +
            +
            +
            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            Example Requests

            Modify the Kibana public network bandwidth.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/bandwidth
            +
            POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/bandwidth
             
             {
            -  "bandWidth" : {
            +  "band_width" : {
                 "size" : 5
               },
            -  "isAutoPay" : 1
            +  "is_auto_pay" : 1
             }

            Example Responses

            None

            Status Codes

            -

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/UpdateAzByInstanceType.html b/docs/css/api-ref/UpdateAzByInstanceType.html index ea23b740a..1d24adfd1 100644 --- a/docs/css/api-ref/UpdateAzByInstanceType.html +++ b/docs/css/api-ref/UpdateAzByInstanceType.html @@ -1,127 +1,188 @@ -

            Changing the AZ of a Cluster Instance

            -

            Function

            This API is used to change the AZ by specifying node types.

            +

            Changing AZs for a Cluster Instance

            +

            Function

            An availability zone (AZ) is a physical region where resources use independent power supplies and networks. AZs in the same region can communicate with each other through internal networks but are physically isolated.

            +

            Multi-AZ deployment is a high-availability solution provided by CSS. You can deploy a cluster across two or three AZs in the same region. This helps prevent data loss and lower the risk of downtime.

            +

            This API is used to change AZs by specifying node types.

            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/azmigrate

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/azmigrate

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            Cluster ID.

            +

            Definition:

            +

            ID of the cluster whose AZs are to be changed. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            inst_type

            +

            inst_type

            Yes

            +

            Yes

            String

            +

            String

            Types of nodes whose AZ is to be changed. Supported values:

            -
            • all: all node types

              -
            • ess: data node

              -
            • ess-cold: cold data node

              -
            • ess-client: client node

              -
            • ess-master: master node

              +

            Definition:

            +

            Types of nodes whose AZ is to be changed.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • all: all node types

              +
            • ess: data node

              +
            • ess-cold: cold data node

              +
            • ess-client: client node

              +
            • ess-master: master node

            -
            NOTE:
            All mission-critical data has been backed up before an AZ switchover. This is to prevent data loss.
            +

            Default value:

            +

            N/A

            +
            NOTE:

            All mission-critical data has been backed up before an AZ switchover. This is to prevent data loss.

            +
            -

            Request Parameters

            -
            Table 2 Request body parameters

            Parameter

            +

            Request Parameters

            +
            - - - - - - - - - - - - - - - - - - - - - - -
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            source_az

            +

            source_az

            Yes

            +

            Yes

            String

            +

            String

            AZ where the node is located.

            +

            Definition:

            +

            AZ where the node is located.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            target_az

            +

            target_az

            Yes

            +

            Yes

            String

            +

            String

            Destination AZ of nodes.

            +

            Definition:

            +

            AZ where the node is expected to be distributed.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            migrate_type

            +

            migrate_type

            Yes

            +

            Yes

            String

            +

            String

            AZ migration mode:

            -
            • multi_az_change: HA reconstruction

              -
            • az_migrate: AZ migration

              +

            Definition:

            +

            AZ migration method.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • multi_az_change: HA reconstruction

              +
            • az_migrate: AZ migration

            +

            Default value:

            +

            N/A

            agency

            +

            agency

            Yes

            +

            Yes

            String

            +

            String

            Agency name. You can create an agency to allow CSS to call other cloud services.

            +

            Definition:

            +

            Agency name. You can create an agency to allow CSS to call other cloud services.

            +

            Constraints:

            +

            The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.

            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            indices_backup_check

            +

            indices_backup_check

            No

            +

            No

            Boolean

            +

            Boolean

            Indicates whether to perform full index snapshot backup check.

            -

            true: Check full index snapshot backup.

            -

            false: Do not perform full index snapshot backup check.

            +

            Definition:

            +

            Whether to check full index snapshots.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • true: Check for full index snapshots.

              +
            • false: Do not check for full index snapshots.

              +
            +

            Default value:

            +

            true

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            Switch the AZ of the current cluster.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/inst-type/all/azmigrate
            +

            Example Requests

            Change AZs for the current cluster.

            +
            POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/inst-type/all/azmigrate
             
             {
               "source_az" : "cn-north-4c",
            @@ -130,36 +191,36 @@
               "agency" : "css-test-agency"
             }
            -

            Example Responses

            None

            +

            Example Responses

            None

            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - - - - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            -

            The client should not repeat the request without modifications.

            +

            Invalid request.

            +

            The client should not repeat the request without modifications.

            403

            +

            403

            The request is rejected. The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

            +

            The request is rejected. The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/css/api-ref/UpdateBatchClustersTags.html b/docs/css/api-ref/UpdateBatchClustersTags.html index 14716dfdd..e9cfd19fd 100644 --- a/docs/css/api-ref/UpdateBatchClustersTags.html +++ b/docs/css/api-ref/UpdateBatchClustersTags.html @@ -1,100 +1,13 @@

            Adding or Deleting Cluster Tags in Batches

            -

            Function

            This API is used to add tags to or delete tags from a cluster in batches.

            +

            Function

            This API is used to add or delete tags in batches for Elasticsearch, Logstash, and OpenSearch clusters.

            -

            URI

            POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/action

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/action

            -
            - - - - - - - - - - - - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            -

            Mandatory

            -

            Type

            -

            Description

            -

            project_id

            -

            Yes

            -

            String

            -

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            -

            cluster_id

            -

            Yes

            -

            String

            -

            ID of the cluster that you want to add tags to or delete tags from in batches.

            -

            resource_type

            -

            Yes

            -

            String

            -

            Resource type. Currently, its value can only be css-cluster.

            -
            -
            -
            -

            Request Parameters

            -
            - - - - - - - - - - - - - - - - - - - - - -
            Table 2 Request body parameters

            Parameter

            -

            Mandatory

            -

            Type

            -

            Description

            -

            action

            -

            Yes

            -

            String

            -

            Action type. This attribute is used to identify the required operation type.

            -
            • create: Tags are added in batches.

              -
            • delete: Tags are deleted in batches.

              -
            -

            tags

            -

            Yes

            -

            Array of Tag objects

            -

            Tag list.

            -

            sysTags

            -

            No

            -

            Array of SysTags objects

            -

            System tag list.

            -
            • The value of key is fixed to _sys_enterprise_project_id.

              -
            • The value is UUID or 0. 0 indicates the default enterprise project.

              -
            -
            -
            - -
            Table 3 Tag

            Parameter

            +
            @@ -104,64 +17,165 @@ - - - - + + + + + + + +
            Table 1 Path Parameters

            Parameter

            Mandatory

            key

            +

            project_id

            Yes

            String

            Tag name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            value

            +

            cluster_id

            Yes

            String

            Tag value.

            +

            Definition:

            +

            ID of the cluster for which you want to add or delete tags in batches. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            +

            resource_type

            +

            Yes

            +

            String

            +

            Definition:

            +

            Cluster resource type. Currently, its value can only be css-cluster.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            css-cluster: Indicates the cluster type.

            +

            Default value:

            +

            N/A

            +
            +
            + +

            Request Parameters

            +
            + + + + + + + + + + + + + +
            Table 2 Request body parameters

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            action

            +

            Yes

            +

            String

            +

            Definition:

            +

            Cluster tag operation type. This attribute is used to identify the required operation type.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • create: Tags are added in batches.

              +
            • delete: Tags are deleted in batches.

              +
            +

            Default value:

            +

            N/A

            +

            tags

            +

            Yes

            +

            Array of Tag objects

            +

            Definition:

            +

            List of cluster tags.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            -
            Table 4 SysTags

            Parameter

            +
            - - - - - - - - - - -
            Table 3 Tag

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            key

            +

            key

            Yes

            +

            Yes

            String

            +

            String

            Tag name.

            +

            Definition:

            +

            Tag key.

            +

            Constraints:

            +
            • The key cannot be empty. Its length is 1 to 128 characters.

              +
            • The value can contain UTF-8 letters, digits, spaces, and special characters _ . : = + - @.

              +
            • Tags starting with sys are system tags and cannot be used by tenants.

              +
            • Do not use spaces to start or end the key.

              +
            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            value

            +

            value

            Yes

            +

            Yes

            String

            +

            String

            Tag value.

            +

            Definition:

            +

            Tag value.

            +

            Constraints:

            +
            • The value contains 0 to 255 characters.

              +
            • The value can contain UTF-8 letters, digits, spaces, and special characters _.://=+-@

              +
            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 204

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            Create or delete cluster tags in batches.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags/action
            +

            Example Requests

            Create cluster tags in batches.

            +
            POST https://{Endpoint}/v1.0/{project_id}/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags/action
             
             {
               "action" : "create",
            @@ -177,32 +191,32 @@
             

            Example Responses

            None

            Status Codes

            -

            Status Code

            +
            - - - - - - - - - diff --git a/docs/css/api-ref/UpdateCloseKibana.html b/docs/css/api-ref/UpdateCloseKibana.html index 6b651109e..bb15eadc1 100644 --- a/docs/css/api-ref/UpdateCloseKibana.html +++ b/docs/css/api-ref/UpdateCloseKibana.html @@ -1,160 +1,179 @@

            Disabling Kibana Public Access

            -

            Function

            This API is used to disable public network access to Kibana. Kibana public network access cannot be disabled for yearly/monthly clusters by calling this API.

            -
            If you disable Kibana public network access and then re-enable it, the public IP address for accessing Kibana may change. Exercise caution.
            +

            Function

            This API is used to disable public network access to Kibana.

            +

            If you disable Kibana public network access and then re-enable it, the public IP address for accessing Kibana may change. Exercise caution.

            +
            -

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/close

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/close

            -

            Status Code

            Description

            +

            Description

            204

            +

            204

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Do not retry the request before modification.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose Kibana public access you want to disable.

            +

            Definition:

            +

            ID of the cluster whose Kibana public access you want to disable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            -

            Request Parameters

            -
            Table 2 Request body parameters

            Parameter

            +

            Request Parameters

            +
            - - - - - - - - - - -
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            eipSize

            +

            eip_size

            No

            +

            No

            Integer

            +

            Integer

            Bandwidth. Unit: Mbit/s

            +

            Bandwidth. Unit: Mbit/s

            elbWhiteList

            +

            elb_white_list

            No

            +

            No

            StartKibanaPublicReqElbWhitelist object

            +

            StartKibanaPublicReqElbWhitelist object

            ELB whitelist.

            +

            ELB whitelist.

            -
            Table 3 StartKibanaPublicReqElbWhitelist

            Parameter

            +
            - - - - - - - - - - -
            Table 3 StartKibanaPublicReqElbWhitelist

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            enableWhiteList

            +

            enable_white_list

            Yes

            +

            Yes

            Boolean

            +

            Boolean

            Whether to enable the whitelist function.

            -
            • true: The whitelist is enabled.

              -
            • false: The whitelist is disabled.

              +

            Whether to enable the whitelist function.

            +
            • true: The whitelist is enabled.

              +
            • false: The whitelist is disabled.

            whiteList

            +

            white_list

            Yes

            +

            Yes

            String

            +

            String

            Whitelist.

            +

            Whitelist.

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            Disable Kibana public access.

            -
            PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/close
            +

            Example Requests

            Disable Kibana public access.

            +
            PUT https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/publickibana/close
             
             {
            -  "eipSize" : 5,
            -  "elbWhiteList" : {
            -    "enableWhiteList" : true,
            -    "whiteList" : "192.168.0.xx"
            +  "eip_size" : 5,
            +  "elb_white_list" : {
            +    "enable_white_list" : true,
            +    "white_list" : "192.168.0.xx"
               }
             }
            -

            Example Responses

            None

            +

            Example Responses

            None

            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - - - - - - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            -

            Modify the request before retry.

            +

            Invalid request.

            +

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            -

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/css/api-ref/UpdateClusterName.html b/docs/css/api-ref/UpdateClusterName.html index b5d02daf2..d03ab81f2 100644 --- a/docs/css/api-ref/UpdateClusterName.html +++ b/docs/css/api-ref/UpdateClusterName.html @@ -1,111 +1,153 @@

            Renaming a Cluster

            -

            Function

            This API is used to change the name of a cluster.

            +

            Function

            This API is used to change cluster names.

            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/changename

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/changename

            -
            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster that you want to rename.

            +

            Definition:

            +

            ID of the cluster that you want to rename For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            -

            Request Parameters

            -
            Table 2 Request body parameters

            Parameter

            +

            Request Parameters

            +
            - - - - - - - + + + + +
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            displayName

            +

            display_name

            Yes

            +

            Yes

            String

            +

            String

            New name of a cluster

            +

            Definition:

            +

            New name of a cluster

            +

            Constraints:

            +

            display_name and desc cannot be null at the same time.

            +

            Value range:

            +

            The cluster name must start with a letter and can contain 4 to 32 characters. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.

            +

            Default value:

            +

            N/A

            +

            desc

            +

            No

            +

            String

            +

            Definition:

            +

            Cluster description.

            +

            Constraints:

            +

            The value can contain up to 128 characters. display_name and desc cannot be null at the same time.

            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            Change the display name of the current cluster.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/changename
            +

            Example Requests

            Change the display name of the current cluster.

            +
            POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/changename
             
             {
            -  "displayName" : "ES-Test-new"
            +  "display_name" : "ES-Test-new",
            +  "desc" : "test1"
             }
            -

            Example Responses

            None

            +

            Example Responses

            None

            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - - - - - - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            -

            Modify the request before retry.

            +

            Invalid request.

            +

            Modify the request before retry.

            409

            +

            409

            The request could not be completed due to a conflict with the current state of the resource.

            -

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            +

            The request could not be completed due to a conflict with the current state of the resource.

            +

            The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

            412

            +

            412

            The server did not meet one of the preconditions contained in the request.

            +

            The server did not meet one of the preconditions contained in the request.

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/css/api-ref/UpdateESListener.html b/docs/css/api-ref/UpdateESListener.html index 53bac383d..99ac38f07 100644 --- a/docs/css/api-ref/UpdateESListener.html +++ b/docs/css/api-ref/UpdateESListener.html @@ -3,83 +3,11 @@

            Updating Load Balancing Listeners for a Cluster

            Function

            This API is used to update load balancing listeners for a cluster.

            -

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}

            -
            - - - - - - - - - - - - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            -

            Mandatory

            -

            Type

            -

            Description

            -

            project_id

            -

            Yes

            -

            String

            -

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            -

            cluster_id

            -

            Yes

            -

            String

            -

            ID of the target cluster

            -

            listener_id

            -

            Yes

            -

            String

            -

            ID of the target listener.

            -
            -
            -
            -

            Request Parameters

            -
            - - - - - - - - - - - - - - - - -
            Table 2 Request body parameters

            Parameter

            -

            Mandatory

            -

            Type

            -

            Description

            -

            listener

            -

            Yes

            -

            EsListenerRequest object

            -

            Listener object

            -

            type

            -

            No

            -

            String

            -

            Type: searchTool indicates that the load balancer is modified for Elasticsearch/OpenSearch. viewTool indicates that the load balancer is modified for Kibana/OpenSearch Dashboards. The default value is searchTool.

            -
            -
            - -
            Table 3 EsListenerRequest

            Parameter

            +
            @@ -89,22 +17,110 @@ - - - - - + + + + + + + +
            Table 1 Path Parameters

            Parameter

            Mandatory

            default_tls_container_ref

            +

            project_id

            Yes

            String

            ID of the server certificate used by the listener

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            client_ca_tls_container_ref

            +

            cluster_id

            No

            +

            Yes

            String

            ID of the CA certificate used by the listener. This parameter is mandatory when bidirectional authentication is to be updated.

            +

            Definition:

            +

            ID of the target cluster. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            +

            listener_id

            +

            Yes

            +

            String

            +

            ID of the target listener.

            +
            +
            + +

            Request Parameters

            +
            + + + + + + + + + + + + + + + + +
            Table 2 Request body parameters

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            listener

            +

            Yes

            +

            EsListenerRequest object

            +

            Listener object

            +

            type

            +

            No

            +

            String

            +

            Type: searchTool indicates that the load balancer is modified for Elasticsearch/OpenSearch. viewTool indicates that the load balancer is modified for Kibana/OpenSearch Dashboards. The default value is searchTool.

            +
            +
            + +
            + + + + + + + + + + + + + + @@ -113,106 +129,120 @@

            Response Parameters

            Status code: 200

            -
            Table 3 EsListenerRequest

            Parameter

            +

            Mandatory

            +

            Type

            +

            Description

            +

            default_tls_container_ref

            +

            Yes

            +

            String

            +

            ID of the server certificate used by the listener

            +

            client_ca_tls_container_ref

            +

            No

            +

            String

            +

            ID of the CA certificate used by the listener. This parameter is mandatory when bidirectional authentication is to be updated.

            Table 4 Response body parameters

            Parameter

            +
            - - - - -
            Table 4 Response body parameters

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            listener

            +

            listener

            EsListenerResponse object

            +

            EsListenerResponse object

            Listener object

            +

            Listener object

            -
            Table 5 EsListenerResponse

            Parameter

            +
            - - - - - - - - - - - - - - - - -
            Table 5 EsListenerResponse

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            protocol

            +

            protocol

            String

            +

            String

            Protocol used by the listener

            +

            Protocol used by the listener

            id

            +

            id

            String

            +

            String

            Listener ID

            +

            Listener ID

            name

            +

            name

            String

            +

            String

            Listener name

            +

            Listener name

            protocol_port

            +

            protocol_port

            String

            +

            String

            Port used by the listener

            +

            Port used by the listener

            ipgroup

            +

            ipgroup

            EsIpgroupResource object

            +

            EsIpgroupResource object

            Access control information of the listener object

            +

            Access control information of the listener object

            -
            Table 6 EsIpgroupResource

            Parameter

            +
            - - - - - - - - - - -
            Table 6 EsIpgroupResource

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            ipgroup_id

            +

            ipgroup_id

            String

            +

            String

            ID of the IP address group associated with the listener

            +

            Definition:

            +

            ID of the access control group associated with the listener.

            +

            Value range:

            +

            N/A

            enable_ipgroup

            +

            enable_ipgroup

            Boolean

            +

            Boolean

            Status of an access control group

            +

            Definition:

            +

            Status of an access control group.

            +

            Value range:

            +
            • true: Enable the access control listener (which can be deleted directly).

              +
            • false: Disable the access control listener.

              +

            type

            +

            type

            String

            +

            String

            Type of an access control group

            +

            Definition:

            +

            Type of an access control group.

            +

            Value range:

            +
            • white: Configure a whitelist. Only IP addresses on the whitelist can have access.

              +
            • black: Configure a blacklist. IP addresses on the blacklist are blocked access.

              +
            -

            Example Requests

            PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/es-listeners/4425eb63-78ce-4c63-b60e-492befdac0e7
            +

            Example Requests

            Update ELB listeners for a cluster.

            +
            PUT https://{Endpoint}/v1.0/{project_id}/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/es-listeners/4425eb63-78ce-4c63-b60e-492befdac0e7
             
             {
               "listener" : {
            @@ -237,32 +267,32 @@
             }

            Status Codes

            -

            Status Code

            +
            - - - - - - - - - @@ -274,7 +304,7 @@
            diff --git a/docs/css/api-ref/UpdateExtendCluster.html b/docs/css/api-ref/UpdateExtendCluster.html index 9da3097b6..d0b491e7b 100644 --- a/docs/css/api-ref/UpdateExtendCluster.html +++ b/docs/css/api-ref/UpdateExtendCluster.html @@ -1,134 +1,164 @@ -

            Scaling Out a Cluster

            -

            Function

            This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters with master, client, or cold data nodes cannot use this API.For details about how to configure the number and storage capacity of instances in a cluster, see the API for Adding Instances and Expanding Instance Storage Capacity.

            +

            Scaling Out a Cluster (Discarded)

            +

            Function

            This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters with master, client, or cold data nodes cannot use this API.

            +

            For details about how to configure the number and storage capacity of instances in a cluster, see the API for Adding Instances and Expanding Instance Storage Capacity.

            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/extend

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/extend

            -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            +

            Invalid request.

            Modify the request instead of retrying.

            409

            +

            409

            The request cannot be processed due to a conflict.

            +

            The request cannot be processed due to a conflict.

            This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

            412

            +

            412

            The server does not meet one of the requirements that the requester puts on the request.

            +

            The server does not meet one of the requirements that the requester puts on the request.

            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster you want to scale out.

            +

            Definition:

            +

            ID of the cluster you want to scale out. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            -

            Request Parameters

            -
            Table 2 Request body parameters

            Parameter

            +

            Request Parameters

            +
            - - - - - - -
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            grow

            +

            grow

            Yes

            +

            Yes

            ExtendClusterGrowReq object

            +

            ExtendClusterGrowReq object

            Parameter description:

            -

            Detailed description about the cluster scale-out request.

            +

            Definition:

            +

            Detailed description about the cluster scale-out request.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            -
            Table 3 ExtendClusterGrowReq

            Parameter

            +
            - - - - - - -
            Table 3 ExtendClusterGrowReq

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            modifySize

            +

            modifySize

            Yes

            +

            Yes

            Integer

            +

            Integer

            Number of instances you want to add.

            -

            The total number of existing instances and newly added instances in a cluster cannot exceed 32.

            +

            Definition:

            +

            Number of instances to be scaled out. The total number of existing instances and newly added instances in a cluster cannot exceed 32.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            1-32

            +

            Default value:

            +

            N/A

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            Change the number of instances in the current cluster.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/extend
            +

            Example Requests

            Change the number of instances in the current cluster.

            +
            POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/extend
             
             {
               "grow" : {
                 "modifySize" : 4
               },
            -  "isAutoPay" : 1
            -}
            + }
            -

            Example Responses

            None

            +

            Example Responses

            None

            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - - - - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            -

            Modify the request before retry.

            +

            Invalid request.

            +

            Modify the request before retry.

            404

            +

            404

            The requested resource could not be found.

            -

            Modify the request before retry.

            +

            The requested resource could not be found.

            +

            Modify the request before retry.

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/css/api-ref/UpdateExtendInstanceStorage.html b/docs/css/api-ref/UpdateExtendInstanceStorage.html index 860ceadca..a613eaf87 100644 --- a/docs/css/api-ref/UpdateExtendInstanceStorage.html +++ b/docs/css/api-ref/UpdateExtendInstanceStorage.html @@ -1,135 +1,189 @@

            Adding Instances and Expanding Instance Storage Capacity

            -

            Function

            This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold data nodes.

            +

            Function

            This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold data nodes.

            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/role_extend

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/role_extend

            -
            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster you want to scale out.

            +

            Definition:

            +

            ID of the cluster you want to scale out. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            -

            Request Parameters

            -
            Table 2 Request body parameters

            Parameter

            +

            Request Parameters

            +
            - - - - - - -
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            grow

            +

            grow

            Yes

            +

            Yes

            Array of RoleExtendGrowReq objects

            +

            Array of RoleExtendGrowReq objects

            Detailed description about the cluster scale-out request.

            +

            Definition:

            +

            Detailed description about the cluster scale-out request.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            N/A

            +

            Default value:

            +

            N/A

            -
            Table 3 RoleExtendGrowReq

            Parameter

            +
            - - - - - - - - - - - - - - - - - + + + + + + + + + +
            Table 3 RoleExtendGrowReq

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            type

            +

            type

            Yes

            +

            Yes

            String

            +

            String

            Type of the instance to be scaled out. Select at least one from ess, ess-master, and ess-client. A type can be selected once only.

            -

            You can only add instances, rather than increase storage capacity, on nodes of the ess-master and ess-client types.

            -

            nodesize

            -

            Yes

            -

            Integer

            -

            Number of instances you want to add. The total number of existing instances and newly added instances in a cluster cannot exceed 32.

            -

            disksize

            -

            Yes

            -

            Integer

            -

            Storage capacity of the instance you want to add. The sum of the original instance storage capacity plus the expanded instance storage capacity cannot exceed the default upper limit of storage capacity set during cluster creation. If scale-out is not required, set this parameter to 0. With a yearly/monthly cluster, you cannot change the number of nodes and disk capacity at the same time.

            -

            Unit: GB.

            -
            • The scale-out step of ESS and ESS-cold nodes is 20.

              -
            • Storage capacity of ess-master and ess-client nodes cannot be expanded.

              +

            Definition:

            +

            Type of the instance to be scaled out.

            +

            Constraints:

            +

            You can only add instances, rather than increase storage capacity, on nodes of the ess-master and ess-client types.

            +

            Value range:

            +
            • ess: data node

              +
            • ess-master: master node

              +
            • ess-client: client node

              +
            • ess-cold: cold data node

            +

            You can select multiple node types, but cannot select the same node for different roles.

            +

            Default value:

            +

            N/A

            +

            nodesize

            +

            Yes

            +

            Integer

            +

            Definition:

            +

            Number of instances you want to add.

            +

            Constraints:

            +

            After scaling, the number of nodes of each type must meet the following requirements:

            +
            • Data nodes: If the cluster does not have master nodes, the value ranges from 1 to 32. Otherwise, the value ranges from 1 to 200.

              +
            • Master nodes: 3, 5, 7, or 9 (must be an odd number from 3 to 9)

              +
            • Client nodes: 1 to 32.

              +
            • Cold data nodes: 1 to 32.

              +
            +

            Value range:

            +

            See Constraints.

            +

            Default value:

            +

            N/A

            +

            disksize

            +

            Yes

            +

            Integer

            +

            Definition:

            +

            Storage capacity to be added, in GB

            +

            Constraints:

            +

            The sum of the original instance storage capacity plus the expanded instance storage capacity cannot exceed the default upper limit of storage capacity set during cluster creation. If there is no need to add more instances, set this parameter to 0.

            +

            Value range:

            +
            • The scale-out step of ESS and ESS-cold nodes is 20.

              +
            • Storage capacity of ess-master and ess-client nodes cannot be expanded.

              +
            +

            Default value:

            +

            N/A

            -

            Response Parameters

            Status code: 200

            +

            Response Parameters

            Status code: 200

            -
            Table 4 Response body parameters

            Parameter

            +
            - - - - -
            Table 4 Response body parameters

            Parameter

            Type

            +

            Type

            Description

            +

            Description

            id

            +

            id

            String

            +

            String

            Cluster ID.

            +

            Definition:

            +

            Cluster ID.

            +

            Value range:

            +

            N/A

            -

            Example Requests

            Change the number of instances and storage capacity of the current cluster.

            -
            POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/role_extend
            +

            Example Requests

            Change the number of instances and storage capacity of the current cluster.

            +
            POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/role_extend
             
             {
               "grow" : [ {
            @@ -144,45 +198,49 @@
                 "type" : "ess-client",
                 "nodesize" : 1,
                 "disksize" : 0
            +  }, {
            +    "type" : "ess-cold",
            +    "nodesize" : 1,
            +    "disksize" : 0
               } ],
            -  "isAutoPay" : 1
            +  "is_auto_pay" : 1
             }
            -

            Example Responses

            Status code: 200

            -

            Request succeeded.

            -
            {
            +

            Example Responses

            Status code: 200

            +

            Request succeeded.

            +
            {
               "id" : "4f3deec3-efa8-4598-bf91-560aad1377a3"
             }
            -

            Status Codes

            -

            Status Code

            +

            Status Codes

            +
            - - - - - - -

            Status Code

            Description

            +

            Description

            200

            +

            200

            Request succeeded.

            +

            Request succeeded.

            400

            +

            400

            Invalid request.

            -

            Modify the request before retry.

            +

            Invalid request.

            +

            Modify the request before retry.

            404

            +

            404

            The requested resource could not be found.

            -

            Modify the request before retry.

            +

            The requested resource could not be found.

            +

            Modify the request before retry.

            -

            Error Codes

            See Error Codes.

            +

            Error Codes

            See Error Codes.

            diff --git a/docs/css/api-ref/UpdateFlavor.html b/docs/css/api-ref/UpdateFlavor.html index 96ae06b2d..ae8bce4db 100644 --- a/docs/css/api-ref/UpdateFlavor.html +++ b/docs/css/api-ref/UpdateFlavor.html @@ -1,180 +1,231 @@ -

            Changing Specifications

            -

            Function

            This API is used to modify the specifications of a cluster. Only the nodes of the ESS type can be modified.

            -
            All mission-critical data has been backed up before a disk change. This is to prevent data loss.
            +

            Changing Node Specifications (Discarded)

            +

            Function

            This API is used to modify the node specifications of a cluster. It can only change the specifications of ess nodes (data nodes). If you need to change other types of nodes as well, use the API for Changing the Specifications of Specified Nodes.

            +

            All mission-critical data has been backed up before a disk change. This is to prevent data loss.

            +
            -

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/flavor

            +

            Calling Method

            For details, see Calling APIs.

            +
            +

            URI

            POST /v1.0/{project_id}/clusters/{cluster_id}/flavor

            -
            Table 1 Path Parameters

            Parameter

            +
            - - - - - - - - - - -
            Table 1 Path Parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            project_id

            +

            project_id

            Yes

            +

            Yes

            String

            +

            String

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Definition:

            +

            Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Project ID of the account.

            +

            Default value:

            +

            N/A

            cluster_id

            +

            cluster_id

            Yes

            +

            Yes

            String

            +

            String

            ID of the cluster whose specifications you want to change.

            +

            Definition:

            +

            ID of the cluster whose specifications you want to change. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +

            Cluster ID.

            +

            Default value:

            +

            N/A

            -

            Request Parameters

            -
            Table 2 Request body parameters

            Parameter

            +

            Request Parameters

            +
            - - - - - - - - - - - - - - - - - - - - - - -
            Table 2 Request body parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            newFlavorId

            +

            newFlavorId

            Yes

            +

            Yes

            String

            +

            String

            When operationType is set to vm, newFlavorId indicates the node flavor ID after the change.

            -

            This parameter is obtained by calling the Obtaining the Instance Specifications List API. The API selects a flavor_id based on the values of the name attribute.

            -

            The old and new node specifications must be under the same Elasticsearch engine version.

            -

            When operationType is set to volume, newFlavorId indicates the new disk type after the change. The following disk types are supported:

            -
            • COMMON: common I/O

              -
            • HIGH: high I/O

              -
            • ULTRAHIGH: ultra-high I/O

              -
            • ESSD: ultra-fast SSD

              +

            Definition:

            +

            ID of the new node flavor or disk type. It is determined by operationType.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • When operationType is set to vm, newFlavorId indicates the node flavor ID after the change. This parameter is obtained by calling the Obtaining the Instance Specifications List API. The API selects a flavor_id based on the values of the name attribute.

              +
            • When operationType is set to volume, newFlavorId indicates the new disk type after the change. The following disk types are supported:

            +

            The old and new node specifications must be under the same Elasticsearch engine version.

            +

            COMMON: common I/O

            +

            HIGH: high I/O

            +

            ULTRAHIGH: ultra-high I/O

            +

            ESSD: ultra-fast SSD

            +

            Default value:

            +

            N/A

            operationType

            +

            operationType

            No

            +

            No

            String

            +

            String

            Operation type. The value can be vm or volume. The default value is vm.

            -
            • vm: Change the node flavor.

              -
            • volume: Change the disk type.

              +

            Definition:

            +

            Operation type for specifications change.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • vm: Change the node flavor.

              +
            • volume: Change the disk type.

            +

            Default value:

            +

            vm

            needCheckReplica

            +

            needCheckReplica

            No

            +

            No

            Boolean

            +

            Boolean

            Indicates whether to verify replicas. Its value can be true or false. This function is enabled by default.

            -
            • *true: Enable the replicas verification.

              -
            • false: Disable the replicas verification.

              +

            Definition:

            +

            Whether to check replicas when changing cluster specifications.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • *true: Enable replica verification.

              +
            • false: Disable replica verification.

            +

            Default value:

            +

            true

            needCheckClusterStatus

            +

            needCheckClusterStatus

            No

            +

            No

            Boolean

            +

            Boolean

            Description: Whether to check the cluster status. The value can be true or false. This function is enabled by default.

            -
            • true: Cluster status verification is enabled.

              -
            • false: Cluster status verification is ignored.

              +

            Definition:

            +

            Whether to check the cluster status when changing cluster specifications.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • true: Enable cluster load check.

              +
            • false: Cluster status verification is ignored.

            +

            Default value:

            +

            true

            clusterLoadCheck

            +

            clusterLoadCheck

            No

            +

            No

            Boolean

            +

            Boolean

            Whether to check the cluster load. The value can be true or false. The default value is true.

            -
            • true: enable cluster load check.

              -
            • true: skip cluster load check.

              +

            Definition:

            +

            Whether to check the cluster load when changing cluster specifications.

            +

            Constraints:

            +

            N/A

            +

            Value range:

            +
            • true: enable cluster load check.

              +
            • false: Skip cluster load check.

            +

            Default value:

            +

            true

            -

            Response Parameters

            None

            +

            Response Parameters

            Status code: 200

            +

            Request succeeded.

            +

            None

            -

            Example Requests

            • POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/flavor
              +

              Example Requests

              • ID of the new flavor.

                +
                POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/flavor
                 
                 {
                   "needCheckReplica" : false,
                   "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2",
                -  "isAutoPay" : 1,
                +  
                   "needCheckClusterStatus" : true
                 }
                -
              • POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/flavor
                +
              • Disk type after the change.

                +
                POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/flavor
                 
                 {
                   "needCheckReplica" : false,
                   "newFlavorId" : "ULTRAHIGH",
                   "operationType" : "volume",
                -  "isAutoPay" : 1,
                +  
                   "clusterLoadCheck" : true
                 }
              -

              Example Responses

              None

              +

              Example Responses

              None

              -

              Status Codes

              -

              Status Code

              +

              Status Codes

              +
              - - - - - - - - -

              Status Code

              Description

              +

              Description

              200

              +

              200

              Request succeeded.

              +

              Request succeeded.

              400

              +

              400

              Invalid request.

              -

              Modify the request before retry.

              +

              Invalid request.

              +

              Modify the request before retry.

              409

              +

              409

              The request could not be completed due to a conflict with the current state of the resource.

              -

              The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

              +

              The request could not be completed due to a conflict with the current state of the resource.

              +

              The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

              412

              +

              412

              The server did not meet one of the preconditions contained in the request.

              +

              The server did not meet one of the preconditions contained in the request.

              -

              Error Codes

              See Error Codes.

              +

              Error Codes

              See Error Codes.

              diff --git a/docs/css/api-ref/UpdateFlavorByType.html b/docs/css/api-ref/UpdateFlavorByType.html index 5ace88f1e..aaf15b0e1 100644 --- a/docs/css/api-ref/UpdateFlavorByType.html +++ b/docs/css/api-ref/UpdateFlavorByType.html @@ -1,202 +1,262 @@

              Change the specifications of a specified node type.

              -

              Function

              This API is used to modify cluster specifications. Supported node types:

              -
              • ess: data node

                -
              • ess-cold: cold data node

                -
              • ess-client: client node

                -
              • ess-master: master node

                -
              • lgs: LGS node

                +

                Function

                If the workloads on a cluster's data plane change, you can scale the cluster vertically by changing its node specifications or node storage type.

                +
                • Cluster types that support node specifications change: Elasticsearch, OpenSearch, and Logstash.

                  +
                • Cluster types that support node storage type (disk type) change: Elasticsearch and OpenSearch. All mission-critical data must be backed up before a node storage type (disk type) change. This helps to prevent data loss.

                  +
                +

                You can specify the following node types when calling this API:

                +
                • ess: data node (only for Elasticsearch and OpenSearch).

                  +
                • ess-cold: cold data node (only for Elasticsearch and OpenSearch).

                  +
                • ess-client: client node (only for Elasticsearch and OpenSearch).

                  +
                • ess-master: master node (only for Elasticsearch and OpenSearch).

                  +
                • lgs: Logstash node (only for Logstash).

                -
                All mission-critical data has been backed up before a disk change. This is to prevent data loss.
                -

                URI

                POST /v1.0/{project_id}/clusters/{cluster_id}/{types}/flavor

                +

                Constraints

                • Make sure the cluster status is Available and there are no ongoing tasks.

                  +
                • The node specifications and storage type cannot be changed for nodes that use local disks.

                  +
                • The node specifications and storage type cannot be changed at the same time.

                  +
                • The node storage type can be changed only for data nodes and cold data nodes.

                  +
                • When you change the node storage type, data needs to be migrated between different nodes. The timeout for data migration per node is 48 hours. Upgrade will fail if this timeout expires. When the cluster has large quantities of data, you are advised to manually adjust the data migration rate and avoid performing the migration during peak hours.

                  +
                • For a cluster without master nodes, the node storage type can be changed only if the number of data nodes plus cold data nodes is at least three.

                  +
                • For a cluster with master nodes, this operation is allowed only if the cluster has at least two data nodes.

                  +
                • During a node storage type change, there is always one node that is unavailable. To ensure service continuity, there has to be at least two nodes of each type for the cluster in each of its AZs, and the total number of data nodes and cold data nodes is greater than the maximum number of index replicas plus 1.

                  +
                • During a node specifications changes, nodes are brought offline in order to make the changes. To ensure service continuity, make sure all shards have replicas.

                  +
                • Make sure the disk usage is always less than 80/ %during the change.

                  +
                +
                +

                Calling Method

                For details, see Calling APIs.

                +
                +

                URI

                POST /v1.0/{project_id}/clusters/{cluster_id}/{types}/flavor

                -
                Table 1 Path Parameters

                Parameter

                +
                - - - - - - - - - - - - - - -
                Table 1 Path Parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                project_id

                +

                project_id

                Yes

                +

                Yes

                String

                +

                String

                Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                +

                Definition:

                +

                Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +

                Project ID of the account.

                +

                Default value:

                +

                N/A

                cluster_id

                +

                cluster_id

                Yes

                +

                Yes

                String

                +

                String

                ID of the cluster whose specifications you want to change.

                +

                Definition:

                +

                ID of the cluster whose specifications you want to change. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +

                Cluster ID.

                +

                Default value:

                +

                N/A

                types

                +

                types

                Yes

                +

                Yes

                String

                +

                String

                Type of the cluster node you want to modify.

                -
                • ess: data node

                  -
                • ess-cold: cold data node

                  -
                • ess-client: client node

                  -
                • ess-master: master node

                  -
                • lgs: Lgs node.

                  +

                Definition:

                +

                Type of the cluster node you want to modify.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +
                • ess: data node

                  +
                • ess-cold: cold data node

                  +
                • ess-client: client node

                  +
                • ess-master: master node

                  +
                • lgs: Logstash node.

                +

                Default value:

                +

                N/A

                -

                Request Parameters

                -
                Table 2 Request body parameters

                Parameter

                +

                Request Parameters

                +
                - - - - - - - - - - - - - - - - - - - - - - -
                Table 2 Request body parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                newFlavorId

                +

                new_flavor_id

                Yes

                +

                Yes

                String

                +

                String

                When operationType is set to vm, newFlavorId indicates the node flavor ID after the change.

                -

                This parameter is obtained by calling the Obtaining the Instance Specifications List API. The API selects a flavor_id based on the values of the name attribute.

                -

                The old and new node specifications must be under the same Elasticsearch engine version.

                -

                When operationType is set to volume, newFlavorId indicates the new disk type after the change. The following disk types are supported:

                -
                • COMMON: common I/O

                  -
                • HIGH: high I/O

                  -
                • ULTRAHIGH: ultra-high I/O

                  -
                • ESSD: ultra-fast SSD

                  +

                Definition:

                +

                ID of the new node flavor or node storage type (disk type). It is determined by operation_type.

                +

                Constraints:

                +

                The value range depends on operation_type.

                +

                Value range:

                +
                1. When operation_type is set to vm, newFlavorId indicates the node flavor ID after the change. This parameter is obtained by calling the Obtaining the Instance Specifications List API. The API selects a flavor_id based on the values of the name attribute.

                  +
                2. When operation_type is set to volume, new_flavor_id indicates the node storage type (disk type). The options are as follows:

                  +
                +
                • COMMON: common I/O

                  +
                • HIGH: high I/O

                  +
                • ULTRAHIGH: ultra-high I/O

                  +
                • ESSD: ultra-fast SSD

                +

                Default value:

                +

                N/A

                operationType

                +

                operation_type

                No

                +

                No

                String

                +

                String

                Operation type. The value can be vm or volume. The default value is vm.

                -
                • vm: Change the node flavor.

                  -
                • volume: Change the disk type.

                  +

                Definition:

                +

                Operation type.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +
                • vm: Change the node flavor.

                  +
                • volume: Change the disk type.

                +

                Default value:

                +

                vm

                needCheckReplica

                +

                need_check_replica

                No

                +

                No

                Boolean

                +

                Boolean

                Indicates whether to verify replicas. Its value can be true or false. This function is enabled by default.

                -
                • *true: Enable the replicas verification.

                  -
                • false: Disable the replicas verification.

                  +

                Definition:

                +

                Whether to verify replicas.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +
                • *true: Enable replica verification.

                  +
                • false: Disable replica verification.

                -

                Master and client nodes are not data nodes, so they do not need to check replicas no matter this parameter is set to true or false.

                +

                Default value:

                +

                true

                needCheckClusterStatus

                +

                need_check_cluster_status

                No

                +

                No

                Boolean

                +

                Boolean

                Indicates whether to check the cluster status. The value can be true or false. This function is enabled by default.

                -
                • true: Cluster status verification is enabled.

                  -
                • false: Cluster status verification is ignored.

                  +

                Definition:

                +

                Whether to check the cluster status. The value can be true or false. The default value is true.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +
                • true: Enable cluster load check.

                  +
                • false: Cluster status verification is ignored.

                +

                Default value:

                +

                true

                clusterLoadCheck

                +

                cluster_load_check

                No

                +

                No

                Boolean

                +

                Boolean

                Whether to check the cluster load. The value can be true or false. The default value is true.

                -
                • true: enable cluster load check.

                  -
                • true: skip cluster load check.

                  +

                Definition:

                +

                Whether to check the cluster load. The value can be true or false. The default value is true.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +
                • true: enable cluster load check.

                  +
                • false: Skip cluster load check.

                +

                Default value:

                +

                true

                -

                Response Parameters

                None

                +

                Response Parameters

                Status code: 200

                +

                Request succeeded.

                +

                None

                -

                Example Requests

                • POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ess/flavor
                  +

                  Example Requests

                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ess/flavor
                   
                   {
                  -  "needCheckReplica" : false,
                  -  "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2",
                  -  "isAutoPay" : 1,
                  -  "needCheckClusterStatus" : true
                  +  "need_check_replica" : false,
                  +  "new_flavor_id" : "HIGH",
                  +  
                  +  "need_check_cluster_status" : true,
                  +  "operation_type" : "volume",
                  +  "cluster_load_check" : true
                   }
                  -
                • POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ess/flavor
                  -
                  -{
                  -  "needCheckReplica" : false,
                  -  "newFlavorId" : "ULTRAHIGH",
                  -  "operationType" : "volume",
                  -  "isAutoPay" : 1,
                  -  "clusterLoadCheck" : true
                  -}
                  -
                -

                Example Responses

                None

                +

                Example Responses

                None

                -

                Status Codes

                -

                Status Code

                +

                Status Codes

                +
                - - - - - - - - -

                Status Code

                Description

                +

                Description

                200

                +

                200

                Request succeeded.

                +

                Request succeeded.

                400

                +

                400

                Invalid request.

                -

                Modify the request before retry.

                +

                Invalid request.

                +

                Modify the request before retry.

                409

                +

                409

                The request could not be completed due to a conflict with the current state of the resource.

                -

                The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                +

                The request could not be completed due to a conflict with the current state of the resource.

                +

                The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                412

                +

                412

                The server did not meet one of the preconditions contained in the request.

                +

                The server did not meet one of the preconditions contained in the request.

                -

                Error Codes

                See Error Codes.

                +

                Error Codes

                See Error Codes.

                diff --git a/docs/css/api-ref/UpdateInstance.html b/docs/css/api-ref/UpdateInstance.html index 0847b0fcc..b89322b09 100644 --- a/docs/css/api-ref/UpdateInstance.html +++ b/docs/css/api-ref/UpdateInstance.html @@ -2,64 +2,74 @@

                Replacing a Node

                Function

                This API is used to replace a failed node.

                +

                If a node in an Elasticsearch cluster is faulty, you can replace it to restore services.

                +

                The node replacement process is as follows:

                +
                1. Migrate data from the node that needs to be replaced to other available nodes.

                  +
                2. Rebuild the node using the original ID, IP address, specifications, and AZ.

                  +
                3. Add the new node into the cluster. The system automatically triggers a shard reallocation, migrating some of the shards

                  +
                +

                to the new node

                +

                This process does not interrupt services because data is migrated from the replaced node to other available nodes.

                All mission-critical data has been backed up before a node replacement. This is to prevent data loss.
                -

                URI

                PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replace

                +

                Calling Method

                For details, see Calling APIs.

                +
                +

                URI

                PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replace

                -
                Table 1 Path Parameters

                Parameter

                +
                - - - - - - - - - - - - - - - @@ -68,46 +78,49 @@
                Table 1 Path Parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                project_id

                +

                project_id

                Yes

                +

                Yes

                String

                +

                String

                Parameter description:

                -

                The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                +

                Definition:

                +

                Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                Constraints:

                N/A

                -

                Options:

                -

                For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                +

                Value range:

                +

                Project ID of the account.

                Default value:

                N/A

                cluster_id

                +

                cluster_id

                Yes

                +

                Yes

                String

                +

                String

                Parameter description:

                -

                ID of the cluster where nodes are to be replaced.

                +

                Definition:

                +

                ID of the cluster where nodes are to be replaced. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                Constraints:

                N/A

                -

                Options:

                -

                For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                +

                Value range:

                +

                Cluster ID.

                Default value:

                N/A

                instance_id

                +

                instance_id

                Yes

                +

                Yes

                String

                +

                String

                Parameter description:

                +

                Definition:

                ID of the node to be replaced.

                Constraints:

                N/A

                -

                Options:

                -

                Node ID Obtain the ID attribute in instances by referring to Querying Cluster Details.

                +

                Value range:

                +

                Node ID. Obtain the ID attribute in instances by referring to Querying Cluster Details.

                Default value:

                N/A

                -
                Table 2 Query Parameters

                Parameter

                +
                - - - - - - - - - - - @@ -118,33 +131,36 @@

                Request Parameters

                None

                -

                Response Parameters

                None

                +

                Response Parameters

                Status code: 200

                +

                Request succeeded.

                +

                None

                -

                Example Requests

                PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/instance/43e63449-339c-4280-a6e9-da36b0685995/replace?migrateData=true
                +

                Example Requests

                Replace a node.

                +
                PUT https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/instance/43e63449-339c-4280-a6e9-da36b0685995/replace?migrateData=true

                Example Responses

                None

                Status Codes

                -
                Table 2 Query Parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                migrateData

                +

                migrateData

                No

                +

                No

                String

                +

                String

                Parameter description:

                -

                Whether to migrate data. The default value is true.

                +

                Definition:

                +

                Whether to migrate data.

                Constraints:

                N/A

                -

                Options:

                -
                • "true": Migrate data.

                  -
                • "false": Do not migrate data.

                  -

                  Default value:

                  -

                  "true"

                  +

                  Value range:

                  +
                  • true: Migrate data.

                    +
                  • false: Do not migrate data.

                  +

                  Default value:

                  +

                  true

                agency

                +

                agency

                No

                +

                No

                String

                +

                String

                Parameter description:

                +

                Definition:

                Agency name. You can create an agency to allow CSS to call other cloud services.

                Constraints:

                -

                This parameter is mandatory when the new IAM plane is connected. This parameter is optional when the old IAM plane is connected.

                -

                Options:

                -

                VPC permissions required by the agency: "vpc:subnets:get","vpc:ports:*".

                +
                • VPC permissions required by the agency: "vpc:subnets:get","vpc:ports:*".

                  +
                • This parameter is mandatory when the new IAM plane is connected. This parameter is optional when the old IAM plane is connected.

                  +
                • The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.

                  +
                +

                Value range:

                +

                N/A

                Default value:

                N/A

                Status Code

                +
                - - - - - - - diff --git a/docs/css/api-ref/UpdateLogSetting.html b/docs/css/api-ref/UpdateLogSetting.html index 2ccfab43a..ea19e02c8 100644 --- a/docs/css/api-ref/UpdateLogSetting.html +++ b/docs/css/api-ref/UpdateLogSetting.html @@ -1,59 +1,84 @@

                Modifying Basic Log Configurations

                -

                Function

                This API is used to modify basic log configurations.

                +

                Function

                This API is used to modify basic configurations for cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the cluster, you can use this API to modify the basic configurations of log backup and log collection.

                -

                URI

                POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

                +

                Calling Method

                For details, see Calling APIs.

                +
                +

                URI

                POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

                -

                Status Code

                Description

                +

                Description

                200

                +

                200

                Request succeeded.

                +

                Request succeeded.

                400

                +

                400

                Invalid request.

                +

                Invalid request.

                The client should modify the request instead of re-initiating it.

                404

                +

                404

                The requested resource could not be found.

                +

                The requested resource could not be found.

                The client should modify the request instead of re-initiating it.

                Table 1 Path Parameters

                Parameter

                +
                - - - - - - - - - - -
                Table 1 Path Parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                project_id

                +

                project_id

                Yes

                +

                Yes

                String

                +

                String

                Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                +

                Definition:

                +

                Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +

                Project ID of the account.

                +

                Default value:

                +

                N/A

                cluster_id

                +

                cluster_id

                Yes

                +

                Yes

                String

                +

                String

                ID of the cluster whose basic log configurations you want to modify.

                +

                Definition:

                +

                ID of the cluster whose basic log configurations you want to modify. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +

                Cluster ID.

                +

                Default value:

                +

                N/A

                -
                Table 2 Query Parameters

                Parameter

                +
                - - - - - - - @@ -61,92 +86,171 @@

                Request Parameters

                -
                Table 2 Query Parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                action

                +

                action

                No

                +

                No

                String

                +

                String

                The action can be base_log_collect or real_time_log_collect. base indicates the historical capability, and real_time indicates the real-time collection capability. If this parameter is not passed, base is used by default, which is compatible with the previous logic.

                +

                Parameter description:

                +

                Modifies the settings of log backup or log collection.

                +

                Constraints:

                +

                N/A

                +

                Options:

                +
                • base_log_collect: Modifies log backup settings.

                  +
                • real_time_log_collect: Modifies log collection settings.

                  +
                +

                Default value:

                +

                base_log_collect

                Table 3 Request body parameters

                Parameter

                +
                - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + +
                Table 3 Request body parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                agency

                +

                agency

                Yes

                +

                No

                String

                +

                String

                Agency name. You can create an agency to allow CSS to call other cloud services. The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters. This parameter is mandatory when action is not set to real_time_log_collect.

                +

                Parameter description:

                +

                Agency name. Through this agency, you delete OBS permissions to CSS, so that CSS will be able to back up log files to your OBS buckets.

                +

                Constraints:

                +

                This parameter is mandatory when action is not set to real_time_log_collect.

                +

                Options:

                +

                The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.

                +

                Default value:

                +

                N/A

                logBasePath

                +

                log_base_path

                Yes

                +

                No

                String

                +

                String

                Storage path of backed up logs in the OBS bucket.

                -

                The backup path cannot contain the following characters: \:*?"<>|'{}. Additionally, it cannot:

                -

                Start with a slash (/).

                -

                Start or end with a period (.).

                -

                Contain more than two consecutive slashes (/) or periods (.).

                -

                Exceed 512 characters.

                -

                This parameter is mandatory when action is not set to real_time_log_collect.

                +

                Definition:

                +

                Storage path of backed up logs in the OBS bucket.

                +

                Constraints:

                +

                This parameter is mandatory when action is not set to real_time_log_collect.

                +

                Value range:

                +
                • The backup path cannot contain the following characters: \:*?"<>|'{}. Additionally, it cannot:

                  +
                • Start with a slash (/).

                  +
                • Start or end with a period (.).

                  +
                • Contain more than two consecutive slashes (/) or periods (.).

                  +
                • Exceed 512 characters.

                  +
                +

                Default value:

                +

                N/A

                logBucket

                +

                log_bucket

                Yes

                +

                No

                String

                +

                String

                Name of the OBS bucket for storing logs. This parameter is mandatory when action is not set to real_time_log_collect.

                +

                Definition:

                +

                OBS bucket name for log backup.

                +

                Constraints:

                +

                This parameter is mandatory when action is not set to real_time_log_collect.

                +

                Value range:

                +

                N/A

                +

                Default value:

                +

                N/A

                index_prefix

                +

                index_prefix

                No

                +

                No

                String

                +

                String

                Index prefix for storing logs. This parameter is mandatory when action is set to real_time_log_collect.

                +

                Parameter description:

                +

                Index prefix for storing logs.

                +

                Constraints:

                +

                This parameter is mandatory when action is set to real_time_log_collect.

                +

                Options:

                +

                N/A

                +

                Default value:

                +

                N/A

                keep_days

                +

                keep_days

                No

                +

                No

                Integer

                +

                Integer

                Log retention duration. This parameter is mandatory when action is set to real_time_log_collect.

                +

                Parameter description:

                +

                Number of days for log retention.

                +

                Constraints:

                +

                This parameter is mandatory when action is set to real_time_log_collect.

                +

                Options:

                +

                1-3650

                +

                Default value:

                +

                N/A

                target_cluster_id

                +

                target_cluster_id

                No

                +

                No

                String

                +

                String

                Specifies the target cluster for saving logs. This parameter is mandatory when action is set to real_time_log_collect.

                +

                Definition:

                +

                ID of the target cluster for log storage.

                +

                Constraints:

                +
                • The target cluster can be the current cluster or another Elasticsearch cluster. If logs are saved to another cluster, you need to use the connectivity testing API to test connectivity to the target cluster. If status code 200 is returned, the target cluster can be reached. Otherwise, you need to select another target cluster.

                  +
                • This parameter is mandatory when action is set to real_time_log_collect.

                  +
                +

                Value range:

                +

                N/A

                +

                Default value:

                +

                N/A

                +

                auto_enable

                +

                No

                +

                Boolean

                +

                Definition:

                +

                Whether to enable automatic backup of cluster logs.

                +

                Constraints:

                +

                N/A

                +

                Value range:

                +
                • true: Enable automatic backup of cluster logs.

                  +
                • false: Disable automatic backup of cluster logs.

                  +
                +

                Default value:

                +

                false

                +

                period

                +

                No

                +

                String

                +

                Definition:

                +

                Cluster log backup start time.

                +

                Constraints:

                +

                Format: Greenwich Mean Time (GMT).

                +

                Value range:

                +

                N/A

                +

                Default value:

                +

                N/A

                -

                Response Parameters

                None

                +

                Response Parameters

                Status code: 200

                +

                Request succeeded.

                +

                None

                Example Requests

                • Modify basic log configurations.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/settings
                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/settings
                   
                   {
                     "agency" : "css_obs_agency",
                  -  "logBasePath" : "css/log",
                  -  "logBucket" : "000-words"
                  +  "log_base_path" : "css/log",
                  +  "log_bucket" : "000-words"
                   }
                  -
                • Updating the Real-Time Log Collection Configuration

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/settings?action=real_time_log_collect 
                  +
                • Update real-time log ingestion configuration.

                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/settings?action=real_time_log_collect
                   
                   {
                     "index_prefix" : "css_log",
                  @@ -158,32 +262,32 @@
                   

                  Example Responses

                  None

                  Status Codes

                  -

                  Status Code

                  +
                  - - - - - - - - - diff --git a/docs/css/api-ref/UpdatePublicBandWidth.html b/docs/css/api-ref/UpdatePublicBandWidth.html index 7e2b50e95..1a40ee37d 100644 --- a/docs/css/api-ref/UpdatePublicBandWidth.html +++ b/docs/css/api-ref/UpdatePublicBandWidth.html @@ -3,65 +3,11 @@

                  Modifying Public Network Access Bandwidth

                  Function

                  This API is used to modify the public network access bandwidth.

                  -

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidth

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidth

                  -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  +

                  Invalid request.

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  - - - - - - - - - - - - - - - - -
                  Table 1 Path Parameters

                  Parameter

                  -

                  Mandatory

                  -

                  Type

                  -

                  Description

                  -

                  project_id

                  -

                  Yes

                  -

                  String

                  -

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  -

                  cluster_id

                  -

                  Yes

                  -

                  String

                  -

                  ID of the cluster whose public network access bandwidth you want to modify.

                  -
                  -
                  - -

                  Request Parameters

                  -
                  - - - - - - - - - - - -
                  Table 2 Request body parameters

                  Parameter

                  -

                  Mandatory

                  -

                  Type

                  -

                  Description

                  -

                  bandWidth

                  -

                  Yes

                  -

                  BindPublicReqEipBandWidth object

                  -

                  Public network bandwidth.

                  -
                  -
                  - -
                  Table 3 BindPublicReqEipBandWidth

                  Parameter

                  +
                  @@ -71,60 +17,146 @@ - - - + + + + +
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  size

                  +

                  project_id

                  Yes

                  Integer

                  +

                  String

                  Bandwidth range. Unit: Mbit/s

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  +

                  cluster_id

                  +

                  Yes

                  +

                  String

                  +

                  Definition:

                  +

                  ID of the cluster whose public network access bandwidth you want to modify. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  -

                  Response Parameters

                  None

                  +

                  Request Parameters

                  +
                  + + + + + + + + + + + +
                  Table 2 Request body parameters

                  Parameter

                  +

                  Mandatory

                  +

                  Type

                  +

                  Description

                  +

                  band_width

                  +

                  Yes

                  +

                  BindPublicReqEipBandWidth object

                  +

                  Definition:

                  +

                  Public network bandwidth.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  +
                  +
                  + +
                  + + + + + + + + + + + +
                  Table 3 BindPublicReqEipBandWidth

                  Parameter

                  +

                  Mandatory

                  +

                  Type

                  +

                  Description

                  +

                  size

                  +

                  Yes

                  +

                  Integer

                  +

                  Definition:

                  +

                  Public network bandwidth, in Mbit/s.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  +
                  +
                  +
                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  Example Requests

                  Modify public network access bandwidth.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/bandwidth
                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/bandwidth
                   
                   {
                  -  "bandWidth" : {
                  +  "band_width" : {
                       "size" : 5
                     },
                  -  "isAutoPay" : 1
                  +  "is_auto_pay" : 1
                   }

                  Example Responses

                  None

                  Status Codes

                  -

                  Status Code

                  +
                  - - - - - - - - - diff --git a/docs/css/api-ref/UpdatePublicKibanaWhitelist.html b/docs/css/api-ref/UpdatePublicKibanaWhitelist.html index dcd54424c..5d2b47c52 100644 --- a/docs/css/api-ref/UpdatePublicKibanaWhitelist.html +++ b/docs/css/api-ref/UpdatePublicKibanaWhitelist.html @@ -3,34 +3,50 @@

                  Modifying Kibana Public Access Control

                  Function

                  This API is used to modify the Kibana access permission by modifying the Kibana whitelist.

                  -

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/update

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/update

                  -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  +

                  Invalid request.

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - - @@ -38,67 +54,69 @@

                  Request Parameters

                  -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  ID of the cluster whose Kibana access permission you want to modify.

                  +

                  Definition:

                  +

                  ID of the cluster whose Kibana access permission you want to modify. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  Table 2 Request body parameters

                  Parameter

                  +
                  - - - - - - -
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  whiteList

                  +

                  white_list

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Whitelisted IP addresses or network segments that can access Kibana. Separate them with commas (,), and each IP address or network segment must be unique.

                  +

                  Whitelisted IP addresses or network segments that can access Kibana. Separate them with commas (,), and each IP address or network segment must be unique.

                  -

                  Response Parameters

                  None

                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  -

                  Example Requests

                  The latest whitelist

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/publickibana/whitelist/update
                  +

                  Example Requests

                  The latest whitelist.

                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/publickibana/whitelist/update
                   
                   {
                  -  "whiteList" : "192.168.0.21"
                  +  "white_list" : "192.168.0.21"
                   }

                  Example Responses

                  None

                  Status Codes

                  -

                  Status Code

                  +
                  - - - - - - - - - diff --git a/docs/css/api-ref/UpdateRoute.html b/docs/css/api-ref/UpdateRoute.html new file mode 100644 index 000000000..2d8fb37d1 --- /dev/null +++ b/docs/css/api-ref/UpdateRoute.html @@ -0,0 +1,178 @@ + + +

                  Updating Cluster Routes

                  +

                  Function

                  This interface is used to update a cluster route.

                  +
                  Modifying the cluster route may cause service network exceptions and affect the network connection between the client and the cluster. Exercise caution when performing this operation.
                  +
                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/route

                  + +

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  +

                  Invalid request.

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  + + + + + + + + + + + + + + + + +
                  Table 1 Path Parameters

                  Parameter

                  +

                  Mandatory

                  +

                  Type

                  +

                  Description

                  +

                  project_id

                  +

                  Yes

                  +

                  String

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  +

                  cluster_id

                  +

                  Yes

                  +

                  String

                  +

                  Definition:

                  +

                  ID of the target cluster For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  +
                  +
                  + +

                  Request Parameters

                  +
                  + + + + + + + + + + + + + + + + + + + + + +
                  Table 2 Request body parameters

                  Parameter

                  +

                  Mandatory

                  +

                  Type

                  +

                  Description

                  +

                  configtype

                  +

                  Yes

                  +

                  String

                  +

                  Definition:

                  +

                  Operation type.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +
                  • add_ip: Add a cluster route.

                    +
                  • del_ip: Delete a cluster route.

                    +
                  +

                  Default value:

                  +

                  N/A

                  +

                  configkey

                  +

                  Yes

                  +

                  String

                  +

                  Definition:

                  +

                  Route IP address, that is, the IP address of the server where the public network data source is located.

                  +

                  Constraints:

                  +

                  The value of this parameter cannot start with 0.

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  +

                  configvalue

                  +

                  Yes

                  +

                  String

                  +

                  Definition:

                  +

                  Subnet mask of a route. If the IP address contains 16 bits, set the subnet mask to 255.255.0.0. If the IP address contains 24 bits, set the subnet mask to 255.255.255.0.

                  +

                  Constraints:

                  +

                  The value of this parameter cannot start with 0.

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  +
                  +
                  +
                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  +
                  +

                  Example Requests

                  Update cluster routes.

                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/route
                  +
                  +{
                  +  "configtype" : "add_ip",
                  +  "configkey" : "10.5.2.1",
                  +  "configvalue" : "255.255.255.255"
                  +}
                  +
                  +

                  Example Responses

                  None

                  +
                  +

                  Status Codes

                  +
                  + + + + + + + + + + + + + + + + +

                  Status Code

                  +

                  Description

                  +

                  200

                  +

                  Request succeeded.

                  +

                  400

                  +

                  Invalid request.

                  +

                  Modify the request instead of retrying.

                  +

                  409

                  +

                  The request cannot be processed due to a conflict.

                  +

                  This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

                  +

                  412

                  +

                  The server does not meet one of the requirements that the requester puts on the request.

                  +
                  +
                  +
                  +

                  Error Codes

                  See Error Codes.

                  +
                  + +
                  + +
                  + diff --git a/docs/css/api-ref/UpdateShrinkCluster.html b/docs/css/api-ref/UpdateShrinkCluster.html index 3a52bfb36..cbb0f98b9 100644 --- a/docs/css/api-ref/UpdateShrinkCluster.html +++ b/docs/css/api-ref/UpdateShrinkCluster.html @@ -1,147 +1,199 @@

                  Scaling In Nodes of a Specific Type

                  -

                  Function

                  This API is used to remove instances of specific types and reduce instance storage capacity in a cluster. Yearly/Monthly clusters do not support the removal of specified node types by calling this API.

                  -
                  All mission-critical data has been backed up before a cluster scale-in. This is to prevent data loss.
                  +

                  Function

                  This API is used to remove instances of specific types and reduce instance storage capacity in a cluster.

                  +

                  All mission-critical data has been backed up before a cluster scale-in. This is to prevent data loss.

                  +
                  -

                  URI

                  POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Parameter description:

                  -

                  The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  -

                  Constraints:

                  -

                  N/A

                  -

                  Options:

                  -

                  For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  -

                  Default value:

                  -

                  N/A

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Parameter description:

                  -

                  Specifies the ID of the cluster to be scaled in. For details, see Obtaining the Cluster ID.

                  -

                  Constraints:

                  -

                  N/A

                  -

                  Options:

                  -

                  For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  -

                  Default value:

                  -

                  N/A

                  +

                  Definition:

                  +

                  ID of the cluster you want to scale in. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  -

                  Request Parameters

                  -
                  Table 2 Request body parameters

                  Parameter

                  +

                  Request Parameters

                  +
                  - - - - - - - - - - - + + + + + + + + + +
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  shrink

                  +

                  shrink

                  Yes

                  +

                  Yes

                  Array of ShrinkNodeReq objects

                  +

                  Array of ShrinkNodeReq objects

                  Parameter description:

                  -

                  Type and quantity of nodes you want to scale in.

                  +

                  Parameter description:

                  +

                  Type and quantity of nodes you want to scale in.

                  agency_name

                  +

                  agency_name

                  No

                  +

                  No

                  String

                  +

                  String

                  Parameter description:

                  -

                  Agency name. You can create an agency to allow CSS to call other cloud services.

                  -

                  Constraints:

                  -

                  This parameter is mandatory when the new IAM plane is connected. This parameter is optional when the old IAM plane is connected.

                  -

                  Options:

                  -

                  VPC permissions required by the agency: "vpc:subnets:get","vpc:ports:*".

                  -

                  Default value:

                  -

                  N/A

                  +

                  Definition:

                  +

                  Agency name. You can create an agency to allow CSS to call other cloud services.

                  +

                  Constraints:

                  +

                  VPC permissions required by the agency: "vpc:subnets:get","vpc:ports:*".

                  +

                  This parameter is mandatory when the new IAM plane is connected. This parameter is optional when the old IAM plane is connected.

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  +

                  operation_type

                  +

                  No

                  +

                  String

                  +

                  Definition:

                  +

                  Operation type.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +
                  • vm: Reduce nodes.

                    +
                  +

                  [- volume: Reduce the disk size.] (tag:white)

                  +

                  Default value:

                  +

                  vm

                  +

                  cluster_load_check

                  +

                  No

                  +

                  Boolean

                  +

                  Definition:

                  +

                  Whether to check the cluster load.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +
                  • true: enable cluster load check.

                    +
                  • true: skip cluster load check.

                    +
                  +

                  Default value:

                  +

                  true

                  -
                  Table 3 ShrinkNodeReq

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 3 ShrinkNodeReq

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  reducedNodeNum

                  +

                  reducedNodeNum

                  Yes

                  +

                  Yes

                  Integer

                  +

                  Integer

                  Parameter description:

                  -

                  Number of nodes you want to reduce.

                  -
                  • After the scale-in, there has to be at least one node in each AZ under each node type.

                    -
                  • In a cross-AZ cluster, the difference between the numbers of same-type nodes in different AZs cannot exceed 1.

                    -
                  • For a cluster with no Master nodes, the number of removed data nodes (including cold data nodes and other types of nodes) in a scale-in must be fewer than half of the number of the original data nodes, and the number of remaining data nodes after a scale-in must be greater than the maximum number of index replicas.

                    +

                  Definition:

                  +

                  Number of nodes you want to reduce.

                  +

                  Constraints:

                  +
                  • After the scale-in, there has to be at least one node of each type in each AZ.

                    +
                  • In a cross-AZ cluster, the difference between the numbers of same-type nodes in different AZs cannot exceed 1.

                    +
                  • For a cluster with no Master nodes, the number of removed data nodes (including cold data nodes and other types of nodes) in a scale-in must be fewer than half of the number of the original data nodes, and the number of remaining data nodes after a scale-in must be greater than the maximum number of index replicas.

                  -

                  For a cluster with master nodes, the number of removed master nodes in a scale-in must be fewer than half of the number of the original master nodes. After scale-in, there has to be an odd number of master nodes, and there has to be at least three of them.

                  +

                  For a cluster with master nodes, the number of removed master nodes in a scale-in must be fewer than half of the number of the original master nodes. After scale-in, there has to be an odd number of master nodes, and there has to be at least three of them.

                  +

                  Value range:

                  +

                  See Constraints.

                  +

                  Default value:

                  +

                  N/A

                  type

                  +

                  type

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Parameter description:

                  -

                  Node type.

                  -

                  Options:

                  -
                  • ess: data node

                    -
                  • ess-cold: cold data node

                    -
                  • ess-client: client node

                    -
                  • ess-master: master node

                    +

                  Definition:

                  +

                  Node type.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  [If operation_type is set to volume, this parameter cannot be set to ess-client or ess-master.] (tag:white)

                  +

                  Value range:

                  +
                  • ess: data node

                    +
                  • ess-cold: cold data node

                    +
                  • ess-client: client node

                    +
                  • ess-master: master node

                  +

                  Default value:

                  +

                  N/A

                  -

                  Response Parameters

                  None

                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  -

                  Example Requests

                  Scale in a cluster by scaling in specified type of nodes.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/role/shrink
                  +

                  Example Requests

                  Scale in a cluster by specifying the node type and the number of nodes to be removed.

                  +
                  POST https://{Endpoint}/v1.0/extend/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/role/shrink
                   
                   {
                     "shrink" : [ {
                  @@ -150,42 +202,42 @@
                     } ]
                   }
                  -

                  Example Responses

                  None

                  +

                  Example Responses

                  None

                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - - - - - - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  -

                  Modify the request before retry.

                  +

                  Invalid request.

                  +

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  -

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/css/api-ref/UpdateShrinkNodes.html b/docs/css/api-ref/UpdateShrinkNodes.html index b56794d24..bfed8f6a4 100644 --- a/docs/css/api-ref/UpdateShrinkNodes.html +++ b/docs/css/api-ref/UpdateShrinkNodes.html @@ -1,161 +1,173 @@

                  Scaling In a Cluster by Removing a Specific Node

                  -

                  Function

                  This API is used to scale in a cluster by removing a specified node. Yearly/Monthly clusters do not support the removal of specified nodes by calling this API.

                  -
                  All mission-critical data has been backed up before a cluster scale-in. This is to prevent data loss.
                  +

                  Function

                  During a scale-in, the data on the to-be-removed nodes needs to be migrated to the remaining nodes. The timeout for data migration per node is 48 hours. Scale-in will fail if this timeout expires. When the cluster has large quantities of data, you are advised to manually adjust the data migration rate and avoid performing the migration during peak hours.

                  +

                  This API is used to scale in a cluster by removing specified nodes.

                  +

                  All mission-critical data has been backed up before a cluster scale-in. This is to prevent data loss.

                  +
                  -

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/node/offline

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/node/offline

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Parameter description:

                  -

                  The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  -

                  Constraints:

                  -

                  N/A

                  -

                  Options:

                  -

                  For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  -

                  Default value:

                  -

                  N/A

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Parameter description:

                  -

                  Specifies the ID of the cluster to be scaled in. For details, see Obtaining the Cluster ID.

                  -

                  Constraints:

                  -

                  N/A

                  -

                  Options:

                  -

                  For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  -

                  Default value:

                  -

                  N/A

                  +

                  Definition:

                  +

                  ID of the cluster you want to scale in. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  -

                  Request Parameters

                  -
                  Table 2 Request body parameters

                  Parameter

                  +

                  Request Parameters

                  +
                  - - - - - - - - - - - - - - -
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  migrate_data

                  +

                  migrate_data

                  No

                  +

                  No

                  String

                  +

                  String

                  Parameter description:

                  -

                  Whether to migrate data.

                  -

                  Options:

                  -
                  • "true": Migrate data.

                    -
                  • "false": Do not migrate data.

                    +

                  Definition:

                  +

                  Whether to migrate data.

                  +

                  Value range:

                  +
                  • true: Migrate data.

                    +
                  • false: Do not migrate data.

                  -

                  Default value:

                  -

                  "true"

                  +

                  Default value:

                  +

                  true

                  shrinkNodes

                  +

                  shrink_nodes

                  Yes

                  +

                  Yes

                  Array of strings

                  +

                  Array of strings

                  Parameter description:

                  -

                  ID of the node you want to remove.

                  -

                  Obtain the ID attribute in instances by referring to Querying Cluster Details.

                  +

                  Definition:

                  +

                  ID of the node to be removed from the cluster.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Obtain the ID attribute in instances by referring to Querying Cluster Details.

                  +

                  Default value:

                  +

                  N/A

                  agency_name

                  +

                  agency_name

                  No

                  +

                  No

                  String

                  +

                  String

                  Parameter description:

                  -

                  Agency name. You can create an agency to allow CSS to call other cloud services.

                  -

                  Constraints:

                  -

                  This parameter is mandatory when the new IAM plane is connected. This parameter is optional when the old IAM plane is connected.

                  -

                  Options:

                  -

                  VPC permissions required by the agency: "vpc:subnets:get","vpc:ports:*".

                  -

                  Default value:

                  -

                  N/A

                  +

                  Definition:

                  +

                  Agency name. You can create an agency to allow CSS to call other cloud services.

                  +

                  Constraints:

                  +

                  VPC permissions required by the agency: "vpc:subnets:get","vpc:ports:*".

                  +

                  This parameter is mandatory when the new IAM plane is connected. This parameter is optional when the old IAM plane is connected.

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  -

                  Response Parameters

                  None

                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  -

                  Example Requests

                  Scale in a cluster by scaling in specified nodes.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/node/offline
                  +

                  Example Requests

                  Scale in a cluster by scaling in specified nodes.

                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/node/offline
                   
                   {
                  -  "shrinkNodes" : [ "2077bdf3-b90d-412e-b460-635b9b159c11" ],
                  +  "shrink_nodes" : [ "2077bdf3-b90d-412e-b460-635b9b159c11" ],
                     "migrate_data" : "true"
                   }
                  -

                  Example Responses

                  None

                  +

                  Example Responses

                  None

                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - - - - - - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  -

                  Modify the request before retry.

                  +

                  Invalid request.

                  +

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  -

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/css/api-ref/UpdateSnapshotSetting.html b/docs/css/api-ref/UpdateSnapshotSetting.html index f4140ad59..4d3828fb8 100644 --- a/docs/css/api-ref/UpdateSnapshotSetting.html +++ b/docs/css/api-ref/UpdateSnapshotSetting.html @@ -1,173 +1,364 @@

                  Modifying Basic Configurations of a Cluster Snapshot

                  -

                  Function

                  This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.

                  -

                  You can also use this API to enable the snapshot function.

                  +

                  Function

                  This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.

                  +
                  • OBS Bucket: Enter the location of the OBS bucket used for storing snapshots.

                    +
                  • Backup Path: Enter the storage path of the snapshot in the OBS bucket.

                    +
                  • IAM Agency: Authorize you to use OBS in IAM so that snapshots must be stored in OBS.

                    +
                  +

                  You can also use this API to enable the snapshot function.

                  -

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  ID of the cluster whose snapshot basic configuration you want to modify.

                  +

                  Definition:

                  +

                  ID of the target cluster For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  -

                  Request Parameters

                  -
                  Table 2 Request body parameters

                  Parameter

                  +

                  Request Parameters

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  bucket

                  +

                  bucket

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Name of the OBS bucket used for backup.

                  +

                  Definition:

                  +

                  Name of the OBS bucket used for backup.

                  +

                  Constraints:

                  +
                  • Storage class: standard.

                    +
                  • Region: the same as that of the cluster.

                    +
                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  agency

                  +

                  agency

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Agency name. You can create an agency to allow CSS to call other cloud services. The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.

                  +

                  Definition:

                  +

                  Agency name. You can create an agency to allow CSS to call other cloud services.

                  +

                  Constraints:

                  +

                  The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  basePath

                  +

                  base_path

                  No

                  +

                  No

                  String

                  +

                  String

                  Storage path of the snapshot in the OBS bucket.

                  -

                  The backup path cannot contain the following characters: \:*?"<>|'{}. Additionally, it cannot:

                  -

                  Start with a slash (/).

                  -

                  Start or end with a period (.).

                  -

                  Contain more than two consecutive slashes (/) or periods (.).

                  -

                  Exceed 512 characters.

                  +

                  Definition:

                  +

                  Storage path of the snapshot in the OBS bucket.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +
                  • The backup path cannot contain the following characters: \:*?"<>|'{}. Additionally, it cannot:

                    +
                  • Start with a slash (/).

                    +
                  • Start or end with a period (.).

                    +
                  • Contain more than two consecutive slashes (/) or periods (.).

                    +
                  • Exceed 512 characters.

                    +
                  +

                  Default value:

                  +

                  N/A

                  maxSnapshotBytesPerSeconds

                  +

                  max_snapshot_bytes_per_seconds

                  No

                  +

                  No

                  String

                  +

                  String

                  Maximum recovery speed (per second). Parameter description: This parameter sets the maximum recovery speed per node. When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

                  -

                  Constraints: For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached.

                  -

                  The following values and formats are allowed:

                  -

                  Format 1: a number followed by a unit

                  -

                  The number ranges from 0 to 9999. The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive). 0mb means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  -

                  Format 2: 0, indicating there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  -

                  Format 3: -1, indicating there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  -

                  Default: For Elasticsearch clusters of 7.6.2 or earlier, the default setting is 40mb. For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter. If this parameter is left blank, the default setting is used.

                  +

                  Definition:

                  +

                  This parameter sets the maximum backup speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  The following values and formats are allowed:

                  +
                  • Number + Unit

                    +
                  +

                  The number ranges from 0 to 9999.

                  +

                  The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

                  +

                  0mb means there is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  +
                  • 0

                    +
                  +

                  There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  +
                  • -1

                    +
                  +

                  There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  +

                  Default value:

                  +

                  The default value is 40 MB. If this parameter is left blank, the default value is used.

                  maxRestoreBytesPerSeconds

                  +

                  max_restore_bytes_per_seconds

                  No

                  +

                  No

                  String

                  +

                  String

                  Maximum recovery speed (per second). Parameter description:

                  -

                  This parameter sets the maximum recovery speed per node. When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

                  -

                  Constraints:

                  -

                  For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached.

                  -

                  Value:

                  -

                  The following values and formats are allowed:

                  -

                  Format 1: a number followed by a unit

                  -

                  The number ranges from 0 to 9999. The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive). 0mb means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  -

                  Format 2: 0, indicating there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  -

                  Format 3: -1, indicating there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  -

                  Default:

                  -

                  For Elasticsearch clusters of 7.6.2 or earlier, the default setting is 40mb. For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter. If this parameter is left blank, the default setting is used.

                  +

                  Definition:

                  +

                  This parameter sets the maximum recovery speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

                  +

                  Constraints:

                  +

                  For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached.

                  +

                  Value range:

                  +

                  The following values and formats are allowed:

                  +
                  • Number + Unit

                    +
                  +

                  The number ranges from 0 to 9999.

                  +

                  The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

                  +

                  0mb means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  +
                  • 0

                    +
                  +

                  There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  +
                  • -1

                    +
                  +

                  There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

                  +

                  Default value:

                  +

                  For Elasticsearch clusters of 7.6.2 or earlier, the default setting is 40mb.

                  +

                  For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter.

                  +

                  If this parameter is left blank, the default setting is used.

                  +

                  enable

                  +

                  No

                  +

                  String

                  +

                  Definition:

                  +

                  Whether to enable the automatic snapshot creation policy.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  true: The automatic snapshot creation policy is enabled.

                  +

                  false: disabled.

                  +

                  Default value:

                  +

                  false

                  +

                  indices

                  +

                  No

                  +

                  String

                  +

                  Definition:

                  +

                  Name of the index to be backed up.

                  +

                  Constraints:

                  +
                  • indicates all indexes and is valid only when enable is set to true.

                    +
                  • The value cannot contain uppercase letters, spaces, or the following characters: "<|>/?

                    +
                  +

                  Value range:

                  +
                  • If this parameter is left blank, all indexes in the snapshot are restored by default.

                    +
                  • To restore specified indexes, for example, index1, index2, and Index3, specify the indexes.

                    +
                  +

                  You can use an asterisk () to match multiple indexes. For example, index indicates that all indexes with the prefix index will be restored.

                  +

                  Default value:

                  +

                  N/A

                  +

                  prefix

                  +

                  No

                  +

                  String

                  +

                  Definition:

                  +

                  Prefix of a snapshot that is automatically created, which is manually entered.

                  +

                  Constraints:

                  +

                  This parameter is mandatory when enable is set to true.

                  +

                  Value range:

                  +

                  Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

                  +

                  Default value:

                  +

                  N/A

                  +

                  period

                  +

                  No

                  +

                  String

                  +

                  Definition:

                  +

                  Time when a snapshot is created every day.

                  +

                  Constraints:

                  +
                  NOTE:

                  When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.

                  +
                  +
                  • This parameter is mandatory when enable is set to true.

                    +
                  +

                  Value range:

                  +

                  Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

                  +

                  Default value:

                  +

                  00:00 GMT+08:00

                  +

                  keepday

                  +

                  No

                  +

                  Integer

                  +

                  Definition:

                  +

                  Customize the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to auto snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

                  +

                  Constraints:

                  +

                  This parameter is mandatory when enable is set to true.

                  +

                  Value range:

                  +

                  1–90

                  +

                  Default value:

                  +

                  N/A

                  +

                  frequency

                  +

                  No

                  +

                  String

                  +

                  Definition:

                  +

                  Frequency of automatically creating snapshots.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +
                  • HOUR: Execute once every hour on the hour.

                    +
                  • DAY: Execute once every day.

                    +
                  • SUN, MON, TUE, WED, THU, FRI, and SAT: Execute the task at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday.

                    +
                  • The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.

                    +
                  +

                  Default value:

                  +

                  DAY

                  +

                  delete_auto

                  +

                  No

                  +

                  String

                  +

                  Definition:

                  +

                  Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled.

                  +

                  Constraints:

                  +

                  This parameter is valid only when enable is set to false, indicating that automatic backup is disabled.

                  +

                  Value range:

                  +

                  true: Delete all automatically created snapshots when an automatic snapshot creation policy is disabled.

                  +

                  false: Retain automatically created snapshots when an automatic snapshot creation policy is disabled.

                  +

                  Default value:

                  +

                  false

                  -

                  Response Parameters

                  None

                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  -

                  Example Requests

                  Enable the snapshot function.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/setting
                  +

                  Example Requests

                  Enable the snapshot function.

                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/setting
                   
                   {
                     "bucket" : "test-bucket",
                     "agency" : "usearch",
                  -  "basePath" : "css_repository/Es-name",
                  -  "maxSnapshotBytesPerSeconds" : 0,
                  -  "maxRestoreBytesPerSeconds" : 0
                  +  "base_path" : "css_repository/Es-name",
                  +  "max_snapshot_bytes_per_seconds" : 0,
                  +  "max_restore_bytes_per_seconds" : 0
                   }
                  -

                  Example Responses

                  None

                  +

                  Example Responses

                  None

                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - - - - - - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  406

                  +

                  406

                  The server could not fulfill the request according to the content characteristics of the request.

                  +

                  The server could not fulfill the request according to the content characteristics of the request.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  504

                  +

                  504

                  A gateway timeout error occurred.

                  +

                  A gateway timeout error occurred.

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/css/api-ref/UpdateUnbindPublic.html b/docs/css/api-ref/UpdateUnbindPublic.html index 0c3d5c76b..8bb53076d 100644 --- a/docs/css/api-ref/UpdateUnbindPublic.html +++ b/docs/css/api-ref/UpdateUnbindPublic.html @@ -1,136 +1,167 @@

                  Disabling Public Network Access

                  -

                  Function

                  This API is used to disable public network access. Public network access cannot be disabled for yearly/monthly clusters by calling this API.

                  -
                  After public network access is disabled, users can no longer access the cluster via a public IP address. If you disable public network access and then re-enable it, the public IP address of the cluster may change. Exercise caution.
                  +

                  Function

                  This API is used to disable public network access.

                  +

                  After public network access is disabled, users can no longer access the cluster via a public IP address. If you disable public network access and then re-enable it, the public IP address of the cluster may change. Exercise caution.

                  +
                  -

                  URI

                  PUT /v1.0/{project_id}/clusters/{cluster_id}/public/close

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  PUT /v1.0/{project_id}/clusters/{cluster_id}/public/close

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  ID of the cluster whose public network access you want to disable.

                  +

                  Definition:

                  +

                  ID of the cluster whose public network access you want to disable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  -

                  Request Parameters

                  -
                  Table 2 Request body parameters

                  Parameter

                  +

                  Request Parameters

                  +
                  - - - - - - -
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  eip

                  +

                  eip

                  No

                  +

                  No

                  UnBindPublicReqEipReq object

                  +

                  UnBindPublicReqEipReq object

                  EIP information.

                  +

                  EIP information.

                  -
                  Table 3 UnBindPublicReqEipReq

                  Parameter

                  +
                  - - - - - - -
                  Table 3 UnBindPublicReqEipReq

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  bandWidth

                  +

                  bandWidth

                  No

                  +

                  No

                  BindPublicReqEipBandWidth object

                  +

                  BindPublicReqEipBandWidth object

                  Public network bandwidth.

                  +

                  Definition:

                  +

                  Public network bandwidth.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  -
                  Table 4 BindPublicReqEipBandWidth

                  Parameter

                  +
                  - - - - - - -
                  Table 4 BindPublicReqEipBandWidth

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  size

                  +

                  size

                  Yes

                  +

                  Yes

                  Integer

                  +

                  Integer

                  Bandwidth range. Unit: Mbit/s

                  +

                  Definition:

                  +

                  Public network bandwidth, in Mbit/s.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  -

                  Response Parameters

                  Status code: 200

                  +

                  Response Parameters

                  Status code: 200

                  -
                  Table 5 Response body parameters

                  Parameter

                  +
                  - - - - -
                  Table 5 Response body parameters

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  action

                  +

                  action

                  String

                  +

                  String

                  Operations. The fixed value is unbindZone, indicating that the unbinding is successful.

                  +

                  Operations. The fixed value is unbindZone, indicating that the unbinding is successful.

                  -

                  Example Requests

                  Disable public network access.

                  -
                  PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/close
                  +

                  Example Requests

                  Disable public network access.

                  +
                  PUT https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/close
                   
                   {
                     "eip" : {
                  @@ -140,46 +171,46 @@
                     }
                   }
                  -

                  Example Responses

                  Status code: 200

                  -

                  Request succeeded.

                  -
                  {
                  +

                  Example Responses

                  Status code: 200

                  +

                  Request succeeded.

                  +
                  {
                     "action" : "unbindZone"
                   }
                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - - - - - - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  -

                  Modify the request before retry.

                  +

                  Invalid request.

                  +

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  -

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/css/api-ref/UpdateVpcepConnection.html b/docs/css/api-ref/UpdateVpcepConnection.html index 5d0f9ae40..11efac54d 100644 --- a/docs/css/api-ref/UpdateVpcepConnection.html +++ b/docs/css/api-ref/UpdateVpcepConnection.html @@ -3,34 +3,50 @@

                  Updating an Endpoint Connection

                  Function

                  This API is used to update the VPCEP connection of a cluster.

                  -

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connections

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - - @@ -38,80 +54,82 @@

                  Request Parameters

                  -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  ID of the cluster whose VPC endpoint you want to update.

                  +

                  Definition:

                  +

                  ID of the cluster whose VPC endpoint you want to update. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  Table 2 Request body parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  action

                  +

                  action

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Expected behavior.

                  +

                  Expected behavior.

                  • receive: Accept the VPC endpoint.

                  • reject: Reject the VPC endpoint.

                  endpointIdList

                  +

                  endpoint_id_list

                  Yes

                  +

                  Yes

                  Array of strings

                  +

                  Array of strings

                  Lists VPC endpoint IDs.

                  +

                  Lists VPC endpoint IDs.

                  -

                  Response Parameters

                  None

                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  Example Requests

                  Update an endpoint connection.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/connections
                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/connections
                   
                   {
                     "action" : "receive",
                  -  "endpointIdList" : [ "f132bb14-e1d5-4f25-9f7c-a29e4c8effd4" ]
                  +  "endpoint_id_list" : [ "f132bb14-e1d5-4f25-9f7c-a29e4c8effd4" ]
                   }

                  Example Responses

                  None

                  Status Codes

                  -

                  Status Code

                  +
                  - - - - - - - - - diff --git a/docs/css/api-ref/UpdateVpcepWhitelist.html b/docs/css/api-ref/UpdateVpcepWhitelist.html index e3a788a72..0987e1795 100644 --- a/docs/css/api-ref/UpdateVpcepWhitelist.html +++ b/docs/css/api-ref/UpdateVpcepWhitelist.html @@ -3,34 +3,50 @@

                  Modifying the VPCEP Service Whitelist of a Cluster

                  Function

                  This API is used to modify the endpoint service whitelist.

                  -

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissions

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissions

                  -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  +

                  Invalid request.

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - - @@ -38,67 +54,69 @@

                  Request Parameters

                  -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Cluster ID.

                  +

                  Definition:

                  +

                  ID of the cluster to be modified For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  Table 2 Request body parameters

                  Parameter

                  +
                  - - - - - - -
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  vpcPermissions

                  +

                  vpc_permissions

                  Yes

                  +

                  Yes

                  Array of strings

                  +

                  Array of strings

                  Whitelist (user account ID).

                  +

                  Whitelist (user account ID).

                  -

                  Response Parameters

                  None

                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  Example Requests

                  Modify the endpoint service whitelist.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/permissions
                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/permissions
                   
                   {
                  -  "vpcPermissions" : [ "dffef70c1db243cbb373e45791165281" ]
                  +  "vpc_permissions" : [ "dffef70c1db243cbb373e45791165281" ]
                   }

                  Example Responses

                  None

                  Status Codes

                  -

                  Status Code

                  +
                  - - - - - - - - - diff --git a/docs/css/api-ref/UpdateYmls.html b/docs/css/api-ref/UpdateYmls.html index 9ba893c94..311f7c74d 100644 --- a/docs/css/api-ref/UpdateYmls.html +++ b/docs/css/api-ref/UpdateYmls.html @@ -1,87 +1,139 @@

                  Modifying Cluster Parameters

                  -

                  Function

                  This API is used to modify the parameter settings of a cluster.

                  -
                  Set the values of any custom parameters to those that are supported by Elasticsearch. Otherwise, the cluster will fail to be restarted. Exercise caution when performing this operation.
                  +

                  Function

                  This API is used to modify the parameter settings of a cluster. Before calling this API, obtain the parameter configuration list, check the parameter settings, and modify them as required.

                  +

                  Set the values of any custom parameters to those that are supported by Elasticsearch. Otherwise, the cluster will fail to be restarted. Exercise caution when performing this operation.

                  +
                  -

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update

                  -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  +

                  Invalid request.

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  ID of the cluster whose parameter settings you want to be modify.

                  +

                  Definition:

                  +

                  ID of the cluster whose parameter settings you want to be modify. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  -

                  Request Parameters

                  -
                  Table 2 Request body parameters

                  Parameter

                  +

                  Request Parameters

                  +
                  - - - - - - -
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  edit

                  +

                  edit

                  Yes

                  +

                  Yes

                  UpdateYmlsReqEdit object

                  +

                  UpdateYmlsReqEdit object

                  Configuration file information.

                  +

                  Definition:

                  +

                  Configuration file information.

                  +

                  Constraints:

                  +

                  N/A

                  -
                  Table 3 UpdateYmlsReqEdit

                  Parameter

                  +
                  - - - - - - - + + + + + + + + + + @@ -89,69 +141,84 @@
                  Table 3 UpdateYmlsReqEdit

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  modify

                  +

                  modify

                  Yes

                  +

                  No

                  UpdateYmlsReqEditModify object

                  +

                  UpdateYmlsReqEditModify object

                  Operations on the configuration file.

                  -
                  • modify: Modify parameter settings.

                    -
                  • delete: Delete parameter settings.

                    -
                  • reset: Reset parameter settings.

                    +

                  Definition:

                  +

                  Modify parameter settings.

                  +

                  Constraints:

                  +
                  • modify, delete, and reset: at least one of them will take effect, and each operation can be used only once.

                    +
                  • Cannot perform multiple operations on the same parameter at the same time.

                    +
                  +

                  delete

                  +

                  No

                  +

                  UpdateYmlsReqEditModify object

                  +

                  Definition:

                  +

                  Delete custom parameter settings.

                  +

                  Constraints:

                  +
                  • Irrelevant to the input parameter value.

                    +
                  • modify, delete, and reset: at least one of them will take effect, and each operation can be used only once.

                    +
                  • Cannot perform multiple operations on the same parameter at the same time.

                    +
                  +

                  reset

                  +

                  No

                  +

                  UpdateYmlsReqEditModify object

                  +

                  Definition:

                  +

                  Reset parameter settings.

                  +

                  Constraints:

                  +
                  • Irrelevant to the input parameter value.

                    +
                  • Custom parameters cannot be reset.

                    +
                  • modify, delete, and reset: at least one of them will take effect, and each operation can be used only once.

                    +
                  • Cannot perform multiple operations on the same parameter at the same time.

                  -
                  Table 4 UpdateYmlsReqEditModify

                  Parameter

                  +
                  - - - - - - -
                  Table 4 UpdateYmlsReqEditModify

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  elasticsearch.yml

                  +

                  elasticsearch.yml

                  Yes

                  +

                  Yes

                  Object

                  +

                  Object

                  Parameter configuration list. The value is the JSON data you want to modify.

                  +

                  Definition:

                  +

                  Parameter configuration list. The value is the JSON data to be modified.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  -

                  Response Parameters

                  Status code: 200

                  +

                  Response Parameters

                  Status code: 200

                  -
                  Table 5 Response body parameters

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 5 Response body parameters

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  acknowledged

                  +

                  acknowledged

                  Boolean

                  +

                  Boolean

                  Whether the modification is successful.

                  -
                  • true: The modification succeeded.

                    -
                  • false: The modification failed.

                    +

                  Definition:

                  +

                  Parameter settings modified successfully or not.

                  +

                  Value range:

                  +
                  • true: The modification is successful.

                    +
                  • false: The modification fails.

                  externalMessage

                  +

                  externalMessage

                  String

                  +

                  String

                  Error message. If acknowledged was set to true, null is returned for this field.

                  +

                  Definition:

                  +

                  Error description.

                  +

                  Value range:

                  +

                  If acknowledged was set to true, null is returned for this field.

                  httpErrorResponse

                  +

                  httpErrorResponse

                  String

                  +

                  String

                  HTTP error information. The default value is null.

                  +

                  Definition:

                  +

                  HTTP error information. The default value is null.

                  +

                  Value range:

                  +

                  N/A

                  -

                  Example Requests

                  Modify parameter settings.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ymls/update
                  +

                  Example Requests

                  Modify parameter settings.

                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ymls/update
                   
                   {
                     "edit" : {
                  @@ -163,48 +230,46 @@
                     }
                   }
                  -

                  Example Responses

                  Status code: 200

                  -

                  Request succeeded.

                  -
                  {
                  -  "acknowledged" : true,
                  -  "externalMessage" : null,
                  -  "httpErrorResponse" : null
                  +

                  Example Responses

                  Status code: 200

                  +

                  Request succeeded.

                  +
                  {
                  +  "acknowledged" : true
                   }
                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - - - - - - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  -

                  Modify the request before retry.

                  +

                  Invalid request.

                  +

                  Modify the request before retry.

                  409

                  +

                  409

                  The request could not be completed due to a conflict with the current state of the resource.

                  -

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  +

                  The request could not be completed due to a conflict with the current state of the resource.

                  +

                  The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/css/api-ref/UpgradeCore.html b/docs/css/api-ref/UpgradeCore.html index 9bbfa1313..3464ceb40 100644 --- a/docs/css/api-ref/UpgradeCore.html +++ b/docs/css/api-ref/UpgradeCore.html @@ -1,134 +1,198 @@

                  Upgrading a Cluster Kernel

                  -

                  Function

                  This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.

                  +

                  Function

                  This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.

                  -

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/image/upgrade

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/image/upgrade

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - - - - - -
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Project ID of the account.

                  +

                  Default value:

                  +

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  ID of the cluster to be upgraded.

                  +

                  Definition:

                  +

                  ID of the cluster to be upgraded. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Cluster ID.

                  +

                  Default value:

                  +

                  N/A

                  inst_type

                  +

                  inst_type

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Type of the node to be upgraded. Currently, its value can only be all.

                  +

                  Definition:

                  +

                  Types of nodes to be upgraded.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  Currently, only all is supported, indicating all nodes.

                  +

                  Default value:

                  +

                  N/A

                  -

                  Request Parameters

                  -
                  Table 2 Request body parameters

                  Parameter

                  +

                  Request Parameters

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 2 Request body parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  target_image_id

                  +

                  target_image_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  ID of the target image version.

                  +

                  Definition:

                  +

                  ID of the target image version.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  upgrade_type

                  +

                  upgrade_type

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Upgrade type.

                  -
                  • same: same-version upgrade.

                    -
                  • cross: cross-version upgrade.

                    -
                  • cross-engine: cross-engine upgrade.

                    +

                  Definition:

                  +

                  Upgrade type.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +
                  • same: same-version upgrade.

                    +
                  • cross: cross-version upgrade.

                    +
                  • cross-engine: cross-engine upgrade.

                  +

                  Default value:

                  +

                  N/A

                  indices_backup_check

                  +

                  indices_backup_check

                  Yes

                  +

                  Yes

                  Boolean

                  +

                  Boolean

                  Whether to perform backup verification.

                  -
                  • true

                    -
                  • false

                    +

                  Definition:

                  +

                  Whether to perform backup verification.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +
                  • true: Verify the load.

                    +
                  • false: Do not verify the load.

                  +

                  Default value:

                  +

                  true

                  agency

                  +

                  agency

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Agency name. You can create an agency to allow CSS to call other cloud services.

                  +

                  Definition:

                  +

                  Agency name. You can create an agency to allow CSS to call other cloud services.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  cluster_load_check

                  +

                  cluster_load_check

                  No

                  +

                  No

                  Boolean

                  +

                  Boolean

                  Indicates whether to verify the load. The default value is true.

                  -
                  • true: Verify the load.

                    -
                  • false: Do not verify the load.

                    +

                  Definition:

                  +

                  Indicates whether to verify the load.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +
                  • true: Verify the load.

                    +
                  • false: Do not verify the load.

                  +

                  Default value:

                  +

                  true

                  batch_size

                  +

                  batch_size

                  No

                  +

                  No

                  Integer

                  +

                  Integer

                  Data migration concurrency in terms of the number of data nodes.

                  +

                  Definition:

                  +

                  Data migration concurrency in terms of the number of data nodes.

                  +

                  Constraints:

                  +

                  N/A

                  +

                  Value range:

                  +

                  N/A

                  +

                  Default value:

                  +

                  N/A

                  -

                  Response Parameters

                  None

                  +

                  Response Parameters

                  Status code: 200

                  +

                  Request succeeded.

                  +

                  None

                  -

                  Example Requests

                  Update a cluster version.

                  -
                  POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/inst-type/all/image/upgrade
                  +

                  Example Requests

                  Update a cluster version.

                  +
                  POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/inst-type/all/image/upgrade
                   
                   {
                     "target_image_id" : "{target_image_id}",
                  @@ -138,42 +202,42 @@
                     "cluster_load_check" : true
                   }
                  -

                  Example Responses

                  None

                  +

                  Example Responses

                  None

                  -

                  Status Codes

                  -

                  Status Code

                  +

                  Status Codes

                  +
                  - - - - - - - - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  -

                  The client should not repeat the request without modifications.

                  +

                  Invalid request.

                  +

                  The client should not repeat the request without modifications.

                  409

                  +

                  409

                  The request cannot be processed due to a conflict.

                  -

                  This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

                  +

                  The request cannot be processed due to a conflict.

                  +

                  This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

                  412

                  +

                  412

                  The server did not meet one of the preconditions contained in the request.

                  +

                  The server did not meet one of the preconditions contained in the request.

                  -

                  Error Codes

                  See Error Codes.

                  +

                  Error Codes

                  See Error Codes.

                  diff --git a/docs/css/api-ref/UpgradeDetail.html b/docs/css/api-ref/UpgradeDetail.html index d116639c3..ace51a94f 100644 --- a/docs/css/api-ref/UpgradeDetail.html +++ b/docs/css/api-ref/UpgradeDetail.html @@ -1,48 +1,50 @@

                  Obtaining Details About a Cluster Upgrade or AZ Switchover

                  -

                  Function

                  The upgrade may take a long time. This API can be used to check phase-by-phase information during a cluster upgrade or AZ switchover.

                  +

                  Function

                  By deploying a CSS cluster across multiple AZs, you can increase the cluster's availability, lower the likelihood of data loss, and minimize service downtime. You can deploy a cluster across two or three AZs within a region. The upgrade may take a long time. This API can be used to check phase-by-phase information during a cluster upgrade or AZ switchover.

                  -

                  URI

                  GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detail

                  +

                  Calling Method

                  For details, see Calling APIs.

                  +
                  +

                  URI

                  GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detail

                  -
                  Table 1 Path Parameters

                  Parameter

                  +
                  - - - - - - - - - - - @@ -51,64 +53,64 @@
                  Table 1 Path Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  project_id

                  +

                  project_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Parameter description:

                  -

                  The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Definition:

                  +

                  Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  Constraints:

                  N/A

                  -

                  Options:

                  -

                  For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

                  +

                  Value range:

                  +

                  Project ID of the account.

                  Default value:

                  N/A

                  cluster_id

                  +

                  cluster_id

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  Parameter description:

                  -

                  ID of the cluster to be upgraded.

                  +

                  Definition:

                  +

                  ID of the cluster to be upgraded. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  Constraints:

                  N/A

                  -

                  Options:

                  -

                  For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

                  +

                  Value range:

                  +

                  Cluster ID.

                  Default value:

                  N/A

                  -
                  Table 2 Query Parameters

                  Parameter

                  +
                  - - - - - - - - - - - - - - - @@ -119,292 +121,349 @@

                  Response Parameters

                  Status code: 200

                  -
                  Table 2 Query Parameters

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  start

                  +

                  offset

                  No

                  +

                  No

                  Integer

                  +

                  Integer

                  Parameter description:

                  +

                  Definition:

                  The start value of the query. The default value is 1, indicating that the query starts from the first task.

                  Constraints:

                  N/A

                  -

                  Options:

                  +

                  Value range:

                  1-1000

                  Default value:

                  1

                  limit

                  +

                  limit

                  No

                  +

                  No

                  Integer

                  +

                  Integer

                  Parameter description:

                  -

                  Number of tasks to be queried. The default value is 10, indicating that 10 tasks are queried at a time.

                  +

                  Definition:

                  +

                  Number of AZs to be queried. The default value is 10, indicating that 10 AZs are queried at a time.

                  Constraints:

                  N/A

                  -

                  Options:

                  +

                  Value range:

                  1-1000

                  Default value:

                  10

                  action_mode

                  +

                  action_mode

                  No

                  +

                  No

                  String

                  +

                  String

                  Parameter description:

                  -

                  Query details about a cluster upgrade or AZ switchover.

                  +

                  Definition:

                  +

                  Query details about a cluster upgrade or AZ change operation.

                  Constraints:

                  N/A

                  -

                  Options:

                  +

                  Value range:

                  • UPGRADING: query cluster upgrade details.

                    -
                  • AZ_MIGRATION: query AZ switchover details.

                    +
                  • AZ_MIGRATION: query AZ change details.

                    +

                  Default value:

                  UPGRADING

                  -
                  Table 3 Response body parameters

                  Parameter

                  +
                  - - - - - - - -
                  Table 3 Response body parameters

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  totalSize

                  +

                  totalSize

                  Integer

                  +

                  Integer

                  Parameter description:

                  -

                  Total number of tasks.

                  +

                  Definition:

                  +

                  Total number of cluster upgrade or AZ change tasks.

                  +

                  Value range:

                  +

                  N/A

                  detailList

                  +

                  detailList

                  Array of GetUpgradeDetailInfo objects

                  +

                  Array of GetUpgradeDetailInfo objects

                  Parameter description:

                  -

                  Details about the upgrade or AZ switchover task.

                  +

                  Definition:

                  +

                  Details of cluster upgrade or AZ change tasks.

                  +

                  Value range:

                  +

                  N/A

                  -
                  Table 4 GetUpgradeDetailInfo

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 4 GetUpgradeDetailInfo

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Parameter description:

                  -

                  Task ID

                  +

                  Definition:

                  +

                  ID of the upgrade or AZ change task.

                  +

                  Value range:

                  +

                  N/A

                  startTime

                  +

                  startTime

                  String

                  +

                  String

                  Parameter description:

                  -

                  Task start time.

                  +

                  Definition:

                  +

                  Start time of an upgrade or AZ change task.

                  +

                  Value range:

                  +

                  N/A

                  endTime

                  +

                  endTime

                  String

                  +

                  String

                  Parameter description:

                  -

                  End time of a job.

                  +

                  Definition:

                  +

                  End time of an upgrade or AZ change task.

                  +

                  Value range:

                  +

                  N/A

                  status

                  +

                  status

                  String

                  +

                  String

                  Parameter description:

                  -

                  Task status.

                  -

                  Options:

                  +

                  Definition:

                  +

                  Status of an upgrade or AZ change task.

                  +

                  Value range:

                  • RUNNING: The task is being executed.

                  • SUCCESS: The task is successful.

                    -
                  • FAILED: The job failed.

                    +
                  • FAILED: The job failed.

                  • PARTIAL_FAILED: The task failed partially.

                  agencyName

                  +

                  agencyName

                  String

                  +

                  String

                  Parameter description:

                  +

                  Definition:

                  Agency name. You can create an agency to allow CSS to call other cloud services.

                  +

                  Value range:

                  +

                  N/A

                  imageInfo

                  +

                  imageInfo

                  GetTargetImageIdDetail object

                  +

                  GetTargetImageIdDetail object

                  Parameter description:

                  +

                  Definition:

                  Image details.

                  +

                  Value range:

                  +

                  N/A

                  totalNodes

                  +

                  totalNodes

                  String

                  +

                  String

                  Parameter description:

                  +

                  Definition:

                  Names of all nodes that need to be upgraded or switched to another AZ.

                  +

                  Value range:

                  +

                  N/A

                  completedNodes

                  +

                  completedNodes

                  String

                  +

                  String

                  Parameter description:

                  -

                  Names of all nodes that have been upgraded or switched to another AZ.

                  +

                  Definition:

                  +

                  Nodes where upgrade or AZ change tasks have been completed.

                  +

                  Value range:

                  +

                  N/A

                  currentNodeName

                  +

                  currentNodeName

                  String

                  +

                  String

                  Parameter description:

                  +

                  Definition:

                  Name of the node that is being upgraded or switched to another AZ.

                  +

                  Value range:

                  +

                  N/A

                  executeTimes

                  +

                  executeTimes

                  String

                  +

                  String

                  Parameter description:

                  -

                  Retry times.

                  +

                  Definition:

                  +

                  Number of times the upgrade or AZ change task was retried.

                  +

                  Value range:

                  +

                  N/A

                  migrateParam

                  +

                  migrateParam

                  String

                  +

                  String

                  Parameter description:

                  -

                  This parameter is available only when action_mode is set to AZ_MIGRATION. It indicates the request parameter of the AZ switchover task.

                  +

                  Definition:

                  +

                  This parameter is available only when action_mode is set to AZ_MIGRATION. It indicates the request parameter of the AZ change task.

                  +

                  Value range:

                  +

                  N/A

                  finalAzInfoMap

                  +

                  finalAzInfoMap

                  String

                  +

                  String

                  Parameter description:

                  +

                  Definition:

                  This parameter is available only when action_mode is set to AZ_MIGRATION. It indicates the AZ details of each node after AZ switchover.

                  +

                  Value range:

                  +

                  N/A

                  currentNodeDetail

                  +

                  currentNodeDetail

                  Array of CurrentNodeDetail objects

                  +

                  Array of CurrentNodeDetail objects

                  Parameter description:

                  +

                  Definition:

                  Task details of the node that is being upgraded or switched to another AZ.

                  +

                  Value range:

                  +

                  N/A

                  batchSize

                  +

                  batchSize

                  Integer

                  +

                  Integer

                  Parameter description:

                  +

                  Definition:

                  Number of nodes where data is being migrated concurrently.

                  +

                  Value range:

                  +

                  N/A

                  currentBatchNodes

                  +

                  currentBatchNodes

                  String

                  +

                  String

                  Parameter description:

                  +

                  Definition:

                  Nodes where data is being migrated.

                  +

                  Value range:

                  +

                  N/A

                  -
                  Table 5 GetTargetImageIdDetail

                  Parameter

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 5 GetTargetImageIdDetail

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  id

                  +

                  id

                  String

                  +

                  String

                  Parameter description:

                  +

                  Definition:

                  ID of an image that can be upgraded.

                  +

                  Value range:

                  +

                  N/A

                  displayName

                  +

                  displayName

                  String

                  +

                  String

                  Parameter description:

                  +

                  Definition:

                  Name of an image that can be upgraded.

                  +

                  Value range:

                  +

                  N/A

                  imageDesc

                  +

                  imageDesc

                  String

                  +

                  String

                  Parameter description:

                  +

                  Definition:

                  Image description.

                  +

                  Value range:

                  +

                  N/A

                  datastoreType

                  +

                  datastoreType

                  String

                  +

                  String

                  Parameter description:

                  -

                  Image engine type.

                  -

                  datastoreVersion

                  -

                  String

                  -

                  Parameter description:

                  -

                  Image engine version.

                  -

                  priority

                  -

                  Integer

                  -

                  Parameter description:

                  -

                  Priority of the target image. A larger value indicates a higher priority.

                  -
                  -
                  - -
                  - - - - - - - - - - - - - - - - - - - - - - +
                  Table 6 CurrentNodeDetail

                  Parameter

                  -

                  Type

                  -

                  Description

                  -

                  order

                  -

                  Integer

                  -

                  Parameter description:

                  -

                  SN of the upgrade or AZ switchover task.

                  -

                  name

                  -

                  String

                  -

                  Parameter description:

                  -

                  Name of the upgrade or AZ switchover task.

                  -

                  status

                  -

                  String

                  -

                  Parameter description:

                  -

                  Current task status.

                  -

                  Options:

                  -
                  • RUNNING: The task is running.

                    -
                  • SUCCESS: The task has succeeded.

                    -
                  • FAILED: The task failed.

                    -
                  • WAITING: The task is waiting for execution.

                    +

                  Definition:

                  +

                  Cluster engine type.

                  +

                  Value range:

                  +
                  • elasticsearch: Cloud Search Service (CSS) provides distributed search capabilities, log analytics, reporting, and semantic search based on open-source Elasticsearch.

                    +
                  • logstash: Provides functions such as data ingestion, transformation, cleaning, and parsing based on open-source Logstash.

                    +
                  • opensearch: Provides distributed search, log analytics, reporting, and semantic search based on open-source OpenSearch. It is the future version of CSS's Elasticsearch clusters.

                  desc

                  +

                  datastoreVersion

                  String

                  +

                  String

                  Parameter description:

                  -

                  Description of the current task.

                  +

                  Definition:

                  +

                  Image engine version.

                  +

                  Value range:

                  +

                  N/A

                  beginTime

                  +

                  priority

                  String

                  +

                  Integer

                  Parameter description:

                  -

                  Start time of the current task.

                  +

                  Definition:

                  +

                  Priority of the target image. A larger value indicates a higher priority.

                  +

                  Value range:

                  +

                  N/A

                  endTime

                  +
                  +
                  + +
                  + + + + + - - + + + + + + + + + + + + + + + + + + + + @@ -412,14 +471,14 @@

                  Example Requests

                  • Query cluster upgrade details.

                    -
                    GET https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail
                    -
                  • Example of an AZ switchover.

                    -
                    GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail?action_mode=AZ_MIGRATION
                    +
                    GET https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail
                    +
                  • Query details about a cluster AZ change task.

                    +
                    GET https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail?action_mode=AZ_MIGRATION

                  Example Responses

                  Status code: 200

                  Request succeeded.

                  -
                  • Example of a cluster image upgrade response.

                    +
                    • Example response for querying cluster upgrade details.

                      {
                         "totalSize" : 1,
                         "detailList" : [ {
                      @@ -457,7 +516,7 @@
                           } ]
                         } ]
                       }
                      -
                    • Example of an AZ switchover response.

                      +
                    • Example response for querying cluster AZ change details.

                      {
                         "totalSize" : 1,
                         "detailList" : [ {
                      @@ -492,26 +551,26 @@
                       

                  Status Codes

                  -
                  Table 6 CurrentNodeDetail

                  Parameter

                  +

                  Type

                  +

                  Description

                  +

                  order

                  String

                  +

                  Integer

                  Parameter description:

                  -

                  End time of the current task.

                  +

                  Definition:

                  +

                  SN of the upgrade or AZ switchover task.

                  +

                  Value range:

                  +

                  N/A

                  +

                  name

                  +

                  String

                  +

                  Definition:

                  +

                  Name of the upgrade or AZ switchover task.

                  +

                  Value range:

                  +

                  N/A

                  +

                  status

                  +

                  String

                  +

                  Definition:

                  +

                  Status of the upgrade or AZ change task of the current cluster.

                  +

                  Value range:

                  +
                  • RUNNING: running

                    +
                  • SUCCESS

                    +
                  • FAILED

                    +
                  • WAITING

                    +
                  +

                  desc

                  +

                  String

                  +

                  Definition:

                  +

                  Description of the upgrade or AZ change task of the current cluster.

                  +

                  Value range:

                  +

                  N/A

                  +

                  beginTime

                  +

                  String

                  +

                  Definition:

                  +

                  Start time of the upgrade or AZ change task of the current cluster.

                  +

                  Value range:

                  +

                  N/A

                  +

                  endTime

                  +

                  String

                  +

                  Definition:

                  +

                  End time of the upgrade or AZ change task of the current cluster.

                  +

                  Value range:

                  +

                  N/A

                  Status Code

                  +
                  - - - - - - - diff --git a/docs/css/api-ref/cluster_management.html b/docs/css/api-ref/cluster_management.html index aae9c4bbb..20b01965c 100644 --- a/docs/css/api-ref/cluster_management.html +++ b/docs/css/api-ref/cluster_management.html @@ -5,51 +5,43 @@
                  diff --git a/docs/css/api-ref/cluster_management_0.html b/docs/css/api-ref/cluster_management_0.html new file mode 100644 index 000000000..5b6cc2a1e --- /dev/null +++ b/docs/css/api-ref/cluster_management_0.html @@ -0,0 +1,22 @@ + + +

                  Cluster Management

                  +

                  +
                  + + diff --git a/docs/css/api-ref/css_03_0001.html b/docs/css/api-ref/css_03_0001.html index a06c61bc3..ecfd6d427 100644 --- a/docs/css/api-ref/css_03_0001.html +++ b/docs/css/api-ref/css_03_0001.html @@ -40,13 +40,13 @@ -

                  Supported versions

                  In CSS, Elasticsearch 7.6.2, 7.9.3, and 7.10.2 and Kibana 7.6.2, 7.9.3, and 7.10.2 are supported.

                  +

                  Supported versions

                  In CSS, Elasticsearch 7.6.2, 7.9.3, and 7.10.2; Kibana 7.6.2, 7.9.3, and 7.10.2; and OpenSearch 1.3.6 and 2.19.0 are supported.

                  Restrictions and Limitations

                  • For more constraints, see the API descriptions.

                  Regions and Endpoints

                  -

                  An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For more information, see Regions and Endpoints.

                  +

                  An endpoint is the request address for calling an API. Endpoints vary with services and regions. For the endpoints of all services, see Regions and Endpoints.

                  Concepts

                  • Account

                    An account is created upon successful registration with the cloud system. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, which should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.

                  • User

                    An IAM user is created under an account to use cloud services. Each user has its own identity credentials (password and access keys).

                    diff --git a/docs/css/api-ref/css_03_0024.html b/docs/css/api-ref/css_03_0024.html index d418fade8..f2973bc90 100644 --- a/docs/css/api-ref/css_03_0024.html +++ b/docs/css/api-ref/css_03_0024.html @@ -9,7 +9,12 @@ -
                  + + + diff --git a/docs/css/api-ref/css_03_0057.html b/docs/css/api-ref/css_03_0057.html index 3a08d7997..31ad9cee0 100644 --- a/docs/css/api-ref/css_03_0057.html +++ b/docs/css/api-ref/css_03_0057.html @@ -1,492 +1,471 @@

                  API Overview

                  -

                  CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 1 by calling the corresponding APIs.

                  - -

                  Status Code

                  Description

                  +

                  Description

                  200

                  +

                  200

                  Request succeeded.

                  +

                  Request succeeded.

                  400

                  +

                  400

                  Invalid request.

                  +

                  Invalid request.

                  The client should not repeat the request without modifications.

                  403

                  +

                  403

                  Request rejected.

                  +

                  Request rejected.

                  The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

                  2025-04-10

                  +

                  2025-11-15

                  +

                  OpenSearch 2.19.0 is supported.

                  +

                  2025-04-10

                  Modified parameter descriptions for the following APIs:

                  • Adding Master and Client Nodes
                  • Deleting a cluster
                  • Restarting a cluster
                  • Changing the specifications of a specified node type
                  • Removing nodes of a specific type
                  • Modifying resource specifications
                  • Scaling in a cluster by removing specified nodes
                  • Replacing nodes
                  • Changing the security group
                  • Rolling restart
                  • Updating cluster routes
                  • Enabling public network access
                  • Disabling public network access
                  • (Not recommended) Automatically configuring basic settings of a cluster snapshot
                  • Deleting a snapshot
                  • Disabling the VPC endpoint service
                  • Modifying parameter configurations
                  • Disabling Kibana public network access
                  @@ -224,7 +229,7 @@
                • Modified the URI format. Added the status code returned by the API for obtaining the list of instance flavors.

                  Obtaining the instance specifications list

                • Modified the function description. Modified the example request. Added the status code returned by the API for automatically performing basic configurations for a cluster snapshot.

                  (Not recommended) Automatically configuring basic settings of a cluster snapshot

                • Modified the description about the indices parameter in the request parameter table. Changed parameter names bakExpectedStartTime, bakKeepDay, and bakPeriod in the table of backup field data structure description. Modified the example response. Added the status code returned by the API for manually creating a cluster snapshot.

                  Manually creating a snapshot

                  -
                • Changed parameter names bakExpectedStartTime, bakKeepDay, and bakPeriod in the table of backups field data structure description. Modified the example response. Added the status code returned by the API for querying the list of snapshots.

                  Querying the snapshot list

                  +
                • Changed parameter names bakExpectedStartTime, bakKeepDay, and bakPeriod in the table that describes the backups field structure. Modified the example response. Added the status code returned by the API for querying the list of snapshots.

                  Querying the snapshot list

                • Modified the description in the request parameter table. Added the status code returned by the API for restoring snapshots.

                  Restoring a snapshot

                • Added the handling method for each error code.
                • Table 1 API description

                  Type

                  +

                  CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 2 by calling the corresponding APIs.

                  +

                  Some APIs of V2 have been released. You are advised to use APIs of V2 preferentially.

                  +
                  +

                  APIs of V2

                  +
                  - - - - - - - - - - - - +
                  Table 1 Description of APIs of version V2

                  API

                  Description

                  +

                  Description

                  Cluster Management APIs

                  +

                  Creating a Cluster (V2)

                  Create clusters, scale out clusters, view cluster details, and obtain instance specifications.

                  +

                  This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, and ess-master).

                  Kibana Public Network Access APIs

                  +

                  Restarting a Cluster (V2)

                  Enable, disable, and modify Kibana public network access for a security-mode cluster.

                  +

                  This API is used to restart nodes of all node types or the combination of some node types in the current cluster.

                  Log Management APIs

                  +

                  Rolling Start

                  Enable, disable, modify, and query logs.

                  +

                  This API is used to restart nodes one by one, which requires a long time if the nodes have a large number of indexes.

                  Public Network Access APIs

                  +

                  Enabling Automatic Snapshot Creation

                  Enable, disable, and modify public network access for a cluster.

                  +

                  This API is used to enable automatic snapshot creation.

                  Snapshot Management APIs

                  +

                  Disabling Automatic Snapshot Creation

                  Snapshots can be used to back up and restore data. You can use snapshot management APIs to create, restore, or delete snapshots.

                  +

                  This API is used to disable automatic snapshot creation.

                  VPC Endpoint APIs

                  +
                  +
                  +
                  +

                  APIs of V1

                  +
                  + + + + - - - - - + + + + + + + + + + + + + + +
                  Table 2 Description of APIs of version V1

                  API

                  +

                  Description

                  +

                  Cluster Management APIs

                  Enable, disable, obtain, and update VPC endpoint connections.

                  +

                  Create clusters, scale out clusters, view cluster details, and obtain instance specifications.

                  Parameter Configuration APIs

                  +

                  Kibana Public Network Access APIs

                  Modify the parameter settings of a cluster.

                  +

                  Enable, disable, and modify Kibana public network access for a security-mode cluster.

                  Load Balancer APIs

                  +

                  Log Management APIs

                  Enable or disable load balancers, or obtain load balancer information.

                  +

                  Enable, disable, modify, and query logs.

                  +

                  Public Network Access APIs

                  +

                  Enable, disable, and modify public network access for a cluster.

                  +

                  Snapshot Management APIs

                  +

                  Create, restore, and delete snapshots. Snapshots are a convenient way to back up and restore data.

                  +

                  VPC Endpoint APIs

                  +

                  Enable, disable, obtain, and update VPC endpoint connections.

                  +

                  Parameter Configuration APIs

                  +

                  Modify the parameter settings of a cluster.

                  +

                  Load Balancer APIs

                  +

                  Enable or disable load balancers, or obtain load balancer information.

                  -
                  Table 2 Cluster management APIs

                  API

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 3 Cluster management APIs

                  API

                  Description

                  +

                  Description

                  Creating a Cluster

                  +

                  Creating a Cluster

                  This API is used to create a cluster.

                  +

                  This API is used to create a cluster.

                  Querying the List of Clusters

                  +

                  Querying the List of Clusters

                  This API is used to query and display the cluster list and cluster status.

                  +

                  This API is used to query and display the cluster list and cluster status.

                  Querying Cluster Details

                  +

                  Querying Cluster Details

                  This API is used to query and display the details of a cluster.

                  +

                  This API is used to query and display the details of a cluster.

                  Deleting a Cluster

                  +

                  Deleting a Cluster

                  This API is used to delete clusters.

                  +

                  This API is used to delete a cluster.

                  Changing the Cluster Name

                  +

                  Changing the Cluster Name

                  This API is used to change the name of a cluster.

                  +

                  This API is used to change the name of a cluster.

                  Changing the Cluster Password

                  +

                  Changing the Cluster Password

                  This API is used to change the password of a cluster.

                  +

                  This API is used to change the password of a cluster.

                  Restarting a Cluster

                  +

                  Updating Cluster Routes

                  This API is used to restart a cluster. Services will be interrupted during the restart.

                  +

                  This API is used to update cluster routes.

                  Scaling Out a Cluster

                  +

                  Obtaining a Cluster Route

                  This API is used to add instances (Elasticsearch instances only) to a cluster.

                  +

                  This API is used to obtain a cluster route.

                  Adding Instances and Expanding Instance Storage Capacity

                  +

                  Restarting a Cluster

                  This API is used to add instances of different types and expand instance storage capacity in a cluster.

                  +

                  This API is used to restart a cluster. Services will be interrupted during the restart.

                  Changing Specifications

                  +

                  Downloading a Security Certificate

                  This API is used to modify the specifications of a cluster.

                  +

                  This API is used to download a security certificate.

                  Obtaining the Instance Specifications List

                  +

                  Upgrading a Cluster Kernel

                  This API is used to query and display the IDs of supported instance specifications.

                  +

                  This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.

                  Querying All Tags

                  +

                  Obtaining the ID of the Target Image to Upgrade To

                  This API is used to query all tags in a specified region.

                  +

                  This API is used to obtain the ID of an image that the current cluster can be upgraded to.

                  Querying Tags of a Specified Cluster

                  +

                  Obtaining Details About a Cluster Upgrade or AZ Switchover

                  This API is used to query the tag information about a specified cluster.

                  +

                  An upgrade may take a long time. This API can be used to check phase-by-phase information during a cluster upgrade or AZ switchover.

                  Adding Tags to a Cluster

                  +

                  Retrying a Failed Upgrade Task

                  This API is used to add tags to a cluster.

                  +

                  If an upgrade takes too long, there is a chance that it has already failed due to connectivity issues. You can call this API to retry the upgrade or terminate its impact.

                  Deleting the Tags of a Cluster

                  +

                  Changing the Subnet of a Cluster

                  This API is used to delete the tags of a cluster.

                  +

                  This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.

                  Adding or Deleting Cluster Tags in Batches

                  +

                  Changing the AZ of a Cluster Instance

                  This API is used to add tags to or delete tags from a cluster in batches.

                  -

                  Changing the Specifications of a Specified Node Type

                  -

                  This API is used to modify cluster specifications. Nodes of the ess, ess-cold, ess-client, and ess-master types can be modified.

                  -

                  Removing Specified Nodes

                  -

                  This API is used to scale in a cluster by removing specified nodes.

                  -

                  Scaling In Nodes of a Specific Type

                  -

                  This API is used to remove instances of different types and reduce instance storage capacity in a cluster.

                  -

                  Replacing a Node

                  -

                  This API is used to replace a failed node.

                  -

                  Changing the Security Group

                  -

                  This API is used to change the security group after a cluster is created.

                  -

                  Modifying the Security Mode

                  -

                  This API is used to switch the security mode of a cluster.

                  -

                  Adding Master and Client Nodes

                  -

                  This API is used to add a master or client node.

                  -

                  Downloading a Security Certificate

                  -

                  This API is used to download a security certificate.

                  -

                  Creating a Cluster (V2)

                  -

                  This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, and ess-master).

                  -

                  Restarting a Cluster (V2)

                  -

                  This API is used to restart nodes of all node types or the combination of some node types in the current cluster.

                  -

                  Rolling Restart

                  -

                  This API is used to restart nodes one by one, which requires a long time if the nodes have a large number of indexes.

                  +

                  This API is used to change AZs by specifying node types.

                  -
                  Table 3 Kibana public network access APIs

                  API

                  +
                  - - - - - - - - - - -
                  Table 4 Kibana public network access APIs

                  API

                  Description

                  +

                  Description

                  Enabling Kibana Public Access

                  +

                  Enabling Kibana Public Access

                  This API is used to enable public network access to Kibana.

                  +

                  This API is used to enable public network access to Kibana.

                  Disabling Kibana Public Access

                  +

                  Disabling Kibana Public Access

                  This API is used to disable public network access to Kibana.

                  +

                  This API is used to disable public network access to Kibana.

                  Modifying the Kibana Public Network Bandwidth

                  +

                  Modifying the Kibana Public Network Bandwidth

                  This API is used to modify the public network bandwidth of Kibana.

                  +

                  This API is used to modify the public network bandwidth of Kibana.

                  Modifying Kibana Public Network Access Control

                  +

                  Modifying Kibana Public Network Access Control

                  This API is used to modify the Kibana public network access whitelist.

                  +

                  This API is used to modify the Kibana public network access whitelist.

                  Disabling Kibana Public Network Access Control

                  +

                  Disabling Kibana Public Network Access Control

                  This API is used to disable the Kibana public network access whitelist.

                  +

                  This API is used to disable the Kibana public network access whitelist.

                  -
                  Table 4 Log management APIs

                  API

                  +
                  - - - - - - - - - - - - - - - - - - - + + +
                  Table 5 Log management APIs

                  API

                  Description

                  +

                  Description

                  Enabling the Log Function

                  +

                  Enabling the Log Function

                  This API is used to enable the log management function.

                  +

                  This API is used to enable the log management function.

                  Disabling Logging

                  +

                  Disabling Logging

                  This API is used to disable the log management function.

                  +

                  This API is used to disable the log management function.

                  Querying the Job List

                  +

                  Querying the Job List

                  This API is used to query the job list in the logs of a cluster.

                  +

                  This API is used to query the job list in the logs of a cluster.

                  Querying Basic Log Configurations

                  +

                  Querying Basic Log Configurations

                  This API is used to query basic log configurations.

                  +

                  This API is used to query basic log configurations.

                  Modifying Basic Log Configurations

                  +

                  Modifying Basic Log Configurations

                  This API is used to modify basic log configurations.

                  +

                  This API is used to modify basic log configurations.

                  Enabling the Automatic Log Backup Policy

                  +

                  Enabling an Automatic Log Backup Policy

                  This API is used to enable the automatic log backup policy.

                  +

                  This API is used to enable an automatic log backup policy.

                  Disabling the Automatic Log Backup Policy

                  +

                  Disabling an Automatic Log Backup Policy

                  This API is used to disable the automatic log backup policy.

                  +

                  This API is used to disable an automatic log backup policy.

                  Backing Up Logs

                  +

                  Backing Up Logs

                  This API is used to back up logs.

                  +

                  This API is used to back up logs.

                  Querying Logs

                  +

                  Querying Logs

                  This API is used to query log information.

                  +

                  This API is used to query log information.

                  +

                  Testing Connectivity

                  +

                  This API is used to test the connectivity between two clusters.

                  -
                  Table 5 Public network access APIs

                  API

                  +
                  - - - - - - - - - - -
                  Table 6 Public network access APIs

                  API

                  Description

                  +

                  Description

                  Enabling Public Network Access

                  +

                  Enabling Public Network Access

                  This API is used to enable public network access.

                  +

                  This API is used to enable public network access.

                  Disabling Public Network Access

                  +

                  Disabling Public Network Access

                  This API is used to disable public network access.

                  +

                  This API is used to disable public network access.

                  Modifying Public Network Access Bandwidth

                  +

                  Modifying Public Network Access Bandwidth

                  This API is used to modify the public network access bandwidth.

                  +

                  This API is used to modify the public network access bandwidth.

                  Enabling the Public Network Access Control Whitelist

                  +

                  Enabling the Public Network Access Control Whitelist

                  This API is used to enable the public network access control whitelist.

                  +

                  This API is used to enable the public network access control whitelist.

                  Disabling the Public Network Access Control Whitelist

                  +

                  Disabling the Public Network Access Control Whitelist

                  This API is used to disable the public network access control whitelist.

                  +

                  This API is used to disable the public network access control whitelist.

                  -
                  Table 6 Snapshot management APIs

                  API

                  +
                  - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 7 Snapshot management APIs

                  API

                  Description

                  +

                  Description

                  (Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot

                  +

                  (Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot

                  This API is used to automatically configure basic settings of a cluster snapshot, including configuring OBS buckets and IAM agency.

                  +

                  This API is used to automatically configure basic settings of a cluster snapshot, including configuring OBS buckets and IAM agency.

                  Modifying Basic Configurations of a Cluster Snapshot

                  +

                  Modifying Basic Configurations of a Cluster Snapshot

                  This API is used to modify the basic configurations of a cluster snapshot, including OBS buckets and IAM agency.

                  +

                  This API is used to modify the basic configurations of a cluster snapshot, including OBS buckets and IAM agency.

                  Manually Creating a Snapshot

                  +

                  Manually Creating a Snapshot

                  This API is used to manually create a snapshot.

                  +

                  This API is used to manually create a snapshot.

                  Restoring a Snapshot

                  +

                  Restoring a Snapshot

                  This API is used to manually restore a snapshot.

                  +

                  This API is used to manually restore a snapshot.

                  Deleting a Snapshot

                  +

                  Deleting a Snapshot

                  This API is used to delete a snapshot.

                  +

                  This API is used to delete a snapshot.

                  Setting the Automatic Snapshot Creation Policy

                  +

                  Setting the Automatic Snapshot Creation Policy

                  This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.

                  +

                  This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.

                  Querying the Automatic Snapshot Creation Policy

                  +

                  Querying the Automatic Snapshot Creation Policy

                  This API is used to query the automatic snapshot creation policy of a cluster.

                  +

                  This API is used to query the automatic snapshot creation policy of a cluster.

                  Querying the Snapshot List

                  +

                  Querying the Snapshot List

                  This API is used to query the snapshot list of a specified cluster.

                  +

                  This API is used to query the snapshot list of a specified cluster.

                  Disabling the Snapshot Function

                  +

                  Disabling the Snapshot Function

                  This API is used to disable the snapshot function.

                  -

                  Enabling Automatic Snapshot Creation

                  -

                  This API is used to enable the automatic snapshot creation function.

                  -

                  Disabling Automatic Snapshot Creation

                  -

                  This API is used to disable the automatic snapshot creation function.

                  +

                  This API is used to disable the snapshot function.

                  -
                  Table 7 VPC endpoint APIs

                  API

                  +
                  - - - - - - - - - - -
                  Table 8 VPC endpoint APIs

                  API

                  Description

                  +

                  Description

                  Enabling the VPC Endpoint Service

                  +

                  Enabling the VPC Endpoint Service

                  This API is used to enable the VPC endpoint service.

                  +

                  This API is used to enable the VPC endpoint service.

                  Disabling the VPC Endpoint Service

                  +

                  Disabling the VPC Endpoint Service

                  This API is used to disable the VPC endpoint service.

                  +

                  This API is used to disable the VPC endpoint service.

                  Obtaining a VPC Endpoint Connection

                  +

                  Obtaining a VPC Endpoint Connection

                  This API is used to obtain a VPC endpoint connection.

                  +

                  This API is used to obtain a VPC endpoint connection.

                  Updating a VPC Endpoint Connection

                  +

                  Updating a VPC Endpoint Connection

                  This API is used to update a VPC endpoint connection.

                  +

                  This API is used to update a VPC endpoint connection.

                  Modifying the Endpoint Service Whitelist

                  +

                  Modifying the Endpoint Service Whitelist

                  This API is used to modify the endpoint service whitelist.

                  +

                  This API is used to modify the endpoint service whitelist.

                  -
                  Table 8 Parameter configuration APIs

                  API

                  +
                  - - - - - - -
                  Table 9 Parameter configuration APIs

                  API

                  Description

                  +

                  Description

                  Modifying Parameter Settings

                  +

                  Modifying Parameter Settings

                  This API is used to modify parameters.

                  +

                  This API is used to modify parameters.

                  Obtaining the Task List of Parameter Configurations

                  +

                  Obtaining the Task List of Parameter Configurations

                  This API is used to obtain the task list of parameter configurations.

                  +

                  This API is used to obtain the task list of parameter configurations.

                  Obtaining the Parameter Configuration List

                  +

                  Obtaining the Parameter Configuration List

                  This API is used to obtain the parameter configuration list of the current cluster.

                  +

                  This API is used to obtain the parameter configuration list of the current cluster.

                  -
                  - - - - - - - - - - - - - - - - - - diff --git a/docs/css/api-ref/en-us_topic_0000002083557490.html b/docs/css/api-ref/css_03_0095.html similarity index 56% rename from docs/css/api-ref/en-us_topic_0000002083557490.html rename to docs/css/api-ref/css_03_0095.html index f557563f6..e327aa948 100644 --- a/docs/css/api-ref/en-us_topic_0000002083557490.html +++ b/docs/css/api-ref/css_03_0095.html @@ -1,9 +1,9 @@ - +

                  Examples

                  -

                  +

                  diff --git a/docs/css/api-ref/css_03_0101.html b/docs/css/api-ref/css_03_0101.html index 8068f2a59..653791293 100644 --- a/docs/css/api-ref/css_03_0101.html +++ b/docs/css/api-ref/css_03_0101.html @@ -65,7 +65,10 @@ "period" : true } ] } -

                  Obtaining the Cluster ID from the GaussDB(DWS) Console

                  1. Log in to the CSS management console.
                  2. In the navigation pane on the left, click Clusters.
                  3. In the cluster list, find the target cluster and click the cluster name. The Cluster Information page is displayed.
                  4. Check the cluster ID under cluster information.
                    Figure 1 Checking the cluster ID
                    +

                    Obtaining the Cluster ID from the GaussDB(DWS) Console

                    1. Log in to the CSS management console.
                    2. In the navigation pane on the left, click Clusters.
                    3. In the cluster list, find the cluster and copy the cluster ID in the Name/ID column.
                      Figure 1 Copying the cluster ID
                      +

                      +
                    4. Alternatively, click the cluster name to go to its details page.
                    5. Check the cluster ID under cluster information.
                      Figure 2 Checking the cluster ID
                      +

                  diff --git a/docs/css/api-ref/css_03_0102.html b/docs/css/api-ref/css_03_0102.html new file mode 100644 index 000000000..f4a6288fd --- /dev/null +++ b/docs/css/api-ref/css_03_0102.html @@ -0,0 +1,17 @@ + + + +

                  API V2

                  + +

                  +
                  + + + diff --git a/docs/css/api-ref/css_03_0097.html b/docs/css/api-ref/css_03_0105.html similarity index 74% rename from docs/css/api-ref/css_03_0097.html rename to docs/css/api-ref/css_03_0105.html index ac36eb14b..fb2f8e8a3 100644 --- a/docs/css/api-ref/css_03_0097.html +++ b/docs/css/api-ref/css_03_0105.html @@ -1,14 +1,15 @@ - + -

                  APIs

                  -

                  + +

                  API V1

                  + +

                  + diff --git a/docs/css/api-ref/en-us_image_0000002105031992.png b/docs/css/api-ref/en-us_image_0000002105031992.png deleted file mode 100644 index 3b824d4e72f7eddc2cb5ae277061a189f68bf5ed..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 22186 zcmce;2UL?w)Gi#42eD8TMVb&0PJ|~5(0#lP(y&+H=Of*>%aH@W!?X~>#ij$?*wMvDSKv~XFq%U()f-p>q*{| zAP|UEU+<rvH)zt){eq2}p3V%P;xUB&KRUl98-Dd*I zCp`76d_W+!Hpb5p4E)mr5XeGZ|E9*>K)dB}EKyOYK4&3^r~+e*Rr>_1+tg8?$}A zpC0SHcp})H;6vfv?!qf&2E}g&L0oXOQKz{%0pQ=%q!DT8%#;TVscMCTd{>>0L&GO6 zo}bn{F7*6#<&rU!@d*@OKc{H?^Oz};!hZN$%`TB##6N$idFccp@}Ea}eKGJq)f4qK zse=DJ-s0$C{->P>$^RcsTG1%vgMHfK35o)SZn5 zGu4}nBKq6CGJ*}WG@JwcNx)o1zGQNwY_CSOr~Cq1$&30Z2Y*s;!5d?p&gf&yNCQRgf$U&gSS`Zp z@9A}l<@(OAC-gh(mR3(R{cY4<_FrG^Bw||~1#n?v3Qwq%CwG)PjrAP+D_#tS(SKQH zYz>g>XYOK3?a_$v&ui`dsTVOHkdxT-$JIRc3IXx7O}XNs6TpiUMmtlHva+}uc?UL{ z1@%$1bI^4b>SIe86ygECd&m&K)L`Iv!RQ`ZHHXrpyDC?;_0~Yc2C9~mWj|J}p5R!& zfC#p~LgTI+x`NlWV=SAej|o(&vwYGTIySWV#}*s23Pspd%-LciAd{at!CT}bH zUKT_CT6X7?b5>uEt}@(~_gD&Yiv&+WCJdcs42Ex&THY(Sq%i&72J)8uM`PhfpSOJ% zFjodrk>xqQQI3JsN2{+Hwoop9y$qp9jgXm6d>cLCcH;;0A77@nU=+L&Aqa_H8oXim z6NfX0_7Cx+fg$4qdV{Ft2EFeoeIYCi8;ZcY31ef9w|(JrGh2K*Bp&VE=(gK!yxAha zyu8sMkYZ-?xbdmA`lZGR%JtaD9Gr#DnuKwN1qtP)`zN?TqV#y`@v6DDPhp1?+H zUILdo-vu^cglIkj#2uy7E0cowDIh)9be^3M3Cu$Vm~ga3tVAfNVmOjo<+S2TMySjy zs^0}eS&)sdFDtAVjE?wIH-UNlWlG%9+&!37w&OD48NDo95zc$1||S z*hPwW)7R>mleemImGSMCQ4c(O@b!1kd@g&IBKkn@$jk8aAkaL}ZP{3?p#lQOA0i0x z@$&L&tKJ-{io2tJ|D0lDR?GL?URQ!v{(Zi5vlZP}i(5Q${ z`gJ8F{PN|?NBix{Cj6DzV4jQed2ufcEpA4)r>8cQ{|;YGgJ~RES{^Wq9SfgXX7~Hr zLSQ|)4GBu^xP)41e(^Jvle^pn$IoH8m6WQs0}u#R!R5_G_m4AcqGFs$bFq4)qOL?6 z{rla9hCbIs4)(265#jyQ8Z2cx_xpw(uXf#J&oSu}B&KYvj_WMs6 zOd_JGr~O1l_Vx`K_5&t3jW<$n`|V(JEbI^FV+IBX({SwJ8_t`*>;){EgU+TO8EkP? zzlm+$W7ogZ5}?bvU={zgiPN<)aVFc*v4bl<#nHMf-YJMmaSq?0c8dcQvQYfyq6$YTt); z_AAU!WL)LNl}`yXUVi2E*2@#&7n<1;1eU4`sPjR zfgf5YkDpw@;RXlqY>I^`MWsW=jb$QhV+Dpol^(0P=(2C!wz~@{)d;ibb?5Zz_@J~h ztt3o=AQ4zb)&xU&BgVf6S6f(Sk{RBJ@ZlGWDSF%T& z#3{X+{i2}t+TfWWe-bBf7Rfe$mj>5|3{06Ix~z&RUgYA%kLo*>qjc;})y~@2-CxbL z;zbyJJjcT5ZJeO_W;$&kU47^ArsOX3SI!iq?5v?z#^vuf;M(jvx8v_O30Ia>v5L!? zy3A&nz1fe}bSOiEEw@}#i zEwOGXH<}FceuGIWRPdHjR(9?3cgSaJd!5q2zk-#=K_`2L}wDTK`Jar^&9Ser3 z9}wWvupgMoyR`8An1QY4O>}YdzCxId`~K$s;$wut*EEbvaHYLFW}9hwOu8oqB0N=F zs`5Q2M>hanv>ZYkxD&jxlE1jnxLmX3Uqu&@nI9Z(KAYZ$U!#qA(eSbKHxMnF>f>X< zlEE!-N0tr#BtiHo|J zdcN64OmLxgt=0}h#u8xn>beurw#y5}0^zkV_o1j6g@FnCUs}1sxZ^H-~j=V}`q?&^9oi9p1sYCT9VaA$sxa8^7LlTkW}`XhUr?xBcKvpL=4mx2eZTzuW2! z>@G#8vw^RzDV%^^>G@0c%3O7HVN+qzFdVk9GfE`w$Q6WT19#}K=UZFoY_TObg>t6M zv)%dw;x6@*VS79!sdUveJo`1K~l^S{na9_7HsKrYVFH0H#?TJSFtJZM{Od6qD$ zZs&LNF@GlWzZxnL88F%CG^A%?z7?v0qCx$cS&t}KPn|YNLt3hC7&S;t`a(Yi>Y0+) z2wLxa2%Cs;6U?5_}I@q2|ZW8(@&*x7)(a(&GKT%!-PfOFCzMb+J;& z1p9HhV876(EF2dTT5oQv=(r$zO2;5H&fGwPpNv`hV2$dB@NS@O8p+|zLmgW5WDRkF z$tY_Sbay%zt1BVE*wa5B9>rq5w?KH>Z#$*FswIZeS0QX8SJQpm*Diuc5ipP2u%N@I{>Fo zBa52@2W`kZYfF$K^@9#LOnvtovUrkqt>Y-^8@>OA!VS{S(_P-oO?;=;H*rHP0oTU+ zUZice`m&6#({b_l)K~JMLz#tbsW0msKFR0K#A;`r$}zr<=r6U9Y4Ux5wqBSfH;D_3 zNW+#D-aaG?ciE;pM18L>eZVL@$a4P@&8xoUNn`NlD0`oB*!w1n*+%vt zq0H3XtwL7}=krX0E@v!iha-Q`5MPFqJDsKG@lvxLo*t< zghR4|KiMf#CYWt?T!^U35K$Qya|#6da)@hYXMMjtS1_aH%%()I@hCz2n4B%| zh*XB{szRagQBmg`JR>={%VUiC541K+ zz3pu0b3^kUs5e<~y$HJ4p$~`Uq)S{_;5yK!c;BaoS`o9d0{q@oCUGYCR<%j+FX)o$ zzQWPo-LcG!TakqUe`g2ZD|-Z1C-1u+MC@!|ou5Lq&UO&r)TYehaX-wtSko!19hIuR zS=&KVYx;$4m(K&e2RU>fA}YVl4=?%Nm(Cvv(c25*-AIJq_cf{UFSyAGRISVFW72eb#n6EIV~Ij3 zUJI|CwNev-xp)~~Xq{V4fptlADqAejV<>P5yQbY^eGp(wpz?SSZb(7CS~C3JjS*}JE6pc+R*fp_<0Wb1~MdfuM}mKk^;42eR~W`r6UAutKHKm7x$!ae$310E9;7-id^$JH zMv(vo=!c=6?Tz2kmN~HsNNdqHjM%xxmy?ztkj_m86LIqt5FU(xYECp?*&28~_Yp?G zS5W-3?IRwQuERR1R&i{* z*3oTUS*cle>x_@T|8>QYy2mu_6J(g?^d#~?;zbjyq}>s@Q+g6$ex|=c5$25Xbc|&3 zH8}6A=wEjWX#amDPRV6va0P)#86m49WY`T&>Kg0@(B%leXa@cI_)$J_TbF&+wofbQ zyw8gqejjUP(~A$9H|6wr#M0!vy`QYE?(78Kp!h8=cRB%d$?k+cQ~P8zfu7BRcA!cM zHbp$QE-(4ZG@YG`Ve9;dhv+bSKLtY9N@kz*FUhr~)CKPcTa;{S-iiGdZt*`-q+<7| z{m&f9Cto!G)j#%3G~CD(FiQmhZUdBBP?}Cr7y15koc~(EL%CzSj7AbdVqbFF%Q9$| zd;)=hO$TTeqm7P!v-62@d*`L7_3|M{>&C)F0p^y@o<0IsMNTRLE=0zppXAwb&KT^A zth0I5)x44*F!#2h#LlX1uOtI6aZyxri)5zyuwV=mmkuf7f-I>j2!!MUtG7W!oqS<) zL?7+2fG=ar-CH-{(w*7r>pEnvnSzFcHT_S8GE@@49w$4n3*ph^=aGBrYWO2&chwrv z{ORMUt(fDHe&}8omdl^)EHP^N^SE4U1HF#Cmhm_ht9!o_kP_~_SKEn=oq$ahi{eGPc z_=%D|x2bp{p&v96z;rSEPP8}A53N39QhQ!LbFi)ap7McsqfH3@KL2HWnBwHuSH>)L zJ-QV(7V&TV-h_5INuRtstP{30j*0P7r7$_t>^^atN-R>QPH9STRNSmd78=EJ;&^gC zhAyl6=5+c!XeL=gMSyidd<7%5+Yu=J+I@{eVZbp0fcpkw+hx|l`wkvGF}#V+4nI(O zB5H(u*DS}3Z5Zcdy6LGN-Tkv=cc~fF=yi6+`hM4-cKN0w8w9(& zwV3I1wY#D0&f*nm>o_8Y7nL|nD@9B1ZS@CFz3VqW);w0#qpSFV+M_#3zJDP|V-0Oq zC_jBl(@bK|XR*4t7ORU`S0-qsp5z3!9cWw(oCyp++jUYtMPOA-P`(}Gw|JyU3akl% zrDgBzOhjUy3`4f@euz64w%TT5R`!UJV85v~FYIsJ=OM$56yyZ3ArNPdqi;s#I259u z&*%6T3V;##RJ%zvi?WYBx^^;-V>jG8CLMn#{jeYYc=DU(!cIl~XOU~p-IfZ5cAA=J z^i8z$W%xL%5TkcSbJXE5Wo3_AgJuGv$zGm27W1(#u;xKWLOZwJeYp{DUsv{V2Q1eXo%ibr=KF)v8`@)6Lg%{|1S?>lrgvUMnreb5l%XIh6 zP_5<+^!Voz0~AD!$%{mOO#l~_r4B)tP5ZN8P36P5?_A=?Kff5xG{1vDyfh&dE`Rjd zC=_nO%=}JG2<#A+6rfyMpT>}WNC@nv6;}p!(T{-2|G{bDRrXR-*YjWhQhd(dMSdwG z*5-XNY4aD6Ob+@bBYxD><8oFUVc|&(z1w2SqWDAL)z$Sin5xa}Wg7rMfD~8{ z0kQoumtoEK`3)(y>7)PmxF6_Bl~!1R2Lh?P@8oA&DJdXhs@(s!7Yi=KZ|nFlPW4m< zx-en?X^6G*%Z}bWF=J?AAi=ucS^Cx;mX&TpSWA-R|LnW79WdJ=Tt7_~vLQ1Z{2sgv zfcqR6ip$u0RP@$o?>Pe_ep|u0m**}w+WOfYY!&&&rN%+{fngkcyk`YdZF*HWQy*At zzS~zP=XqtpegX0Kq&k<8kGJro| z(9f-bOKL_$08sx#8E@)i`H79)59lnqh}LTqKV`Ce4|*P}ApS!#l{M#s=Wm#bO{=s; z(88zi0uNp4&x)9}fllQgj~&4{zoQ`TLnJhEBQ%b3JvCdq2U+6eX4Zd>EkDp0nkGQX zK%E7($TD`oBlcft;nfLDYa;Z=Su4!&2N6kL=*-WQBNI>k4;C9#7b6`0!bLcuTN=ld4wTc95j%@Ux{l{S#bhLtAZ~0_)l@+iH2Ji#gW<@^;l$~7v z*+bh~-xeASxi~@FHY{+4>n^SLu1`g7h9#~%SUsDWw4^2y=?H)5KU?$05+i*AXH7B! z)AmF=L)?Bt{7TH4Ann2IFO2rsU0BfbtL&h+02?Uj?@VQP)Q(Lvzlj2e%-gG?xHD-B z2Fhi=30T#kAg8Px!{UrtX8;ldCfaB|deF5gt>TAtm2me>#hKx+rP z6n2MHkG?fQt%=&CLBSfCis(L`&xWa0jfHcn9|HHr0!uCrDt%9|#to-kz}4cz1AbJ# zs{)2=Wm+$cUBS zlbZteSWB(N_`}Ynz4?_fO*WgU$hIV2Rq;@Bvi4T}=s_P>>h|v69liHZzrs$1D>Qpq zlOyhhiDo537K^Ag{-?P}me+oF?*5*cb5Ml6(YRhn4gL|z-S)^Hk*S=@jlbt|XRP-7 z86Q50!CF7eM0EJ~SD`uYF2FDt!&rP%`^0MESDaRktL@E2N#Tm;=g<$j>35uA8XNAG z{Ah=3Oa)@#A$KsaITcP5j#?I4UsY}JKkAq@B(dn_^XZ*rS*Ts{ReM}5yU&f~1aKHq zw6i)bb7*C3?nNytCuywC3EtK`*V$y>9A@4aTvbrBY`C<~rcYB{TrWALFD2YDkhq&x zQW>!$$xyyB0N#7}ij1R9S+a_D@CXFK2|ihf_%Rl3AopUcgNx6VFY+R08CvI5qz*oZ zE`jD~J9-R3G5#ffrK{htiv!s70mCbh-@Ja1# zLmZCRd%Q&z_eTQTgvc~?b9I@nsF`^K-|@#Tu3L-D`7ispVeTos(`w2g4#W|0#YC6v z&q#5C{E(jig)7NfG0M2RI*w-^rvrBO8+K!l?gHFo|7mRwY%zXzI~sBw7uX(lvewFM zZQ0J&ZZy~rj_Sm-{2Y-T1>3(VxIsOKH+`IAuQ+%09aguoA?vG+YPxHOyHT?HBrpX% znk26{ETd2q}V)UyXbC!{SY z&DP@p-3;Tz>aOPph=W1b`TkvlF4;`N+dWsGK*UzV!w8nhVx=BS;~}E9E8hw-%Vb%1b z`8spErSYg%Ui(4%dhHCl&*WLGWAeqe$NN?H?BE#Pgvn9jqY7rSRRx+bonVz?#J{cl zyz(;9O%pVPEgR!F*DJePE8y%KV2L#Uks)++b(=3q7Vg>`&017 zSoL6Z!=?lTJoM<_O`_GKYjHiHs7>wU@k{cfYl5NAfTKAJ49VHf9}3B79$NuQ~G7hZ}Z6RM=jDzaCk& zsziB3wmk22I)~FoMP?*u$2|tj)Q&5}1%6 zLJ7ju);kRmO>>GNV3~uHdco>BN+RM&2ZMFMg+O5^CVZRO@?5rPkN^&voJq3&;x?pF>kJ@l~>$;;0 z=UL8ThX=%@teL$`E14dl&>OwWH9(nlmOy+`s~l`?t3C60b7SG17inh`QR2RJGwUrs z31zPU)1>5CE@G>Eo zMk_^rX`w&KlywJ!z{g zzJX15%Pf*)@VqM*yFT@`u>Z&Hgzq@#~3+O5xrvdPm`C= zBXbG);s&+^t-RQdh++Kv%cUXy$o+@6I{1A^2>6-e~$Orjs%4%U{rL z^IsFx3aCw;(^J!NF>yAV0Dx|xm_Q2_H*GEida+r0{fg;9vWC7gQh82^-H6_@>c~2z<>Zdz_X)bw=E(0VCNho@V=7!F zO?7YM&x)7MkriM{ZzerfrVVuupvXbEA`r*a^5|b^^o@5*^FahM5}~%|M~EU1cX=Is z80R5B{1xFOljQt|G>qkW6@z>YS$_qXh66Z*4ngVL}`=Z=|QAB|O^;XmRSp5_k#GCRaf-j9at z6@o@YSi^lf-1GI;ho9knBOmh9Eq608@JVnze&|6(%)GX#hqavoN!4u6^zuQ#n8Xc9W)9s_RqP0Z%*G#!+ zVw9tMeULQ1>>*;z@-nhPx3y!8cz@xFt>$+PmAs7d zwIXJSN*52lv++RVRF{~K06F_G8aTm_8 z5)|N#nVx(gQ`pwg+^u>LXj>fk6|QEW>coHATz0WN?@TfsZVHHK z*Nf`{zoGz+3352z!(48FeiWD}bmv&Ta{6~->HXDXKpQWw{h5gP@7qW$dDQ-Zu5u2m z<6oFx+aa;fp;7D$NMiX07^1}jcWxliRs`RRe}{YT=(uJO>6pfL-@ff>XeaKwGxLXu zgqziTj{E!hW)N3*AAavm9oFCcTALSwNWw%JH17zu#QFDj&o0#eGK5EHVNvI`Z>pC4 z!q1MjU?i{|L3RJKgh)Vc+Y5p&w=6wk{7%T9rdQPW9qdL19;c72$6*N`CeT_RQJt`Z^~LoT1f4lt zR(LC1IA8Z*0yt3_&Wjd_?w^8fM}?kCF?=a}hxU`RcSyZe=bA6Qz81F+q4I&(7dzH0 z>1wxlsUd%ZJQ#CtlCj;lO~AwJSHDa~WR!JRIj&+bfs>lF##3$U`V@V-@5c?lE?vpT z;}p65D!j!GKhJ&q_o3q3RA_?y7EPG~0v*be!$&Jp%~KQhE_1Oa$bE%y_~5lQg}&H* zQ5~!kA8cxliwx&+{V9-)OU4C@8QI4mDw7AL!N2V5-J`%JeAVNK#!*XWN0;evE>Hxp z$r-VhBW#3xNwYNM-D5p~li~wLit7spy&eRbWjIjo)4R+hPwjF4Hc6(p)(BNZ(=6ie z)A8_!>8!5d96|0A^-i1OcJ(NqpZEa`AOt@ZZM#tLlILHQ(uA$&$_(?;mY|x;qL3Xs zh5u*+r`qoT9afrn3iA7LkV6=-F!|+Sxwi0W$c`lQlHA#?Gx=Mt(ykr68`dU~;jztC zz4t6SMso@dqGEP4oF)P;)K8$G2_Ifu6)lhvJZb>ATAltw|#hSEK1nnakJep^1;`b37PZRQ@TOQG44%rR$m&Lt|8cPe>)A2l!@IpOP@{){ZMz zI&I4IUArL1_JgMX`>KX_fvSkbV!_YPuc93bIr2_*5plo(TD%WqOBWZ5>Xu%rPUa{K zq{_Lm$5k~x^&-8&OVPtjwVL?Fxh=YnCvARN<`mURXj6p>2RHh@d#vua(2aTq>~#?7 zDMNQlPfs7vHkzd#utXoa7hha{l({BIzMsvM2gNOb|k6BX~ja zSJ-0fYg?x7vWOI>*%W?rVMteSb%NM@4q7Z&sW4d)l*5OFwxhO~Zw*qbQWce* zg2~*PLJA#(j@JFfF?rPSe4-_^$NEq%lRKQYjinN0wJf0Fk)IEua$h3cWhQ$*ff&h+PVP6oCYUFO=C%ewS;9!XDL8>4+{{Ua=@2?UcA5H{+9>mS><;XdmJ zy{lXxsbulE0(75PQS&GUzDoL z!x_F?TX!3(VsJTZd4=CXmrN=kk!$(+Ekf#<2WECeWurcBR~MI-mR`gU9K5cH*z){n zHFv0i+4NKgZJQvzk{Mdqx-25aIRQEDU_VU-xK7VVH=G+HSv!H(<&eDN{*1H^c4MGvk&Zy=2dI zni^7tVCaZN2ZYE9gztDT6R5@V`YI6g#~dhbqgj8f1+Z*RaNy+^())lA<++7iq?yv-FEguy)^Y0wII8YfNgkCJYv@MA|Y^_H5CzF;sama*8ND>@7;a?jM;i1?J zd-!Z>Zy8csj=R`)ui+HXwo%)DfONFGFZASXr!>rQfgsE_S^8AfP>kP-8VCf=7Fb^9 zo40io%CLgQD&$)O5E_(-@1^7#YTF*aDF)swHI{1miRe3Z zCWSp-xLK{|!=zqQXu!jt?y%hF&k1!~8q`NIfD&}W1CZN%LQ)YIe3@Fsz^^DL^=&)= zXKxR4C#MI}0Cw$|IJ|8!4~~;BL#Uc+dGWqC_dVfdPjaSxnWdP(n@1i>{LNu|&i84J z1vRnV{lk6={3?5yiBJ5X*N5Z+q|sL9gr{9PJ3T;>p*soylJ@h9f-q@Hu6hVA2Ew89 zIT12IyQxWif$zgEY&uQ-Tm@7=2ODHjmeuNHmj_lpEY{pKg(JL5IMlt7*rxV@d8Q;# zPYmn_?DB}))wP5+_B|BK*9r6)!)K67Tg!L9wGbAQXG~Y)C{IPZVxvq|QSka6l*5K} zy8F=1V;HKWKtq}3mjs2T($h}Zs|?Gy119S8cFjbf47KfhgeJ7X^+p%wV-B*B=Xmz^ ziJi#N)Oq)X$tS37emjK#n?dBbA9BIDblT(~PlFm_9;>@!QV(9F2z5k)t4@J3Mvnn$ zL8q>GG!}&$)`H{Lp9WWSy?1B%ll8bqZ=VKr?4JRuvaBax{rNGsNx%LUBlwA#&I2&% z>X9Yva!3pOdf7~xG}5Hnh!Fy)0^pCRf=SQpF7s!nd15ym8XrAqxqfW*$MeeRnb;_Z zjNAg*V#HVr5i7$S6m*=B$Eh%no<12-Fin`Qyibm^3~7RYy-ob>PuO65eN z{m94BHlgzkghewc0huBOUa)Yn{brThJl#X9GD1E#OCk7Mw3KNtKT&l80RKUj>I_(L9L-D6+O)~6uPK=R zV{p^JL~8L9p=bGBPC87{=B~-l$WVTTKUmIV^baf9I|PxAU1y=k%i(&zcPqbtH4^8a z!jP)rXiA6hgtz&5B+44aSnIveE+*Ae=JJG=`0OhzTsl0^Wc_Ic<=M0iYI(kCa~3qLf&o z#WpXe##oBj;%- zY`naT4Kpv9F%<{;!G^ZHQ(OJ?CsbDHBp-b7X#Jy-|Xdz1_;asR2SAPTNUtY=C=dm=zk-MyPPBL>4d-YE!GtZYJ7E&G?OTZWA_`Nhv9 z50mDc^XomI&-dTwLKfu(gFtDAaE!2KtuwLV#`=9-J9;&->4aQeBPl57km<7+(N7NrggOk#ZNI zeltO|CK0#TBsaS*2*8*b*%FSD4+SRS2}a&)=8WG}I<3h1Dvim&)w5yYt8^-^i2kRK zy(s5k+x~9z`k$Q72gUS#xOuoAndtR$N??4vsCs1yW;8Ptm%QvY`MOlKbZZp|9Aa;q zv3)}@Y#Ria0qNltAXHtTPVjG`$)=ETnscizwL<;BYdz9v9s}EcSL;;7P=s| zuE0*GF4C2$ziMVdMq9z>0v}ihw8y?LNId&+tD*k!I=0ayOq2 zA;|eA!2-#%+s@yC7$_;}k6<%Ag@!NQ+Vk;hzDDETKNt%GvQ`H0hS+&bf0H$qv#>{f z6^SQDNtN0QuzMsouOsQv5MKHUeGOtx$A6($2h+(#yL6cY{Y@|(qE1HAL)hu5i^~BI zy%xfZR^4fT34+lpPy=Ljbhz!gy-I6qx!aEy>L`89dtp_tvq_`$wk((ZGpL_H+9Cl+ zD?Jl)Fd=ysaPMF5!g@b`tE16;(I z_lSPIt=r_VhmWCaZf+9PUm=g>G|^GJ$OB^YTn;@adyk9U2bG`wD8JT~8o|F!k8FtV z^6^r#|N9N0;6?$Vmm=px{Se;;HJvghVN)}MGuHxrYyg`YcY8$5AVX+A>Fl@JDU@0} zdw00riCEGQOyusFZUb!%`##G8#Gkp{by)ahdfd1=ZD>ZgHhgUZxwjs^VH9>5+TS+m zJz%4sD4%HW{-RI=x>_^+-Z0h*dXhk?)4PhhMxtRhnnDtQ1nm+57*tBDC&tV^%ky#U zje5jyf(AsT;BV*Fih})Fg0O1(@2W#qws2`^vLRt+ zb#Es83bg+_`__X0hm<;&t1y)}rb5#L%uf9E2o@{oyc9UtHfPQN$V|3`G!XMIX$z%2 zMN#^!Y&N`|sqn!c1fpCaH z{IN84-RQNFbM2DMkN?Q@=mw9m6TBJ`H_{19tx2pqof` zzpj*$#F<}X<0Vzu7|cJWNGIgbQ4sDaR$@3BFuZ=Qq>V6S^QQU%_RFNFT?3c!ajo#s zYpsx(lNwe6i)C6*f&7V4tODje*7!>pfNp9Mlz~`_a=Yta5XaSD)K95sv+wSn)R1DS z?45|zGM93c`%&>af3nG{=?{ z#(w@kkUh?bxdBdJz;y+D{I4aR{}-wb*HFki2Od@Ru7vl&7t(o_iX)!{td=Xs+WUvt z@cXV9W&@$94?P~tdoy|!Jo-lxoO_xfRoS$^r<~dPvi;s_asFGj1cUqo$KJ7?7$7g_ z(qi%1-C7`_tSqQOhQo^b0y_plz+6i1?Xw-5lHmdCH3^q>R-|wR; zU>b*k(2pY^2G5$6&%{O18w94E8v_UOWWdfmKi^C{sF%fQSysy^jL21`U%~1YpT0)? z8>m&nL1>fuJAoHSh0kqwW?Lnq%`+d2_+Gn+FO%UE-5x_bxBcGax9r@?vh- zNpm9S-`D1goeSP&L^etNs(X@$jg(>QkgLijiGk;61~;vM{~iJqF_4SMAPBQ8`&T4x z_G}{*n?Ro^rjnO`XB{s-e1U+v8WroBVh1!%<90}4TNL?6pv9jCu<( z|JV@6|5+RQFPPu|pQ>-Ip-sx4`~w0=OKOU-M)3qj(kG1nN4-_J4YP;4g9dv*QE6$` zqRAd*H`{_1P(60tX=SNi*8pI6rHngzuM$Sz%AUZZa_~XiU|)f8bJ96tx;on2ebN=2 zdkKq9&kSX=#a!Bu^If5LhgI>XpQvau^1iUV{O}&W50hm#xm8;*vyCCr-_5&UT^JAe zy?<|h6;3COG`JAFr>?ExGQ%f;5WWGIGz=66~CV^~DZ zok&Oe`^*gwBXB*qeC9fVT>qVinp<_C?B>+fBGuobvaRIH|8|C%9IUqj1SP-XY4cTX z`ms*Nm;eqN>BbKM8ziY&uWd^b4c3%>bfe+?NOk2*k8@e3-yWHp2)zz!xrc9|^qE{u zU@LCCx?y-^81G}hT8E7Bc(r3$XPPXqUhv>5%-DYwd%hLg>hw8c9^+peSvFhIwWf{$jRVqXAJJx)LZk@{^m+6h^#{Yf+1w$fh@laT4AyITICq zC+~+;hVncjEpNSxv_sK`TaDqX>XR-_tdZ}AY`4|=CO_U9a^(EI5D%`qT??(m3V*2q| z=6+NtC-Dqc%eH)@WjuGx=w~?FIOY;*`7X`-7MXh#&$g$$plC~Zmb3){V~Kgww8w_p zBI-GJFP8Yge-wU~0FRexlN%SL*cP~F(#fvPx5E>jWN8ptKsDmmzao0MSK_R50Qg3L zsqCem3EdR#i^|`#v0px3*b#0kfJ>Y?y1TJ&SfM&3$Gw|d;RGu6^QaH^TupH=+kyFD zF2rK*{~qovSua1fcHlFwQf+*GG1Q+8+i`u*O96XL>!5^^YfrCP%_t8WMwU#z`>1+; z%Q-8A=9f^GKkENtseZNU_+E~vRnwQ_X~a*}RtG$Qqr0WFHI?1aLXaGpxVwO_3a+r7^1$ZUQobT2?pg#+IcCL)#8VJ*jTAN1#=53G%2W`7|E{z!ljIYNe%|4P z{?RDT?(XeIpk$S47mKkd+0j!aY&y1c_pSg7)OWocp?L5lQs(Gx=!H8b(4Jz^gHWCW zY6IfAq=^4i*Tni1I(-m}J-te8xws)auRg?-FEG|Bs2D)yzPk6_1iD-OG3QsL8?HGl zfUQ;Syf`=uGxq@VC;dzH72i*Tku~4SV5(s7DPjRucQ3n`K$Hf5_%W0hxWDhSRolDk z^QKyEyW$9Fa1=NZOeSOs%iMrC_6Jx6!i~w~s_j2s>vjouA1(fs+;j(9REm-35K#9m zjG{aZx~Am<-8qj`Pq{D479_vM3gkrWtdojAZ9en%Tosso=#Kkuy_|VmQ&$$pQD%x& zF=|E70is1J3PPbs5lK)e23$dlVG$z3ra*#%ppZ=~npTt)k>C^rtfFO0*ux$aF+c=d zNK!x&HH1LI8c0Gy66Qv2Kl9hjXWGxq`|mAz_uZR!&$;LK&iO(SI9J0mRmB(GZ}QLy ztp(dzkZn+5Jg34^W%85g8v1Fdt4$OG9%_a?8J8OIQd>HetQ`>2*flKDD^1`qlQYgD z;0Kv@eNKTy4zOAMBNT|<0ofeyF!PL|o}QDghGwlUT9Vp<)0;qq4z~XtLg$b8gZC?s zKL_slFJsRT3&00(A!E09ORDA-9<>=}*qNxv^NLn9EJHIY+7it`fR)8#;)AQn=gyZ5 z4D9bOGH+)#0}4=5$|Od95DafpGq0y@eiLx}Yhxpo(;oNDy~rS;YUeZBUgdPV2lVnv z8m8b-+jIkk?BhD%q1?XQtNe|^L%Z^IT+ipZ$QF>Xpn*l_M`>~MDW~~Wq}>5U)1LRW zD&Lx8#%Uju$9TsUucPdYj8HzcC7P|;4PaUF0)0|xb#31}(t@)iS7>1~xbl{AlVpXv z3W;(1<*IO&DC3Ze&`M2xXrJ3dQer6d9zTEZh)HUjyz=onXv`}JH zFP72Io?%#>9FZR|^SnoZc`~&E3DG}4$9|M6Np#B&A^Y@beYKi-gcv*CS#gWj{3G|! z)IC9yT5x(-*al5hmt=sywtBy3g5?v`SY6drw3oWccAKX?fbf{~k7SXZ=Ok}y0RE@r zlW16}_);I0`v!~tT(5GUp*qnz^Q5!nkqxqMNzGdr81ckb$fZSL4WKhd#*fa)%|E} z{~o?&X};DE1*r^BT9FIQDQTgMLJ_Wy8?a_|u!twSu(f89Be{!W=9-JExO*#D2>-8l z@B{ub?0W9BRj;*C;qCGp@36vG+JpxRhGYB0v4Aye5|yV=W4h^ZG2&epsnFaB+eH$P z-Z-Cf(k~2oy3tEe>9ODE3%j)`qnNDADTBh9-SL?Inba^e+Qaa*$~DJ?IZ1~Ja$V$n z0&GrV(qj?Sn|*mQp6v%$6V%C_0(pgMb_a`8UrNBYDO|8+H{4<>(UJ>@&-ng%&1ZA1 zLC|yZ&~zU8r;Yn0j~Y#QH$ok(NYASe+RsOqg$7j_gu&KDExw~&`wj_Vwa+X}P*6-k zRqb6C$^7Z=tU+?+B}UkyFs7tMzJO$MlrC0xgl&v3CM5=w>V_Wg9vGGiUW3|~0*-@F z0!_!C7Pe(C7Z?hfL?HSp{Q-z4>Chh5B}Yw6!!Za?DIkop_0Pfzo?ha_*+G*cmQk~3 z^%G6^VOfZZJmaf_j&+e9bRH(@nQ%G>(xJjhMem$mwxZVQ6Jv{4o(j!THO-w>jJxG| zxNKcK@tUM{MO!T7t?TWSH?j}|G(zz5c$;=*1aqTsu(P+@I^^rkOm;nAGOF?RQ&(Gq zkkwolvZD69UY+x^0bWMap0=Vy07gdfUZ+)~vV_x*50ZQRd*bMgAg&!|%B1)@w%|>W z+k@VR=D95Ci&A3_KGzKu*JjpuV#9O&3-S~hl+FVwWs}o&14JBbl{f)od|P!^qsfS3 zOK!>8x5(0k&5-VtiHJK*ju*te?u+(LooQEXUM&vn=t4dEo>6ko8*n0q(uGhvOvy`$ z6bt0^RtGdjxyR1!c@#2)61!)^-_q>%RP`KM-qRtnTVQ(vz3=2JANcB9i^ZtdN!8~* z%Oao23jdW5-v0uVadS3DwG-$d{$KqGV~T1@o_%Vwq(lc_yEr(O2I^MDVsV$v(voE# zk8o)yq~zN@U{CM$VU#OT+Z6b4DIg~4y-AYNgT0sRg2Snx_O;lLVW5laS|{e(MF1U@ znVBhWPczmEghJu|6(4W5LP?zBHJ9YUu*aKm%9nhC4nYH4lM@P_dP3$!N0mv%K-B|J zQe+E_mkDy>S^|`8U686rKNbv6T?a{?VvdcCbrGaS?=RbC4ULM5(l$d&nq;~zv`*a0 zf^5)&?{-L9NZB}ZQum;BcPgbbZ`(*>3CQ;yTL8nZ>q>x*Q3qsr-LH-UvdF>|gO;A2 zuFmNZYINz8U<>Q)B7Jafx{`Tt;NrjM&pr8sLT0ibO=1$K{nQRFx-Y;ws!f9}7J6e^ zjp^crCa%jb(yi==^yyFjZqDbI$<6zMf^yx`g{A_BPKEvMMX76&qS!-IjpJ8|g8TCI zlVObvvPA4#Q&rOKN!>yBqv-SyF0taK~);ltZQ|$aJXIxdL+~=8^ z=!G7FB^%^L0I`q_#6s*e29oRj)w1lr7W!hUuyypS!J8KpEX6G{HLQ=x-dJj27I&Ca zwJ392HLEg_iQFNY_L*!E&oqCa7F5FuWYHO#NY<5v>T4mAo!jXk7hRPNsTXgKbFlMR z0veHo>$4Ch@T#{jA^66PWN4|xkt}5tZ-;5o)Cs(l|JL#nybl-JJpQxJSa!z zkY1W!n{9>_&B(LK@vs-k*JtYHw7{J<_b3Z!J&2Z@vUj3Tlrs5YSa-UG1ma^otVr3iFW&;JPEEv7=hjF`XCX)xn#64cxNcIP*c#?S%gr5BnPV~{S+M4bb2T(afvCZPzp%@O2FThf3D8=EEO~j#aj9oW0_mediJ- z{)&4SYbg^<#*6E_3^*4XqK9AM6T>JKw4=Wwj{!?j4l=_2v%&a3>xO@1p&o;T0|wy2 zg)N{rdYH@_Ybex>a2@g90XPLTz9)hH%gMD=g6=~4k>l`T&3a&&w&cU{*AP0M>Kmty zF49Uhil|AHNrf!2T8%3ddOSALfgaz;JGz)82$WNd^BRV2I_f^Z4KN}=`7Q;Rb2&pf zk|PFOHFkS@d*JVA(+Mxo2Hw0k4_1;+CYP{S2Yx4*R)-5cF!Y;W=j7+*9Y-ROBg=oo zrFw~_Gm}HRi7d8DGyfwGH6D93o2>I!%30Ctc+U?E)qwpt<&P!i(hvwW diff --git a/docs/css/api-ref/en-us_image_0000002119117513.png b/docs/css/api-ref/en-us_image_0000002119117513.png deleted file mode 100644 index 090574caad922f91c29e58155a028caef9896b6b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 17384 zcmdtKWl$VZ+bs%1NCE^1!QFz};O-7Vf;$9v7~BKFVUXZ5xVu|$$>17XLk5RHkl=(f z@P6<4bLv*zy1!1{A5+uQJ>A=S?_O&?>*+{UWm$AoB2)wf1ax^hDK!KH#60+?^ECjz zhjZP?9sY&rswOLeP(4Ai5C8GPN?b`C0iiAq?fw%o{5OiToUSVZ0!IJS2XWA;)Eogp z(qCRmT*J%gch;Sg#a#04p-R-A6gsu0s??c&fW%FaDn|-OS(MakaU9F7QYd{Q>&v1T z0RTV-EEnnFE*ToMMO!N1@ZPzF5xW+#j38g)g*r&h0)N|Q(WGaR^APgDcjtZVy>`BM z2$IK-5ESw_~+yOm+f$0-J|!!9o`<9maQLva@GFMa@#02QdpL200^n$UaVn7p3lLG9pZWM=vg z$fi)kZV(eYCOOVPo&kk=L)vmREfhWJFO|CCu=XSEu+QQkh0s!|I%J~WQWdHju|a@zGT zt0d)L{q=<>ZFT_v#9eVoqa|f9vza0W6nQB4Z7SC~IJ$wyELFjv;kq&ssuS0c}GGEOi-LHo%65q<)b?( zfx^rJMCOB8YrcB*ir3Ncf_~A&_8hg+-_PC3led<2SfYpuXxzsp&K>!mHf(0br&`8zX#;0xVW$!60)C)00_$_@Hl-Vamud4U7&GcJn z?=`YdE&_ZE{`M$+qQarCdfHC*Aae@=2&*E%d*A10F%SziN$Y7_K@d|wB8ZG00p9Pz z&gyBekrkMpwu`b}k>-hE!fVviO4iEoAp}qaAC;cgnTg<7)!bL`F)%T}T*aZ42%34` zw%HYzrJq82uJS8KRP4O}FV&x*T!VL&*N4v?7c+`QG%~XE2*`Ty8_6|V#dAxIL3Y;e zRH<(kz9>D_-BnRGGSi&ow7Rhi-r`)bc6dD;ALf2D@|6F+rMCPsaWMR}LsRID zf8O&yj2@OeaEa$UNO2k@gQDQ47$H9Ih$0I+R?RhpuK>&s43YgZO@^<&AF1Z%156B3 z0&BYe`AGXucX}WO$0hzVLg#x@eGKUalhgmy3=}eVaD5aDWVKjraFT5i;e20y z;=}ZJNZl#{YLy?oP|$vc^mSQw+AZ%g6gnyDqR$e|Xt|=RA;}}rW;B0<*@@@ih>xUh zShY`0J1k)|J|Z*8cD zi2A%o(FRLg$_2{No5w{v?R%3SicA`7atb=Uu;QF%3aeB|DLi#cu!kZoj}LIpGB?ZW z;uMvxN>rp8^nK~#a<_Fzum1EydU|#uwBlT^!o#``kJX3$6uoJ!Ga*E|OWfea0`XUI zfm>DkYmm1YdEV1fFDBAYm`WEJ?OCSqZm=VV>R{H71PJD?M;CTFk-16a_@`S)V^-{k z)uSL=o5}DZ?|rCKdh+iylpjkGyy`r5elo-|^FL?RXv$n|ULF-^?S0savH-EJrtyB9 zdn@}R!_++r-%GqIrOwu!sE5RBcw3i2Fz^e~71YRKB*Anj7`w$=NuTwJ*b-mU zq!cULsu@*Ad=@H=&M%yKH#k4=&p!U7ps;&7I>Dd~FT1yl@Y`RRYm#7$HOCX~D1Lj5 z-pYJbgH|d6*>LSJ4%VG$&`}NzmTkx)IB_NaJ;^VK;y7%CgEdAim^=GLR23^73=-U+ zL~ilvSZG4Wk^yRS{;d^W?dIk3UQ=pgG??6^VrC3Sb?N5p|6 zU^8D$TqgHz5XQ2?452kJxAHy1dS`iz3p?MZ*pw4Ie+3n^D2 zmayBn=!_4D@nXLV5K35*EjBelITYuLC3LUKD@aXgR5YIILB_+`*oal>#wMIJ;UY-~ zn{6P^Cj@DU=m=2fP@WUy#`Mm)BJUI8YAcM&SdKP^&&hbu)Gl|R(kx*J|7M*yuT`(e z@NQnN51JX(!6I0A&}|HzNrX9{_=)%knS z0C2Al^(aekc$LyMyd4PI24Hp)sZ(%4Es~t;M@4L{#_1Kr?RZ_>kUVlg-FL$d;TWX1 z^9IDm)1c#Nr-v;Sbma5Zt1b=4Y6%%U+tnDhFq9Zj2QbhuAz#C|xCl+*LESI;RYm1n zZ74MLy4*hzdi3tCN3wjinyPMjQQQghC@HCb24Nc^^!L%xls5a1)Z~AE*6+wZ@8sa8 zI=MJQd@mGV057jEd!!S4Te|M|PF#>ze(E1%DfE1Nz9r-3+>rj&{mjs9`Jm+dYE z`Ucw-*V2HJ8jX9M->Eu3B&^9DB^C6A?FfMNO@?h8CN!5}6Iro0%1UL1zd^Y0;G-yx z%)Xs$S5zUM8Km)DH{;W)2~gF^?M_8SIFlnbn89KxaU(WzFoEduE>Cj9SM7cxF^lgt z`9n&=Mj4Clf#*on~u6456rK#HRaR^Q+1IUcck%SG(4wC#Sox zjz~S|<)C5;Qk1b;Llrysxlj#sBqEOsZ980+szwB@#A7}RthsdyE&4bDN!?zl0W6>LXB(dsXrR8fptTA?14rTTPy7D%{UBjAi zkc{sQ-D6QTZd08NsUnmRIr|oi>q^_Qz9vWgjL*pHkP+D(r)b%CZp&||wAz%xZCJ4h zIu4AT;D5Wb2kG~}68&@G%GT9cZ$TOt9XC$bPA80ru( zQc9vVFfGj)a?QF;Ya@^~Oj_gm7-qtPndpDR1A@+HM4!v?PO=wFe{94@DHx;h78n~~ z=%UIuAI9$DMr3D(YN9RZon?TC3kl)NGSWEtcrVyr8v$JL7}ZwS2M0=?FJ3r_!couD zd`HX1@;9a+&}QfxWVCQ)#RDG-0=~46!?6z|0|FFzGNOyEHW92i!9O!+RqxFB(6`A7 z(NtAQ&}uBXR;{G35~MTlZSA6_@VaXs;*(9+kWQLi>7+=T$@gCYf03+PGcD=rBKS`! zCRYR{22_Ww+~5w~AVbBPcT(L*T-|lCE=+1y!d1F#1sI~e@jkxx=ku@R={9&X2(D&! zS~R(B|6-4-Q*$~|vviA7z=*XngcM#w|B@p1u59o_%QgbdIau3M*4-zGnuvmUx_8!! z4L#j>4*y`6+qMj*SkhlEQY%jJoxICjZ_}knR-YmG;ZAJxQtCI4@L$?;X&EHg7b~d^ z{4|c^e;e8Ymj>F$CO~Bt3{tgMj8s4TefM8zUK*;8`%*4@Drh*x7U3^itqtn+hL}Sp z0~Fp_5Lw6We~aO&DA;=q<7r7oU7vo8@|C;F;u~Md;c)b*iw3J>R_|ItU>H-3u%!0$ z(;DTG>i$&YPp0e>zT}7Z;DYxb5!1aZ$InA)poWfzw}A`-6TB*M*|xWDJ{xT~h{yrW zYH%rXDCq>G9$5?zUchE4c(2NrJVjD;Kx>E@+jd7AmA-mbJD?rml82TItxsR8`m$$?&wH=?3;m9#@#(K++KoIDMQKLkP+Ch z^mI4Q)5WNCx~D9V)quovl4)9&cNq~fKvLfp_G!9(e@JoO9UN1(}J~A865!f0epTT z!49q%!LO0O6+BT2_d()MC^)6YPqd?AqXI~UvlshJQ%IdcXjF3pp1D9kO<%-4Fz^(&J z2L}i252rJVY{^lwZsoc`hx&IXRlhHeV{?G5^2kGyLn?*4L7-y_NOras!_{Uu`8-J_ zL3Jy@?Qo1%64~{y9-=p~4RC_gHn>-eBlcKKM~G~?z!G^6+T-?kZX`nXxeKiikIyuyScRuGb6Yn=OWy^ zAxOmyw|_pPl2MR^ryNnNWRu3AwH^&>flRVeZCap*r@(z>$0r0dM1YTTe{g(r#bPN& zYS~vj#1N8{sak-^>Yphg&*RlUGS<@(0QB%z#b{!PuV5nIu!R4~xY@s5pPkC)=qLas{h#D+ehpfj0p#O`?vy%9{tt9LL%x+YbnAI4`Y9Y60UVF2x&|%I~rh zatb&Vr74;kft)5_eLfL(-V?O)uR`6<_X83RwG(!qn&j2n?x`@5-&#R5M0W3rbVS^u z?4i?jTY&{wio~ISq-&?ag?Qd8;FK6cTFU3|>_AT;nf2kefwf)bffq?P$cjrC*t1fN zwJ(P;Pks?6(sIba{OMw$40&%vX)u~D61FMc6G+4dbmgh!5U3lAhLLrqV2gGBN1 z%tqSyv>*vYtyhm_F*~>M!0m)+_pa{jBs{R>rJj6HGhynH=danY!M1C;IL};8n^-(@ z#~-GAF3hd5{g_aRLd z*3QvL;j$v#Y_N5o1Th|z=)1L}yprMz0e|wB!`Az%&@hc;CTYe)D%U@i{beQwMXxbM zl!(9ez+19(ZOtqP=wEcV{k#m0#!gS9-8|Gni0|5<3Xd7-b0ycoz5&Y|kiUIz4W<8f zoq~~db3GHHZe{RZ0Nb#GY>j(_4THjWwrpSJpU%$Z6z7iuE)#lFJtw%_6Gp0?>k6ih zD4k6+a*P9=vrB63DCDpG)xx1kv&)7{2%gd9CI;G69TzEWZi7cJ9Hjd3CQ$_kTSK?4 zKN*=j$QL&|XVIy1#Qa+Qc*YlXe?9zuzd%;ti(LJxzqGFvtBjf2yArjre{1FjrZZev z@n4slWrh0p%b0^&hZl;j5>kEyg0D{{-zUHl2d7)Eg>Ux?9?w6I-=B@0$bfMxj^x|( zmD;kE=UHm)#3A@yxN*aN6%AnK@uV5j6)S^kK+^=fqaLPjKCW2|(HMj|pN2akub6tW zvokpzpBt}GZZrQ_;JbAQuKZY%bx59h=8*|x)p6zWeIiHpnY;sZzmw}19cktyNdx=x z2Qt|}bvXO!e%xM=L79!0U^3z_oTKDJtJ>nLZyf!S8ZZuQmkA-Iy<%q#lQa0lqel(X z9g|@4WKVAuP+_X$I9SKY#xe|ttpw}h&#XT{H-gd zo#!6bi%izV-(KtSVH`d>V2uX7`BLCt;?v(6LJNvbi4SF0Mh^KJeaeZT&}Xs5N9Yer z;elOPaZCWsfvjZne7`H+9IjRPXi=VzoUT@M{pmwvg#A0MD?x{%Gc?xMBRS>aR_Fk2 ztM&-Jr&Ij6V{AcfM?h%Iyj(P>Yk%=v=6BNJiq`ejAzbBlqDePg+y1m_Exm^Yd#?rY zHt?hB6F`s^%k!^DsT?Me9flos@xUUep<1biQfl;Z)T2MtUr=Gc7Z?p6Q(NLRCs^UA z==?>uB>6L;Tj4Wp39VkYOHn!uBq%6YqMT)#b{C%W;0L-X?&WK!94sX_T_O~e?y;-# z3)QNhm9J>}wLwuhZ&D-`-F+95>dLPovQ_!A!n*J~pE`EIYxu1z_obMG#Mz%ZFe(7V zD8n>tD-&|eS&cTBmQhD(XSH^4*|2w(`3Z7wGUPe&v22QHTE2fwJt`C}ZyCr@k`TI} zb}Mu?B(*osAD)jmzj0{-@d%^8BIl>(bl|BUVz8H&`E%7bH1lU<31m(c2rAt!FBDri zZ-pR+S#H7wd(Egn|7a83buplG=~JO-8F-riS)CfkTJMP=_blgu#p}~&V`(Kyyj3G+ z{C0^O|L$4XP69#6R2|j!rQNVV&>TmS!JOO(&cx-fVXCjjC|9F^a{Z+JJup?NaiazVlHv2ThTT1u0zE|+iDA|S)yJ_>oM0(+fv#|*r(y_S^r6(Hh;!tnBK)?V$2t~ zOiqKWX9WqMX7%1=tx4pK{x(pBG{Axn7S(@#-lgao!x7+qUL;%Zal&N9 z5bCFvGwQp-Xi-g>tXWJ0^{-93^I8g95_&i3bwX%qV-dkmeG;qVSmX0}!gS+f=#2>7 zPX%PIwADCN6y)8sRmn>0(QUD@xNP__4Z{@h8O#347o%f983q>|ge+3Ca6dt=ps!IW zP}l4$br2yrpmpCcT|GimpOdv@*P7d-6%!I1`r@9f$%Wo3Dzil}wr3mfF(1u4f%a0x z&YP5=HybQ9VR(#Xp7#nTK1Ca6nq^K(_FCv73RglOm~#9qtUw35-%3*b)G+#XIUL8g zJ49pGq45<8Pesi?G!Eo{xSP|DpmEvX!8*GT^lEd`NIKS>tie4$2`D12^}sPQhQ|l`` zV<`40;GpZbI!&U&R7pB(9-N_h{Mznd6^ZIVFuRlvTKPY==*tlZc!j2V zTQ`Zg=klL*SOi#@EFA%_K|!$|g=wDHM>reXoJN77FO-(yksGYB9Q?8t-GP(XcwaKx z5ouq3OoD~1mfvu42Ng1{yNAoe%Zo^`un-`@0x8rXpw4*q`*gq+UOs1bKNPFOG?3$D5#!34JBfiF>KE1#(1+>sgq2CAFFbF?Z+vX6jXwc$C6)u8x^ zkA8~bnJTJdpqS)o$%wONo zP`Ft1Ww5yDhOrJhGSm7;$m3uRdW~MKi6C09JK2`{%-o* z?**sK7B>hqpv6)uxm>XtIGe6t@8aF?YgjmOjE9~alTXE@!i9j;n%{7mUix2}o?XL! ze6M#gWjFm5zd+ye6bYFNx$D%x4K4%JtlJT0F0@>3==Y<`#Xp}=9q8z z7iW)GKw8#$gDmDoz~HGkhTu}iWz^BGKa0gi9{T+^IEJSZy5@4&1L#|eTjIg4$>W=FTkx4JJwh>j66V^tm8O7)^| z628moHdh+q$m;)soL`sbV{@fw&T6l;nyx z0}RbbN{FS=VBdchzA=O*-7F=t|9eT-Bx)h>wngQ-)Xh9lb(w7vbKu%9st_$xBR@oD z>e1XQOOW!~Zku9XQKUiGkZ)OI)s^+U$r_9u{AYj5AmxEIGD&Dcuk2o^mXJ~gc)Aw~e&PddSCXeJX_4bj7ydl%t+~7(g z4)+m0v!Z&lZ~RT)xq!A^O5c{6hin-${KCp|P`f1SIzO#S;3x@pQ~&(nHXSg0^S;Z} z^SQX#59JiF5B)B{38tEaKVdzs?NWQ$-&py)XcJV3%Cwd(UmzMQ>Mi)A z%~@QAf_7uJzTc}uXfC!u*~cTwsvK0Ly7ng0vBg$NBeC4;U)s+3?AB+M+Z8j2iI5m& z+X>DZyY_R+dQqsVjyPV1`%H-QOu4J_{Ig{x`5aH+O_KAAep=UFT9b6~y83tXK#ovI z35gB&gv&(?C@I%4?l@x?R|;e~n4KO|oGPt5?Q;9x;`0&cw8~4RyeY5C6cXy~I%wDQi}-^XixhxhSjHQkc?s({CH+Qtw2DxYsRKHrOG z2ONKI(QZBvl+1t;MUc>)n5eX)dSRcFWx4+JoioQK!utN611F;JPIp@#FaC_iidZ2_ zISWLd#(6aqi3m<(?7n_ILY9s_ZV5Sib12QCIppKHoh4<&>AiYb(_Ov3mjYaHl=^g8 zO;3@i`iRT&Fb30UREHK8+A|Jm+ybHUQSx8j>duB|jS!N0pXGCo5>SrM8oaiw5!g{u z6P-{(9&9@DlNA_(KXnBjsMZcmx8TdUd@@M1Q7C!BeV1CRgRooEw!Uag5Dz;eZuktHliNVyZa>dssF z&_7^oEv3gsF}f009Dn(ZrDK~8-e0S@-K81(D6m8go#ucCOuFEfgZ~f**IUn_@qzRg z8%;HTD?5YEz*ubW>7l3Us8XylR5YXoqDzik4h7j?A}(N{>R1oBXfW`W`YrZ$FqW2x zBo7c!Tq2TSw4ZY@j198=?*ILRRqQx-e`{7&mU@XY``APOWI$J|UqdzmYxAU}N6E(GP zHCI&coVha&%+q|#l7LQ>=R@O?rmD?HZ9VNR`u>C>(fRLGdWeZ?p4;>+Y5;~R+cWmq z1)E4aHV(p)c{#%5Pxa;Cg`%Q`E?fo|mn2v3Z^R4cg_d+^by}MO-DNl{{J5NKALlEM zFK$^1(wHY@4V}(fV?*2mID1+@`bpPLmW%@!baRqsDGRyfj|7;l(BmVxngZnswU}5k zjAscP44i+n-0<&*}NUIvUGh;Sq_}5l!am zvpmtXnDg(N9`j*n_ZgP^qV`gkX)fX?$?tNos*mM&jQA8z5X!xi~Oc><#^rR@uwF9G#P}Z)oxOBq{ zw*ybLl<&wW1%Cc*F#h8tzj;|vu>V)hp1z51te>wTJ?N!XU8-$~KS$6~N^BzY)`0vt z0gGKqTjseJq#kNs4dcRjlo&rE;e;7F=kSY@g$q?D09ZI#H?Rl?KX$xijT~~&_lalq zOcfej)+J71k8z8-hc?c8iSF`r3(sYgSdSMd4Dj%@jF>N$WDr{Zi{ z)I|Se{g8e1y%vpX^Wq!^Snd}CHoRDEy$Tdqzcu-*MsJwKpML!L<9BcpXsaHZ4ars2 zq!sX@_1sR04rJfeq*Ulq)Ky~6tU_bFylCc#eWJN-=8RbQTouRaSsEc+hDf5Fk&u%+{Cuqskw^8Rzy zBz!N1s2|icE({094vj+9Oh&7Og2lzf^9u`tW*BdR0IIogP2C{H+{EBhxWp^^DY!iW zZsam!MRCm)t9r)IRT!bYxnhIQ_&K)i{a6s72~MzsKurQTFM|Q3>d*LjCjs~hbrwz@ z;Q0AKmEaAk+lOcToTk`ELa$o!jGrqcKLP(QDu91$b#c*4)cb?7GAk?V3>y;@Q`1On zZ!Q9kwHzFLQ*y0EAEx~yc=HmylQQik+*_&#$H%KKB4Z(a5N!;Tfq*VTwhG(j&P`5wQ>j~!?9L|U$mlW6^_)GA)=2lqBH%lQe za)O(o*3ZGI)U^N+#{_k1kkaDeERX$oRl)7?q`*lC|2cSK!su-OR`|}Nu~Qqn#RaqB z^hP8f9~DO}5W_AFOg-qo$1TN;Lr@JT+_L!duIFX3VX3@5d?bNP#XYaIJ(Zxs|Devh zGA^%>(*PlDv<+~R5Lyw?`UC1z8$%3;d@aJ!|0OsWfQ*x7SV=88$_ou;;#*N=jz-*( zLyUQvh0cy!9IAmhd}pR2B6HJl2WEo;eJ;D>fhG_G6-O(#?l&WWHdWuWv>8bjo1`NE z&Uc+{8e-qG3=&8Z@bY<^dk|6zGa{$##HPl#AUUBDysFgJ%%y>{Onz7eU3=WPx>O@= zaxr#sX;0U|<1Jr&aTU=xgCXRUBNU`w>OHOHSVmljC^i0yU^Cf`NH@A&0>Ce4J-HrF zH_J%!%p5^1N!8JlUzV#|(!6Vom{%Ix&>VswmVGpzkObI)BKln>H7bSW6VW zG5F?xrx z=2{g%WqjR_A6ytoLyGz%!NZA07Co)`AHy$|7^ifh(_LT-^yN605c-NBGKh^Lb(K0y zH?T*zG6y92+q^J-e38wD?LpJ5^Wf(W<2{&j=Uq5p(TLjuFK3i*Z^sIvO$e+Wj`(gM zjcXkU(%08_>blwKzQ5g=e6Uf9`vmiXUn2&5FMC+w$N!(3UaTXh#uN8?I-_w zA8)Q61;4?5><^LhQKq@3SG||zcQ}-2nC5U4Kb1*gw|FsaQt{H!-a95*)fQ@&Q())8MpM-JdProySNe8-Lj31f%%e2|t5&sH$j1CUSA$yta5Y)4i-dR+NKAFO0gcdxo1{mpdj2BThw1B{S~K9Pi` zca@nBMHd(j@ND}qOeDRC`SmzUi0;}^vp10|xdw}$*ee~g;N`T6Yh@Qg(hQ>+Dh|XO zGHcj11oT^&@<{UNo0LaRMa_5BRt_aF{|FQrEz}UUI2MwM9|0$Z|CY%b?0iqC)z z3dtZaJ1yB2Q->qEy!B+$xoJq_+j=c*3vtYYjF9Ya&%>_@h zn`{ny6Q+)1f93}Go@G?`*8#U4)CL~P?lhm^^RB}vJ?#jivB;L9&IGN;lGT?s)GjR< zCFhLL53~;a+*Blh^7*2y0x9KeO8`Kq?2>kI3ZVj=p*1Qzde8A(S{ETTxyb^n0cROz z5Tc-1A!QVkjAF3u{Mt zQ5D)4(+uVE&?^>FPDd@4ESU23`n3yEJ{HfnQh>Z6?Z+&=i5<7R426oLFcN&AR!_Ps z(h3P|ahmrs_Zm#CB|7olSn)a`TmNl%g}L=6Vte|=!ls3)ALr(Yc2Qn|!&0G;jQD8OkE7Jp~Yf4E+WhV=bA>qt|KyQ@;@ z+G|2>b{D-vvH=*7j5;!$=pWct<_p)Ie&xdY)tY^eeo}@7qCjC&kq)mfPsc}bC%$Q zDo)nV@^~wyXAd7`G_@?1c2p%mBtyid@m0*(9OwkhLZhSwg+Z)hV{$+&qTm5-!BlttW zXrfVpB?i56N1^0)&BqGa_{wj*&EdEkv^~5FjWVEp4lL(FW5*~VM=p2EzlQ$vq$y4A zzay?7lG&J#%PJN->5Zcf0#tIrmQNOUO=P`M*ja92ug*xfuWf_H;g?!Sb?+@Fu-Z1n zQxxvV3eB=KAj8O4ntH}{ns6bP=e$1mR3p09#9;0RD5#9)v6y90xe5 zjy=1BeItj|*5V-(nXPWeJe;B^S2p4yi?n{L*ao$RyRoo~ItFujVD86E_O|jIxZZV; z8m+7@5P04S@i?mHrU7J)G`a{(F1k(I^%OlgX@gaR&W)m4_uk&@hW<7EC+vuVHgCrS zJP)4^R!aW_*ZUsgJO|%P)r~QtcC<8~?_UNTWU<5c#95=|!r;#F>z)15x|nje`QYFP z9tt<+HU)%Sr$tnQj;@yW8pPQ9a89_(DO)>`pB`usB$yM2{fI|yd_*?&iaQ`Tu)HTF zyPf}x?{fC1#FJIzcFb9J@+N5G%CbecdHsrJ)>@P_*!MmLkE0dOJE{yxHEDXY9mnL-@TMNQ*;22k*H`Phv1}iB6ARKiu<=1nax7uS7)!K7nV9Is{~i=X?c; zOQ%Zor@ki1M?ejE77#;^Hgt%epfsNpBF<~wCyb1?)LqB(Y+i~0(7&yJg39>ypUoVe z(;wan2zf%DmyyKmJ`CPG&|Bn^h_44H9;aOK9OH53Rj*h+<9T`y=G74-GhbL4az(`J5)|~!4 zW8uwP1g)3P&2#N;j}tnJP-vT*n~U#6fS39dcWc{N`7aUD;DCo4=Xa9__$Qh<)ZPk2+-dDEUWX>=h#ZO0V6z>X8(lNpG}=e3D{5WEo< zoxP24n9Tj>bItY*f*uvc+ z-l8mTw*?a$M8u-!>*qu|rhmu80ph}O<;6Ae^rcZ|Yx~*odV7W7E*l(ld*M=G>aMJc zzRiWfL2f5pflF_N0On~9ih|p zALJM}@W+)koo%enzUHcoi(*!O9lx4QEf0PUR0{O*F~#X;lSkkv{w`q z^;J`g8%m~{vHltS<*b9`&rrzwGSlD;6WUHVV(v-qEfe0)bc+nbZFjmAme-iuE)Ayd zX7V;*h2r9?Dy7SR$WKm6VsI)e51?hodKcVOcC#CA+CadM1(Z#|cnZZ%Z_D}N{EDbc;7GZ9zn}IK%g)R~=Qa>6=}o;oQ&X?0!5fPuW`9j@wVdyg ztWe~Xg5m8_>d}p8j_TGxh$^$Xa5>V0bAD_?aK6o@(_bgVTu`;FrzW|TIrZvaEw|IEFDAeLzd0 zd;Dn7617#1s%;PmXKUJpXiI2kQUma#?C?w6-%SeA2CelVkS1#>XD9z1L=u8el9iq; zD7gJ1H04_E?T|X6mLBD@t4p2e(k6dObHq!kBGWQ*U!#qbvra}u{l-)&nG_)g%#WwK z132vEvl~rI$-#lA6eEEOWL99vJz>M}`+A^ANni$sAN9VP|4wt2Vdon!+5y>WDXI-=Hqe}=*rOT-xxL*uu$69bI$8Zd*3!@* zX)GYh&F#MNfGPB_8tqhL-{i_77h53un?P%D;RDuN(tU^IukDoD#Nf=B2nyyjv&ve? z1gaTSB>nGz0d}TAtTatnBo2ucir7*bW8C8L+)*0WJYPQ74=B#vhTDfG*c2gdC9$`` zZ3z?7Hjg<_dEa7mrboQfl0bHYyJmgw^3>{I8)=dowe^awFUq33WVHtY-E>NyvV7T= z5$z6za1H{~I{$<#8H zW9T8He-zZEUQw+OBgq)#-zmrZLO>?pN{c5rrSlc$-xfsK8$^8)GoAXY~)+Q3(nXf;iMl=BmlD2iD35GS!c ziCv8?=J!2j@(F`v@?3MIsN#3WFARRs7S&}CMj{rQMj3chXx1rl!g&A$i2(n_-LjcM z!@kUSIhiYu$%>JaeV_IH&k4LTn2)W z*#?m_+>tYeVSeCI{rkccLYgL3Jr-@t?UaVSa{M}U>hxz3Og_kiutZbpCOSuovQR6& zCdt;ONfrL5_B~YIhr<}S7FYCokgVAO%0PoE0OLT-uD8n@8)0cK8>nkrcdYJ(i*pHp z-yE!-r-^ER3g;zGozzCkSJg@=?%fX$d3;B+Xs@Q9t|3ddzzWNFgF7~-{`BmJpJZa7 zLjBoq>?Mp*nh%~7<>+TJ{UiB5qG?ZSw#>ilv@8yct9ThTEeXU`NuTG##b81Iu9;o$ z$UkDKT};kf(!T`_iLPOjhwZ{KTxo0Y_%7#GdiY*9JfE;d1Zhk>2!J}q$`i=#5H(7C z=Majz^SkUhFYTgxaD)EmhX16v$!BTgV?UAqilcvyZJnxXPZ)3{I5Io78?v4yQq0bm zW9g{(57@-GptnYzfYs2y#fflt`tpvEoOnbN7#{A&+u=Di(iEAflDc{nxrMq0l4}3# zUKjL-hgUX1<*QNfN50jDBW19<;RQUEacD;-Dh%Nz9VVsdSH}YO>MWIAj7fzS1zlq& z2Alm_=HD63ot|Rk)A%(fEXMtqI8*<%R2$-eM^SZv)rOEyaM>6hlZQV#kEIC^QQfqk z<;`l(K92w2?VmVZx3{8PDQ8#(4((Q*Am5%8&yorB zhCBp#Qj7PR*po;qT`Csz4-O!`Hw2#*(e4TK(L98+R_6b4FVH=?7bxOJeeSHE{Nptb z#863iX8Y(XxU@;y`Whz?(5VGCaa-kl4*0v=)Lm8muQh7YZPQ1#s&4b@FiF=eCOZ8 z1uVGHpcJrJ9ZSsY^KCs1U`Y2At-_tttC*|w^{$H8H@pgN4qZt6j>h1k+VcrBS&#C?YU{1w}TgpG< z9to}do+<+hmR4CngWeFzx(S}@E9iL5%gkceN!Rya)``%$cG7_+m`g8f~KN)0ZOnLYOTR=$FK=7T5hiAC!J-z3E%rAq-Ey%>6 z$KbV%&65v84Sox}fBT{X@2Mv+m0Z8T4Z_G{q46m%;Q@-L)O-nmc#j?8Q)>Pno8>9w zFCau$%EF@mzChuBUs!}|9Hk4903V1iq4!k(=QjeNyg;m>v0R%N&%u|E z6qY2yLl$x@jBKOcR zai?VHAskG(7@nU`t~g{$WsTFEGOgps%{6o8<>mR>8;bJ?tHp}}!D>w^vEZ?ZI<=pV aNUiJpvP3C$@OOD2AjnHAOI1sleEDD9A>K3q diff --git a/docs/css/api-ref/en-us_image_0000002396491200.png b/docs/css/api-ref/en-us_image_0000002396491200.png new file mode 100644 index 0000000000000000000000000000000000000000..4f2df7b20f8a7dc528350ec4b8c2848c8594454a GIT binary patch literal 27793 zcmZ6yby!=?);ors)__yLuaRmef zN`$vElJC6{e|6Z$uns4Yds6LVAs$dT!jSkSF2gaObtQD9bcT4O@sN>;&#>%Gh$%fn zUk+UxjxX{UVKG*5<#fDorBnD$@Z+{pFN8)wwa5t{k>`Ywp5mi1@#w!eQ$AM}8t}Pc6spl40wo00boURE;i~2mro<2RPJW(q@ZQpi1Jl^gN-8e|@9osv( zQlSFO6F!qC8%kBqABq#H+{<&+2;*M+HQ|~?f8rNa7x($SL-EuG{`9B_nD?No(_{pcec{#lo$^d`CIS&Z$~sOVW3hLVuM|mM z+w71U!u300t>mra(8u#!rt?C#nvy;A9oSX8k@u#&ZM$+m^df4{i9kCD602;miSogj z5Qu&3V%HyKUu^(l#)>>Q$sR)^BdQ#)etLpCaS@*{^Z9;wbmQX|QFPPv?k{_p#!c$I zBh`c+cLx}y9(0#pUxt_kNFm0#5^y-k5qSG>Dxc#Jcn8thwvP6|$=zi|4<)2^I$@(0 z=IO6(G?_^B^UKjl3~j$Ol6Xsd!^u6vOy)vY9A|2|m4Gv3{OGYM!1qFN*Q8w}3$pX_ zEmF6A^9S?_tL~p{rYu9sQ4qz{oQ_prj_#uvx0+oJNrk75KcE)t+2rw^XYU-hr3*p<9{ikJYJRG#Lo*)IzDFwEF2zDQ{khX~j>M0xzFZy| z_vfR}NBUUTs?lygmKJPsh7K#^f1+mMGkS#gHF123kF&zYwgHhA(&zQ^Az-7xt1HrG{^5lsZE9L!6h zX_4y*flgx4pcPjcl71l~EQop`N|mJFl-grC@_xTtZ836_&ICOPv9nPLIDioVkLxH1 z6{$C!!ACB0=IF)KoNttRhsOB#GEkC*GHKLI5p8L%VV?s*V*A`O5j1p!sB)$cw=ra1 zBL+&yU~Ro9?EKGUq8qfOv`9`b@WnxDzk}?*T9fFsfknUQ*`E=fS8l*J95%gg^1ec3$heBmhX;4oT-- zLJTV~bgtf8YHsU&%#r5Wi8T85bmnFJ^p+kqE|PjrIM_0{ zq6E}=*LK=$QPjRmAQb6THYwQ%faak$!Xy4NbImW|yvSgcP3!7Ey#nIM3mp_sTPe>C z?OTyp?f4tNN2QF!|46Ci8TvW&TYYZ1o7|iC<4vVPm-ij9k!5?{)z>1P$5OJ_vKHpF z*8LR3Kslvhh9>7abM4n67(8KMa`kSoaL=TSlWQvq zwH;JN)%X4t!W$j5?*i&xDOQv+JOiULy5&#<-O?S2B<;*#pOB(L%?;JPwUkl45$I5*Vv#s4m?4SM+tt1IP@>e`o9y^a zOE|jvui}7<3)1GH<3|A_>To*P_jVOELSzICdN-U;ttKzOv}0W59u|*rYXaM)K z@&qu@X)ZLp&@eh?3fyBw50Y0WDYlVNLFh5l4{_3h;M|6qfRtm`F(hU zBDeV7m_{x0!tb}>;xAJICtP(+#`l|J>={Rd!cv=5&CG&$jxnDP1pu4gi}J!`m!Fa{ z;?2D6Tz01ll#fGPYI?#?1>e6+mgomft6F9LJW-gFoRR$)tUwkYV$J)3jj6ZAv!2Vk zE1n3lz$UC!NkYT@B?>cF(~=+dlY5#P3iCKcpC~wN^)w-o6@8w_w9E~fOF&ZTq@hMQ z2qqGt#3~i4h?3w3RkAiq2qF@QHambSq@a2LJW?UIPHf*GrCvEl z1%D(P0wq~n)v!y@wLZIgiy5XOq4KtJ)wF7Sxh0A5{Jw?eQd1#{L}RN+b+#x^d8WFx zd80n-hpE|mKvjehzdXgI>1J9JDao|sB0|xFXHRKYCPmo9NdwEtW=aE;h;t=(DExu@ zZPVkDX0uBzWxCyv42rH}744_PEg}lI3ihXu&B(Bc(HX-%c3yAoXMy#UvM9YBCSSgj&6vzQJY^tYLk`u@7d`vN>6drTJcU z#D@B!@Af^nrx0d-{JX54G^PWQk#URrbk+bZE&irzHv4yk#=p{qt55*dK2)qCe)i)~ z^sZ%18E-+bH^ESUL5ru!z_u%SwZJ6;JduUS&`rV&#@aHf8Pe4 z?PhHF{q|aL7W2+V*IlVO!&qcF>#5N0^fTRqETF75yts@R0t1y%CgHp*9?rAk6u-}u z5{+6;`|kazI$*x#JN_=yyecOC$vXbGR7!tqu%Pg-S}G0?-9Do!Gf_C%@-~tIPFU3q z@HJ-0hE|0QyVHEO-8YY!FT;#e6S@ zAw??HS?|E6egt^F z8rztpiwU@?qmwvI_=gh*v&41l3f@Ka?y+zD%bAPi;5555*PY>CnhjHe(?T&k{}YRU znRzA&oMje=O=Ru=Lq&nXJXA37ozhv$*MHb%G(eSVlj{Gg@ed;mW00ig1LvI<_NDmxHM=2<5lP?D}u(ApfTi zaF2hR|5E=iEJV1$`DvC>WFD?S2G^fRBb-dW;6^Knaf2rfq~*`50Ci`?8H>C!>DFvJ1=KdYQDhIfZk$x%uTisaqVxaR?mv9}qYN4ay|qJM1D?k#*j< zuaB5U(wp5@o!tj>5m5ue!%F~waCJwQ$^=N=_;3$jxU1Dzs*k`-=C+69yNgP^*)4<1 z=1DQ;dMxx~NS*+@Z+@Ntqpu|Nl;Dpt^foG>d|x0cpkb1U@Q>8`kKM<|%x@#Vg>?h% zHv%)yDXiK7uTP({y_`4N+D_NT?{ajXjRx8>j#fv#_|ewnLr?PEoa?67N^dk8OsWYj z(jf-+sy0~B$EL%i$t(F$;>;^(W554K+o%l81SL4YlP@GQw*6!J)z*>|ncy9-c2k7A z72_WW1X4R)tLcz*W<@Y^$7b_H05kVW8MSb$P8?(`~TMA{36hW*^+-DsH5CF+MjFk-Ru? zZk^Z>RZVlzh(lzbO#atza(yU#|B07oqmR&I^a(P2F+v}7IUlDw+3 z4C+HY=3qmV-rQXN7_DJw+AeK@+5_KAYLMB`{!|H8tgQUw(qIiFBP!^!l7>8*y?#*E zIl_GEG0%Dt`m#&!Y*bAcd?Y^MZN@5uR||1}dNkNWT!I#!ShX}69-s?1iW_McK)UdFUhj+ap)bSg-_E;k%^up>l`1Co7BGk_0B9Z3Gn57-c+-8 zVeuYy`tTAvI|;KJgqKAAh3rR*rLaK23>`5BMuVo_Ae7$Q*>ERNoy0KG4oJ>DZI})8+G}ge@?^C^3pc)x>#Szw zO>vNvZs_e7hyVz%VwZdAg<8ReG`wa{;Rmx>04bRtsqTqgRzdNFHuGD=+<6B&knq01 zL?t011fi1cv_L}J=uDT1vC-@u?sLyKfT0L#D+W-h?Rr?56~d z{9B%D^TOCIjPeuXg+HX&Vk_XUyCj1x12{I9j0+-T5b|w(^BRbLFOmowKK^otS)2aV zpS%SW;l*;Ib~`8wQM=Uo=uXFDX3B(5o1nAsk)u_IJeY2*=vx589ygwzjMAHs3$qe$E$Vqidb5{xm~3|jG71J1ik+D}Y)w!H=`Kz;u7%jo z$Z}8VyN)H>@3OCjJJmO+g?L;2bU_Abe=42di9J^i?>!&T3ZyBy+%mhKp}3uyZ^Moi zoQcSRTA(p3Ky%agHw1n8qQ>!cJJExcw95yVUaD-qF`7)O+g15)-ZnpEaLog z#Fwy0!Y|bDjex$V)EAOn)Xv=HXTn79Kjx@E{vsBLwcMZjnU%z-qB+vZo=xvqU0Lsl zqfcgp3+TF0VF)}@p~4b>e&I6d*%cs@UP_TARd=0F>#0))Xym!99(wdVaYugNVt!gZZ#jzlSCX}oDp z^Kn*}SU)t4bYv-Ty!;CNn2s^gg!1zk^i*>gUzVj-$y4^fgxP)D?tLw~fj_5f&%Qsj zwIrDQJ>`%|SAH7zoGjrRwV7VzyGCZt+RP!#{F}RNojUJQ8<;KKI9?_wo0?L6LCK`R zn7fY)K>vHBqUY3r`19id|D;BZh6Gp46+feb2X` zKN%b8?L}RlKgk#S9QR%P1U8-iUnyLOZ*m071#_J}4Mllm&45 z7Fe`tQ?wcWW&q3mski-^@l>4IgPcfMzwpGfrAhywu>7&Z_Zvzc`Vh341RYF_y6Eas zUnE2k-mQRb)1+T?n8ncyMVanviWnGG^tjK8Bc>x*ny&PM3WdZ+M1HvsLQV^vA~6C2 zSY8mg^m{V#Qdt_Q3u?wKlhGweC;w2x=r5?`xL_$AWZTvHGUWk_^q9lLoE z#lY5$D!VrJtuqiwpb%Wva4qE3{Wy~33%B*Z8Co63L|9Jf%7}Q?vH5G0mzPW#Rtr;`m?Bc;snN8OS_%yBEWgVpS1yp2e4uLZT~qC*Q%>%K-s@cL zJtGX{1zxVxYEXQGM|ACb^w&QIp<5a*E>kQ7?NZQDf_5e73JuAGpRkX!@Tp_2({9Ij zdzUW48nb7kVpf)$b<^~_7l^mq*8z=FKLj9B_NsPR%SX^eo@zQ!uLB)>JTR*(ZoL>fE=CUJrn-uy~h-H0hstsy3mo zdqM$h_bdGq%B6MsCj~)4ZA#sOv@kP2RV$>ExS$}vEiLEO?};gwp771w(r+c9 zXLqAmX;eDL)*!T#Z0z)~)2Qv#G;(aURG!jdw^W|kq5j$iY<%HH$Dx05qquG~tO&V3 zNcbl8E=4$p1aS+S7u%(lEU`oKWmr!52UA2E#M?omz+X#f4r)*G41mD;-z$Nq#eq8m z$MynF#t-)^-yVE+8<@UW8wDQTUt4da;VKAc`aQB>i`_13EPV6RzO>$J`vHG=jd7|> z|FtAOV77$}X)m}N{^LS_$yYv*Ud&QYHw`LhJ$_a^X_2ea$5t*Ywn!NecR&O(G9GUR z=knU8z|KIe*(Ef;e&}VXV#XIbsH$z;*ucFt0MLhc+^$;pK z)0e#lH8mknYye7F2GSV*Ht=%EY9(OgIx2c5VEgx%jmaphfn=w07_hvmSsRlJUAoEO z)fcD80v+bi4;OJImMR@6KlZ*?Btrm8dOGe6P&m-rhmijOO$or7L|ieGhU2vKEfz95 z1brDB#xvCSKo{8c>ooU7TPSBvxoCcTzOBWVV`E<$tukj7Shk+Ci*=M`iZ`~Q)+T^- za~%Kpw77>W#4t!9=6?eR^GE09=`(bIr+V#id12#eHFjm;iS@x(%B^J~+xM`=`dgIs z%%@8bfFXD*u95&rb$FcpyH@3At$Yhm?q_98{<&^Hh<%F z4uTNl{ENcafVVc)v%iuu*4*keobGp$wViyDwA!ZaG?&K}+SF_pn2+rW4NL2x`0Re6 z-%~jJTE3^S`MsWw>WWVNpwHD36~%sVjX6g<_jYuoxDJNK(t{X z_L^ugAMp}!TJ5~46n|C;4>wdO!LjIky4efZQhB~VtFeA7bbGIz?JFv+k9u+9zF_J6 z(h7NT(1!7=WNq^@|)dh z{|10w^psSkcFFZ+NvNK9#dQE;gU%_7#b#!z9b0XTO4A^Ypk~db!8mw0|MGUIP<1?}bP1G7mm6 zN&S%CDZ$Yiu5G@)oyQ0!Mg4(hy5p=?;ao*MNy)WBxt6UabER9MVOf22NvMLbvF)CO z=p?h<_>Z|i{v8@N9%!-b#EX?ig=^KmlH*t;S%|o2*s-uLH9-(pFHXYU1HlhM&!;!f z{#!Q<4-HM%cN^;u9i&awk9l{2N7=t7I&KnEUnR#xyEk!`r7s7X$#vTxU~nk)*-70lC6(+6+|9F{9oYAJ!YPL_%|9)?#^;jd zt)3Ti#BA?{!{&uvPCC`j>8LXvdACS9CbeKimx6CHs zm!ws_e6rA<69-y71g>=CE>Qe_#KDjRY_Yr5I7)bPeVkxO3j7FnLEQgt<6!FXgd@Av z^+B(+snk!w>rWm*J!#C8E!R4(GvEc?*8|q^Ra#)@RXe&(kjV9YSE6Fb?l=3Cm)ik9 zV!DNY3{-(UK)=A=T%h(i^C`MiNlaUywU+e;+5pWujaH)rI)Smx97m96l%}!GILG`S zT-!B{xejidwpAN#61G{Z!X=4H?Tl-MIxSnRatpL31%gR4f_ha)^vVWwzG~IWs1Fpc znl+p}St^|x*2;Z8(!z3<$S4u9z68mKd<1N*o2-hv$0y)J?`+P*+aD;N?p2--f802K zkZVwPK8lU)3WU3P8gMpuH{-qd8cPvHHvfi2WlEx6Od3PWA%=`~?B}cH!Nm=_IN50C z@^cUW-OOrf6GYTLpo|Lr*8)CW&es?riupVF3io{#H{@96Xj<@C(eqy{`4_msA{y^TkclUp#h39%ZDOdb|T7bUSrp&vF&GhB7BMHg+OW$4g zM%bhkcb)caT9O3t!yt}&CH0|5D!!p*+7^{Q{ps4&m41c3q^QK;RMcioTcsTsuA58k zGNGP55z~BYy!lF&LY=iQYPPd1vAzvz(v?~n1hZ}pZ}rOf6&sRgJxkY7qDjK)9~EY*8-*G?n@+At0;-n| znuH|V1kQY4bcz2$&UfNG#FTr4Hj9G*y{y*%ji0@5g}3r8 zX7x{d4FP5J=kNW?5hV=^V%OI)>9C5r@YV^Egx$ z_)!bOzPNhvz_diUyWqj-t|Q9G`c0!%;&h*JwdERj7)vbd2Js=yOjI~yH|pA;^b5-z zjY2l2$nsDMFPp$c5#h+Y+$1YWyV_~w$`GVbG(yK@`x2$@YYi99<>_vyMEAR{`NP?j zwXg;I`wp$*jT2;v?heUf@n2P+AViBQEhQkN6aqxp0&+i)#5kUB=R*>eUaG4=AKR-o zp3CZ1wr&wr=8I$J5j`BhrJvBYJV`3Abszi5n$8)DtuHQ#m?aLOs9A_!PE_Hl%_O?8 zM=$udVbaBp?p>>b{tMkWGK`o9hzcbZ#q*{j$K&Q;2n4;M;$3uugBsa5fxSd;4JMP% z{5hk;WksRy`m9tbRsAaC8@6Q9{-{ayhG6*6lkTKXDs%+vRnLYp3pcA(@-s_8=?VMT zl=ig>*Q>feeGfOE)xAI-h$LMZHcH5zB`>(_v_LpY<+GfehTdY@K(OdyWiApw-b-Q^INv}fthU}4JVdGU&ZZni5$shGjxI`uUzBxVPJ zFX4NA+yOcitRpqXy2s?*g9O5hX8i)`cd6$m%&N9{i=O0=w~IzlPRJto?y^7X{o8?r zB=kaNW^UIOEyjhY3W?rp^+KbvkYru^Yc%@~BLam>Xan;iRLVZqu2R>uvZ?G^t6{2) zZ@HmJ+u7$jIbP1Cc*kocD|_MiVJ&Bd)Z+nS#QCdN>5P#$t{aIwF1+`AQr&1`JI1a{=H-PSzF_mh(tiUNkXX^5HKk5YHIn%=w0>HMLJv8 z(n)>0^2(`iR`$lRSF2=`!2Vkx5CqUKD}gU=D{zAuM}NQhxQ*rH-luUo$akB#E`H-u zOcQR}5W&k3S9$Lq9VJ%ygU;2l2`E$!&-*1PhGyCVb0!62XYi9OzhzbN(+zAO z!)Nbd%Ih!)mN=>FLD?SENc~(3A{VziLHy_syxx+BIk;>y^$gqE^8_gymG5U%JC` zujMM&X)9kmG#-v?){O7yB0=UZMM=*Fb$h`;Ir0ohkuJ{&0{k|=K$zk&7u z*{v>1qW4TJEGf5FcTb4(f=#@Yd8JF1rM|p)88MLAENSe7XroCO0MAz-C+?1hVm(?V4(ZyxN>2tL_4@O z77L=xc8!#0JdsA#{E*%xc}-JAPveCbMq{H%?BJN>sS5(7bZ)`ZqU&|fZ$adFR78W^ zavbe0iZ?H#=rBL5yLtImi%X-vUSjQ%6SHO5RWr3gtS zvU7dfN2C`$iagmgi8yVWpJ)=!=L(&ShOKBMyN$iWT5F1|tW>T}fVi6gAiL-Vb;NDH zLsFfptU>s_B=>GK%TU?ll@U75kkI7OJ7m6P=!Flvzc|@PBK(b)<<(r_lGff@`jy@@ z^F70RSN*?4CNRC5P1HZ8;}N1s=#JDH}C4Q4AdmVKv7SpFkz<1l*v{;0k4sUuJ9fn%zX0#T^WHZmliK6<=xUe#4nLfWXz?GVT zTH^DDv8b2P5@e!Oy_zZtKBB!Ct`5U}%o2QehZ+&hEKzg^8YV~Vzu z;M+D45$hI~YZCNAcEId~pBTc2yi5|Ee~hh$C4N=!!FBF{g*$DDFP4hBRE~*8Fx*PH z;8ht{wbL_s8lg-3s~9%^DIot|sB6^S8@%D)>2FytEUj)l`~d!5TwzXxd`v~CJ+HiE zJycM<9BR$%RY!MW?xz}tNWfqXDieFEiRUPqAVpf+TnlyUEN>;6rnJn+FYiQ$dWSWn z&4O&=cu5SH07ud@QwHq)gTT$zTlq%MdRk!Pb=0zu;GPF6D*>W@Ry`lVULYS17-1&z zYPO?O(vIg>rVy3Lmv(FwCW94o;Scii$>?=peWvLTx<|tK-0dh00Tf=r#*@BV&sOyt9GGZ0E z{UOX3bOhEcYN7f>=G&{&ES#z1{ro-!SIpKG1d8)H?5ym_LRkdi3H zS4p^w0fYOgvCG^H2uiKg*$PR@7fkiH;B6uXa}rdn1h{Pk93-`)${AJe_s*9zL zM)($tk1f@u(Sgkp3L5)JSomX?qptdoOo4Y;RJLVfmvtYRD=I5FV%Z0o`*~cg)sE-+@4ZMgFoa){{{j7QjB(ZUEamvcd4zJzdN5_`bE^cma9v-|Tv3LEJy_=uYQoqG*A9jqj zx75!gBC`ALxu9mgMAWx5;smUqHgB9_g-gqKG@7|QvB1?C+ZJHZ&BI6E{;Jq8?QE5l zU^*I?WT%C!BWx37higwR(AaRdx%QnM-WpO-z7!F&E74cp%@Svj7LxU%8RJ8ho&$y#-Ilx&^y?NT}jeN7OAWG&gPB}+5_ zZ6}Gg4jD#0@ep!iO2+)S*A<4EnVIP!l=Ybjq(|8iw&bZR#DF|8ecb9!h7=Q28Ni+Z zkuI+dq1^Xu>pWeV_WbLoO!w`hQ`1pc{z9Ecawf}(bXG5w3n3iVn+njFPZU`My!q_C zrT;5@*{)o?^?!v)HrrRxGT|{QSYe!Bxdd>j}du!np3j?H8AM&Fa_TDLrIALd_#-f1NIdj!eEp4J+ zDDu|S)R#`mXnF`4U?s=v$vzsv)x}0(k!@6OE5`{{(w7R;wyu7@=zP_}yw6^xHP~FeZ@8RJgO^H5blmIQ%tX79T1s zeVFxj+Rp>Qu)rcgbRt5tRpZk-g|(8TSB)ZyFB-tc&G(L6REIonjXwx*_(VT^W#Z6++Z7~2kXMdp z;?FNgOreSluxH1a7M|{>+%C{kB%opHizH7`ph*m1)w5=aBKYQL&kawIkC?jA-{FHP z3{-ZQyCkdUL%CTHOih-f0D;c3FzE(@v$ou5I7xs>abYx*x|aPNPpre?Ey~4GvY*f1 z1SJ&g$|X@T^3$*F45NZhXH;YCDNT{D!jsl8G(4R1um_}s1>mq?O$Vno zSp*fSdZ=8ya-1PtiXQ5ey$ZtDWjx5rB3nZ>${{mg#8)W9U4mZwb}TtGt~mPoCao6} zBTEk9&&wC2@q0kPwLT?~vi>x70yFZI*Mm{F4za2x~11ID#NbvNg z393-}qVRTuAU7~FPn-{P!oY!d_3lO`iRx)_IC7$kTWk1UZ-iOJG}B7f=o9HDWJTvr z?o1w8KNo!-S5O7Xz8;a&73sN%A_4u=q63JPC(q4VB8Liegt42j z$e5Qcy-63?@2Jb0vx|p;61JQ^9lCAO_%T0j)O*xK5f zhmfOwG66|kQOcW7T2^Y;h5RyXZ`K`JjYESfxoWz$Ou~8uLju0xFYCQO78Ub^>V0bu zP=>7F@2GKblWU0g?AAC)49h4H&}T#D(zw}w703v2>!#r(3BM2&hItf-rzl0g15tbm zm~%`M4GF*|wzF4&6NO{X2Yk3-D&YB`_*-Yd<2_N=T|WSeTqcqq8ouaysKqdgygr9@ zP^|igWz&Qt?&f3H%z;Onp>Mp5jZFIdx%xOgy;WW6`T?7M(0w5S$h#J(U{&inL7vh2 z=HNR#+!#Ku>F~aAOCswq(zfH!y6+&j$&_GdAINjfpcSE(kPNpXqK0dHr<k&T5s*>zW0bvp(8#r~ZQdO&Djb`z4SN844AJ;+cnwb6P!;cN#rY42cn8 zrRn>;N}~m(${IX*Z_R$Pt&J@H8)kYj*}-d5qe# zMlG9YzCv^TMk&>So;!~>*h{~m9?JFTqM{}sn|FqgI&4QNV)}^^8qs1GjPe~5qqIWt0+|NB z<+vJOUCDevwF!f{cd)!AY1R!Mp?emW8>z3hVG%u$z40%udzDagb+$GV4#UH;`QU zt)MVKTy9BbiQ9Mv=R3sKmbar6{!gx^@sG z^eozV&0}hdKCp%(ZuP=oGk7lZIW*@;i--zky37hKg#u5UI{pj6hl#9TT zTTA1K)h{zoW>uP6e!EEl_3w1u%>HNTa%J+gXE~-_1Rx&02M@v;keMTzIGe(8M@(#T zo`;LON}mdhRd%qRY^`}j5=K&ty4JP9_(lVeZcRlTLfegUV{{u!>3sv~WsI3rW?|Jy z%oC9|Jug+Ev8sJRJCX+`7$P_w-WGh1NxkApY8UbN5PUQQ{W`o2AMmcYiwWV=F{ye` zn5`S(;A_ED zc;?=7PCnT1hFDOFz9Hg4_!Hfd2Z{pusbk#mqS4gPV4xEgGX7B2`K210+8^f%u~cVG zC>IGYleAzt-9$(M>uLb!>qh=4#4)xk|H-G47TfEC>Z|h~Q$r$BWG^4`W_Ih|*12%b z)J*hwV=;xNHtR;B0UuOX3Ss92&Wyda`cu+2;)7s??kSAsfO$bz_TtlKhg zR|QCA7=>QZ1f>o*ytL=%q{aIE`A>OWbvtS(-=?!uX* zTn72CZY@f<1RSre@}2Azh~RJRDSi=+mceUsbz#NhSqlTN{4kp4uoU)GTqtxlhfJlmXB)1(R4Izwg4v=P=5Afk#W-^5OiKLlZQTbQ3{fT;Bc(6yO9XV%?Sai0vRW zX*C}L34IweZuBA&O4n|xScttgU!=HCdt9X;L($sub9O2Bt5XLej?DY@-lgTSmoS)z zP)8G3P|?9wLp{AlvO)!yXLLa54&Tgpgc!$#{>8?-sAZ@HTDXmlK*TV8(Uh%&_G+Vt zQ~L0DF~?x8M#TxCsO)MydCY2V#d4K9_d5_kMS4GhEbvxWFMzsHr6XI7NT*zDs{zHU z*F`!;g+XJ*_~`1wCu%30$o7RdU9{1g;2#Jw`TJ-FmR zTXk>Nc`LF!&?`ZDLDR@uh%B+tiyvY&sZa}K>CtOjG15zbPhmOkY6%ZVl9Y#j7JKg3 zZ9{@2ItS^U;nKPnueEC&DuMs;Hge=TX~A8m#jRRY7XD`EtyM}r6Vp3Sw!AuLUQ~Gr zoYUju@d>B{rn^RXR8+{EmSe=X-L6qILdjSB1>JJ3H=FAM1vn(Y>m{yhem#4-jy_~D2vMC(9~DhurpeL3 zz)y$)HV`F1=2b1@FXdt*Q5jmK*F4X12*@k?rL-`(q|QY@3=P?U?&A$viJC;mj}GDC z_NQ66uBV^b6A|pqLH)pp`RUJ ztEyDIxHMcb8Tg!1a?5*bV_1*s8p8l<0Z?+)LG9RecpzLUsphS6R`OrPHFFuY`{`8+ zic-Hs`k;JypXy3FfQuOG6JgEe|PwNxJ zG72UrYnd)T{K~f|uuyYj^ugy29VTJVpTs0z8#(w>;I5u{xO*{`FBC1DZo|v}h&xod zQF!Q8*V=V_agF~$jJ|2Tcc7IFFxca^B)ai&{uk)Lmkh8)qi{dHFP%t3)id$|G$vO= z5;%WslK%J+t}gPyPY)|10~A{)&MwjNCy6rExzs54(&1;tq!oHZMd7X(i21&^c9qAA z9T@m+4KO5gJn+3PpO3#_%H2d%5E!}DXt59k{khkcDffRg9-))`5qVx#D(Hbo7!Ow{ z^vD>>fZ&T4qamI865VB;tF|A8frkyN@cFNEBb2qLYvbXSPAfw`UP)_wt_T`4pR&Lj z)axDVyT_ao zHjxvs*~@9U^S&AUfjm}kIUPTZL2o6FN)braGn-dkrXtBe{<(@|)7tkXHos zYbJ)%3doty8g0KtdSr7n@5kRumW`0S2GLn(H~(2uNCTYMPp@dLrDv%ZLr<~XG<#S* zGDcj_QldB5m`{Yjk7?lq*lr~8>UCd?ZD)rqetQPCA@8VP(J#f})VvuNU}$(zT9Q;| z-)hBIJht8Gj~*8@kB%oc%yoB*X6DbTwEk+_Inm>LmmbGLNd9lcL(R5^q!Y(hMbhZw zAjMQ3zvK3do}@-w|Tm=GXr()UibyJrLiw?vB1QemWft~2oLYbe+(mWkVxT3r0)c~Bg-kp ze1^>T@Yno{Pph?W!+Y@2UdAaf7(OoNpJd{TrR2>G>vXM9-o8irXQfQ}^pfn)*{ho+ zU+s4{>5Fnk>|{?cY0@2hjy3Q~)FI)k!js%PJ2j7eHnQHyOQ?JGu+Wz<7aPkf9pl%S z9MLDyDtwdn-znv%lpF9PLzm*r4T-J(-aQ-tw zp>Z#|=oxS37Bxwowqgix; zAi>?;Sv8a9z=~^J21a%+Wac2;UVRi&ZuO2|o@{ zu@zY#SSENSr08)-mzbFpL%K2VPL0okEj7O>ab<>`BR_{td14)sIeI?C4RsHCK9jqF z9>4ubdOR)Cm%1)*E=xhm)iUb$aWfK|Q4GrQaBf>k?!A)iUm9VLCO@{Z5{hPX<0W;S zYn`1(vF2MRK_)ncu!boHVUcvZ&(@2?x&;fj>GCAUX09n7c1k#M$vrYS@DZcH9A>p^ z_IWB4;rqINW~hhnW-;Ha1n!&y2I8f-W>|Vnss8D_Uavz&-dnCEw@GsJM7M>G9IRhQ zPOI;Q(`wF6wi1i*1;s89H$peFUc@7+poqH(60FJs{ldbW?aQ#2Co{inJml%+&T=r1 zZ~DSet!irE7ms(m?em?v%6jhrnPeCz!K$nDg;`F=@-s~J`dDD)q(Opn4a6)~!QX87 z!{hMgayGe|?{hPx$+GOybu9k3HKa?D>sSkT*e{iMJ~i_)Z=T)pkp^1jAo07C>PdLf zHzpEq21o>f`PK`r&U|A>erYb}zn?sW3EOhR9@)skQP5XijSs=a(_W-CnozwW1a7xh-qs3Uirbf9Y8;1)lYiV2 zrCdYB)8G zQ8jP$UAXM>nrD9k5J_pll9(kkKD2B_nw=Lf@y@QrO3 zqw;}vSO7GUh=1R-?)0NcA&9#N-y>2pAdS@Y(2wgD^vCBg?FuZVrLm#>eg|Y*~hC=Kg>*iia7fRUn7WvJiaOYe2){JEFa?Sr2vf_vZUc#Go;A7Fovd#^~w(D z{?BXMbSUmqR-!A#)o1d)o5o$Vb+7JW=z|>i@fP9nm|-XR8{fVM-5YZtDz2evT?rD# zi2>jIRYc6h|6R<&#zjCX{M_vQ#~aDsVdDOjDYIH`qQ3Ni=itysv_=|NF+I?1)m_Q2 zVCI7Z_f}PW&+AqaRec44w}@`_g8kxD&Sb9Owob&R3GF0(EzRATE;P=nsJA88`p~SH zuocOIl#R&$hZMP)KWZZ1W`q~Gy0{oURg)uNJf;hpe~WZapWXsOx@@=wI@7k)>BQSc zW9#P-TlbK9uPQ&*aVRc@oEsQSQ#UKU;tKISs;CeK`7&n+4!^6rw^4(Pux%rynnZol z>4u@j_8uZ;mQB}5KQcWZd2gXH-a=fW+_cADD1C!H#*>uME+fU(XxJ2lQdUV}AOzfb z@u!GK5TF1?`tvgQ;#r56g$;(=1b#rV+`$szJD4CymQ9|H6By*C4j8uPR;<7<#^JyF z>0u$BN*_TXLm#fnm|y6QBGXh?S4h;AnVG4tum5``u|U5ki?X=;j%&*T!McuX;VsG0 zu>aE~#&uDmjd@c8Mqx8y<#+cO9KP`qwz!X6q^p@@sOJu$;nCRR5qM0Nv(8``90d1!%+Nb8{CeJqY&}C#R(dgf z3A+Z8C%KO@r^1s{XKWJw8h5zzU;{z*FyeVmI@~)}YAxz$15UtSH88(KY%@1k)xrSs zhtEGHzJ*#{>;ZzL9#!=k2-{_WA_4*eAP|0>bVyg;+NoFT$|Zgb(Bn|U%LiS}UN%Ev z7A)a)_%HDzFAf(r8c~^jhqMw$!;l#XvB(V#F0rT}Xn)==_IgXh9{9{mk~BY;GT%8# z6_v61pr#yLxG23KzQ7$O1Xk$UV>Tkd6eJ$~u}BF2$d{=!e%Z28C4%Sg?k>sq?EZKB zKcQ;O5#~Yco6!VX-3Sc}@_y4}to3gMWdf|1RwImp-3TemOmsopjVKrxDOk)Ia6CwD zy7R}T!WCA?Nes+!rnQQ`LjA>4=@cm)^z1I$jYy){`MS5ku*+6`V3=Y{JKC6C$ho%= zF^~jsd0^mAE|BU{m_wkHKDf~J?=NsiEqf+$#V>j^KX(j4E}o<{RQ%wZfhv#`81b9B z4+^|vH!r``-E{hb;`s3P{%L?(1(P{wO&S8UN4m^~W%5TZ;123~5-=sW)iTFTK%x4j z7WF(y&}c(L#T(GWPm#9-9aH1TTQTn|E7z1R=Jw59PKt1LMe&B`bdumxC1_kp@dG5J zkHMbxcbb%Dj`-7aoEB#smVPg&IghcJ;>fK%lQtkiWi|aUQ8pkjIIzC}nhL_=@P_B9 zAm~-%#Yq9gARuqyzc%3J;FC{aahWVXS?gqmldZ@SVq8V|SeWJiokBNlV z!@A$6RoQY2`}nd$7`}2DC@Nx>Nc*4(Z;f4iap1Y}IT(E!s-&B)Rj7{K7XxkG+n!}`h790BYG#Hf0J zSkbfdyw;cJSzvc<+aU-kt2Rj_Vf;pt!7_TB06XXY%7(Yw9zS1U-G%UA+l}&DxJKNL z!rh3UWekeVXq2ak9}EqPhmc6*k4ohnRKWDqo>BGOzWd_w&CpO3i_cr1@gYC~*u`Vd z(&_zc->cyGb8jeFdLiT;A|E~aufnjbuA$C}BzYyc`x8d(NKZWyR zynfa$$otDwPPdOW^S67I+{9d5w=)Y$5nMSHzexoZZ&1t9@k6^PKH6BBPm>J^9IA{7 zJH8}ch=k`^H?{{>6$@OQdnXeL7j`By$mx>nfY_QDRDFn>T^XJ`1Dxegw@Gi8<{<`x z<Bvbr=g;)5*1Ot+aDwh<47Wv^RWPt;IWSoJXcp3;bcE>!E_ZG9HQuEggGe zB1A+)j3w5jL|htk!qL&uK~Kdne=j*?2VSe-wFK?ad>GcF;hPSuM%}_p4-c%=VuQl8 zJ(IsVV>;G8V)s;Pl`q)y62|FOYE^16(OV{mguv^wdc2-{8@O&@rUPJqn*1r&)2`IA ztJf=>wBgOXGOGZ7smW}g?yMd_A?P}}QFDsb?h>xF^B5q3>_f@loc69Jp|gS%Ji=SRMKr&}UYwO22h^Z@`*1YQ;tWm=P;YrEeqy zg~cbJuz0CtpsgWq=IFNTyb49dnk%C9 zNebFr#?oB~Ii){Cn-LTy_f+*;yA@I?wfH5Qp6(NxK(cx6{T_=CL3kWej%r8V`6-4( zu~C!AW9nMy>xda)2GmQxjBerSv@wFDJi1tOnBoH~_n8wzLdf%0e@477F!e`jnY8(L z=;80JO1EQMPe_>TDKT-0(cZ$CA&s2Q|9=FE|Fw#Cw;P()o(oP-Pakm} zzl@9;VlL^^?H#y|JR@Soz`&paWJgFqu8_D@Gw4}x2pvlFmryoRV>{(YlJt_Wskyz9?@S6w#gVwzfXsMo@}H>1Xivy=Y)6=TG5^qoS|`K_PJ7gc-qioZFE7(qJs1FFEri7 ze3Twt`?974zvTOsXF2f$rFqVobPPf(oH$LeMq z*@Q5xp`Lg*KnfGzz*QHajhQAs#t7JO<7z~#xPNXyNYwiv#Bt8y)U4tTe4F|^QHR*&_a7nyp$O6~VTyen=-_kgInXnPU4eOFU}6u8uP=@9YB=FG#Du zs{!pl>GDw7LJ_2qR>VH6pPzUrrn#P-yL93p9f1F?uCzU?kIhWaT+ zGyo@yh|<}Jh5U)-Gm3-4<%BDjFZeT~PtJ881?Cx%R#<_uUeWOR#a*nnKe=U7#HL%c z-t7;YRCCtk?>|A+Pl6P}JCCxN!?J3bjB`!Ye7SUVcl-J8Kn-}I<8zz5@8j@u6$0)0 zgGH_nQO&TBgCPaZXC_p3dp$>;6Uz`&$1~Z3&1Hy-NJZv7tPL!8PFpC+cV$99YQ9R7XFmq`? zB#?R&p4&P(qHLcStQI4AeHt<={UkJH!yDE;XS`>5<)Tj{4h1B8exvKQ47Fm^iD{B; z!%Yn|cTV`7fynG_TT(C@Q1X`4y`o|F9XViF5E;t$T`|>(GD>gO?%L>bzEFKWm|lr` z%iQLtnD{Z5!h3+8@6uMWGiT3T;=Xd|tg}n%GeGXGQd3)GW?EwVR5pF^k8g1=s2((b zhdVT=5AzN1y%Zt?xXBVDhJ^|w}epC7vFm+Db1Q4#57i#ecOIJ|PXVa=$bh6~6G5Z1U2sP1S z>R+VhuC{q!stb(g9W_Cmg*W&?zEyim%!+}#vsGsgQZ-DOPg&hBTdY^9Q)EzvZ(H73 zz6~*<5)82ljziOFBMLuW3P|Uc8lw!PVBPl}1|qLDay01cX)%JqGRPQF^h|U%YlbfQ6wNwulCb8Cm zJbMcpeT)vjSCnP;y@I9~5NmgDbYz<(?Yr=l;M1FA!HYEhOxb1P&(aSw4#q{s(AF8J zXb4&!X!FJ_(K9ZqSt9@YIbUxh-<9B(pTM>iRzsCL9`;YGHm#=%(D*X6HTSYbjuf2x z1%vqa3<390_P(g*;^*{z;gRrbwT6KQ5L6v7%!6x=YGwGk;X=IevhCQZ5!7w54jI}gLATwmoCgc z@m}3Q_fFr=fRCXj37i;Ac(jzqKY8>LZP&d#fm%0gMPfT%8j9oMtn7lxTq)D?eNCZU zM|(6*u>2JW=Z4 zKPvBhwAYLTfQ}u{$4(t9voNm8Z!#e)P=Xa#Gqd|Iaku&1=*qp=GN)8c79YLS$(TOM zSjC)<&a+)+N;h@9VCo1zz{rOkQ))9pmUkORc}TP;->!-gKK7JElDos@pw>S#w z>gw9+SP)3`mzFqe%lH4TL&%YU9b$IB+C82$22qa~+y6CByNhyqQI+0(t&``g`|@Y! ziAAZ=t$pH82bBlk=_y`l35p1~Wq#75dM{~1L(`K7K z$k6ey5TdI<%s5dhSkxPq1l_Ov$rg-UqSx~KC9*Q`e*Z*plHbRMr2%d49eQ%demR&6>f!@ha^5{+&-6Mq`t ztT=wNf)w1cm;bOe&*WRg@gZr?WB2>(-A+e7T~M6!@ofhb z-6i066Z|U!xfwlFcU;Y(x)&UWfCF|rTH@`Fc0pVsd)b+DF39W0nW)k1StB=B9VBI%NoXT)eEA7TU-!8YlBMqRN_Qbz~7t{x(0fy1nxx8eX^bIg~` z30oTwCl&r8d2u#Lr9|c^6#b(z7@FWXUacQH>YpO?E58Wrw%&h=kM?YLm-xZvY{PGR#~cUpcb6h4&O_03zl zeXRztJ+W0?s4x3%M;*@X=0_ZBx1+5e`&S*EeCk#s^Ei6n z3R7^%N5i(#%nulgkw%kWXowBqpn>5-KkVy*X`=1lc5)Dz#bGA>_1OfqrM|6R3jUit zi<)-3f?Lq?fP$N@=gayUPOOh@&Yp5tC{?;87-au0P)r@yNI{0*Ytmx(DM5m`U*lU= z;Ec(WQ06El)&~^X9uQwFvm#S5_@nPRajZ0ZRcCOsO%`nUq;-LDRxU0c8wbOVzG1=s z#)8hYpp{B+ck#PMO?sUoXsA#1UvH~qQ?SGNZhk^s1Q9g`FE6*ha{$#_?kun^9$Zhn zyf{qQLa?wh(jePdByr23;^b)A(~|8V?LoJ+JcPV5$`iJu&!99NhIeR`PxE_zQNmDB z`}dSiyVvOsRGlH`zVUVS)#tXue>>@Q=dAjHoY0M(K7=p&EvCdC?KQ zqtPf0&HmQd)ymN3Om3{<=~0Hm>niubj${^4oMpL&j43W$e)cJh*Xa_4UC+AXNC5BY>+A zNf5)nDRW#XU%)0(UWZ}?J%6bmN?mS`7`@Vb38aR=z`PfE? zoJ~p)22q>g`Tap|_=UMJ-h2qtjz-vNM#H&-J%r;*+H7!0ql`+Hc4hX$DcBifGh&x{pYOw`#LY226?}O8 z4D|q1PIIgZs_u@T+xgw!>Ga9zO&Z4M!FZ3u|8;e(1L~5MsoaB{;kJ7yGj3Ql!JqqT zaURQQt(|Jsr}8`q8Xn$lz;{SV<%owRG;DyF5RfCKn`>&Z<|?fC;Lr6VZD#%p8OKMw^&LxpHNQYW!lD0_Kg5|qh&FtV;J+oq~m>Icf_) z2rimk!2(Lj^@IiDCb>Jo2Q#^Mv&iWV#wEr+Dfz~KY_cekNZ7r4LPk6fXe4e|{WlCs zmRr3x6I>GrtbyBtyeGsWWx7bWlHOXbh%kj_5ClzPt~L^DsMiZe|5UDyE~ut za)OGi>^=tMeg5_NaTdFP3aXINCW?<9oe~05Nq;nEd0Oqp-rHZouF6K_=Dsm1nCS8y zHSWd3Lm>jPwA9>V;f z;f$2y=X;OpUv1j&Rt73h$OD#7j#9*KQ%+9OQmhzTzspB+>&xYr)P0&T&Oj5}p_JJB@-ao5wsS2RT!5@0iXh>}QoDm5#}Kp!V+NEo&A748te zV;xA%2hdsi_g_7c4}r9i;z<7B{-FS#|6>VpZkl#T$L+}%tG%|?Tj!q`jT3Tf076>Y z@G|kPUK4^4dQ!A$xVoPf;Z4S3^sa#9VQyL0)@#IbG42ZuH{;*#Z6*Y%s*7=DonAK&L*;;0+`b; z2oGH{WZ|E9ou5naZ0F^VO(0_l^6zJwG|udTRa$;4wR~_nqwqXR@id!(Y+g8)WWh;k zX(b!TS&PN-5-xln%e%InO|V_^J07^gr;HlgUiZixe|-|YyUu-?5nXt({>0Wg*L3^n z6|f0ic{?6o0!YceF3iZkE1n#qvmqx8C)`G>U7fS@WY-pPHVKIM=SUQTmqm@tAYz?1 z@Byr|yfaw4HcsdeO z0fV2mF!35a52dw#R=EfdvwM;YAO*KVXHksn6KnSM(mVX2JJLmY$sSirW+i+H3^qB{ zn`am1zh4v^@fXFbIB5^771bw3sIumZ&|TsOaV5!jDub4t9libebrfNo@_)#LIKODI zWOG&<>I(q?&P@a*ep2+3A*s4pk0RbC=^c`tx&EHFb>k*A_thBIuaq$x}wkO3^GrC2jg zIg?vLiOEgR^l-MIi1>3f1q+wBhO2k<1fyp78N8LIypc2qEfA)0FAFR;hg~ebSB;-VcxYt+C@8f+PC_5QZH}{F z5>c91LD*s8AK&k9+=O6=ARrz*Lqd#0H9fxe7b29`hv52ie#QGHY#^z~rPZ|5stEI-7ax7B60vE!jvbTRK!wHY3I zVPt;l0M{~kSDJXWzB);&DOA@o+k z&p(E{BD&)>ts;1`#c0P)O6p{Lnhn|GQ)tuNL&czxv?VhNm%H9EvbEln@-Zm7xp@PP zphF|PxF1dAh?$uoX-2;H1KjVkp&vwHBcLra(I}cqCf7vkJh2#9y#c<}64$z4naw@L zE+{FBR2L&(O73%dbaGlGi%3I-j!jVR;My0t4q?*=ftof!AOc0NfBz9JH!wp;?dj@l z>TP#rCM=2QN&UfYdfN~ba=WEAlI#XG@bulp@fqlpH{3x8D7=*3VI>1^%g zL|0D-_70#+Sx_3VaSa0@0vgv|ZW`CL)>NW<6SDID*Gun%ww=!&ozAG)r_NQ>A?EA< zxNFF3sLm;;ismi7vdrn~+maT$k6+hT7dC0pBw*7EEe`Obnn!h8D6Ubk;OR`Q4mBAh zWIz(w00A#3$B=@WaUech^b>CF4>^&2hV;-s^J@|h4=7mR`saktlFca*n(2l0LCWb- zZD?htEau+=qWuNGuz3vR9WRmEmL7^UHOK%33G@bhP+*Zh!oZo6I}-txM4IL+wac#? zR9|Cw8F~CGmy@>DLw`v;+ijI4z@50&(333Bmwf-Rpq=}pYR2UZ7Vvf5VT_O*1{TR% z4#Ep$jV}1?G^K^ABFD!zqra%V^*R4>@)y%5^VU(WNwVRJgVJ*ONt9-#@`Qt#{D4)) zzg*ay*2k_F`sWdh4-b&+{p0O5?89spr_z{Wj0R_XF&H?^z(5LTEsTC36jbKjjL4D`64L$1m$K;N1qsrPwn5a~aD zSjFt@T1^g)dNU%hvlj^hiNej={%@Q35S(lHicKj0Q!+aT9LU=Y(YpD6^(Zl9YRk%v%Bm@L2ye~HoS($w%XJ+=^GyB`$M5?JMkdfRa0RVsu_Ts4q06_kLzY~b@ z!0&err?&y%?jP7wSuJnKT4s$i{j2wFXU>oHP=euj;;FG=Wx<5vsb!4HHuPi=NKD&v zsi5J`k6(WyX`##_zr(I^GdPvSvv0a#n^eBJ5#1<%P_+=Qqm4!|LmAgfKdAyzU5IhnngaaTTDQJw5t00L9#!~}Gpg{n#?HNFT z0;o9h@c@LZ1YytB0|5Jj5FA9}5oiNQUU)m|)ulEBxI20|sD?t309b-GTA>?PFNMzE z1qT5VDlG_5jbaS3mc6tDzzy-QYy@)x&^zT8SZ;6-1pqPjm#^YbQzHOy!Jee)1efLk zlq=bP{3`?iBW$cJ=E}S-9>Tsr|Es!@T|&A=ya{p+0 z2yE3#0<0xY>(W24GMd*n*p`nhovX)UfxFX6AZD6qx#5asi*%2b>dTRt+$ z8J5TzfL@t!Kj!~R2+o8X*JB}+CUOA?i2J~6u&iS-t*>I-L6g$Sl(yjLQ_P(4O48&( z$~uoA-=|m8YjQE)ual+SOd8QJBZVX4hBy_>U=Lt+{F z&xy>NR#$zUs2A!@UH8>cN+hH=;6!r~dQLugD8_=&;&-`ft=8!N@~xYQXg^@wgOmjH=&fN;4ur=+Iq*dX+~PIA zO(dMDAhx^2^!86)FC~I$HOX%>&Xw2=p6l4Tk(Q%yEIAQmoONPGqQka@(B zPkbpM@v5i+l)GXW*_AM_4j`H0dPPYt_dRnZm?Tb}Wspn3R1!>r`F=Wupv%4gR|i1$ z^3aJ~CBj<;2;eIzKF@KrER&#K)q@toD`ATRfW|4?B|nb7jJ!rseH{tezM2K-_OFu=!SLnh?>vrb$t;v zkFUW1F-L&!M-P7c>G#is1;E`l5f$B21Sg5_7I6`VhL06HxiuV}3l_0*rnIho%h`Xfav#{ZyQ^`3_3jO$ z^{Z?Z{$VhfJ2rPmwMIfD%@=f~EgT($GH|Kk@43rK{~k7Osn0dHYk5ApYeWn#v>c+P z{KR5KVc7@oJ zUQG!NE*ZwV%d%PG{6e2Iqpc}3$ogbfjSuG7 zYAqwMaO(W5CnJ0Me7&@8m#nL1(Iq%%gY5kf;Sl*?0R8UlbL#66gs5&mx;vY{Ah>rb zV)n0hmM3*D&UcRdv}cF=WKLb3)>jtO^ux?4t`Sj^1~`|MiJ)TX?e0EXlg~+yGBY&L z=oYoz#@ca&-|JwZIhJZAB8SNa?moiZFubp3sz*>lh&$nm7SUOEr(7@P9vK~fr9Ws~ z#8>jgrU2%VUokG|%&qXNI^1y2*Q?<}(G-S3T4sf@=CtjVyV?4FV536#?mIT@HRHXQ zri5`*aV1+}9NHNlNxpaAIw}u54V+3x?ns%9>eAea>>qFaM7s&vBq7u6lif z*g}5-&fmW%A2uSl1C5m=_x%+R)Y6lPCyy^4*5T<_H&ubm{l2H|IY2W;irAm9{CXWn z)%`bTG{vgTK~6YDSBGYe>4o#y?0A$}wYcw4YiUxrN%GX_==dTum%lvoC(2KLXC-6i zymZ-$^CGj$J}~{{{Nh)0_PPH~Mnjrg)wJi`VUl+L5NF+NT zA<&c+eeTvV@*8kMYdPMQKYHGUke!d{4q5OSe_C?0l zV1+T=v_Z_#OOHsE+A3)1h{pGCSkmA|Oy%G*Lf#$UMozn?{BtIEUg$L5mP)0)^_u?c z4G+f8Jm^;WaGr8T5yxzXeaA-Gl-cpj0e1!(tYuJAVow3GLS)R*60)|65uG@;o7mP; z{1-7}TvYl+qDzt5=3`{H$k=^DYYlo6)e~%j^+!Li1}!9cuxXz9*_6!rW|A_DNEQSS zT|x+qPUNE&a`C6L6dv;S=7KqeKzaR~dKjK81t}SP!z?B?co6}07jAjs)L`wXk)`Lg%i zNU?6s2X-vmVfpm>lo{8xd9I-XNW>>N$mxDIWwViz&8eY9t*SUA1V^i$51yO3M8uQ-4y+zYmT(m zHuZ)k1w5!oH+@;C&LFZ@_RYba#WNBX6Oragu{8B*Fv-pj-80d3%aQ)D2~|ZIQMI_Z zOcgFX>7TFoWmh#Y>*SPg!pUK(iqCPhA=N#O0@EcavG+@}>E-9=RZGZtqXI2Cv02w& zyVXX?zUzCwA}9V7bPf+K*39ugp4`sa#XRX-w--MJ$OTD`c@!*3iDH7jYUhn7z3NnH=Kr|R7gmgZ&m z6l-{Yb>}RR`$|c?T8t8=314;mW@JCjS~BK(boiTes*Lr?WIJ(;hfc28>6+&vSI*jj zY=h5ESVPGCn!y?RYhobH1;aUQP8W3E{mtjIBHGqSd@Ne+>+VSe;7)}JCkhWIA_}+D zm9(cB7*}H`czloLZER8Wz^lND3F%vJPiwgWqhm$CW;_5(xsDtY^^ZtKr-_M6ii=B1 zYDmn#!o-h+HOr+fIGuJN&Ds{7|cxD#y1rZ7iWjgZ7%@c=H19q`rxo zi)YDLz@EEgo*C}Tm_xm?R))2z&C&-)H~H6pyJAXCHk-D^-p%{~P{M)i#RH$KeZl#Hq7@--{ejHj)vXVY^N3tD57xqgevS}l+lXywc zq3b9UAH#~FtCS@iZxU0o`LSeM6B|8h3{-mu2!!%{gGE@Z@bcpBs<0V`gEsReU)Hx_nJ@~S|n41LJ*7!)?0b$V$ zM+nLWW76)gb4J=!f2d_#2eHPi+6b;bEQk{6JKuT8a^jFp6jqB7?Clca;_%~~$mxCO z8tWqFlsTJ)|1$!FEDCIvRbGRA6oW)?oAhB*GN5`=_xML26OyTNPSB@T-BP5aEUun} zf6&vEF$3NUjSkUi5&kJ@a((nf#<|N51Yr8^8*BSS6oX0=RD`5LU4Z?vSh_H21DD-D#gwQ?_%Y|9xyp z_i0JN^imnj)^os&-cead48GOZCZ!;KH=fsm?JI<1+8QHhgWyF+;{H3a6!uN*HDQDO3s1gbi# ztiV+dhwzLQm$$i3%lEM6*)sY3 z^y9*DhEG;0NJv5a&h+Kxh_wbPNo@ZBt!)c)Fe}#>_tyW$T@MJp*xf64P|zMWm1S?2k#{N7Ao>>iiU)&Iw^5)P((B>#>~#tbQ-K^;lm5 z4g#E%(Ga9v$)swbw+UypwpP-UDQ)_E5NEFf+W{oa%X<)5-SN&;_(}2$%a6sO&&kE1N-9AsK)G1P z-oi6N#Bt{XJm3C)2Bb<#iK)G(z|X-v3Drk9ZQYwaIO>qDKF_Rv%a5%r<<@!|ZtS7_ zJ@3c`(J?yj~@f{wP7ku41_)s3k^O?V)=6D*Nhrz+ zkvGV~8sOs6m`1+cFZ5iWaQbWHi0TawCVgTusL2L(Xx&XMQ#PbX6}f$ya#TyNIJC4h z<7v22A}P)jgioE620X+g8@`9BNH*El%L){yy6Af1R6Gh+{edo!er)bPjj+EH!I8e2*MbT< zri`u*J{wCMc=(U$F@QyG3mb{^L%Utqhbx$*5rgua&W?`#64XpDgJ`P$2-gO4^|$pO zF3ifOF^vZsYKKE(3V80M<{V;VKdkWc1Dg6tZr5B8! zpDH!~D5Lg*=6JsS#*Y2e!kW*Aqc>DPoPZHPb)xVI}``i;-?~i>8>J z3Ma5Wb$YC>x^Sjv(c)n-KK$?hd1xHXuWnI|DpY_p1*@T>9j6NpE9d7HXn^YR1+))!Vr zOQ&mnP6)}x2Z~ZNYe6#N?+L(j#gDLojNrqr;Ls~Zq!VO1RO@eI@vg{?k08VHkz4PI zib?%{{?jt@e5?IWFQd|xA9I|W^tsmJ1CW3v6_sSkUe_96@kaR!x9emifP z!a?@4oMf{4S!K+ON?`810JQJ;s1LC;_ZQW;%E^4un(YCFU@?9K^S@Ayq+n<%vw;+X z{*d`0R3kSi;$t!X0rQinMy)GBGXN5Y*~+w!aLQBcpN)+Enqpi!vG!~pr65CAH2;`E zAzXpIx%+IgDQEgaS6v9sj9qwUZ2;E(375MItu;5~=h1V$@K`&t%Cp_X_YP*1zi-KwmFCI!6MyAn^7)d}pO-jTsdj1s*lo zz4=ngB&$M&)RFp0<5PCObnOm;>+Ij2oz+<$vVCj%_Ga3zF5W;gLfoFn(rB|+ZzHNZ zl1RxU723bsRW-8ewQu_}LP{svkM&h$hpYJ#j^-)nwnH-{T+ecxgJ&2tN&(W7a6}VfP6$Y2V>wZD88>F zyoFr8k#sBFSmq?X?o2BEwt33%-1LhP9ybae-5(4E9hmDx4CV>8=yI)w#S?h|6%IjA zeBq16^yZ1!sixrdgue7BumbAT>`hovwxfPE+q#TRvca&Sck20Mf~h!CD5d*%!yLEU z*-0DM6Qp6O$`8J+>8#I8P5B3cyWQoAYe*U0v5gtm{DkauI|K_wro~=Npt+Q~=Q`@Sf zfNHw7VO8Ug7u`uv8~66)lahcb0#p+7<6RqpF~hjs z$0&-kY+x`UA>u2#!yI~Yl#NwcTl~p0zAKto<}q8mVXunaPbxjQRt4q z05oLx<4w|84mU58Do0q$YT*sx%(36@*VTOYEwV0L2#nE1&$~5bE22&W8rTFjdEe4* zAcvD=rQ+BBAf+R2pKwPN%sttb_^4s|RN<%LO|kBf1^FGIfxkEz^I61*W*r9H5FIGJ| zB4q}Fs63``>W?Sl@}Evy{Mh%y^|w>Ann`mD99qQM(H{>@4mVHTOY{_?7_(&+*4ojC zUUtmQXtnC7N7Ru<>{llH2eJY}K;}l2tRq+(+CYwv3>vp)-Vy{7tQ{acC4(;2n5)r) zy@aoiE)(6N=C=zosJVS59hJ}yg@LTG1BiZs-QT<-48)+O|D}Ye=OX-`12VQ5c%T8P zifA$-uzkUteJTC7Ib~$MM|8a~3FTD}Mh&b&+Jrj>=BkF}P#=SX_I_;J=gTjZ>OrNg6Jnk>VEy|9I{jenurqUiY(G%A{v_qz>+x(uN*7Cx#}7zO ZWz5{-Hu0g$?*Z@wd#3WVM9wt$e*nLZ{M`Tm literal 0 HcmV?d00001 diff --git a/docs/css/api-ref/en-us_image_0000002426197049.png b/docs/css/api-ref/en-us_image_0000002426197049.png new file mode 100644 index 0000000000000000000000000000000000000000..51e7309f9cad17c53f30f397753015dda70934a2 GIT binary patch literal 39758 zcmdRVRZtvJ+a`n{!Gk-&3GOZd5(w@V+}#=6f`s591b26LcL?qbFbwYQF5CI)|7&-z zb}x4?rn=}Frn}F1&wC#0FeL>kG-M)V7#J8d>93zvU|?VefX^xt0&r%y)x!%oymS1j z?E(XX-uv$ZJLphk3Ip>2M*6dunn&6Z)ZGI|9lvXR)mEA&o8}58n~L;p-dE*MIIt)` zvygINVZVfj)90KS;a5$mm%x|NtNg+GMM-m2@PYJAUR>}W=F4X%=>_W6kH4zkrQLdZ zjGid)ySPJZ-FL>DiCFep?1g-Jp3Jy>nUs3woW*g(c+h;4$2Qo7_?kxH-4UsR>2z^viqocm+RD*ymWb+WT|y(bLaDzavo~V+7UG30G1p#^ur5!{wu&-blQG*<;7$F$-n? z_e*qzD)k4vqNo(hB}XAB_&!k5V9XpxN4Kb{#{wye;MB!qxBF!j3K;w#hhR+cpOAQJ zNs3_1p6~w`hao8J@-UCx(&&WftDKx1)An%u=9Cn9fp)EVa7c(z?V{yWPCv-beP>h~ zmGnVZM2ayO^9?mSUXpAgrB;<81#3H33WItHCK*}A%hFWt;Mw(925$!)+Dz4nc@#{DvqksjZ(vSfTNh6;7t zJYr|nP>vyuxelv?ut{v|@-1%1!zJpaMY_!#@88F2m23P!CsnvUnDf}rXSWvw9<>Qq z8n^K#0#2ahZ@bKE&-Zd;fSX`8HZk!$ zt_NGqml4)m&-IydTt1#M5^x`UdGqGY&xi<K+~JQm&HIcrc$*_36TLi&H>#kr*;dBx5*`uA6!#X26WU*;_8P%B?=AkG^bES&bsT9J}eE<2;``|QXR z!Ae_d*05pW;pUe+%(@*u$-%*Ic^p<`wui-F?(T6nj}~heYZaf!`q&qRHJ++TJWHyjm(N8d2jw0cEw{;o>tLs zmzFFRQ+%1MZd5T%z}p_pv69&MeUIHJ0&|sk2y*O6v;@++-?RyiI1&ZPSL6TV!Bjf3 zMWIdb&HJ8o;DNA~NrQkT@%J|YH=NY+`=6Nht{i-Pe2Y*qVEu%ag-w}15jpC+efg>L z>qo=Fe^yltQ&_e0wlkvZ6~^-WNKD@J@$5f&eM2Yc5=hD(e55{c1o*tlGj}`Yh*W*@ zZf{%Ht5djb3Yr8lDL${q=4+JX##xMumRUV`WbMm`?>6A#6U)lUp{fT3K}mZKKKN~ zwpQM_Qqw9(3oLd$V6neNMd-EG17pLs7FcyQ3z7k+)Bl||A4{p%o8dC}AO^mkJBgM; zqOiB11uivhH^X&Y!Khgg+#-mn%ta!Un^=>iGLmYSvIwn4QpQ<8^O6Zq9K08lwQ^cy zrVFb+TgX3rAdSFdmH|3;jw1v=LjW^9(N^n#&=oB;?e;xoBA3u_=7)~UVnOa8Bb6ZM zg6;9dVaZK?FPETnr%%Km*b28p=-*%k1X=pj+pxJz)lqUj+^*5Ir;VjN;9B0c3gS`N zzef=o-N8S2YkeNAD4^)tQo)_xZ^|`5+35OH=MQ=|57qN+h@}OTR93-NkCz0g(RMPs z9GLtKyi56BWHLoQk@YKTx!T3ZPn+D-AH#K$5J=@T63!Cz_Y@^hP#PnD<rt$`v?M1E*icz3jdWuAUnmPqURXmXRa* zqXqH{XKCNtRN~*hA;&lPs4nyAYwa>TcN1aT3XA)Qz=0C3fcl7@&=+<6C3aSh#`Hu& z8IRplkqkRzby;0+pY~HuQ#(Xa46S?Wx450v1h8Y4LwC)ra;`xM6Q|*rl$=2op83z| z*CLX~OJC;%-x#^MC$(d*Aj7AUo|GeyuVPSXiY?q9xvLG46UC3|DM7{qZ$Z>`lG`6x z_)ibF6A&zk7NC4ZqO8YB`0!9SnB$V31{W}y!RaHaHiTm8&FWF8?7ib|;TTgRbf^TTr*Fx~v&hW2wrCF1l$?J-cyji*qZMw6%bx6BbvFFhODsOu+ zLf3LxFt;!=Xz#AclN!|RHY+~RufzLisz25*W&h#j`iPjQYP2QuQ(>6EAoar@D0B&| z8nw19I(I3Frf&}?Y~4GgMbJ(}iPhbUWCAI5#txNbVFc;kE6JAQd)DzW#< zsdl9bxw;KzwlKVqyq2KoLZo#IPRakk11}WCW+Z&n4m0x5!|2~7s%+hAa2*`tO>ss2 zhY=x8phSN%nUA1Rqko|s54Bkpw0&z3c*|>MH^}O47TMU8c<2Vg4eH-%JBA@Ef$P;N zx;1=iu@Mb;;8uD?MbN53OdwHeznuKeW?diN8i~QQfUoq#3FEl+T;{4xlI7Y@ zzF{;4J)@*&UEs-G@AxL7_>mUh2>JG#XEBdGK|bQbjy_I^4}u0+NVAbOxs}1%ty<7n zVfLoa&$c)1l@*V2s`Lh^WKRgRb^*5nrKZW+CGw=11>Nl^A4K3q_THS@1wP_SWMNzt z7bc`HypR4O0q)1VV8pqEDIEg^6?#7E$9tUWyw#cLDb+;Wh_QT^t5HHA3fXBRiymIdOlu5yqM6iZ^la$);Qr=v ztx)33N%NX;j0HeWe@D%XnfA*SsPtW(Qy6xvC&nfup4|_%`AD+8jASuNSd}fx+!k;v zybu$y)QyYO1rD9vNHxfVB;FsKf0sSr`ey%ppLsB+eS9#hx73neTB_=x(R#3`ukgL) zy8=&^L?7-oO(|S?&@8^sf+sGd^7Rvhp=5Wa?ak;r)rmoxQr6eB@fL)KlHjxJIkJ(7 z&^ZxQBHgb_?{aO~`N%V$-KMu1^jtPwNtl*Oy*yGCEo@ukr6>-g}@}#vczfQ1Fg}?$o|Elz_xYWlQ9rb=-yA2d4#)da%`W-AMiTa~c-gdZPO2 zgPWe4gyM-Zb6#|o5LswVeV8Yu(j_B7&b|lEHHY1-E3}~S3Wb1&z>;roZuCa^zow$^ z96o^@>Pz))zb)r}D<+uU__(v~(~fgk-wEe43lrnuT|8(G_nD@6E8bFBxS@^y7_9}} z;Hv3HSDfK4Wj$YXtv}(+g?tX>)!Ka=(z@a{7G?s0zx$LrJX!PG>&QeyR6nhHQJr`@ z&xf7Qpa1YO2CNCL0qH&8Au0ZCku%>8FIJt39;a(k@N14zMsj*|N+w_}EK&_lFEwi$ zKyoxdTkuoxbu!mj!C=vS4xHu$rDxdZR1l+US9B!Ny0uN6xtyf)hs*!q1(%Xp>i5z1 zzC@h$ghx(jGH3rzp2~`*<1E$Fiy2{J`Esq5amRj`m2syA(yR3PsC8C#aBpfqI9g+) zsmcCnWr>A_Fo7)K-kU?jVU(iTv@zxm2V~x(JQB{pE^=M_fa+H1Yqw?Vc8r;xhgF^n z;{amNL!!8#gjCi~G<3U+&2cjtU~r#h8^GsUK@yEXB3q{*~M`w8%Gd|Q_56=XHuU+N7f1|^DhTjCKSQ|K?&l0yI?*ALI>5HUOyzYb7~ zm0T~e3pALRFV>fq5==LwLK;wn-^I+TI|UqwJ$RdUDm;kDd{6vngY|q^*J7_dDsjCs z{8(%vEm%*qmg|?qZ$F|gXe*LCf2yP|e4-|AXYEjWNmLwIr{Z;$y9*92)wLU?||w-3Sp7Wm)%XHV;JrQqaj$(m<9Ax{3rLc&hr`V z&ezhLPJ0+vq;bE+eaKwm;RT(V+~!gV>qOdT>XO*lT%GO#u`>zsrqbUB$MRa0e)PfU z!N`6GOQtETy=%n-Rafjqng|UU%{NrWN0}we^B8J&kDuYm;nG7*6|b*z;R zApxYAj~}%e)03Nh7Wy9ev+4b`NgH}lN|6|6^eqLlveJwGrHurDG3+Dze-A&zcQy&4 z#>)OCs2n~n!!Ut)*WPW^VIG)c_mG? zK-SW;U9&rpw$=XvO@6v?kt2C#sufN78{c=tNTu827#)_Ixt*>V>hdx=bQpfV5DWKN zzr|7SP`|QB7N5^;>(j&LX~#p_r25E(83d)k|L=|bq1O2(FVo{qDQac=^RSY}>xEuL zW4+0Y*O412$VJAPqco9uERo>y@D8Pfw6V-!4D2GZv#<{5b0?Xd0k=#e9jR$2h+-47 z+orozCs(*xGygIgO+mhE|5s?F?_BHSPv25P4%4qxYxr5gbH*PlAje0`P2r@(8qK%{!a5xHxdnxd{s7r*Qs@D^|uA86h+q2?E4A~Ot#vc;j-%%F1oy; z&)$~gi0%%G{>#OXTrL}^h(W{g;ciT(zf<`AFY{5Y@!OKD)Weew}3B zf8=j-z(;hm+wJR=qE{9Oz#r@!+~1VazL;}WQTcs#eYrc-or}bzNg?5*{2o8~^&XJ` z6+zCNvv=?XgEalL<0%bgcigaEYw!H-(*cjIjQEoo-b9LwTHhB`1h{qtp}_+)*{{+H z8-HJfg@lcnvKbSVMT(H!-4Ax0Uv(s2*Unz_JiH$r*`G)xb7QkB<$6qq?{Kv`RB&Yy zSaL;hZ)`e!8Y>LOpy{pEHiweYN2~JCAM&tC!e&_R?p^_cM9_C#vJ+Pu$NLcrXM@hh zxm3v)I|SBXo6oys2Y<%NM-pm$X9SMi1Si_BXw8N-xAwAqnI7#$VDjNcrv3K_O=B%qG)u~DtyWK#f zFuq!k?lkdyy3&lcZykIKSfy4YfT87Afgd5a#NgVhT1YzhL}P|8O1pf+N`*{=Otscg z$O{qGrXry|9saX@f%BdFBW&uJc`d}2M=%Rg$&oDQrpD~tI%PRK^D++-_SMz{AGcIM z&=4ekn1S>Z4d(3|AyJaKdYunz2di#f_G|Q_!>&`MLIa7O@g$fz7e>KOz7|(c$QN|YOs`QW+@pl&ry$zYlvKm2! zSh~bKOet3wKbW56735WUL(E%l34cym8qX}n?}tsrvj}@#4%W~_CiB79E(QhPjZo7J zsAfB>5BT#%;EMY74u~dRDs@_D33(F%_tf9{S-KP&QZ;Yr3N)zRuz$*iQ+;$fo8cMfQt6x|M%l&s4M`Ky1lN$w;j$Oy zn-f}&vy-(R*Pz#56cQP4I$$_VyTa9NTI9lk2HECrGpSZWQ&JI0%sWHyD)GAt?NDRC7q0e0dp}*S(7UE2 z)WUBry%2EBgS^^MfirHh2pamaAlxT!hYcY7^?z%AP`nywLh}Uqi=DHOXe4@ zF6ti&wWnhjL9dm%+3r9tA&tP2j%@w~Jt9lC0P*2hnxB7-)03_lh3`9ls9$8Na36@Q z>F1b7Y)>j`&>0pyteGcHs{f2rwpeSyN+RTO2G>Oupgn_nm&hc)D}~SmY>kH6`riHs zvK=YoouM~VO<#yVr3aF788dbC>rOz;8zIH3dGIl4Bq{6nRm{ZBq_tz_z2>cM56UxK zTtTq%BOc$|ee#Ff_(3c>yiY@e*ak*Nt(iuRkml3uLCfVFyB}udcqkeA+SvC|N22of zmALl$o#6mTNamv5I&d?x*~@g@zt^g;W){q~BH9yZfhr75e-{$9caA>XqSduH=03f| z*n6JEv|gF|MfK=jYknWIXrG(4R81e-&C5$KAdOq8fV~zc$|=A%o^-x^VbiYg7s7?IDL$XjGg&be9 zwwda*gxxy!qcD+|^yE-1WVpLe@{3BXJseM^PSjk9pENCP(a_f*n|ULkEA1Zw{)CWF z`_E32M4E)<6H!){4AGJNGZ(oBQ!)UanDzW=MkTzYO$AqqgF#Q>iPW?*>6Uy>S8T-} zKkmQ!dwF=hC&y1czG2j;khFEBmcl5Va^Xph|Fd=UY5@X0t+lmdZEn)*6_B)4xLBT! zlQg;rA6r)E>EHg{>G|pv$!j^s&Yfkp>v_$%8TP{(;emMDb|BK^K#;MQ3A;c})DGaY zL$_Tqp=-86!CdOK;nZ7f7N&Dp2Ry&f=p2OHV*Pi<(_2jpJPv$ZorQHLkJh`pb_Y2w zgLsRd+|V9`AKw7AY&2K^N)i^f^1KyZh8$0!9;%gs5O0@XF;!_J2Sx_*F)$Q=M0!#U z`qtZm!}@CrtKIq)BYie~Gf3}=R{ib?-CEH)H)sg&o*1>~@4YuOZS`A`gNDBL4|l(X z2WN?Im*}F3j`S%{tZnK8QQmq9S3*zSdCv5}nyMj6V1MXVbfjSKrwQtAPFMY{^v-=~X5OyL%ZzR{G!UBy8 zww`&5?0#L)Saon>3V+U`ZG4f)9;#V*w?W}7m)!cfHL%`cGKI4co|#?|Uxd(2AU!6U z4siz{L{#gNoAzU-wsz$)yM-FcNLzT{%IJ+sePnZCq;&ie(2|-4mAQkI%4gl5kW`cR zPSTO$AHtM>LefVo02fWX=|fmGQp?m(Iv}$*(Hc}I6L2NnV$Pzux>Jt}LvSP;$20Bb z(1PzVwjG)U0J3sG&2E07M9Sx_4fXM_buB_pFWI)&HWBGC38h*aHRC>$1UL+3*wl9f zp*f_E)*<+2;&|1NZs>aJ^O-5tJ~uMOXQJkqDY0^xGq!HA&=uo|@H1y(^*Zkn!lX83 z=(qJEWqyzP@)qdEvRRQf(bBFns!{5PITKDxhL4?3biwKFdPvL4@mOrN#F1LXCr(G; zPtTkLhTUXZ&Yz$)?*%X=%QYa3n{X&M`l(TyhQTfPH5yiYD)fV<$P|5JG{TaIXv1B8 zp*1!y834)S-t2#lP%my2x#p(U6l zH-hs~+fGS{pEV(`Wx&{t9LqRQz|c#y0Z3}BBvx+F9<_Q9m%MF_K>b4xGWbxpx=0+# zOX-5aSt!2dpZ;T_v9~8w-EJnX`ru)68jj6halmfd9LL6roO?SSFl{UfRj!Feu(eD{ zn~Ew<^B3I|a8K=V^CZi>QY*&t&Xq_(>8wn;@_fr#OdiRzFezLjJ2s8te{O^5hy_+1 zbZdyJOt^}C%R~_LY(B+r95j!Hbmhj)eq4d~HZ+!s=aNwDp#oLX+`y3I8rX9&F@{Z9 zer(J1mLE*GR1yD4Y~+6T$|P$%%T<#}w~gneRZ)}1Y}kC*7v0^O$7oXm?gKL*t-Q~vLC&dyg9_qRPQu#*&8>5}Q#2%N2@ zIUC=Hg9Ko$cOsNoMrHpy3owqt zDI!``ebDXOay(!%s_5VrkgI$)Cg0&+t2DLHX!CQ&D}$U@&_j~djPn}{WuizhJ^hr_ zaO#LqffbMAv`JlI4JPt=Ldh|94btwj zHLQv>uo6gsWpB?5g~FN^>i@zkw|ZIw+`1-ptCknDZz^x;ge3!LIj_Z11`>H$%W~{g zq(G$8Gf1thU44@_aAu#gZwD)O>mHX$KP$L}9Db*TI%Cr3sr!V`*F@jtC#AkcwArUo z(?y?l;E*LR?}l`tMK|N*Og;>mnw{P3*3-Kq{wDUG&}p&WTZQd+(bYnVMe%BizA?;2 zCTk_h9J@KGH?O@Ga1%7)ikjbhn`zKDDa0;AuKmY}LO&~>R4MSg*$qxs zAifboPl+C^BXGboB342Bg`y8M zeiuwVApU`y8zjW`b*AnirGVMpT`0$Kk+2*e@u67|ox)yk2~!U|bD0f%ugku%5)lie z$7_?)un0Z>+0#!ov_$eNwon`=t*d=k#X3*;SDzM=7E{7?N&zk$R>11Ni|TTX>5l^r zy3+_J!ARcg{y1MShyTlysUA26R#Fcv@t^Ow0v>lsFufsQx*bRSCP0ai5AYpN<1d7g z{sg?;@tS9vCEJD*lg7&?^DH!h?_VjI*`%Ahw;|5T7#$toC z1RNwg>;!E`5Ox&2iD63ThUwxA%%+nt8|-vb9Ukc|2ct ztPl!D&d^2gc(zM;yJI<>`((^7k~c)f4Ms0d`lSy&tyDZe(*dy7-ZE8NAwLDn6D#U~ zw@#fR99@3K6OLYB^+KUc`vp!!q(6zx485fSo79PYwZT_vQ?OWxpCI6@w(zTroFRa$ z!S&2~;HhP$E1!`E_2tDDI9Rib+wsIep^OpssWP2&?6Gh4j8z^PKK3}c4C?LCd-igE zCygIgAZ1_z?vwGxauj78%Q{IgH&^*zefdUhySzMVxGXE8{7OIRr}lNlhSz#LgU*e< z&tEW=3P=>uNQ1g9sR1d>%~n5V%sf}S)Xnu|g;)>#4-4{Fc?$wk6QKB*@OT3h-$01n zgL-xJK3Eoi{PM+y%ES09!iVEtomMVABGdof#-_2yW4w`EMh8;d{*vZMj<)JMCY_Al zNB60`FFFhw=;n*=m$38z2YrzkG~`I;dpV`($P`713nh#jitIMr3IVT}-~5qYhVH|j zSh~`|unNyaG#0Y<%#1+x*-4gKj{xM29t}v|8{;U!Z zGq9vf!As2DNVS%V3P9}8^vF+SUAJh=eedwDiB^YV;k*erofr&!AM6vhDOvRl2OhDT zYC+x#WRIc2cYIzqqt?7T^C^8I?5?6f@mqM%?ju z;lh$87&K>`J-7*145_k8xRFZ_c)Q7H8UcA0eoZB5e+dGq*Qu8R?^sPjJBS?+dT-6E#`}jhTa%{KkRE zjliE+Y1=-#fn`Hlnj4A8R=8&UTai2Ze=>Pp80$>F1^EHDhJlKCEn;zTF)Hy57Hw^E zGI`t3&DdeF7JpK@jyNGOV0!|mZ32-6%%?km1eqr28+cAW-ebu2E9LiSx3D1W+115P zbz$iF4A_P6avldJrOsA%Apy;GZz-;-^EF5N@P_a=Wx$Z>&fgcP(CY!j5&`a&7`rDa zO!b^q`M1N4U(fj1q1Dt4S;y0s9w7RB+P3CiY;|GOnJ*u{Nt#G|n%HNzy))s*5ItuC z5pi|f*BY@A{ZqhxusTRpEbUder4wBBlqQXu1A4AQl-CcQ+m)ChQ`)CxD>9#>kHECP zT{Gs#o{Gi)N4PMA9^Q&FrHu`fcbYFOy#C`yb_;Q?zD=y`%I_6oa=kNQeIEM@+nzdO zV6{3g@O^wD*v&U^{>i00=Vr8i9IO(LDZ)Y?G+XSn{vAjdii$@(Iu##j`I>SIMd29_~CX8o_#UIproNPB%eJgLy*gkqnjw^e(7aVBkC3PS-@cZ`k zCF52H_{Wpu8zi7twLR$0m;3|~^MD>!XleU6Z;lo3PydQ_7_h|+FfUb|$80M=Cak?_|L z&%%-Vrbn_-GP1O%Q*tcq4Q)PEn)$7~&oc0TwwL#@@9yw&o$FIz2+;Wb(MT6NNA}s5 z7fXau%zges(_5y_Uqa7r&c~c|#{V-{TAc^@3QyhywW0soD|_twKlHc({^wX+wr-ja z590}!tjbuc#(rwW`X~Wd`EP*g>gk=qhI##+|1&1S$&;l2DZ=9C`B?|s#^%P|6ZBj& zk@I)jpFi2YuqpM{6W*1=in}N6R*My?(Szt&+3Sb9QjTK+0S7~w!sRFC0)V3uBlP~w zuWczsH}q4;mvXPD8oSq{8*fVof|wifG`}*>sT?~gF8N&D{tqmJ{klO|nHbqz4mXVSYxM(|I->BLtjY3Au$JKl2|8gTtroTuhA*Egl z9$3}HZUn2ICMk~QAdJ#wGySdc4dH5kyKBv~eS(#*t~+C%Q<2L5YJ-H);bA+haGuTj48$ zD4n`7w^UyQwB4)o+@}^(k#!5j%fE3GI}CVq-LQb~a5lQbxqk3momT*;5=Sk!Hr06> z$1bFYg41<%W7{pypS(iFm$3k`r#HUuEexP8PI93+kY}Qf{Qg;S_!e9SEOsT=P}csmx)TrbRloC(?x4N2%^F-rO)5ZY&JDeVGpyB? zmR86CMwF5zjS6UMEftrmouSjsQ5z_TE{W$13KkwB zJ@EO}6{QHvZftn8-5&ySsp0?*U?2eZfoem%X$Iunn#NcW-P=182T08Or(ece&=%V4 zxiw1Fk9jFZ`YvG>?06V7OQjq2pPL;OaHj{z zGTbl1P57n#fq*mFJmXnfs9f#L7J736v$ild5y9E)>)-U z8#|Hw6^iG3MOIMwUM8IPon?KjIAxC1MO$?|{ zEiM}dhbWTZm`d_n;aR#tUtasE1cQ$I@EtpWou;zTLb@Qyw&CBEB8Xgo?}8ypD1Ph} zAXEQs|FG_GIqH5!bZc^jjp40&!RO*>EvAovk`+2*a`zlsS$Wgo z+H&oMB|l@iSb-g3p=fd(o=I>&@Tl#@F}_64zRm$)r>*qr-XfKD9so@YnAe)~7f6oj z>{|0{>XJ$UTKgYn18Ke5qlI|y7U7=$vsyWlYgCbretOjotcf;0mfnUk4aUrNVf0og zI?;aNC;aidpZKdDtNT{HX;&zO-M|*OQ1zhM*5>2!5K{fGfXMO3v&FX!6HgVNX_*(u zZ+Nk#L}iP+IQ}r`A;_}$S?2FwUOD28Km7zuf-%yl6caYS(^PXm2fZQr$NZt1!h+f> z?oY9um9jtECb{19{;&j+sJ+R)>&0+WP9icN5RG(rs@!++5TYDk;D3>8JU=l{#U@Ty zTJ3}az^%sU+5y$q%(%mDCO&ma^5jpFV=`cc7(Ip7E|bb+07gchL5#4MCAlc`3*|&% z|E2g$T{PNos)QKebN@VaHGO6AyLTgd>6g6#y7!h#)HXL$U4ws^(ts=VRGN>0TH0o<3 zV&Db`+UE9ruv4>Dp2;)QNvRw4%#sspDo0oq`lngBx#Ng$$*WAqAHKlqFl3>|I}?2T zMsS})j?V-Rs>P7iG^xlVG0hwi*O510QRJZl^ihfrfz8#Yo|s#6=rC z#EP-rdrrmgvO$n#kCVwon`am}F2zsk?>BokI%-{Aby4VW0ZIi^Jso{?vqcBF6R;dF z)aj#r9nKd|V9;$f{{CofDvw+q*wu=ZfyrYz*(^YLu4Uz(>+? zzMAY{s+Zq1&Pn=T4RKaky9x7hh{5f7B1VavIGLAb@?m0h+8L}UQ&Rl)-7ydGKa5sQ zg$Ur_b!T1Fe?%p;P&47ehFv*U=whq3?>~lq-PPj_0;+%V28}HHY3*%TRCJFe*R;i? zV}h?B>)_^uEZPKIYeV(_YD&NT^HB-_K`7>O6d&0sdVS$58shG2rvQVy@VL=&Kni$Y zp-ck>O70!*6_r}ceT9L3x*F2hh=JcbVZ=p5_%KWjG-SGHGNb(`!X!C!01bWAp*XB` zw*Z;(mfs7@>MaEN7@!}mhym7z>I#X(zrKAJmWD!xliX*?R`hwcb)~*fYXJWMp(m2` zETDJ$=k{xlck1kFrn_n(W#=;J804>*ClbdJ^`|lZV&rcZ29p3!Vgi-1oXp zP5pztMOa$37n5z2KGh@lZqs>7vt2oe*5Z{kC3FvFiVJRd2(JheTp^l}o}{_S&iAuS z@EE>@8yWNJ&%AWN`HTLwZig&C!n-OI*GHlZYgAFvANh#cw(LLUHNx&Y4$jQ!k0v_9 z$dEr9ZXuMU-QSSV$hHXLNGVM0EHL3=Z5Y#Q2$__b$0Y}OyRn&XsJ$8f*gJt#~9Ye!}JKtqEQ+TI4)+zb}2x6{&r0?{ag*ZfBlsceAA|1{Bfx4{uuGZ zI?<&&fD5RZ7J(P}Lk%o!(xIl?0>GXFmAd2-mgtJZW`UQs*|V~ltdG~J4Q~y5$vdmv?qjY9xzh44EzFB39v;qKU|1S~ z>R6WxQ-O{2c-BLeqykXY`8M6D5hCY| z-K`?bxiH1b=U3Fl;Q$u-Z{sXhE~ZkiJ{VDQ4e%2x(Xs)Y2*i*1{UEJ@j;J7T)mi2e z(i`1?k&g$VLm_YDe_`kc2EA`yP@=$ozwrGp2k9_w!6Si$xcJHp7xRcPCM`w`lQg^h z@k7*1=bi3ch)|t7U5r7wh4tSr!qc^dFD~C8b;_6XJ~!hwef^(j@^?-CeAGODKV=PC_*POlrOwe|*4h46b;+m**;`*?_qLtwggPC$-a~S!$NMB1^@x1ZmsEkcYLE{2Q7Ws?Sh_LLuFvy+S2@k zyG2J@{(a<;L>6im9)!4|&uV=%pXNBqb<1h}G(}y2=nED;c7O8>9b2+oGtr0be^ZHa zcydcqOBqKXmj3(k*}$U--KPc3YgVH@dmwq`bnvjZeNJtt9oTX+9FOY}ZNzfm8#3B~ zfy1aPMrE$dcz4ELN}ZV8`0huelJuChCY1Q}Rg_A9&rCy?`AuPCKx#@WkNAjELUCi70sN{8!R+VTq+Jc6jjS1k9fl7^36 zsj9m*px#U$p>y1Ujz{fi2#2@FuO!SEfKz_DmQ?*6$MFiFE47hl|*d&SotPdgQ_udd24m;mD1q4lu|uRViM-tc}I>abhFV%pCz$JgX7 zn1$?Kc^h%p~`d?rJXd~<3(;B?TYKSeMj9s?GbgIN#lPu&%iylnF8=K6sKjN}V+q&Yk zRG8Fi^8=99DsznpLJ9`84+wp%94<;J}69s~Q|iG@!Mrx67qcpSb9&_ILIz8$am5 z+j@Lsose|bw4mFM^rdVN$&nIaTvtOlQSoK`p(V5M;X<*YB*Spmny@nqu)RM0f%l#b zh%NM2E>w_eQ~{$X4i;al*d3@D?br=cmu6_C!&s_m=;e+^9MGs^jSBrTf0o|U)=5Vm z!&pCeWKht`&vOAYkf3uI^>{^-NkGr@$!E|~QPrL2iE6EMJ;J;cKiJX!n8khWt5~NmkVvwWns&6fpDV;YRT&WL6MXrc7n}%?;Bcg9YoqCIB zvfk0i=(WyT{^S{)d3}OOJ zmMy%B>RjK%bB6Et5YECXlNo{0jEuUrM>6Xynm7}3gV zH$dhhSM&<`oe%d<3%e=JWgsWN68fjqlw@}1>Te3pD2nbB;O%7#3*O&OiXfnRf9$;k zG9yDz`{Y&U6RVcfId;+D4WEen%QI{WIp0GXAOMnO4n=5Y;5#j0u@&oJ%{n+%0M3`F zRet$fbk0AZO>Lc@a29ChoBcdT{tIJXrSP)Fx4h$wyr|gANFuRxChHWW()j5KAI>JG zRQXS@UnqrpiCufAG<2qE&q(VzQ|31uvBWCELCZ@1+q>0)vLMNl1SK%t2u@I^Lh%+c z8HT~}IG-1GmZC2x+o$g>L$HYjq)+8R_2@4oY9HnA)3m|m%jPmuxE01gDj(l(M zEDrkd5gM(_XOFa)ircWJL#;0T$4}+)liCFvojn}19zfH?*XzVo0O>tT)sX9g`f2f{ zuBCvi=1bCBC593NSMUeF6@Q^*4-e$7&ONwiSvoxVx-5ldGF1g2Q(&Gy?|0SQ*R(^J z*Op;i&F@1vKo)PAGid2YjtBFNZB) zcTM(#XCnxpfA7!^m`I^xdJajW4IKVbU3VPZnEN<1RHom+WpH!I0whQskAB8^CEtH= z(P_ElWDWz~ozPjV@xx8*nGo=0uDt!QqsAvx*E^ zHKSj@tg|854G>I&vGUtFx*At%6QFqEkPbUnE7FYzoD}2! zm{p*)ZeMv>|C|Y2NVe#vM-AD4xbJ6BGz$P3LT7u}PgRaQjQ&q4MkcSJ zL#7+`MvBwd>m7iX$Hz>a(TwzXVwcM2|L~Tz?FAjEq^+5uN@vScg#%uz*usgc>%R|H z;5(G`9QFdupFUZ=cz{EwS;eSY@n%KD`lbFsKE-8c%OBXeA`=@i;)CX%4c!~|yMQ+w zXxS-N%-9d+Z(Ysyf&4OH>!hbj?5B>6UA@Pj5M*{mBXZ}m{?TpOXUMgo+4eTk#DotB z%GV!o%f!sYKesmgQ$qJ|A)X#yPCzAp1MLMCSb2DOO_!+)0v4V^|L`1;ou_ItC;fEo zF`glU{;5{u*z>f0cYnE^ml*%K0PAxL--DW_jwg@e`S}*(1 zz!}o6)CM3`V8?+kA`}Gb=j==^^WA?L2HIcSlKjt^ASe~ubiSQtj72?%7K)@3mlgt* zY1ah!heWKos+&I=Sw6295`$=41b;r6*MDPA9RuFHw{5Vo2;-KQ;3Syj8Use4WX{H< zUJIZeyga4x;p!#L%Q2hgNsoaIYe<;O%O$^{(W`7V)ismBZdga98B(EFtd&pnO12y^XWVTpy}fL;Yw)9+ z`w**vhRgR?7~pH#_tM%znh^BB)!)jG7CZQ#U5gmqQvaohr^_|{S<+N5M?JlOnCGq+ zmgy@NO<0)9Wg%ev5I9I~A{LGb^BxwnjpGK%{}2?YTqBqc?p1w^DvT0x{kI;6Y1 zrAxZIyL0H22I=nZj$z#qChuJdV@^z4L%}nI_wa(qJ{b;}yI*Cnqzf`_5nlwz;+WC|%+QF7 zNn_$Z<3|g6L8IX8KN^kh_4`7+Klb*4;6>6e_U9->9ZqS~;YSC9DOC=gsSDf=BPV;@ zWCon2a&>&J%rS&~@zCoSG++zCStM7%&E7NNc1NjZnp|1Z zt`%#PvlmdQ?`~!syvQ%NS5+=6L&r$Pe7oEvZVh%Mmj6B2hqDu^pWSme8_cHxZ~pn< zc|#KOU;D)$RSAVIiPX*VF=FtVA}vc17UEsRCk%LG2M!r)>DZjd3`fz0m}PC>qQVq< zy`#~F!>HNMiWH6QryiRkcm7)5AvGhk^;(4L?Kzix=46}O5 zjs?^(s?*cckAgCJu3IsX4b&lwUA)#@H<+!(YT{!$-ES_=p25k=MH-!amG~C4=0#p3 z>x;RIV8X7YbBOe&wxO|MJVQc?TIBshFtkG2Rp6~$mLQI0P~j5nAMKjgTi-RCk<7@4 z&7~WLbVETR&?#qyitbfV?L!uLH<& zC9kgrz3+s{tz{G@woRtw|CzD_gU}kE3?#&=NWq}EApMupANdy%EDFB9&OR0Pi~mZ0 z9yNVf)&Xeozu+KFRQu-N5~HKgpZ*6LG$zQ?Chsd>JcXIku4j`X8`P=#;Xgi6 zzBL3YvXU9qiJ2)KSs)J#S{;7>Sv2PV|Cb)`&U~7nQiG9HX9MJSzcDdB`BWideze^g zRl*fX(5_LzwXir={~~A5`yTu!-5X{+xS-6gfjZTaDT* zhC@VNkdxX1^N}YgYNGK>R$f7Ja@RKLzh1jRsM}tlE)#8zhR?XLeek6Vw%S#*fvTU< z5@M_nG8`rXo|Ax#oE?(x*H@a9pXXuL#`&x7CWUH7F-ckqLq48MZgews22rJ=l(tGA zt{y0(vWQT&o335ME$&D!Na72@rFHTSA;{HH>grxP^F8NX({8Lzix4$2kAbV$e(TF0VN|k$^sPhex^JxOshid>+96ss))q#{fl8d zvQkvgY*q&hAFuH84?UL>>d<6pXm1E@U3U&XR@!_~2n{N1**)O+O;ao{l3)tu*bk8D zWx4)9NREmSQ#y=J&dsPa6bffy&`T~%eswbThiKEB_irMB0^RbswcA^o8k}!RJe>B66zqiDJsK4OMpRWJc z7h!V!PdOEv;hM=LqNxj^@z>_d!mg%+>Op^<7*k>X&GYPf5Gmmq*06*52t5~B9Uc>p z8>&`8`Uzl8v`VW|9{ldChk4w@ghTkT*W1St4hBNQdvaDYNfD`JyZ5RoBXGNoRIH5$LUOk@+wv$0ZnIol8ilgrYe zxTojH8}2_9g61oR#{TD>Gidr(b>;Z|Fgt|2d zRAx;xCCVNqil^hp+xnm3~wpJ^t|7UbfUs6^x0k1cnvd{XNH@GmeEv~QBK)EABSA;!~^9?xUg zD@E0CqKRRdF)>CDT7tF9;Oql0ACs|8Wp&VIuISF`53XHXS4w2k|GwH4;WlA>60lgy zWq;V$!&*eZ?t~qU8%^##P4w$h%a6>bdm9wXmuc0ot}K?2} zYv~Ic+v&J8Q6jiM69$9HqG=*7Or2$6HIT6xx!k(XRKw+w1rGhV*{yj(!{dsS=hM6{ zaS96+o%bbw*~U=#_WIFkpVTs=fW^nTP*pH8eUl-10ROPVr`yh+f!H4ltbvMQUfb4c zb*;hU$>(|N{RR%;Y?+Qc9P+r~*+p}y(8f@>L&SwV`8TfS?mMw33?gc#-&5zTacoX9 z+%8CYP~pIqExPO;)8Ge^&DmdgLY{x025b$C9#P{Zsq{Tgkiz*F{f$}o^*N^tR)h|g z8nJxZ+b&JWg~j~x_@|o|*Wnt%c-QV&rylQlfxedgndfP(9VXvcM zymyz~^#g4myE4R?)2f0Q%omyOI;yG-=piteI27C^%9oP6&<5*MHNP%LuwOg1su+B9 zd=1Cd>;z;kC&O&aGoe$y0fW@hcY z0;#Rp#Z-gBy%S>2iqM}mDitb&yCb`oNH`+o3=FsqBgJ+r>T2pw{f(Hr-akfSYqVKY z`tHTEx8!`WF~J7sThwSYYYNfJiXNepI(>xhjJld!*VxWiWTIa}xt_+BrisV1bgSUn zV&!|zmK+$c7?OjLVWP;`Jw6bu;Ufw>R0J$EP$Hrd=qW_)(1IqfFi$*pmmKIYPQrpA zhwHhzugaYWe;Gdf#aCKhwDU^fRSHSB&t_R#t4Rbfwv}zusAix7+h{UpPKjr=@*rR- zxEI{nN8nf1_Cy8MOvB80)F6D2x(AdmYTt2`7?X31wHW#piaP=+pzu$_i;)WTty_-C zqUey}R4#?KQrRy~w^5H2isXaf`_q0y{OvNp7m;ry4_I3Szwp?2xblJyMrj%x) zh963KR2iq?Y~L38Li4hY$gG+}mi zvhH&|HQ!jFkb!;+duotE(diR_sy$u!6L+h>`rY3AXE+3cJc8j8^G-u#ccz3r*q~)3 z+DhOiu1pw^hJ#etN=%w7P)eIoqL*L-AGNrNe|dNtdqtftN|GD$s-v!&UvEIEM~CIz zkmNxvsmB&4U(y*@x5S-su(#=)@j}z9`N#VdPeMC5!|?*5fi1U=D}IkG_b5Dq(4R^h ziUo=(%ZhG8wXa&a7M3BuF{aCWKf3)Rkd3q$t#?u_oPN63o}zqq&7p@s?ODs|i`Y^u zy8o0HczCR=tn_B;9Zu*J7qm5%@?U?+GjG1#I8?HZZuG=a z1oL>UVGTnCth*^cUh=t}k?|K67Jd}kqobPhb<@UXwlnn~x^mi1Ul25-x9p%6g?DOh zXBbHCC?N;cf9ZNv63QZT6;7}IEVp`6R8eVdB~%hqdpq1s%uJsx_s#pHbZaZe{AaeB zInB8(H3E4)W#MgwNgf+_j%^#Yn9>M3a_tHjQMF%`z1g_TOGHKXOHh+EM7{goz5@8h1P$va+X$hLJA67t|v%`sjgIR#sGiR z)(jBT36hgB=l*t@t3$0?#|jLAukw-IJSHNi3sWuM<2(fZ zi(H#EbaWzdZ0L|`Zco0n{)Qx?z8V##65=nUeT6*=p(=jiHzrvVKiuuv8i%)kp+1^J z7@`vA2D!$*-oQi{c4w;=kd}TJR@(B)q@nn0Yay?oz-eU}2k_z%*um=c8Ib*n{^O}o zBYU};IMLM5MqeeELZE;<+}oBoKDWL;t^F0&RCgXe#IY96GRiRe;NFrdore?hAmnm? zPU~3V1*08Zs4XZgzx9sAf#;H+yb5p3;9YXYQj!0?|7~=JOyg0GTS+Y_R^BGj$*sDH zt&-PK(&c`i|HRggf!U8zu(h##1x`)kZ$<_*ekszs-MAoseD~;J?I)kK!el!gyct$- zCcW(d;_tsoTq$8#*h?dmExugL`ud9P`6Ey($pL}K#<>b-5lF3})Her)2!>r}7ge1^ zHs7Q__6BAM*>h@VC#RlUxYg_MJR#+)AEN0HzEPP4u`s#vq`NXJ&kDJiP6$j4U3_$> zX!?iae)LKLylcr*`J$gJWcYEYRP;QLx>v!!Dot3Zt!U?JM)br!nU`&p zP-->*NYbg%t2EA1bkUJ}d(+4UOZ+JuX@6K{jB<1L=4R9O%8l|U72w|oP+9V`luWdY zr%c)Ox?C<#xZOZnH~ZRAAS%ZCzgrKmzoIwrUmIOIOv=~DgBNKgVQR4grYE*_)&8`8 zc=X({BlvG2Uj*q0Y^5s*gsBXO?HZPd$GUS3QHJdMSl_ z6f+E_^?%fA{H_?P-kltR}|9vw!ULr9gV__(0oeYsS0 z;%sB6NP49I$oUa5u|+3#~{I+`;%v zq}+fZkfN6_U_OqxlHy(8)@+|8U&J+#BAX6^`*pr)E$05XTnA@+WCg|e&ERn_DBor0 zd_mR&ro+lBe+wGLruX_)fsLVLn+YvKaE`qB>=qu4AD5#94F6IB>?ZCbrg92XvY|cH zOl1pq7?`%%ngqy?Mzz8^w&icZBUtoy%!ieEPE9pQ&E^B2HgIjFX7NK*O~G-$x_)2( zY|-M18-_^$GcuJNp-59uCfICq+b}!3T^Vg}j3G|s&j<9wdp#CBe$V|JMlutnA;rq{ zo;fo#KbFkb0wVO42XI>RBi-4Cn)}L&auOfWu1v;5!@`nIsGG*clc*$_J7dv4GRUn$ z59S8@rh?~oEUlCnIDM%*pz}2{%h?PkKTOOhcZ0OdYUmA7oQE}(M}H2-l*$sDUy#um3`GjBUTeVD?1_%;0lXbmxuP3b zWd1O1_kV*9FIw3-IP^Ch%iF`)SAAyRMDDgyhgkz3EY**sC=IG%u$JR%x}l9O?c3x@ zjRKJAfHUB++dAmmbDlX$*%NMNE>U}J-1FXnk&x@d^uyx{>tPXL-Qa8yY~jkmgOUm&nBX^`79j?~0!cOJd)%q~ob5zB&QTKxsi*3C_ z>Z*2o^FV{jj+5_225I+G?gwj2eWh*HB@1{xOBK5qwPrWC4j3aZyJLGXcH8~Yl(arK zVgiuA%y1WiGOn*%5r6wI(C}Nm*?aa^rb(KYeA&3?CBMhW7z|=*Ws~DH-+M}@n7r

                  +l z@r+gc=7!UCC;=^$-L=}Tbe+x?piX2Nb2QoQ+>iFYbnvEXRYB~0iT)5!cR;n}uXe?z zYORG@u)hITk7VkTud#}%wP#}_uF`2y>U#?G71(7dGvL`e^C}>kj8(#-b`|6SH$Wq? zC{xtkv6djW%df)&KWP#bo9O)`tuDp}=r7aidNzbpa6nv&NRxj)+wkly|TXF5a$r)c--6#ur2QdCLsJWSTnNnIu<|SOA*Wc>Z-i z?B@|jWXj~gmRyA~t6%FCseV<$0o6xEh7_rJ>PDF&cWf}BbR6@$X2Hm}S6B@gKd0gY zda?pGU2Wo>c`_g&u$PRgOHD~7T_iAmp)D6y}h4ba_=K0PmB!t3gr0Phk20O=NbP&$@ZfyNYcM0}v3 zvf2K|7z|7|FUm5PcDEhmg|M$@dlbWy98{sKZIKGbG_{)!DjBEUe^j)MTPB zA{@Rg%kJi!665}?qlP>XL60szOjEjGOqm-uf!TAW!HBo4>73cTA^CyF-H>dAkL=kW zT|r(F*MRB?`P$M)+~Dqz{h?(Pv9jA%kR=U}T-rN$(bXI|k1$?KjN7B}c;3$go5Yxl z%j4!<40e`O`8BiTa`KfijlZ+3C>GEx2?m;u%u0s|0wek7qFiTvsGp-(8|sd|aLiwv-O*vFRNehymo~BPR9t6a$pJvesz9q!cFqlY}sy z!1;k#qXHFhTHlyziLFmf@0dlJgR!x3;SJfd6)a-^yvWx`N=ahZVlx?ti+WuXgbBtT zssh5!LKc~}QVrT{X{q`9uEiE}TtaJ32?29J#sr4d4^K*L!yh8zyaf{^`XMaoM7m^6 z1W;U12lG{+uY4l5_((v&VT=H3#0^>!6$}>RN%*Zz)XA4BrmXv4N4QeZ!tTR@jN=$p zQv=G2cDEZWugLtjt9onUoaG$}Kn`kmB!v_AySQ~vOP|@Qjo5ZML*>y|b0`yluYdP5 zJQd9u_}Gxjbe1@KY$P^4zktq(V0i31X*?u-zc3}_RWn<=dWGOm^eu3QhAz)2UP4mx$%(Q@}j1=E^b;rF{}I)D+}ZghH}0Ni}_rJMYilY=l? zdS0c5@k;wFo*WeLYA^fFi4@`*%1PFg!7wQOHSLqhTp=%@n!0oC_)md6bv_WpWHkHG z_p;8%+QuPo`K02*tt%k_&LYhcAFbD*PprjA3uafxZqzr)2Cw#=4&9Wrp-2J&NFXHn zzj*;5;ktQwE>)&S)Jb?6Sh6IqTx|4>5_iO} zQJexj({b|=t#W;M`LwdIvtuAN^LXvq5uUA|F`bnCIYocvrs6m=2lgxL9>|A3mGCrISdpdtjw+?HDg2I83v? zC%0|oa@Jzc3nR^z;#**SR|n#ZiVEEzXc-;f23_|*9lj9p>@V&sJHN_9OTnA>+3=!$ z$M_p_wjm<^i+?F^3ZYQfrF08S2T!r;Ic`iI6uqY^0RL$>Q@4%8$y$s2bk2ZqEzn8* zlOX<8oqzF%=4@^4UqqiV_10hO|C-eR^B}b_#TP(fy+gig`9UtMO;rT6H^CP~|5>#h z1VnX@rr)5+IN~fUyC^W!SD?szrJ0&fga7$Dt1!~W?k72FT$fL0GDfqrxg( z%*^sC!VejB56epdRxsWWkpOS4tSZF6KMIX!kl%0DXJM|P(~{S~)R-2WqbZq5Nr$EK zO(AsxD65~@i$9Ld3jE58XthRE-guHPy7Xy-A~p0_fqo$)-`ua2{zVZUYmHG>=8em* zdg~q_qP%~#u8N9t!{J-MOjDj^|3=8qMQ&C-rqScK^-{4cwlCSSq@kdIh|HnVU;Nv( zWK=Ws=IjN0iVD$({#Pk68lFC?Drn?KZ34Wp_&@=iGao$NQhT*kFo}yeq;MjqaO*7Q zeu|;4S|z*?G1rT@{IE1zfuqmm>sZu}lG1SnZXIe~vpx24QcgyaEaMZ--v-%w%#Ktd zn*LsyoLA#>bmFn72b{|_vJ2P(0s@P;B2GuaOf5S=j}mTopb}?Dj5K!dD$LiD?t8F5 z7JLC``=^jbJis7G+hMamsB^wv;u{C~kq|s(j3ereu?qQ-(kE8B{|`#b|3#N5!-Wtq zXCj|GKj{LgqE;(=9>EuvvQURX}7G7LgeY%Cyz2 zHXNfe=%ql7#a=Zw3ZCU5o5+jss1sbkdj3u!W_mx`?q}knyLD)V=jg62#4~ejY)lo1 zcQnf0LPIGG`r|0lX#$a%m=52cli{>*IkR5YfzQDbgKiqr)c}++BzQ!2Omyq_h#4H6ld{C!xeaqCN94)SuDQ9O-e{IjyRP%dX4TlK@bbJ-qm7ia( zXWqBxHZE0EU&#EK+hKD{mWVl=(blR@GD1pHm~3hP;p&;@x00;An5_T!BZ)=j-sKv( ztrGh@QS~fGrN~U01Nr>iy2{2O*~y{VikYmvXvN_$fq)K4BO?ow*sd8vFBLRjlv}bt zn9l`6f6Fgf+hf|(8viu#e=AJB?fzDUA=XJZw#(3KTcCxEl9ZUPY2|?6Kt={=u>t{t zOuio;he65t6v0au>`=_-qB-7NDb9KCI!dj6Eu#Z1o%G8iF@MMAxj`~Xk4NO@J|P{) zy}3W8uYw?R;;>~wj|)ri6yMwjDg zpB?W#WnA@n5>~F0*tDN9y(AOz?T2@8EzLjqsFO+IL{p9jCw6_D`TaIXKHqxVj4LVn zH})D|&NNZ{S%YGm?rf9Pi(-W|F%<{6m6Ih1yNbL5u1G{9!gZ9o>eTqo7#k;5558Y` zd#hT`qiv~&6e$JI=l8tKct~JMq{)_*le=|(uw_i<6hR^57j5Eu?lbl`A*xsT9QFxL z{4O?gSz;ZOg>=XH-=sN>s4eggp1vF*9HMB8D6nfNb8YMDWMz%+Ujn*6a$tL;{PeKssMNZkdRO`D6(fEF0?SO3@!2h1-_>I3qNGPC*R8%YF z&UT+A004jwNl+B76m;;5{-PXXli^2Eh5?=Bjm~nj9Yvlu1^_PtGn4c9r`lcIR&Zs@zw?G9(;q7=!fR{eoVHh{9FqN z4b-{4-vtWKpgy*`^JSiXa}NLm57$HZ$-HjF?CcI8EBxl84i6B{{wlO;{_oJKD>PfU zMg4Q|-xFzDF5bmdBH}b;PWNvPC6GbGyfqwDC3q>i<;D{z8eY4)HaiYNVrOgdbtm-dY!V)yjc%2l zn@%g3fi@g85&i22GMV)SFgC`L_f{l%E45wh$t}(=`0Q1r(5`61-XA>iFM%DfN#;C=)(Be zSYK|~gEPlB779q#a*u61_s3Nt75=3d0Q7pK5&{bg^9#jyVkEM2a+r0x9D#O*#^)60 z#$7j>?WFotCU$hD4wMSYyQkAbl~jc^(T1y4fH4vhgKy7Y@#;qTdCi$nZH(IN-+TA z06-PodG^xo&Z-ydR3mRec>8CRrtaCc#B9?Mb?z_>313MG>`7Fo9wRByk6-hJxbF)A z)R#dXcXM`b^d!NyvX_AV>dnrV9GpqxdcS4(5{W{;inG_fPUXXgRL+Y&YC^u`@rjf7m%KdZ@TfHZJ0&z@dX)EbqBMh0FRyAK-Mx;po?6vm`?j& z!Q~Sq@@!|40&YVcwgg9uLCi${t7jS_%@(boDy^`XS{~@BJhRPAMAOCky_)-uSH9^V zVA@6b4pu4-2ZFAqpFt-}Zh`G>2EQbGBn?8a2t5$%HE#|Gsvq`JSAE0oM3qlBP8F68 z;8ygYw*3Cf{}||W$j{c4RG>X#0JVTJi-1lb{uYSxLGvS`XY|H<@tf#M7uTrRL-3s8 zEP*s;R8U~5{z#7({6^X8MU4>cj4Mzso0IRDk=JZgoAlJ)hwM4ImNFbyqY? z-i5E)k7#=hfYBlMK(MUTY9?_I!HMgl}cRAlmZ(3fv_hGcAa{zc`M z%*}^VP~IY$C^1oknv~Yyg2+AM1=8q)CO15w-O#3qKiF4mNpKpvyYVD0)jVfPsl<2l7z?8>?Akcw`UOFSe$*IsCrT&~|+R9xXGRnR9 z6@RN-)SdjGT*l6EzG`zAKm=^pEVfA57n_|-%-0`yQQ$X9mtpksR9tIZN=!x+tW|x_+B$3Yt6cWe z;6RYiYO~{K;a2%*_vB>g?|P0yJIXGZj$Vuu4JpSRg?Al-=Mz#1Pzn}&CHB{A>(-`# zk}(7Ro^K07ST1Lw?;(LrZynP`L)?tL%BTlt_Yc1QF1G;Z4q@zG-Yt4cS?eHd{~#s5 zICHuSbHrv3e|(Un1CtU`c&0BJa70*-yl;lzbGCX3<`}udDuHVY)&u6Wl zHlH{)AR76_Uf?=j-M)obfp!noJLl7ernSm|JZgxjS$~7>w8n>2)|ftB4WNMb*Sk1p z(ukMdErRmh?w!4r8|Ov@p^RW@ZvPv2eExq@CTGLrlWL7e>Vowvj25L{lAN;v3AnEs zg(6@1Qu}^Dp-qPcVJK|Ybod`x!X%iQC0if6CZ_$yZQ3mT%@hh0ee9)phC;sSTAiPC zb$7>TuP=Q|LuLG08PZGiLH-eew5rM?^}8WFud(MWY6Wfir@e{An)ULZSm}?bpp_z_0!F^4k!0M=dM>FCS%Gh5iit)W+B@% zJ6;eCqj%H(A8@TBUIfGsSKf%gjp)|kzAmkdqGwaAW-K9%`nwUDz$>kzmIaa`xwbnp zvDp&3_NAi7lF);NPy*j`oN!*@$@5@y-Vj3$+kBSJKE+=6psm1vRu^gh{v1)Dx~uduUCWo3%0zy`6m)6Wl38`E+8- zCG!g!c=qontIL)viBrQSLmBz>2aO1Fbw1sRr^%g!0(NBa(D(7hCmVHh_RX0j^OxFY z?>X%eh2MJxYY=U+F_oq4`y5)14$Hf45kShkTWV^^QqWuY5Q@S~DrSRWkfU)sojbTQ5KAVWD9aVo_M9L+^pb{!i??Nw0T| zm{y2OOD_$~88eGi38`vFMK6@r$pYJA2#%464bv%myg%s>vzgA|DJabU zS~`+zOvcXagY-`p$`zVA8ThY$&bc38K5Bk5j4pI9cAH2L%4H_6Fha)lvV-k^@JdAHLb7 zBWNXLTf-KPOTpKnPVnS%eturT>swOIuX`i0ou7zX$NuE6(!XOl8b6;n8&BQ8Pr-{S z8DwUoMMK;ZSSG7^Ur|U+jN+T<{!Lt2&dLxE|HNbLE`6`gap7GPa)I zg}BiTg9>fOZnW^-%Lfq&EqX|2ICX|w4EHfb)bp2Ih8pmG_o#N_?U{L6edIgW*ww`^ z%J?#Y%4c@e^zx9dbDX~B{mwoLZm`}WlH~!{#pBN;6_193E3uw{nw4FIDz5fuv$=-7 zXz%AzM!g(+%N_@1;!H375FlQWb!?6}wBkk7&KyjcJT$B8ahqt@f(xMjg@SS2ml?LN zL^WnDaLdRhWYPYDHMDKU+w7cq5;GlyrGB$ZVgF>XGb~PgGZy zQ=4zdZ(jm`1C6u?r^U?Jqa?;mYbY6J+BYfqYW^_kWxbllJ475@EFy8BRU~>2b$+Ph zYn(jlfT{fB#Lb{wVZ!i1CB~SJ{K#R>!lpn3e^vV29H~Cl(1WOrKSG7fYs#Q*=~{nt zMWy2~!f4~w;r;BTg?0@%k&@+$oK{wnSi}sSm)#Dp>6-daN4e4X??$G#>v51Jb3lKB z<*Rl7aEWPqgb7k-{+@YtSm|pTC+;Ai^pACfZ>crKLLRvj?4IXC;6>TIzK|UXwSZ=g ztnaqB8ZM=u^G;DpYCq{Y*&~}XECS-L(>aD=7J8<&hM9TXY+-0ToGWiN*5F^Ny7doh zI*%Ol1a3UlSW4qbEb649GnPO=ntokb8xx6*_f8T_DlShGCD*YDaq zQMhzOCT7-?(-yE?(?TRKl|;H|*ZokNyP58xZYE!(RGp17XHqxKUN>w~=7Cnl)N->% zJi5D66TOStXvIltnI{FGBE!;3N6nQEx()NUP5v;Mia+7hlFcolABNv|*B^ zBTQq1F08mr260a897$e%gL#oduJ!DpKYwx=N*f5GY^)cZv3l6XbCsBSjVO|Mm0&e?T7@S6ml)@+UDMo#HN>E@WB*2)S{O(;zram^b$A;<%P6JjZ~5o|Ma zq;cqSi-ws^gy_<)>Ne|CEB|WFB<|l*(F2=ifz3qgX~BtYdMz*C<*?>7%zWgkmBWQD z9_*ItAugji*Pd#)PKFr|=nc8MAX0AtxVr1*qEgj5Nrjo+^WpY$PFB~%| zIuG$)grj2EC>zd?-I|Gr`Bj~aU+4cU!vdm(_QFQO!Oi~l2ay^nQr@=27zwNElWet| zLg0`MvA`Q_Gp+%qMnPbVCN*00>gD1OE-bviUwj=#wiI5dVlfF zKay&UZc6`^ZMmP}k5>du<0`6soELQm>xp$zsxggMPG&)uYM(=v%5O}p3BUb&4M~_G?V5~NLKAke{dcOUZz)a=yWU>0S%|`2$j5(+A zIq0Yd*_4ocqLb6*IlI2Wc^%nmh3X;~<36kQhxub@j>D-Ta0jNEFmz2L_;xZ*F3S?JABzYnZ>MJo$Bvf5Ipe**f*`*P2=b8|p<)-UB%sp23=%`-w*KbIBxX1Ce#U*s_AiA`g z1>(-QDGNBy9dP`c33CA!8_jzB_`quwZGktu0prx<{$Ndtk3Dpk*18=UzP0+FR#o_w zv09Sbo02hG5Aqi{zPiW`ET^3fkE@#Pi*Xi#V`FhUOg(~SWC#509v(ft`yBiUpm%EuP2l6-;~7 zTQsi_>=b!ZR|8dn9(T`hA7>37=KlP|7be+vGb58U;+h6AtGYJkuQTOwfIcccTh?GD z+ChYwiiTd@;ivBh70;6j150w8`*L#=4wS92epOvi6&@Fm2rhMxB7bwv!BeWsLRhRr zl~`Uo+7&6eoAZVJ(;Kk)^*C&bWJlbE{n&!c7O8K%3 zo##eI1q4Ud6&5bf8>_NtP=CqoEXXjM7ES8ZSvuImB2w)5-3{u#)TZYwaO+<=Vo}~W+n6>Zx?5$&4&8A!a@LSUm|67zT3{N zmiMo*Br}6@KpjlmwLbqVHp^2>yVi(!w{|@f@v)cwBiS!A`gSHat#i1;#@!J0;joczcV*FQJVNW&iO68dmdHYO{1^at30l-yP76Ma=y@>X`MYJPc3fpu;@+YQH@a zmX$fD82lWx1ka+w3*aFCiE5_VYVT_j$0VJj@~RNzXO|8=G79N{5>ElO&t3Kzix?DX zKhCbd1{QZ(r2;wtV$p+><4Tl$J*0@cO+RUW%CWjUJ2a}CdzEB;+wtZpHv(!DKD~X| z->r5z-~5)M$Hnw&2^<@aDLJ=x@B-C;0S~IE00h1^5N)ucp!GV7AwPEvZtS zrQa+Hh@BbUyynamz>nA{EI_Qk*u@Ut5{Qhg?rn)aV$HD!6611~fpADW^7TiMNr^tW z%o6^_|D7EwQpPTQxvGM5dM21RZL@k{q`HQu?v=+9{sz@?m%VF zKmGe)cT40wD1<5(-ph7jd%_8&6KevGI1O6GoX+Ff1R2;A9!Eabk z!2s^`(rZiBFuM!W*e=HvNEhC+O%Rxpt1F%_)2}Ls&7^6KsGGYH z3<$|ocu}~1d?)DBmv0M3YQMlPv@dzdKj2Bn>4mGubQ3y+XN{VdjwuOJ$K+ie&&Nfeb8!roMv z%fTHh$S9z|>D8g+?@vFULh@ZBr9M`z-TOfzy%~i4*4%SxT+3L9#HK!!2^%;Kj|p7j z=fiM(XFVNSM5%vQ(R>hRWqIiON;x*0vC%VTlG}?rq3}iKDR#P=?&ozTPvQ~hQ>%Iy z21mpw>q3V*5RpxT$`YepiWJMq9kRfIQ+P+0|MX^;dUiBYOS7ebUDaYDB{Q2^_FcZ> z)?!utZ%e9}qgVI^ZYd<9KSJX55nG;QLqVF4W0Yn=he$3IJ@7PV7}7i(@-fWAVdUJ@ zrTLWdF{%HdEs85dldHWd?KJ+{#3+XvKtz1-0ghLj)xljJlJk*M3gGRaN_*GX`c&^9v)+F5 zom|iJ9Dcq^3uKE>S1+Jt2q{dygr@SkCI3AszvxYJe+6-zt=_ zZn50JU3zqM``RCH<){g*k9R37dEO`xd*7-&Z>KBYd5S(D0a)FS@&PuU@HmpM>Fi1j zE}6sHGslLXoSZQ>712+w?3>L8JeFk-&baa-rH@J9Z4X)g0B6fDj_K4x4^UqCBYWg) zD~Id!<58sp(kM*)&Pu0oP|CMsXH8uBuO6RDb>x#r_di9Imu;DEiTkr#s3*|+z2r!n-F4o$? z2!SukyIUtiyGrp%=m1ZwTz^w`ftTlL`@nmLp$i*Xwy}L=R9jFp`p@`775Jm4PzOlP z^m?uWEg@-o>G7rK(~W(Xe?QW4q7&AN{lDpkJ1B4<_qSPfO^u05Dhh-Zr^e$IwdUix zC8(r{N0$z>+-`>dF3XLcnwt8pe)~({R09Dv;os`(5mO|N#phM%^DvM#ag~T!l|LZ| z6*>d}`Tc{GJD}S%_jfoMqL}20sE%OlP2EFM$(C)5>F|#?*msUoQ)prhiQ910ImHdwFo%Hfr_Sg zQ;y8w_5DVR4U|4v@h`)d2EE|_XzO*f3`eUe{|7X3 z1LX0OakgusVHpIV65Sv0!g;?L8-D_d=i7~cx2Bq!_Ce10d3L>wZysJeB^BR+aIAl3 zn<@o#tU{IP%KVYO_nH?(3q9_uy-~;pdw|;cl%XW!FH2WV6Cem-tgmnUl)h||os)aA zR3wx?eIpY_vY=b1?$iEvccn8V@dh4fl%T^%@f1xiD4)$D6LXg*0TXpK5kI(1?bG6d zXQ6IMs4<8$t-5HMBahLia{Ahz8!cgTxJa!$Sm3}3BBsk6!2j2~IO@-9MiO-M8ccZY zJ~VB}8L}FU;fcu5sMqqGS~0^VgJ2xcP`2D}*g(iGHG1RM!Y4^hUbP~PyXxXB-5;d9 zU((34s?8eWr(QPLhGlm>i)D(3{{l|iq;wUR0RDj;tO(x8e z4=Xr%E&hkQbgs@-O>ObOoEx}6Z|aq|Ja~5XJqQBoNyW2(Ug-RgS8ckSP%Fg~3hclD z@N9vaIAfsxLSk(rJL}p$n|bVmyECXv29ju{OV`+9=+Z?Rx;#9=aHBw;0?xe@KEiW) zIkskueuct*5W^#>MH|i5;|4~2xMWnmuA>qn5HwV4#XEbvI^y92y+wg+wUa<}gFLcbXX&)5nZx9wmcSFOlE z2-o$rea~lt7m<;PD#x{!9D_2w7rHkAMOkxy_s62Hms~@8k0CzuM;^&&q8bB6- zowzKTJ~cQCt0zf^Du*x=gy)5wFaBVdzqYp@W{E}z6H-B@|{^IXf--I~9JUrx< z<6#DE+vVoE8WW^cj!E>cJ^rOc%K0?MPX{okw13@HhJlL8%JB}93Q7#gx8bdeT)Pp= zGL@!d@J8&Elrce-cSX|YXD*+vVGj9)g$OgSSFX!peMbv1O#GT~U;3ss75Vv_Md)kI zW?#;nYk@oJfv>b_lx?(Qp^s&Pe~VMtq1g~@Nh2(7jQxXi-L%r$ns%`=VIvx+Rw-Ic zVR;H?f9CFrJv`ue9(Mrc2F8KDK^iggZv?;GWE&l>(7Qc;{_M=9(y(2vU;Hp7)c$b6 zYn|h_5V?we_3A>fn2cg$jkD^HX&ygxNXYS2Szu7BQ?O#R`Jy+tN>HI#xi+5c@vjRH zX`wfKn<7mwp&n&kwycc17T-063u!0#9(m2J^E4;2BUaYOEJ>oNO6{RKTi#4D(C!Nj zQP~^664^|CY?i9KC}d3GdGs=>&o=0C)3<6Mwf!5}ikhsjxiqxbtmo26h9Jqhqxaf+ zj<6lgy6ZbQ);$x4ebhs7ZC!7>USuW-Gj~{-58YtKEZuzEd$`b4f`n!;L%ADyqj%Ax zWrBi&=KMNWrMyDuJSgX3F@w&q=O6vdZ^e$4=3!E#gTdY5pImxA_bkA)N=CTG0rLt@j|B0}Ug zmod4|2t$nTzTe;fzwck)^XIueujf3^dCnitIq%~=7vwckPrxF9*X{ZcHLRZG+m}ag zyVGky{w+S`kAB~kz_|ZW0{+By7p2_Tn5V_Cn_KRRjhht@q(7Y-N_Qe#_?ZaFm6Ngx z!*Jp%TOsO?}i|p%`Iju&tFvvI& z;Dy_<;B2R@zlpKov|X*z{?()UPNU^*PRvKQfR4W4k{&Wxb z>~EBPz104ieED+)mYBY=&l?M-jomWZ$3SSsTuc19JxokfNh>+%O#&g#pvg@sn8WI( zkVvru>8!_nf5%@T@6EQef4&)fn0C|J{O>bOI|4!5P12~2c`V4WX9tELX(a9-6{mKU z;y8=`-SZhVnb`;At%XW@E4krT8&|g?fSUauq zm}JKlM9Ln0$hR5x*`2-~Ke;@-(xzZzbM%?QH4n)8w`hCw=j)PbbyCYaN6qK>qi~Zy zJUBzSH^_7PsO1S3)6n4&=AdMAWdS#}a3yJym<2kB@etJAPiHMgr=uvVJw!#_#^Vnk zcqPUD4D2c-*T`eS_!Drl%i1z=`+UL!l%|3az|@Fpy^ALQwO%f1TjR4TFtm9GSU1Qg zY(!BEd-g(N3|V*VqtG=Y30S_~t0PXGw}w6mzii^*^eQEmj(s^}5E<1-!t83FF*@x+ zzf7(=!^jWJGk7C=gj{xZni#n(vyxee^0nAuu9By(s{|C{L^eetKOdtH@|~d%+R{A_ z>bxFd+rso^_taYz9)_J5RTY*Rz$se4Td`)nU(9IdQ@xPt6(7c~jJle;6S4LLY2lOJ z^2=p8(YLilPWl*XaZVWX^v5DH#_wkE3J>%Aq=cI{8T}>)8%c2ZrgD60Xb&t8^rcdsJ!9?pk<4Co z-CbH=98t~enHflXeZKU$;2Pup4RU}QXFM?Yvh)V&Mc<)pJ=ur$0>>Q9&89CEb!Hd)v)@PNDiRcNS9iyg8^*zX69FRI^U*PE+rnu4(>tc{ zEyH}yRbnhjE^gkD(y*nfGpQc3UQWL`oYev z5*pEbwyRmY37V%3Q)&9O?Ml^!X6u99HFQTu(fge3`B|tZQ5gMXEo;A8PQPOH^e}Y~ zd-F2JHJh7PIj6G|{9A1@0m*4{sK#bAR}~TTL708}Ovx}W{~4j7sy_YfY9Rr1^e=-e zIijd1Wn)COqlEz{Lm>Z@%5aAVKJAA`MIrpT-GrpPygYl##X>Xb-%5dOOHI^@t-6KJ^Di%8etOVDom&E-y<>!>=%-Q1Q0r}v6vT}P zWwGj{6y1t8>p!YKiJ;!y3cluHXL>_ko!P5){qw`0e0;5~U^O#Fd%Zki4C)B!i)tW0RR#a)e!4*1M`I;UbGL!`pObfs}nmU89+Rvhm zx&&Mja^Kc1BLhD!^nbADT9}{&lcn9u!bv$k${?Hj$gn3DN}oeA86*UpomnSE6^rn0 zWTXV3PjS9#s;JNux@;B{ojg$!0g7w%#f`s%E`7p$K$NU4Q-vB zkDuFEZl5H#RNvZkh{vZJD+Tr$;7l^3!nbl6*l zB(N5wc8^cuij~UOPLI3J3P#EBH^+sKmX%k?H9=_<``U{f{jjD|UJA8cDp7saFlGil z(c%4K;aSTVBc&GIT7^l`i_r}9UgC6IU4EIeHr!XPuVxBkc|VPdwW|~)AlJ+ zrg8tr*z5F$(xtVyJf$4jC5jcXd!`*bqE03a(x->CyUf=__3|bMjk;_P&;FvPwGhts z-St|vDC%yW%?uoY-yif8Tsmz=9LJTSY$4ON#KYQVA!vE+5?V8fbIr`xcU4Z#XOGD} zmlLpOm?C*y6fFpK=Ep8C4n(LF%X9Y5poikVSMt5(9>rH+|S zP%`UWyKp}=>eM$!siC6&%gU8~EfD+3nZU_JpQR7bKIN)+zilBsjS-7CyKN6U*o{QK zmpl_f0`08;Trbx-KK?>3@>W3-K%ha6-GxIcSjer$A}Dp9zl z@M9`50sz}BEt}Ql_Q1@!ZCXD)eS$xa+et77x(rsP`2tzB`Ln5Knv+I|9?anUy$xe3 z0b3uO)m`k<5Yr}X@ZsqqA{5vD8e1B)y_>@>Fx`}sQD4{PMWgz~k#A`$yTwo!31fA^ zfQD%N63NEXX8;k#OEr1w^?%g~S~B$l$6krOJ$)QCO1}GUVBD)DKz{_-j0r%a&Z%C;nL$sC3TcOu@}h{WcBe z%(EAE6vX3sLSS3*|CR)onrO{1;l`dkf(PziZI9i-vY&&xwBpoN&%rmcFfI_IlgmD5 zr;4)TLp@E#MDsLH>(-V`$b*l>L0cAz$KQ#+Wt3oMW*CHN%? zKBZtpfmL~m)NAQR_mwz4;VIcvyyqe6i=Mh**g)FZG=m0E%-7tG7MYXVunW*VmwLhU z<8t9~ur~RrQ+$D!E~=X@gylCjFEFrQ=Y)&D9-MW`-{>$&7jL*U6OfSO;F+ppwa%}P zH+8)lyshdtU>2a0Kxq#o4-3b4^4IZs;3uiiQAN=Q&oqGIzvg~vxus?}@miy95a)lG z2Bqm!1Rsf=W4xG$*&TmdSu?SYerPnGx9eumi2FpZ1a{~~|5mwZYC4tG@UGMFveFcc zVEY-0X=)ig#sh*g0b0^BHj|8mVy!y~L&~vE>vO#%DD{E5?^Np}Bn^BdrY-YAV{p-D z5KwFfv*?*jiI@1|a|`9*nrn8^Zrf=3?9XC{1rw(abYDF1iMqxGFj(9$_BI?YA1VG0 zkH5(eF#-URkD4Ta!C=5E>FaPf_&hWYkB3`2O9B9~Z(Gm*PX;K2`!cE9K$?e7f`_(q zD?SxTlLPy~)*3+J+;-W3Fz6cc5UpV=N3DF6wTQAjoK#&8AC=#?&1&EFav7ps(Wb!0)f5 zC1^3!w0>SRRvs0F!>3W!KC5Q!(IQ&L1phn<&2(wV531_yv*8FHz_+b<&|8{`z8IrQ zgPkBSLxv$b*k&lzSLZaqST~;tnh4$THnq6Zk<-$kn|(00HEPmSLRHSsuWFBpJ`a9r zSh)+(Q*+Zs zXTfFA_vJ%XkTI4DTpkKfl7_Y;`N329`Jtpx_I3WA!+SjYVsHO9n;uD4y!&v5yBW}E z1W2adV|y34?pxivhw9Q8WYv~h)3<`r1%`#}FC;tFAsuXMpJ*Id&?ntU3PE%QCpoFyG;TLZRo=fKdOHpe99MsR z>c)LXoc9JvSV*Xz%duY!*^4^)kjzXnFuvWZAt@<|>c4%M|5*!F^e%5=#1o`V6OxN1 zpFQae@HKl$b49qhd82hi0lqo;cmBWqc(tT;u2oM6@Ft4#h&vvC^tc*S+ig|sTC0^g z8cqDS+40HJA|cEF@s5jX)O!t}XuN#%$JRNGnZs|tMA^U}Op^PMwEuG>gu8qB;aRE6 zk$_l(HN)AGl7dmfRk-+#&Z2&v%Sy?1I$Yr@Im82NIuk5kZh~DBgnZ!d?fUHslLyKi z=t^Flm&k%ns=dEJem!cx7#Atf6z#x{;9k~axcus_0lVjeNPC+Jk9mFIfbn&6c-d8_ G$bSK%Y!eFr literal 0 HcmV?d00001 diff --git a/docs/css/api-ref/intelligent_maintenance.html b/docs/css/api-ref/intelligent_maintenance.html index f6caf3dd4..a8fa82683 100644 --- a/docs/css/api-ref/intelligent_maintenance.html +++ b/docs/css/api-ref/intelligent_maintenance.html @@ -16,7 +16,7 @@

                  diff --git a/docs/css/api-ref/kibana_public_network_access.html b/docs/css/api-ref/kibana_public_network_access.html index 398afb10e..163b6e74f 100644 --- a/docs/css/api-ref/kibana_public_network_access.html +++ b/docs/css/api-ref/kibana_public_network_access.html @@ -18,7 +18,7 @@
                  diff --git a/docs/css/api-ref/log_management.html b/docs/css/api-ref/log_management.html index 2f0c6ec28..231e9f1bb 100644 --- a/docs/css/api-ref/log_management.html +++ b/docs/css/api-ref/log_management.html @@ -5,9 +5,9 @@
                  diff --git a/docs/css/api-ref/public_network_access.html b/docs/css/api-ref/public_network_access.html index cde688440..e851ce843 100644 --- a/docs/css/api-ref/public_network_access.html +++ b/docs/css/api-ref/public_network_access.html @@ -18,7 +18,7 @@ diff --git a/docs/css/api-ref/snapshot_management.html b/docs/css/api-ref/snapshot_management.html index fe9131710..822d085d9 100644 --- a/docs/css/api-ref/snapshot_management.html +++ b/docs/css/api-ref/snapshot_management.html @@ -5,8 +5,6 @@ diff --git a/docs/css/api-ref/snapshot_management_0.html b/docs/css/api-ref/snapshot_management_0.html new file mode 100644 index 000000000..551967f19 --- /dev/null +++ b/docs/css/api-ref/snapshot_management_0.html @@ -0,0 +1,18 @@ + + +

                  Snapshot Management

                  +

                  +
                  + + diff --git a/docs/css/api-ref/thesaurus_management.html b/docs/css/api-ref/thesaurus_management.html deleted file mode 100644 index 985a3ee54..000000000 --- a/docs/css/api-ref/thesaurus_management.html +++ /dev/null @@ -1,20 +0,0 @@ - - -

                  Word Dictionary Management

                  -

                  -
                  - - diff --git a/docs/css/api-ref/topic_300000010.html b/docs/css/api-ref/topic_300000011.html similarity index 91% rename from docs/css/api-ref/topic_300000010.html rename to docs/css/api-ref/topic_300000011.html index e87c83175..5ec0ac25b 100644 --- a/docs/css/api-ref/topic_300000010.html +++ b/docs/css/api-ref/topic_300000011.html @@ -1,4 +1,4 @@ - +

                  Load Balancing

                  diff --git a/docs/css/api-ref/vpecp_management.html b/docs/css/api-ref/vpecp_management.html index 06bd30a28..69e37d035 100644 --- a/docs/css/api-ref/vpecp_management.html +++ b/docs/css/api-ref/vpecp_management.html @@ -18,7 +18,7 @@ diff --git a/docs/css/api-ref/ymls_management.html b/docs/css/api-ref/ymls_management.html index 9f691eb3a..261584bf5 100644 --- a/docs/css/api-ref/ymls_management.html +++ b/docs/css/api-ref/ymls_management.html @@ -14,7 +14,7 @@
                  Table 9 Load balancer APIs

                  API

                  +
                  - - - - - - - - - - - - -
                  Table 10 Load balancer APIs

                  API

                  Description

                  +

                  Description

                  Querying ELB V3 Load Balancers Supported by a Cluster

                  +

                  Querying ELB V3 Load Balancers Supported by a Cluster

                  This API is used to query the ELB V3 load balancers supported by a cluster.

                  +

                  This API is used to query the ELB V3 load balancers supported by a cluster.

                  Enabling or Disabling the Elasticsearch Load Balancer

                  +

                  Enabling or Disabling the Elasticsearch Load Balancer

                  This API is used to enable or disable an Elasticsearch load balancer.

                  +

                  This API is used to enable or disable an Elasticsearch load balancer.

                  Configuring an Elasticsearch Listener

                  +

                  Configuring an Elasticsearch Listener

                  This API is used to configure an Elasticsearch listener.

                  +

                  This API is used to configure an Elasticsearch listener.

                  Obtaining Elasticsearch ELB Information and Health Check Status

                  +

                  Obtaining Elasticsearch ELB Information and Health Check Status

                  This API is used to obtain the ELB information and health check status of an Elasticsearch cluster.

                  +

                  This API is used to obtain the ELB information and health check status of an Elasticsearch cluster.

                  Updating an Elasticsearch Listener

                  +

                  Updating an Elasticsearch Listener

                  This API is used to update an Elasticsearch listener.

                  +

                  This API is used to update an Elasticsearch listener.

                  Querying the Certificate List

                  +

                  Querying the Certificate List

                  This API is used to query the certificate list.

                  +

                  This API is used to query the certificate list.

                  +
                  diff --git a/docs/css/api-ref/css_03_0062.html b/docs/css/api-ref/css_03_0062.html index fa045ad63..01adb59ca 100644 --- a/docs/css/api-ref/css_03_0062.html +++ b/docs/css/api-ref/css_03_0062.html @@ -2,7 +2,7 @@

                  Creating a Pay-per-Use Elasticsearch Cluster

                  This section describes how to create a CSS cluster by using APIs. Figure 1 illustrates the API calling process.

                  -
                  Figure 1 API calling process
                  +
                  Figure 1 API calling process

                  The token obtained on IAM is valid for only 24 hours. If you want to use one token for authentication, you can cache it to avoid frequent calling.

                  Involved APIs

                  If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header of the API when making an API call.

                  @@ -72,7 +72,7 @@
                  diff --git a/docs/css/api-ref/css_03_0071.html b/docs/css/api-ref/css_03_0071.html index 291725580..c518dcbbe 100644 --- a/docs/css/api-ref/css_03_0071.html +++ b/docs/css/api-ref/css_03_0071.html @@ -2,7 +2,7 @@

                  Obtaining a Project ID and Name

                  A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.

                  -

                  Obtaining a Project ID and Name from the Console

                  1. Log in to the console.
                  2. In the upper right corner of the page, click the username and choose My Credentials from the drop-down list. The API Credentials page is displayed.
                  3. In the project list, view the Project ID and Project Name.
                    Figure 1 Viewing the project ID and name
                    +

                    Obtaining a Project ID and Name from the Console

                    1. Log in to the CSS management console.
                    2. In the upper-right corner of the page, hover your mouse over the username and choose My Credentials from the drop-down list. The API Credentials page is displayed.
                    3. In the project list, view the Project ID and Project Name.
                      Figure 1 Viewing the project ID and name

                    Obtaining a Project ID by Calling an API

                    The API for obtaining a project ID is GET https://{iam-endpoint}/v3/projects. {iam-endpoint} indicates the endpoint of IAM, which can be obtained from Regions and Endpoints.

                    diff --git a/docs/css/api-ref/css_03_0076.html b/docs/css/api-ref/css_03_0076.html index 4c90c3c7c..a735d3b31 100644 --- a/docs/css/api-ref/css_03_0076.html +++ b/docs/css/api-ref/css_03_0076.html @@ -154,7 +154,7 @@

                  Insufficient resource quota on the node.

                  Release unused clusters, reduce the number of new nodes, and increase the quota.

                  +

                  Release unused clusters, reduce the number of new nodes, and increase your quota.

                  400

                  @@ -187,7 +187,7 @@

                  Insufficient disk capacity.

                  Release unused resources, reduce the disk capacity required, and increase the quota.

                  +

                  Release unused resources, reduce the disk capacity required, and increase your quota.

                  400

                  @@ -781,7 +781,7 @@

                  Invalid extended parameters.

                  This error code is generated when an internal error occurred.

                  +

                  An internal error occurred.

                  400

                  @@ -869,7 +869,7 @@

                  Invalid database user name.

                  Currently, only Elasticsearch is supported.

                  +

                  Currently, only elasticsearch is supported.

                  400

                  @@ -1345,17 +1345,6 @@

                  Enable the VPC endpoint service and then perform related operations.

                  400

                  -

                  CSS.5300

                  -

                  This operation is not allowed for yearly/monthly clusters.

                  -

                  This operation is not allowed for yearly/monthly clusters.

                  -

                  This operation is forbidden. (Internal error)

                  -

                  400

                  CSS.5301

                  @@ -1455,17 +1444,6 @@

                  Enable the related functions based on the error information.

                  400

                  -

                  CSS.5312

                  -

                  Nodes and disks cannot be scaled out at the same time in a cluster billed in yearly/monthly mode.

                  -

                  Nodes and disks cannot be scaled out at the same time in a cluster billed in yearly/monthly mode.

                  -

                  Operation not supported.

                  -

                  400

                  CSS.5313

                  diff --git a/docs/css/api-ref/css_03_0078.html b/docs/css/api-ref/css_03_0078.html index 536075cb6..c406be6fe 100644 --- a/docs/css/api-ref/css_03_0078.html +++ b/docs/css/api-ref/css_03_0078.html @@ -1,7 +1,7 @@

                  Making an API Request

                  -

                  This section describes the structure of a RESTful API request, and uses the IAM API for obtain a user token as an example to describe how to call an API.

                  +

                  This section describes the structure of a RESTful API request, and uses the IAM API for obtaining a user token as an example to describe how to call an API.

                  Request URI

                  A request URI is in the following format:

                  {URI-scheme}://{Endpoint}/{resource-path}?{query-string}

                  @@ -23,7 +23,7 @@

                  resource-path

                  API access path for performing a specified operation. Obtain the value from the URI of an API. For example, the resource-path of the API for obtaining a user token is /v3/auth/tokens.

                  +

                  API access path for performing a specified operation. Obtain the value from the URI of an API. For example, the resource-path of the API for obtaining a user token is /v3/auth/tokens.

                  query-string

                  @@ -90,7 +90,7 @@ POST https://{iam-en

                  Mandatory for AK/SK authentication

                  Signature authentication information, When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request.

                  +

                  Signature authentication information. When AK/SK authentication is enabled, this field is automatically specified when SDK is used to sign the request.

                  For details, see Authentication.