1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
获取指定region下指定zone列表的资源情况
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：QueryZoneResource。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Zones.N | 是 | Array of String | 要检查的可用区 |
| OptType | 是 | String | 操作类型（create数据节点创建，masterCreate专用主节点创建，scaleUp数据节点纵向扩容，masterAdd添加专用主节点，masterScaleUp专用主节点纵向扩容） |
| InstanceId | 否 | String | 实例ID(变配检查需要传递) |
| DeployMode | 否 | Integer | 集群部署方式 |
| ChargeType | 否 | String | 计费类型 |
| EsVersion | 否 | String | ES版本号如5.6.4，6.4.3，6.8.2，7.5.1 |
| CdcId | 否 | String | cdcId，使用cdc子网时传递 示例值：cluster-xxxxxx |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ZoneResources | Array of ZoneResource | 可用区资源描述列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取可用区资源情况
获取可用区资源情况
输入示例
https://es.tencentcloudapi.com/?Action=QueryZoneResource
&InstanceId=es-xxxxxxxx
&Zones.0=ap-beijing-3
&Zones.1=ap-beijing-4
&OptType=create
&ChargeType=PREPAID
&EsVersion=7.5.1
&<公共请求参数>输出示例
{
"Response": {
"ZoneResources": [
{
"Available": true,
"NodeTypeList": [
{
"Available": true,
"LocalDiskInfo": {
"LocalDiskType": "abc",
"LocalDiskSize": 1,
"LocalDiskCount": 1
},
"DiskCountRange": {
"Max": 1,
"Min": 1
},
"SsdAvailable": false,
"SsdDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Max": 1,
"Min": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"SsdSoldOutReason": "abc",
"BssdAvailable": true,
"BssdDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Max": 1,
"Min": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"BssdSoldOutReason": "abc",
"NodeTypeInfo": {
"Mem": 1,
"Cpu": 1,
"Desc": "abc"
},
"SataAvailable": false,
"NodeTypeName": "abc",
"SataSoldOutReason": "abc",
"SataDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Max": 1,
"Min": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"ThroughputAvailable": true,
"HSsdDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"ThroughputSoldOutReason": "abc",
"HSsdSoldOutReason": "abc",
"HSsdAvailable": true,
"ThroughputDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"BigDataAvailable": true,
"BigDataSoldOutReason": "abc",
"BigDataDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"HighIOAvailable": true,
"HighIOSoldOutReason": "abc",
"HighIODiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
}
},
{
"Available": true,
"LocalDiskInfo": {
"LocalDiskType": "abc",
"LocalDiskSize": 1,
"LocalDiskCount": 1
},
"DiskCountRange": {
"Max": 1,
"Min": 1
},
"SsdAvailable": false,
"SsdDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Min": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"SsdSoldOutReason": "abc",
"BssdAvailable": false,
"BssdDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Min": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"BssdSoldOutReason": "abc",
"NodeTypeInfo": {
"Mem": 1,
"Cpu": 1,
"Desc": "abc"
},
"SataAvailable": false,
"NodeTypeName": "abc",
"SataSoldOutReason": "abc",
"SataDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Min": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"ThroughputAvailable": true,
"HSsdDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"ThroughputSoldOutReason": "abc",
"HSsdSoldOutReason": "abc",
"HSsdAvailable": true,
"ThroughputDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"BigDataAvailable": true,
"BigDataSoldOutReason": "abc",
"BigDataDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"HighIOAvailable": true,
"HighIOSoldOutReason": "abc",
"HighIODiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
}
},
{
"Available": true,
"LocalDiskInfo": {
"LocalDiskType": "abc",
"LocalDiskSize": 1,
"LocalDiskCount": 1
},
"DiskCountRange": {
"Max": 1,
"Min": 1
},
"SsdAvailable": false,
"SsdDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Min": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"SsdSoldOutReason": "abc",
"BssdAvailable": false,
"BssdDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Min": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"BssdSoldOutReason": "abc",
"NodeTypeInfo": {
"Mem": 1,
"Cpu": 1,
"Desc": "abc"
},
"SataAvailable": false,
"NodeTypeName": "abc",
"SataSoldOutReason": "abc",
"SataDiskSizeRange": {
"Med": 1,
"Sml": 1,
"Min": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"ThroughputAvailable": true,
"HSsdDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"ThroughputSoldOutReason": "abc",
"HSsdSoldOutReason": "abc",
"HSsdAvailable": true,
"ThroughputDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"BigDataAvailable": true,
"BigDataSoldOutReason": "abc",
"BigDataDiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
},
"HighIOAvailable": true,
"HighIOSoldOutReason": "abc",
"HighIODiskSizeRange": {
"Min": 1,
"Sml": 1,
"Med": 1,
"Max": 1,
"DiskCountMin": 1,
"DiskCountMax": 1
}
}
],
"AvailNodeFamilies": [
"abc"
],
"ZoneName": "abc"
}
],
"RequestId": "abc"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter.InvalidInstanceId | 无效的InstanceId，没有找到对应资源。 |
| InvalidParameter.InvalidNodeType | 节点规格NodeType的取值和预期不符。 |
| InvalidParameter.InvalidOpType | 操作类型OpType的取值和预期不符。 |
| InvalidParameter.InvalidRegion | 地域Region的取值与预期不符。 |
| InvalidParameter.InvalidZone | 可用区Zone的信息与预期不符。 |
| InvalidParameterValue.ChargeType | 计费类型ChargeType的参数取值有误。 |
| ResourceInsufficient.HiddenZone | 隐藏可用区专用主节点资源不足。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
| ResourceNotFound.DiskInfoNotFound | 磁盘相关资源获取失败。 |
| ResourceNotFound.OssInfoNotFound | 获取oss资源失败。 |
| ResourceNotFound.WhiteListNotFound | 白名单资源获取失败。 |
| UnsupportedOperation.InstanceTypeError | 不支持该操作，服务类型有误。 |
