Domain name for API request: es.intl.tencentcloudapi.com.
This API is used to restart cluster nodes.
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: RestartNodes. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Cluster instance ID |
| NodeNames.N | Yes | Array of String | Node name list |
| ForceRestart | No | Boolean | Whether to force restart |
| RestartMode | No | String | The restart mode. Valid values: in-place (default), blue-green. |
| IsOffline | No | Boolean | The node status, applicable in the blue/green mode. The blue/green restart is risky if the node is offline. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RestartNodes
<Common request parameters>
{
"InstanceId": "es-xxxxxxxx",
"NodeNames": [
"159229897700074xxxx"
]
}
{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}
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 |
|---|---|
| FailedOperation.ErrorClusterState | Incorrect cluster status |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId, no corresponding resource found. |
| InvalidParameter.InvalidIpList | |
| InvalidParameter.InvalidNodeNames | |
| InvalidParameter.InvalidRestartMode | |
| InvalidParameter.InvalidSubnetUidList | |
| ResourceInUse | Resource is in use. |
| ResourceInsufficient.CVM | |
| ResourceInsufficient.SubnetIp | |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain cluster resources. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
| UnsupportedOperation.ClusterStateNoReplication | |
| UnsupportedOperation.ClusterStateUnHealth | |
| UnsupportedOperation.DiskFreeSpaceInsufficient | |
| UnsupportedOperation.HeteroScalingExecuting | |
| UnsupportedOperation.InstanceTypeError | |
| UnsupportedOperation.RestartMode | |
| UnsupportedOperation.StatusNotNormal | |
| UnsupportedOperation.StatusNotSupport |
피드백