接口请求域名: es.intl.tencentcloudapi.com 。
重启ES集群实例(用于系统版本更新等操作)
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:RestartInstance。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID |
| ForceRestart | 否 | Boolean | 是否强制重启 |
| RestartMode | 否 | Integer | 重启模式:0 滚动重启; 1 全量重启 |
| UpgradeKernel | 否 | Boolean | 重启时选择是否升级内核patch版本 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
用以进行版本更新等操作
https://es.intl.tencentcloudapi.com/?Action=RestartInstance
&InstanceId=es-xxxxxxxx
&<公共请求参数>
{
"Response": {
"RequestId": "7f0e35a7-e03b-42cd-aa4f-0c1471xxxxxx"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ErrorClusterState | 集群状态错误。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId,没有找到对应资源。 |
| InvalidParameterValue.ConfigInfo | 组件配置值有误。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
| UnsupportedOperation.ClusterStateNoReplication | 集群中存在部分索引无备份。 |
| UnsupportedOperation.ClusterStateUnHealth | 集群的状态不正常(不为绿)。 |
| UnsupportedOperation.CvmStatusStopped | 有关机的cvm |
| UnsupportedOperation.DiskFreeSpaceInsufficient | 节点磁盘可用空间不足 |
| UnsupportedOperation.HeteroScalingExecuting | 存在未完成的异构扩缩容流程 |
| UnsupportedOperation.InstanceTypeError | 不支持该操作,服务类型有误。 |
| UnsupportedOperation.StatusNotNormal | 不支持该操作,当前实例运行状态不为正常。 |
| UnsupportedOperation.StatusNotSupport | 不支持该操作,实例状态有误。 |
文档反馈