Stopping a Cluster¶

Function¶

This API is used to stop a cluster.

URI¶

POST /v1.1/{project_id}/clusters/{cluster_id}/action

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
cluster_id	Yes	String	Cluster ID

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
stop	Yes	stop object	Startup of a cluster. This parameter is an empty object.

**Table 4** stop¶
Parameter	Mandatory	Type	Description
stopMode	No	String	Stop mode IMMEDIATELY: immediate stop GRACEFULLY: graceful stop Enumeration values: IMMEDIATELY GRACEFULLY
delayTime	No	Integer	Stop delay, in seconds. This parameter is valid only when stopMode is set to GRACEFULLY. If the value of this parameter is set to -1, the system waits for all jobs to complete and stops accepting new jobs. If the value of this parameter is greater than 0, the system stops the cluster after the specified time and stops accepting new jobs.

Response Parameters¶

Status code: 200

**Table 5** Response body parameters¶
Parameter	Type	Description
jobId	Array of strings	Job ID

Example Requests¶

Stopping a Cluster

POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/bae65496-643e-47ca-84af-948672de7eeb/action

{
  "stop" : {
    "stopMode" : "GRACEFULLY",
    "delayTime" : -1
  }
}

Example Responses¶

Status code: 200

{
  "jobId" : [ "ff8080815e59d92d015e5b27ccb0004d" ]
}

Status Codes¶

Status Code	Description
200	ok
400	Request error.
401	Authentication failed.
403	You do not have required permissions to perform this operation.
404	The requested resource was not found.
500	An internal service error occurred. For details, see error codes.
503	Service unavailable.

Error Codes¶

See Error Codes.

last updated: 2024-11-13 13:47 UTC - commit: db9c60a6c98025320fa32706a5e58cd02cf7d7f1