Updated on 2025-07-07 GMT+08:00

Waking Up a Cluster

Function

This API is used to wake up a hibernated cluster. After the cluster is woken up, master node resources continue to be billed.

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/awake

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Details:

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

cluster_id

Yes

String

Details:

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

The request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

Default value:

N/A

X-Auth-Token

Yes

String

Details:

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

The cluster wakeup job is successfully delivered. Keep querying the cluster status. When the cluster status changes to Available, the cluster is woken up successfully.

None

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The cluster wakeup job is successfully delivered. Keep querying the cluster status. When the cluster status changes to Available, the cluster is woken up successfully.

Error Codes

See Error Codes.