Delete cluster

Prev Next

Available in VPC

Delete a search engine cluster.

Request

This section describes the request format. The method and URI are as follows:

Method URI
DELETE /api/v2/cluster/deleteSearchEngineCluster/{serviceGroupInstanceNo} (Korea Region)
DELETE /api/sgn-v2/cluster/deleteSearchEngineCluster/{serviceGroupInstanceNo} (Singapore Region)
DELETE /api/jpn-v2/cluster/deleteSearchEngineCluster/{serviceGroupInstanceNo} (Japan Region)

Request headers

For information about the headers common to all Search Engine Service APIs, see Search Engine Service request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
serviceGroupInstanceNo Integer Required Cluster instance number

Request example

The request example is as follows:

curl --location --request DELETE 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/deleteSearchEngineCluster/1037****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' 

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
code Integer - Response code
message String - Response message
result Boolean - Response result
  • true | null
    • true: succeeded
    • null: failed
requestId String - ID for the request
  • UUID format

Response status codes

For response status codes common to all Search Engine Service APIs, see Search Engine Service response status codes.

Response example

The response example is as follows:

{
    "code": 0,
    "message": "SUCCESS",
    "result": true,
    "requestId": "809ebf03-****-****-****-560b5b61f68d"
}