Releases a specified pay-as-you-go Elasticsearch cluster. After the cluster is released, the physical resources used by the cluster are reclaimed. The data stored on the cluster is deleted and cannot be recovered. The disks attached to the nodes in the cluster and the snapshots created for the cluster are released.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request headers.
Request syntax
DELETE /openapi/instances/{InstanceId} HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
InstanceId | String | Path | Yes | es-cn-t57p81n7ai89v**** | The ID of the instance. |
clientToken | String | Query | No | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. |
deleteType | String | Query | No | protective | The release type. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 94B03BBA-A132-42C3-8367-0A0C1C45**** | The request ID. |
The returned data also includes the Result parameter. For more information, see ListInstance.
Examples
Sample requests
DELETE /openapi/instances/es-cn-t57p81n7ai89v****?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****&deleteType=protective HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
Sample success response
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : {
"instanceId" : "es-cn-z2q1wk6z00007****",
"version" : "6.7.0_with_X-Pack",
"description" : "es-cn-z2q1wk6z00007****",
"nodeAmount" : 3,
"paymentType" : "postpaid",
"status" : "inactive",
"privateNetworkIpWhiteList" : [ "0.0.0.0/0" ],
"enablePublic" : false,
"nodeSpec" : {
"spec" : "elasticsearch.n4.small",
"disk" : 20,
"diskType" : "cloud_ssd",
"diskEncryption" : false
},
"networkConfig" : {
"vpcId" : "vpc-uf6ov5av2bmjgzrfg****",
"vswitchId" : "vsw-uf6r9op1zf38byetr****",
"vsArea" : "cn-shanghai-g",
"type" : "vpc"
},
"createdAt" : "2020-11-06T11:47:27.776Z",
"updatedAt" : "2021-02-01T02:04:19.844Z",
"commodityCode" : "elasticsearch",
"extendConfigs" : [ {
"configType" : "usageScenario",
"value" : "general"
}, {
"configType" : "maintainTime",
"maintainStartTime" : "02:00Z",
"maintainEndTime" : "06:00Z"
}, {
"configType" : "aliVersion",
"aliVersion" : "ali1.3.0"
}, {
"configType" : "deleteProtection",
"deleteTime" : 1612231459805
} ],
"endTime" : 4760352000000,
"clusterTasks" : [ ],
"vpcInstanceId" : "es-cn-z2q1wk6z00007****-worker",
"resourceGroupId" : "rg-acfm2h5vbzd****",
"zoneCount" : 1,
"protocol" : "HTTP",
"zoneInfos" : [ {
"zoneId" : "cn-shanghai-g",
"status" : "NORMAL"
} ],
"instanceType" : "elasticsearch",
"inited" : true,
"tags" : [ {
"tagKey" : "acs:rm:rgId",
"tagValue" : "rg-acfm2h5vbzd****"
} ],
"domain" : "es-cn-z2q1wk6z00007****.elasticsearch.aliyuncs.com",
"port" : 9200,
"esVersion" : "6.7.0_with_X-Pack",
"esConfig" : {
"action.destructive_requires_name" : "true",
"xpack.security.audit.outputs" : "index",
"xpack.watcher.enabled" : "false",
"xpack.security.audit.enabled" : "false",
"action.auto_create_index" : "+.*,-*"
},
"esIPWhitelist" : [ "0.0.0.0/0" ],
"esIPBlacklist" : [ ],
"kibanaProtocol" : "HTTPS",
"kibanaIPWhitelist" : [ "0.0.0.0/0" ],
"kibanaPrivateIPWhitelist" : [ ],
"publicIpWhitelist" : [ ],
"kibanaDomain" : "es-cn-z2q1wk6z00007****.kibana.elasticsearch.aliyuncs.com",
"kibanaPort" : 5601,
"haveKibana" : true,
"instanceCategory" : "x-pack",
"dedicateMaster" : false,
"advancedDedicateMaster" : true,
"masterConfiguration" : {
"spec" : "elasticsearch.sn2ne.large",
"amount" : 3,
"diskType" : "cloud_ssd",
"disk" : 20
},
"haveClientNode" : false,
"warmNode" : false,
"warmNodeConfiguration" : { },
"clientNodeConfiguration" : { },
"kibanaConfiguration" : {
"spec" : "elasticsearch.n4.small",
"amount" : 1,
"disk" : 0
},
"elasticDataNodeConfiguration" : {
"spec" : "elasticsearch.sn1ne.large",
"amount" : 3,
"diskType" : "cloud_efficiency",
"disk" : 20480,
"diskEncryption" : false
},
"haveElasticDataNode" : true,
"dictList" : [ {
"name" : "SYSTEM_MAIN.dic",
"fileSize" : 2782602,
"sourceType" : "ORIGIN",
"type" : "MAIN"
}, {
"name" : "SYSTEM_STOPWORD.dic",
"fileSize" : 132,
"sourceType" : "ORIGIN",
"type" : "STOP"
} ],
"synonymsDicts" : [ ],
"ikHotDicts" : [ ],
"aliwsDicts" : [ ],
"haveGrafana" : false,
"haveCerebro" : false,
"enableKibanaPublicNetwork" : true,
"enableKibanaPrivateNetwork" : false,
"advancedSetting" : {
"gcName" : "CMS"
},
"enableMetrics" : true,
"readWritePolicy" : {
"writeHa" : false
}
},
"RequestId" : "898EF65A-121E-4728-93E3-3412DAA8****"
}
Error codes
For a list of error codes, see Service error codes.