Domain name for API request: es.intl.tencentcloudapi.com.
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 perform forced reboot. |
| RestartMode | No | String | Optional restart mode. in-place: restart; blue-green: blue-green restart. Default value: in-place. |
| IsOffline | No | Boolean | Node status, for use in blue-green mode; offline node blue/green at risk |
| CvmDelayOnlineTime | No | Integer | cvm delay listing time |
| ShardAllocationConcurrents | No | Integer | Number of concurrent shard migrations |
| ShardAllocationBytes | No | Integer | Shard migration concurrency speed |
| EnableScheduleRecoverGroup | No | Boolean | Whether to enable the placement group asynchronous task |
| EnableScheduleOperationDuration | No | EnableScheduleOperationDuration | Time period of the async task for the placement group |
| EventTypeIds.N | No | Array of String | Event ID list. |
| 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. |
This example shows you how to restart a cluster node.
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 | Cluster status error. |
| InternalError | Internal error. |
| InvalidParameter.InvalidAppId | The APPID value does not match the expectation. |
| InvalidParameter.InvalidInstanceId | Invalid InstanceId. No corresponding resources were found. |
| InvalidParameter.InvalidIpList | The value of IpList in the private network vip list does not meet expectations. |
| InvalidParameter.InvalidNodeNames | The value of NodeNames does not match the expected value. |
| InvalidParameter.InvalidRestartMode | The value of the selectable restart mode RestartMode does not match the expected one. |
| InvalidParameter.InvalidSubnetUidList | The value of the Unified Virtual Subnet ID list does not meet expectations. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient.CVM | Insufficient computing resources. Replace the availability zone or adjust the model. |
| ResourceInsufficient.SubnetIp | Insufficient available subnet IP. |
| ResourceNotFound.ClusterInfoNotFound | Failed to obtain the cluster resource. |
| ResourceNotFound.DBInfoNotFound | Failed to obtain the database resource. |
| UnsupportedOperation.ClusterStateNoReplication | Some indexes in the cluster have no backup. |
| UnsupportedOperation.ClusterStateUnHealth | Cluster status is abnormal (not green). |
| UnsupportedOperation.DiskFreeSpaceInsufficient | Insufficient free space on the node disk |
| UnsupportedOperation.HeteroScalingExecuting | An incomplete heterogeneous scaling process exists. |
| UnsupportedOperation.InstanceTypeError | This operation is not supported. The service type is incorrect. |
| UnsupportedOperation.RestartMode | Offline node blue-green change has risks. Select restart "in-place" directly. |
| UnsupportedOperation.StatusNotNormal | This operation is not supported. The instance is not running as normal. |
| UnsupportedOperation.StatusNotSupport | This operation is not supported. The instance status is incorrect. |
フィードバック