1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
查询用户该地域下符合条件的所有实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Zone | 否 | String | 集群实例所属可用区，不传则默认所有可用区 示例值：ap-guangzhou-3 |
| InstanceIds.N | 否 | Array of String | 集群实例ID列表 示例值：es-abcdefgh |
| InstanceNames.N | 否 | Array of String | 集群实例名称列表 示例值：测试 |
| Offset | 否 | Integer | 分页起始值, 默认值0 示例值：0 |
| Limit | 否 | Integer | 分页大小，默认值20 示例值：10 |
| OrderByKey | 否 | Integer | 排序字段 示例值：1 |
| OrderByType | 否 | Integer | 排序方式 示例值：0 |
| TagList.N | 否 | Array of TagInfo | 节点标签信息列表 |
| IpList.N | 否 | Array of String | 私有网络vip列表 示例值：10.2.3.4 |
| ZoneList.N | 否 | Array of String | 可用区列表 示例值：ap-guangzhou-3 |
| HealthStatus.N | 否 | Array of Integer | 健康状态筛列表:0表示绿色，1表示黄色，2表示红色,-1表示未知 |
| VpcIds.N | 否 | Array of String | Vpc列表 筛选项 示例值：vpc-gz5fa86l |
| CdcId | 否 | String | cdc集群id 示例值：cluster-262n63e8 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 返回的实例个数 示例值：2 |
| InstanceList | Array of InstanceInfo | 实例详细信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询ES集群实例
查询ES集群实例
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{}输出示例
{
"Response": {
"TotalCount": 1,
"InstanceList": [
{
"InstanceId": "es-7sy7efoi",
"InstanceName": "_some_name_",
"InstanceType": 2,
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-3",
"AppId": 130000000,
"Uin": "100000000",
"VpcUid": "vpc-xxxxxx",
"SubnetUid": "subnet-xxxxxx",
"CdcId": "cluster-xxxxxxxx",
"Status": 1,
"ChargeType": "POSTPAID_BY_HOUR",
"ChargePeriod": 0,
"RenewFlag": "",
"NodeInfoList": [
{
"Type": "hotData",
"NodeNum": 3,
"NodeType": "ES.SA2.MEDIUM4",
"CpuNum": 0,
"MemSize": 0,
"DiskType": "CLOUD_SSD",
"DiskSize": 20,
"DiskEnhance": 0,
"DiskEncrypt": 0,
"DiskCount": 1,
"LocalDiskInfo": null
}
],
"NodeType": "ES.SA2.MEDIUM4",
"NodeNum": 3,
"CpuNum": 2,
"MemSize": 4,
"DiskType": "CLOUD_SSD",
"AutoIndexEnabled": true,
"DiskSize": 20,
"EnableHotWarmMode": false,
"WarmNodeType": "",
"WarmNodeNum": 0,
"WarmCpuNum": 0,
"WarmMemSize": 0,
"WarmDiskType": "",
"WarmDiskSize": 0,
"ColdNodeType": "",
"ColdNodeNum": 0,
"ColdCpuNum": 0,
"ColdMemSize": 0,
"ColdDiskType": "",
"ColdDiskSize": 0,
"FrozenNodeType": "",
"FrozenNodeNum": 0,
"FrozenCpuNum": 0,
"FrozenMemSize": 0,
"FrozenDiskType": "",
"FrozenDiskSize": 0,
"MasterNodeInfo": {
"EnableDedicatedMaster": false,
"MasterNodeType": "",
"MasterNodeNum": 0,
"MasterNodeCpuNum": 0,
"MasterNodeMemSize": 0,
"MasterNodeDiskType": "",
"MasterNodeDiskSize": 0
},
"KibanaNodeInfo": {
"KibanaNodeType": "ES.SA2.SMALL2",
"KibanaNodeNum": 1,
"KibanaNodeCpuNum": 1,
"KibanaNodeMemSize": 2,
"KibanaNodeDiskType": "CLOUD_PREMIUM",
"KibanaNodeDiskSize": 50
},
"EsDomain": "es-7sy7efoi.myelasticsearch.com",
"EsPrivateDomain": "es-7sy7efoi-esinternal.kibana.myelasticsearch.com",
"EsVip": "{vip}",
"EsPort": 9200,
"KibanaUrl": "https://es-7sy7efoi.kibana.myelasticsearch.com:5601",
"KibanaPrivateUrl": "",
"PublicAccess": "CLOSE",
"KibanaPublicAccess": "OPEN",
"KibanaPrivateAccess": "CLOSE",
"KibanaAlteringPublicAccess": "CLOSE",
"Protocol": "",
"SecurityGroups": [],
"EsPublicUrl": "",
"EsPrivateUrl": "https://es-7sy7efoi-esinternal.kibana.myelasticsearch.com:9200",
"EsVersion": "7.14.2",
"EsConfig": "{}",
"EsConfigSets": [],
"KibanaConfig": "",
"EsAcl": {
"WhiteIpList": [
"127.0.0.1"
],
"BlackIpList": []
},
"EsPublicAcl": {
"WhiteIpList": [],
"BlackIpList": []
},
"IkConfig": {
"UpdateType": "",
"MainDict": [],
"Stopwords": [],
"Synonym": [],
"QQDict": []
},
"AllowCosBackup": true,
"CosBackup": {
"IsAutoBackup": false,
"BackupTime": ""
},
"DeployMode": 0,
"MultiZoneInfo": [
{
"Zone": "ap-guangzhou-3",
"SubnetId": "subnet-q29llw8g"
}
],
"TagList": [],
"HealthStatus": 0,
"SecurityType": 2,
"LicenseType": "platinum",
"SceneType": 1,
"Jdk": "kona",
"WebNodeTypeInfo": {
"NodeNum": 1,
"NodeType": "ES.SA2.SMALL2"
},
"CreateTime": "2022-07-06 20:52:48",
"UpdateTime": "2022-07-07 17:35:29",
"Deadline": "2017-12-04 00:00:00",
"OperationDuration": null,
"OptionalWebServiceInfos": [
{
"Status": 0,
"PrivateAccess": "abc",
"PublicAccess": "abc",
"PrivateUrl": "abc",
"Version": "abc",
"Type": "abc",
"PublicUrl": "abc"
}
],
"ProcessPercent": 0.5,
"EnableHybridStorage": true,
"HasKernelUpgrade": true,
"SubProductCode": "sp_es_platium"
}
],
"RequestId": "xxxx"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnAuthDescribeInstances | 当前用户对查询集群实例操作未授权，请添加CAM权限。 |
| AuthFailure.UnAuthorizedOperation | 操作未授权。 |
| FailedOperation.GetTagInfoError | 获取实例的标签列表错误。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidAppId | AppId的取值和预期不符。 |
| InvalidParameter.InvalidIp | Ip地址取值和预期不符。 |
| InvalidParameter.InvalidIpList | 私有网络vip列表IpList的取值和预期不符。 |
| InvalidParameter.InvalidLimit | 分页大小Limit的取值和预期不符。 |
| InvalidParameter.InvalidNodeType | 节点规格NodeType的取值和预期不符。 |
| InvalidParameter.InvalidOffset | 分页起始值Offset的取值和预期不符。 |
| InvalidParameter.InvalidOrderByKey | 排序字段OrderByKey的取值和预期不符。 |
| InvalidParameter.InvalidOrderByType | 排序方式OrderByType的取值和预期不符。 |
| InvalidParameter.InvalidRegion | 地域Region的取值与预期不符。 |
| InvalidParameter.InvalidTagInfo | 节点标签信息TagInfo的取值和预期不符。 |
| InvalidParameter.InvalidTagList | 节点标签信息列表TagList的取值和预期不符。 |
| InvalidParameter.InvalidZone | 可用区Zone的信息与预期不符。 |
| ResourceNotFound.CAMInfoNotFound | CAM资源未找到。 |
| ResourceNotFound.DBInfoNotFound | 数据库资源获取失败。 |
