1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
升级ES商业特性
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpgradeLicense。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：es-xxxxxxxx |
| LicenseType | 是 | String | License类型 示例值：platinum |
| AutoVoucher | 否 | Integer | 是否自动使用代金券 示例值：111 |
| VoucherIds.N | 否 | Array of String | 代金券ID列表（目前仅支持指定一张代金券） 示例值：111 |
| BasicSecurityType | 否 | Integer | 6.8（及以上版本）基础版是否开启xpack security认证 示例值：0 |
| ForceRestart | 否 | Boolean | 是否强制重启 示例值：TRUE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DealName | String | 订单号 注意：此字段可能返回 null，表示取不到有效值。 示例值：123 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 升级ES商业特性
升级ES商业特性
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeLicense
<公共请求参数>
{
"InstanceId": "es-xxxxxxxx",
"LicenseType": "platinum"
}输出示例
{
"Response": {
"RequestId": "1",
"DealName": "1"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.EsDictionaryInfoError | 由于EsDictionaryInfo错误，不允许操纵。 |
| FailedOperation.NoPayment | 账户未绑定信用卡或paypal，无法支付。 |
| FailedOperation.NotAuthenticated | 用户未实名认证。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidAutoVoucher | 是否自动使用代金券AutoVoucher的取值和预期不符。 |
| InvalidParameter.InvalidCosBackupInfo | cos自动备份信息与预期不符。 |
| InvalidParameter.InvalidDiskCount | 节点磁盘块数DiskCount取值和预期不符。 |
| InvalidParameter.InvalidDiskSize | 节点磁盘容量DiskSize的取值和预期不符。 |
| InvalidParameter.InvalidDiskType | 节点磁盘类型DiskType的取值和预期不符。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId，没有找到对应资源。 |
| InvalidParameter.InvalidKibanaPrivatePort | Kibana内网访问端口的取值和预期不符。 |
| InvalidParameter.InvalidNodeNum | 节点数量NodeNum的取值和预期不符。 |
| InvalidParameter.InvalidNodeType | 节点规格NodeType的取值和预期不符。 |
| InvalidParameter.InvalidOpType | 操作类型OpType的取值和预期不符。 |
| InvalidParameter.InvalidPrivateAccess | 内网访问PrivateAccess的取值和预期不符。 |
| InvalidParameter.InvalidRestartType | 重启方式RestartType的取值和预期不符。 |
| InvalidParameter.InvalidType | 节点类型Type的取值和预期不符。 |
| InvalidParameter.InvalidVoucherIds | 代金券ID列表VoucherIds的取值和预期不符。 |
| InvalidParameterValue.ChargeType | 计费类型ChargeType的参数取值有误。 |
| InvalidParameterValue.ConfigInfo | 组件配置值有误。 |
| InvalidParameterValue.EsConfigType | ES配置类型取值有误。 |
| InvalidParameterValue.InstanceName | 实例名校验失败，按规则输入。 |
| InvalidParameterValue.InvalidDeadline | 截止日期冲突。 |
| LimitExceeded.UpdateItemLimit | 更新参数值过多，超过限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInUse.Order | 订单被锁定。 |
| ResourceInsufficient | 资源不足。 |
| ResourceInsufficient.Balance | 账户余额不足。 |
| ResourceNotFound.ClusterInfoNotFound | 集群资源获取失败。 |
| ResourceNotFound.DataNodeNotFound | 数据节点信息未找到。 |
| ResourceNotFound.DiskInfoNotFound | 磁盘相关资源获取失败。 |
| ResourceNotFound.TradeCgwNotFound | 获取计费资源失败。 |
| UnauthorizedOperation.UinNotInWhiteList | Uin不在白名单中。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BasicSecurityType | 不支持该认证方式。 |
| UnsupportedOperation.ClusterStateNoReplication | 集群中存在部分索引无备份。 |
| UnsupportedOperation.ClusterStateUnHealth | 集群的状态不正常（不为绿）。 |
| UnsupportedOperation.InstanceTypeError | 不支持该操作，服务类型有误。 |
| UnsupportedOperation.LicenseError | 不支持该操作，license的类型有误。 |
| UnsupportedOperation.LocalDisk | 不支持本地盘机型。 |
| UnsupportedOperation.MultiZonesUpgrade | 不支持多可用区变配。 |
| UnsupportedOperation.Plugin | 不支持该插件。 |
