Skip to main content

Drop Cluster

Deletes a cluster. This operation moves your cluster to the recycle bin. All clusters in the recycle bin are pending permanent deletion in 30 days.


DELETE
https://controller.${CLOUD_REGION}.zillizcloud.com/v1/clusters/{CLUSTER_ID}/drop

Example

📘Notes

This API requires an API key as the authentication token.

export CLOUD_REGION="gcp-us-west1"
export API_KEY=""

curl --location --request DELETE "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clusters/inxx-xxxxxxxxxxxxxxx/drop" \
--header "Authorization: Bearer ${API_KEY}"

Possible return is similar to the following:

{
"code": 200,
"data": {
"clusterId": "inxx-xxxxxxxxxxxxxxx",
"prompt": "The cluster has been deleted. If you consider this action to be an error, you have the option to restore the deleted cluster from the recycle bin within a 30-day period. Kindly note, this recovery feature does not apply to free clusters."
}
}

Request

Parameters

  • No query parameters required

  • Path parameters

    ParameterDescription
    CLUSTER_IDstring(required)
  • Header parameters

    ParameterDescription
    Authorizationstring

Request Body

No request body required

Response

Returns the ID of the deleted cluster.

Response Body

{
"code": "integer",
"data": {
"clusterId": "string",
"prompt": "string"
}
}
PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 0: The request succeeds.
  • Others: Some error occurs.
dataobject
data.clusterIdstring
The ID of a cluster.
data.promptstring
The statement indicating that the current operation succeeds.

Error Response

{
"code": integer,
"message": string
}
PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 0: The request succeeds.
  • Others: Some error occurs.
messagestring
Indicates the possible reason for the reported error.