All Products
Search
Document Center

OpenSearch:DeleteIndex

Last Updated:Jul 16, 2024

Deletes an index.

Operation description

Method

DELETE

URI

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-2r42p5oi202
indexNamestringYes

The index name.

generation
dataSourcestringYes

The data source.

ha-cn-pl32rf0js04_test
deleteDataSourcebooleanNo

Specifies whether to delete the data source.

true

Sample requests



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

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

id of request

022F36C7-9FB4-5D67-BEBC-3D14B0984463
resultobject

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 timeSummary of changesOperation
2023-07-20The request parameters of the API has changedView Change Details
2022-01-12Add OperationView Change Details