接口请求域名: es.intl.tencentcloudapi.com 。
升级ES集群版本
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpgradeInstance。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID |
| EsVersion | 是 | String | 目标ES版本,支持:”6.4.3“, "6.8.2","7.5.1", "7.10.1", "7.14.2" |
| CheckOnly | 否 | Boolean | 是否只做升级检查,默认值为false |
| LicenseType | 否 | String | 目标商业特性版本: |
| BasicSecurityType | 否 | Integer | 6.8(及以上版本)基础版是否开启xpack security认证 |
| UpgradeMode | 否 | String | 升级方式: |
| CosBackup | 否 | Boolean | 升级版本前是否对集群进行备份,默认不备份 |
| SkipCheckForceRestart | 否 | Boolean | 滚动模式时,是否跳过检查,进行强制重启。默认值为false |
| CvmDelayOnlineTime | 否 | Integer | cvm延迟上架参数 |
| ShardAllocationConcurrents | 否 | Integer | 分片迁移并发数 |
| ShardAllocationBytes | 否 | Integer | 分片迁移并发速度 |
| EnableScheduleRecoverGroup | 否 | Boolean | 是否开启置放群组异步任务 |
| EnableScheduleOperationDuration | 否 | EnableScheduleOperationDuration | 置放群组异步任务时间段 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
升级ES集群版本
POST / HTTP/1.1
Host: es.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeInstance
<公共请求参数>
{
"InstanceId": "es-xxxxxxxx",
"EsVersion": "6.4.3"
}
{
"Response": {
"RequestId": "c96a110c-7493-452d-a99b-683d07xxxxxx"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ErrorClusterState | 集群状态错误。 |
| FailedOperation.NoPayment | 账户未绑定信用卡或paypal,无法支付。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId,没有找到对应资源。 |
| InvalidParameter.InvalidNodeType | 节点规格NodeType的取值和预期不符。 |
| InvalidParameterValue.ConfigInfo | 组件配置值有误。 |
| InvalidParameterValue.UpgradeMode | 升级方式UpgradeMode的取值有误。 |
| LimitExceeded.NodeNumOrIndices | 节点数量或索引存储量超过限额。 |
| LimitExceeded.ResourceLimit | 超出一个用户可以拥有的最大资源限制。 |
| ResourceInsufficient.Balance | 账户余额不足。 |
| ResourceInsufficient.SubnetIp | 可用的子网IP不足。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
| ResourceNotFound.WhiteListNotFound | 白名单资源获取失败。 |
| UnauthorizedOperation.UinNotInWhiteList | Uin不在白名单中。 |
| UnsupportedOperation.ClusterStateClose | 集群中存在部分索引处于关闭状态。 |
| UnsupportedOperation.ClusterStateNoReplication | 集群中存在部分索引无备份。 |
| UnsupportedOperation.ClusterStateUnHealth | 集群的状态不正常(不为绿)。 |
| UnsupportedOperation.CosBackUp | 该版本不支持cos备份。集群需要重启来允许cos备份。 |
| UnsupportedOperation.HeteroScalingExecuting | 存在未完成的异构扩缩容流程 |
| UnsupportedOperation.IndexSettingsRequireSet | 集群有索引设置index.routing.allocation.require._name,or _ip, or _id |
| UnsupportedOperation.LicenseError | 不支持该操作,license的类型有误。 |
| UnsupportedOperation.Plugin | 不支持该插件。 |
| UnsupportedOperation.StatusNotSupport | 不支持该操作,实例状态有误。 |
文档反馈