文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>时序数据库 CTSDB>API 文档>实例相关接口>查询实例列表

查询实例列表

最近更新时间：2025-09-12 01:46:47

我的收藏

本页目录：

1. 接口描述

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

查询实例列表及详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeClusters。
Version 是 String 公共参数，本接口取值：2023-02-02。
Region 是 String 公共参数，详见产品支持的 地域列表。
PageNumber 是 Integer 当前页数
示例值：1
PageSize 是 Integer 单页大小
示例值：20
Filters.N 否 Array of Filter 查询参数：支持通过实例ID（cluster_id）和实例名称（name）进行过滤查询
示例值：[{"Name":"name", "Values":["test"]}]
Orders.N 否 Array of Order 排序参数：支持通过创建时间字段（created_at）进行排序，Type可指定为DESC（降序）或ASC（升序）
示例值：[{"Name": "created_at", "Type": "DESC"}]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 当前条件下的总记录数
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
Clusters Array of Cluster 符合条件的实例列表
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例列表

查询实例列表

输入示例

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

{
    "PageNumber": 1,
    "PageSize": 10,
    "Filters": [
        {
            "Name": "cluster_id",
            "Op": "=",
            "Values": [
                "ctsdbi-xxxxxxx"
            ]
        }
    ],
    "Orders": [
        {
            "Name": "created_at",
            "Type": "DESC"
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Clusters": [
            {
                "AppID": 123456789,
                "ClusterID": "ctsdbi-xxxxxxx",
                "AccountID": "xxxxxx==",
                "Name": "测试实例",
                "Region": "guangzhou",
                "Zones": "guangzhou-3",
                "Networks": [
                    {
                        "VIP": "10.0.0.x",
                        "Port": 8086,
                        "VpcId": "332211",
                        "SubnetId": "55321"
                    }
                ],
                "Spec": {
                    "RequestUnit": 1,
                    "PayMode": 1,
                    "CpuLimit": 1,
                    "MemoryLimit": 4,
                    "DiskLimit": 100,
                    "Shards": 3,
                    "Replicas": 1
                },
                "Status": 1,
                "Period": {
                    "StartTime": "2020-09-22T00:00:00+00:00",
                    "EndTime": "2020-09-22T00:00:00+00:00"
                },
                "CreatedAt": "2020-09-22T00:00:00+00:00",
                "UpdatedAt": "2020-09-22T00:00:00+00:00",
                "Tenant": {},
                "Tags": [
                    {
                        "Key": "test",
                        "Value": "示例"
                    }
                ],
                "Security": [
                    "test"
                ]
            }
        ],
        "RequestId": "requestxxxxxxxxxx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
中国站
目录