集群信息描述

1. 接口描述

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

该接口（DescribeClusterDetail）用于显示集群详情。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 集群信息描述

集群信息描述

输入示例

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

{
    "ClusterId": "cynosdbpg-5804k48e"
}

输出示例

{
    "Response": {
        "Detail": {
            "ClusterId": "cynosdbmysql-sgvwu2is",
            "ClusterName": "cynodbmysql-自定义用户名",
            "Region": "ap-guangzhou",
            "Zone": "ap-guangzhou-1",
            "PhysicalZone": "ap-guangzhou-1",
            "Status": "running",
            "StatusDesc": "运行中",
            "ServerlessStatus": "运行中",
            "StorageId": "cynosdbmysql-sgvwu2is",
            "Storage": 20,
            "MaxStorageSize": 1000,
            "MinStorageSize": 10,
            "StoragePayMode": 0,
            "VpcName": "vpc-osjw7wbx",
            "VpcId": "vpc-osjw7wbx",
            "SubnetName": "subnet-stbcji8s",
            "SubnetId": "subnet-stbcji8s",
            "Charset": "utf8mb4",
            "CreateTime": "2020-02-20 20:20:20",
            "DbType": "MYSQL",
            "DbMode": "normal",
            "DbVersion": "5.7",
            "StorageLimit": 20,
            "UsedStorage": 14,
            "Vip": "1.2.3.4",
            "Vport": 3306,
            "RoAddr": [
                {
                    "IP": "1.2.3.5",
                    "Port": 3306
                }
            ],
            "Ability": {
                "IsSupportSlaveZone": "yes",
                "NonsupportSlaveZoneReason": "aaabbbccc",
                "IsSupportRo": "yes",
                "NonsupportRoReason": "aaabbbccc",
                "IsSupportManualSnapshot": "yes"
            },
            "CynosVersion": "3.1.10",
            "BusinessType": "",
            "HasSlaveZone": "",
            "IsFreeze": "no",
            "Tasks": [
                {
                    "TaskId": 10,
                    "TaskType": "taskAutoBackup",
                    "TaskStatus": "processing",
                    "ObjectId": "cynosdbmysql-sgvwu2is",
                    "ObjectType": "taskObjTypeCluster"
                }
            ],
            "MasterZone": "ap-guangzhou-5",
            "SlaveZones": [
                "ap-guangzhou-3"
            ],
            "InstanceSet": [
                {
                    "InstanceId": "cynosdbmysql-ins-xvs9osn2",
                    "InstanceName": "cynosdbmysql-用户自定义名称",
                    "InstanceType": "rw",
                    "InstanceStatus": "running",
                    "InstanceStatusDesc": "运行中",
                    "InstanceCpu": 1,
                    "InstanceMemory": 2,
                    "InstanceStorage": 0,
                    "InstanceRole": "master",
                    "MaintainStartTime": 0,
                    "MaintainDuration": 0,
                    "MaintainWeekDays": [
                        "Mon"
                    ],
                    "ServerlessStatus": "pause"
                }
            ],
            "PayMode": 0,
            "PeriodEndTime": "2030-01-01 10:01:01",
            "ProjectID": 0,
            "ResourceTags": [
                {
                    "TagKey": "tagKey-1",
                    "TagValue": "tagValue-1"
                }
            ],
            "ProxyStatus": "running",
            "LogBin": "ON",
            "IsSkipTrade": "no",
            "PitrType": "redo_pitr",
            "IsOpenPasswordComplexity": "yes",
            "NetworkStatus": "whole_rdma",
            "ResourcePackages": [
                {
                    "PackageId": "package-xbhsw7wk",
                    "PackageType": "CCU",
                    "DeductionPriority": 1
                }
            ],
            "RenewFlag": 0,
            "NetworkType": "whole_rdma",
            "SlaveZoneAttr": [
                {
                    "Zone": "ap-guangzhou-3",
                    "BinlogSyncWay": "async"
                }
            ]
        },
        "RequestId": "6febb6f0-b0fc-11ee-93cb-73a07daf38c5"
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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