Help Center> Cloud Container Engine> API Reference> APIs> Cluster Management> Hibernating a Cluster
View PDF

Hibernating a Cluster

Function

This API is used to hibernate a running cluster. After a cluster is hibernated, control 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 (yearly/monthly or pay-per-use).

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

cluster_id

Yes

String

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format).

Default: application/json

X-Auth-Token

Yes

String

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this field is mandatory and must be set to a user token. For details about how to obtain a token, see Authentication.

Maximum: 16384

Response Parameters

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