TDSQL Boundless 查询实例列表

1. 接口描述

接口请求域名： tdmysql.tencentcloudapi.com 。

本接口（DescribeDBInstances）提供查询实例列表功能

默认接口请求频率限制：200次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBInstances。
Version	是	String	公共参数，本接口取值：2021-11-22。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of InstanceFilter	过滤参数
Limit	否	Integer	最大返回个数，默认为20，上限为100 示例值：20
Offset	否	Integer	偏移量，取Limit整数倍示例值：0

3. 输出参数

参数名称	类型	描述
Instances	Array of InstanceInfo	返回实例列表信息
TotalCount	Integer	满足条件总数量示例值：100
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例列表

输入示例

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

{
    "Filters": [
        {
            "Name": "Status",
            "Values": [
                "creating",
                "running"
            ]
        },
        {
            "Name": "VpcId",
            "Values": [
                "vpc-asdfifff"
            ]
        }
    ],
    "Limit": 20,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Instances": [
            {
                "ComputeNodeNum": 2,
                "Region": "ap-guangzhou",
                "Zone": "ap-guangzhou-1",
                "CreateVersion": "RELEASE_R080D001",
                "InitParams": [
                    {
                        "Value": "lower_case_table_names",
                        "Param": "0"
                    }
                ],
                "Status": "running",
                "StatusDesc": "运行中",
                "InstanceId": "tdsql3-f3475547",
                "StorageNodeNum": 3,
                "ResourceTags": [
                    {
                        "TagKey": "tag-key",
                        "TagValue": "tag-value"
                    }
                ],
                "InstanceName": "tdsql3-f3475547",
                "Cpu": 4,
                "VpcId": "vpc-o7ssr1vx",
                "Mem": 8,
                "Vip": "172.16.113.202",
                "SubnetId": "subnet-s21doiba",
                "Vport": 6008,
                "Disk": 200,
                "CreateTime": "2006-01-02 15:04:05"
            }
        ],
        "RequestId": "a93d2900-ef72-11eb-ab93-0716f253da76",
        "TotalCount": 100
    }
}

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. 错误码

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

错误码	描述
AuthFailure.UnauthorizedOperation	CAM鉴权失败。
FailedOperation.DBQueryInstanceError	查询实例数据失败。
FailedOperation.DBQueryTagError	查询tag绑定实例数据失败。
InvalidParameterValue.InstanceFilterKeyError	实例过滤参数错误。
LimitExceeded.OutOfInstanceCountLimitError	拉取实例超过限制个数。

查询实例列表

本页目录：