A200161411/cloud-container-engine
1
0
Fork 0
forked from docs/cloud-container-engine
Code Pull Requests Activity
cloud-container-engine/api-ref/source/apis/cluster_management/hibernating_a_cluster.rst
proposalbot 2490522af3 Changes to cce_api-ref from docs/doc-exports#318 (CCE API for v1.23 
CCE API for

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2022-11-10 10:54:32 +00:00

6.3 KiB
Raw Permalink Blame History

original_name

cce_02_0374.html

Hibernating a Cluster

Function

This API is used to hibernate a running cluster.

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 project ID, see How to Obtain Parameters in the API URI <cce_02_0271>.
cluster_id Yes String Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI <cce_02_0271>.

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 API Usage Guidelines <cce_02_0344>.

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 <cce_02_0250>.