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

Disabling Scale-In Protection for a Node

Function

This API is used to disable scale-in protection for a node. A node with scale-in protection disabled can be removed by changing the number of nodes in the node pool. Scale-in protection can be disabled only for pay-per-use nodes.

Calling Method

For details, see Calling APIs.

URI

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

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

Details:

The request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

apiVersion

Yes

String

Definition

API version. The value is fixed at v3.

Constraints

N/A

Range

v3

Default Value

N/A

kind

Yes

String

Definition

API type. The value is fixed at List.

Constraints

N/A

Range

List

Default Value

N/A

nodeList

No

Array of strings

Definition

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

Constraints

N/A

Response Parameters

Status code: 200

The scale-in protection is disabled for the node.

None

Example Requests

Unlock a node which cannot be scaled in.

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

{
  "kind" : "List",
  "apiVersion" : "v3",
  "nodeList" : [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx" ]
}

Example Responses

None

Status Codes

Status Code

Description

200

The scale-in protection is disabled for the node.

Error Codes

See Error Codes.