1. 接口描述
接口请求域名： cdwch.tencentcloudapi.com 。
获取实例列表，供外部sdk使用
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstancesNew。 |
| Version | 是 | String | 公共参数，本接口取值：2020-09-15。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SearchInstanceId | 否 | String | 搜索的集群id名称 示例值：cdwch-xxxx |
| SearchInstanceName | 否 | String | 搜索的集群name 示例值：- |
| Offset | 否 | Integer | 分页参数，第一页为0，第二页为10 示例值：0 |
| Limit | 否 | Integer | 分页参数，分页步长，默认为10 示例值：20 |
| SearchTags.N | 否 | Array of SearchTags | 搜索标签列表 |
| IsSimple | 否 | Boolean | 信息详细与否 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 实例总数 示例值：18 |
| InstancesList | Array of InstanceInfo | 实例数组 示例值：- |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 test
查询
输入示例
POST / HTTP/1.1
Host: cdwch.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstancesNew
<公共请求参数>
{
"SearchInstanceId": "abc",
"SearchInstanceName": "abc",
"Offset": 0,
"Limit": 0,
"SearchTags": [
{
"TagKey": "abc",
"TagValue": "abc",
"AllValue": 0
}
]
}输出示例
{
"Response": {
"TotalCount": 0,
"InstancesList": [
{
"InstanceId": "abc",
"InstanceName": "abc",
"Status": "abc",
"Version": "abc",
"Region": "abc",
"Zone": "abc",
"VpcId": "abc",
"SubnetId": "abc",
"PayMode": "abc",
"CreateTime": "abc",
"ExpireTime": "abc",
"MasterSummary": {
"Spec": "abc",
"NodeSize": 0,
"Core": 0,
"Memory": 0,
"Disk": 0,
"DiskType": "abc",
"DiskDesc": "abc",
"AttachCBSSpec": {
"DiskType": "abc",
"DiskSize": 0,
"DiskCount": 0,
"DiskDesc": "abc"
},
"SubProductType": "abc",
"SpecCore": 0,
"SpecMemory": 0,
"DiskCount": 0,
"MaxDiskSize": 0,
"Encrypt": 0
},
"CommonSummary": {
"Spec": "abc",
"NodeSize": 0,
"Core": 0,
"Memory": 0,
"Disk": 0,
"DiskType": "abc",
"DiskDesc": "abc",
"AttachCBSSpec": {
"DiskType": "abc",
"DiskSize": 0,
"DiskCount": 0,
"DiskDesc": "abc"
},
"SubProductType": "abc",
"SpecCore": 0,
"SpecMemory": 0,
"DiskCount": 0,
"MaxDiskSize": 0,
"Encrypt": 0
},
"HA": "abc",
"AccessInfo": "abc",
"Id": 0,
"RegionId": 0,
"ZoneDesc": "abc",
"FlowMsg": "abc",
"StatusDesc": "abc",
"RenewFlag": true,
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"Monitor": "abc",
"HasClsTopic": true,
"ClsTopicId": "abc",
"ClsLogSetId": "abc",
"EnableXMLConfig": 0,
"RegionDesc": "abc",
"Eip": "abc",
"CosMoveFactor": 0,
"Kind": "abc",
"IsElastic": true,
"InstanceStateInfo": {
"InstanceState": "abc",
"FlowCreateTime": "abc",
"FlowName": "abc",
"FlowProgress": 0,
"InstanceStateDesc": "abc",
"FlowMsg": "abc",
"ProcessName": "abc",
"RequestId": "abc"
},
"HAZk": true,
"MountDiskType": 0,
"CHProxyVip": "abc",
"CosBucketName": "abc",
"CanAttachCbs": true,
"CanAttachCbsLvm": true,
"CanAttachCos": true,
"Components": [
{
"Name": "abc",
"Version": "abc"
}
],
"UpgradeVersions": "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: 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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |