Domain name for API request: tke.tencentcloudapi.com.
This API is used to enable removal protection for the nodes automatically created by the scaling group in a node pool.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: SetNodePoolNodeProtection. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-25. |
Region | No | String | Common Params. This parameter is not required for this API. |
ClusterId | Yes | String | Cluster ID |
NodePoolId | Yes | String | Node pool ID |
InstanceIds.N | Yes | Array of String | Node ID |
ProtectedFromScaleIn | Yes | Boolean | Whether the node needs removal protection |
Parameter Name | Type | Description |
---|---|---|
SucceedInstanceIds | Array of String | ID of the node that has successfully set the removal protection Note: this field may return null , indicating that no valid values can be obtained. |
FailedInstanceIds | Array of String | ID of the node that fails to set the removal protection Note: this field may return null , indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to prevent nodes from being removed from the cluster by the scaling group when scale-in is triggered.
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetNodePoolNodeProtection
<Common request parameters>
{
"ProtectedFromScaleIn": "true",
"ClusterId": "cls-xxx",
"InstanceIds": [
"ins-xxx"
],
"NodePoolId": "np-xxx"
}
{
"Response": {
"SucceedInstanceIds": [
"ins-xxx"
],
"FailedInstanceIds": [
"xx"
],
"RequestId": "xx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error. |
InternalError.AccountUserNotAuthenticated | Account not verified. |
InternalError.ClusterNotFound | Cluster not found. |
InternalError.Db | DB error. |
InternalError.DbRecordNotFound | Record not found. |
InternalError.Param | Parameter error. |
InternalError.UnexceptedInternal | Internal error. |
InternalError.UnexpectedInternal | Unknown internal error. |
InvalidParameter | Parameter error. |
InvalidParameter.Param | Invalid parameter. |
本页内容是否解决了您的问题?