Skip to main content

Suspend Cluster

Suspend a specified cluster. This operation will only stop the cluster and your data will remain intact.


POST
https://controller.api.{cloud-region}.zillizcloud.com/v1/clusters/{CLUSTER_ID}/suspend

Example

Notes
  • This API requires an API Key as the authentication token.
curl --request POST \
--url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clusters/${clusterId}/suspend" \
--header "Authorization: Bearer ${API_KEY}" \
--header "accept: application/json" \
--header "content-type: application/json"

Success response:

{
code: 200,
data: {
"clusterId": "cluster01",
"prompt": "Submission successful. Your vector database computing cost is free until you Resume the Cluster, and only storage costs will be charged."
}
}

Request

Parameters

  • No query parameters required

  • Path parameters

    ParameterDescription
    CLUSTER_IDstring(required)

Request Body

No request body required

Response

Returns the ID of the affected cluster.

Response Bodies

  • Response body if we process your request successfully
{
"code": "integer",
"data": {
"clusterId": "string",
"prompt": "string"
}
}
  • Response body if we failed to process your request
{
"code": integer,
"message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 200: The request succeeds.
  • Others: Some error occurs.
codeinteger
dataobject
data.clusterIdstring
The ID of a cluster.
data.promptstring
The statement indicating that the current operation succeeds.
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
80001The token is illegal
80002The token is invalid
80020Cluster not exist or you don't have permission.
80021Serverless cluster not support this operation.
90102The cluster does not exist in current region.
90103The clusterId parameter is empty in the request path.
90117Invalid domain name used