云数据库 KeeWiDB 查询实例列表

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	排序依据。枚举范围如下所示。 projectId：实例按照项目ID排序。 createtime：实例按照创建时间排序。 instancename：实例按照实例名称排序。 type：实例按照类型排序。 curDeadline：实例按照到期时间排序。示例值：createtime
OrderType	否	Integer	排序方式。 1：倒序。默认为倒序。 0：顺序。示例值：1
VpcIds.N	否	Array of String	私有网络ID数组。数组下标从0开始，如果不传则默认选择基础网络，如：47525 示例值：47525
SubnetIds.N	否	Array of String	子网ID数组，数组下标从0开始，如：56854 示例值：56854
ProjectIds.N	否	Array of Integer	项目ID 组成的数组，数组下标从0开始示例值：[1289900]
SearchKey	否	String	查找关键字，可输入实例的ID或者实例名称。示例值：模糊查询实例名称
InstanceName	否	String	实例名称。示例值：example_InstanceName
UniqVpcIds.N	否	Array of String	私有网络ID数组，数组下标从0开始，如果不传则默认选择基础网络，如：vpc-sad23jfdfk 示例值：vpc-b6fsjaxt
UniqSubnetIds.N	否	Array of String	子网ID数组，数组下标从0开始，如：subnet-fdj24n34j2 示例值：subnet-gqj66zh0
Status.N	否	Array of Integer	实例状态。 0：待初始化。 1：流程中。 2：运行中。 -2：已隔离。 -3：待删除。示例值：1
AutoRenew.N	否	Array of Integer	续费模式。- 0：手动续费。- 1：自动续费。- 2：到期不再续费。示例值：1
BillingMode	否	String	计费模式。 postpaid：按量计费。 prepaid：包年包月。示例值：1
Type	否	Integer	实例类型。 13：标准版。 14：集群版。示例值：13
SearchKeys.N	否	Array of String	搜索关键词：支持实例 ID、实例名称、私有网络IP地址。示例值：["kee-dagpcalj"]
TypeList.N	否	Array of Integer	内部参数，用户可忽略。示例值：1
MonitorVersion	否	String	内部参数，用户可忽略。示例值：1
TagKeys.N	否	Array of String	根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。示例值：keyname
TagList.N	否	Array of InstanceTagInfo	根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。示例值：[{"TagKey": "key1", "TagValue": "value1"}]

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	实例数示例值：1
InstanceSet	Array of InstanceInfo	实例详细信息列表示例值：具体参考数据结构。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

查询Keewidb实例列表

输入示例

POST / HTTP/1.1
Host: keewidb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>

{
    "Status": [
        "0",
        "1",
        "2"
    ],
    "Limit": "2",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "Appid": 251223628,
                "AutoRenewFlag": 0,
                "BillingMode": 1,
                "ClientLimit": 10000,
                "ClientLimitMax": 40000,
                "ClientLimitMin": 10000,
                "CloseTime": "0000-00-00 00:00:00",
                "Createtime": "2023-04-17 11:32:18",
                "DeadlineTime": "2023-05-17 11:32:18",
                "DiskSize": 0,
                "DtsStatus": 0,
                "Engine": "Keewidb",
                "InstanceId": "kee-4nmzc0ul",
                "InstanceName": "Keewidb_automation_is_awesome",
                "InstanceTags": [],
                "InstanceTitle": "添加实例中",
                "MonitorVersion": "5s",
                "NetLimit": 24,
                "NoAuth": false,
                "NodeSet": [
                    {
                        "NodeId": 336948,
                        "NodeType": 0,
                        "ZoneId": 100002,
                        "ZoneName": ""
                    },
                    {
                        "NodeId": 336946,
                        "NodeType": 1,
                        "ZoneId": 100003,
                        "ZoneName": ""
                    },
                    {
                        "NodeId": 336947,
                        "NodeType": 1,
                        "ZoneId": 100004,
                        "ZoneName": ""
                    }
                ],
                "OfflineTime": "",
                "PasswordFree": 0,
                "Port": 6379,
                "PriceId": 1000848,
                "ProductType": "standalone",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "ReadOnly": 0,
                "RedisReplicasNum": 2,
                "RedisShardNum": 1,
                "RedisShardSize": 4096,
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "RemainBandwidthDuration": "",
                "Size": 4096,
                "SlaveReadWeight": 0,
                "Status": 1,
                "SubStatus": 37,
                "SubnetId": 2282634,
                "Tags": [],
                "Type": 15,
                "UniqSubnetId": "subnet-1ed4w7to",
                "UniqVpcId": "vpc-mjwornzj",
                "Vip6": "",
                "VpcId": 11133673,
                "WanIp": "10.0.1.61",
                "ZoneId": 100002,
                "DiskShardSize": 60,
                "DiskReplicasNum": 3,
                "Compression": "",
                "MachineMemory": 16,
                "DiskShardNum": 1
            },
            {
                "Appid": 251223628,
                "AutoRenewFlag": 0,
                "BillingMode": 1,
                "ClientLimit": 10000,
                "ClientLimitMax": 40000,
                "ClientLimitMin": 10000,
                "CloseTime": "0000-00-00 00:00:00",
                "Createtime": "2023-04-17 11:47:02",
                "DeadlineTime": "2023-05-17 11:47:01",
                "DiskSize": 0,
                "DtsStatus": 0,
                "Engine": "Keewidb",
                "InstanceId": "kee-46njvft9",
                "InstanceName": "Keewidb_automation_is_awesome",
                "InstanceTags": [],
                "InstanceTitle": "运行中",
                "MonitorVersion": "5s",
                "NetLimit": 24,
                "NoAuth": false,
                "NodeSet": [
                    {
                        "NodeId": 336951,
                        "NodeType": 0,
                        "ZoneId": 100002,
                        "ZoneName": ""
                    },
                    {
                        "NodeId": 336949,
                        "NodeType": 1,
                        "ZoneId": 100003,
                        "ZoneName": ""
                    },
                    {
                        "NodeId": 336950,
                        "NodeType": 1,
                        "ZoneId": 100004,
                        "ZoneName": ""
                    }
                ],
                "OfflineTime": "",
                "PasswordFree": 0,
                "Port": 6379,
                "PriceId": 1000848,
                "ProductType": "standalone",
                "ProjectId": 0,
                "ProjectName": "默认项目",
                "ReadOnly": 0,
                "RedisReplicasNum": 2,
                "RedisShardNum": 1,
                "RedisShardSize": 4096,
                "Region": "ap-guangzhou",
                "RegionId": 1,
                "RemainBandwidthDuration": "",
                "Size": 4096,
                "SlaveReadWeight": 0,
                "Status": 2,
                "SubStatus": 19,
                "SubnetId": 2282634,
                "Tags": [],
                "Type": 6,
                "UniqSubnetId": "subnet-1ed4w7to",
                "UniqVpcId": "vpc-mjwornzj",
                "Vip6": "",
                "VpcId": 11133673,
                "WanIp": "10.0.1.71",
                "ZoneId": 100002,
                "DiskShardSize": 60,
                "DiskReplicasNum": 3,
                "Compression": "",
                "MachineMemory": 16,
                "DiskShardNum": 1
            }
        ],
        "RequestId": "3fb5a4d2-680c-45a2-aa88-0213b76d1489",
        "TotalCount": 8
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.SystemError	内部系统错误，和业务无关。
FailedOperation.Unknown	未知类型操作错误。
InternalError.DbOperationFailed	统一的 DB 操作错误，可以是 update insert select..。
InternalError.InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.EmptyParam	参数为空。
InvalidParameter.InvalidParameter	业务参数错误。
InvalidParameter.PermissionDenied	接口没有cam权限。

查询实例列表

本页目录：