Suspend Cluster
Suspend a specified cluster. This operation will only stop the cluster and your data will remain intact.
POST
https://controller.${CLOUD_REGION}.zillizcloud.com/v1/clusters/{CLUSTER_ID}/suspend
Example
📘Notes
- This API requires an API key as the authentication token.
- This API requires applies only to dedicated clusters.
export CLOUD_REGION="gcp-us-west1"
export API_KEY=""
curl --location --request POST "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/clusters/inxx-xxxxxxxxxxxxxxx/suspend" \
--header "Authorization: Bearer ${API_KEY}"
Possible return is similar to the following.
{
"code": 200,
"data": {
"clusterId": "inxx-xxxxxxxxxxxxxxx",
"prompt": "Successfully Submitted. The cluster will not incur any computing costs when suspended. You will only be billed for the storage costs during this time."
}
}
Request
Parameters
-
No query parameters required
-
Path parameters
Parameter Description CLUSTER_ID string(required) -
Header parameters
Parameter Description Authorization string
Request Body
No request body required
Response
Returns the ID of the affected cluster.
Response Body
{
"code": "integer",
"data": {
"clusterId": "string",
"prompt": "string"
}
}
Property | Description |
---|---|
code | integer Indicates whether the request succeeds.
|
data | object |
data.clusterId | string The ID of a cluster. |
data.prompt | string The statement indicating that the current operation succeeds. |
Error Response
{
"code": integer,
"message": string
}
Property | Description |
---|---|
code | integer Indicates whether the request succeeds.
|
message | string Indicates the possible reason for the reported error. |