Stopping a Cluster
Function
This API is used to stop a cluster.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/clusters/{cluster_id}/stop
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| cluster_id | Yes | String | Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| job_id | String | Definition ID of the task for stopping a cluster. Range N/A |
Example Requests
Stop a cluster.
POST https://{endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/97cbaab3-939e-4dbc-9187-0fe240f2b9fd/stop Example Responses
Status code: 200
{
"job_id" : "id"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | The request for stopping the cluster is submitted. |
| 400 | Request error. |
| 401 | Authentication failed. |
| 403 | You do not have required permissions. |
| 404 | No resources found. |
| 500 | Internal server error. |
| 503 | Service unavailable. |
