You can call this operation to release a specified pay-as-you-go Elasticsearch instance.

Warning After the instance is released, the physical resources of the instance is reclaimed. The data of the instance is deleted and cannot be recovered. The disks mounted to the instance nodes and the snapshots are released.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation only uses common request headers. For more information, see the Common request parameters topic.

Request syntax

DELETE /openapi/instances/[InstanceId] HTTP/1.1

Request parameters

Parameter Type Required Example Description
InstanceId String Yes es-cn-abc

The ID of the instance.

clientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF****

A unique token generated by the client to guarantee the idempotency of the request. The maximum length of the token is 64 ASCII characters.

Response parameters

Parameter Type Example Description
RequestId String 94B03BBA-A132-42C3-8367-0A0C1C45****

The ID of the request.

Examples

Sample requests

DELETE /openapi/instances/es-cn-abc? clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****

Sample success responses

XML format

<RequestId>B0BB1C4B-AF9C-465D-BED4-9E4C5B54****</RequestId>
<Result>
    <commodityCode>elasticsearch</commodityCode>
    <createdAt>2018-07-17T18:19:02.019Z</createdAt>
    <dedicateMaster>false</dedicateMaster>
    <description>es-cn-pp7055iz678v1****</description>
    <domain>es-cn-abc.elasticsearch.aliyuncs.com</domain>
    <enablePublic>false</enablePublic>
    <endTime>4687603200000</endTime>
    <esConfig>
        <action.auto_create_index>+.*,-*</action.auto_create_index>
        <action.destructive_requires_name>true</action.destructive_requires_name>
        <xpack.security.audit.outputs>logfile</xpack.security.audit.outputs>
        <xpack.watcher.enabled>false</xpack.watcher.enabled>
    </esConfig>
    <esVersion>5.5.3_with_X-Pack</esVersion>
    <inited>true</inited>
    <instanceId>es-cn-pp7055iz678v1****</instanceId>
    <kibanaDomain>es-cn-abc.kibana.elasticsearch.aliyuncs.com</kibanaDomain>
    <networkConfig>
        <type>vpc</type>
        <vpcId>vpc-abc</vpcId>
        <vsArea>cn-hangzhou-b</vsArea>
        <vswitchId>vsw-abc</vswitchId>
    </networkConfig>
    <nodeAmount>2</nodeAmount>
    <nodeSpec>
        <disk>20</disk>
        <spec>elasticsearch.n4.small</spec>
    </nodeSpec>
    <paymentType>postpaid</paymentType>
    <port>9200</port>
    <status>active</status>
    <updatedAt>2018-07-18T16:10:05.147Z</updatedAt>
</Result>

JSON format

{
	"Result":{
		"port":9200,
		"publicIpWhitelist":[],
		"esConfig":{
			"xpack.watcher.enabled":"false",
			"action.destructive_requires_name":"true",
			"xpack.security.audit.outputs":"logfile",
			"action.auto_create_index":"+.*,-*"
		},
		"nodeAmount":2,
		"status":"active",
		"kibanaIPWhitelist":[],
		"paymentType":"postpaid",
		"instanceId":"es-cn-pp7055iz678v1****",
		"esIPWhitelist":[],
		"esVersion":"5.5.3_with_X-Pack",
		"enablePublic":false,
		"endTime":4687603200000,
		"nodeSpec":{
			"spec":"elasticsearch.n4.small",
			"disk":20
		},
		"updatedAt":"2018-07-18T16:10:05.147Z",
		"inited":true,
		"esIPBlacklist":[],
		"kibanaDomain":"es-cn-abc.kibana.elasticsearch.aliyuncs.com",
		"createdAt":"2018-07-17T18:19:02.019Z",
		"description":"es-cn-pp7055iz678v1****",
		"networkConfig":{
			"vpcId":"vpc-abc",
			"vswitchId":"vsw-abc",
			"vsArea":"cn-hangzhou-b",
			"type":"vpc"
		},
		"dictList":[],
		"domain":"es-cn-abc.elasticsearch.aliyuncs.com",
		"dedicateMaster":false,
		"commodityCode":"elasticsearch"
	},
	"RequestId":"B0BB1C4B-AF9C-465D-BED4-9E4C5B54****"
}

Error codes

For a list of error codes, visit the API Error Center.