volume_type
|
-Yes
+ | Yes
|
-String
+ | String
|
-Parameter description:
+ | Parameter description:
Node storage type.
Constraints:
N/A
@@ -164,19 +172,22 @@
Response ParametersStatus code: 200
- Table 4 Response body parametersParameter
+Table 4 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-Cluster ID.
+ | Definition:
+Cluster ID.
+Value range:
+N/A
|
@@ -184,7 +195,7 @@
Example RequestsAdd independent master and client nodes.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent
+POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent
{
"type" : {
@@ -201,25 +212,26 @@
}
Status Codes
- Status Code
+Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | Request succeeded.
|
-403
+ | 403
|
-Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
+ | Request rejected.
+The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
|
-500
+ | 500
|
-The server has received the request but could not understand it.
+ | The server has received the request but could not understand it.
|
diff --git a/docs/css/api-ref/CLASS.TXT.json b/docs/css/api-ref/CLASS.TXT.json
index f64116a6e..7fc3c5af1 100644
--- a/docs/css/api-ref/CLASS.TXT.json
+++ b/docs/css/api-ref/CLASS.TXT.json
@@ -9,7 +9,7 @@
"code":"1"
},
{
- "desc":"CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 1 by calling the corresponding APIs.",
+ "desc":"CSS APIs comply with RESTful API design specifications. You can use the functions described in Table 2 by calling the corresponding APIs.Some APIs of V2 have been release",
"product_code":"css",
"title":"API Overview",
"uri":"css_03_0057.html",
@@ -27,7 +27,7 @@
"code":"3"
},
{
- "desc":"This section describes the structure of a RESTful API request, and uses the IAM API for obtain a user token as an example to describe how to call an API.A request URI is ",
+ "desc":"This section describes the structure of a RESTful API request, and uses the IAM API for obtaining a user token as an example to describe how to call an API.A request URI ",
"product_code":"css",
"title":"Making an API Request",
"uri":"css_03_0078.html",
@@ -56,8 +56,8 @@
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"css",
- "title":"APIs",
- "uri":"css_03_0097.html",
+ "title":"API V2",
+ "uri":"css_03_0102.html",
"doc_type":"api",
"p_code":"",
"code":"7"
@@ -66,343 +66,379 @@
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"css",
"title":"Cluster Management",
- "uri":"cluster_management.html",
+ "uri":"cluster_management_0.html",
"doc_type":"api",
"p_code":"7",
"code":"8"
},
{
- "desc":"This API is used to create a cluster.POST /v1.0/{project_id}/clustersStatus code: 200Example request for creating a pay-per-use cluster.Status code: 200Request succeeded.",
+ "desc":"This API is used to create a cluster that uses multiple different types of nodes. The cluster engine type can be Elasticsearch, OpenSearch, or Logstash.An Elasticsearch c",
"product_code":"css",
- "title":"Creating a cluster",
- "uri":"CreateCluster.html",
+ "title":"Creating a Cluster (V2)",
+ "uri":"CreateClusterMultiRole.html",
"doc_type":"api",
"p_code":"8",
"code":"9"
},
{
- "desc":"This API is used to query and display the cluster list and cluster status.GET /v1.0/{project_id}/clustersNoneStatus code: 200Query the first two clusters.- Method 1: GET ",
+ "desc":"This API is used to restart nodes of all or some types in the current cluster.For details, see Calling APIs.POST /v2.0/{project_id}/clusters/{cluster_id}/restartStatus co",
"product_code":"css",
- "title":"Querying the Cluster List",
- "uri":"ListClustersDetails.html",
+ "title":"Restarting a Cluster (V2)",
+ "uri":"RestartClusterMultiRole.html",
"doc_type":"api",
"p_code":"8",
"code":"10"
},
{
- "desc":"This API is used to query and display the details of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}NoneStatus code: 200Whether the details of a cluster are obtain",
+ "desc":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.For details, see Calling APIs.POST /v2.0/{project_i",
"product_code":"css",
- "title":"Querying Cluster Details",
- "uri":"ShowClusterDetail.html",
+ "title":"Rolling Restart (Deprecated)",
+ "uri":"RollingRestart.html",
"doc_type":"api",
"p_code":"8",
"code":"11"
},
{
- "desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluste",
+ "desc":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.For details, see Calling APIs.POST /v2.0/{project_i",
"product_code":"css",
- "title":"Deleting a Cluster",
- "uri":"DeleteCluster.html",
+ "title":"Rolling Restart",
+ "uri":"RollingRestartV2.html",
"doc_type":"api",
"p_code":"8",
"code":"12"
},
{
- "desc":"This API is used to change the name of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameNoneChange the display name of the current cluster.NoneSee Error ",
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"css",
- "title":"Renaming a Cluster",
- "uri":"UpdateClusterName.html",
+ "title":"Snapshot Management",
+ "uri":"snapshot_management_0.html",
"doc_type":"api",
- "p_code":"8",
+ "p_code":"7",
"code":"13"
},
{
- "desc":"This API is used to change the password of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetNoneChange the administrator password of the current clus",
+ "desc":"CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the clu",
"product_code":"css",
- "title":"Changing the Password of a Cluster",
- "uri":"ResetPassword.html",
+ "title":"Enabling Automatic Snapshot Creation",
+ "uri":"StartAutoCreateSnapshots.html",
"doc_type":"api",
- "p_code":"8",
+ "p_code":"13",
"code":"14"
},
{
- "desc":"This API is used to restart a data node in a cluster, which will interrupt services. To restart all nodes in a cluster, you are advised to use [Restart Cluster V2] (Resta",
+ "desc":"CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the clu",
"product_code":"css",
- "title":"Restarting a Cluster (Deprecated)",
- "uri":"RestartCluster.html",
+ "title":"Disabling Automatic Snapshot Creation",
+ "uri":"StopAutoCreateSnapshots.html",
"doc_type":"api",
- "p_code":"8",
+ "p_code":"13",
"code":"15"
},
{
- "desc":"This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters wit",
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"css",
- "title":"Scaling Out a Cluster",
- "uri":"UpdateExtendCluster.html",
+ "title":"API V1",
+ "uri":"css_03_0105.html",
"doc_type":"api",
- "p_code":"8",
+ "p_code":"",
"code":"16"
},
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"css",
+ "title":"Cluster Management",
+ "uri":"cluster_management.html",
+ "doc_type":"api",
+ "p_code":"16",
+ "code":"17"
+ },
+ {
+ "desc":"This API can only be used to create clusters that contain a single type of nodes. To create clusters that contain multiple types of nodes (ess, ess-cold, ess-client, and ",
+ "product_code":"css",
+ "title":"Creating a Cluster (Discarded)",
+ "uri":"CreateCluster.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"18"
+ },
{
"desc":"This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold da",
"product_code":"css",
"title":"Adding Instances and Expanding Instance Storage Capacity",
"uri":"UpdateExtendInstanceStorage.html",
"doc_type":"api",
- "p_code":"8",
- "code":"17"
- },
- {
- "desc":"This API is used to modify the specifications of a cluster. Only the nodes of the ESS type can be modified.POST /v1.0/{project_id}/clusters/{cluster_id}/flavorNonePOST /v",
- "product_code":"css",
- "title":"Changing Specifications",
- "uri":"UpdateFlavor.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"18"
- },
- {
- "desc":"This API is used to query and display the IDs of supported instance specifications.GET /v1.0/{project_id}/es-flavorsNoneStatus code: 200Obtain the specifications of all i",
- "product_code":"css",
- "title":"Obtaining the Instance Specifications List",
- "uri":"ListFlavors.html",
- "doc_type":"api",
- "p_code":"8",
+ "p_code":"17",
"code":"19"
},
{
- "desc":"This API is used to query all tags in a specified region.GET /v1.0/{project_id}/{resource_type}/tagsNoneStatus code: 200Query all CSS cluster tags in a project.Status cod",
+ "desc":"This API is used to query the cluster list and cluster status, including cluster nodes, Kibana public network access information, public network IP address, and IPv4 addr",
"product_code":"css",
- "title":"Querying All Tags",
- "uri":"ListClustersTags.html",
+ "title":"Querying the Cluster List",
+ "uri":"ListClustersDetails.html",
"doc_type":"api",
- "p_code":"8",
+ "p_code":"17",
"code":"20"
},
{
- "desc":"This API is used to query the tags of a specified cluster.GET /v1.0/{project_id}/{resource_type}/{cluster_id}/tagsNoneStatus code: 200Query the tags of a cluster.Status c",
- "product_code":"css",
- "title":"Querying Tags of a Specified Cluster",
- "uri":"ShowClusterTag.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"21"
- },
- {
- "desc":"This API is used to add tags to a cluster.POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tagsNoneCreate a cluster tag.NoneSee Error Codes.",
- "product_code":"css",
- "title":"Adding Tags to a Cluster",
- "uri":"CreateClustersTags.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"22"
- },
- {
- "desc":"This API is used to delete a cluster tag.DELETE /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/{key}NoneNoneNoneNoneSee Error Codes.",
- "product_code":"css",
- "title":"Deleting a Cluster Tag",
- "uri":"DeleteClustersTags.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"23"
- },
- {
- "desc":"This API is used to add tags to or delete tags from a cluster in batches.POST /v1.0/{project_id}/{resource_type}/{cluster_id}/tags/actionNoneCreate or delete cluster tags",
- "product_code":"css",
- "title":"Adding or Deleting Cluster Tags in Batches",
- "uri":"UpdateBatchClustersTags.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"24"
- },
- {
- "desc":"This API is used to scale in a cluster by removing a specified node. Yearly/Monthly clusters do not support the removal of specified nodes by calling this API.POST /v1.0/",
- "product_code":"css",
- "title":"Scaling In a Cluster by Removing a Specific Node",
- "uri":"UpdateShrinkNodes.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"25"
- },
- {
- "desc":"This API is used to modify cluster specifications. Supported node types:ess: data nodeess: data nodeess-cold: cold data nodeess-cold: cold data nodeess-client: client nod",
- "product_code":"css",
- "title":"Change the specifications of a specified node type.",
- "uri":"UpdateFlavorByType.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"26"
- },
- {
- "desc":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster. Yearly/Monthly clusters do not support the removal of specified ",
- "product_code":"css",
- "title":"Scaling In Nodes of a Specific Type",
- "uri":"UpdateShrinkCluster.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"27"
- },
- {
- "desc":"This API is used to download a security certificate.GET /v1.0/{project_id}/cer/downloadNoneStatus code: 200Download the security certificate.Status code: 200Request succe",
- "product_code":"css",
- "title":"Downloading a Security Certificate",
- "uri":"DownloadCert.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"28"
- },
- {
- "desc":"This API is used to replace a failed node.PUT /v1.0/{project_id}/clusters/{cluster_id}/instance/{instance_id}/replaceNoneNoneNoneSee Error Codes.",
- "product_code":"css",
- "title":"Replacing a Node",
- "uri":"UpdateInstance.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"29"
- },
- {
- "desc":"This API is used to configure the security mode of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/mode/changeNoneChange the security mode of the current cluster.",
- "product_code":"css",
- "title":"Configuring the Security Mode.",
- "uri":"ChangeMode.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"30"
- },
- {
- "desc":"This API is used to add dedicated master and client nodes to an existing cluster that previously does not have such nodes.POST /v1.0/{project_id}/clusters/{cluster_id}/ty",
+ "desc":"This API is used to add dedicated master and client nodes to an existing cluster that previously does not have such nodes.For details, see Calling APIs.POST /v1.0/{projec",
"product_code":"css",
"title":"Adding Independent Masters and Clients",
"uri":"AddIndependentNode.html",
"doc_type":"api",
- "p_code":"8",
+ "p_code":"17",
+ "code":"21"
+ },
+ {
+ "desc":"This API is used to query and display details about a single cluster, including the cluster's search type, node list, network information, cluster name, cluster ID, and c",
+ "product_code":"css",
+ "title":"Querying Cluster Details",
+ "uri":"ShowClusterDetail.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"22"
+ },
+ {
+ "desc":"This API is used to modify the node specifications of a cluster. It can only change the specifications of ess nodes (data nodes). If you need to change other types of nod",
+ "product_code":"css",
+ "title":"Changing Node Specifications (Discarded)",
+ "uri":"UpdateFlavor.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"23"
+ },
+ {
+ "desc":"This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluste",
+ "product_code":"css",
+ "title":"Deleting a Cluster",
+ "uri":"DeleteCluster.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"24"
+ },
+ {
+ "desc":"During a scale-in, the data on the to-be-removed nodes needs to be migrated to the remaining nodes. The timeout for data migration per node is 48 hours. Scale-in will fai",
+ "product_code":"css",
+ "title":"Scaling In a Cluster by Removing a Specific Node",
+ "uri":"UpdateShrinkNodes.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"25"
+ },
+ {
+ "desc":"If the workloads on a cluster's data plane change, you can scale the cluster vertically by changing its node specifications or node storage type.Cluster types that suppor",
+ "product_code":"css",
+ "title":"Change the specifications of a specified node type.",
+ "uri":"UpdateFlavorByType.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"26"
+ },
+ {
+ "desc":"This API is used to change cluster names.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/changenameStatus code: 200Request succeeded.NoneChang",
+ "product_code":"css",
+ "title":"Renaming a Cluster",
+ "uri":"UpdateClusterName.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"27"
+ },
+ {
+ "desc":"This API is used to remove instances of specific types and reduce instance storage capacity in a cluster.All mission-critical data has been backed up before a cluster sca",
+ "product_code":"css",
+ "title":"Scaling In Nodes of a Specific Type",
+ "uri":"UpdateShrinkCluster.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"28"
+ },
+ {
+ "desc":"This API is used to change cluster passwords to enhance cluster security.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/password/resetStatus ",
+ "product_code":"css",
+ "title":"Changing the Password of a Cluster",
+ "uri":"ResetPassword.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"29"
+ },
+ {
+ "desc":"This API is used to replace a failed node.If a node in an Elasticsearch cluster is faulty, you can replace it to restore services.The node replacement process is as follo",
+ "product_code":"css",
+ "title":"Replacing a Node",
+ "uri":"UpdateInstance.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"30"
+ },
+ {
+ "desc":"This API is used to restart a data node in a cluster, which will interrupt services. To restart all nodes in a cluster, you are advised to use [Restart Cluster V2] (Resta",
+ "product_code":"css",
+ "title":"Restarting a Cluster (Deprecated)",
+ "uri":"RestartCluster.html",
+ "doc_type":"api",
+ "p_code":"17",
"code":"31"
},
{
- "desc":"This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_typ",
+ "desc":"This API is used to configure the security mode of a cluster. The security mode settings for clusters include:Security mode + HTTP: strikes a balance between performance ",
+ "product_code":"css",
+ "title":"Configuring the Security Mode.",
+ "uri":"ChangeMode.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"32"
+ },
+ {
+ "desc":"This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters wit",
+ "product_code":"css",
+ "title":"Scaling Out a Cluster (Discarded)",
+ "uri":"UpdateExtendCluster.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"33"
+ },
+ {
+ "desc":"This API is used to obtain the node specifications, including the node specifications version, cluster data search engine, number of vCPUs per node, and node memory size.",
+ "product_code":"css",
+ "title":"Obtaining the Instance Specifications List",
+ "uri":"ListFlavors.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"34"
+ },
+ {
+ "desc":"The certificate obtained through this API can be used for HTTPS-based secure cluster connections, where encryption and user authentication occur.For details, see Calling ",
+ "product_code":"css",
+ "title":"Downloading a Security Certificate",
+ "uri":"DownloadCert.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"35"
+ },
+ {
+ "desc":"This API is used to query all tags of a user in the current project, including the keys and values. This facilitates tag management by group.For details, see Calling APIs",
+ "product_code":"css",
+ "title":"Querying All Tags",
+ "uri":"ListClustersTags.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"36"
+ },
+ {
+ "desc":"This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{c",
"product_code":"css",
"title":"Upgrading a Cluster Kernel",
"uri":"UpgradeCore.html",
"doc_type":"api",
- "p_code":"8",
- "code":"32"
+ "p_code":"17",
+ "code":"37"
},
{
- "desc":"This API is used to obtain the ID of an image that can be upgraded in the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/imagesNoneSta",
+ "desc":"This API is used to obtain the IDs of target images the current cluster can be upgraded to. The upgrade types are as follows:During a same-version upgrade, kernel patches",
"product_code":"css",
"title":"Obtaining the ID of the Target Image to Upgrade To",
"uri":"ListImages.html",
"doc_type":"api",
- "p_code":"8",
- "code":"33"
+ "p_code":"17",
+ "code":"38"
},
{
- "desc":"The upgrade may take a long time. This API can be used to check phase-by-phase information during a cluster upgrade or AZ switchover.GET /v1.0/{project_id}/clusters/{clus",
+ "desc":"By deploying a CSS cluster across multiple AZs, you can increase the cluster's availability, lower the likelihood of data loss, and minimize service downtime. You can dep",
"product_code":"css",
"title":"Obtaining Details About a Cluster Upgrade or AZ Switchover",
"uri":"UpgradeDetail.html",
"doc_type":"api",
- "p_code":"8",
- "code":"34"
+ "p_code":"17",
+ "code":"39"
},
{
- "desc":"The upgrade may fail due to network problems. In this case, you can call this API to retry.PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retryNoneNoneE",
+ "desc":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources. You can add tags to a cluster when creating a cluster or add them on ",
+ "product_code":"css",
+ "title":"Querying Tags of a Specified Cluster",
+ "uri":"ShowClusterTag.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"40"
+ },
+ {
+ "desc":"The upgrade may fail due to network problems. In this case, you can call this API to retry.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/upgr",
"product_code":"css",
"title":"Retrying a Failed Upgrade Task",
"uri":"RetryUpgradeTask.html",
"doc_type":"api",
- "p_code":"8",
- "code":"35"
+ "p_code":"17",
+ "code":"41"
},
{
- "desc":"This API is used to change the security group after a cluster is created.POST /v1.0/{project_id}/clusters/{cluster_id}/sg/changeNoneChange the security group that the cur",
+ "desc":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources.You can add tags to a cluster when creating a cluster or add them on t",
+ "product_code":"css",
+ "title":"Adding Tags to a Cluster",
+ "uri":"CreateClustersTags.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"42"
+ },
+ {
+ "desc":"This API is used to change the security group after a cluster is created.Before changing the security group, ensure that port 9200 has been enabled. Incorrect security gr",
"product_code":"css",
"title":"Changing the Security Group",
"uri":"ChangeSecurityGroup.html",
"doc_type":"api",
- "p_code":"8",
- "code":"36"
+ "p_code":"17",
+ "code":"43"
},
{
- "desc":"This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.POST /v1.0/{project_id}/clusters/{cluster_id}",
+ "desc":"Tags are cluster identifiers. You can add tags to clusters to identify and manage cluster resources.You can add tags to a cluster when creating a cluster or add them on t",
+ "product_code":"css",
+ "title":"Deleting a Cluster Tag",
+ "uri":"DeleteClustersTags.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"44"
+ },
+ {
+ "desc":"This API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.For details, see Calling APIs.POST /v1.0/{pro",
"product_code":"css",
"title":"Changing the Subnet of a Cluster",
"uri":"ChangeClusterSubnet.html",
"doc_type":"api",
- "p_code":"8",
- "code":"37"
+ "p_code":"17",
+ "code":"45"
},
{
- "desc":"This API is used to change the AZ by specifying node types.POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/azmigrateNoneSwitch the AZ of the current c",
+ "desc":"This API is used to add or delete tags in batches for Elasticsearch, Logstash, and OpenSearch clusters.For details, see Calling APIs.POST /v1.0/{project_id}/{resource_typ",
"product_code":"css",
- "title":"Changing the AZ of a Cluster Instance",
+ "title":"Adding or Deleting Cluster Tags in Batches",
+ "uri":"UpdateBatchClustersTags.html",
+ "doc_type":"api",
+ "p_code":"17",
+ "code":"46"
+ },
+ {
+ "desc":"An availability zone (AZ) is a physical region where resources use independent power supplies and networks. AZs in the same region can communicate with each other through",
+ "product_code":"css",
+ "title":"Changing AZs for a Cluster Instance",
"uri":"UpdateAzByInstanceType.html",
"doc_type":"api",
- "p_code":"8",
- "code":"38"
+ "p_code":"17",
+ "code":"47"
},
{
- "desc":"This API is used to create a cluster with multiple node types (for example, ess, ess-cold, ess-client, ess-master).POST /v2.0/{project_id}/clustersStatus code: 200Example",
+ "desc":"This interface is used to update a cluster route.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/routeStatus code: 200Request succeeded.NoneUp",
"product_code":"css",
- "title":"Creating a Cluster (V2)",
- "uri":"CreateClusterMultiRole.html",
+ "title":"Updating Cluster Routes",
+ "uri":"UpdateRoute.html",
"doc_type":"api",
- "p_code":"8",
- "code":"39"
+ "p_code":"17",
+ "code":"48"
},
{
- "desc":"This API is used to restart nodes of all or some types in the current cluster.POST /v2.0/{project_id}/clusters/{cluster_id}/restartNoneRestart nodes of all or some types ",
+ "desc":"By default, a CSS Elasticsearch cluster cannot access a target service—such as a client program or a Lightweight Directory Access Protocol (LDAP) service—that is located ",
"product_code":"css",
- "title":"Restarting a Cluster (V2)",
- "uri":"RestartClusterMultiRole.html",
+ "title":"Obtaining a Cluster Route",
+ "uri":"GetRoutes.html",
"doc_type":"api",
- "p_code":"8",
- "code":"40"
- },
- {
- "desc":"This API is used to restart nodes one by one, which requires a long time when the nodes have a large number of indexes.POST /v2.0/{project_id}/clusters/{cluster_id}/rolli",
- "product_code":"css",
- "title":"Rolling Restart",
- "uri":"RollingRestart.html",
- "doc_type":"api",
- "p_code":"8",
- "code":"41"
- },
- {
- "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
- "product_code":"css",
- "title":"Word Dictionary Management",
- "uri":"thesaurus_management.html",
- "doc_type":"api",
- "p_code":"7",
- "code":"42"
- },
- {
- "desc":"This API is used to load a custom word dictionary stored in OBS.POST /v1.0/{project_id}/clusters/{cluster_id}/thesaurusNoneEnable and configure the word dictionary.NoneSe",
- "product_code":"css",
- "title":"Loading Custom Word Dictionaries",
- "uri":"CreateLoadIkThesaurus.html",
- "doc_type":"api",
- "p_code":"42",
- "code":"43"
- },
- {
- "desc":"This API is used to query the loading status of a custom word dictionary.GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurusNoneStatus code: 200Query the loading statu",
- "product_code":"css",
- "title":"Querying the Status of a Custom Word Dictionary",
- "uri":"ShowIkThesaurus.html",
- "doc_type":"api",
- "p_code":"42",
- "code":"44"
- },
- {
- "desc":"This API is used to clear custom word dictionaries (main word dictionary, stop word dictionary, and synonym dictionary).DELETE /v1.0/{project_id}/clusters/{cluster_id}/th",
- "product_code":"css",
- "title":"Disabling a Word Dictionary",
- "uri":"DeleteIkThesaurus.html",
- "doc_type":"api",
- "p_code":"42",
- "code":"45"
+ "p_code":"17",
+ "code":"49"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -410,53 +446,53 @@
"title":"Kibana Public Network Access",
"uri":"kibana_public_network_access.html",
"doc_type":"api",
- "p_code":"7",
- "code":"46"
+ "p_code":"16",
+ "code":"50"
},
{
- "desc":"This API is used to enable public network access to Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openNoneNoneSee Error Codes.",
+ "desc":"This API is used to enable public network access to Kibana.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/openStatus code: 200Re",
"product_code":"css",
"title":"Enabling Kibana Public Access",
"uri":"StartKibanaPublic.html",
"doc_type":"api",
- "p_code":"46",
- "code":"47"
+ "p_code":"50",
+ "code":"51"
},
{
- "desc":"This API is used to disable public network access to Kibana. Kibana public network access cannot be disabled for yearly/monthly clusters by calling this API.PUT /v1.0/{pr",
+ "desc":"This API is used to disable public network access to Kibana.If you disable Kibana public network access and then re-enable it, the public IP address for accessing Kibana ",
"product_code":"css",
"title":"Disabling Kibana Public Access",
"uri":"UpdateCloseKibana.html",
"doc_type":"api",
- "p_code":"46",
- "code":"48"
+ "p_code":"50",
+ "code":"52"
},
{
- "desc":"This API is used to modify the public network bandwidth of Kibana.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthNoneModify the Kibana public network",
+ "desc":"This API is used to modify the public network bandwidth of Kibana.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/bandwidthStatus",
"product_code":"css",
"title":"Modifying the Kibana Public Network Bandwidth",
"uri":"UpdateAlterKibana.html",
"doc_type":"api",
- "p_code":"46",
- "code":"49"
+ "p_code":"50",
+ "code":"53"
},
{
- "desc":"This API is used to modify the Kibana access permission by modifying the Kibana whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/updateNoneT",
+ "desc":"This API is used to modify the Kibana access permission by modifying the Kibana whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/publ",
"product_code":"css",
"title":"Modifying Kibana Public Access Control",
"uri":"UpdatePublicKibanaWhitelist.html",
"doc_type":"api",
- "p_code":"46",
- "code":"50"
+ "p_code":"50",
+ "code":"54"
},
{
- "desc":"This API is used to disable public network access control for Kibana.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/closeNoneNoneNoneNoneSee Error Co",
+ "desc":"This API is used to disable public network access control for Kibana.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/publickibana/whitelist/clo",
"product_code":"css",
"title":"Disabling Kibana Public Network Access Control",
"uri":"StopPublicKibanaWhitelist.html",
"doc_type":"api",
- "p_code":"46",
- "code":"51"
+ "p_code":"50",
+ "code":"55"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -464,98 +500,98 @@
"title":"Log Management",
"uri":"log_management.html",
"doc_type":"api",
- "p_code":"7",
- "code":"52"
+ "p_code":"16",
+ "code":"56"
},
{
- "desc":"This API is used to enable the log function.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/openNoneEnable the log function.POST /v1.0/6204a5bd270343b5885144cf9c8c158d",
+ "desc":"This API is used to enable log backup or log ingestion for a cluster. Log backup and log ingestion can be enabled separately. After log backup is enabled, you can configu",
"product_code":"css",
- "title":"Enabling the Log Function",
+ "title":"Enabling Log Backup or Log Collection",
"uri":"StartLogs.html",
"doc_type":"api",
- "p_code":"52",
- "code":"53"
+ "p_code":"56",
+ "code":"57"
},
{
- "desc":"This API is used to disable the log function.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/closeNoneNoneNoneNoneSee Error Codes.",
+ "desc":"This API is used to disable log backup or log ingestion for a cluster. Log backup and log ingestion can be disabled separately. After log backup is disabled, any automati",
"product_code":"css",
- "title":"Disabling the Log Function",
+ "title":"Disabling the Log Backup or Collection Function",
"uri":"StopLogs.html",
"doc_type":"api",
- "p_code":"52",
- "code":"54"
+ "p_code":"56",
+ "code":"58"
},
{
- "desc":"This API is used to query the log backup task list of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/recordsNoneStatus code: 200Querying the First 10 Log Bac",
+ "desc":"This API is used to query the log backup task list of a cluster. To be able to use this API, the target cluster must have log backup enabled, and log backup tasks were tr",
"product_code":"css",
"title":"Querying the Log Backup Task List",
"uri":"ListLogsJob.html",
"doc_type":"api",
- "p_code":"52",
- "code":"55"
+ "p_code":"56",
+ "code":"59"
},
{
- "desc":"This API is used to query basic cluster log configurations.GET /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneStatus code: 200Query basic cluster log configura",
+ "desc":"This API is used to query the basic configuration of cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the ",
"product_code":"css",
"title":"Querying Basic Log Configurations",
"uri":"ShowGetLogSetting.html",
"doc_type":"api",
- "p_code":"52",
- "code":"56"
+ "p_code":"56",
+ "code":"60"
},
{
- "desc":"This API is used to modify basic log configurations.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settingsNoneModify basic log configurations.POST /v1.0/6204a5bd2703",
+ "desc":"This API is used to modify basic configurations for cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the c",
"product_code":"css",
"title":"Modifying Basic Log Configurations",
"uri":"UpdateLogSetting.html",
"doc_type":"api",
- "p_code":"52",
- "code":"57"
+ "p_code":"56",
+ "code":"61"
},
{
- "desc":"This API is used to enable the automatic log backup policy.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/updateNoneEnable the automatic log backup policy.None",
+ "desc":"CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.Log ",
"product_code":"css",
"title":"Enabling the Automatic Log Backup Policy",
"uri":"StartLogAutoBackupPolicy.html",
"doc_type":"api",
- "p_code":"52",
- "code":"58"
+ "p_code":"56",
+ "code":"62"
},
{
- "desc":"This API is used to disable the automatic log backup policy.PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/closeNoneNoneNoneNoneSee Error Codes.",
+ "desc":"CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.Log ",
"product_code":"css",
"title":"Disabling the Automatic Log Backup Policy",
"uri":"StopLogAutoBackupPolicy.html",
"doc_type":"api",
- "p_code":"52",
- "code":"59"
+ "p_code":"56",
+ "code":"63"
},
{
- "desc":"This API is used to back up logs.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/collectNoneNoneNoneNoneSee Error Codes.",
+ "desc":"This API is used to back up logs. If log backup is enabled for a cluster, you can call this API to back up the cluster's run logs to the specified OBS bucket. This ensure",
"product_code":"css",
"title":"Backing Up Logs",
"uri":"CreateLogBackup.html",
"doc_type":"api",
- "p_code":"52",
- "code":"60"
+ "p_code":"56",
+ "code":"64"
},
{
- "desc":"This API is used to query log information.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/searchStatus code: 200Query logs.Status code: 200Request succeeded.See Error ",
+ "desc":"CSS supports log backup and query, helping you efficiently locate issues. You can periodically back up cluster logs to OBS buckets for long-term storage, from which you d",
"product_code":"css",
"title":"Searching for Logs",
"uri":"ShowLogBackup.html",
"doc_type":"api",
- "p_code":"52",
- "code":"61"
+ "p_code":"56",
+ "code":"65"
},
{
- "desc":"This API is used to test connectivity.POST /v1.0/{project_id}/clusters/{cluster_id}/logs/connectivityNoneTest connectivity to the target cluster.Status code: 200Request s",
+ "desc":"This API is used to test the connectivity between two clusters. CSS clusters provide a log collection function, allowing users to collect clusters' run logs in real time ",
"product_code":"css",
"title":"Test connectivity.",
"uri":"StartTargetClusterConnectivityTest.html",
"doc_type":"api",
- "p_code":"52",
- "code":"62"
+ "p_code":"56",
+ "code":"66"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -563,53 +599,53 @@
"title":"Public Network Access",
"uri":"public_network_access.html",
"doc_type":"api",
- "p_code":"7",
- "code":"63"
+ "p_code":"16",
+ "code":"67"
},
{
- "desc":"This API is used to enable public network access.POST /v1.0/{project_id}/clusters/{cluster_id}/public/openStatus code: 200Status code: 200Request succeeded.See Error Code",
+ "desc":"Public network access is supported only when Security Mode and HTTPS Access are enabled for a cluster. When Public IP Address is enabled, a public IP address is automatic",
"product_code":"css",
"title":"Enabling Public Network Access",
"uri":"CreateBindPublic.html",
"doc_type":"api",
- "p_code":"63",
- "code":"64"
+ "p_code":"67",
+ "code":"68"
},
{
- "desc":"This API is used to disable public network access. Public network access cannot be disabled for yearly/monthly clusters by calling this API.PUT /v1.0/{project_id}/cluster",
+ "desc":"This API is used to disable public network access.After public network access is disabled, users can no longer access the cluster via a public IP address. If you disable ",
"product_code":"css",
"title":"Disabling Public Network Access",
"uri":"UpdateUnbindPublic.html",
"doc_type":"api",
- "p_code":"63",
- "code":"65"
+ "p_code":"67",
+ "code":"69"
},
{
- "desc":"This API is used to modify the public network access bandwidth.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthNoneModify public network access bandwidth.No",
+ "desc":"This API is used to modify the public network access bandwidth.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidthStatus code: 20",
"product_code":"css",
"title":"Modifying Public Network Access Bandwidth",
"uri":"UpdatePublicBandWidth.html",
"doc_type":"api",
- "p_code":"63",
- "code":"66"
+ "p_code":"67",
+ "code":"70"
},
{
- "desc":"This API is used to enable the public network access control whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/updateNoneEnable the public network ",
+ "desc":"This API is used to enable the public network access control whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/update",
"product_code":"css",
"title":"Enabling the Public Network Access Control Whitelist",
"uri":"StartPublicWhitelist.html",
"doc_type":"api",
- "p_code":"63",
- "code":"67"
+ "p_code":"67",
+ "code":"71"
},
{
- "desc":"This API is used to disable the public network access control whitelist.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeNoneNoneNoneNoneSee Error Codes",
+ "desc":"This API is used to disable the public network access control whitelist.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/public/whitelist/closeN",
"product_code":"css",
"title":"Disabling the Public Network Access Control Whitelist",
"uri":"StopPublicWhitelist.html",
"doc_type":"api",
- "p_code":"63",
- "code":"68"
+ "p_code":"67",
+ "code":"72"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -617,8 +653,80 @@
"title":"Snapshot Management",
"uri":"snapshot_management.html",
"doc_type":"api",
- "p_code":"7",
- "code":"69"
+ "p_code":"16",
+ "code":"73"
+ },
+ {
+ "desc":"This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.OBS Bucket: Enter the location of the OBS bucket used for",
+ "product_code":"css",
+ "title":"Modifying Basic Configurations of a Cluster Snapshot",
+ "uri":"UpdateSnapshotSetting.html",
+ "doc_type":"api",
+ "p_code":"73",
+ "code":"74"
+ },
+ {
+ "desc":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ",
+ "product_code":"css",
+ "title":"Manually Creating a Snapshot",
+ "uri":"CreateSnapshot.html",
+ "doc_type":"api",
+ "p_code":"73",
+ "code":"75"
+ },
+ {
+ "desc":"This API is used to manually restore a snapshot.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restoreStatus cod",
+ "product_code":"css",
+ "title":"Restoring a Snapshot",
+ "uri":"RestoreSnapshot.html",
+ "doc_type":"api",
+ "p_code":"73",
+ "code":"76"
+ },
+ {
+ "desc":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ",
+ "product_code":"css",
+ "title":"Deleting a Snapshot",
+ "uri":"DeleteSnapshot.html",
+ "doc_type":"api",
+ "p_code":"73",
+ "code":"77"
+ },
+ {
+ "desc":"CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's ",
+ "product_code":"css",
+ "title":"Querying the Automatic Snapshot Creation Policy",
+ "uri":"ShowAutoCreatePolicy.html",
+ "doc_type":"api",
+ "p_code":"73",
+ "code":"78"
+ },
+ {
+ "desc":"This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{clu",
+ "product_code":"css",
+ "title":"Configuring the Automatic Snapshot Creation Policy",
+ "uri":"CreateAutoCreatePolicy.html",
+ "doc_type":"api",
+ "p_code":"73",
+ "code":"79"
+ },
+ {
+ "desc":"This API is used to query all snapshots of a cluster, including the snapshot creation time, data engine, snapshot ID, and snapshot status, helping you manage the lifecycl",
+ "product_code":"css",
+ "title":"Querying a Snapshot List",
+ "uri":"ListSnapshots.html",
+ "doc_type":"api",
+ "p_code":"73",
+ "code":"80"
+ },
+ {
+ "desc":"This API is used to disable the snapshot function.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneStatus code: 200Request",
+ "product_code":"css",
+ "title":"Disabling the Snapshot Function",
+ "uri":"StopSnapshot.html",
+ "doc_type":"api",
+ "p_code":"73",
+ "code":"81"
},
{
"desc":"This API is used to automatically set basic configurations for a cluster snapshot, including configuring OBS buckets and IAM agency.OBS Bucket: Enter the location of the ",
@@ -626,98 +734,8 @@
"title":"(Not Recommended) Automatically Setting Basic Configurations of a Cluster Snapshot",
"uri":"StartAutoSetting.html",
"doc_type":"api",
- "p_code":"69",
- "code":"70"
- },
- {
- "desc":"This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.You can also use this API to enable the snapshot function",
- "product_code":"css",
- "title":"Modifying Basic Configurations of a Cluster Snapshot",
- "uri":"UpdateSnapshotSetting.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"71"
- },
- {
- "desc":"This API is used to manually create a snapshot.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotStatus code: 201Create a snapshot.Status code: 201Resource crea",
- "product_code":"css",
- "title":"Manually Creating a Snapshot",
- "uri":"CreateSnapshot.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"72"
- },
- {
- "desc":"This API is used to manually restore a snapshot.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restoreNoneRestore a snapshot.NoneSee Error Cod",
- "product_code":"css",
- "title":"Restoring a Snapshot",
- "uri":"RestoreSnapshot.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"73"
- },
- {
- "desc":"This API is used to delete a snapshot.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}NoneNoneNoneNoneSee Error Codes.",
- "product_code":"css",
- "title":"Deleting a Snapshot",
- "uri":"DeleteSnapshot.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"74"
- },
- {
- "desc":"This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy",
- "product_code":"css",
- "title":"Configuring the Automatic Snapshot Creation Policy",
- "uri":"CreateAutoCreatePolicy.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"75"
- },
- {
- "desc":"This API is used to query the automatic snapshot creation policy.GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policyNoneStatus code: 200Query the automatic",
- "product_code":"css",
- "title":"Querying the Automatic Snapshot Creation Policy",
- "uri":"ShowAutoCreatePolicy.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"76"
- },
- {
- "desc":"This API is used to query all the snapshots of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneStatus code: 200Query the cluster snapshot list.S",
- "product_code":"css",
- "title":"Querying a Snapshot List",
- "uri":"ListSnapshots.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"77"
- },
- {
- "desc":"This API is used to disable the snapshot function.DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshotsNoneNoneNoneNoneSee Error Codes.",
- "product_code":"css",
- "title":"Disabling the Snapshot Function",
- "uri":"StopSnapshot.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"78"
- },
- {
- "desc":"This API is used to enable automatic snapshot creation.POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/openNoneEnable the automatic backup function.NoneSee",
- "product_code":"css",
- "title":"Enabling Automatic Snapshot Creation",
- "uri":"StartAutoCreateSnapshots.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"79"
- },
- {
- "desc":"This API is used to disable the automatic snapshot creation function.PUT /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/closeNoneNoneDisable the automatic back",
- "product_code":"css",
- "title":"Disabling Automatic Snapshot Creation",
- "uri":"StopAutoCreateSnapshots.html",
- "doc_type":"api",
- "p_code":"69",
- "code":"80"
+ "p_code":"73",
+ "code":"82"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -725,53 +743,53 @@
"title":"VPC Endpoint",
"uri":"vpecp_management.html",
"doc_type":"api",
- "p_code":"7",
- "code":"81"
+ "p_code":"16",
+ "code":"83"
},
{
- "desc":"This API is used to enable the VPCEP service for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200Enable the VPC endpoint service.",
+ "desc":"This API is used to enable the VPCEP service for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/openStatus code: 200En",
"product_code":"css",
"title":"Enabling the VPC Endpoint Service",
"uri":"StartVpecp.html",
"doc_type":"api",
- "p_code":"81",
- "code":"82"
+ "p_code":"83",
+ "code":"84"
},
{
- "desc":"This API is used to disable the VPCEP service for a cluster.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: 200NoneStatus code: 200Request",
+ "desc":"This API is used to disable the VPCEP service for a cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/closeNoneStatus code: ",
"product_code":"css",
"title":"Disabling the VPC Endpoint Service",
"uri":"StopVpecp.html",
"doc_type":"api",
- "p_code":"81",
- "code":"83"
+ "p_code":"83",
+ "code":"85"
},
{
- "desc":"This API is used to obtain the VPCEP connection of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneStatus code: 200Obtain the VPCEP con",
+ "desc":"The VPC endpoint service enables secure and reliable access across VPCs through a dedicated gateway, without exposing the network information of servers. The VPC endpoint",
"product_code":"css",
"title":"Obtaining an Endpoint Connection",
"uri":"ShowVpcepConnection.html",
"doc_type":"api",
- "p_code":"81",
- "code":"84"
+ "p_code":"83",
+ "code":"86"
},
{
- "desc":"This API is used to update the VPCEP connection of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsNoneUpdate an endpoint connection.NoneS",
+ "desc":"This API is used to update the VPCEP connection of a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/connectionsStatus co",
"product_code":"css",
"title":"Updating an Endpoint Connection",
"uri":"UpdateVpcepConnection.html",
"doc_type":"api",
- "p_code":"81",
- "code":"85"
+ "p_code":"83",
+ "code":"87"
},
{
- "desc":"This API is used to modify the endpoint service whitelist.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsNoneModify the endpoint service whitelist.",
+ "desc":"This API is used to modify the endpoint service whitelist.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissionsStatus code:",
"product_code":"css",
"title":"Modifying the VPCEP Service Whitelist of a Cluster",
"uri":"UpdateVpcepWhitelist.html",
"doc_type":"api",
- "p_code":"81",
- "code":"86"
+ "p_code":"83",
+ "code":"88"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -779,35 +797,35 @@
"title":"Parameter Configuration",
"uri":"ymls_management.html",
"doc_type":"api",
- "p_code":"7",
- "code":"87"
+ "p_code":"16",
+ "code":"89"
},
{
- "desc":"This API is used to modify the parameter settings of a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/updateStatus code: 200Modify parameter settings.Status c",
+ "desc":"This API is used to modify the parameter settings of a cluster. Before calling this API, obtain the parameter configuration list, check the parameter settings, and modify",
"product_code":"css",
"title":"Modifying Cluster Parameters",
"uri":"UpdateYmls.html",
"doc_type":"api",
- "p_code":"87",
- "code":"88"
+ "p_code":"89",
+ "code":"90"
},
{
- "desc":"This API is used to obtain the parameter configuration task list of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblistsNoneStatus code: 200Obtaining the ",
+ "desc":"This API is used to obtain the parameter configuration task list of a cluster. It can obtain the parameter configuration list ID, cluster ID, and parameter modification r",
"product_code":"css",
"title":"Obtaining the Task List of Parameter Configurations",
"uri":"ListYmlsJob.html",
"doc_type":"api",
- "p_code":"87",
- "code":"89"
+ "p_code":"89",
+ "code":"91"
},
{
- "desc":"This API is used to obtain the YAML parameter configuration list of the current cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/templateNoneStatus code: 200Obta",
+ "desc":"This API is used to obtain the YAML parameter configuration list of the current cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/te",
"product_code":"css",
"title":"Obtaining the Parameter Configuration List",
"uri":"ListYmls.html",
"doc_type":"api",
- "p_code":"87",
- "code":"90"
+ "p_code":"89",
+ "code":"92"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -815,116 +833,116 @@
"title":"Intelligent O&M",
"uri":"intelligent_maintenance.html",
"doc_type":"api",
- "p_code":"7",
- "code":"91"
+ "p_code":"16",
+ "code":"93"
},
{
- "desc":"This API is used to obtain the intelligent O&M task list and details.GET /v1.0/{project_id}/clusters/{cluster_id}/ai-opsNoneStatus code: 200This API is used to obtain the",
+ "desc":"CSS provides intelligent O&M to check potential risks in clusters. After a scan task is completed, check the risks identified by the task, confirm and handle these risks ",
"product_code":"css",
"title":"Obtaining the Intelligent O&M Task List and Details",
"uri":"ListAiOps.html",
"doc_type":"api",
- "p_code":"91",
- "code":"92"
+ "p_code":"93",
+ "code":"94"
},
{
- "desc":"This API is used to create a cluster detection task.POST /v1.0/{project_id}/clusters/{cluster_id}/ai-opsNoneCreate a cluster detection task.NoneSee Error Codes.",
+ "desc":"This API is used to create a cluster detection task. A maximum of 30 detection tasks can be created for a single cluster.For details, see Calling APIs.POST /v1.0/{project",
"product_code":"css",
"title":"Creating a Cluster Detection Task",
"uri":"CreateAiOps.html",
"doc_type":"api",
- "p_code":"91",
- "code":"93"
+ "p_code":"93",
+ "code":"95"
},
{
- "desc":"This API is used to delete a detection task.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneNoneDelete a detection task.NoneSee Error Codes.",
+ "desc":"This API is used to delete a detection task.For details, see Calling APIs.DELETE /v1.0/{project_id}/clusters/{cluster_id}/ai-ops/{aiops_id}NoneStatus code: 200Request suc",
"product_code":"css",
"title":"Deleting a Detection Task",
"uri":"DeleteAiOps.html",
"doc_type":"api",
- "p_code":"91",
- "code":"94"
+ "p_code":"93",
+ "code":"96"
},
{
- "desc":"This API is used to obtain SMN topics available for intelligent O&M alarms.GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topicsNoneStatus code: 200Obtain the inte",
+ "desc":"This API is used to obtain SMN topics available for intelligent O&M alarms.For details, see Calling APIs.GET /v1.0/{project_id}/domains/{domain_id}/ai-ops/smn-topicsNoneS",
"product_code":"css",
"title":"Obtaining SMN Topics Available for Intelligent O&M Alarms",
"uri":"ListSmnTopics.html",
"doc_type":"api",
- "p_code":"91",
- "code":"95"
+ "p_code":"93",
+ "code":"97"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"css",
"title":"Load Balancing",
- "uri":"topic_300000010.html",
+ "uri":"topic_300000011.html",
"doc_type":"api",
- "p_code":"7",
- "code":"96"
+ "p_code":"16",
+ "code":"98"
},
{
- "desc":"Query the ELB V3 load balancers supported by a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200Query ELB V3 load balancers supported",
+ "desc":"Query the ELB V3 load balancers supported by a cluster.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancersNoneStatus code: 200Query E",
"product_code":"css",
"title":"Querying ELB V3 Load Balancers Supported by a Cluster",
"uri":"ListElbs.html",
"doc_type":"api",
- "p_code":"96",
- "code":"97"
+ "p_code":"98",
+ "code":"99"
},
{
- "desc":"This API is used to enable or disable load balancers for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStatus code: 200Enable the load ba",
+ "desc":"This API is used to enable or disable load balancers for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switchStat",
"product_code":"css",
"title":"Enabling or Disabling Load Balancers for a Cluster",
"uri":"EnableOrDisableElb.html",
"doc_type":"api",
- "p_code":"96",
- "code":"98"
+ "p_code":"98",
+ "code":"100"
},
{
- "desc":"This API is used to configure load balancing listeners for a cluster.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: 200Status code: 200Request suc",
- "product_code":"css",
- "title":"Configuring Load Balancing Listeners for a Cluster",
- "uri":"CreateElbListener.html",
- "doc_type":"api",
- "p_code":"96",
- "code":"99"
- },
- {
- "desc":"This API is used to obtain information about the load balancers of a cluster.GET /v1.0/{project_id}/clusters/{cluster_id}/es-listenersNoneStatus code: 200NoneStatus code:",
+ "desc":"CSS integrates shared load balancers and allows you to bind public network access and enable the VPC Endpoint service. Dedicated load balancers provide more functions and",
"product_code":"css",
"title":"Obtain information about the load balancers of a cluster.",
"uri":"ShowElbDetail.html",
"doc_type":"api",
- "p_code":"96",
- "code":"100"
+ "p_code":"98",
+ "code":"101"
},
{
- "desc":"This API is used to update load balancing listeners for a cluster.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Status code: 200Status code: 200R",
+ "desc":"This API is used to configure load balancing listeners for a cluster.For details, see Calling APIs.POST /v1.0/{project_id}/clusters/{cluster_id}/es-listenersStatus code: ",
+ "product_code":"css",
+ "title":"Configuring Load Balancing Listeners for a Cluster",
+ "uri":"CreateElbListener.html",
+ "doc_type":"api",
+ "p_code":"98",
+ "code":"102"
+ },
+ {
+ "desc":"This API is used to update load balancing listeners for a cluster.For details, see Calling APIs.PUT /v1.0/{project_id}/clusters/{cluster_id}/es-listeners/{listener_id}Sta",
"product_code":"css",
"title":"Updating Load Balancing Listeners for a Cluster",
"uri":"UpdateESListener.html",
"doc_type":"api",
- "p_code":"96",
- "code":"101"
+ "p_code":"98",
+ "code":"103"
},
{
- "desc":"This API is used to query the certificate list.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200NoneStatus code: 200Request succeeded.See ",
+ "desc":"This API is used to query the certificate list.For details, see Calling APIs.GET /v1.0/{project_id}/clusters/{cluster_id}/elb/certificatesNoneStatus code: 200This API is ",
"product_code":"css",
"title":"Querying the Certificate List",
"uri":"ListElbCerts.html",
"doc_type":"api",
- "p_code":"96",
- "code":"102"
+ "p_code":"98",
+ "code":"104"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"css",
"title":"Examples",
- "uri":"en-us_topic_0000002083557490.html",
+ "uri":"css_03_0095.html",
"doc_type":"api",
"p_code":"",
- "code":"103"
+ "code":"105"
},
{
"desc":"This section describes how to create a CSS cluster by using APIs. Figure 1 illustrates the API calling process.The token obtained on IAM is valid for only 24 hours. If yo",
@@ -932,8 +950,8 @@
"title":"Creating a Pay-per-Use Elasticsearch Cluster",
"uri":"css_03_0062.html",
"doc_type":"api",
- "p_code":"103",
- "code":"104"
+ "p_code":"105",
+ "code":"106"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -942,7 +960,7 @@
"uri":"css_03_0040.html",
"doc_type":"api",
"p_code":"",
- "code":"105"
+ "code":"107"
},
{
"desc":"Table 1 describes the status codes.",
@@ -950,8 +968,8 @@
"title":"Status Codes",
"uri":"css_03_0075.html",
"doc_type":"api",
- "p_code":"105",
- "code":"106"
+ "p_code":"107",
+ "code":"108"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -959,17 +977,17 @@
"title":"Error Codes",
"uri":"css_03_0076.html",
"doc_type":"api",
- "p_code":"105",
- "code":"107"
+ "p_code":"107",
+ "code":"109"
},
{
- "desc":"A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.Log in to the console.In the upper right c",
+ "desc":"A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.Log in to the CSS management console.In th",
"product_code":"css",
"title":"Obtaining a Project ID and Name",
"uri":"css_03_0071.html",
"doc_type":"api",
- "p_code":"105",
- "code":"108"
+ "p_code":"107",
+ "code":"110"
},
{
"desc":"A cluster ID (cluster_id) is required for some URLs when an API is called. To obtain the cluster ID, perform the following steps:You can obtain the cluster ID by calling ",
@@ -977,8 +995,8 @@
"title":"Obtaining the Cluster ID",
"uri":"css_03_0101.html",
"doc_type":"api",
- "p_code":"105",
- "code":"109"
+ "p_code":"107",
+ "code":"111"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@@ -987,6 +1005,6 @@
"uri":"css_03_0024.html",
"doc_type":"api",
"p_code":"",
- "code":"110"
+ "code":"112"
}
]
\ No newline at end of file
diff --git a/docs/css/api-ref/ChangeClusterSubnet.html b/docs/css/api-ref/ChangeClusterSubnet.html
index 6ebd34277..92dd34b81 100644
--- a/docs/css/api-ref/ChangeClusterSubnet.html
+++ b/docs/css/api-ref/ChangeClusterSubnet.html
@@ -4,34 +4,50 @@
FunctionThis API is used to bind a new subnet to newly added nodes after cluster creation, or in the case of a cluster subnet change.
 By default, subnets with the same VPC are connected. Ensure that the new subnet can reach your service system. Note that a cluster with automatic IPv6 address creation enabled can only be switched to a new subnet that uses IPv6 addresses.
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/subnet/change
+
+ URIPOST /v1.0/{project_id}/clusters/{cluster_id}/subnet/change
- Table 1 Path ParametersParameter
+Table 1 Path ParametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Definition:
+Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+Constraints:
+N/A
+Value range:
+Project ID of the account.
+Default value:
+N/A
|
-cluster_id
+ | cluster_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-ID of the cluster that you want to change the security group
+ | Definition:
+ID of the cluster whose subnet is to be changed. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.
+Constraints:
+N/A
+Value range:
+Cluster ID.
+Default value:
+N/A
|
@@ -39,29 +55,39 @@
Request Parameters
- Table 2 Request body parametersParameter
+Table 2 Request body parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
--
+ | subnet_id
|
-Yes
+ | Yes
|
-Object
+ | String
+ |
+Definition:
+Subnet ID.
+Constraints:
+The value must be standard UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
+Value range:
+The value must be standard UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
+Default value:
+N/A
|
- |
Response ParametersNone
+ Response ParametersStatus code: 200
+ Request succeeded.
+ None
Example RequestsModify the subnet of a cluster.
POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/subnet/change
@@ -73,26 +99,27 @@
Status Codes
- Status Code
+Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | Request succeeded.
|
-400
+ | 400
|
-Invalid request.
+ | Invalid request.
Modify the request and then retry.
|
-403
+ | 403
|
-Request rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
+ | Request rejected.
+The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
|
diff --git a/docs/css/api-ref/ChangeMode.html b/docs/css/api-ref/ChangeMode.html
index 2d0aa69e6..a2137b58a 100644
--- a/docs/css/api-ref/ChangeMode.html
+++ b/docs/css/api-ref/ChangeMode.html
@@ -1,36 +1,55 @@
Configuring the Security Mode.
-FunctionThis API is used to configure the security mode of a cluster.
+ FunctionThis API is used to configure the security mode of a cluster. The security mode settings for clusters include:
+ Security mode + HTTP: strikes a balance between performance and security. Make sure the cluster is deployed in a secure environment. Do not expose the cluster's network interface to the public network.
+Security mode + HTTPS: prioritizes security and in-transit data encryption, and allows public network access.
+
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/mode/change
+
+ URIPOST /v1.0/{project_id}/clusters/{cluster_id}/mode/change
- Table 1 Path ParametersParameter
+Table 1 Path ParametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Definition:
+Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+Constraints:
+N/A
+Value range:
+Project ID of the account.
+Default value:
+N/A
|
-cluster_id
+ | cluster_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Cluster ID.
+ | Definition:
+ID of the target cluster For details about how to obtain the cluster ID, see Obtaining the Cluster ID.
+Constraints:
+N/A
+Value range:
+Cluster ID.
+Default value:
+N/A
|
@@ -38,89 +57,109 @@
Request Parameters
- Table 2 Request body parametersParameter
+Table 2 Request body parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-authorityEnable
+ | authority_enable
|
-Yes
+ | Yes
|
-Boolean
+ | Boolean
|
-Security mode. Its value can be:
- |
-adminPwd
+ | admin_pwd
|
-No
+ | No
|
-String
+ | String
|
-Cluster password in security mode.
+ | Definition:
+Cluster password in security mode.
+Constraints:
+Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter.
+Value range:
+N/A
+Default value:
+N/A
|
-httpsEnable
+ | https_enable
|
-Yes
+ | Yes
|
-Boolean
+ | Boolean
|
-Enable HTTPS. Its value can be:
-true: enabled
-false: disabled
-Default value: true
+Definition:
+Whether to enable HTTPS for the cluster.
+Constraints:
+Elasticsearch: Only Elasticsearch 6.5.4 and later versions support security-mode clusters.
+HTTPS access can be disabled only for OpenSearch 1.3.6 and 2.19.0 security-mode clusters. For other versions, HTTPS access is forcibly enabled and cannot be disabled.
+true: Enable HTTPS.
+false: Disable HTTPS.
+Value range:
+Default value:
+true
|
|
Response ParametersNone
+ Response ParametersStatus code: 200
+ Request succeeded.
+ None
Example RequestsChange the security mode of the current cluster.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/mode/change
+POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/mode/change
{
- "authorityEnable" : true,
- "adminPwd" : "admin@1234",
- "httpsEnable" : true
+ "authority_enable" : true,
+ "admin_pwd" : "admin@1234",
+ "https_enable" : true
}
Status Codes
- Status Code
+Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | Request succeeded.
|
-400
+ | 400
|
-Invalid request.
+ | Invalid request.
Modify the request before retry.
|
-404
+ | 404
|
-The requested resource could not be found.
+ | The requested resource could not be found.
Modify the request before retry.
|
diff --git a/docs/css/api-ref/ChangeSecurityGroup.html b/docs/css/api-ref/ChangeSecurityGroup.html
index 369018a3d..b16e8aa5a 100644
--- a/docs/css/api-ref/ChangeSecurityGroup.html
+++ b/docs/css/api-ref/ChangeSecurityGroup.html
@@ -1,106 +1,133 @@
Changing the Security Group
-FunctionThis API is used to change the security group after a cluster is created.
- Before changing the security group, ensure that port 9200 has been enabled. Incorrect security group configuration may cause service access failures. Exercise caution when performing this operation.
+ FunctionThis API is used to change the security group after a cluster is created.
+ Before changing the security group, ensure that port 9200 has been enabled. Incorrect security group configuration may cause service access failures. Exercise caution when performing this operation.
+
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/sg/change
+
+ URIPOST /v1.0/{project_id}/clusters/{cluster_id}/sg/change
- Table 1 Path ParametersParameter
+Table 1 Path ParametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Definition:
+Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+Constraints:
+N/A
+Value range:
+Project ID of the account.
+Default value:
+N/A
|
-cluster_id
+ | cluster_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Cluster ID.
+ | Definition:
+ID of the cluster that you want to change the security group. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.
+Constraints:
+N/A
+Value range:
+Cluster ID.
+Default value:
+N/A
|
Request Parameters
- Table 2 Request body parametersParameter
+Request Parameters
+ Table 2 Request body parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-security_group_ids
+ | security_group_ids
|
-Yes
+ | Yes
|
-String
+ | String
|
-Security group ID.
+ | Definition:
+Security group ID.
+Constraints:
+N/A
+Value range:
+N/A
+Default value:
+N/A
|
Response ParametersNone
+ Response ParametersStatus code: 200
+ Request succeeded.
+ None
- Example RequestsChange the security group that the current cluster belongs to.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/sg/change
+Example RequestsChange the security group that the current cluster belongs to.
+ POST https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/sg/change
{
"security_group_ids" : "b1038649-1f77-4ae9-b64d-9af56e422652"
}
Example ResponsesNone
+
- Status Codes
- Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | Request succeeded.
|
-400
+ | 400
|
-Invalid request.
-The client should not repeat the request without modifications.
+ | Invalid request.
+The client should not repeat the request without modifications.
|
-403
+ | 403
|
-Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
+ | Request rejected.
+The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.
|
diff --git a/docs/css/api-ref/CreateAiOps.html b/docs/css/api-ref/CreateAiOps.html
index 95d702583..136ba9b84 100644
--- a/docs/css/api-ref/CreateAiOps.html
+++ b/docs/css/api-ref/CreateAiOps.html
@@ -1,67 +1,13 @@
Creating a Cluster Detection Task
- FunctionThis API is used to create a cluster detection task.
+ FunctionThis API is used to create a cluster detection task. A maximum of 30 detection tasks can be created for a single cluster.
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/ai-ops
+
+ URIPOST /v1.0/{project_id}/clusters/{cluster_id}/ai-ops
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the target cluster
- |
-
-
-
-
-
- Request Parameters
-
-
-
- Table 3 Request body parametersParameter
+Table 1 Path ParametersParameter
|
Mandatory
|
@@ -71,54 +17,124 @@
|---|
-name
+ | project_id
|
Yes
|
String
|
-Detection task name
+ | Definition:
+Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+Constraints:
+N/A
+Value range:
+Project ID of the account.
+Default value:
+N/A
|
-description
+ | cluster_id
|
-No
+ | Yes
|
String
|
-Detection task description
+ | Definition:
+ID of the target cluster. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.
+Constraints:
+N/A
+Value range:
+Cluster ID.
+Default value:
+N/A
|
-alarm
+ |
+
+ Request Parameters
+
- Table 4 alarmParameter
+Table 3 Request body parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-level
+ | name
|
-Yes
+ | Yes
|
-String
+ | String
|
-Sensitivity of an SMN alarm message.
+ | Detection task name
+ |
+
+description
+ |
+No
+ |
+String
+ |
+Detection task description
+ |
+
+alarm
+ |
+No
+ |
+alarm object
+ |
+After the detection task is complete, an SMN alarm message is sent.
+ |
+
+
+
+ Table 4 alarmParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+level
+ |
+Yes
+ |
+String
+ |
+Sensitivity of an SMN alarm message.
high
medium
suggestion
@@ -126,23 +142,25 @@
|
-smn_topic
+ | smn_topic
|
-Yes
+ | Yes
|
-String
+ | String
|
-SMN topic name
+ | SMN topic name
|
Response ParametersNone
+ Response ParametersStatus code: 200
+ Request succeeded.
+ None
Example RequestsCreate a cluster detection task.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops
+POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ai-ops
{
"name": " aiops-test ",
@@ -157,32 +175,32 @@
Status Codes
- Status Code
+Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | Request succeeded.
|
-400
+ | 400
|
-Invalid request.
+ | Invalid request.
Modify the request instead of retrying.
|
-409
+ | 409
|
-The request cannot be processed due to a conflict.
+ | The request cannot be processed due to a conflict.
This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
|
-412
+ | 412
|
-The server does not meet one of the requirements that the requester puts on the request.
+ | The server does not meet one of the requirements that the requester puts on the request.
|
diff --git a/docs/css/api-ref/CreateAutoCreatePolicy.html b/docs/css/api-ref/CreateAutoCreatePolicy.html
index bdd7b6348..d6ab83b97 100644
--- a/docs/css/api-ref/CreateAutoCreatePolicy.html
+++ b/docs/css/api-ref/CreateAutoCreatePolicy.html
@@ -3,34 +3,50 @@
Configuring the Automatic Snapshot Creation Policy
FunctionThis API is used to configure automatic snapshot creation. By default, a snapshot is created every day.
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
+
+ URIPOST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy
- Table 1 Path ParametersParameter
+Table 1 Path ParametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Definition:
+Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+Constraints:
+N/A
+Value range:
+Project ID of the account.
+Default value:
+N/A
|
-cluster_id
+ | cluster_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-ID of the cluster for which you want to create snapshots automatically.
+ | Definition:
+ID of the cluster for which you want to create snapshots automatically. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.
+Constraints:
+N/A
+Value range:
+Cluster ID.
+Default value:
+N/A
|
@@ -38,95 +54,152 @@
Request Parameters
- Table 2 Request body parametersParameter
+Table 2 Request body parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-indices
+ | indices
|
-No
+ | No
|
-String
+ | String
|
-Name of the index to be backed up. * indicates all indexes.
- |
-
-prefix
- |
-No
- |
-String
- |
-Prefix of a snapshot that is automatically created, which is manually entered.
-Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
- NOTE: This parameter is mandatory when enable is set to true.
- |
-
-period
- |
-No
- |
-String
- |
-Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.
- NOTE: The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful. This parameter is mandatory when enable is set to true.
- |
-
-keepday
- |
-No
- |
-Integer
- |
-Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.
- NOTE: This parameter is mandatory when enable is set to true.
- |
-
-enable
- |
-Yes
- |
-String
- |
-Whether to enable the automatic snapshot creation policy.
-true: The automatic snapshot creation policy is enabled.
-false:The automatic snapshot creation policy is disabled, and other parameters do not need to be delivered.
+Definition:
+Specify the name of the index you want to restore.
+Constraints:
+You can use "*" to match multiple indexes. For example, index* indicates that all indexes with the prefix index will be restored.
+Or you can restore indexes by specifying their names, for example, index1,index2,index3.
+When "*" is used for index matching, the .opendistro_security index and any system indexes whose name is prefixed with .kibana are filtered out by default. The .opendistro_security index cannot be restored. To restore an index whose name is prefixed with .kibana, you need to specify the index name.
+Value range:
+The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: "\<|>/?
+Default value:
+By default, this parameter is left blank.
+If you do not specify any index name, all indexes in snapshots will be restored by default.
|
|
-deleteAuto
+ | prefix
|
-No
+ | No
|
-String
+ | String
|
-Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled. The default value is false, indicating that automatically created snapshots will not be deleted. If this parameter is set to true, all created snapshots will be deleted when the automatic snapshot creation policy is disabled.
+ | Definition:
+Prefix of a snapshot that is automatically created, which is manually entered.
+Constraints:
+This parameter is mandatory when enable is set to true.
+Value range:
+Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
+Default value:
+N/A
|
-frequency
+ | period
|
-No
+ | No
|
-String
+ | String
|
-Frequency of automatically creating snapshots.
- NOTE: The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
+ | Definition:
+Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.
+Constraints:
+N/A
+Value range:
+N/A
+Default value:
+00:00 GMT+08:00
+ NOTE: The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful. This parameter is mandatory when enable is set to true.
+ |
+
+keepday
+ |
+No
+ |
+Integer
+ |
+Definition:
+Customize the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.
+Constraints:
+N/A
+Value range:
+1–90
+Default value:
+N/A
+ NOTE: This parameter is mandatory when enable is set to true.
+ |
+
+enable
+ |
+Yes
+ |
+String
+ |
+Definition:
+Whether to enable the automatic snapshot creation policy.
+Constraints:
+N/A
+Value range:
+
+Default value:
+N/A
+ |
+
+delete_auto
+ |
+No
+ |
+String
+ |
+Definition:
+Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled.
+Constraints:
+N/A
+Value range:
+true: Delete all automatically created snapshots when an automatic snapshot creation policy is disabled.
+false: Retain automatically created snapshots when an automatic snapshot creation policy is disabled.
+
+Default value:
+false
+ |
+
+frequency
+ |
+No
+ |
+String
+ |
+Definition:
+Frequency of automatically creating snapshots.
+Constraints:
+N/A
+Value range:
+HOUR: Execute once every hour on the hour.
+DAY: Execute once every day.
+SUN, MON, TUE, WED, THU, FRI, and SAT: Execute the task at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday.
+The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
+
+Default value:
+DAY
|
Response ParametersNone
+ Response ParametersStatus code: 200
+ Request succeeded.
+ None
Example RequestsConfigure the automatic snapshot creation policy.
- POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy
+POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/policy
{
"prefix" : "snapshot",
@@ -134,26 +207,26 @@
"keepday" : 7,
"frequency" : "DAY",
"enable" : "true",
- "deleteAuto" : "false"
+ "delete_auto" : "false"
}
Status Codes
- Status Code
+Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | Request succeeded.
|
-406
+ | 406
|
-The server could not fulfill the request according to the content characteristics of the request.
+ | The server could not fulfill the request according to the content characteristics of the request.
|
diff --git a/docs/css/api-ref/CreateBindPublic.html b/docs/css/api-ref/CreateBindPublic.html
index 6068c172b..7acaad8d6 100644
--- a/docs/css/api-ref/CreateBindPublic.html
+++ b/docs/css/api-ref/CreateBindPublic.html
@@ -1,67 +1,14 @@
Enabling Public Network Access
-FunctionThis API is used to enable public network access.
+ FunctionPublic network access is supported only when Security Mode and HTTPS Access are enabled for a cluster. When Public IP Address is enabled, a public IP address is automatically assigned, which will enable access to the security cluster from the public network. Additionally, you can configure access control from the public network by IP addresses or IP address ranges.
+ To enable public network access for Elasticsearch or OpenSearch clusters, a shared load balancer is typically used for load balancing. If your workloads require quicker access, you are advised to use a dedicated load balancer to connect to your clusters. For details about its configuration, see section "Configuring a Dedicated Load Balancer for an Elasticsearch Cluster."
- URIPOST /v1.0/{project_id}/clusters/{cluster_id}/public/open
+
+ URIPOST /v1.0/{project_id}/clusters/{cluster_id}/public/open
- Table 1 Path ParametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
- |
-
-cluster_id
- |
-Yes
- |
-String
- |
-ID of the cluster whose public network access you want to enable.
- |
-
-
-
-
-
- Request Parameters
- Table 2 Request body parametersParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-eip
- |
-Yes
- |
-BindPublicReqEip object
- |
-EIP information.
- |
-
-
-
-
-
- Table 3 BindPublicReqEipParameter
+Table 1 Path ParametersParameter
|
Mandatory
|
@@ -71,36 +18,143 @@
|---|
-bandWidth
+ | project_id
|
Yes
|
-BindPublicReqEipBandWidth object
+ | String
|
-Public network bandwidth.
+ | Definition:
+Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+Constraints:
+N/A
+Value range:
+Project ID of the account.
+Default value:
+N/A
+ |
+
+cluster_id
+ |
+Yes
+ |
+String
+ |
+Definition:
+ID of the cluster whose public network access you want to enable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.
+Constraints:
+N/A
+Value range:
+Cluster ID.
+Default value:
+N/A
+ |
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+eip
+ |
+Yes
+ |
+BindPublicReqEip object
+ |
+Definition:
+EIP for public network access.
+Constraints:
+N/A
+Value range:
+N/A
+Default value:
+N/A
+ |
+
+white_list
+ |
+No
+ |
+String
+ |
+Definition:
+Public network access control whitelist.
+Constraints:
+Separate the whitelisted CIDR blocks or IP addresses with commas (,), and make sure each of them is unique.
+Value range:
+N/A
+Default value:
+N/A
|
- Table 4 BindPublicReqEipBandWidthParameter
+Table 3 BindPublicReqEipParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-size
+ | band_width
|
-Yes
+ | Yes
|
-Integer
+ | BindPublicReqEipBandWidth object
|
-Bandwidth range. Unit: Mbit/s
+ | Definition:
+Public network bandwidth.
+Constraints:
+N/A
+Value range:
+N/A
+Default value:
+N/A
+ |
+
+
+
+ Table 4 BindPublicReqEipBandWidthParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+size
+ |
+Yes
+ |
+Integer
+ |
+Definition:
+Public network bandwidth, in Mbit/s.
+Constraints:
+N/A
+Value range:
+N/A
+Default value:
+N/A
|
@@ -109,31 +163,39 @@
Response ParametersStatus code: 200
- Table 5 Response body parametersParameter
+Table 5 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-action
+ | action
|
-String
+ | String
|
-Operations. The fixed value is bindZone, indicating that the binding is successful.
+ | Definition:
+A setting required to enable public network access.
+Value range:
+The fixed value is bindZone, indicating that the binding is successful.
|
Example Requests{
+Example RequestsEnable public network access.
+ POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/open
+
+{
"eip" : {
- "bandWidth" : {
+ "band_width" : {
"size" : 5
}
- }
+ },
+ "white_list" : "127.0.0.1",
+ "is_auto_pay" : 1
}
Example ResponsesStatus code: 200
@@ -143,32 +205,32 @@
}
Status Codes
- Status Code
+Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-Request succeeded.
+ | Request succeeded.
|
-400
+ | 400
|
-Invalid request.
+ | Invalid request.
Modify the request before retry.
|
-409
+ | 409
|
-The request could not be completed due to a conflict with the current state of the resource.
+ | The request could not be completed due to a conflict with the current state of the resource.
The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
|
-412
+ | 412
|
-The server did not meet one of the preconditions contained in the request.
+ | The server did not meet one of the preconditions contained in the request.
|
diff --git a/docs/css/api-ref/CreateCluster.html b/docs/css/api-ref/CreateCluster.html
index ba6ae0b5e..3903e5b96 100644
--- a/docs/css/api-ref/CreateCluster.html
+++ b/docs/css/api-ref/CreateCluster.html
@@ -1,572 +1,839 @@
-Creating a cluster
-FunctionThis API is used to create a cluster.
+ Creating a Cluster (Discarded)
+ FunctionThis API can only be used to create clusters that contain a single type of nodes. To create clusters that contain multiple types of nodes (ess, ess-cold, ess-client, and ess-master), use the API for Creating a Cluster v2.
- URIPOST /v1.0/{project_id}/clusters
+
+ URIPOST /v1.0/{project_id}/clusters
- Table 1 Path ParametersParameter
+Table 1 Path ParametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+ | Definition:
+Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
+Constraints:
+N/A
+Value range:
+Project ID of the account.
+Default value:
+N/A
|
Request Parameters
- Table 2 Request body parametersParameter
+Request Parameters
+ Table 2 Request body parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-cluster
+ | cluster
|
-Yes
+ | Yes
|
-CreateClusterBody object
+ | CreateClusterBody object
|
-Cluster object.
+ | Parameter description:
+Cluster object.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
- Table 3 CreateClusterBodyParameter
+Table 3 CreateClusterBodyParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-instance
+ | instance
|
-Yes
+ | Yes
|
-CreateClusterInstanceBody object
+ | CreateClusterInstanceBody object
|
-Instance.
+ | Parameter description:
+Array of Buffer instances, whose memory is to be shared.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-datastore
+ | datastore
|
-Yes
+ | Yes
|
-CreateClusterDatastoreBody object
+ | CreateClusterDatastoreBody object
|
-Search engine.
+ | Definition:
+Search engine.
+Constraints:
+N/A
+Value range:
+N/A
+Default value:
+N/A
|
-name
+ | name
|
-Yes
+ | Yes
|
-String
+ | String
|
-Cluster name It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.
+ | Definition:
+Cluster name.
+Constraints:
+N/A
+Value range:
+It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.
+Default value:
+N/A
|
-instanceNum
+ | desc
|
-Yes
+ | No
|
-Integer
+ | String
|
-Number of clusters. The value range is 1 to 32.
+ | Definition:
+Cluster description.
+Constraints:
+Enter a maximum of 128 characters.
+Value range:
+The value can contain digits, letters, periods (.), hyphens (-), underscores (_), and other special characters.
+Default value:
+N/A
|
-backupStrategy
+ | instanceNum
|
-No
+ | Yes
|
-CreateClusterBackupStrategyBody object
+ | Integer
|
-Automatic snapshot creation policy, which is disabled by default.
-The automatic snapshot creation policy is enabled only if backupStrategy is not left blank.
+ | Definition:
+Number of cluster instances.
+Constraints:
+N/A
+Value range:
+1–32.
+Default value:
+N/A
|
-httpsEnable
+ | backupStrategy
|
-No
+ | No
|
-Boolean
+ | CreateClusterBackupStrategyBody object
|
-Whether communication is encrypted on the cluster. The value can be true or false. By default, communication encryption is disabled. If httpsEnable is set to true, authorityEnable must be set to true.
-true: Communication is encrypted on the cluster.
-false: Communication is not encrypted on the cluster.
+Parameter description:
+Automatic snapshot creation policy, which is disabled by default.
+The automatic snapshot creation policy is enabled only when backupStrategy is not left blank.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
+ |
+
|
+httpsEnable
+ |
+No
+ |
+Boolean
+ |
+Definition:
+Whether communication is encrypted on the cluster. The value can be true or false. By default, communication encryption is disabled. When httpsEnable is set to true, authorityEnable must be set to true.
+Constraints:
+Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter.
+HTTPS access can be disabled only for OpenSearch 1.3.6 and 2.19.0 security-mode clusters. For other versions, HTTPS access is forcibly enabled and cannot be disabled.
+Value range:
+
-This parameter is supported in clusters 6.5.4 or later.
+Default value:
+false
|
-authorityEnable
+ | authorityEnable
|
-No
+ | No
|
-Boolean
+ | Boolean
|
-Whether to enable authentication. The value can be true or false. Authentication is disabled by default.
-true indicates that authentication is enabled for the cluster.
-true indicates that authentication is enabled for the cluster.
+Definition:
+Whether to enable authentication. Available values include true and false. Authentication is disabled by default.
+Constraints:
+Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter.
+Value range:
+
-This parameter is supported in clusters 6.5.4 or later.
+Default value:
+false
|
|
-adminPwd
+ | adminPwd
|
-No
+ | No
|
-String
+ | String
|
-Password of the cluster user admin in security mode. This parameter is mandatory only if authorityEnable is set to true.
-The administrator password must meet the following requirements:
-The password can contain 8 to 32 characters.
-Passwords must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^&*()-_=+\|[{}];:,<.>/?).
-
-Weak password verification is required for a security cluster. You are advised to set a strong password.
+Parameter description:
+Password of the cluster user admin in security mode. This parameter is mandatory only when authorityEnable is set to true. Weak password verification is required for a security cluster. You are advised to set a strong password.
+Constraints:
+The administrator password must meet the following requirements:
+The password can contain 8 to 32 characters.
+Passwords must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters ~!@#$%^&*()-_=+\|[{}];:,<.>/?
+Options:
+See Constraints.
+Default value:
+N/A
|
|
-enterprise_project_id
+ | enterprise_project_id
|
-No
+ | No
|
-String
+ | String
|
-Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
+ | Parameter description:
+Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-tags
+ | tags
|
-No
+ | No
|
-Array of CreateClusterTagsBody objects
+ | Array of CreateClusterTagsBody objects
|
-Cluster tag.
+ | Parameter description:
+Cluster tags.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-ipv6_enable
+ | ipv6_enable
|
-No
+ | No
|
-Boolean
+ | Boolean
|
-Whether to enable automatic IPv6 address assignment for the cluster. The default value is false.
- |
-
-diskEncryption
- |
-No
- |
-diskEncryptionInfo object
- |
-Disk encryption information.
+ | Definition:
+Whether to enable automatic IPv6 address assignment for the cluster. The default value is false.
+Constraints:
+N/A
+Value range:
+N/A
+Default value:
+false
|
Table 4 CreateClusterInstanceBodyParameter
+Table 4 CreateClusterInstanceBodyParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-flavorRef
+ | flavorRef
|
-Yes
+ | Yes
|
-String
+ | String
|
-Instance flavor. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.
+ | Parameter description:
+Instance flavor name. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-volume
+ | volume
|
-Yes
+ | Yes
|
-CreateClusterInstanceVolumeBody object
+ | CreateClusterInstanceVolumeBody object
|
-Volume information. You do not need to set this parameter when flavorRef is set to a local disk flavor. Currently, the following local disk flavors are supported:
-ess.spec-i3small
-ess.spec-i3medium
-ess.spec-i3.8xlarge.8
-ess.spec-ds.xlarge.8
-ess.spec-ds.2xlarge.8
-ess.spec-ds.4xlarge.8
+Parameter description:
+Volume information. You do not need to set this parameter when flavorRef is set to a local disk flavor. Currently, the following local disk flavors are supported:
+ess.spec-i3small
+ess.spec-i3medium
+ess.spec-i3.8xlarge.8
+ess.spec-ds.xlarge.8
+ess.spec-ds.2xlarge.8
+ess.spec-ds.4xlarge.8
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
|
-nics
+ | nics
|
-Yes
+ | Yes
|
-CreateClusterInstanceNicsBody object
+ | CreateClusterInstanceNicsBody object
|
-Subnet ID.
+ | Parameter description:
+Subnet information.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-availability_zone
+ | availability_zone
|
-Yes
+ | Yes
|
-String
+ | String
|
-One or more AZs. You need to specify the AZ names.
-By default, a single AZ is specified. If multiple AZs are specified, use commas (,) to separate different AZ names. For example, if three AZs are selected under region-1, the value of availability_zone is region-1a,region-1b,region-1c. If a single AZ is used, the value of availability_zone is empty by default.
- NOTE: Note: - If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.
- - If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ.
+ Definition:
+AZ of the node. The AZ name needs to be specified.
+Constraints:
+When specifying the AZs of nodes, use commas (,) to separate different AZ names. For example, if multiple AZs are selected for general AZs, the value of availability_zone is region-1a,region-1b,region-1c.
+Value range:
+N/A
+Default value:
+availability_zone is empty by default, indicating that a single AZ is used.
+ NOTE: If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.
+ If the number of nodes is evenly divisible by the number of AZs, the nodes will be evenly distributed among all AZs.
+ If the number of nodes is not evenly divisible by the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.
+ AZ name. Obtain it from Regions and Endpoints in section "Before You Start".
-If the number of nodes is not a multiple of the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.
-Obtain the AZ names from Regions and Endpoints in section "Before You Start".
+
|
+ |
+
+
+ Table 5 CreateClusterInstanceVolumeBodyParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+volume_type
+ |
+Yes
+ |
+String
+ |
+Parameter description:
+Volume type.
+Constraints:
+N/A
+Options:
+
+Default value:
+N/A
|
-
-
- Table 5 CreateClusterInstanceVolumeBodyParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-volume_type
+ | size
|
-Yes
+ | Yes
|
-String
+ | Integer
|
-Volume type
-COMMON: common I/O
-HIGH: high I/O
-ULTRAHIGH: ultra-high I/O
-ESSD: ultra-fast SSD
+Definition:
+Disk size.
+Constraints:
+The value must be greater than 0 and a common multiple of 4 and 10, in GB.
+Value range:
+You can obtain the disk size from the diskrange attribute in Obtaining the Instance Specifications List.
+Default value:
+ess and ess-cold nodes: 100 GB or the minimum disk capacity supported by the selected node flavor, whichever is larger.
+ess-master and ess-client nodes: The default volume size is 40 GB and cannot be changed.
- |
-
|
-size
- |
-Yes
- |
-Integer
- |
-Volume size. The value must be greater than 0 and a multiple of 4 and 10. For details about the local disk size, see the diskrange attribute in Obtaining the Instance Specifications List. Unit: GB
+ NOTE: For ess and ess-cold nodes, 100 GB or a larger value is recommended.
+
|
Table 6 CreateClusterInstanceNicsBodyParameter
+Table 6 CreateClusterInstanceNicsBodyParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-vpcId
+ | vpcId
|
-Yes
+ | Yes
|
-String
+ | String
|
-VPC ID, which is used for configuring cluster network.
+ | Parameter description:
+VPC ID, which is used for configuring cluster network.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-netId
+ | netId
|
-Yes
+ | Yes
|
-String
+ | String
|
-Subnet ID (network ID).
+ | Parameter description:
+Subnet ID (network ID).
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-securityGroupId
+ | securityGroupId
|
-Yes
+ | Yes
|
-String
+ | String
|
-Security group ID.
- |
-
-ip
- |
-No
- |
-String
- |
-Node IP address.
+ | Parameter description:
+Security group ID
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
Table 7 CreateClusterDatastoreBodyParameter
+Table 7 CreateClusterDatastoreBodyParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-version
+ | version
|
-Yes
+ | Yes
|
-String
+ | String
|
-Elasticsearch/Logstash engine version. For details, see the supported versions in Before You Start.
+ | Parameter description:
+Elasticsearch/Logstash engine version. For details, see the supported versions in Before You Start.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-type
+ | type
|
-Yes
+ | Yes
|
-String
+ | String
|
-Engine type. The value can be elasticsearch, logstash, or opensearch.
+ | Definition:
+Engine type of the cluster to be created.
+Constraints:
+N/A
+Value range:
+elasticsearch: Elasticsearch cluster.
+opensearch: OpenSearch cluster.
+logstash: Logstash cluster.
+
+Default value:
+N/A
|
Table 8 CreateClusterBackupStrategyBodyParameter
+Table 8 CreateClusterBackupStrategyBodyParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-period
+ | period
|
-Yes
+ | Yes
|
-String
+ | String
|
-Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.
- NOTE: The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.
+ | Definition:
+Time when a snapshot is generated every day.
+Constraints:
+N/A
+Value range:
+Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.
+Default value:
+00:00 GMT+08:00
+ NOTE: When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.
+
|
-prefix
+ | prefix
|
-Yes
+ | Yes
|
-String
+ | String
|
-Prefix of a snapshot that is automatically created, which is manually entered. Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
+ | Definition:
+Prefix of a snapshot that is automatically created, which is manually entered.
+Constraints:
+N/A
+Value range:
+Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.
+Default value:
+N/A
|
-keepday
+ | keepday
|
-Yes
+ | Yes
|
-Integer
+ | Integer
|
-Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.
+ | Definition:
+Set the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.
+Constraints:
+N/A
+Value range:
+1–90
+Default value:
+N/A
|
-bucket
+ | bucket
|
-No
+ | No
|
-String
+ | String
|
-Name of the OBS bucket used for backup.
+ | Parameter description:
+Name of the OBS bucket used for backup.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-basePath
+ | basePath
|
-No
+ | No
|
-String
+ | String
|
-Storage path of the snapshot in the OBS bucket.
+ | Parameter description:
+Storage path of the snapshot in the OBS bucket.
+Constraints:
+N/A
+Options:
+N/A
+Default value:
+N/A
|
-agency
+ | agency
|
-No
+ | No
|
-String
+ | String
|
-Agency name. You can create an agency to allow CSS to call other cloud services. The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.
- NOTE: If none of the bucket, basePath, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.
+ | Definition:
+Agency name. You can create an agency to allow CSS to call other cloud services. An agency name cannot contain special characters or Chinese characters.
+Constraints:
+N/A
+Value range:
+Only a-z, A-Z, 0-9, hyphens (-) and underscores (_) are allowed.
+Default value:
+N/A
+ NOTE: If none of the bucket, basePath, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.
+
|
-frequency
+ | frequency
|
-No
+ | No
|
-String
+ | String
|
-Frequency of automatically creating snapshots.
- NOTE: The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
+ | Definition:
+Frequency of automatically creating snapshots.
+Constraints:
+N/A
+Value range:
+HOUR: Execute once every hour on the hour.
+DAY: Execute once every day.
+SUN, MON, TUE, WED, THU, FRI, and SAT: Execute the task at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday.
+The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.
+
+Default value:
+DAY
+ |
+
+maxSnapshotBytesPerSeconds
+ |
+No
+ |
+String
+ |
+Definition:
+This parameter sets the maximum backup speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.
+Constraints:
+N/A
+Value range:
+The following values and formats are allowed:
+
+The number ranges from 0 to 9999.
+The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).
+0mb means there is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.
+
+There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.
+
+There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.
+Default value:
+The default value is 40 MB. If this parameter is left blank, the default value is used.
+ |
+
+maxRestoreBytesPerSeconds
+ |
+No
+ |
+String
+ |
+Definition:
+This parameter sets the maximum recovery speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.
+Constraints:
+For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached.
+Value range:
+The following values and formats are allowed:
+
+The number ranges from 0 to 9999.
+The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).
+0mb means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.
+
+There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.
+
+There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.
+Default value:
+For Elasticsearch clusters of 7.6.2 or earlier, the default setting is 40mb.
+For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter.
+If this parameter is left blank, the default setting is used.
|
Table 9 CreateClusterTagsBodyParameter
+Table 9 CreateClusterTagsBodyParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-key
+ | key
|
-Yes
+ | Yes
|
-String
+ | String
|
-Separate multiple AZs with commas (,). For example, to specify three AZs in CN North-Beijing4, you can set availability_zone to cn-north-4a,cn-north-4b,cn-north-4c. By default, a single AZ is created when this parameter is not specified.
+ | Definition:
+Tag key.
+Constraints:
+N/A
+Value range:
+The value can contain 1 to 36 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.
+Default value:
+N/A
|
-value
+ | value
|
-Yes
+ | Yes
|
-String
+ | String
|
-Tag value. The value can contain 0 to 43 characters. It can only contain digits, letters, hyphens (-), and underscores (_).
+ | Definition:
+Tag value.
+Constraints:
+N/A
+Value range:
+ | |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|