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	Definition Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints GET requests are not validated. 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. Constraints The value is fixed and cannot be changed. Range N/A Default Value v3
kind	Yes	String	Definition API type. Constraints The value is fixed and cannot be changed. Range N/A Default Value List
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 Range N/A Default Value 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" ]
}