1. 接口描述
接口请求域名: keewidb.tencentcloudapi.com 。
本接口(DescribeInstances)可以根据地域、网络、实例id、标签、计费方式等条件,搜索查询实例列表。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstances。 |
Version | 是 | String | 公共参数,本接口取值:2022-03-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Limit | 否 | Integer | 每页输出的实例列表的大小,即每页输出的实例数量,默认值20,取值范围为[1,1000]。 示例值:100 |
Offset | 否 | Integer | 分页偏移量,取Limit整数倍。 计算公式为offset=limit*(页码-1)。例如 limit=10,第1页offset就为0,第2页offset就为10,依次类推。 示例值:0 |
InstanceId | 否 | String | 实例 ID,如:kee-6ubh****。 示例值:kee-6ubhgouj |
OrderBy | 否 | String | 排序依据。枚举范围如下所示。
示例值:createtime |
OrderType | 否 | Integer | 排序方式。
示例值:1 |
VpcIds.N | 否 | Array of String | 私有网络ID数组。数组下标从0开始,如果不传则默认选择基础网络,如:47525 |
SubnetIds.N | 否 | Array of String | 子网ID数组,数组下标从0开始,如:56854 |
ProjectIds.N | 否 | Array of Integer | 项目ID 组成的数组,数组下标从0开始 |
SearchKey | 否 | String | 查找关键字,可输入实例的ID或者实例名称。 |
InstanceName | 否 | String | 实例名称。 |
UniqVpcIds.N | 否 | Array of String | 私有网络ID数组,数组下标从0开始,如果不传则默认选择基础网络,如:vpc-sad23jfdfk |
UniqSubnetIds.N | 否 | Array of String | 子网ID数组,数组下标从0开始,如:subnet-fdj24n34j2 |
Status.N | 否 | Array of Integer | 实例状态。
|
AutoRenew.N | 否 | Array of Integer | 包年包月计费的续费模式。
|
BillingMode | 否 | String | 计费模式。
|
Type | 否 | Integer | 实例类型。
|
SearchKeys.N | 否 | Array of String | 搜索关键词:支持实例 ID、实例名称、私有网络IP地址。 |
TypeList.N | 否 | Array of Integer | 内部参数,用户可忽略。 |
MonitorVersion | 否 | String | 内部参数,用户可忽略。 |
InstanceTags | 否 | InstanceTagInfo | 根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值,则不根据标签进行过滤。 |
TagKeys.N | 否 | Array of String | 根据标签的 Key 筛选资源,该参数不配置或者数组设置为空值,则不根据标签Key进行过滤。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 实例数 示例值:1 |
InstanceSet | Array of InstanceInfo | 实例详细信息列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
输入示例
POST / HTTP/1.1
Host: keewidb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{
"Status": [
"0",
"1",
"2"
],
"Limit": "100",
"Offset": "0"
}
输出示例
{
"Response": {
"InstanceSet": [
{
"RedisShardSize": 16384,
"RedisShardNum": 1,
"MonitorVersion": "xx",
"AutoRenewFlag": 0,
"InstanceTitle": "xx",
"ProductType": "xx",
"PriceId": 1006984,
"Type": 13,
"Status": 2,
"Vip6": "xx",
"VpcId": 16770892,
"ClientLimit": 0,
"Tags": [
"xx"
],
"InstanceId": "xx",
"ClientLimitMax": 40000,
"RegionId": 1,
"SubStatus": 19,
"SlaveReadWeight": 0,
"OfflineTime": "xx",
"SubnetId": 2061142,
"NodeSet": [
{
"ZoneName": "xx",
"NodeType": 0,
"NodeId": 0,
"ZoneId": 1
}
],
"Engine": "xx",
"InstanceTags": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"ProjectId": 0,
"Region": "xx",
"DeadlineTime": "xx",
"CloseTime": "xx",
"ZoneId": 100002,
"PasswordFree": 0,
"DiskSize": 50000,
"NoAuth": false,
"Appid": 251200002,
"WanIp": "xx",
"NetLimit": 0,
"InstanceName": "xx",
"Createtime": "xx",
"UniqVpcId": "xx",
"DtsStatus": 0,
"ProjectName": "xx",
"BillingMode": 1,
"RemainBandwidthDuration": "xx",
"ReadOnly": 0,
"UniqSubnetId": "xx",
"ClientLimitMin": 10000,
"RedisReplicasNum": 1,
"Port": 6379,
"Size": 0.0
}
],
"TotalCount": 1,
"RequestId": "xx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.SystemError | 内部系统错误,和业务无关。 |
FailedOperation.Unknown | 未知类型操作错误。 |
InternalError.DbOperationFailed | 统一的 DB 操作错误,可以是 update insert select..。 |
InternalError.InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.EmptyParam | 参数为空。 |
InvalidParameter.InvalidParameter | 业务参数错误。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |