1. 接口描述
接口请求域名: vdb.tencentcloudapi.com 。
查询实例列表
默认接口请求频率限制:30次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstances。 |
Version | 是 | String | 公共参数,本接口取值:2023-06-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 否 | Array of String | 实例ID数组。 |
InstanceNames.N | 否 | Array of String | 实例名称,支持模糊搜索。 |
InstanceKeys.N | 否 | Array of String | 实例模糊搜索字段。 |
Status.N | 否 | Array of String | 根据状态获取实例, 为空则获取全部非隔离和非下线的实例。 |
EngineNames.N | 否 | Array of String | 按照引擎筛选实例。 |
EngineVersions.N | 否 | Array of String | 按照版本筛选实例。 |
CreateAt | 否 | String | 按照创建时间筛选实例。 |
Zones.N | 否 | Array of String | 按照可用区筛选实例。 |
OrderBy | 否 | String | 排序字段。 |
OrderDirection | 否 | String | 排序方式。 |
Offset | 否 | Integer | 查询开始位置。 |
Limit | 否 | Integer | 列表查询数量。 |
ResourceTags.N | 否 | Array of Tag | 按照标签筛选实例 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Items | Array of InstanceInfo | 实例列表。 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 实例总数。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
查询实例列表
输入示例
POST / HTTP/1.1
Host: vdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{
"Offset": 0,
"Limit": 50
}
输出示例
{
"Response": {
"Items": [
{
"AppId": 251223614,
"Cpu": 1,
"CreatedAt": "2023-07-07",
"Disk": 20,
"EngineName": "",
"EngineVersion": "",
"ExpiredAt": "2023-08-07",
"Extend": "{\"Port\": \"8100\", \"DiskType\": \"CLOUD_SSD\", \"NodeType\": \"Store\", \"Platform\": \"vdb-cd\", \"NodeSpecs\": \"{\\\"Cpu\\\":1,\\\"Memory\\\":8}\", \"NodeNumber\": \"3\", \"DiskCapacity\": \"20\", \"DiskTypeValue\": \"云硬盘\", \"EngineVersion\": \"v1.0.0\", \"NodeTypeValue\": \"存储型\", \"NodeSpecsValue\": \"S.2SMALL\", \"NodeNumberValue\": \"\", \"DiskCapacityValue\": \"\"}",
"HealthScore": 0,
"InstanceId": "vdb-77qt0r46",
"IsNoExpired": false,
"Memory": 8,
"Name": "benyqhuang_测试",
"Networks": [
{
"Port": 8100,
"SubnetId": "subnet-02bwnv4i",
"Vip": "10.0.7.132",
"VpcId": "vpc-kddx224l"
}
],
"PayMode": 1,
"Product": "vdb",
"Project": "vdb",
"Region": "ap-guangzhou",
"ReplicaNum": 3,
"ResourceTags": [],
"ShardNum": 1,
"Status": "online",
"Warning": 0,
"Zone": "ap-guangzhou-3"
},
{
"AppId": 251223614,
"Cpu": 1,
"CreatedAt": "2023-07-06",
"Disk": 20,
"EngineName": "",
"EngineVersion": "",
"ExpiredAt": "2023-08-06",
"Extend": "{\"Port\": \"8100\", \"DiskType\": \"CLOUD_SSD\", \"NodeType\": \"Store\", \"Platform\": \"vdb-cd\", \"NodeSpecs\": \"{\\\"Cpu\\\":1,\\\"Memory\\\":8}\", \"NodeNumber\": \"3\", \"DiskCapacity\": \"20\", \"DiskTypeValue\": \"云硬盘\", \"EngineVersion\": \"v1.0.0\", \"NodeTypeValue\": \"存储型\", \"NodeSpecsValue\": \"S.2SMALL\", \"NodeNumberValue\": \"\", \"DiskCapacityValue\": \"\"}",
"HealthScore": 0,
"InstanceId": "vdb-o2ovx6ko",
"IsNoExpired": false,
"Memory": 8,
"Name": "ha-test",
"Networks": [
{
"Port": 8100,
"SubnetId": "subnet-02bwnv4i",
"Vip": "10.0.7.115",
"VpcId": "vpc-kddx224l"
}
],
"PayMode": 1,
"Product": "vdb",
"Project": "vdb",
"Region": "ap-guangzhou",
"ReplicaNum": 3,
"ResourceTags": [],
"ShardNum": 1,
"Status": "online",
"Warning": 0,
"Zone": "ap-guangzhou-3"
}
],
"RequestId": "2757e3ad-427f-45dc-9119-8c9cfb4ae614",
"TotalCount": 2
}
}
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 | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |