Help Center/ Cloud Container Engine/ API Reference/ APIs/ Node Management/ Enabling Scale-In Protection for a Node
Updated on 2024-07-26 GMT+08:00

Enabling Scale-In Protection for a Node

Function

This API is used to enable scale-in protection for a node. A node with scale-in protection enabled cannot be removed by simply changing the number of nodes in the node pool.

Calling Method

For details, see Calling APIs.

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/locknodescaledown

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

apiVersion

Yes

String

API version. The value is fixed at v3.

kind

Yes

String

API type. The value is fixed at List.

nodeList

No

Array of strings

ID list of nodes for which scale-in protection needs to be enabled. For details about how to obtain node IDs, see How to Obtain Parameters in the API URI.

Response Parameters

None

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The scale-in protection is enabled for the node.

Error Codes

See Error Codes.