接口请求域名: es.intl.tencentcloudapi.com 。
用于重启集群节点
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:RestartNodes。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例ID |
| NodeNames.N | 是 | Array of String | 节点名称列表 |
| ForceRestart | 否 | Boolean | 是否强制重启 |
| RestartMode | 否 | String | 可选重启模式"in-place","blue-green",分别表示重启,蓝绿重启;默认值为"in-place" |
| IsOffline | 否 | Boolean | 节点状态,在蓝绿模式中使用;离线节点蓝绿有风险 |
| CvmDelayOnlineTime | 否 | Integer | cvm延迟上架时间 |
| ShardAllocationConcurrents | 否 | Integer | 分片迁移并发数 |
| ShardAllocationBytes | 否 | Integer | 分片迁移并发速度 |
| EnableScheduleRecoverGroup | 否 | Boolean | 是否开启置放群组异步任务 |
| EnableScheduleOperationDuration | 否 | EnableScheduleOperationDuration | 置放群组异步任务时间段 |
| EventTypeIds.N | 否 | Array of String | 事件id列表 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
重启集群节点
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RestartNodes
<公共请求参数>
{
"InstanceId": "es-xxxxxxxx",
"NodeNames": [
"159229897700074xxxx"
]
}
{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ErrorClusterState | 集群状态错误。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId,没有找到对应资源。 |
| InvalidParameter.InvalidIpList | 私有网络vip列表IpList的取值和预期不符。 |
| InvalidParameter.InvalidNodeNames | 节点名称列表NodeNames的取值和预期不符。 |
| InvalidParameter.InvalidRestartMode | 可选重启模式RestartMode的取值和预期不符。 |
| InvalidParameter.InvalidSubnetUidList | 虚拟子网络统一ID列表的取值和预期不符。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient.CVM | 计算资源不足,可更换可用区或调整机型。 |
| ResourceInsufficient.SubnetIp | 可用的子网IP不足。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
| UnsupportedOperation.ClusterStateNoReplication | 集群中存在部分索引无备份。 |
| UnsupportedOperation.ClusterStateUnHealth | 集群的状态不正常(不为绿)。 |
| UnsupportedOperation.DiskFreeSpaceInsufficient | 节点磁盘可用空间不足 |
| UnsupportedOperation.HeteroScalingExecuting | 存在未完成的异构扩缩容流程 |
| UnsupportedOperation.InstanceTypeError | 不支持该操作,服务类型有误。 |
| UnsupportedOperation.RestartMode | 离线节点蓝绿变更存在风险,请直接选择重启“in-place”。 |
| UnsupportedOperation.StatusNotNormal | 不支持该操作,当前实例运行状态不为正常。 |
| UnsupportedOperation.StatusNotSupport | 不支持该操作,实例状态有误。 |
文档反馈