Suspend a cluster

Suspends a CelerData cluster.

Request

Basic information
HTTP URL	`https://cloud-api.celerdata.com/api/1.0/clusters/:cluster_id/suspend`
HTTP method	PATCH
Frequency	600/minute

Path variables

Parameter	Example value	Required	Type	Description
cluster_id	4ae48a3f-f840-46fa-b0e7-0709a220fa40	Yes	String	The ID of the cluster. You can sign in to the CelerData Cloud BYOC console and then navigate to the `Cluster properties` section of the cluster's `Overview` page to obtain the cluster ID.

:<variable_name> indicates a URL path variable in web development tools such as Postman. :cluster_id in the above URL path, as such, indicates the ID of the cluster you want to suspend. However, if you use other tools such as curl, you need to replace :cluster_id with the actual cluster ID by hand in the curl command.

Header parameters

Parameter	Example value	Required	Type	Description
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	Yes	String	The access token used to access the CelerData Cloud BYOC API. Format: `Bearer <access_token>`.

See Obtain access token.

Response

Sample response

{
    "code": 20000,
    "data": {
        "action_id": "7b622922-2a25-4d24-aa6f-9be54c7a91e0"
    }
}

Response elements

Parameter	Sub-attribute	Example value	Type	Description
code		20000	Integer	The error code. If the error code returned is `20000`, the request succeeded. If any other error code is returned, the request failed.
data	-	-	Object	The result of the API call. The data object may not be returned for some API actions. It consists of the following elements: `account_idusagedetails`.
	action_id	7b622922-2a25-4d24-aa6f-9be54c7a91e0	String	The ID of the action.

Suspend a cluster

Request​

Path variables​

Header parameters​

Response​

Sample response​

Response elements​

See also​