Help Center/ Cloud Container Engine/ API Reference (Ally Region)/ APIs/ Cluster Management/ Hibernating a Cluster
Updated on 2026-04-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Hibernating a Cluster

Function

This API is used to hibernate a running cluster. After a cluster is hibernated, master node resources stop being billed.

Constraints

  1. After a cluster is hibernated, resources such as workloads cannot be created or managed in the cluster.

  2. After a pay-per-use cluster is hibernated, master node resources are not billed. Other resources such as the nodes to which the cluster belongs, bound EIP, and bandwidth are billed based on their billing mode.

Calling Method

For details, see Calling APIs.

URI

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

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

Definition

Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any.

Constraints

GET requests are not validated.

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 hibernation job is successfully delivered. Keep querying the cluster status. When the cluster status changes to Hibernation, the cluster is hibernated.

None

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The cluster hibernation job is successfully delivered. Keep querying the cluster status. When the cluster status changes to Hibernation, the cluster is hibernated.

Error Codes

See Error Codes.

Parent topic: Cluster Management