DeleteInstance - OpenSearch - Alibaba Cloud Documentation Center

Deletes a specified instance.

Operation description

Method

DELETE

URI

/openapi/ha3/instances/{instanceId}

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:DeleteInstance	delete	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

DELETE /openapi/ha3/instances/{instanceId} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-7pp2m0ozr01

Sample requests

Change the instance name

DELETE /openapi/ha3/instances/ha3-cn-xxxxxx

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The ID of the request	E45380E8-994A-5402-9806-F114B3295FCF
result	object	The result returned	{}

Sample responses

Sample success responses

{
  "result": {  },
  "requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818"
}

Sample error responses


{
  "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
  "httpCode": 404,
  "code": "App.NotFound",
  "message": "App not found"
}

For more information, see Response structure.

Examples

Sample success responses

JSONformat

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {}
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details