1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
检查实例变配操作是否可以发起
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CheckUpdateInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：es-xxxxxxxx |
| NodeNum | 否 | Integer | 已废弃，请使用NodeInfoList 变配后的节点个数（2-50个） 示例值：1 |
| NodeType | 否 | String | 已废弃，请使用NodeInfoList 变配后的节点规格 示例值：ES.S1.MEDIUM4 |
| DiskSize | 否 | Integer | 已废弃，请使用NodeInfoList 变配后的磁盘大小（单位GB） 示例值：150 |
| MasterNodeNum | 否 | Integer | 已废弃，请使用NodeInfoList 变配后的专用主节点个数（仅支持3个和5个） 示例值：1 |
| MasterNodeType | 否 | String | 已废弃，请使用NodeInfoList 变配后的专用主节点规格 示例值："test" |
| NodeInfoList.N | 否 | Array of NodeInfo | 节点信息列表，可以只传递要更新的节点及其对应的规格信息。支持的操作包括 |
| ForceRestart | 否 | Boolean | 更新配置时是否强制重启 示例值：true |
| ScaleType | 否 | Integer | 0: 蓝绿变更方式扩容，集群不重启 （默认） 1: 磁盘解挂载扩容，集群滚动重启 示例值：0 |
| MultiZoneInfo.N | 否 | Array of ZoneDetail | 多可用区部署 |
| WebNodeTypeInfo | 否 | WebNodeTypeInfo | 可视化节点配置 |
| CosBackup | 否 | CosBackup | COS自动备份信息 |
| ReadWriteMode | 否 | Integer | 读写分离模式：-1-不开启，1-本地读写分离，2-远端读写分离 示例值：-1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AllowUpdate | Boolean | 是否允许变配操作 示例值：false |
| ErrMsg | String | 不允许变配的原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：err |
| NeedSetShards | Boolean | 是否需要设置分片迁移并发相关参数 示例值：false |
| EnableScheduleRecoverGroupTask | Boolean | 是否需要开启置放群组异步任务 示例值：false |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 变配检查
变配检查
输入示例
https://es.tencentcloudapi.com/?Action=CheckUpdateInstance
&InstanceId=es-xxxxxxxx
&NodeType=ES.S1.MEDIUM4
&DiskSize=150
&<公共请求参数>输出示例
{
"Response": {
"AllowUpdate": true,
"RequestId": "dd3f624d-9a72-4057-85cb-f5d32exxxxxx",
"ErrMsg": "error"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.ClusterResourceLimitError | 集群资源配额限制错误。 |
| FailedOperation.DiskCountParamError | 节点磁盘块数参数检查失败。 |
| FailedOperation.ErrorClusterState | 集群状态错误。 |
| FailedOperation.ErrorClusterStateNoReplication | 集群索引没有副本存在。 |
| FailedOperation.ErrorClusterStateUnhealth | 集群状态不健康。 |
| FailedOperation.UnsupportedLocalDiskRollUpScaleUpOrDown | 不支持对本地盘集群通过滚动重启方式扩缩容。 |
| FailedOperation.UnsupportedResetNodeTypeAndScaleOutDisk | 不支持在滚动重启扩容计算资源同时扩容磁盘数量。 |
| FailedOperation.UnsupportedRestScaleDownAndModifyDisk | 不支持在滚动重启缩容计算资源同时修改磁盘大小 |
| FailedOperation.UnsupportedReverseRegulationNodeTypeAndDisk | 不支持反向调节节点配置和磁盘容量。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidCosBackupInfo | cos自动备份信息与预期不符。 |
| InvalidParameter.InvalidDiskCount | 节点磁盘块数DiskCount取值和预期不符。 |
| InvalidParameter.InvalidDiskEncrypt | 节点磁盘加密信息DiskEncrypt的取值与预期不符。 |
| InvalidParameter.InvalidDiskSize | 节点磁盘容量DiskSize的取值和预期不符。 |
| InvalidParameter.InvalidDiskType | 节点磁盘类型DiskType的取值和预期不符。 |
| InvalidParameter.InvalidEsACL | EsAcl的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId，没有找到对应资源。 |
| InvalidParameter.InvalidKibanaPrivatePort | Kibana内网访问端口的取值和预期不符。 |
| InvalidParameter.InvalidMultiZoneInfo | 多可用区部署ZoneDetail的信息与预期不符。 |
| InvalidParameter.InvalidNodeNum | 节点数量NodeNum的取值和预期不符。 |
| InvalidParameter.InvalidNodeType | 节点规格NodeType的取值和预期不符。 |
| InvalidParameter.InvalidPrivateAccess | 内网访问PrivateAccess的取值和预期不符。 |
| InvalidParameter.InvalidPublicAccess | 外网访问PublicAccess的取值和预期不符。 |
| InvalidParameter.InvalidScaleDiskSafeFactor | 磁盘缩容安全检查系数scale_disk_safe_factor配置有误 |
| InvalidParameter.InvalidSceneType | 场景化模版类型SceneType的取值和预期不符。 |
| InvalidParameter.InvalidSubnetId | 子网ID SubnetId的取值与预期不符。 |
| InvalidParameter.InvalidType | 节点类型Type的取值和预期不符。 |
| InvalidParameter.InvalidUin | Uin的取值和预期不符。 |
| InvalidParameter.InvalidUpdateType | 更新类型UpdateType的取值和预期不符。 |
| InvalidParameter.InvalidZone | 可用区Zone的信息与预期不符。 |
| InvalidParameterValue.ConfigInfo | 组件配置值有误。 |
| InvalidParameterValue.EsConfigType | ES配置类型取值有误。 |
| InvalidParameterValue.InstanceName | 实例名校验失败，按规则输入。 |
| InvalidParameterValue.InvalidDeadline | 截止日期冲突。 |
| InvalidParameterValue.Password | 密码校验不合法。 |
| LimitExceeded.ResourceLimit | 超出一个用户可以拥有的最大资源限制。 |
| LimitExceeded.UpdateItemLimit | 更新参数值过多，超过限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceInsufficient.Disk | 磁盘资源不足。 |
| ResourceInsufficient.Subnet | 子网剩余ip数量不足。 |
| ResourceInsufficient.SubnetIp | 可用的子网IP不足。 |
| ResourceInsufficient.Zone | 可用区资源不足。 |
| ResourceNotFound.CVMInfoNotFound | 获取CVM信息失败。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
| ResourceNotFound.DataNodeNotFound | 数据节点信息未找到。 |
| ResourceNotFound.DiskInfoNotFound | 磁盘相关资源获取失败。 |
| ResourceNotFound.NetWorkInfoNotFound | 网络资源获取失败。 |
| ResourceNotFound.OssInfoNotFound | 获取oss资源失败。 |
| ResourceNotFound.WhiteListNotFound | 白名单资源获取失败。 |
| UnauthorizedOperation.UinNotInWhiteList | Uin不在白名单中。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BasicSecurityType | 不支持该认证方式。 |
| UnsupportedOperation.ChangeNodeType | 不支持变配节点或磁盘的配置。 |
| UnsupportedOperation.ClusterShardNum | 不支持该操作，在集群中存在分配的分片。 |
| UnsupportedOperation.ClusterStateClose | 集群中存在部分索引处于关闭状态。 |
| UnsupportedOperation.ClusterStateNoReplication | 集群中存在部分索引无备份。 |
| UnsupportedOperation.ClusterStateUnHealth | 集群的状态不正常（不为绿）。 |
| UnsupportedOperation.CvmStateNotSupported | cvm当前运行状态不支持 |
| UnsupportedOperation.DataNodeJvmHeapTooSmall | 调整后集群数据节点堆内存过小 |
| UnsupportedOperation.DiskNotPortable | 该操作仅支持弹性云盘 |
| UnsupportedOperation.DiskStateNotSupported | 当前磁盘状态不支持 |
| UnsupportedOperation.DiskTypeChangePathNotSupported | 磁盘类型变更路径不支持 |
| UnsupportedOperation.HeteroScalingExecuting | 存在未完成的异构扩缩容流程 |
| UnsupportedOperation.IndexSettingsRequireSet | 集群有索引设置index.routing.allocation.require._name,or _ip, or _id |
| UnsupportedOperation.InstanceTypeError | 不支持该操作，服务类型有误。 |
| UnsupportedOperation.LicenseError | 不支持该操作，license的类型有误。 |
| UnsupportedOperation.LocalDisk | 不支持本地盘机型。 |
| UnsupportedOperation.MultiZonesUpgrade | 不支持多可用区变配。 |
| UnsupportedOperation.NotDataDisk | 该操作仅支持数据盘 |
| UnsupportedOperation.Plugin | 不支持该插件。 |
| UnsupportedOperation.ScaleDownTooMuch | 纵向缩容太多资源。 |
| UnsupportedOperation.ScaleInTooMuch | 横向缩容过多节点。 |
| UnsupportedOperation.SingleNodeClusterNotSupport | 单节点不支持该操作 |
| UnsupportedOperation.StatusNotNormal | 不支持该操作，当前实例运行状态不为正常。 |
| UnsupportedOperation.StatusNotSupport | 不支持该操作，实例状态有误。 |
| UnsupportedOperation.SwitchPrivateLink | 不支持切换PrivateLink架构。 |
| UnsupportedOperation.TotalStorage | 集群总的磁盘容量较小。 |
| UnsupportedOperation.VPCInfoNotFound | VPC资源获取失败。 |
