查询集群信息列表

最近更新时间:2024-06-18 02:12:00

我的收藏

1. 接口描述

接口请求域名: tcaplusdb.tencentcloudapi.com 。

查询TcaplusDB集群列表,包含集群详细信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusters。
Version String 公共参数,本接口取值:2019-08-23。
Region String 公共参数,详见产品支持的 地域列表
ClusterIds.N Array of String 指定查询的集群ID列表
示例值:10001
Filters.N Array of Filter 查询过滤条件
Offset Integer 查询列表偏移量
示例值:0
Limit Integer 查询列表返回记录数,默认值20
示例值:0
Ipv6Enable Integer 是否启用Ipv6
示例值:0

3. 输出参数

参数名称 类型 描述
TotalCount Integer 集群实例数
示例值:2
Clusters Array of ClusterInfo 集群实例列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群列表

查询用户所属的集群列表

输入示例

https://tcaplusdb.tencentcloudapi.com/?Action=DescribeClusters
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 0,
        "Clusters": [
            {
                "ClusterName": "abc",
                "ClusterId": "abc",
                "Region": "abc",
                "IdlType": "abc",
                "NetworkType": "abc",
                "VpcId": "abc",
                "SubnetId": "abc",
                "CreatedTime": "2020-09-22 00:00:00",
                "Password": "abc",
                "PasswordStatus": "abc",
                "ApiAccessId": "abc",
                "ApiAccessIp": "abc",
                "ApiAccessPort": 0,
                "OldPasswordExpireTime": "abc",
                "ApiAccessIpv6": "abc",
                "ClusterType": 0,
                "ClusterStatus": 0,
                "ReadCapacityUnit": 0,
                "WriteCapacityUnit": 0,
                "DiskVolume": 0,
                "ServerList": [
                    {
                        "ServerUid": "abc",
                        "MachineType": "abc",
                        "MemoryRate": 0,
                        "DiskRate": 0,
                        "ReadNum": 0,
                        "WriteNum": 0,
                        "Version": "abc"
                    }
                ],
                "ProxyList": [
                    {
                        "ProxyUid": "abc",
                        "MachineType": "abc",
                        "ProcessSpeed": 0,
                        "AverageProcessDelay": 0,
                        "SlowProcessSpeed": 0,
                        "Version": "abc"
                    }
                ],
                "Censorship": 0,
                "DbaUins": [
                    "abc"
                ],
                "DataFlowStatus": 0,
                "KafkaInfo": {
                    "Address": "abc",
                    "Topic": "abc",
                    "User": "abc",
                    "Password": "abc",
                    "Instance": "abc",
                    "IsVpc": 0
                },
                "TxhBackupExpireDay": 1,
                "UlogBackupExpireDay": 1,
                "IsReadOnlyUlogBackupExpireDay": 1,
                "RestProxyStatus": 0
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 接口操作鉴权错误。
FailedOperation.RegionMismatch 请求的地域不匹配。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。