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	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: Request body type or format Constraints: The GET method is not verified. Options: application/json application/json;charset=utf-8 application/x-pem-file 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	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

Lock a node so that it will not be scaled in.

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

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