From 99a2d775991c2ae99743e2910d3e2fb85261405a Mon Sep 17 00:00:00 2001 From: "Zheng, Xiu" Date: Fri, 7 Jun 2024 17:47:08 +0000 Subject: [PATCH] css api 23.5.1 20240520 Reviewed-by: Kacur, Michal Co-authored-by: Zheng, Xiu Co-committed-by: Zheng, Xiu --- docs/css/api-ref/ALL_META.TXT.json | 846 +++++++++++++++++------ docs/css/api-ref/AddIndependentNode.html | 190 +++++ docs/css/api-ref/CLASS.TXT.json | 424 +++++++----- docs/css/api-ref/ListFlavors.html | 241 +++++++ docs/css/api-ref/ListImages.html | 184 +++++ docs/css/api-ref/ResetPassword.html | 119 ++++ docs/css/api-ref/RetryUpgradeTask.html | 118 ++++ docs/css/api-ref/ShowClusterDetail.html | 593 ++++++++++++++++ docs/css/api-ref/UpgradeCore.html | 174 +++++ docs/css/api-ref/UpgradeDetail.html | 436 ++++++++++++ docs/css/api-ref/css_03_0008.html | 28 +- docs/css/api-ref/css_03_0018.html | 40 +- docs/css/api-ref/css_03_0019.html | 108 +-- docs/css/api-ref/css_03_0020.html | 10 +- docs/css/api-ref/css_03_0021.html | 38 +- docs/css/api-ref/css_03_0023.html | 241 ------- docs/css/api-ref/css_03_0024.html | 34 +- docs/css/api-ref/css_03_0025.html | 10 +- docs/css/api-ref/css_03_0026.html | 591 ---------------- docs/css/api-ref/css_03_0030.html | 33 +- docs/css/api-ref/css_03_0031.html | 88 +-- docs/css/api-ref/css_03_0032.html | 12 +- docs/css/api-ref/css_03_0033.html | 60 +- docs/css/api-ref/css_03_0034.html | 50 +- docs/css/api-ref/css_03_0035.html | 2 +- docs/css/api-ref/css_03_0036.html | 2 +- docs/css/api-ref/css_03_0037.html | 4 +- docs/css/api-ref/css_03_0038.html | 48 +- docs/css/api-ref/css_03_0039.html | 6 +- docs/css/api-ref/css_03_0050.html | 16 +- docs/css/api-ref/css_03_0051.html | 2 +- docs/css/api-ref/css_03_0056.html | 2 +- docs/css/api-ref/css_03_0057.html | 29 +- docs/css/api-ref/css_03_0065.html | 8 +- docs/css/api-ref/css_03_0078.html | 4 +- docs/css/api-ref/css_03_0079.html | 4 +- docs/css/api-ref/css_03_0081.html | 12 +- docs/css/api-ref/css_03_0082.html | 21 +- docs/css/api-ref/css_03_0083.html | 18 +- docs/css/api-ref/css_03_0084.html | 82 +-- docs/css/api-ref/css_03_0085.html | 111 --- docs/css/api-ref/css_03_0086.html | 98 +-- docs/css/api-ref/css_03_0087.html | 111 +-- docs/css/api-ref/css_03_0088.html | 83 +-- docs/css/api-ref/css_03_0089.html | 113 +-- docs/css/api-ref/css_03_0090.html | 68 +- docs/css/api-ref/css_03_0091.html | 98 +-- docs/css/api-ref/css_03_0092.html | 74 +- docs/css/api-ref/css_03_0093.html | 4 +- docs/css/api-ref/css_03_0094.html | 96 +-- docs/css/api-ref/css_03_0095.html | 64 +- docs/css/api-ref/css_03_0096.html | 163 ++--- docs/css/api-ref/css_03_0097.html | 153 ++-- docs/css/api-ref/css_03_0098.html | 97 +-- docs/css/api-ref/css_03_0099.html | 82 +-- docs/css/api-ref/css_03_0100.html | 65 +- docs/css/api-ref/css_03_0101.html | 65 +- docs/css/api-ref/css_03_0102.html | 139 ++-- docs/css/api-ref/css_03_0103.html | 4 +- docs/css/api-ref/css_03_0104.html | 131 ++-- docs/css/api-ref/css_03_0105.html | 128 ++-- docs/css/api-ref/css_03_0106.html | 100 +-- docs/css/api-ref/css_03_0107.html | 83 +-- docs/css/api-ref/css_03_0108.html | 66 +- docs/css/api-ref/css_03_0109.html | 4 +- docs/css/api-ref/css_03_0110.html | 98 +-- docs/css/api-ref/css_03_0111.html | 80 +-- docs/css/api-ref/css_03_0112.html | 146 ++-- docs/css/api-ref/css_03_0113.html | 93 +-- docs/css/api-ref/css_03_0114.html | 80 +-- docs/css/api-ref/css_03_0115.html | 2 +- docs/css/api-ref/css_03_0116.html | 146 ++-- docs/css/api-ref/css_03_0117.html | 130 ++-- docs/css/api-ref/css_03_0118.html | 85 +-- docs/css/api-ref/css_03_0120.html | 123 ++-- docs/css/api-ref/css_03_0121.html | 114 +-- docs/css/api-ref/css_03_0122.html | 103 +-- docs/css/api-ref/css_03_0123.html | 84 +-- docs/css/api-ref/css_03_0124.html | 64 +- docs/css/api-ref/css_03_0125.html | 6 +- docs/css/api-ref/css_03_0126.html | 112 +-- docs/css/api-ref/css_03_0127.html | 112 +-- docs/css/api-ref/css_03_0128.html | 122 ++-- docs/css/api-ref/css_03_0129.html | 278 ++++---- docs/css/api-ref/css_03_0130.html | 184 ++--- docs/css/api-ref/css_03_0131.html | 104 +-- docs/css/api-ref/css_03_0132.html | 17 + docs/css/api-ref/css_03_0133.html | 196 ++++++ docs/css/api-ref/css_03_0134.html | 328 +++++++++ docs/css/api-ref/css_03_0135.html | 99 +++ docs/css/api-ref/css_03_0136.html | 138 ++++ docs/css/api-ref/iam_02_0008.html | 15 +- 92 files changed, 6295 insertions(+), 3892 deletions(-) create mode 100644 docs/css/api-ref/AddIndependentNode.html create mode 100644 docs/css/api-ref/ListFlavors.html create mode 100644 docs/css/api-ref/ListImages.html create mode 100644 docs/css/api-ref/ResetPassword.html create mode 100644 docs/css/api-ref/RetryUpgradeTask.html create mode 100644 docs/css/api-ref/ShowClusterDetail.html create mode 100644 docs/css/api-ref/UpgradeCore.html create mode 100644 docs/css/api-ref/UpgradeDetail.html delete mode 100644 docs/css/api-ref/css_03_0023.html delete mode 100644 docs/css/api-ref/css_03_0026.html delete mode 100644 docs/css/api-ref/css_03_0085.html create mode 100644 docs/css/api-ref/css_03_0132.html create mode 100644 docs/css/api-ref/css_03_0133.html create mode 100644 docs/css/api-ref/css_03_0134.html create mode 100644 docs/css/api-ref/css_03_0135.html create mode 100644 docs/css/api-ref/css_03_0136.html diff --git a/docs/css/api-ref/ALL_META.TXT.json b/docs/css/api-ref/ALL_META.TXT.json index baa7d93c..9e4d6705 100644 --- a/docs/css/api-ref/ALL_META.TXT.json +++ b/docs/css/api-ref/ALL_META.TXT.json @@ -15,7 +15,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Before You Start", @@ -34,7 +36,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Overview", @@ -53,7 +57,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Endpoints", @@ -64,7 +70,7 @@ "node_id":"css_03_0056.xml", "product_code":"css", "code":"4", - "des":"In CSS, Elasticsearch 7.6.2, 7.9.3, 7.10.2 and Opensearch_1.3.6 and Kibana 7.6.2, 7.9.3, 7.10.2 and Opensearch_1.3.6 are supported.", + "des":"In CSS, Elasticsearch 7.6.2, 7.9.3, and 7.10.2 are supported. OpenSearch 1.3.6 and 2.11.0 are supported. Kibana 7.6.2, 7.9.3, and 7.10.2 are supported.", "doc_type":"api", "kw":"Supported Cluster Versions,Before You Start,API Reference", "search_title":"", @@ -91,7 +97,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"API Overview", @@ -110,7 +118,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Calling APIs", @@ -129,7 +139,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Making an API Request", @@ -148,7 +160,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Authentication", @@ -167,7 +181,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Returned Values", @@ -186,7 +202,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Getting Started", @@ -205,7 +223,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Cluster Management APIs", @@ -224,7 +244,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Creating a Cluster", @@ -243,18 +265,20 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Querying the List of Clusters", "githuburl":"" }, { - "uri":"css_03_0026.html", - "node_id":"css_03_0026.xml", + "uri":"ShowClusterDetail.html", + "node_id":"showclusterdetail.xml", "product_code":"css", "code":"14", - "des":"This API is used to query and display the details of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200NoneStatus code: 200Request succeeded.", + "des":"This API is used to query and display details about a cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_i", "doc_type":"api", "kw":"Querying Cluster Details,Cluster Management APIs,API Reference", "search_title":"", @@ -262,7 +286,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Querying Cluster Details", @@ -273,18 +299,20 @@ "node_id":"css_03_0084.xml", "product_code":"css", "code":"15", - "des":"This API is used to change the password of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneNone", + "des":"This API is used to change the name of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameNoneNone", "doc_type":"api", - "kw":"Renaming a Cluster,Cluster Management APIs,API Reference", + "kw":"Changing a Cluster Name,Cluster Management APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Renaming a Cluster", + "title":"Changing a Cluster Name", "githuburl":"" }, { @@ -300,7 +328,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Restarting a Cluster", @@ -319,29 +349,33 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Deleting a Cluster", "githuburl":"" }, { - "uri":"css_03_0085.html", - "node_id":"css_03_0085.xml", + "uri":"ResetPassword.html", + "node_id":"resetpassword.xml", "product_code":"css", "code":"18", - "des":"This API is used to change the password of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneNone", + "des":"This API is used to change the password of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneChange the administrato", "doc_type":"api", - "kw":"Changing the Password of a Cluster,Cluster Management APIs,API Reference", + "kw":"Changing a Password,Cluster Management APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Changing the Password of a Cluster", + "title":"Changing a Password", "githuburl":"" }, { @@ -349,18 +383,20 @@ "node_id":"css_03_0086.xml", "product_code":"css", "code":"19", - "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}/flavorNoneNone", + "des":"This API is used to modify the specifications of a cluster. Only the specifications of ESS nodes can be modified.You can debug this API in . Automatic authentication is s", "doc_type":"api", - "kw":"Changing Specifications,Cluster Management APIs,API Reference", + "kw":"Modifying Cluster Specifications,Cluster Management APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Changing Specifications", + "title":"Modifying Cluster Specifications", "githuburl":"" }, { @@ -368,7 +404,7 @@ "node_id":"css_03_0087.xml", "product_code":"css", "code":"20", - "des":"This API is used to modify cluster specifications. The following node types can be changed:ess: data nodeess-cold: cold data nodeess-client: client nodeess-master: master", + "des":"This API is used to change the specifications of a specified node type. The following node types are supported:ess: data nodeess-cold: cold data nodeess-client: client no", "doc_type":"api", "kw":"Changing the Specifications of a Specified Node Type,Cluster Management APIs,API Reference", "search_title":"", @@ -376,7 +412,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Changing the Specifications of a Specified Node Type", @@ -395,7 +433,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Scaling Out a Cluster with only Common Nodes", @@ -414,7 +454,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Scaling Out a Cluster with Special Nodes", @@ -425,18 +467,20 @@ "node_id":"css_03_0088.xml", "product_code":"css", "code":"23", - "des":"This API is used to scale in a cluster by removing a specified node.POST /v1.0/{project_id}/clusters/{cluster_id}/node/offlineNoneNone", + "des":"This API is used to scale in a cluster by removing specified nodes. Yearly/Monthly clusters do not support the removal of specified nodes by calling this API.You can debu", "doc_type":"api", - "kw":"Scaling In a Cluster by Removing a Specific Node,Cluster Management APIs,API Reference", + "kw":"Scaling in a Cluster By Removing Specified Nodes,Cluster Management APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Scaling In a Cluster by Removing a Specific Node", + "title":"Scaling in a Cluster By Removing Specified Nodes", "githuburl":"" }, { @@ -444,23 +488,25 @@ "node_id":"css_03_0089.xml", "product_code":"css", "code":"24", - "des":"This API is used to remove instances of different types and reduce instance storage capacity in a cluster.POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink", + "des":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster.You can debug this API in . Automatic authentication is supported", "doc_type":"api", - "kw":"Scaling In Nodes of a Specific Type,Cluster Management APIs,API Reference", + "kw":"Removing Nodes of a Specific Type,Cluster Management APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Scaling In Nodes of a Specific Type", + "title":"Removing Nodes of a Specific Type", "githuburl":"" }, { - "uri":"css_03_0023.html", - "node_id":"css_03_0023.xml", + "uri":"ListFlavors.html", + "node_id":"listflavors.xml", "product_code":"css", "code":"25", "des":"This API is used to query and display the IDs of supported instance flavors.NoneTable 2 describes the response parameters.Example requestGET /v1.0/6204a5bd270343b5885144c", @@ -471,7 +517,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Obtaining the List of Instance Flavors", @@ -482,18 +530,20 @@ "node_id":"css_03_0050.xml", "product_code":"css", "code":"26", - "des":"This API is used to download the HTTPS certificate file of the server.NoneExample requestExample responseAfter obtaining the preceding character string, run the following", + "des":"This API is used to download the HTTPS certificate of the server.NoneExample requestExample responseAfter obtaining the preceding character string, run the following comm", "doc_type":"api", - "kw":"Downloading a Certificate File,Cluster Management APIs,API Reference", + "kw":"Downloading the Certificate,Cluster Management APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Downloading a Certificate File", + "title":"Downloading the Certificate", "githuburl":"" }, { @@ -509,7 +559,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Tag Management APIs", @@ -528,7 +580,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Querying Tags of a Specified Cluster", @@ -547,7 +601,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Querying All Tags", @@ -566,7 +622,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Adding Tags to a Cluster", @@ -585,7 +643,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Adding or Deleting Cluster Tags in Batches", @@ -604,7 +664,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Deleting Specified Cluster Tags", @@ -615,7 +677,7 @@ "node_id":"css_03_0090.xml", "product_code":"css", "code":"33", - "des":"This API is used to replace a failed node.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replaceNoneNoneNone", + "des":"This API is used to replace a failed node.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instanc", "doc_type":"api", "kw":"Replacing a Node,Cluster Management APIs,API Reference", "search_title":"", @@ -623,7 +685,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Replacing a Node", @@ -634,18 +698,20 @@ "node_id":"css_03_0091.xml", "product_code":"css", "code":"34", - "des":"This API is used to configure the security mode of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/mode/changeNoneNone", + "des":"This API is used to change the security mode of a cluster.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/", "doc_type":"api", - "kw":"Configuring the Security Mode.,Cluster Management APIs,API Reference", + "kw":"Changing the Security Mode,Cluster Management APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Configuring the Security Mode.", + "title":"Changing the Security Mode", "githuburl":"" }, { @@ -653,7 +719,7 @@ "node_id":"css_03_0092.xml", "product_code":"css", "code":"35", - "des":"This API is used to change the security group after a cluster is created.POST /v1.0/{project_id}/clusters/{cluster_id}/sg/changeNoneNone", + "des":"This API is used to change the security group after a cluster is created.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/cluster", "doc_type":"api", "kw":"Changing the Security Group,Cluster Management APIs,API Reference", "search_title":"", @@ -661,17 +727,124 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Changing the Security Group", "githuburl":"" }, + { + "uri":"UpgradeCore.html", + "node_id":"upgradecore.xml", + "product_code":"css", + "code":"36", + "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 APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Upgrading a Cluster Kernel", + "githuburl":"" + }, + { + "uri":"ListImages.html", + "node_id":"listimages.xml", + "product_code":"css", + "code":"37", + "des":"This API is used to obtain the ID of an image that can be upgraded in the current cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/targe", + "doc_type":"api", + "kw":"Obtaining a Target Image ID,Cluster Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Obtaining a Target Image ID", + "githuburl":"" + }, + { + "uri":"UpgradeDetail.html", + "node_id":"upgradedetail.xml", + "product_code":"css", + "code":"38", + "des":"The upgrade takes a long time. You can call this API to check the upgrade progress on a node.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/up", + "doc_type":"api", + "kw":"Obtaining Upgrade Details,Cluster Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Obtaining Upgrade Details", + "githuburl":"" + }, + { + "uri":"RetryUpgradeTask.html", + "node_id":"retryupgradetask.xml", + "product_code":"css", + "code":"39", + "des":"The upgrade takes a long time and the upgrade may fail due to network problems. You can use this API to retry a task or terminate the impact of a task.For details, see Ca", + "doc_type":"api", + "kw":"Retrying a Failed Upgrade Task,Cluster Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Retrying a Failed Upgrade Task", + "githuburl":"" + }, + { + "uri":"AddIndependentNode.html", + "node_id":"addindependentnode.xml", + "product_code":"css", + "code":"40", + "des":"This API is used to add master and client nodes to a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independentStatus cod", + "doc_type":"api", + "kw":"Adding Master and Client Nodes,Cluster Management APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Adding Master and Client Nodes", + "githuburl":"" + }, { "uri":"css_03_0119.html", "node_id":"css_03_0119.xml", "product_code":"css", - "code":"36", + "code":"41", "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", @@ -680,7 +853,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Kibana Public Network Access", @@ -690,8 +865,8 @@ "uri":"css_03_0120.html", "node_id":"css_03_0120.xml", "product_code":"css", - "code":"37", - "des":"This API is used to enable public network access to Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openNoneNone", + "code":"42", + "des":"This API is used to enable Kibana public network access.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/pu", "doc_type":"api", "kw":"Enabling Kibana Public Access,Kibana Public Network Access,API Reference", "search_title":"", @@ -699,7 +874,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Enabling Kibana Public Access", @@ -709,8 +886,8 @@ "uri":"css_03_0121.html", "node_id":"css_03_0121.xml", "product_code":"css", - "code":"38", - "des":"This API is used to disable public network access to Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/closeNoneNone", + "code":"43", + "des":"This API is used to disable Kibana public network access.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/pu", "doc_type":"api", "kw":"Disabling Kibana Public Access,Kibana Public Network Access,API Reference", "search_title":"", @@ -718,7 +895,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Disabling Kibana Public Access", @@ -728,8 +907,8 @@ "uri":"css_03_0122.html", "node_id":"css_03_0122.xml", "product_code":"css", - "code":"39", - "des":"This API is used to modify the public network bandwidth of Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthNoneNone", + "code":"44", + "des":"This API is used to modify the Kibana public network bandwidth.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster", "doc_type":"api", "kw":"Modifying the Kibana Public Network Bandwidth,Kibana Public Network Access,API Reference", "search_title":"", @@ -737,7 +916,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Modifying the Kibana Public Network Bandwidth", @@ -747,8 +928,8 @@ "uri":"css_03_0123.html", "node_id":"css_03_0123.xml", "product_code":"css", - "code":"40", - "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":"45", + "des":"This API is used to modify the Kibana public network access whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{", "doc_type":"api", "kw":"Modifying Kibana Public Access Control,Kibana Public Network Access,API Reference", "search_title":"", @@ -756,7 +937,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Modifying Kibana Public Access Control", @@ -766,8 +949,8 @@ "uri":"css_03_0124.html", "node_id":"css_03_0124.xml", "product_code":"css", - "code":"41", - "des":"This API is used to disable public network access control for Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/closeNoneNoneNoneNone", + "code":"46", + "des":"This API is used to disable the Kibana public network access control.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cl", "doc_type":"api", "kw":"Disabling Kibana Public Network Access Control,Kibana Public Network Access,API Reference", "search_title":"", @@ -775,7 +958,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Disabling Kibana Public Network Access Control", @@ -785,7 +970,7 @@ "uri":"css_03_0093.html", "node_id":"css_03_0093.xml", "product_code":"css", - "code":"42", + "code":"47", "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", @@ -794,7 +979,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Log Management", @@ -804,8 +991,8 @@ "uri":"css_03_0094.html", "node_id":"css_03_0094.xml", "product_code":"css", - "code":"43", - "des":"This API is used to enable the log function.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneNone", + "code":"48", + "des":"This API is used to enable the log function.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneN", "doc_type":"api", "kw":"Enabling the Log Function,Log Management,API Reference", "search_title":"", @@ -813,7 +1000,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Enabling the Log Function", @@ -823,8 +1012,8 @@ "uri":"css_03_0095.html", "node_id":"css_03_0095.xml", "product_code":"css", - "code":"44", - "des":"This API is used to disable the log function.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNoneNoneNoneNone", + "code":"49", + "des":"This API is used to disable the log function.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNone", "doc_type":"api", "kw":"Disabling the Log Function,Log Management,API Reference", "search_title":"", @@ -832,7 +1021,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Disabling the Log Function", @@ -842,27 +1033,29 @@ "uri":"css_03_0096.html", "node_id":"css_03_0096.xml", "product_code":"css", - "code":"45", - "des":"This API is used to query the job list in the logs of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/recordsNoneStatus code: 200NoneStatus code: 200Request s", + "code":"50", + "des":"This API is used to query the job list in the logs of a cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster", "doc_type":"api", - "kw":"Querying the Job List,Log Management,API Reference", + "kw":"Viewing the Job List,Log Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Querying the Job List", + "title":"Viewing the Job List", "githuburl":"" }, { "uri":"css_03_0097.html", "node_id":"css_03_0097.xml", "product_code":"css", - "code":"46", - "des":"This API is used to query basic log configurations.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneStatus code: 200NoneStatus code: 200Request succeeded.", + "code":"51", + "des":"This API is used to query basic log configurations.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/set", "doc_type":"api", "kw":"Querying Basic Log Configurations,Log Management,API Reference", "search_title":"", @@ -870,7 +1063,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Querying Basic Log Configurations", @@ -880,8 +1075,8 @@ "uri":"css_03_0098.html", "node_id":"css_03_0098.xml", "product_code":"css", - "code":"47", - "des":"This API is used to modify basic log configurations.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneNone", + "code":"52", + "des":"This API is used to modify basic log configurations.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/s", "doc_type":"api", "kw":"Modifying Basic Log Configurations,Log Management,API Reference", "search_title":"", @@ -889,7 +1084,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Modifying Basic Log Configurations", @@ -899,8 +1096,8 @@ "uri":"css_03_0099.html", "node_id":"css_03_0099.xml", "product_code":"css", - "code":"48", - "des":"This API is used to enable the automatic log backup policy.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/updateNoneNone", + "code":"53", + "des":"This API is used to enable the automatic log backup policy.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}", "doc_type":"api", "kw":"Enabling the Automatic Log Backup Policy,Log Management,API Reference", "search_title":"", @@ -908,7 +1105,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Enabling the Automatic Log Backup Policy", @@ -918,8 +1117,8 @@ "uri":"css_03_0100.html", "node_id":"css_03_0100.xml", "product_code":"css", - "code":"49", - "des":"This API is used to disable the automatic log backup policy.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/closeNoneNoneNoneNone", + "code":"54", + "des":"This API is used to disable the automatic log backup policy.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}", "doc_type":"api", "kw":"Disabling the Automatic Log Backup Policy,Log Management,API Reference", "search_title":"", @@ -927,7 +1126,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Disabling the Automatic Log Backup Policy", @@ -937,8 +1138,8 @@ "uri":"css_03_0101.html", "node_id":"css_03_0101.xml", "product_code":"css", - "code":"50", - "des":"This API is used to back up logs.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneNone", + "code":"55", + "des":"This API is used to back up logs.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneN", "doc_type":"api", "kw":"Backing Up Logs,Log Management,API Reference", "search_title":"", @@ -946,7 +1147,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Backing Up Logs", @@ -956,26 +1159,28 @@ "uri":"css_03_0102.html", "node_id":"css_03_0102.xml", "product_code":"css", - "code":"51", - "des":"This API is used to query log information.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatus code: 200Status code: 200Request succeeded.", + "code":"56", + "des":"This API is used to query log information.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatu", "doc_type":"api", - "kw":"Searching for Logs,Log Management,API Reference", + "kw":"Querying Logs,Log Management,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Searching for Logs", + "title":"Querying Logs", "githuburl":"" }, { "uri":"css_03_0103.html", "node_id":"css_03_0103.xml", "product_code":"css", - "code":"52", + "code":"57", "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", @@ -984,7 +1189,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Public Network Access", @@ -994,8 +1201,8 @@ "uri":"css_03_0104.html", "node_id":"css_03_0104.xml", "product_code":"css", - "code":"53", - "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.", + "code":"58", + "des":"This API is used to enable public network access.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/public/op", "doc_type":"api", "kw":"Enabling Public Network Access,Public Network Access,API Reference", "search_title":"", @@ -1003,7 +1210,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Enabling Public Network Access", @@ -1013,8 +1222,8 @@ "uri":"css_03_0105.html", "node_id":"css_03_0105.xml", "product_code":"css", - "code":"54", - "des":"This API is used to disable public network access to Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/closeStatus code: 200Status code: 200Request succeeded.", + "code":"59", + "des":"This API is used to disable public network access.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/cl", "doc_type":"api", "kw":"Disabling Public Network Access,Public Network Access,API Reference", "search_title":"", @@ -1022,7 +1231,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Disabling Public Network Access", @@ -1032,8 +1243,8 @@ "uri":"css_03_0106.html", "node_id":"css_03_0106.xml", "product_code":"css", - "code":"55", - "des":"This API is used to modify the public network access bandwidth.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthNoneNone", + "code":"60", + "des":"This API is used to modify the public network access bandwidth.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster", "doc_type":"api", "kw":"Modifying Public Network Access Bandwidth,Public Network Access,API Reference", "search_title":"", @@ -1041,7 +1252,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Modifying Public Network Access Bandwidth", @@ -1051,45 +1264,49 @@ "uri":"css_03_0107.html", "node_id":"css_03_0107.xml", "product_code":"css", - "code":"56", - "des":"This API is used to enable the public network access control whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/updateNoneNone", + "code":"61", + "des":"This API is used to enable the public network access whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster", "doc_type":"api", - "kw":"Enabling the Public Network Access Control Whitelist,Public Network Access,API Reference", + "kw":"Enabling the Public Network Access Whitelist,Public Network Access,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Enabling the Public Network Access Control Whitelist", + "title":"Enabling the Public Network Access Whitelist", "githuburl":"" }, { "uri":"css_03_0108.html", "node_id":"css_03_0108.xml", "product_code":"css", - "code":"57", - "des":"This API is used to disable the public network access control whitelist.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeNoneNoneNoneNone", + "code":"62", + "des":"This API is used to disable the public network access whitelist.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster", "doc_type":"api", - "kw":"Disabling the Public Network Access Control Whitelist,Public Network Access,API Reference", + "kw":"Disabling the Public Network Access Whitelist,Public Network Access,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Disabling the Public Network Access Control Whitelist", + "title":"Disabling the Public Network Access Whitelist", "githuburl":"" }, { "uri":"css_03_0010.html", "node_id":"css_03_0010.xml", "product_code":"css", - "code":"58", + "code":"63", "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 APIs", @@ -1098,7 +1315,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Snapshot Management APIs", @@ -1108,8 +1327,8 @@ "uri":"css_03_0037.html", "node_id":"css_03_0037.xml", "product_code":"css", - "code":"59", - "des":"The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapthos. If you have multiple clusters, an OBS buc", + "code":"64", + "des":"The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapshots. If you have multiple clusters, an OBS bu", "doc_type":"api", "kw":"(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot,Snapshot Management", "search_title":"", @@ -1117,7 +1336,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot", @@ -1127,7 +1348,7 @@ "uri":"css_03_0030.html", "node_id":"css_03_0030.xml", "product_code":"css", - "code":"60", + "code":"65", "des":"Using this API will automatically enable the snapshot function.This API is used to modify the basic configurations of a cluster snapshot. The basic configurations include", "doc_type":"api", "kw":"Modifying Basic Configurations of a Cluster Snapshot,Snapshot Management APIs,API Reference", @@ -1146,7 +1367,7 @@ "uri":"css_03_0031.html", "node_id":"css_03_0031.xml", "product_code":"css", - "code":"61", + "code":"66", "des":"This API is used to set parameters related to automatic snapshot creation. By default, a snapshot is created per day.Table 2 describes the request parameters.NoneExample ", "doc_type":"api", "kw":"Setting the Automatic Snapshot Creation Policy,Snapshot Management APIs,API Reference", @@ -1155,7 +1376,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Setting the Automatic Snapshot Creation Policy", @@ -1165,7 +1388,7 @@ "uri":"css_03_0032.html", "node_id":"css_03_0032.xml", "product_code":"css", - "code":"62", + "code":"67", "des":"This API is used to query the automatic snapshot creation policy for a cluster.NoneTable 2 describes the response parameters.Example requestExample responseTable 3 descri", "doc_type":"api", "kw":"Querying the Automatic Snapshot Creation Policy for a Cluster,Snapshot Management APIs,API Reference", @@ -1174,7 +1397,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Querying the Automatic Snapshot Creation Policy for a Cluster", @@ -1184,7 +1409,7 @@ "uri":"css_03_0033.html", "node_id":"css_03_0033.xml", "product_code":"css", - "code":"63", + "code":"68", "des":"This API is used to manually create a snapshot.Table 2 describes the request parameters.Table 3 describes the response parameters.Example requestExample responseTable 5 d", "doc_type":"api", "kw":"Manually Creating a Snapshot,Snapshot Management APIs,API Reference", @@ -1193,7 +1418,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Manually Creating a Snapshot", @@ -1203,7 +1430,7 @@ "uri":"css_03_0034.html", "node_id":"css_03_0034.xml", "product_code":"css", - "code":"64", + "code":"69", "des":"This API is used to query all snapshots of a cluster.NoneExample requestExample responseTable 5 describes the status code.", "doc_type":"api", "kw":"Querying the List of Snapshots,Snapshot Management APIs,API Reference", @@ -1212,7 +1439,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Querying the List of Snapshots", @@ -1222,7 +1451,7 @@ "uri":"css_03_0035.html", "node_id":"css_03_0035.xml", "product_code":"css", - "code":"65", + "code":"70", "des":"This API is used to manually restore a snapshot.Table 2 describes the request parameters.NoneExample requestExample responseThe return value is empty.Table 3 describes th", "doc_type":"api", "kw":"Restoring a Snapshot,Snapshot Management APIs,API Reference", @@ -1231,7 +1460,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Restoring a Snapshot", @@ -1241,7 +1472,7 @@ "uri":"css_03_0036.html", "node_id":"css_03_0036.xml", "product_code":"css", - "code":"66", + "code":"71", "des":"This API is used to delete a snapshot.NoneNoneExample requestTable 2 describes the status code.", "doc_type":"api", "kw":"Deleting a Snapshot,Snapshot Management APIs,API Reference", @@ -1250,7 +1481,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Deleting a Snapshot", @@ -1260,7 +1493,7 @@ "uri":"css_03_0039.html", "node_id":"css_03_0039.xml", "product_code":"css", - "code":"67", + "code":"72", "des":"This API is used to disable the snapshot function.NoneNoneExample requestTable 2 describes the status code.", "doc_type":"api", "kw":"Disabling the Snapshot Function,Snapshot Management APIs,API Reference", @@ -1269,7 +1502,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Disabling the Snapshot Function", @@ -1279,7 +1514,7 @@ "uri":"css_03_0109.html", "node_id":"css_03_0109.xml", "product_code":"css", - "code":"68", + "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":"VPC Endpoint", @@ -1288,7 +1523,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"VPC Endpoint", @@ -1298,8 +1535,8 @@ "uri":"css_03_0110.html", "node_id":"css_03_0110.xml", "product_code":"css", - "code":"69", - "des":"This API is used to enable the VPC endpoint service.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200Status code: 200Request succeeded.", + "code":"74", + "des":"This API is used to enable the VPC endpoint service.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/vpceps", "doc_type":"api", "kw":"Enabling the VPC Endpoint Service,VPC Endpoint,API Reference", "search_title":"", @@ -1307,7 +1544,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Enabling the VPC Endpoint Service", @@ -1317,8 +1556,8 @@ "uri":"css_03_0111.html", "node_id":"css_03_0111.xml", "product_code":"css", - "code":"70", - "des":"This API is used to disable the VPC endpoint service.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: 200NoneStatus code: 200Request succee", + "code":"75", + "des":"This API is used to disable the VPC endpoint service.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpceps", "doc_type":"api", "kw":"Disabling the VPC Endpoint Service,VPC Endpoint,API Reference", "search_title":"", @@ -1326,7 +1565,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Disabling the VPC Endpoint Service", @@ -1336,46 +1577,50 @@ "uri":"css_03_0112.html", "node_id":"css_03_0112.xml", "product_code":"css", - "code":"71", - "des":"This API is used to obtain a VPC endpoint connection.GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneStatus code: 200NoneStatus code: 200Request ", + "code":"76", + "des":"This API is used to obtain a VPC endpoint connection.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_id}/vpceps", "doc_type":"api", - "kw":"Obtaining an Endpoint Connection,VPC Endpoint,API Reference", + "kw":"Obtaining a VPC Endpoint Connection,VPC Endpoint,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Obtaining an Endpoint Connection", + "title":"Obtaining a VPC Endpoint Connection", "githuburl":"" }, { "uri":"css_03_0113.html", "node_id":"css_03_0113.xml", "product_code":"css", - "code":"72", - "des":"This API is used to update an endpoint connection.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneNone", + "code":"77", + "des":"This API is used to update a VPC endpoint connection.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcep", "doc_type":"api", - "kw":"Updating an Endpoint Connection,VPC Endpoint,API Reference", + "kw":"Updating a VPC Endpoint Connection,VPC Endpoint,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Updating an Endpoint Connection", + "title":"Updating a VPC Endpoint Connection", "githuburl":"" }, { "uri":"css_03_0114.html", "node_id":"css_03_0114.xml", "product_code":"css", - "code":"73", - "des":"This API is used to modify the endpoint service whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsNoneNone", + "code":"78", + "des":"This API is used to modify the endpoint service whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/", "doc_type":"api", "kw":"Modifying the Endpoint Service Whitelist,VPC Endpoint,API Reference", "search_title":"", @@ -1383,7 +1628,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Modifying the Endpoint Service Whitelist", @@ -1393,7 +1640,7 @@ "uri":"css_03_0115.html", "node_id":"css_03_0115.xml", "product_code":"css", - "code":"74", + "code":"79", "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", @@ -1402,7 +1649,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Parameter Configuration", @@ -1412,27 +1661,29 @@ "uri":"css_03_0116.html", "node_id":"css_03_0116.xml", "product_code":"css", - "code":"75", - "des":"This API is used to modify the parameter settings of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/updateStatus code: 200Status code: 200Request succeeded.", + "code":"80", + "des":"This API is used to modify parameter configurations.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/u", "doc_type":"api", - "kw":"Modifying Cluster Parameters,Parameter Configuration,API Reference", + "kw":"Modifying Parameter Configurations,Parameter Configuration,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Modifying Cluster Parameters", + "title":"Modifying Parameter Configurations", "githuburl":"" }, { "uri":"css_03_0117.html", "node_id":"css_03_0117.xml", "product_code":"css", - "code":"76", - "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: 200NoneStatus cod", + "code":"81", + "des":"This API is used to obtain the task list of parameter configurations.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cl", "doc_type":"api", "kw":"Obtaining the Task List of Parameter Configurations,Parameter Configuration,API Reference", "search_title":"", @@ -1440,7 +1691,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Obtaining the Task List of Parameter Configurations", @@ -1450,8 +1703,8 @@ "uri":"css_03_0118.html", "node_id":"css_03_0118.xml", "product_code":"css", - "code":"77", - "des":"This API is used to obtain the parameter configuration list of the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/templateNoneStatus code: 200NoneStatu", + "code":"82", + "des":"This API is used to obtain the parameter configuration list of the current cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id", "doc_type":"api", "kw":"Obtaining the Parameter Configuration List,Parameter Configuration,API Reference", "search_title":"", @@ -1459,7 +1712,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Obtaining the Parameter Configuration List", @@ -1469,7 +1724,7 @@ "uri":"css_03_0125.html", "node_id":"css_03_0125.xml", "product_code":"css", - "code":"78", + "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":"Load Balancing", @@ -1478,7 +1733,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Load Balancing", @@ -1488,27 +1745,29 @@ "uri":"css_03_0126.html", "node_id":"css_03_0126.xml", "product_code":"css", - "code":"79", - "des":"This API is used to query the ELBv3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200NoneStatus code: 2", + "code":"84", + "des":"This API is used to query the ELB V3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200NoneStatus code: ", "doc_type":"api", - "kw":"Querying ELBv3 Load Balancers Supported by a Cluster,Load Balancing,API Reference", + "kw":"Querying ELB V3 Load Balancer Supported by a Cluster,Load Balancing,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Querying ELBv3 Load Balancers Supported by a Cluster", + "title":"Querying ELB V3 Load Balancer Supported by a Cluster", "githuburl":"" }, { "uri":"css_03_0127.html", "node_id":"css_03_0127.xml", "product_code":"css", - "code":"80", - "des":"This API is used to enable or disable the Elasticsearch load balancer.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load", + "code":"85", + "des":"This API is used to enable or disable the ES load balancer.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load balancer.N", "doc_type":"api", "kw":"Enabling or Disabling the ES Load Balancer,Load Balancing,API Reference", "search_title":"", @@ -1516,7 +1775,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Enabling or Disabling the ES Load Balancer", @@ -1526,46 +1787,50 @@ "uri":"css_03_0128.html", "node_id":"css_03_0128.xml", "product_code":"css", - "code":"81", - "des":"This API is used to configure the Elasticsearch listener.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200Request succeeded.See E", + "code":"86", + "des":"This API is used to configure the ES listener.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200The request is processed.See Error", "doc_type":"api", - "kw":"Configuring ES Listener,Load Balancing,API Reference", + "kw":"Configuring the ES Listener,Load Balancing,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Configuring ES Listener", + "title":"Configuring the ES Listener", "githuburl":"" }, { "uri":"css_03_0129.html", "node_id":"css_03_0129.xml", "product_code":"css", - "code":"82", - "des":"This API is used to obtain the ES ELB information and display the health check status on the page.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus code", + "code":"87", + "des":"This API is used to obtain the ES ELB information and health check status.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus code: 200NoneStatus code: 20", "doc_type":"api", - "kw":"Obtaining the ES ELB Information and Displaying the Health Check Status,Load Balancing,API Reference", + "kw":"Obtaining the ELB Information and Health Check Status,Load Balancing,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], - "title":"Obtaining the ES ELB Information and Displaying the Health Check Status", + "title":"Obtaining the ELB Information and Health Check Status", "githuburl":"" }, { "uri":"css_03_0130.html", "node_id":"css_03_0130.xml", "product_code":"css", - "code":"83", - "des":"This API is used to update an Elasticsearch listener.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200NoneSee Error Codes.", + "code":"88", + "des":"This API is used to update an ES listener.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200NoneSee Error Codes.", "doc_type":"api", "kw":"Updating an ES Listener,Load Balancing,API Reference", "search_title":"", @@ -1573,7 +1838,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Updating an ES Listener", @@ -1583,8 +1850,8 @@ "uri":"css_03_0131.html", "node_id":"css_03_0131.xml", "product_code":"css", - "code":"84", - "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":"89", + "des":"This API is used to query the certificate list.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200NoneStatus code: 200The request is process", "doc_type":"api", "kw":"Querying the Certificate List,Load Balancing,API Reference", "search_title":"", @@ -1592,18 +1859,125 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Querying the Certificate List", "githuburl":"" }, + { + "uri":"css_03_0132.html", + "node_id":"css_03_0132.xml", + "product_code":"css", + "code":"90", + "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":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Intelligent O&M", + "githuburl":"" + }, + { + "uri":"css_03_0133.html", + "node_id":"css_03_0133.xml", + "product_code":"css", + "code":"91", + "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.NoneFor details, see Error Cod", + "doc_type":"api", + "kw":"Creating a Cluster Detection Task,Intelligent O&M,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Creating a Cluster Detection Task", + "githuburl":"" + }, + { + "uri":"css_03_0134.html", + "node_id":"css_03_0134.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: 200Obtain the intelligent O&M tas", + "doc_type":"api", + "kw":"Obtaining the Intelligent O&M Task List and Details,Intelligent O&M,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Obtaining the Intelligent O&M Task List and Details", + "githuburl":"" + }, + { + "uri":"css_03_0135.html", + "node_id":"css_03_0135.xml", + "product_code":"css", + "code":"93", + "des":"This API is used to delete a detection task record.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneNoneDelete a detection task record.NoneFor details", + "doc_type":"api", + "kw":"Deleting a Detection Task Record,Intelligent O&M,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Deleting a Detection Task Record", + "githuburl":"" + }, + { + "uri":"css_03_0136.html", + "node_id":"css_03_0136.xml", + "product_code":"css", + "code":"94", + "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", + "doc_type":"api", + "kw":"Obtaining SMN Topics Available for Intelligent O&M Alarms,Intelligent O&M,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"css", + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" + } + ], + "title":"Obtaining SMN Topics Available for Intelligent O&M Alarms", + "githuburl":"" + }, { "uri":"css_03_0065.html", "node_id":"css_03_0065.xml", "product_code":"css", - "code":"85", - "des":"This section describes fine-grained permissions management for your CSS. If your account does not need individual IAM users, then you may skip over this chapter.By defaul", + "code":"95", + "des":"This section describes fine-grained permissions management for your CSS. If your cloud account does not need individual IAM users, then you may skip over this chapter.By ", "doc_type":"api", "kw":"Permissions Policies and Supported Actions,API Reference", "search_title":"", @@ -1611,7 +1985,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Permissions Policies and Supported Actions", @@ -1621,7 +1997,7 @@ "uri":"css_03_0040.html", "node_id":"css_03_0040.xml", "product_code":"css", - "code":"86", + "code":"96", "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":"Common Parameters", @@ -1630,7 +2006,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Common Parameters", @@ -1640,7 +2018,7 @@ "uri":"css_03_0071.html", "node_id":"css_03_0071.xml", "product_code":"css", - "code":"87", + "code":"97", "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", "doc_type":"api", "kw":"Obtaining a Project ID and Name,Common Parameters,API Reference", @@ -1649,7 +2027,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Obtaining a Project ID and Name", @@ -1659,7 +2039,7 @@ "uri":"css_03_0075.html", "node_id":"css_03_0075.xml", "product_code":"css", - "code":"88", + "code":"98", "des":"Table 1 describes the status code.", "doc_type":"api", "kw":"Status Code,Common Parameters,API Reference", @@ -1668,7 +2048,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Status Code", @@ -1678,7 +2060,7 @@ "uri":"css_03_0076.html", "node_id":"css_03_0076.xml", "product_code":"css", - "code":"89", + "code":"99", "des":"No data is returned if an API fails to be invoked. You can locate the cause of an error according to the error code of each API. When the API calling fails, HTTPS status ", "doc_type":"api", "kw":"Error Code,Common Parameters,API Reference", @@ -1687,7 +2069,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Error Code", @@ -1697,7 +2081,7 @@ "uri":"css_03_0024.html", "node_id":"css_03_0024.xml", "product_code":"css", - "code":"90", + "code":"100", "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", @@ -1706,7 +2090,9 @@ { "documenttype":"api", "prodname":"css", - "opensource":"true" + "opensource":"true", + "operation_id":"AddIndependentNode", + "version":"v1" } ], "title":"Change History", diff --git a/docs/css/api-ref/AddIndependentNode.html b/docs/css/api-ref/AddIndependentNode.html new file mode 100644 index 00000000..7d78ee4f --- /dev/null +++ b/docs/css/api-ref/AddIndependentNode.html @@ -0,0 +1,190 @@ + + +

Adding Master and Client Nodes

+

Function

This API is used to add master and client nodes to a cluster.

+
+

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

+

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

+

cluster_id

+

Yes

+

String

+

ID of the cluster that needs an independent master or client.

+

type

+

Yes

+

String

+

Node type. The value can be:

+
  • ess-master: Master node
  • ess-client: Client node
+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

IndependentBodyReq object

+

Master/Client request body parameter

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 IndependentBodyReq

Parameter

+

Mandatory

+

Type

+

Description

+

flavor_ref

+

Yes

+

String

+

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

+

node_size

+

Yes

+

Integer

+

Number of nodes.

+
  • 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.
+

volume_type

+

Yes

+

String

+

Node storage type. Its value can be ULTRAHIGH, COMMON, or HIGH.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Cluster ID.

+
+
+
+

Request Example

Add the master and client nodes.

+
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent
+
+{
+  "type" : {
+    "flavor_ref" : "d9dc06ae-b9c4-4ef4-acd8-953ef4205e27",
+    "node_size" : 3,
+    "volume_type" : "COMMON"
+  }
+}
+
+

Response Example

Status code: 200

+

The request is processed.

+
{
+  "id" : "320afa24-ff2a-4f44-8460-6ba95e512ad4"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The request is processed.

+

403

+

The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it.

+

500

+

The server can be accessed by the request, but it cannot understand the user's request.

+
+
+
+

Error Codes

For details, see Error Code.

+
+
+
+ +
+ diff --git a/docs/css/api-ref/CLASS.TXT.json b/docs/css/api-ref/CLASS.TXT.json index e368c76a..80b2c5f4 100644 --- a/docs/css/api-ref/CLASS.TXT.json +++ b/docs/css/api-ref/CLASS.TXT.json @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"In CSS, Elasticsearch 7.6.2, 7.9.3, 7.10.2 and Opensearch_1.3.6 and Kibana 7.6.2, 7.9.3, 7.10.2 and Opensearch_1.3.6 are supported.", + "desc":"In CSS, Elasticsearch 7.6.2, 7.9.3, and 7.10.2 are supported. OpenSearch 1.3.6 and 2.11.0 are supported. Kibana 7.6.2, 7.9.3, and 7.10.2 are supported.", "product_code":"css", "title":"Supported Cluster Versions", "uri":"css_03_0056.html", @@ -117,18 +117,18 @@ "code":"13" }, { - "desc":"This API is used to query and display the details of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200NoneStatus code: 200Request succeeded.", + "desc":"This API is used to query and display details about a cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_i", "product_code":"css", "title":"Querying Cluster Details", - "uri":"css_03_0026.html", + "uri":"ShowClusterDetail.html", "doc_type":"api", "p_code":"11", "code":"14" }, { - "desc":"This API is used to change the password of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneNone", + "desc":"This API is used to change the name of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameNoneNone", "product_code":"css", - "title":"Renaming a Cluster", + "title":"Changing a Cluster Name", "uri":"css_03_0084.html", "doc_type":"api", "p_code":"11", @@ -153,25 +153,25 @@ "code":"17" }, { - "desc":"This API is used to change the password of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneNone", + "desc":"This API is used to change the password of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneChange the administrato", "product_code":"css", - "title":"Changing the Password of a Cluster", - "uri":"css_03_0085.html", + "title":"Changing a Password", + "uri":"ResetPassword.html", "doc_type":"api", "p_code":"11", "code":"18" }, { - "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}/flavorNoneNone", + "desc":"This API is used to modify the specifications of a cluster. Only the specifications of ESS nodes can be modified.You can debug this API in . Automatic authentication is s", "product_code":"css", - "title":"Changing Specifications", + "title":"Modifying Cluster Specifications", "uri":"css_03_0086.html", "doc_type":"api", "p_code":"11", "code":"19" }, { - "desc":"This API is used to modify cluster specifications. The following node types can be changed:ess: data nodeess-cold: cold data nodeess-client: client nodeess-master: master", + "desc":"This API is used to change the specifications of a specified node type. The following node types are supported:ess: data nodeess-cold: cold data nodeess-client: client no", "product_code":"css", "title":"Changing the Specifications of a Specified Node Type", "uri":"css_03_0087.html", @@ -198,18 +198,18 @@ "code":"22" }, { - "desc":"This API is used to scale in a cluster by removing a specified node.POST /v1.0/{project_id}/clusters/{cluster_id}/node/offlineNoneNone", + "desc":"This API is used to scale in a cluster by removing specified nodes. Yearly/Monthly clusters do not support the removal of specified nodes by calling this API.You can debu", "product_code":"css", - "title":"Scaling In a Cluster by Removing a Specific Node", + "title":"Scaling in a Cluster By Removing Specified Nodes", "uri":"css_03_0088.html", "doc_type":"api", "p_code":"11", "code":"23" }, { - "desc":"This API is used to remove instances of different types and reduce instance storage capacity in a cluster.POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink", + "desc":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster.You can debug this API in . Automatic authentication is supported", "product_code":"css", - "title":"Scaling In Nodes of a Specific Type", + "title":"Removing Nodes of a Specific Type", "uri":"css_03_0089.html", "doc_type":"api", "p_code":"11", @@ -219,15 +219,15 @@ "desc":"This API is used to query and display the IDs of supported instance flavors.NoneTable 2 describes the response parameters.Example requestGET /v1.0/6204a5bd270343b5885144c", "product_code":"css", "title":"Obtaining the List of Instance Flavors", - "uri":"css_03_0023.html", + "uri":"ListFlavors.html", "doc_type":"api", "p_code":"11", "code":"25" }, { - "desc":"This API is used to download the HTTPS certificate file of the server.NoneExample requestExample responseAfter obtaining the preceding character string, run the following", + "desc":"This API is used to download the HTTPS certificate of the server.NoneExample requestExample responseAfter obtaining the preceding character string, run the following comm", "product_code":"css", - "title":"Downloading a Certificate File", + "title":"Downloading the Certificate", "uri":"css_03_0050.html", "doc_type":"api", "p_code":"11", @@ -288,7 +288,7 @@ "code":"32" }, { - "desc":"This API is used to replace a failed node.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replaceNoneNoneNone", + "desc":"This API is used to replace a failed node.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instanc", "product_code":"css", "title":"Replacing a Node", "uri":"css_03_0090.html", @@ -297,16 +297,16 @@ "code":"33" }, { - "desc":"This API is used to configure the security mode of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/mode/changeNoneNone", + "desc":"This API is used to change the security mode of a cluster.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/", "product_code":"css", - "title":"Configuring the Security Mode.", + "title":"Changing the Security Mode", "uri":"css_03_0091.html", "doc_type":"api", "p_code":"11", "code":"34" }, { - "desc":"This API is used to change the security group after a cluster is created.POST /v1.0/{project_id}/clusters/{cluster_id}/sg/changeNoneNone", + "desc":"This API is used to change the security group after a cluster is created.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/cluster", "product_code":"css", "title":"Changing the Security Group", "uri":"css_03_0092.html", @@ -314,6 +314,51 @@ "p_code":"11", "code":"35" }, + { + "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":"11", + "code":"36" + }, + { + "desc":"This API is used to obtain the ID of an image that can be upgraded in the current cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/targe", + "product_code":"css", + "title":"Obtaining a Target Image ID", + "uri":"ListImages.html", + "doc_type":"api", + "p_code":"11", + "code":"37" + }, + { + "desc":"The upgrade takes a long time. You can call this API to check the upgrade progress on a node.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/up", + "product_code":"css", + "title":"Obtaining Upgrade Details", + "uri":"UpgradeDetail.html", + "doc_type":"api", + "p_code":"11", + "code":"38" + }, + { + "desc":"The upgrade takes a long time and the upgrade may fail due to network problems. You can use this API to retry a task or terminate the impact of a task.For details, see Ca", + "product_code":"css", + "title":"Retrying a Failed Upgrade Task", + "uri":"RetryUpgradeTask.html", + "doc_type":"api", + "p_code":"11", + "code":"39" + }, + { + "desc":"This API is used to add master and client nodes to a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independentStatus cod", + "product_code":"css", + "title":"Adding Master and Client Nodes", + "uri":"AddIndependentNode.html", + "doc_type":"api", + "p_code":"11", + "code":"40" + }, { "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", @@ -321,52 +366,52 @@ "uri":"css_03_0119.html", "doc_type":"api", "p_code":"", - "code":"36" + "code":"41" }, { - "desc":"This API is used to enable public network access to Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openNoneNone", + "desc":"This API is used to enable Kibana public network access.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/pu", "product_code":"css", "title":"Enabling Kibana Public Access", "uri":"css_03_0120.html", "doc_type":"api", - "p_code":"36", - "code":"37" + "p_code":"41", + "code":"42" }, { - "desc":"This API is used to disable public network access to Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/closeNoneNone", + "desc":"This API is used to disable Kibana public network access.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/pu", "product_code":"css", "title":"Disabling Kibana Public Access", "uri":"css_03_0121.html", "doc_type":"api", - "p_code":"36", - "code":"38" + "p_code":"41", + "code":"43" }, { - "desc":"This API is used to modify the public network bandwidth of Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthNoneNone", + "desc":"This API is used to modify the Kibana public network bandwidth.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster", "product_code":"css", "title":"Modifying the Kibana Public Network Bandwidth", "uri":"css_03_0122.html", "doc_type":"api", - "p_code":"36", - "code":"39" + "p_code":"41", + "code":"44" }, { - "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 public network access whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{", "product_code":"css", "title":"Modifying Kibana Public Access Control", "uri":"css_03_0123.html", "doc_type":"api", - "p_code":"36", - "code":"40" + "p_code":"41", + "code":"45" }, { - "desc":"This API is used to disable public network access control for Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/closeNoneNoneNoneNone", + "desc":"This API is used to disable the Kibana public network access control.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cl", "product_code":"css", "title":"Disabling Kibana Public Network Access Control", "uri":"css_03_0124.html", "doc_type":"api", - "p_code":"36", - "code":"41" + "p_code":"41", + "code":"46" }, { "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.", @@ -375,88 +420,88 @@ "uri":"css_03_0093.html", "doc_type":"api", "p_code":"", - "code":"42" + "code":"47" }, { - "desc":"This API is used to enable the log function.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneNone", + "desc":"This API is used to enable the log function.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneN", "product_code":"css", "title":"Enabling the Log Function", "uri":"css_03_0094.html", "doc_type":"api", - "p_code":"42", - "code":"43" + "p_code":"47", + "code":"48" }, { - "desc":"This API is used to disable the log function.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNoneNoneNoneNone", + "desc":"This API is used to disable the log function.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNone", "product_code":"css", "title":"Disabling the Log Function", "uri":"css_03_0095.html", "doc_type":"api", - "p_code":"42", - "code":"44" + "p_code":"47", + "code":"49" }, { - "desc":"This API is used to query the job list in the logs of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/recordsNoneStatus code: 200NoneStatus code: 200Request s", + "desc":"This API is used to query the job list in the logs of a cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster", "product_code":"css", - "title":"Querying the Job List", + "title":"Viewing the Job List", "uri":"css_03_0096.html", "doc_type":"api", - "p_code":"42", - "code":"45" + "p_code":"47", + "code":"50" }, { - "desc":"This API is used to query basic log configurations.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneStatus code: 200NoneStatus code: 200Request succeeded.", + "desc":"This API is used to query basic log configurations.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/set", "product_code":"css", "title":"Querying Basic Log Configurations", "uri":"css_03_0097.html", "doc_type":"api", - "p_code":"42", - "code":"46" + "p_code":"47", + "code":"51" }, { - "desc":"This API is used to modify basic log configurations.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneNone", + "desc":"This API is used to modify basic log configurations.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/s", "product_code":"css", "title":"Modifying Basic Log Configurations", "uri":"css_03_0098.html", "doc_type":"api", - "p_code":"42", - "code":"47" + "p_code":"47", + "code":"52" }, { - "desc":"This API is used to enable the automatic log backup policy.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/updateNoneNone", + "desc":"This API is used to enable the automatic log backup policy.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}", "product_code":"css", "title":"Enabling the Automatic Log Backup Policy", "uri":"css_03_0099.html", "doc_type":"api", - "p_code":"42", - "code":"48" + "p_code":"47", + "code":"53" }, { - "desc":"This API is used to disable the automatic log backup policy.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/closeNoneNoneNoneNone", + "desc":"This API is used to disable the automatic log backup policy.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}", "product_code":"css", "title":"Disabling the Automatic Log Backup Policy", "uri":"css_03_0100.html", "doc_type":"api", - "p_code":"42", - "code":"49" + "p_code":"47", + "code":"54" }, { - "desc":"This API is used to back up logs.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneNone", + "desc":"This API is used to back up logs.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneN", "product_code":"css", "title":"Backing Up Logs", "uri":"css_03_0101.html", "doc_type":"api", - "p_code":"42", - "code":"50" + "p_code":"47", + "code":"55" }, { - "desc":"This API is used to query log information.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatus code: 200Status code: 200Request succeeded.", + "desc":"This API is used to query log information.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatu", "product_code":"css", - "title":"Searching for Logs", + "title":"Querying Logs", "uri":"css_03_0102.html", "doc_type":"api", - "p_code":"42", - "code":"51" + "p_code":"47", + "code":"56" }, { "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.", @@ -465,52 +510,52 @@ "uri":"css_03_0103.html", "doc_type":"api", "p_code":"", - "code":"52" + "code":"57" }, { - "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.", + "desc":"This API is used to enable public network access.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/public/op", "product_code":"css", "title":"Enabling Public Network Access", "uri":"css_03_0104.html", "doc_type":"api", - "p_code":"52", - "code":"53" + "p_code":"57", + "code":"58" }, { - "desc":"This API is used to disable public network access to Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/closeStatus code: 200Status code: 200Request succeeded.", + "desc":"This API is used to disable public network access.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/cl", "product_code":"css", "title":"Disabling Public Network Access", "uri":"css_03_0105.html", "doc_type":"api", - "p_code":"52", - "code":"54" + "p_code":"57", + "code":"59" }, { - "desc":"This API is used to modify the public network access bandwidth.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthNoneNone", + "desc":"This API is used to modify the public network access bandwidth.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster", "product_code":"css", "title":"Modifying Public Network Access Bandwidth", "uri":"css_03_0106.html", "doc_type":"api", - "p_code":"52", - "code":"55" + "p_code":"57", + "code":"60" }, { - "desc":"This API is used to enable the public network access control whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/updateNoneNone", + "desc":"This API is used to enable the public network access whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster", "product_code":"css", - "title":"Enabling the Public Network Access Control Whitelist", + "title":"Enabling the Public Network Access Whitelist", "uri":"css_03_0107.html", "doc_type":"api", - "p_code":"52", - "code":"56" + "p_code":"57", + "code":"61" }, { - "desc":"This API is used to disable the public network access control whitelist.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeNoneNoneNoneNone", + "desc":"This API is used to disable the public network access whitelist.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster", "product_code":"css", - "title":"Disabling the Public Network Access Control Whitelist", + "title":"Disabling the Public Network Access Whitelist", "uri":"css_03_0108.html", "doc_type":"api", - "p_code":"52", - "code":"57" + "p_code":"57", + "code":"62" }, { "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.", @@ -519,16 +564,16 @@ "uri":"css_03_0010.html", "doc_type":"api", "p_code":"", - "code":"58" + "code":"63" }, { - "desc":"The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapthos. If you have multiple clusters, an OBS buc", + "desc":"The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapshots. If you have multiple clusters, an OBS bu", "product_code":"css", "title":"(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot", "uri":"css_03_0037.html", "doc_type":"api", - "p_code":"58", - "code":"59" + "p_code":"63", + "code":"64" }, { "desc":"Using this API will automatically enable the snapshot function.This API is used to modify the basic configurations of a cluster snapshot. The basic configurations include", @@ -536,8 +581,8 @@ "title":"Modifying Basic Configurations of a Cluster Snapshot", "uri":"css_03_0030.html", "doc_type":"api", - "p_code":"58", - "code":"60" + "p_code":"63", + "code":"65" }, { "desc":"This API is used to set parameters related to automatic snapshot creation. By default, a snapshot is created per day.Table 2 describes the request parameters.NoneExample ", @@ -545,8 +590,8 @@ "title":"Setting the Automatic Snapshot Creation Policy", "uri":"css_03_0031.html", "doc_type":"api", - "p_code":"58", - "code":"61" + "p_code":"63", + "code":"66" }, { "desc":"This API is used to query the automatic snapshot creation policy for a cluster.NoneTable 2 describes the response parameters.Example requestExample responseTable 3 descri", @@ -554,8 +599,8 @@ "title":"Querying the Automatic Snapshot Creation Policy for a Cluster", "uri":"css_03_0032.html", "doc_type":"api", - "p_code":"58", - "code":"62" + "p_code":"63", + "code":"67" }, { "desc":"This API is used to manually create a snapshot.Table 2 describes the request parameters.Table 3 describes the response parameters.Example requestExample responseTable 5 d", @@ -563,8 +608,8 @@ "title":"Manually Creating a Snapshot", "uri":"css_03_0033.html", "doc_type":"api", - "p_code":"58", - "code":"63" + "p_code":"63", + "code":"68" }, { "desc":"This API is used to query all snapshots of a cluster.NoneExample requestExample responseTable 5 describes the status code.", @@ -572,8 +617,8 @@ "title":"Querying the List of Snapshots", "uri":"css_03_0034.html", "doc_type":"api", - "p_code":"58", - "code":"64" + "p_code":"63", + "code":"69" }, { "desc":"This API is used to manually restore a snapshot.Table 2 describes the request parameters.NoneExample requestExample responseThe return value is empty.Table 3 describes th", @@ -581,8 +626,8 @@ "title":"Restoring a Snapshot", "uri":"css_03_0035.html", "doc_type":"api", - "p_code":"58", - "code":"65" + "p_code":"63", + "code":"70" }, { "desc":"This API is used to delete a snapshot.NoneNoneExample requestTable 2 describes the status code.", @@ -590,8 +635,8 @@ "title":"Deleting a Snapshot", "uri":"css_03_0036.html", "doc_type":"api", - "p_code":"58", - "code":"66" + "p_code":"63", + "code":"71" }, { "desc":"This API is used to disable the snapshot function.NoneNoneExample requestTable 2 describes the status code.", @@ -599,8 +644,8 @@ "title":"Disabling the Snapshot Function", "uri":"css_03_0039.html", "doc_type":"api", - "p_code":"58", - "code":"67" + "p_code":"63", + "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.", @@ -609,52 +654,52 @@ "uri":"css_03_0109.html", "doc_type":"api", "p_code":"", - "code":"68" + "code":"73" }, { - "desc":"This API is used to enable the VPC endpoint service.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200Status code: 200Request succeeded.", + "desc":"This API is used to enable the VPC endpoint service.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/vpceps", "product_code":"css", "title":"Enabling the VPC Endpoint Service", "uri":"css_03_0110.html", "doc_type":"api", - "p_code":"68", - "code":"69" + "p_code":"73", + "code":"74" }, { - "desc":"This API is used to disable the VPC endpoint service.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: 200NoneStatus code: 200Request succee", + "desc":"This API is used to disable the VPC endpoint service.You can debug this API in . Automatic authentication is supported.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpceps", "product_code":"css", "title":"Disabling the VPC Endpoint Service", "uri":"css_03_0111.html", "doc_type":"api", - "p_code":"68", - "code":"70" + "p_code":"73", + "code":"75" }, { - "desc":"This API is used to obtain a VPC endpoint connection.GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneStatus code: 200NoneStatus code: 200Request ", + "desc":"This API is used to obtain a VPC endpoint connection.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cluster_id}/vpceps", "product_code":"css", - "title":"Obtaining an Endpoint Connection", + "title":"Obtaining a VPC Endpoint Connection", "uri":"css_03_0112.html", "doc_type":"api", - "p_code":"68", - "code":"71" + "p_code":"73", + "code":"76" }, { - "desc":"This API is used to update an endpoint connection.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneNone", + "desc":"This API is used to update a VPC endpoint connection.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcep", "product_code":"css", - "title":"Updating an Endpoint Connection", + "title":"Updating a VPC Endpoint Connection", "uri":"css_03_0113.html", "doc_type":"api", - "p_code":"68", - "code":"72" + "p_code":"73", + "code":"77" }, { - "desc":"This API is used to modify the endpoint service whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsNoneNone", + "desc":"This API is used to modify the endpoint service whitelist.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/", "product_code":"css", "title":"Modifying the Endpoint Service Whitelist", "uri":"css_03_0114.html", "doc_type":"api", - "p_code":"68", - "code":"73" + "p_code":"73", + "code":"78" }, { "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.", @@ -663,34 +708,34 @@ "uri":"css_03_0115.html", "doc_type":"api", "p_code":"", - "code":"74" + "code":"79" }, { - "desc":"This API is used to modify the parameter settings of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/updateStatus code: 200Status code: 200Request succeeded.", + "desc":"This API is used to modify parameter configurations.You can debug this API in . Automatic authentication is supported.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/u", "product_code":"css", - "title":"Modifying Cluster Parameters", + "title":"Modifying Parameter Configurations", "uri":"css_03_0116.html", "doc_type":"api", - "p_code":"74", - "code":"75" + "p_code":"79", + "code":"80" }, { - "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: 200NoneStatus cod", + "desc":"This API is used to obtain the task list of parameter configurations.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id}/clusters/{cl", "product_code":"css", "title":"Obtaining the Task List of Parameter Configurations", "uri":"css_03_0117.html", "doc_type":"api", - "p_code":"74", - "code":"76" + "p_code":"79", + "code":"81" }, { - "desc":"This API is used to obtain the parameter configuration list of the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/templateNoneStatus code: 200NoneStatu", + "desc":"This API is used to obtain the parameter configuration list of the current cluster.You can debug this API in . Automatic authentication is supported.GET /v1.0/{project_id", "product_code":"css", "title":"Obtaining the Parameter Configuration List", "uri":"css_03_0118.html", "doc_type":"api", - "p_code":"74", - "code":"77" + "p_code":"79", + "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.", @@ -699,70 +744,115 @@ "uri":"css_03_0125.html", "doc_type":"api", "p_code":"", - "code":"78" + "code":"83" }, { - "desc":"This API is used to query the ELBv3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200NoneStatus code: 2", + "desc":"This API is used to query the ELB V3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200NoneStatus code: ", "product_code":"css", - "title":"Querying ELBv3 Load Balancers Supported by a Cluster", + "title":"Querying ELB V3 Load Balancer Supported by a Cluster", "uri":"css_03_0126.html", "doc_type":"api", - "p_code":"78", - "code":"79" + "p_code":"83", + "code":"84" }, { - "desc":"This API is used to enable or disable the Elasticsearch load balancer.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load", + "desc":"This API is used to enable or disable the ES load balancer.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load balancer.N", "product_code":"css", "title":"Enabling or Disabling the ES Load Balancer", "uri":"css_03_0127.html", "doc_type":"api", - "p_code":"78", - "code":"80" + "p_code":"83", + "code":"85" }, { - "desc":"This API is used to configure the Elasticsearch listener.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200Request succeeded.See E", + "desc":"This API is used to configure the ES listener.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200The request is processed.See Error", "product_code":"css", - "title":"Configuring ES Listener", + "title":"Configuring the ES Listener", "uri":"css_03_0128.html", "doc_type":"api", - "p_code":"78", - "code":"81" + "p_code":"83", + "code":"86" }, { - "desc":"This API is used to obtain the ES ELB information and display the health check status on the page.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus code", + "desc":"This API is used to obtain the ES ELB information and health check status.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus code: 200NoneStatus code: 20", "product_code":"css", - "title":"Obtaining the ES ELB Information and Displaying the Health Check Status", + "title":"Obtaining the ELB Information and Health Check Status", "uri":"css_03_0129.html", "doc_type":"api", - "p_code":"78", - "code":"82" + "p_code":"83", + "code":"87" }, { - "desc":"This API is used to update an Elasticsearch listener.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200NoneSee Error Codes.", + "desc":"This API is used to update an ES listener.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200NoneSee Error Codes.", "product_code":"css", "title":"Updating an ES Listener", "uri":"css_03_0130.html", "doc_type":"api", - "p_code":"78", - "code":"83" + "p_code":"83", + "code":"88" }, { - "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.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200NoneStatus code: 200The request is process", "product_code":"css", "title":"Querying the Certificate List", "uri":"css_03_0131.html", "doc_type":"api", - "p_code":"78", - "code":"84" + "p_code":"83", + "code":"89" }, { - "desc":"This section describes fine-grained permissions management for your CSS. If your account does not need individual IAM users, then you may skip over this chapter.By defaul", + "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":"Intelligent O&M", + "uri":"css_03_0132.html", + "doc_type":"api", + "p_code":"", + "code":"90" + }, + { + "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.NoneFor details, see Error Cod", + "product_code":"css", + "title":"Creating a Cluster Detection Task", + "uri":"css_03_0133.html", + "doc_type":"api", + "p_code":"90", + "code":"91" + }, + { + "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: 200Obtain the intelligent O&M tas", + "product_code":"css", + "title":"Obtaining the Intelligent O&M Task List and Details", + "uri":"css_03_0134.html", + "doc_type":"api", + "p_code":"90", + "code":"92" + }, + { + "desc":"This API is used to delete a detection task record.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneNoneDelete a detection task record.NoneFor details", + "product_code":"css", + "title":"Deleting a Detection Task Record", + "uri":"css_03_0135.html", + "doc_type":"api", + "p_code":"90", + "code":"93" + }, + { + "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", + "product_code":"css", + "title":"Obtaining SMN Topics Available for Intelligent O&M Alarms", + "uri":"css_03_0136.html", + "doc_type":"api", + "p_code":"90", + "code":"94" + }, + { + "desc":"This section describes fine-grained permissions management for your CSS. If your cloud account does not need individual IAM users, then you may skip over this chapter.By ", "product_code":"css", "title":"Permissions Policies and Supported Actions", "uri":"css_03_0065.html", "doc_type":"api", "p_code":"", - "code":"85" + "code":"95" }, { "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.", @@ -771,7 +861,7 @@ "uri":"css_03_0040.html", "doc_type":"api", "p_code":"", - "code":"86" + "code":"96" }, { "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", @@ -779,8 +869,8 @@ "title":"Obtaining a Project ID and Name", "uri":"css_03_0071.html", "doc_type":"api", - "p_code":"86", - "code":"87" + "p_code":"96", + "code":"97" }, { "desc":"Table 1 describes the status code.", @@ -788,8 +878,8 @@ "title":"Status Code", "uri":"css_03_0075.html", "doc_type":"api", - "p_code":"86", - "code":"88" + "p_code":"96", + "code":"98" }, { "desc":"No data is returned if an API fails to be invoked. You can locate the cause of an error according to the error code of each API. When the API calling fails, HTTPS status ", @@ -797,8 +887,8 @@ "title":"Error Code", "uri":"css_03_0076.html", "doc_type":"api", - "p_code":"86", - "code":"89" + "p_code":"96", + "code":"99" }, { "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.", @@ -807,6 +897,6 @@ "uri":"css_03_0024.html", "doc_type":"api", "p_code":"", - "code":"90" + "code":"100" } ] \ No newline at end of file diff --git a/docs/css/api-ref/ListFlavors.html b/docs/css/api-ref/ListFlavors.html new file mode 100644 index 00000000..f33b2438 --- /dev/null +++ b/docs/css/api-ref/ListFlavors.html @@ -0,0 +1,241 @@ + + +

Obtaining the List of Instance Flavors

+

Function

This API is used to query and display the IDs of supported instance flavors.

+
+

URI

GET /v1.0/{project_id}/flavors
+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID and Name.

+
+
+
+

Request

None

+
+

Response

Table 2 describes the response parameters.

+ +
+ + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Description

+

versions

+

Array of versions objects

+

List of engine versions.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 3 versions field description

Parameter

+

Type

+

Description

+

version

+

String

+

Engine version.

+

type

+

String

+

Instance type. The options are ess, ess-cold, ess-master, and ess-client.

+

flavors

+

Array of flavors objects

+

Flavor list

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 flavors field description

Parameter

+

Type

+

Description

+

ram

+

Integer

+

Memory size of an instance. Unit: GB

+

cpu

+

Integer

+

Number of vCPUs of an instance.

+

name

+

String

+

Flavor name.

+

region

+

String

+

AZ

+

diskrange

+

String

+

Disk capacity range of an instance.

+

flavor_id

+

String

+

ID of a flavor.

+
+
+
+

Examples

Example request
GET /v1.0/6204a5bd270343b5885144cf9c8c158d/flavors
+
+

Example response

+
{
+  "versions": [
+    {
+      "version": "6.2.3",
+      "flavors": [
+        {
+          "cpu": 1,
+          "ram": 8,
+          "name": "css.medium.8",
+          "region": "eu-de",
+          "diskrange": "40,640",
+          "flavor_id": "6b6c0bcf-750d-4f8a-b6f5-c45a143f5198"
+
+        },
+        {
+          "cpu": 2,
+          "ram": 16,
+          "name": "css.large.8",
+          "region": "eu-de",
+          "diskrange": "40,1280",
+          "flavor_id": "d373e339-3cf4-4c00-9739-2259e9f3ec16"
+
+        },
+        {
+          "cpu": 4,
+          "ram": 32,
+          "name": "css.xlarge.8",
+          "region": "eu-de",
+          "diskrange": "40,2560",
+          "flavor_id": "2d8daf1b-873f-4c2e-a7b9-2f9cbcf2f213"
+
+        },
+        {
+          "cpu": 8,
+          "ram": 64,
+          "name": "css.2xlarge.8",
+          "region": "eu-de",
+          "diskrange": "80,5120",
+          "flavor_id": "b3d33ec6-d58a-40f0-aa51-4f671ce64b2a"
+
+        },
+        {
+          "cpu": 16,
+          "ram": 128,
+          "name": "css.4xlarge.8",
+          "region": "eu-de",
+          "diskrange": "160,10240",
+          "flavor_id": "f74419ca-bc91-4558-b4e2-90eeefb37c6e"
+        }
+      ]
+    }
+  ]
+}
+
+

Status Code

Table 5 describes the status code.

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Status codes

Status Code

+

Message

+

Description

+

400

+

BadRequest

+

Invalid request.

+

Modify the request instead of retrying.

+

404

+

NotFound

+

The requested resource cannot be found.

+

Modify the request instead of retrying.

+

200

+

OK

+

The request is processed.

+
+
+
+
+
+ +
+ diff --git a/docs/css/api-ref/ListImages.html b/docs/css/api-ref/ListImages.html new file mode 100644 index 00000000..aa89ed0a --- /dev/null +++ b/docs/css/api-ref/ListImages.html @@ -0,0 +1,184 @@ + + +

Obtaining a Target Image ID

+

Function

This API is used to obtain the ID of an image that can be upgraded in the current cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

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

+

cluster_id

+

Yes

+

String

+

ID of the cluster to be upgraded.

+

upgrade_type

+

Yes

+

String

+

Version type. The value can be:

+
  • same: upgrade to the same version.
  • cross: upgrade to a different version.
  • crossEngine: cross-engine upgrade.
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

needUploadUpgradePlugin

+

Boolean

+

Indicates whether to upload the plug-in of the target version.

+

imageInfoList

+

Array of GetTargetImageIdDetail objects

+

Image details.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 GetTargetImageIdDetail

Parameter

+

Type

+

Description

+

id

+

String

+

ID of an image that can be upgraded.

+

displayName

+

String

+

Name of an image that can be upgraded.

+

imageDesc

+

String

+

Image description.

+

datastoreType

+

String

+

Image engine type.

+

datastoreVersion

+

String

+

Image engine version.

+

priority

+

Integer

+

Priority

+
+
+
+

Request Example

GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images
+
+{
+  "needUploadUpgradePlugin" : false,
+  "imageInfoList" : [ ]
+}
+
+

Response Example

Status code: 200

+

The request is processed.

+
{
+  "needUploadUpgradePlugin" : false,
+  "imageInfoList" : [ ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The request is processed.

+

400

+

Invalid request. Modify the request directly and do not attempt to retry it.

+

403

+

The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it.

+
+
+
+

Error Codes

For details, see Error Code.

+
+
+
+ +
+ diff --git a/docs/css/api-ref/ResetPassword.html b/docs/css/api-ref/ResetPassword.html new file mode 100644 index 00000000..1d617476 --- /dev/null +++ b/docs/css/api-ref/ResetPassword.html @@ -0,0 +1,119 @@ + + +

Changing a Password

+

Function

This API is used to change the password of a cluster.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

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

+

cluster_id

+

Yes

+

String

+

ID of the cluster whose password you want to change.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

newpassword

+

Yes

+

String

+

Password of the cluster user admin in security mode. This API is available only when authorityEnable is set to true.

+
  • The value can contain 8 to 32 characters.
  • The value must contain at least 3 of the following character types: uppercase letters, lowercase letters, numbers, and special characters ~!@#$%&*()-_=|[{}];:,<.>/?
+
+
+
+

Response Parameters

None

+
+

Request Example

Change the administrator password of the current cluster.

+
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/password/reset
+
+{
+  "newpassword" : "xxxxxx"
+}
+
+

Response Example

None

+
+

Status Codes

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

Status Code

+

Description

+

200

+

The request is processed.

+

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 the client is attempting to create already exists, or that the update operation requested cannot be completed due to a conflict.

+

412

+

The server did not satisfy one of the preconditions set by the requester in the request.

+
+
+
+

Error Codes

For details, see Error Code.

+
+
+
+ +
+ diff --git a/docs/css/api-ref/RetryUpgradeTask.html b/docs/css/api-ref/RetryUpgradeTask.html new file mode 100644 index 00000000..69e10e12 --- /dev/null +++ b/docs/css/api-ref/RetryUpgradeTask.html @@ -0,0 +1,118 @@ + + +

Retrying a Failed Upgrade Task

+

Function

The upgrade takes a long time and the upgrade may fail due to network problems. You can use this API to retry a task or terminate the impact of a task.

+
+

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

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

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

+

cluster_id

+

Yes

+

String

+

ID of the cluster to be retried.

+

action_id

+

Yes

+

String

+

ID of the task to be retried.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

retry_mode

+

No

+

String

+

If this parameter is not left blank, the impact of the task is terminated. Currently, only abort is supported.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

None

+
+

Request Example

  • Example request for retrying an upgrade task.
    PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry
    +
  • Example request for terminating an upgrade task.
    PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry?retry_mode=abort
    +
+
+

Response Example

None

+
+

Status Codes

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

Status Code

+

Description

+

200

+

The request is processed.

+

400

+

Invalid request. Modify the request directly and do not attempt to retry it.

+

403

+

The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it.

+
+
+
+

Error Codes

For details, see Error Code.

+
+
+
+ +
+ diff --git a/docs/css/api-ref/ShowClusterDetail.html b/docs/css/api-ref/ShowClusterDetail.html new file mode 100644 index 00000000..9063e2e0 --- /dev/null +++ b/docs/css/api-ref/ShowClusterDetail.html @@ -0,0 +1,593 @@ + + +

Querying Cluster Details

+

Function

This API is used to query and display details about a cluster.

+
+

Debugging

You can debug this API in . Automatic authentication is supported.

+
+

URI

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

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see Obtaining a Project ID and Name.

+

cluster_id

+

Yes

+

String

+

ID of the cluster to be queried

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Response body parameter

Parameter

+

Type

+

Description

+

datastore

+

ClusterDetailDatastore object

+

Search engine type

+

instances

+

Array of ClusterDetailInstances objects

+

Node object list

+

publicKibanaResp

+

publicKibanaRespBody object

+

Kibana public network access information

+

elbWhiteList

+

elbWhiteListResp object

+

Public network access information

+

updated

+

String

+

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

+

name

+

String

+

Cluster name

+

publicIp

+

String

+

Public IP address

+

created

+

String

+

Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss.

+

id

+

String

+

Cluster ID.

+

status

+

String

+

Cluster status.

+
  • 100: The operation, such as instance creation, is in progress.
  • 200: The cluster is available.
  • 303: The cluster is unavailable.
+

endpoint

+

String

+

IP address and port number for accessing VPC

+

vpcId

+

String

+

VPC ID.

+

subnetId

+

String

+

Subnet ID.

+

securityGroupId

+

String

+

Security group ID

+

vpcepIp

+

String

+

VPC endpoint IP address

+

bandwidthSize

+

Integer

+

Public network bandwidth Unit: Mbit/s

+

httpsEnable

+

Boolean

+

Communication encryption status.

+
  • Value false indicates that communication encryption is not enabled.
  • true: communication encryption has been enabled.
+

diskEncrypted

+

Boolean

+

Indicates whether disks are encrypted.

+
  • Value true indicates that disks are encrypted.
  • false: disks are not encrypted.
+

authorityEnable

+

Boolean

+

Indicates 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.
+

backupAvailable

+

Boolean

+

Indicates whether the snapshot function is enabled.

+
  • true: The snapshot function is enabled.
  • false: The snapshot function is disabled.
+

actionProgress

+

Object

+

Cluster operation progress, which displays the progress of cluster creation or scale-out in percentage.

+

actions

+

Array of strings

+

Current behavior of a cluster. The value can be REBOOTING, GROWING, RESTORING, and SNAPSHOTTING.

+

enterpriseProjectId

+

String

+

ID of the enterprise project to which a cluster belongs.

+

If the user of the cluster does not enable the enterprise project, the setting of this parameter is not returned.

+

tags

+

Array of ClusterDetailTags objects

+

Cluster tag

+

failedReason

+

ClusterDetailFailedReasons object

+

Failure cause. If the cluster is in the Available state, this parameter is not returned.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 ClusterDetailDatastore

Parameter

+

Type

+

Description

+

type

+

String

+

Engine type. Currently, only Elasticsearch is supported.

+

version

+

String

+

CSS cluster engine version. For details, see Supported Cluster Versions.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ClusterDetailInstances

Parameter

+

Type

+

Description

+

status

+

String

+

Node status value.

+
  • 100: The operation, such as instance creation, is in progress.
  • 200: The cluster is available.
  • 303: The cluster is unavailable.
+

type

+

String

+

Node type

+

id

+

Integer

+

Instance ID

+

name

+

String

+

Instance name

+

specCode

+

String

+

Node specifications.

+

azCode

+

String

+

AZ to which a node belongs.

+

ip

+

String

+

Instance IP address

+

volume

+

ShowClusterVolumeRsp object

+

Instance disk information

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ShowClusterVolumeRsp

Parameter

+

Type

+

Description

+

type

+

String

+

Instance disk type

+

size

+

Integer

+

Instance disk size

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 publicKibanaRespBody

Parameter

+

Type

+

Description

+

eipSize

+

Integer

+

Bandwidth. Unit: Mbit/s

+

elbWhiteListResp

+

kibanaElbWhiteListResp object

+

Kibana public network access information

+

publicKibanaIp

+

String

+

Kibana access IP address

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 kibanaElbWhiteListResp

Parameter

+

Type

+

Description

+

enableWhiteList

+

Boolean

+

Indicates whether access control is enabled.

+
  • true: Access control is enabled.
  • false: Access control is disabled.
+

whiteList

+

String

+

Whitelist for Kibana public network access

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 elbWhiteListResp

Parameter

+

Type

+

Description

+

enableWhiteList

+

Boolean

+

Indicates whether public access control is enabled.

+
  • true: Public network access control is enabled.
  • false: Public network access control is disabled.
+

whiteList

+

String

+

Whitelist for public network access

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 ClusterDetailTags

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+

value

+

String

+

Tag value

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 ClusterDetailFailedReasons

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Error code.

+
  • CSS.6000: failed to create a cluster.
  • CSS.6001: failed to scale out a cluster.
  • CSS.6002: failed to restart a cluster.
  • CSS.6004: failed to create a node.
  • CSS.6005: failed to initialize the service.
+

errorMsg

+

String

+

Detailed error information

+
+
+
+

Request Example

None

+
+

Response Example

Status code: 200

+

The request is processed successfully.

+
{
+  "datastore" : {
+    "type" : "elasticsearch",
+    "version" : "x.x.x"
+  },
+  "instances" : [ {
+    "status" : "200",
+    "type" : "ess",
+    "id" : "3c7fe582-a9f6-46fd-9d01-956bed4a8bbc",
+    "name" : "ES-xx",
+    "specCode" : "css.xlarge.2",
+    "azCode" : "xx-xxx-xx",
+    "ip" : "192.168.0.x",
+    "volume" : {
+      "type" : "COMMON",
+      "size" : 40
+    }
+  } ],
+  "publicKibanaResp" : {
+    "eipSize" : 5,
+    "publicKibanaIp" : "100.95.158.x",
+    "elbWhiteListResp" : {
+      "whiteList" : "11.11.11.11",
+      "enableWhiteList" : true
+    }
+  },
+  "updated" : "2018-01-16T08:37:18",
+  "name" : "ES-xx",
+  "publicIp" : "100.95.149.xx:9200",
+  "elbWhiteList" : {
+    "whiteList" : "10.10.10.10",
+    "enableWhiteList" : true
+  },
+  "created" : "2018-01-16T08:37:18",
+  "id" : "5c77b71c-5b35-4f50-8984-76387e42451a",
+  "status" : "200",
+  "endpoint" : "192.168.0.x:9200",
+  "vpcId" : "07e7ab39-xxx-xxx-xxx-d3f28ea7f051",
+  "subnetId" : "025d45f9-xxx-xxx-xxx-e852c6455a5e",
+  "securityGroupId" : "0347aabc-xxx-xxx-xxx-6b10a79701e2",
+  "vpcepIp" : "192.168.0.203",
+  "bandwidthSize" : 0,
+  "diskEncrypted" : false,
+  "httpsEnable" : true,
+  "authorityEnable" : true,
+  "backupAvailable" : true,
+  "actionProgress" : { },
+  "actions" : [ ],
+  "enterpriseProjectId" : "3e1c74a0-xxx-xxx-xxx-c6b9e46cf81b",
+  "tags" : [ {
+    "key" : "k1",
+    "value" : "v1"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The request is processed.

+

400

+

Invalid request.

+

Modify the request instead of retrying.

+

404

+

The requested resource cannot be found.

+

Modify the request instead of retrying.

+
+
+
+
+
+ +
+ diff --git a/docs/css/api-ref/UpgradeCore.html b/docs/css/api-ref/UpgradeCore.html new file mode 100644 index 00000000..76ba3f5d --- /dev/null +++ b/docs/css/api-ref/UpgradeCore.html @@ -0,0 +1,174 @@ + + +

Upgrading a Cluster Kernel

+

Function

This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.

+
+

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

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

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

+

cluster_id

+

Yes

+

String

+

ID of the cluster to be upgraded.

+

inst_type

+

Yes

+

String

+

Type of the node to be upgraded. Currently, its value can only be all.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

target_image_id

+

Yes

+

String

+

ID of the target image version.

+

upgrade_type

+

Yes

+

String

+

Upgrade type.

+
  • same: upgrade to the same version.
  • cross: upgrade to a different version.
  • crossEngine: cross-engine upgrade.
+

The value can be:

+
  • same
  • cross
  • crossEngine
+

indices_backup_check

+

Yes

+

Boolean

+

Indicates whether to perform backup verification.

+
  • true: Verify the backup.
  • false: Do not verify the backup.
+

The value can be:

+
  • true
  • false
+

agency

+

Yes

+

String

+

Agency name. You can create an agency to allow CSS to call other cloud services.

+

cluster_load_check

+

No

+

Boolean

+

Indicates whether to verify the load. The default value is true.

+
  • true: Verify the load.
  • false: Do not verify the load.
+
+
+
+

Response Parameters

None

+
+

Request Example

Update a cluster version.

+
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/inst-type/all/image/upgrade
+
+{
+  "target_image_id" : "{target_image_id}",
+  "upgrade_type" : "same",
+  "indices_backup_check" : true,
+  "agency" : "css-test-agency",
+  "cluster_load_check" : true
+}
+
+

Response Example

None

+
+

Status Codes

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

Status Code

+

Description

+

200

+

The request is processed.

+

400

+

Invalid request.

+

Modify the request directly and do not attempt to retry it.

+

409

+

The request cannot be processed due to a conflict.

+

This status code indicates that the resource the client is attempting to create already exists, or that the update operation requested cannot be completed due to a conflict.

+

412

+

The server did not satisfy one of the preconditions set by the requester in the request.

+
+
+
+

Error Codes

For details, see Error Code.

+
+
+
+ +
+ diff --git a/docs/css/api-ref/UpgradeDetail.html b/docs/css/api-ref/UpgradeDetail.html new file mode 100644 index 00000000..424fc075 --- /dev/null +++ b/docs/css/api-ref/UpgradeDetail.html @@ -0,0 +1,436 @@ + + +

Obtaining Upgrade Details

+

Function

The upgrade takes a long time. You can call this API to check the upgrade progress on a node.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detail

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

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

+

cluster_id

+

Yes

+

String

+

ID of the cluster to be upgraded.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

start

+

No

+

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.

+

limit

+

No

+

Integer

+

Maximum number of connections displayed on each page.

+

action_mode

+

No

+

String

+

Upgrade querying behavior.

+
  • If you need to query the cluster version upgrade details, leave this parameter blank.
  • If you need to query the details about AZ switchover, set this parameter to AZ_MIGRATION.
+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

totalSize

+

Integer

+

Number of times a request is delivered to the execution API.

+

detailList

+

Array of GetUpgradeDetailInfo objects

+

Upgrade task details.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 GetUpgradeDetailInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Task ID

+

startTime

+

String

+

Start time of the upgrade.

+

endTime

+

String

+

End time of the upgrade.

+

status

+

String

+

Task status. The value can be:

+
  • RUNNING: The upgrade is in progress.
  • SUCCESS: The upgrade is successful.
  • FAILED: The upgrade failed.
  • PARTIAL_FAILED: The upgrade partially failed.
+

agencyName

+

String

+

Agency name. You can create an agency to allow CSS to call other cloud services.

+

imageInfo

+

GetTargetImageIdDetail object

+

Image details.

+

totalNodes

+

String

+

Names of the nodes to be upgraded.

+

completedNodes

+

String

+

Names of the nodes that have been upgraded.

+

currentNodeName

+

String

+

Names of the nodes that are being upgraded.

+

executeTimes

+

String

+

Retried times

+

migrateParam

+

String

+

Current upgrade behavior of the cluster. The value is displayed if the query parameter exists.

+

finalAzInfoMap

+

String

+

Expected result of the cluster upgrade. The value is displayed if the query parameter exists.

+

currentNodeDetail

+

Array of CurrentNodeDetail objects

+

Task details of the node that is being upgraded.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 GetTargetImageIdDetail

Parameter

+

Type

+

Description

+

id

+

String

+

ID of an image that can be upgraded.

+

displayName

+

String

+

Name of an image that can be upgraded.

+

imageDesc

+

String

+

Image description.

+

datastoreType

+

String

+

Image engine type.

+

datastoreVersion

+

String

+

Image engine version.

+

priority

+

Integer

+

Priority

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 CurrentNodeDetail

Parameter

+

Type

+

Description

+

order

+

Integer

+

Sequence number of an upgrade task.

+

name

+

String

+

Upgrade task name.

+

status

+

String

+

Status of the current task.

+

desc

+

String

+

Description of the current task.

+

beginTime

+

String

+

Start time of the current task.

+

endTime

+

String

+

End time of the current task.

+
+
+
+

Request Example

  • Example request for upgrading a cluster.
    GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail
    +
  • Example request for upgrading a cluster.
    GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail?action_mode=AZ_MIGRATION
    +
+
+

Response Example

Status code: 200

+

The request is processed.

+
  • Example response for upgrading a cluster image.
    {
    +  "totalSize" : 1,
    +  "detailList" : [ {
    +    "id" : "b7ac4c5b-3bda-4feb-a303-eb80f4bce986",
    +    "startTime" : "2023-01-05T02:23:39",
    +    "endTime" : "",
    +    "status" : "RUNNING",
    +    "agencyName" : "css_test_agency",
    +    "imageInfo" : {
    +      "id" : "439b5d30-5968-45df-b088-d030a858522d",
    +      "displayName" : "7.10.2_22.5.1_1230",
    +      "imageDesc" : "The latest image of version 7.10.2 will be officially released on December 30, 2022. the stability of the cluster has been optimized. It is recommended that you upgrade to this version.",
    +      "datastoreType" : "elasticsearch",
    +      "datastoreVersion" : "7.10.2",
    +      "priority" : 16
    +    },
    +    "totalNodes" : "css-test-ess-esn-1-1,css-test-ess-esn-2-1,css-test-ess-esn-3-1",
    +    "completedNodes" : "",
    +    "currentNodeName" : "css-test-ess-esn-1-1",
    +    "executeTimes" : "1",
    +    "currentNodeDetail" : [ {
    +      "order" : 0,
    +      "name" : "Data migration",
    +      "status" : "SUCCESS",
    +      "desc" : "Data is migrated from a node to other nodes in the cluster by running the exclude command.",
    +      "beginTime" : "2023-01-05T02:23:42",
    +      "endTime" : "2023-01-05T02:29:51"
    +    }, {
    +      "order" : 12,
    +      "name" : "Task status update",
    +      "status" : "WAITING",
    +      "desc" : "The cluster task status is refreshed. If there are no nodes to be replaced, the task is marked as completed. Otherwise, another node starts to be replaced.",
    +      "beginTime" : "",
    +      "endTime" : ""
    +    } ]
    +  } ]
    +}
    +
  • Example response for switching the AZ.
    {
    +  "totalSize" : 1,
    +  "detailList" : [ {
    +    "id" : "8ebe958b-b8c6-4939-b5a7-85aee9468888",
    +    "startTime" : "2022-12-29T08:32:29",
    +    "endTime" : "",
    +    "status" : "RUNNING",
    +    "agencyName" : "css_test_agency",
    +    "totalNodes" : "css-test-ess-esn-2-1,css-test-ess-esn-1-1,css-test-ess-esn-3-1",
    +    "completedNodes" : "css-test-ess-esn-2-1",
    +    "currentNodeName" : "css-test-ess-esn-1-1",
    +    "executeTimes" : "1",
    +    "migrateParam" : "{\"instType\":\"ess\",\"migrateType\":\"az_migrate\",\"sourceAz\":\"cn-north-4a\",\"targetAz\":\"cn-north-4c\"}",
    +    "finalAzInfoMap" : "{\"cn-north-4c\":\"css-test-ess-esn-2-1,css-test-ess-esn-1-1,css-test-ess-esn-3-1\"}",
    +    "currentNodeDetail" : [ {
    +      "order" : 0,
    +      "name" : "Data migration",
    +      "status" : "SUCCESS",
    +      "desc" : "Data is migrated from a node to other nodes in the cluster by running the exclude command.",
    +      "beginTime" : "2022-12-29T08:41:05",
    +      "endTime" : "2022-12-29T08:41:23"
    +    }, {
    +      "order" : 12,
    +      "name" : "Task status update",
    +      "status" : "RUNNING",
    +      "desc" : "The cluster task status is refreshed. If there are no nodes to be replaced, the task is marked as completed. Otherwise, another node starts to be replaced.",
    +      "beginTime" : "2023-01-04T06:53:42",
    +      "endTime" : ""
    +    } ]
    +  } ]
    +}
    +
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The request is processed.

+

400

+

Invalid request. Modify the request directly and do not attempt to retry it.

+

403

+

The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it.

+
+
+
+

Error Codes

For details, see Error Code.

+
+
+
+ +
+ diff --git a/docs/css/api-ref/css_03_0008.html b/docs/css/api-ref/css_03_0008.html index 18759e17..a4f37fd9 100644 --- a/docs/css/api-ref/css_03_0008.html +++ b/docs/css/api-ref/css_03_0008.html @@ -8,17 +8,17 @@ - - - - @@ -26,22 +26,32 @@ - - - - - + + + + + diff --git a/docs/css/api-ref/css_03_0018.html b/docs/css/api-ref/css_03_0018.html index 86db1416..138ef983 100644 --- a/docs/css/api-ref/css_03_0018.html +++ b/docs/css/api-ref/css_03_0018.html @@ -52,17 +52,17 @@
- - - - @@ -86,9 +86,9 @@ - - - - @@ -178,7 +178,7 @@ - @@ -212,7 +212,7 @@ - @@ -221,7 +221,7 @@
Table 2 Parameter description

Parameter

Type

+

Type

Description

+

Description

clusters

Array of clusters objects

+

Array of clusters objects

List of cluster objects.

+

List of cluster objects

instances

Array of instances in Table 5.

+

Array of instance objects

List of node objects.

+

List of node objects

updated

@@ -102,7 +102,7 @@

String

Cluster name.

+

Cluster name

created

@@ -170,7 +170,7 @@

String

Whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true.

+

Indicates whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true.

  • Value true indicates that authentication is enabled for the cluster.
  • Value false indicates that authentication is disabled for the cluster.

Boolean

Whether disks are encrypted.

+

Indicates whether disks are encrypted.

  • Value true indicates that disks are encrypted.
  • Value false indicates that disks are not encrypted.

tags

Array of tags in Table 7.

+

Array of tag objects

Tags of a cluster.

-
Table 4 datastore field data structure description

Parameter

+
@@ -240,7 +240,7 @@ - @@ -281,7 +281,7 @@
Table 4 datastore field data structure description

Parameter

Type

String

Engine version number.

+

Engine version number.

String

Instance status.

-
  • 100: Creating.
  • 200: Available.
  • 303: Unavailable, such as creation failed.
+
  • 100: Creating.
  • 200: Available.
  • 303: Unavailable, such as creation failed.

specCode

@@ -329,24 +329,24 @@
-
Table 7 tags field data structure description

Parameter

+
- - - - - @@ -473,7 +473,7 @@

Status Code

Table 8 describes the status code.

-
Table 7 tags field data structure description

Parameter

Type

+

Type

Description

key

+

key

String

+

String

Tag key.

value

+

value

String

+

String

Tag value.

Table 8 Status code

Status Code

+
diff --git a/docs/css/api-ref/css_03_0019.html b/docs/css/api-ref/css_03_0019.html index 0b3b7831..e61dde23 100644 --- a/docs/css/api-ref/css_03_0019.html +++ b/docs/css/api-ref/css_03_0019.html @@ -53,99 +53,99 @@
Table 8 Status codes

Status Code

Code

-
Table 3 cluster field description

Parameter

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -179,7 +179,7 @@
Table 3 cluster field description

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

instance

+

instance

Yes

+

Yes

Object

+

Object

Instance. For details about related parameters, see Table 4.

datastore

+

datastore

Yes

+

Yes

Object

+

Object

Type of the data search engine. For details about related parameters, see Table 7.

name

+

name

Yes

+

Yes

String

+

String

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

instanceNum

+

instanceNum

Yes

+

Yes

Integer

+

Integer

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

backupStrategy

+

backupStrategy

No

+

No

Object

+

Object

Automatic snapshot creation. This function is disabled by default. For details about related parameters, see Table 8.

NOTE:

The automatic snapshot creation policy is enabled only if this parameter is specified.

diskEncryption

+

diskEncryption

Yes

+

Yes

Object

+

Object

Whether disks are encrypted. For details about related parameters, see Table 9.

+

Indicates whether disks are encrypted. For details about related parameters, see Table 9.

httpsEnable

+

httpsEnable

No

+

No

String

+

String

Whether communication encryption is performed on the cluster. Available values include true and false. By default, communication encryption is disabled. When httpsEnable is set to true, authorityEnable must be set to true.

-
  • Value true indicates that communication encryption is performed on the cluster.
  • Value false indicates that communication encryption is not performed on the cluster.
+
Indicates whether communication is encrypted on the cluster. Available values include true and 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 on the cluster.
+

authorityEnable

+

authorityEnable

No

+

No

Boolean

+

Boolean

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.
    NOTE:

    This parameter is supported in clusters 7.1.1 or later.

    +

Indicates whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true.

+
  • Value true indicates that authentication is enabled for the cluster.
  • Value false indicates that authentication is disabled for the cluster.
    NOTE:

    This parameter is supported in clusters 7.1.1 or later.

adminPwd

+

adminPwd

No

+

No

String

+

String

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

NOTE:
  • The administrator password must meet the following requirements:
    • The password can contain 8 to 32 characters.
    • Passwords must contain at least 3 of the following character types: uppercase letters, lowercase letters, numbers, and special characters (~!@#$%^&*()-_=+\\|[{}];:,<.>/?).
    @@ -153,25 +153,25 @@

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.

-
NOTE:

For details about how to obtain enterprise project IDs and features, see the Enterprise Management Service User Guide.

+
NOTE:

For details about how to obtain enterprise project IDs and features, see the .

tags

+

tags

No

+

No

Array of tags in Table 10

+

Array of tag objects

Tags in a cluster.

-
NOTE:

For details about the tag feature, see the Tag Management Service Overview.

+
NOTE:

For details about the tag feature, see the Tag Management Service.

-
Table 4 instance field description

Parameter

+
@@ -233,7 +233,7 @@
Table 4 instance field description

Parameter

Mandatory

-
Table 5 volume field description

Parameter

+
@@ -268,7 +268,7 @@
Table 5 volume field description

Parameter

Mandatory

-
Table 6 nics field description

Parameter

+
@@ -309,7 +309,7 @@
Table 6 nics field description

Parameter

Mandatory

-
Table 7 datastore field description

Parameter

+
@@ -357,7 +357,7 @@ -
Table 7 datastore field description

Parameter

Mandatory

String

Time when a snapshot is created every day. 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+02:00.

+

Time when a snapshot is created every day. 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+02:00.

prefix

@@ -498,7 +498,7 @@
-
Table 12 cluster field description

Parameter

+
@@ -517,7 +517,7 @@ - @@ -531,8 +531,8 @@ "name": "ES-Test", "instanceNum": 4, "instance": { - "availability_zone": "eu-de-01", - "flavorRef": "css.large.8", + "availability_zone": "eu-du-01", + "flavorRef": "css.large.8", "volume": { "volume_type": "COMMON", "size": 100 @@ -573,14 +573,14 @@ - diff --git a/docs/css/api-ref/css_03_0020.html b/docs/css/api-ref/css_03_0020.html index 581f3940..f7ca250d 100644 --- a/docs/css/api-ref/css_03_0020.html +++ b/docs/css/api-ref/css_03_0020.html @@ -49,11 +49,11 @@

Status Code

Table 2 describes the status code.

-
Table 12 cluster field description

Parameter

Type

String

Cluster name.

+

Cluster name

BadRequest

Invalid request.

-

The client should not repeat the request without modifications.

+

Modify the request instead of retrying.

409

Conflict

The request could not 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 request fails to be processed because of the update of the conflict request.

Table 2 Status code

Status Code

+
- - @@ -62,7 +62,7 @@
Table 2 Status codes

Status Code

Code

+

Message

Status Code Description

+

Description

BadRequest

Invalid request.

-

The client should not repeat the request without modifications.

+

Modify the request instead of retrying.

404

@@ -70,7 +70,7 @@

NotFound

The requested resource cannot be found.

-

The client should not repeat the request without modifications.

+

Modify the request instead of retrying.

200

diff --git a/docs/css/api-ref/css_03_0021.html b/docs/css/api-ref/css_03_0021.html index 13ab80f6..d9f8d3e8 100644 --- a/docs/css/api-ref/css_03_0021.html +++ b/docs/css/api-ref/css_03_0021.html @@ -5,32 +5,32 @@

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/restart
-
Table 1 Parameter description

Parameter

+
- - - - - - - - - - - @@ -39,17 +39,17 @@

Request

None

-

Response

None

+

Response

None

-

Examples

None

+

Examples

None

Status Code

Table 2 describes the status code.

-
Table 1 Parameter description

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

project_id

+

project_id

Yes

+

Yes

String

+

String

Project ID. For details, see Obtaining a Project ID and Name.

+

Project ID. For details, see Obtaining a Project ID and Name.

cluster_id

+

cluster_id

Yes

+

Yes

String

+

String

ID of the cluster to be restarted.

+

ID of the cluster to be restarted.

Table 2 Status code

Status Code

+
- - @@ -58,7 +58,7 @@ - + + + - - @@ -93,7 +101,7 @@ @@ -126,14 +134,14 @@ @@ -189,9 +197,9 @@
Table 2 Status codes

Status Code

Code

+

Message

Status Code Description

+

Description

BadRequest

Invalid request.

-

The client should not repeat the request without modifications.

+

Modify the request instead of retrying.

404

@@ -66,7 +66,7 @@

NotFound

The requested resource cannot be found.

-

The client should not repeat the request without modifications.

+

Modify the request instead of retrying.

200

diff --git a/docs/css/api-ref/css_03_0023.html b/docs/css/api-ref/css_03_0023.html deleted file mode 100644 index 93f9956d..00000000 --- a/docs/css/api-ref/css_03_0023.html +++ /dev/null @@ -1,241 +0,0 @@ - - -

Obtaining the List of Instance Flavors

-

Function

This API is used to query and display the IDs of supported instance flavors.

-
-

URI

GET /v1.0/{project_id}/flavors
- -
- - - - - - - - - - - -
Table 1 Parameter description

Parameter

-

Mandatory

-

Type

-

Description

-

project_id

-

Yes

-

String

-

Project ID. For details, see Obtaining a Project ID and Name.

-
-
-
-

Request

None

-
-

Response

Table 2 describes the response parameters.

- -
- - - - - - - - - -
Table 2 Parameter description

Parameter

-

Type

-

Description

-

versions

-

Array of versions objects

-

List of engine versions.

-
-
- -
- - - - - - - - - - - - - - - - - -
Table 3 versions field description

Parameter

-

Type

-

Description

-

version

-

String

-

Engine version.

-

type

-

String

-

Instance type. The options are ess, ess-cold, ess-master, and ess-client.

-

flavors

-

Array of flavors objects

-

Flavor list

-
-
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 flavors field description

Parameter

-

Type

-

Description

-

ram

-

Integer

-

Memory size of an instance. Unit: GB

-

cpu

-

Integer

-

Number of vCPUs of an instance.

-

name

-

String

-

Flavor name.

-

region

-

String

-

AZ

-

diskrange

-

String

-

Disk capacity range of an instance.

-

flavor_id

-

String

-

ID of a flavor.

-
-
-
-

Examples

Example request
GET /v1.0/6204a5bd270343b5885144cf9c8c158d/flavors
-
-

Example response

-
{
-  "versions": [
-    {
-      "version": "7.6.2",
-      "flavors": [
-        {
-          "cpu": 1,
-          "ram": 8,
-          "name": "css.medium.8",
-          "region": "eu-de",
-          "diskrange": "40,640",
-          "flavor_id": "6b6c0bcf-750d-4f8a-b6f5-c45a143f5198"
-
-        },
-        {
-          "cpu": 2,
-          "ram": 16,
-          "name": "css.large.8",
-          "region": "eu-de",
-          "diskrange": "40,1280",
-          "flavor_id": "d373e339-3cf4-4c00-9739-2259e9f3ec16"
-
-        },
-        {
-          "cpu": 4,
-          "ram": 32,
-          "name": "css.xlarge.8",
-          "region": "eu-de",
-          "diskrange": "40,2560",
-          "flavor_id": "2d8daf1b-873f-4c2e-a7b9-2f9cbcf2f213"
-
-        },
-        {
-          "cpu": 8,
-          "ram": 64,
-          "name": "css.2xlarge.8",
-          "region": "eu-de",
-          "diskrange": "80,5120",
-          "flavor_id": "b3d33ec6-d58a-40f0-aa51-4f671ce64b2a"
-
-        },
-        {
-          "cpu": 16,
-          "ram": 128,
-          "name": "css.4xlarge.8",
-          "region": "eu-de",
-          "diskrange": "160,10240",
-          "flavor_id": "f74419ca-bc91-4558-b4e2-90eeefb37c6e"
-        }
-      ]
-    }
-  ]
-}
-
-

Status Code

Table 5 describes the status code.

- -
- - - - - - - - - - - - - - - - - -
Table 5 Status code

Status Code

-

Code

-

Status Code Description

-

400

-

BadRequest

-

Invalid request.

-

The client should not repeat the request without modifications.

-

404

-

NotFound

-

The requested resource cannot be found.

-

The client should not repeat the request without modifications.

-

200

-

OK

-

The request is processed successfully.

-
-
-
-
-
- -
- diff --git a/docs/css/api-ref/css_03_0024.html b/docs/css/api-ref/css_03_0024.html index 2753c606..efb6f123 100644 --- a/docs/css/api-ref/css_03_0024.html +++ b/docs/css/api-ref/css_03_0024.html @@ -8,7 +8,15 @@

2023-12-15

+

2024-05-17

+

Added:

+ +

Modified:

+ +

2023-12-15

Delete the following section:

Intelligent O&M

@@ -17,7 +25,7 @@

2023-9-25

Added:

- +

2023-07-04

@@ -29,25 +37,25 @@

Added the cluster version Opensearch_1.3.6 in Supported Cluster Versions.

Optimize the parameter description.

- +

Update example response in Modifying Public Network Access Bandwidth.

2023-03-28

2023-02-28

Optimized response parameters in Querying Cluster Details.

+

Optimized response parameters in Querying Cluster Details.

2022-09-14

Added:

- +

2022-07-28

@@ -80,7 +88,7 @@

Added parameters in the following section based on software function changes:

Creating a Cluster

Querying the List of Clusters

-

Querying Cluster Details

+

Querying Cluster Details

2018-11-08

Added parameters in the following section based on software function changes:

Querying the List of Clusters

-

Querying Cluster Details

+

Querying Cluster Details

2018-10-29

@@ -181,7 +189,7 @@

2018-09-04

  • Added the status codes returned by the APIs in each section.
  • Modified the description about the endpoint and actions parameters in the response parameter table. Added the status code returned by the API for querying the list of clusters.

    Querying the List of Clusters

    -
  • Modified the description about the actions parameter in the response parameter table. Added the status code returned by the API for querying details about a cluster.

    Querying Cluster Details

    +
  • Modified the description about the actions parameter in the response parameter table. Added the status code returned by the API for querying details about a cluster.

    Querying Cluster Details

  • Modified the example response. Added the status code returned by the API for deleting a cluster.

    Deleting a Cluster

    -
  • Modified the URI format. Added the status code returned by the API for obtaining the list of instance flavors.

    Obtaining the List of Instance Flavors

    +
  • Modified the URI format. Added the status code returned by the API for obtaining the list of instance flavors.

    Obtaining the List of Instance Flavors

  • Modified the function description. Modify 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 to backupExpectedStartTime, backupKeepDay, and backupPeriod, respectively. 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 to backupExpectedStartTime, backupKeepDay, and backupPeriod, respectively. Modified the example response. Added the status code returned by the API for querying the list of snapshots.

    Querying the List of Snapshots

    diff --git a/docs/css/api-ref/css_03_0025.html b/docs/css/api-ref/css_03_0025.html index 77299238..b2367c45 100644 --- a/docs/css/api-ref/css_03_0025.html +++ b/docs/css/api-ref/css_03_0025.html @@ -102,11 +102,11 @@

    Status Code

    Table 4 describes the status code.

    -
    Table 4 Status code

    Status Code

    +
    - - @@ -115,7 +115,7 @@
    Table 4 Status codes

    Status Code

    Code

    +

    Message

    Status Code Description

    +

    Description

    BadRequest

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    404

    @@ -123,7 +123,7 @@

    NotFound

    The requested resource cannot be found.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    200

    diff --git a/docs/css/api-ref/css_03_0026.html b/docs/css/api-ref/css_03_0026.html deleted file mode 100644 index 8a0ef601..00000000 --- a/docs/css/api-ref/css_03_0026.html +++ /dev/null @@ -1,591 +0,0 @@ - - -

    Querying Cluster Details

    -

    Function

    This API is used to query and display the details of a cluster.

    -
    -

    URI

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

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

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    Project ID. For details, see Obtaining a Project ID and Name.

    -

    cluster_id

    -

    Yes

    -

    String

    -

    ID of the cluster you want to query.

    -
    -
    -
    -

    Request Parameters

    None

    -
    -

    Response Parameters

    Status code: 200

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Response body parameters

    Parameter

    -

    Type

    -

    Description

    -

    datastore

    -

    ClusterDetailDatastore object

    -

    Search engine.

    -

    instances

    -

    Array of ClusterDetailInstances objects

    -

    List of node objects.

    -

    publicKibanaResp

    -

    publicKibanaRespBody object

    -

    Kibana public network access information.

    -

    elbWhiteList

    -

    elbWhiteListResp object

    -

    Public network access information.

    -

    updated

    -

    String

    -

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

    -

    name

    -

    String

    -

    Cluster name

    -

    publicIp

    -

    String

    -

    Public IP address information.

    -

    created

    -

    String

    -

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

    -

    id

    -

    String

    -

    Cluster ID.

    -

    status

    -

    String

    -

    Cluster status.

    -
    • 100: An operation, such as creation, is in progress.
    • 200: Available.
    • 303: Unavailable, for example, due to a creation failure.
    -

    endpoint

    -

    String

    -

    IP address and port number of the user used to access the VPC.

    -

    vpcId

    -

    String

    -

    VPC ID

    -

    subnetId

    -

    String

    -

    Subnet ID

    -

    securityGroupId

    -

    String

    -

    Security group ID.

    -

    vpcepIp

    -

    String

    -

    Endpoint IP address.

    -

    bandwidthSize

    -

    Integer

    -

    Public network bandwidth. Unit: Mbit/s

    -

    httpsEnable

    -

    Boolean

    -

    Communication encryption status.

    -
    • false: Communication encryption is not enabled.
    • true: Communication encryption is enabled.
    -

    diskEncrypted

    -

    Boolean

    -

    Whether disks are encrypted.

    -
    • true: Disks are encrypted.
    • false: Disk are not encrypted.
    -

    authorityEnable

    -

    Boolean

    -

    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 not enabled for the cluster.
    -

    backupAvailable

    -

    Boolean

    -

    Whether the snapshot function is enabled.

    -
    • true: The snapshot function is enabled.
    • false: The snapshot function is disabled.
    -

    actionProgress

    -

    Object

    -

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

    -

    actions

    -

    Array of strings

    -

    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 a snapshot is being created.

    -

    enterpriseProjectId

    -

    String

    -

    ID of the enterprise project that a cluster belongs to.

    -

    If the user of the cluster does not enable the enterprise project, the setting of this parameter is not returned.

    -

    tags

    -

    Array of ClusterDetailTags objects

    -

    Cluster tag.

    -

    failedReason

    -

    ClusterDetailFailedReasons object

    -

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

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 3 ClusterDetailDatastore

    Parameter

    -

    Type

    -

    Description

    -

    type

    -

    String

    -

    Engine type. Currently, only Elasticsearch is supported.

    -

    version

    -

    String

    -

    Version of the CSS cluster engine. For details, see CSS Supported Cluster Versions.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 4 ClusterDetailInstances

    Parameter

    -

    Type

    -

    Description

    -

    status

    -

    String

    -

    Node status value.

    -
    • 100: An operation, such as creation, is in progress.
    • 200: Available.
    • 303: Unavailable, for example, due to a creation failure.
    -

    type

    -

    String

    -

    Type of the current node.

    -

    id

    -

    String

    -

    Instance ID.

    -

    name

    -

    String

    -

    Instance name.

    -

    specCode

    -

    String

    -

    Node specifications.

    -

    azCode

    -

    String

    -

    AZ of a node.

    -

    ip

    -

    String

    -

    Instance IP address.

    -

    volume

    -

    ShowClusterVolumeRsp object

    -

    Instance disk information

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 5 ShowClusterVolumeRsp

    Parameter

    -

    Type

    -

    Description

    -

    type

    -

    String

    -

    Instance disk type

    -

    size

    -

    Integer

    -

    Instance disk size

    -
    -
    - -
    - - - - - - - - - - - - - - - - - -
    Table 6 publicKibanaRespBody

    Parameter

    -

    Type

    -

    Description

    -

    eipSize

    -

    Integer

    -

    Bandwidth range. Unit: Mbit/s

    -

    elbWhiteListResp

    -

    kibanaElbWhiteListResp object

    -

    Kibana public network access information.

    -

    publicKibanaIp

    -

    String

    -

    Specifies the IP address for accessing Kibana.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 7 kibanaElbWhiteListResp

    Parameter

    -

    Type

    -

    Description

    -

    enableWhiteList

    -

    Boolean

    -

    Whether the Kibana access control is enabled.

    -
    • true: Access control is enabled.
    • false: Access control is disabled.
    -

    whiteList

    -

    String

    -

    Whitelist of public network for accessing Kibana.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 8 elbWhiteListResp

    Parameter

    -

    Type

    -

    Description

    -

    enableWhiteList

    -

    Boolean

    -

    Whether the public network access control is enabled.

    -
    • true: Public network access control is enabled.
    • false: Public network access control is disabled.
    -

    whiteList

    -

    String

    -

    Whitelist for public network access.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 9 ClusterDetailTags

    Parameter

    -

    Type

    -

    Description

    -

    key

    -

    String

    -

    Tag key.

    -

    value

    -

    String

    -

    Tag value.

    -
    -
    - -
    - - - - - - - - - - - - - -
    Table 10 ClusterDetailFailedReasons

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Error code.

    -
    • 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

    -

    Error details.

    -
    -
    -
    -

    Example Requests

    None

    -
    -

    Example Responses

    Status code: 200

    -

    Request succeeded.

    -
    {
    -  "datastore" : {
    -    "type" : "elasticsearch",
    -    "version" : "x.x.x"
    -  },
    -  "instances" : [ {
    -    "status" : "200",
    -    "type" : "ess",
    -    "id" : "3c7fe582-a9f6-46fd-9d01-956bed4a8bbc",
    -    "name" : "ES-1-16-test17-ess-esn-1-1",
    -    "specCode" : "css.xlarge.2",
    -    "azCode" : "xx-xxx-xx",
    -    "ip" : "192.168.0.x",
    -    "volume" : {
    -      "type" : "COMMON",
    -      "size" : 40
    -    }
    -  } ],
    -  "publicKibanaResp" : {
    -    "eipSize" : 5,
    -    "publicKibanaIp" : "100.95.158.x",
    -    "elbWhiteListResp" : {
    -      "whiteList" : "11.11.11.11",
    -      "enableWhiteList" : true
    -    }
    -  },
    -  "updated" : "2018-01-16T08:37:18",
    -  "name" : "ES-1-16-test17",
    -  "publicIp" : "100.95.149.xx:9200",
    -  "elbWhiteList" : {
    -    "whiteList" : "10.10.10.10",
    -    "enableWhiteList" : true
    -  },
    -  "created" : "2018-01-16T08:37:18",
    -  "id" : "5c77b71c-5b35-4f50-8984-76387e42451a",
    -  "status" : "200",
    -  "endpoint" : "192.168.0.x:9200",
    -  "vpcId" : "07e7ab39-xxx-xxx-xxx-d3f28ea7f051",
    -  "subnetId" : "025d45f9-xxx-xxx-xxx-e852c6455a5e",
    -  "securityGroupId" : "0347aabc-xxx-xxx-xxx-6b10a79701e2",
    -  "vpcepIp" : "192.168.0.203",
    -  "bandwidthSize" : 0,
    -  "diskEncrypted" : false,
    -  "httpsEnable" : true,
    -  "authorityEnable" : true,
    -  "backupAvailable" : true,
    -  "actionProgress" : { },
    -  "actions" : [ ],
    -  "enterpriseProjectId" : "3e1c74a0-xxx-xxx-xxx-c6b9e46cf81b",
    -  "tags" : [ {
    -    "key" : "k1",
    -    "value" : "v1"
    -  } ]
    -}
    -
    -

    Status Codes

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

    Status Code

    -

    Description

    -

    200

    -

    Request succeeded.

    -

    400

    -

    Invalid request.

    -

    Modify the request before retry.

    -

    404

    -

    The requested resource could not be found.

    -

    Modify the request before retry.

    -
    -
    -
    -
    -
    - -
    - diff --git a/docs/css/api-ref/css_03_0030.html b/docs/css/api-ref/css_03_0030.html index 0bd695c6..7466a020 100644 --- a/docs/css/api-ref/css_03_0030.html +++ b/docs/css/api-ref/css_03_0030.html @@ -7,32 +7,32 @@

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting
    -
    Table 1 Parameter description

    Parameter

    +
    - - - - - - - - - - - @@ -60,6 +60,15 @@ + + + + +
    Table 1 Parameter description

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details, see Obtaining a Project ID and Name.

    +

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

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster where index data is to be backed up.

    +

    ID of the cluster where index data is to be backed up.

    OBS bucket used for index data backup. If there is snapshot data in an OBS bucket, only the OBS bucket is used and cannot be changed.

    basePath

    +

    Yes

    +

    String

    +

    Storage path of the snapshot in the OBS bucket.

    +

    agency

    Yes

    diff --git a/docs/css/api-ref/css_03_0031.html b/docs/css/api-ref/css_03_0031.html index b696e390..0d2f5477 100644 --- a/docs/css/api-ref/css_03_0031.html +++ b/docs/css/api-ref/css_03_0031.html @@ -5,32 +5,32 @@

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
    -
    Table 1 Parameter description

    Parameter

    +
    - - - - - - - - - - - @@ -39,73 +39,75 @@

    Request

    Table 2 describes the request parameters.

    -
    Table 1 Parameter description

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster where automatic snapshot creation is enabled.

    +

    ID of the cluster where automatic snapshot creation is enabled.

    Table 2 Request body parameters

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0032.html b/docs/css/api-ref/css_03_0032.html index 06f66ae7..08c586b7 100644 --- a/docs/css/api-ref/css_03_0032.html +++ b/docs/css/api-ref/css_03_0032.html @@ -95,7 +95,7 @@ -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    indices

    +

    indices

    No

    +

    No

    String

    +

    String

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

    +

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

    prefix

    +

    prefix

    No

    +

    No

    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.

    -
    NOTE:

    This parameter is mandatory when enable is set to true.

    +

    Prefix of automatically generated snapshots. It is manually configured. Enter up to 32 characters and start with a lowercase letter. Lowercase letters, numbers, hyphens (-), and underscores (_) are allowed.

    +
    NOTE:

    This parameter is mandatory when enable is set to true.

    period

    +

    period

    No

    +

    No

    String

    +

    String

    Time when a snapshot is created every day. 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+02:00.

    -
    NOTE:

    This parameter is mandatory when enable is set to true.

    +

    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:

    This parameter is mandatory when enable is set to true.

    keepday

    +

    keepday

    No

    +

    No

    Integer

    +

    Integer

    Snapshot retention period. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. This parameter is mandatory when enable is set to true.

    +

    Number of days that a snapshot can be retained. The value ranges from 1 to 90. The system automatically deletes snapshots that have been retained for the maximum allowed duration on the half hour.

    +
    NOTE:

    This parameter is mandatory when enable is set to true.

    +

    enable

    +

    enable

    Yes

    +

    Yes

    String

    +

    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.
    +

    Indicates whether to enable the automatic snapshot creation policy.

    +
    • true: enabled.
    • false: disabled.

    deleteAuto

    +

    deleteAuto

    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.

    +

    Indicates whether to delete all automatically created snapshots when the automatic snapshot creation policy is disabled. The default value is false and the automatically created snapshots are not deleted when the automatic snapshot creation function is disabled. If this parameter is set to true, all automatically created snapshots are deleted when the automatic snapshot creation policy is disabled.

    String

    Whether to enable the automatic snapshot creation policy.

    +

    Indicates whether to enable the automatic snapshot creation policy.

    snapshotCmkId

    @@ -116,7 +116,7 @@
    {
         "keepday":2,
    -    "period":"16:00 GMT+02:00",
    +    "period":"16:00 GMT+2:00",
         "prefix":"snapshot",
         "bucket":"es-backup",
         "basePath": "css_repository/tests", 
    @@ -127,11 +127,11 @@
     
     

    Status Code

    Table 3 describes the status code.

    -
    Table 3 Status code

    Status Code

    +
    - - @@ -139,7 +139,7 @@ -
    Table 3 Status codes

    Status Code

    Code

    +

    Message

    Status Code Description

    +

    Description

    OK

    The request is processed successfully.

    +

    The request is processed.

    406

    diff --git a/docs/css/api-ref/css_03_0033.html b/docs/css/api-ref/css_03_0033.html index ab578b62..7a593149 100644 --- a/docs/css/api-ref/css_03_0033.html +++ b/docs/css/api-ref/css_03_0033.html @@ -41,9 +41,9 @@
    - - @@ -51,27 +51,27 @@ - - - - - -
    Table 2 Parameter description

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    name

    Yes

    +

    Yes

    String

    +

    String

    Snapshot name. The snapshot name must start with a letter and contains 4 to 64 characters consisting of only lowercase letters, digits, hyphens (-), and underscores (_).

    description

    No

    +

    No

    String

    +

    String

    Description of a snapshot. The value contains 0 to 256 characters, and angle brackets (<) and (>) are not allowed.

    indices

    No

    +

    No

    String

    +

    String

    Name of the index to be backed up. Multiple index names are separated by commas (,). By default, data of all indices is backed up. You can use the asterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then data of indices with the name prefix of 2018-06 will be backed up.

    The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed.

    @@ -145,56 +145,56 @@ }

    Status Code

    Table 5 describes the status code.

    -
    Table 5 Status code

    Status Code

    +
    - - - - - - - - - - - - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0034.html b/docs/css/api-ref/css_03_0034.html index d9e14305..43c2b228 100644 --- a/docs/css/api-ref/css_03_0034.html +++ b/docs/css/api-ref/css_03_0034.html @@ -99,35 +99,35 @@ - - - - -
    Table 5 Status code

    Status Code

    Code

    +

    Code

    Status Code Description

    +

    Status Code Description

    201

    +

    201

    Created

    +

    Created

    The request for creating a resource has been fulfilled.

    +

    The request for creating a resource has been fulfilled.

    500

    +

    500

    InternalServerError

    +

    InternalServerError

    The server is able to receive the request but it could not understand the request.

    +

    The server is able to receive the request but it could not understand the request.

    406

    +

    406

    Not Acceptable

    +

    Not Acceptable

    The server cannot fulfill the request according to the content characteristics of the request.

    +

    The server cannot fulfill the request according to the content characteristics of the request.

    501

    +

    501

    Not Implemented

    +

    Not Implemented

    The server does not support the requested function.

    +

    The server does not support the requested function.

    403

    +

    403

    Forbidden

    +

    Forbidden

    The server understood the request, but is refusing to fulfill it.

    +

    The server understood the request, but is refusing to fulfill it.

    The client should not repeat the request without modifications.

    400

    +

    400

    BadRequest

    +

    BadRequest

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    String

    Cluster ID.

    +

    Cluster ID

    clusterName

    String

    Cluster name.

    +

    Cluster name

    name

    String

    Snapshot name.

    +

    Snapshot name

    status

    String

    Snapshot status.

    +

    Snapshot status

    updated

    String

    Whether the snapshot status is updated.

    +

    Indicates whether the snapshot status is updated

    backupType

    @@ -225,26 +225,26 @@
    -
    Table 4 datastore field data structure description

    Parameter

    +
    - - - - - - - - @@ -257,10 +257,10 @@
    {
        "backups": [
         {
    -      "created": "2021-03-07T07:34:47",
    +      "created": "2018-03-07T07:34:47",
           "datastore": {
             "type": "elasticsearch",
    -        "version": "7.6.2"
    +        "version": "*.*.*"
           },
           "description": "",
           "id": "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9",
    @@ -268,7 +268,7 @@
           "clusterName": "Es-xfx",
           "name": "snapshot-002",
           "status": "COMPLETED",
    -      "updated": "2021-03-07T07:40:12",
    +      "updated": "2018-03-07T07:40:12",
           "backupType": "1",
           "backupMethod": "manual",
           "backupExpectedStartTime": null,
    @@ -277,17 +277,17 @@
           "indices": ".kibana,website2",
           "totalShards": 6,
           "failedShards": 0,
    -      "version": "7.6.2",
    +      "version": "6.2.3",
           "restoreStatus": "success",
           "startTime": 1520408087099,
           "endTime": 1520408412219,
           "bucketName": "obs-b8ed"
         },
         {
    -      "created": "2021-03-06T15:42:37",
    +      "created": "2018-03-06T15:42:37",
           "datastore": {
             "type": "elasticsearch",
    -        "version": "7.6.2"
    +        "version": "6.2.3"
           },
           "description": "",
           "id": "29a2254e-947f-4463-b65a-5f0b17515fae",
    @@ -295,7 +295,7 @@
           "clusterName": "Es-xfx",
           "name": "snapshot-001",
           "status": "COMPLETED",
    -      "updated": "2021-03-06T15:48:04",
    +      "updated": "2018-03-06T15:48:04",
           "backupType": "1",
           "backupMethod": "manual",
           "backupExpectedStartTime": null,
    @@ -304,7 +304,7 @@
           "indices": ".kibana",
           "totalShards": 1,
           "failedShards": 0,
    -      "version": "7.6.2",
    +      "version": "6.2.3",
           "restoreStatus": "none",
           "startTime": 1520350957275,
           "endTime": 1520351284357,
    @@ -315,11 +315,11 @@
     
     

    Status Code

    Table 5 describes the status code.

    -
    Table 4 datastore field data structure description

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    type

    +

    type

    String

    +

    String

    Supported type: elasticsearch

    +

    Supported type: elasticsearch

    version

    +

    version

    String

    +

    String

    Engine version number.

    +

    Engine version number.

    Table 5 Status code

    Status Code

    +
    - - diff --git a/docs/css/api-ref/css_03_0035.html b/docs/css/api-ref/css_03_0035.html index 75a51bb5..0b8404bf 100644 --- a/docs/css/api-ref/css_03_0035.html +++ b/docs/css/api-ref/css_03_0035.html @@ -134,7 +134,7 @@ -
    Table 5 Status codes

    Status Code

    Code

    +

    Message

    Status Code Description

    +

    Description

    BadRequest

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    403

    diff --git a/docs/css/api-ref/css_03_0036.html b/docs/css/api-ref/css_03_0036.html index 73633ab1..d22a6f77 100644 --- a/docs/css/api-ref/css_03_0036.html +++ b/docs/css/api-ref/css_03_0036.html @@ -75,7 +75,7 @@

    BadRequest

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    403

    diff --git a/docs/css/api-ref/css_03_0037.html b/docs/css/api-ref/css_03_0037.html index 50962ce3..60fc99a8 100644 --- a/docs/css/api-ref/css_03_0037.html +++ b/docs/css/api-ref/css_03_0037.html @@ -1,7 +1,7 @@

    (Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot

    -

    The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapthos. If you have multiple clusters, an OBS bucket will be created for each cluster via this API during automatic configuration and consume your OBS quota. Too many OBS buckets will be difficult to manage. You are advised to perform operations in Modifying Basic Configurations of a Cluster Snapshot.

    +

    The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapshots. If you have multiple clusters, an OBS bucket will be created for each cluster via this API during automatic configuration and consume your OBS quota. Too many OBS buckets will be difficult to manage. You are advised to perform operations in Modifying Basic Configurations of a Cluster Snapshot.

    Function

    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 OBS bucket used for storing snapshots.
    • IAM Agency: Authorize you to use OBS in IAM so that snapshots must be stored in OBS.
    @@ -24,7 +24,7 @@

    String

    Project ID. For details, see Obtaining a Project ID and Name.f

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    diff --git a/docs/css/api-ref/css_03_0038.html b/docs/css/api-ref/css_03_0038.html index 1f573776..df7807ed 100644 --- a/docs/css/api-ref/css_03_0038.html +++ b/docs/css/api-ref/css_03_0038.html @@ -5,32 +5,32 @@

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/role_extend
    -
    Table 1 Parameter description

    Parameter

    +
    - - - - - - - - - - - @@ -105,21 +105,21 @@
    Table 1 Parameter description

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    String

    +

    String

    Project ID. For details, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster to be scaled out.

    +

    ID of the cluster to be scaled out.

    -

    Response

    Table 4 describes the response parameters.

    +

    Response Parameters

    Table 4 describes the response parameters.

    -
    Table 4 Parameter description

    Parameter

    +
    - - - - - @@ -154,11 +154,11 @@

    Status Code

    Table 5 describes the status code.

    -
    Table 4 Parameter description

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Cluster ID.

    +

    Cluster ID.

    Table 5 Status code

    Status Code

    +
    - - @@ -167,7 +167,7 @@
    Table 5 Status codes

    Status Code

    Code

    +

    Message

    Status Code Description

    +

    Description

    BadRequest

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    404

    @@ -175,7 +175,7 @@

    NotFound

    The requested resource cannot be found.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    200

    diff --git a/docs/css/api-ref/css_03_0039.html b/docs/css/api-ref/css_03_0039.html index f862a871..ab67cc3b 100644 --- a/docs/css/api-ref/css_03_0039.html +++ b/docs/css/api-ref/css_03_0039.html @@ -46,11 +46,11 @@

    Status Code

    Table 2 describes the status code.

    -
    Table 2 Status code

    Status Code

    +
    - - diff --git a/docs/css/api-ref/css_03_0050.html b/docs/css/api-ref/css_03_0050.html index feccd653..2eaded4c 100644 --- a/docs/css/api-ref/css_03_0050.html +++ b/docs/css/api-ref/css_03_0050.html @@ -1,7 +1,7 @@ -

    Downloading a Certificate File

    -

    Function

    This API is used to download the HTTPS certificate file of the server.

    +

    Downloading the Certificate

    +

    Function

    This API is used to download the HTTPS certificate of the server.

    URI

    GET /v1.0/dev/cluster/sslCert
    @@ -37,11 +37,11 @@
    echo -n "MIIDnTCCAoWgAwIBAgIEXXdMtTANBgkqhkiG9w0BAQsFADB/MRAwDgYDVQQGEwdHZXJtYW55MQ0wCwYDVQQIEwROb25lMQ0wCwYDVQQHEwROb25lMRkwFwYDVQQKExBPcGVuVGVsZWtvbUNsb3VkMRUwEwYDVQQLEwxEYXRhQW5hbHlzaXMxGzAZBgNVBAMTEkNsb3VkU2VhcmNoU2VydmljZTAeFw0xODExMTcxODE4NDJaFw0xOTAyMTUxODE4NDJaMH8xEDAOBgNVBAYTB0dlcm1hbnkxDTALBgNVBAgTBE5vbmUxDTALBgNVBAcTBE5vbmUxGTAXBgNVBAoTEE9wZW5UZWxla29tQ2xvdWQxFTATBgNVBAsTDERhdGFBbmFseXNpczEbMBkGA1UEAxMSQ2xvdWRTZWFyY2hTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApHai9+LMoFSlWqI+YodGiFLw597Vuoo7gG3qTCs+szQTn3PTZtbnzy7TNWjn8K41mkBgUY16wtkhH1nu6AmhRLpZA+2fwAz34v/tDOYahPq045bk9S/znJXQeWWeux93I15z7OP/XC68IF2AKl2NXjmm9bAD/DsqaLuJpoE77d71862sD6uRCBQYyZoQaHw+eKuL8/+5PjWvG9mS+Rxp0DcLd1waFkyK4BjB5Ae3og4bAivKo7vQHH79fgnuK0SQnNpxlU8xLIGaKsQ0/yeJrTrlfy3vBQmj949SbCzFjvmXgkbv4I0jcT5Ax1P68tlasUUnCqFTjGTbzeT82CeE6QIDAQABoyEwHzAdBgNVHQ4EFgQUPPZLu9ElUzQgKURRwn8HpzIliEcwDQYJKoZIhvcNAQELBQADggEBAI/e/sGbZ1jB3ao7Car2p7rm1Pg8ro1kSy9o+Jug6XjJpkwITKGkhPYugtGuKgL6oiYkdJhqmfrm/1R7phf1qzBgRoWtR7eCBg4uorNaYvTelAjbIoYGL03D1c5K6e1XwRsdqNWT3TwiHZ5CuiVOsjAtvt3OrvF2YtPUOJpbbvdXlnLKaLHoaklcyyMJ+KmUbkd2XFhzlhwj4eOaloL8XQcAk/urYFFNTymJPnNiEXjLAgGCfE/j8rX26WKvPUGmcuuqBiK7Ob+VfnfpnssDQoBtQsN9eUNxkYkg6eua8U6zR3nSPxXpdn+TZo3HHnUp3x0f1Xev49MHKe/aPMJOTYE=" | base64 -d > CloudSearchService.cert

    Status Code

    -
    Table 2 Status codes

    Status Code

    Code

    +

    Message

    Status Code Description

    +

    Description

    Table 2 Status code

    Status Code

    +
    - - @@ -50,7 +50,7 @@ - diff --git a/docs/css/api-ref/css_03_0051.html b/docs/css/api-ref/css_03_0051.html index c3b2f383..cba93f16 100644 --- a/docs/css/api-ref/css_03_0051.html +++ b/docs/css/api-ref/css_03_0051.html @@ -2,7 +2,7 @@

    Overview

    Welcome to Cloud Search Service API Reference. Cloud Search Service (CSS) provides hosted, distributed search engine services. It is fully compatible with open-source Elasticsearch and supports multi-condition retrieval, statistics, and reporting of structured and unstructured texts.

    -

    This document provides CSS API description, syntax, parameters, and examples. CSS provides APIs for cluster management and snapshot management. You can call these APIs to easily create, query, delete, restart, and scale clusters.

    +

    This document provides CSS API description, syntax, parameters, and examples. CSS provides APIs for cluster management and snapshot management. You can call these APIs to easily create, query, delete, restart, and scale clusters.

    - - - - - - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0065.html b/docs/css/api-ref/css_03_0065.html index 6d640042..fbde0063 100644 --- a/docs/css/api-ref/css_03_0065.html +++ b/docs/css/api-ref/css_03_0065.html @@ -1,14 +1,14 @@

    Permissions Policies and Supported Actions

    -

    This section describes fine-grained permissions management for your CSS. If your account does not need individual IAM users, then you may skip over this chapter.

    +

    This section describes fine-grained permissions management for your CSS. If your cloud account does not need individual IAM users, then you may skip over this chapter.

    By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign permissions policies to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.

    -

    You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

    +

    You can grant permissions to a role or by creating a policy. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

    Policy-based authorization is useful if you want to allow or deny the access to an API.

    An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully.

    Supported Actions

    CSS provides system-defined policies that can be directly used in IAM. CSS administrators can create custom policies and use them to supplement system-defined policies, implementing more refined access control. Actions supported by policies are specific to APIs. The following are common concepts related to policies:

    -
    • Permissions: Allow or deny operations on specified resources under specific conditions.
    • APIs: REST APIs that can be called by a custom policy.
    • Actions: added to a custom policy to control permissions for specific operations.
    • Related actions: actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the dependent actions.
    • IAM or enterprise projects: type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM.

      The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.

      +
      • Permissions: Allow or deny operations on specified resources under specific conditions.
      • APIs: REST APIs that can be called by a custom policy.
      • Actions: added to a custom policy to control permissions for specific operations.
      • Dependencies: actions which a specific action depends on. When allowing an action for a user, you also need to allow any existing action dependencies for that user.
      • IAM or enterprise projects: type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM.

        The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.

    Table 2 Status codes

    Status Code

    Code

    +

    Message

    Status Code Description

    +

    Description

    BadRequest

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    404

    @@ -58,14 +58,14 @@

    NotFound

    The requested resource cannot be found.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    200

    OK

    The request is processed successfully.

    +

    The request is processed.

    Cluster Management APIs

    +

    Cluster management APIs

    You can use cluster management APIs to create clusters, scale out a cluster, view cluster details, and obtain instance specifications.

    +

    You can call APIs to create clusters, scale out a cluster, view cluster details, and obtain instance specifications.

    Kibana Public Network Access APIs

    +

    Log management APIs

    These APIs are used to enable, disable, and modify Kibana public access for a cluster in security mode.

    +

    You can call APIs to enable, disable, modify, and query logs.

    Log Management APIs

    +

    Public network access APIs

    These APIs are used to enable, disable, modify, and query logs.

    +

    You can call APIs to enable, disable, and modify public network access of a cluster.

    Public Network Access APIs

    +

    Snapshot management APIs

    These APIs are used to enable, disable, and modify the public network access of a cluster.

    +

    Snapshots can be used to back up and restore data. You can call APIs to create, restore, or delete a snapshot.

    Snapshot Management APIs

    +

    VPC endpoint APIs

    Snapshots can be used to back up and restore data. You can use snapshot management APIs to create, restore, or delete a snapshot.

    +

    You can call APIs to enable, disable, obtain, and update VPC endpoint connections.

    VPC Endpoint APIs

    +

    Parameter configuration APIs

    These APIs can be used to enable, disable, obtain, and update VPC endpoint connections.

    -

    Parameter Configuration APIs

    -

    These APIs can be used to modify the parameter configurations of a cluster.

    +

    You can call APIs to modify the parameter configurations of a cluster.

    Table 1 API actions

    Permission

    @@ -16,7 +16,7 @@

    API

    Action

    -

    +

    IAM Project

    (Project)

    diff --git a/docs/css/api-ref/css_03_0078.html b/docs/css/api-ref/css_03_0078.html index 563b2441..6861d524 100644 --- a/docs/css/api-ref/css_03_0078.html +++ b/docs/css/api-ref/css_03_0078.html @@ -117,7 +117,7 @@

    BadRequest

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    404

    @@ -125,7 +125,7 @@

    NotFound

    The requested resource cannot be found.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    200

    diff --git a/docs/css/api-ref/css_03_0079.html b/docs/css/api-ref/css_03_0079.html index 09cad298..78fd3850 100644 --- a/docs/css/api-ref/css_03_0079.html +++ b/docs/css/api-ref/css_03_0079.html @@ -114,7 +114,7 @@

    BadRequest

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    404

    @@ -122,7 +122,7 @@

    NotFound

    The requested resource cannot be found.

    -

    The client should not repeat the request without modifications.

    +

    Modify the request instead of retrying.

    200

    diff --git a/docs/css/api-ref/css_03_0081.html b/docs/css/api-ref/css_03_0081.html index ac890ce3..7d49b490 100644 --- a/docs/css/api-ref/css_03_0081.html +++ b/docs/css/api-ref/css_03_0081.html @@ -11,7 +11,7 @@

    URI

    POST /v1.0/{project_id}/css-cluster/{cluster_id}/tags/action
    -
    Table 1 Parameters

    Parameter

    +
    @@ -27,7 +27,7 @@ - - @@ -134,7 +134,7 @@
    • Response example

      None

    -

    Status Code

    Table 4 describes status codes.

    +

    Status Code

    Table 4 describes the status code.

    Table 1 Parameter description

    Parameter

    Mandatory

    String

    Project ID. For details, see Obtaining a Project ID and Name.

    +

    Project ID For details, see Obtaining a Project ID and Name.

    cluster_id

    @@ -36,7 +36,7 @@

    String

    IDs of clusters to which tags are to be added or deleted in batches.

    +

    IDs of clusters to which tags are to be added or deleted in batches

    @@ -149,7 +149,7 @@
    Table 4 Status code

    Status Code

    BadRequest

    Invalid request.

    -

    Do not retry the request before modification.

    +

    Modify the request instead of retrying.

    404

    @@ -157,7 +157,7 @@

    NotFound

    The requested resource cannot be found.

    -

    Do not retry the request before modification.

    +

    Modify the request instead of retrying.

    204

    diff --git a/docs/css/api-ref/css_03_0082.html b/docs/css/api-ref/css_03_0082.html index 1747b46c..b5511e52 100644 --- a/docs/css/api-ref/css_03_0082.html +++ b/docs/css/api-ref/css_03_0082.html @@ -1,11 +1,11 @@ -

    Deleting Specified Cluster Tags

    +

    Deleting Specified Cluster Tags

    Function

    This API is used to delete specified cluster tags.

    URI

    DELETE /v1.0/{project_id}/css-cluster/{cluster_id}/tags/{key}
    -
    Table 1 Parameters

    Parameter

    +
    @@ -21,8 +21,7 @@ - -
    Table 1 Parameter description

    Parameter

    Mandatory

    String

    Project ID.

    -

    For details, see Obtaining a Project ID and Name.

    +

    Project ID For details, see Obtaining a Project ID and Name.

    cluster_id

    @@ -31,7 +30,7 @@

    String

    ID of the cluster to which a tag is to be deleted.

    +

    ID of the cluster to which a tag is to be deleted

    key

    @@ -56,11 +55,11 @@
  • Response example

    None

  • -

    Status Code

    Table 2 describes status codes.

    +

    Status Codes

    Table 2 describes the status code.

    -
    Table 2 Status code

    Status Code

    +
    - @@ -71,7 +70,7 @@ - diff --git a/docs/css/api-ref/css_03_0083.html b/docs/css/api-ref/css_03_0083.html index 4bfc5519..a8ffe69d 100644 --- a/docs/css/api-ref/css_03_0083.html +++ b/docs/css/api-ref/css_03_0083.html @@ -5,7 +5,7 @@

    URI

    POST /v1.0/{project_id}/css-cluster/{cluster_id}/tags
    -
    Table 2 Status codes

    Status Code

    Encoding

    +

    Message

    Description

    BadRequest

    Invalid request.

    -

    Do not retry the request before modification.

    +

    Modify the request instead of retrying.

    404

    @@ -79,14 +78,14 @@

    NotFound

    The requested resource cannot be found.

    -

    Do not retry the request before modification.

    +

    Modify the request instead of retrying.

    204

    OK

    The request is processed successfully.

    +

    The request is processed.

    Table 1 Parameters

    Parameter

    +
    @@ -21,7 +21,7 @@ - - @@ -84,11 +84,11 @@
  • Example response

    None

  • -

    Status Code

    Table 3 describes status codes.

    +

    Status Codes

    Table 3 describes the status code.

    -
    Table 1 Parameter description

    Parameter

    Mandatory

    String

    Project ID. For details, see Obtaining a Project ID and Name.

    +

    Project ID For details, see Obtaining a Project ID and Name.

    cluster_id

    @@ -30,7 +30,7 @@

    String

    ID of the cluster to which a tag is to be added.

    +

    ID of the cluster to which a tag is to be added

    Table 3 Status code

    Status Code

    +
    - @@ -99,7 +99,7 @@ - diff --git a/docs/css/api-ref/css_03_0084.html b/docs/css/api-ref/css_03_0084.html index fa4e42e7..da0549cf 100644 --- a/docs/css/api-ref/css_03_0084.html +++ b/docs/css/api-ref/css_03_0084.html @@ -1,101 +1,101 @@ -

    Renaming a Cluster

    -

    Function

    This API is used to change the password of a cluster.

    +

    Changing a Cluster Name

    +

    Function

    This API is used to change the name of a cluster.

    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset

    +

    URI

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

    -
    Table 3 Status codes

    Status Code

    Encoding

    +

    Message

    Description

    BadRequest

    Invalid request.

    -

    Do not retry the request before modification.

    +

    Modify the request instead of retrying.

    404

    @@ -107,14 +107,14 @@

    NotFound

    The requested resource cannot be found.

    -

    Do not retry the request before modification.

    +

    Modify the request instead of retrying.

    204

    OK

    The request is processed successfully.

    +

    The request is processed.

    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.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster whose password you want to change.

    +

    ID of the cluster that you want to rename

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    newpassword

    +

    displayName

    Yes

    +

    Yes

    String

    +

    String

    Password of the cluster user admin in security mode. This API is available only if authorityEnable is set to true.- Must contain 8 to 32 characters.- Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^&*()-_=+\|[{}];:,<.>/?).

    +

    New cluster name

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    {
    -  "newpassword" : "xxxxxx"
    +

    Request Example

    {
    +  "displayName" : "ES-Test-new"
     }
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0085.html b/docs/css/api-ref/css_03_0085.html deleted file mode 100644 index 05084282..00000000 --- a/docs/css/api-ref/css_03_0085.html +++ /dev/null @@ -1,111 +0,0 @@ - - -

    Changing the Password of a Cluster

    -

    Function

    This API is used to change the password of a cluster.

    -
    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset

    - -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    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 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 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 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 whose password you want to change.

    -
    -
    -
    -

    Request Parameters

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

    Parameter

    -

    Mandatory

    -

    Type

    -

    Description

    -

    newpassword

    -

    Yes

    -

    String

    -

    Password of the cluster user admin in security mode. This API is available only if authorityEnable is set to true.- Must contain 8 to 32 characters.- Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^&*()-_=+\|[{}];:,<.>/?).

    -
    -
    -
    -

    Response Parameters

    None

    -
    -

    Example Requests

    {
    -  "newpassword" : "xxxxxx"
    -}
    -
    -

    Example Responses

    None

    -
    -

    Status Codes

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

    Status Code

    -

    Description

    -

    200

    -

    Request succeeded.

    -

    400

    -

    Invalid request.

    -

    Modify the request before retry.

    -

    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.

    -

    412

    -

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

    -
    -
    -
    - -
    - -
    - diff --git a/docs/css/api-ref/css_03_0086.html b/docs/css/api-ref/css_03_0086.html index e8934ec6..d933b544 100644 --- a/docs/css/api-ref/css_03_0086.html +++ b/docs/css/api-ref/css_03_0086.html @@ -1,112 +1,120 @@ -

    Changing Specifications

    -

    Function

    This API is used to modify the specifications of a cluster. Only the nodes of the ESS type can be modified.

    +

    Modifying Cluster Specifications

    +

    Function

    This API is used to modify the specifications of a cluster. Only the specifications of ESS nodes can be modified.

    -

    URI

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

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster whose specifications you want to change.

    +

    ID of the cluster that you want to modify specifications

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    needCheckReplica

    +

    needCheckReplica

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to check replicas. The value can be true or false. The check is enabled by default.

    -
    • true: Replicas are checked.
    • false: Replicas are not checked.
    +

    Indicates whether to verify replicas. Its value can be true or false. Replica verification is enabled by default.

    +
    • true: Replica verification is enabled.
    • false: Replica verification is disabled.

    newFlavorId

    +

    newFlavorId

    Yes

    +

    Yes

    String

    +

    String

    ID of the new flavor. This parameter is obtained by calling the Obtaining the List of Instance Flavors API. The API compares the values of the name attribute and obtains the ID of the flavor higher than the current flavor. Only the node specifications of the same Elasticsearch engine version can be changed.

    +

    ID of the new flavor. This parameter is obtained by calling the Obtaining the Instance Specifications List API. The API compares the values of the name attribute and obtains the ID of the flavor higher than the current flavor. Only the node specifications of the same Elasticsearch engine version can be changed.

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    {
    +

    Request Example

    • {
      +  "needCheckReplica" : false,
      +  "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2",
      +  "isAutoPay" : 1
      +}
      +
    • {
         "needCheckReplica" : false,
         "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2"
       }
      +
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0087.html b/docs/css/api-ref/css_03_0087.html index a2cda68d..3abfca23 100644 --- a/docs/css/api-ref/css_03_0087.html +++ b/docs/css/api-ref/css_03_0087.html @@ -1,124 +1,133 @@

    Changing the Specifications of a Specified Node Type

    -

    Function

    This API is used to modify cluster specifications. The following node types can be changed:

    -
    • ess: data node
    • ess-cold: cold data node
    • ess-client: client node
    • ess-master: master node
    +

    Function

    This API is used to change the specifications of a specified node type. The following node types are supported:

    +
    • ess: data node
    • ess-cold: cold data node
    • ess-client: client node
    • ess-master: master node
    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/{types}/flavor

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/{types}/flavor

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    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 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 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 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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster whose specifications you want to change.

    +

    ID of the cluster that you want to modify specifications

    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
    +

    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
    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    needCheckReplica

    +

    needCheckReplica

    No

    +

    No

    Boolean

    +

    Boolean

    Whether to check replicas. The value can be true or false. The check is enabled by default.

    -
    • true: Replicas are checked.
    • false: Replicas are not checked.
    -

    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.

    +

    Indicates whether to verify replicas. Its value can be true or false. Replica verification is enabled by default.

    +
    • true: Replica verification is enabled.
    • false: Replica verification is disabled.
    +
    NOTE:

    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.

    +

    newFlavorId

    +

    newFlavorId

    Yes

    +

    Yes

    String

    +

    String

    ID of the new flavor. This parameter is obtained by calling the Obtaining the List of Instance Flavors API. The API compares the values of the name attribute and obtains the ID of the flavor higher than the current flavor. Only the node specifications of the same Elasticsearch engine version can be changed.

    +

    ID of the new flavor. This parameter is obtained by calling the Obtaining the Instance Specifications List API. The API compares the values of the name attribute and obtains the ID of the flavor higher than the current flavor. Only the node specifications of the same Elasticsearch engine version can be changed.

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    {
    +

    Request Example

    • {
      +  "needCheckReplica" : false,
      +  "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2",
      +  "isAutoPay" : 1
      +}
      +
    • {
         "needCheckReplica" : false,
         "newFlavorId" : "35b060a4-f152-48ce-8773-36559ceb81f2"
       }
      +
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0088.html b/docs/css/api-ref/css_03_0088.html index d00675fb..5916c84d 100644 --- a/docs/css/api-ref/css_03_0088.html +++ b/docs/css/api-ref/css_03_0088.html @@ -1,101 +1,104 @@ -

    Scaling In a Cluster by Removing a Specific Node

    -

    Function

    This API is used to scale in a cluster by removing a specified node.

    +

    Scaling in a Cluster By Removing Specified Nodes

    +

    Function

    This API is used to scale in a cluster by removing specified nodes. Yearly/Monthly clusters do not support the removal of specified nodes by calling this API.

    -

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/node/offline

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

    POST /v1.0/{project_id}/clusters/{cluster_id}/node/offline

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    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 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 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 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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster you want to scale in.

    +

    ID of the cluster you want to scale in

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    shrinkNodes

    +

    shrinkNodes

    Yes

    +

    Yes

    Array of strings

    +

    Array of strings

    ID of the node you want to remove from a cluster.

    +

    ID of the node you want to remove.

    +

    Obtain the ID attribute in instances by referring to Querying Cluster Details.

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    {
    +

    Request Example

    {
       "shrinkNodes" : [ "2077bdf3-b90d-412e-b460-635b9b159c11" ]
     }
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0089.html b/docs/css/api-ref/css_03_0089.html index a31aea11..415e7ab5 100644 --- a/docs/css/api-ref/css_03_0089.html +++ b/docs/css/api-ref/css_03_0089.html @@ -1,138 +1,143 @@ -

    Scaling In Nodes of a Specific Type

    -

    Function

    This API is used to remove instances of different types and reduce instance storage capacity in a cluster.

    +

    Removing Nodes of a Specific Type

    +

    Function

    This API is used to remove instances of specific types and reduce instance storage capacity in a cluster.

    -

    URI

    POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

    POST /v1.0/extend/{project_id}/clusters/{cluster_id}/role/shrink

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    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 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 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 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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster you want to scale in.

    +

    ID of the cluster you want to scale in

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    shrink

    +

    shrink

    Yes

    +

    Yes

    Array of ShrinkNodeReq objects

    +

    Array of ShrinkNodeReq objects

    Type and quantity of nodes you want to remove from a cluster.

    +

    Type and quantity of nodes you want to remove

    -
    Table 3 ShrinkNodeReq

    Parameter

    +
    - - - - - - - - - - -
    Table 3 ShrinkNodeReq

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    reducedNodeNum

    +

    reducedNodeNum

    Yes

    +

    Yes

    Integer

    +

    Integer

    Number of nodes you want to remove from a cluster.

    -
    • 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 the same type nodes in different AZs cannot exceed 1.
    • For a cluster without 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 original data node number, 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 original master node number. After scale-in, there has to be an odd number of master nodes, and there has to be at least three of them.
    +

    Number of nodes you want to remove.

    +

    - 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 the 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 original data node number, 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 original master node number. After scale-in, there has to be an odd number of master nodes, and there has to be at least three of them.

    type

    +

    type

    Yes

    +

    Yes

    String

    +

    String

    Node type.

    -
    • ess: data node
    • ess-cold: cold data node
    • ess-client: client node
    • ess-master: master node
    +

    Node type.

    +
    • ess: data node
    • ess-cold: cold data node
    • ess-client: Client node
    • ess-master: Master node
    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    {
    +

    Request Example

    {
       "shrink" : [ {
         "type" : "ess",
         "reducedNodeNum" : 1
       } ]
     }
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0090.html b/docs/css/api-ref/css_03_0090.html index 9ce78b57..e5e48e13 100644 --- a/docs/css/api-ref/css_03_0090.html +++ b/docs/css/api-ref/css_03_0090.html @@ -1,81 +1,83 @@

    Replacing a Node

    -

    Function

    This API is used to replace a failed node.

    +

    Function

    This API is used to replace a failed node.

    -

    URI

    PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replace

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

    PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replace

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    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 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 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 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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster where nodes are to be replaced

    +

    ID of the cluster where nodes are to be replaced

    instance_id

    +

    instance_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the node to be replaced

    +

    ID of the node to be replaced

    -

    Request Parameters

    None

    +

    Request Parameters

    None

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replace
    +

    Request Example

    PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replace
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - diff --git a/docs/css/api-ref/css_03_0091.html b/docs/css/api-ref/css_03_0091.html index 30a5a585..32262c21 100644 --- a/docs/css/api-ref/css_03_0091.html +++ b/docs/css/api-ref/css_03_0091.html @@ -1,89 +1,91 @@ -

    Configuring the Security Mode.

    -

    Function

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

    +

    Changing the Security Mode

    +

    Function

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

    -

    URI

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

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

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

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

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

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    404

    +

    404

    The requested resource could not be found.

    -

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

    +

    The requested resource cannot be found.

    +

    Modify the request instead of retrying.

    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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    Cluster ID.

    +

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

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - - - - - -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    authorityEnable

    +

    authorityEnable

    Yes

    +

    Yes

    Boolean

    +

    Boolean

    Security mode. Its value can be:

    -
    • true: enabled
    • false: disabled Default value: true
    +

    Indicates whether to enable the security mode.

    +
    • true: enabled.
    • false: disabled. The default value is true.

    adminPwd

    +

    adminPwd

    No

    +

    No

    String

    +

    String

    Cluster password in security mode.

    +

    Cluster password in security mode

    httpsEnable

    +

    httpsEnable

    Yes

    +

    Yes

    Boolean

    +

    Boolean

    Enable HTTPS. Its value can be:

    -
    • true: enabled
    • false: disabled Default value: true
    +

    Indicates whether to enable HTTPS. Its value can be:

    +
    • true: enabled.
    • false: disabled. The default value is true.
    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

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

    Request Example

    POST /v1.0/{project_id}/clusters/{cluster_id}/mode/change
     
     {
       "authorityEnable" : true,
    @@ -91,30 +93,30 @@
       "httpsEnable" : true
     }
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - diff --git a/docs/css/api-ref/css_03_0092.html b/docs/css/api-ref/css_03_0092.html index 50701181..928c97e5 100644 --- a/docs/css/api-ref/css_03_0092.html +++ b/docs/css/api-ref/css_03_0092.html @@ -1,97 +1,99 @@

    Changing the Security Group

    -

    Function

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

    +

    Function

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

    -

    URI

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

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

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

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    404

    +

    404

    The requested resource could not be found.

    -

    Modify the request before retry.

    +

    The requested resource cannot be found.

    +

    Modify the request instead of retrying.

    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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    Cluster ID.

    +

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

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    security_group_ids

    +

    security_group_ids

    Yes

    +

    Yes

    String

    +

    String

    Security group ID.

    +

    Security group ID

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

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

    Request Example

    POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/sg/change
     
     {
       "security_group_ids" : "b1038649-1f77-4ae9-b64d-9af56e42xxxx"
     }
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - diff --git a/docs/css/api-ref/css_03_0093.html b/docs/css/api-ref/css_03_0093.html index 422471e0..53880aeb 100644 --- a/docs/css/api-ref/css_03_0093.html +++ b/docs/css/api-ref/css_03_0093.html @@ -12,7 +12,7 @@ - @@ -24,7 +24,7 @@ - diff --git a/docs/css/api-ref/css_03_0094.html b/docs/css/api-ref/css_03_0094.html index 0ea2d446..8f9398ad 100644 --- a/docs/css/api-ref/css_03_0094.html +++ b/docs/css/api-ref/css_03_0094.html @@ -1,121 +1,123 @@

    Enabling the Log Function

    -

    Function

    This API is used to enable the log function.

    +

    Function

    This API is used to enable the log function.

    -

    URI

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

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

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

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

    The client should not repeat the request without modifications.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    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.

    +

    The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry 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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster whose log function you want to enable.

    +

    ID of the cluster that you want to enable the log function

    -

    Request Parameters

    -
    Table 2 Request body parameters

    Parameter

    +

    Request Parameters

    +
    - - - - - - - - - - - - - - -
    Table 2 Request body parameter

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    agency

    +

    agency

    Yes

    +

    Yes

    String

    +

    String

    Agency name. You can create an agency to allow CSS to call other cloud services.

    +

    Agency name. You can create an agency to allow CSS to call other cloud services.

    logBasePath

    +

    logBasePath

    Yes

    +

    Yes

    String

    +

    String

    Storage path of backed up logs in the OBS bucket.

    +

    Storage path of backup logs in the OBS bucket

    logBucket

    +

    logBucket

    Yes

    +

    Yes

    String

    +

    String

    Name of the OBS bucket for storing logs.

    +

    Name of the OBS bucket for storing logs

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    {
    +

    Request Example

    {
       "agency" : "css_obs_agency",
       "logBasePath" : "css/log",
       "logBucket" : "000-words"
     }
    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0095.html b/docs/css/api-ref/css_03_0095.html index 9d53889a..8e5acced 100644 --- a/docs/css/api-ref/css_03_0095.html +++ b/docs/css/api-ref/css_03_0095.html @@ -1,77 +1,79 @@

    Disabling the Log Function

    -

    Function

    This API is used to disable the log function.

    +

    Function

    This API is used to disable the log function.

    -

    URI

    PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/close

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

    PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/close

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    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 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 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 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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster whose log function you want to disable.

    +

    ID of the cluster that you want to disable the log function

    -

    Request Parameters

    None

    +

    Request Parameters

    None

    -

    Response Parameters

    None

    +

    Response Parameters

    None

    -

    Example Requests

    None

    +

    Request Example

    None

    -

    Example Responses

    None

    +

    Response Example

    None

    -

    Status Codes

    -

    Status Code

    +

    Status Codes

    +
    - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0096.html b/docs/css/api-ref/css_03_0096.html index 50e57086..cb2319b1 100644 --- a/docs/css/api-ref/css_03_0096.html +++ b/docs/css/api-ref/css_03_0096.html @@ -1,187 +1,138 @@ -

    Querying the Job List

    -

    Function

    This API is used to query the job list in the logs of a cluster.

    +

    Viewing the Job List

    +

    Function

    This API is used to query the job list in the logs of a cluster.

    -

    URI

    GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

    GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records

    -

    Status Code

    Description

    +

    Description

    200

    +

    200

    Request succeeded.

    +

    The request is processed successfully.

    400

    +

    400

    Invalid request.

    -

    Modify the request before retry.

    +

    Invalid request.

    +

    Modify the request instead of retrying.

    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 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 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 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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster you want to query.

    +

    ID of the cluster to be queried

    -

    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 parameter

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    clusterLogRecord

    +

    clusterLogRecord

    Array of clusterLogRecord objects

    +

    Array of clusterLogRecord objects

    Cluster log entity object.

    +

    Entity object of cluster log records

    -
    Table 3 clusterLogRecord

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 clusterLogRecord

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Log task ID, which is generated based on the system UUID.

    +

    Log task ID, which is generated based on the system UUID.

    clusterId

    +

    clusterId

    String

    +

    String

    Cluster ID.

    +

    Cluster ID

    createAt

    +

    createAt

    String

    +

    String

    Creation time. Format: Unix timestamp.

    +

    Creation time. Format: Unix timestamp.

    logPath

    +

    logPath

    String

    +

    String

    Storage path of backed up logs in the OBS bucket.

    +

    Storage path of backup logs in the OBS bucket

    status

    +

    status

    String

    +

    String

    Task status

    -
    • RUNNING: The line is being backed up.
    • SUCCESS: The backup succeeded.
    • FAIL: The backup failed.
    +

    Task status. The value can be:

    +
    • RUNNING: The backup is in progress.
    • SUCCESS: The backup is successful.
    • FAIL: The backup fails.

    finishedAt

    +

    finishedAt

    Long

    +

    Long

    End time. If the creation has not been completed, the end time is null. Format: Unix timestamp.

    +

    End time. If the creation has not been completed, the end time is null. Format: Unix timestamp.

    jobTypes

    +

    jobTypes

    String

    +

    String

    Task type.

    -
    • Manual: Manual backup.
    • Auto: Automatic backup.
    +

    Task type. The value can be:

    +
    • Manual
    • Auto

    failedMsg

    +

    failedMsg

    String

    +

    String

    Error information. If the task did not fail, the value of this parameter is null.

    +

    Error message. If the task is not failed, the value of this parameter is null.

    jobId

    +

    jobId

    String

    +

    String

    Task ID.

    -
    -
    - -

    Example Requests

    None

    -
    -

    Example Responses

    Status code: 200

    -

    Request succeeded.

    -
    {
    -  "clusterLogRecord" : [ {
    -    "id" : "d455a541-597e-4846-a6be-baad0ea361b1",
    -    "clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
    -    "createAt" : 1656042837000,
    -    "logPath" : "css-backup-1610678043608/css/log",
    -    "status" : "RUNNING",
    -    "finishedAt" : null,
    -    "jobTypes" : "Manual",
    -    "failedMsg" : null,
    -    "jobId" : "2c9080df7c171342017c5e0884f8011c"
    -  } ]
    -}
    -
    -

    Status Codes

    -
    - - - - - - - - - - - - - - diff --git a/docs/css/api-ref/css_03_0097.html b/docs/css/api-ref/css_03_0097.html index a24b2b40..11a9b720 100644 --- a/docs/css/api-ref/css_03_0097.html +++ b/docs/css/api-ref/css_03_0097.html @@ -1,147 +1,149 @@

    Querying Basic Log Configurations

    -

    Function

    This API is used to query basic log configurations.

    +

    Function

    This API is used to query basic log configurations.

    -

    URI

    GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

    +

    Debugging

    You can debug this API in . Automatic authentication is supported.

    +
    +

    URI

    GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

    -

    Status Code

    -

    Description

    -

    200

    -

    Request succeeded.

    -

    400

    -

    Invalid request.

    -

    Modify the request before retry.

    -

    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.

    -

    412

    -

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

    +

    Task 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, see Obtaining a Project ID and Name.

    +

    Project ID. For details, see Obtaining a Project ID and Name.

    cluster_id

    +

    cluster_id

    Yes

    +

    Yes

    String

    +

    String

    ID of the cluster you want to query.

    +

    ID of the cluster to be queried

    -

    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 parameter

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    logConfiguration

    +

    logConfiguration

    logConfiguration object

    +

    logConfiguration object

    Log configuration entity object.

    +

    Log configuration entity object

    -
    Table 3 logConfiguration

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 logConfiguration

    Parameter

    Type

    +

    Type

    Description

    +

    Description

    id

    +

    id

    String

    +

    String

    Log backup ID, which is generated using the system UUID.

    +

    Log backup ID, which is generated based on the system UUID.

    clusterId

    +

    clusterId

    String

    +

    String

    Cluster ID.

    +

    Cluster ID

    obsBucket

    +

    obsBucket

    String

    +

    String

    Name of the OBS bucket for storing logs.

    +

    Name of the OBS bucket for storing logs

    agency

    +

    agency

    String

    +

    String

    Agency name. You can create an agency to allow CSS to call other cloud services.

    +

    Agency name. You can create an agency to allow CSS to call other cloud services.

    updateAt

    +

    updateAt

    Long

    +

    Long

    Update time. Format: Unix timestamp.

    +

    Update time. Format: Unix timestamp.

    basePath

    +

    basePath

    String

    +

    String

    Storage path of backed up logs in the OBS bucket.

    +

    Storage path of backup logs in the OBS bucket

    autoEnable

    +

    autoEnable

    Boolean

    +

    Boolean

    Whether the automatic backup is enabled.

    -
    • true: Automatic backup is enabled.
    • false: Automatic backup is disabled.
    +

    Indicates whether to enable automatic backup.

    +
    • true: enabled
    • false: disabled

    period

    +

    period

    String

    +

    String

    Start time of automatic log backup. If autoEnable is set to false, the value of this parameter is null. Format: GMT

    +

    Start time of automatic log backup. When autoEnable is set to false, the value of this parameter is null. Format: GMT

    logSwitch

    +

    logSwitch

    Boolean

    +

    Boolean

    Whether the log function is enabled.

    -
    • true: The log function is enabled.
    • false: The log function is disabled.
    +

    Indicates whether to enable the log function.

    +
    • true: enabled
    • false: disabled
    -

    Example Requests

    None

    +

    Request Example

    None

    -

    Example Responses

    Status code: 200

    -

    Request succeeded.

    -
    {
    +

    Response Example

    Status code: 200

    +

    The request is processed successfully.

    +
    {
       "logConfiguration" : {
         "id" : "d455a541-597e-4846-a6be-baad0ea361b1",
         "clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
    @@ -150,44 +152,11 @@
         "updateAt" : 1633663681055,
         "basePath" : "css/log",
         "autoEnable" : false,
    -    "period" : "16:00 GMT+02:00",
    +    "period" : "00:00 GMT+08:00",
         "logSwitch" : true
       }
     }
    -

    Status Codes

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

    Status Code

    -

    Description

    -

    200

    -

    Request succeeded.

    -

    400

    -

    Invalid request.

    -

    Modify the request before retry.

    -

    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.

    -

    412

    -

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

    -
    -
    -