DeleteIndex - OpenSearch - Alibaba Cloud Documentation Center

Deletes an index.

Operation description

Method

DELETE

URI

/openapi/ha3/instances/{instanceId}/indexes/{indexName}?dataSource=xxx

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:DeleteIndex		Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-2r42p5oi202
indexName	string	Yes	The index name.	generation
dataSource	string	Yes	The data source.	ha-cn-pl32rf0js04_test
deleteDataSource	boolean	No	Specifies whether to delete the data source.	true

Sample requests

DELETE /openapi/ha3/instances/ose-test1/indexes/my_index?dataSource=xxx

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	id of request	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	object	The information about the index	{}

Sample responses

Success responses

{

  "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",

  "result": []

}

For more information, see Response struct.

Examples

Sample success responses

JSONformat

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": {}
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-07-20	The request parameters of the API has changed	View Change Details
2022-01-12	Add Operation	View Change Details