1. 接口描述
接口请求域名: es.tencentcloudapi.com 。
集群可访问API展示
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeRequestInstancePolicy。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群id 示例值:ts-57zavbdv |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| GetPaths | Array of String | GET路径可请求的命令合集 示例值:["_cat/.*"] |
| PostPaths | Array of String | POST路径可请求的命令合集 示例值:["/.*/_open"] |
| PutPaths | Array of String | PUT路径可请求的命令合集 示例值:["/.*/_settings"] |
| IsDefault | Boolean | 是否是默认的参数 示例值:false |
| UpdateTime | String | 变更时间 示例值:2026-06-04 15:37:49 |
| Operator | String | 变更人 示例值:**** |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群可访问API展示
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRequestInstancePolicy
<公共请求参数>
{
"InstanceId": "ts-57zavbdv"
}
输出示例
{
"Response": {
"GetPaths": [
"_cat/.*"
],
"IsDefault": false,
"Operator": "************",
"PostPaths": [
"/.*/_open"
],
"PutPaths": [
"/.*/_settings"
],
"UpdateTime": "2026-06-04 15:37:49",
"RequestId": "f556db11-af0f-48df-9ada-b61569421411"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnAuthCreateInstance | 当前用户对创建集群实例操作未授权,请添加CAM权限 |
| AuthFailure.UnAuthorizedOperation | 操作未授权。 |
| FailedOperation.DiskCountParamError | 节点磁盘块数参数检查失败。 |
| FailedOperation.NoPayment | 账户未绑定信用卡或paypal,无法支付。 |
| FailedOperation.NodeNumAndZoneError | 节点数和可用区的信息不符合对应操作的规则。 |
| FailedOperation.NotAuthenticated | 用户未实名认证。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidAutoVoucher | 是否自动使用代金券AutoVoucher的取值和预期不符。 |
| InvalidParameter.InvalidDeployMode | 集群部署方式InvalidDeployMode的取值和预期不符。 |
| InvalidParameter.InvalidDiskCount | 节点磁盘块数DiskCount取值和预期不符。 |
| InvalidParameter.InvalidDiskEncrypt | 节点磁盘加密信息DiskEncrypt的取值与预期不符。 |
| InvalidParameter.InvalidDiskEnhance | 是否启用增强型ssd云盘DiskEnhance的取值和预期不符。 |
| InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
| InvalidParameter.InvalidNodeNum | 节点数量NodeNum的取值和预期不符。 |
| InvalidParameter.InvalidNodeType | 节点规格NodeType的取值和预期不符。 |
| InvalidParameter.InvalidOpType | 操作类型OpType的取值和预期不符。 |
| InvalidParameter.InvalidOperationDuration | 可维护时间段OperationDuration的取值和预期不符。 |
| InvalidParameter.InvalidRegion | 地域Region的取值与预期不符。 |
| InvalidParameter.InvalidTagList | 节点标签信息列表TagList的取值和预期不符。 |
| InvalidParameter.InvalidType | 节点类型Type的取值和预期不符。 |
| InvalidParameter.InvalidVoucherIds | 代金券ID列表VoucherIds的取值和预期不符。 |
| InvalidParameterValue.ChargeType | 计费类型ChargeType的参数取值有误。 |
| InvalidParameterValue.RenewFlag | 自动续费标识RenewFlag的参数取值有误。 |
| LimitExceeded.ClusterNum | 该账号下的集群数超过限额。 |
| LimitExceeded.ResourceLimit | 超出一个用户可以拥有的最大资源限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInUse.Order | 订单被锁定。 |
| ResourceInsufficient | 资源不足。 |
| ResourceInsufficient.Balance | 账户余额不足。 |
| ResourceInsufficient.HiddenZone | 隐藏可用区专用主节点资源不足。 |
| ResourceInsufficient.Subnet | 子网剩余ip数量不足。 |
| ResourceInsufficient.Zone | 可用区资源不足。 |
| ResourceNotFound.DiskInfoNotFound | 磁盘相关资源获取失败。 |
| ResourceNotFound.TradeCgwNotFound | 获取计费资源失败。 |
| ResourceNotFound.VPCInfoNotFound | VPC资源获取失败。 |
| ResourceNotFound.WhiteListNotFound | 白名单资源获取失败。 |
| UnauthorizedOperation.UinNotInWhiteList | Uin不在白名单中。 |
| UnsupportedOperation.BasicSecurityType | 不支持该认证方式。 |
| UnsupportedOperation.LicenseError | 不支持该操作,license的类型有误。 |
| UnsupportedOperation.SingleNodeClusterNotSupport | 单节点不支持该操作 |