调用DeleteInstance,释放指定按量付费类型的阿里云Elasticsearch实例。释放后,实例所使用的物理资源都被回收,相关数据全部丢失且不可恢复;挂载实例节点的云盘和相应的快照都会被释放。
说明 实例释放后数据无法恢复,建议您在释放实例前先备份数据。具体操作,请参见快照备份与恢复命令。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
DELETE /openapi/instances/{InstanceId} HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
InstanceId | String | Path | 是 | es-cn-t57p81n7ai89v**** | 实例ID。 |
clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | 用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。 |
deleteType | String | Query | 否 | protective | 释放类型。可选值: |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 94B03BBA-A132-42C3-8367-0A0C1C45**** | 请求ID。 |
返回数据中还包括Result参数。详细信息,请参见ListInstance。
示例
请求示例
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
正常返回示例
JSON
格式
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****"
}
错误码
访问错误中心查看更多错误码。