Parameter +
|
|---|
This API is used to add master and client nodes to a cluster.
+For details, see Calling APIs.
+POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independent
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. + |
+
cluster_id + |
+Yes + |
+String + |
+ID of the cluster that needs an independent master or client. + |
+
type + |
+Yes + |
+String + |
+Node type. The value can be: +
|
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
type + |
+Yes + |
+IndependentBodyReq object + |
+Master/Client request body parameter + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
flavor_ref + |
+Yes + |
+String + |
+Flavor ID. You can obtain the value of this parameter by calling the API Obtaining the Instance Specifications List. Select the flavor ID suitable for your cluster version. + |
+
node_size + |
+Yes + |
+Integer + |
+Number of nodes. +
|
+
volume_type + |
+Yes + |
+String + |
+Node storage type. Its value can be ULTRAHIGH, COMMON, or HIGH. + |
+
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Cluster ID. + |
+
Add the master and client nodes.
+POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/type/ess-client/independent
+
+{
+ "type" : {
+ "flavor_ref" : "d9dc06ae-b9c4-4ef4-acd8-953ef4205e27",
+ "node_size" : 3,
+ "volume_type" : "COMMON"
+ }
+}
+Status code: 200
+The request is processed.
+{
+ "id" : "320afa24-ff2a-4f44-8460-6ba95e512ad4"
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+The request is processed. + |
+
403 + |
+The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it. + |
+
500 + |
+The server can be accessed by the request, but it cannot understand the user's request. + |
+
For details, see Error Code.
+This API is used to query and display the IDs of supported instance flavors.
+GET /v1.0/{project_id}/flavors
+
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. For details, see Obtaining a Project ID and Name. + |
+
None
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
versions + |
+Array of versions objects + |
+List of engine versions. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
version + |
+String + |
+Engine version. + |
+
type + |
+String + |
+Instance type. The options are ess, ess-cold, ess-master, and ess-client. + |
+
flavors + |
+Array of flavors objects + |
+Flavor list + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
ram + |
+Integer + |
+Memory size of an instance. Unit: GB + |
+
cpu + |
+Integer + |
+Number of vCPUs of an instance. + |
+
name + |
+String + |
+Flavor name. + |
+
region + |
+String + |
+AZ + |
+
diskrange + |
+String + |
+Disk capacity range of an instance. + |
+
flavor_id + |
+String + |
+ID of a flavor. + |
+
GET /v1.0/6204a5bd270343b5885144cf9c8c158d/flavors+
Example response
+{
+ "versions": [
+ {
+ "version": "6.2.3",
+ "flavors": [
+ {
+ "cpu": 1,
+ "ram": 8,
+ "name": "css.medium.8",
+ "region": "eu-de",
+ "diskrange": "40,640",
+ "flavor_id": "6b6c0bcf-750d-4f8a-b6f5-c45a143f5198"
+
+ },
+ {
+ "cpu": 2,
+ "ram": 16,
+ "name": "css.large.8",
+ "region": "eu-de",
+ "diskrange": "40,1280",
+ "flavor_id": "d373e339-3cf4-4c00-9739-2259e9f3ec16"
+
+ },
+ {
+ "cpu": 4,
+ "ram": 32,
+ "name": "css.xlarge.8",
+ "region": "eu-de",
+ "diskrange": "40,2560",
+ "flavor_id": "2d8daf1b-873f-4c2e-a7b9-2f9cbcf2f213"
+
+ },
+ {
+ "cpu": 8,
+ "ram": 64,
+ "name": "css.2xlarge.8",
+ "region": "eu-de",
+ "diskrange": "80,5120",
+ "flavor_id": "b3d33ec6-d58a-40f0-aa51-4f671ce64b2a"
+
+ },
+ {
+ "cpu": 16,
+ "ram": 128,
+ "name": "css.4xlarge.8",
+ "region": "eu-de",
+ "diskrange": "160,10240",
+ "flavor_id": "f74419ca-bc91-4558-b4e2-90eeefb37c6e"
+ }
+ ]
+ }
+ ]
+}
+Table 5 describes the status code.
+ +Status Code + |
+Message + |
+Description + |
+
|---|---|---|
400 + |
+BadRequest + |
+Invalid request. +Modify the request instead of retrying. + |
+
404 + |
+NotFound + |
+The requested resource cannot be found. +Modify the request instead of retrying. + |
+
200 + |
+OK + |
+The request is processed. + |
+
This API is used to obtain the ID of an image that can be upgraded in the current cluster.
+For details, see Calling APIs.
+GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. + |
+
cluster_id + |
+Yes + |
+String + |
+ID of the cluster to be upgraded. + |
+
upgrade_type + |
+Yes + |
+String + |
+Version type. The value can be: +
|
+
None
+Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
needUploadUpgradePlugin + |
+Boolean + |
+Indicates whether to upload the plug-in of the target version. + |
+
imageInfoList + |
+Array of GetTargetImageIdDetail objects + |
+Image details. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+ID of an image that can be upgraded. + |
+
displayName + |
+String + |
+Name of an image that can be upgraded. + |
+
imageDesc + |
+String + |
+Image description. + |
+
datastoreType + |
+String + |
+Image engine type. + |
+
datastoreVersion + |
+String + |
+Image engine version. + |
+
priority + |
+Integer + |
+Priority + |
+
GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/target/cross/images
+
+{
+ "needUploadUpgradePlugin" : false,
+ "imageInfoList" : [ ]
+}
+Status code: 200
+The request is processed.
+{
+ "needUploadUpgradePlugin" : false,
+ "imageInfoList" : [ ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+The request is processed. + |
+
400 + |
+Invalid request. Modify the request directly and do not attempt to retry it. + |
+
403 + |
+The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it. + |
+
For details, see Error Code.
+This API is used to change the password of a cluster.
+For details, see Calling APIs.
+POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. + |
+
cluster_id + |
+Yes + |
+String + |
+ID of the cluster whose password you want to change. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
newpassword + |
+Yes + |
+String + |
+Password of the cluster user admin in security mode. This API is available only when authorityEnable is set to true. +
|
+
None
+Change the administrator password of the current cluster.
+POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/password/reset
+
+{
+ "newpassword" : "xxxxxx"
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+The request is processed. + |
+
400 + |
+Invalid request. +Modify the request instead of retrying. + |
+
409 + |
+The request cannot be processed due to a conflict. +This status code indicates that the resource the client is attempting to create already exists, or that the update operation requested cannot be completed due to a conflict. + |
+
412 + |
+The server did not satisfy one of the preconditions set by the requester in the request. + |
+
For details, see Error Code.
+The upgrade takes a long time and the upgrade may fail due to network problems. You can use this API to retry a task or terminate the impact of a task.
+For details, see Calling APIs.
+PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retry
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. + |
+
cluster_id + |
+Yes + |
+String + |
+ID of the cluster to be retried. + |
+
action_id + |
+Yes + |
+String + |
+ID of the task to be retried. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
retry_mode + |
+No + |
+String + |
+If this parameter is not left blank, the impact of the task is terminated. Currently, only abort is supported. + |
+
None
+None
+PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry+
PUT /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/bcdb711c-a7f0-4007-b8ee-9f13c05f8326/retry?retry_mode=abort+
None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+The request is processed. + |
+
400 + |
+Invalid request. Modify the request directly and do not attempt to retry it. + |
+
403 + |
+The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it. + |
+
For details, see Error Code.
+This API is used to query and display details about a cluster.
+You can debug this API in . Automatic authentication is supported.
+GET /v1.0/{project_id}/clusters/{cluster_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. For details, see Obtaining a Project ID and Name. + |
+
cluster_id + |
+Yes + |
+String + |
+ID of the cluster to be queried + |
+
None
+Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
datastore + |
+ClusterDetailDatastore object + |
+Search engine type + |
+
instances + |
+Array of ClusterDetailInstances objects + |
+Node object list + |
+
publicKibanaResp + |
+publicKibanaRespBody object + |
+Kibana public network access information + |
+
elbWhiteList + |
+elbWhiteListResp object + |
+Public network access information + |
+
updated + |
+String + |
+Last modification time of a cluster. The format is ISO8601: CCYY-MM-DDThh:mm:ss. + |
+
name + |
+String + |
+Cluster name + |
+
publicIp + |
+String + |
+Public IP address + |
+
created + |
+String + |
+Time when a cluster is created. The format is ISO8601: CCYY-MM-DDThh:mm:ss. + |
+
id + |
+String + |
+Cluster ID. + |
+
status + |
+String + |
+Cluster status. +
|
+
endpoint + |
+String + |
+IP address and port number for accessing VPC + |
+
vpcId + |
+String + |
+VPC ID. + |
+
subnetId + |
+String + |
+Subnet ID. + |
+
securityGroupId + |
+String + |
+Security group ID + |
+
vpcepIp + |
+String + |
+VPC endpoint IP address + |
+
bandwidthSize + |
+Integer + |
+Public network bandwidth Unit: Mbit/s + |
+
httpsEnable + |
+Boolean + |
+Communication encryption status. +
|
+
diskEncrypted + |
+Boolean + |
+Indicates whether disks are encrypted. +
|
+
authorityEnable + |
+Boolean + |
+Indicates whether to enable authentication. The value can be true or false. Authentication is disabled by default. +
|
+
backupAvailable + |
+Boolean + |
+Indicates whether the snapshot function is enabled. +
|
+
actionProgress + |
+Object + |
+Cluster operation progress, which displays the progress of cluster creation or scale-out in percentage. + |
+
actions + |
+Array of strings + |
+Current behavior of a cluster. The value can be REBOOTING, GROWING, RESTORING, and SNAPSHOTTING. + |
+
enterpriseProjectId + |
+String + |
+ID of the enterprise project to which a cluster belongs. +If the user of the cluster does not enable the enterprise project, the setting of this parameter is not returned. + |
+
tags + |
+Array of ClusterDetailTags objects + |
+Cluster tag + |
+
failedReason + |
+ClusterDetailFailedReasons object + |
+Failure cause. If the cluster is in the Available state, this parameter is not returned. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
type + |
+String + |
+Engine type. Currently, only Elasticsearch is supported. + |
+
version + |
+String + |
+CSS cluster engine version. For details, see Supported Cluster Versions. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Node status value. +
|
+
type + |
+String + |
+Node type + |
+
id + |
+Integer + |
+Instance ID + |
+
name + |
+String + |
+Instance name + |
+
specCode + |
+String + |
+Node specifications. + |
+
azCode + |
+String + |
+AZ to which a node belongs. + |
+
ip + |
+String + |
+Instance IP address + |
+
volume + |
+ShowClusterVolumeRsp object + |
+Instance disk information + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
type + |
+String + |
+Instance disk type + |
+
size + |
+Integer + |
+Instance disk size + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
eipSize + |
+Integer + |
+Bandwidth. Unit: Mbit/s + |
+
elbWhiteListResp + |
+kibanaElbWhiteListResp object + |
+Kibana public network access information + |
+
publicKibanaIp + |
+String + |
+Kibana access IP address + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
enableWhiteList + |
+Boolean + |
+Indicates whether access control is enabled. +
|
+
whiteList + |
+String + |
+Whitelist for Kibana public network access + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
enableWhiteList + |
+Boolean + |
+Indicates whether public access control is enabled. +
|
+
whiteList + |
+String + |
+Whitelist for public network access + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Tag key. + |
+
value + |
+String + |
+Tag value + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errorCode + |
+String + |
+Error code. +
|
+
errorMsg + |
+String + |
+Detailed error information + |
+
None
+Status code: 200
+The request is processed successfully.
+{
+ "datastore" : {
+ "type" : "elasticsearch",
+ "version" : "x.x.x"
+ },
+ "instances" : [ {
+ "status" : "200",
+ "type" : "ess",
+ "id" : "3c7fe582-a9f6-46fd-9d01-956bed4a8bbc",
+ "name" : "ES-xx",
+ "specCode" : "css.xlarge.2",
+ "azCode" : "xx-xxx-xx",
+ "ip" : "192.168.0.x",
+ "volume" : {
+ "type" : "COMMON",
+ "size" : 40
+ }
+ } ],
+ "publicKibanaResp" : {
+ "eipSize" : 5,
+ "publicKibanaIp" : "100.95.158.x",
+ "elbWhiteListResp" : {
+ "whiteList" : "11.11.11.11",
+ "enableWhiteList" : true
+ }
+ },
+ "updated" : "2018-01-16T08:37:18",
+ "name" : "ES-xx",
+ "publicIp" : "100.95.149.xx:9200",
+ "elbWhiteList" : {
+ "whiteList" : "10.10.10.10",
+ "enableWhiteList" : true
+ },
+ "created" : "2018-01-16T08:37:18",
+ "id" : "5c77b71c-5b35-4f50-8984-76387e42451a",
+ "status" : "200",
+ "endpoint" : "192.168.0.x:9200",
+ "vpcId" : "07e7ab39-xxx-xxx-xxx-d3f28ea7f051",
+ "subnetId" : "025d45f9-xxx-xxx-xxx-e852c6455a5e",
+ "securityGroupId" : "0347aabc-xxx-xxx-xxx-6b10a79701e2",
+ "vpcepIp" : "192.168.0.203",
+ "bandwidthSize" : 0,
+ "diskEncrypted" : false,
+ "httpsEnable" : true,
+ "authorityEnable" : true,
+ "backupAvailable" : true,
+ "actionProgress" : { },
+ "actions" : [ ],
+ "enterpriseProjectId" : "3e1c74a0-xxx-xxx-xxx-c6b9e46cf81b",
+ "tags" : [ {
+ "key" : "k1",
+ "value" : "v1"
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+The request is processed. + |
+
400 + |
+Invalid request. +Modify the request instead of retrying. + |
+
404 + |
+The requested resource cannot be found. +Modify the request instead of retrying. + |
+
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/{cluster_id}/inst-type/{inst_type}/image/upgrade
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. + |
+
cluster_id + |
+Yes + |
+String + |
+ID of the cluster to be upgraded. + |
+
inst_type + |
+Yes + |
+String + |
+Type of the node to be upgraded. Currently, its value can only be all. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
target_image_id + |
+Yes + |
+String + |
+ID of the target image version. + |
+
upgrade_type + |
+Yes + |
+String + |
+Upgrade type. +
The value can be: +
|
+
indices_backup_check + |
+Yes + |
+Boolean + |
+Indicates whether to perform backup verification. +
The value can be: +
|
+
agency + |
+Yes + |
+String + |
+Agency name. You can create an agency to allow CSS to call other cloud services. + |
+
cluster_load_check + |
+No + |
+Boolean + |
+Indicates whether to verify the load. The default value is true. +
|
+
None
+Update a cluster version.
+POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/inst-type/all/image/upgrade
+
+{
+ "target_image_id" : "{target_image_id}",
+ "upgrade_type" : "same",
+ "indices_backup_check" : true,
+ "agency" : "css-test-agency",
+ "cluster_load_check" : true
+}
+None
+Status Code + |
+Description + |
+
|---|---|
200 + |
+The request is processed. + |
+
400 + |
+Invalid request. +Modify the request directly and do not attempt to retry it. + |
+
409 + |
+The request cannot be processed due to a conflict. +This status code indicates that the resource the client is attempting to create already exists, or that the update operation requested cannot be completed due to a conflict. + |
+
412 + |
+The server did not satisfy one of the preconditions set by the requester in the request. + |
+
For details, see Error Code.
+The upgrade takes a long time. You can call this API to check the upgrade progress on a node.
+For details, see Calling APIs.
+GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detail
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID and Name. + |
+
cluster_id + |
+Yes + |
+String + |
+ID of the cluster to be upgraded. + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
start + |
+No + |
+Integer + |
+Offset. All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services. + |
+
limit + |
+No + |
+Integer + |
+Maximum number of connections displayed on each page. + |
+
action_mode + |
+No + |
+String + |
+Upgrade querying behavior. +
|
+
None
+Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
totalSize + |
+Integer + |
+Number of times a request is delivered to the execution API. + |
+
detailList + |
+Array of GetUpgradeDetailInfo objects + |
+Upgrade task details. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Task ID + |
+
startTime + |
+String + |
+Start time of the upgrade. + |
+
endTime + |
+String + |
+End time of the upgrade. + |
+
status + |
+String + |
+Task status. The value can be: +
|
+
agencyName + |
+String + |
+Agency name. You can create an agency to allow CSS to call other cloud services. + |
+
imageInfo + |
+GetTargetImageIdDetail object + |
+Image details. + |
+
totalNodes + |
+String + |
+Names of the nodes to be upgraded. + |
+
completedNodes + |
+String + |
+Names of the nodes that have been upgraded. + |
+
currentNodeName + |
+String + |
+Names of the nodes that are being upgraded. + |
+
executeTimes + |
+String + |
+Retried times + |
+
migrateParam + |
+String + |
+Current upgrade behavior of the cluster. The value is displayed if the query parameter exists. + |
+
finalAzInfoMap + |
+String + |
+Expected result of the cluster upgrade. The value is displayed if the query parameter exists. + |
+
currentNodeDetail + |
+Array of CurrentNodeDetail objects + |
+Task details of the node that is being upgraded. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+ID of an image that can be upgraded. + |
+
displayName + |
+String + |
+Name of an image that can be upgraded. + |
+
imageDesc + |
+String + |
+Image description. + |
+
datastoreType + |
+String + |
+Image engine type. + |
+
datastoreVersion + |
+String + |
+Image engine version. + |
+
priority + |
+Integer + |
+Priority + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
order + |
+Integer + |
+Sequence number of an upgrade task. + |
+
name + |
+String + |
+Upgrade task name. + |
+
status + |
+String + |
+Status of the current task. + |
+
desc + |
+String + |
+Description of the current task. + |
+
beginTime + |
+String + |
+Start time of the current task. + |
+
endTime + |
+String + |
+End time of the current task. + |
+
GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail+
GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/upgrade/detail?action_mode=AZ_MIGRATION+
Status code: 200
+The request is processed.
+{
+ "totalSize" : 1,
+ "detailList" : [ {
+ "id" : "b7ac4c5b-3bda-4feb-a303-eb80f4bce986",
+ "startTime" : "2023-01-05T02:23:39",
+ "endTime" : "",
+ "status" : "RUNNING",
+ "agencyName" : "css_test_agency",
+ "imageInfo" : {
+ "id" : "439b5d30-5968-45df-b088-d030a858522d",
+ "displayName" : "7.10.2_22.5.1_1230",
+ "imageDesc" : "The latest image of version 7.10.2 will be officially released on December 30, 2022. the stability of the cluster has been optimized. It is recommended that you upgrade to this version.",
+ "datastoreType" : "elasticsearch",
+ "datastoreVersion" : "7.10.2",
+ "priority" : 16
+ },
+ "totalNodes" : "css-test-ess-esn-1-1,css-test-ess-esn-2-1,css-test-ess-esn-3-1",
+ "completedNodes" : "",
+ "currentNodeName" : "css-test-ess-esn-1-1",
+ "executeTimes" : "1",
+ "currentNodeDetail" : [ {
+ "order" : 0,
+ "name" : "Data migration",
+ "status" : "SUCCESS",
+ "desc" : "Data is migrated from a node to other nodes in the cluster by running the exclude command.",
+ "beginTime" : "2023-01-05T02:23:42",
+ "endTime" : "2023-01-05T02:29:51"
+ }, {
+ "order" : 12,
+ "name" : "Task status update",
+ "status" : "WAITING",
+ "desc" : "The cluster task status is refreshed. If there are no nodes to be replaced, the task is marked as completed. Otherwise, another node starts to be replaced.",
+ "beginTime" : "",
+ "endTime" : ""
+ } ]
+ } ]
+}
+{
+ "totalSize" : 1,
+ "detailList" : [ {
+ "id" : "8ebe958b-b8c6-4939-b5a7-85aee9468888",
+ "startTime" : "2022-12-29T08:32:29",
+ "endTime" : "",
+ "status" : "RUNNING",
+ "agencyName" : "css_test_agency",
+ "totalNodes" : "css-test-ess-esn-2-1,css-test-ess-esn-1-1,css-test-ess-esn-3-1",
+ "completedNodes" : "css-test-ess-esn-2-1",
+ "currentNodeName" : "css-test-ess-esn-1-1",
+ "executeTimes" : "1",
+ "migrateParam" : "{\"instType\":\"ess\",\"migrateType\":\"az_migrate\",\"sourceAz\":\"cn-north-4a\",\"targetAz\":\"cn-north-4c\"}",
+ "finalAzInfoMap" : "{\"cn-north-4c\":\"css-test-ess-esn-2-1,css-test-ess-esn-1-1,css-test-ess-esn-3-1\"}",
+ "currentNodeDetail" : [ {
+ "order" : 0,
+ "name" : "Data migration",
+ "status" : "SUCCESS",
+ "desc" : "Data is migrated from a node to other nodes in the cluster by running the exclude command.",
+ "beginTime" : "2022-12-29T08:41:05",
+ "endTime" : "2022-12-29T08:41:23"
+ }, {
+ "order" : 12,
+ "name" : "Task status update",
+ "status" : "RUNNING",
+ "desc" : "The cluster task status is refreshed. If there are no nodes to be replaced, the task is marked as completed. Otherwise, another node starts to be replaced.",
+ "beginTime" : "2023-01-04T06:53:42",
+ "endTime" : ""
+ } ]
+ } ]
+}
+Status Code + |
+Description + |
+
|---|---|
200 + |
+The request is processed. + |
+
400 + |
+Invalid request. Modify the request directly and do not attempt to retry it. + |
+
403 + |
+The request is rejected. The server has received and understood the request, but refused to respond to it. Modify the request directly and do not attempt to retry it. + |
+
For details, see Error Code.
+Parameter |
-Type + | Type |
-Description + | Description |
|---|---|---|---|---|
clusters |
-Array of clusters objects + | Array of clusters objects |
-List of cluster objects. + | List of cluster objects |
instances |
-Array of instances in Table 5. + | Array of instance objects |
-List of node objects. + | List of node objects |
updated @@ -102,7 +102,7 @@ |
String |
-Cluster name. + | Cluster name |
|
created @@ -170,7 +170,7 @@ |
String |
-Whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true. + | Indicates whether to enable authentication. Available values include true and false. Authentication is disabled by default. When authentication is enabled, httpsEnable must be set to true.
|
Boolean |
-Whether disks are encrypted. + | Indicates whether disks are encrypted.
|
@@ -212,7 +212,7 @@
tags |
-Array of tags in Table 7. + | Array of tag objects |
Tags of a cluster. |
@@ -221,7 +221,7 @@
Parameter +
|
|---|
