Help Center/ Cloud Container Engine/ API Reference (Kuala Lumpur Region)/ APIs/ Cluster Management/ Hibernating a Cluster
Updated on 2024-10-22 GMT+08:00
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.

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 value, see How to Obtain Parameters in the API URI.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the value, 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).

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 parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

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