tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeClusterDetail

最后更新时间：2024-11-28 17:22:14

    1. API Description

    Domain name for API request: cynosdb.intl.tencentcloudapi.com.

    This API is used to show the details of an instance.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeClusterDetail.
    Version Yes String Common Params. The value used for this API: 2019-01-07.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
    ClusterId Yes String Cluster ID

    3. Output Parameters

    Parameter Name Type Description
    Detail CynosdbClusterDetail Cluster details
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 集群信息描述

    集群信息描述

    Input Example

    POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterDetail
<common request parameters>

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

    Output Example

    {
    "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"
            },
            "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"
                }
            ],
            "RenewFlag": 0,
            "NetworkType": "whole_rdma",
            "SlaveZoneAttr": [
                {
                    "Zone": "ap-guangzhou-3",
                    "BinlogSyncWay": "async"
                }
            ]
        },
        "RequestId": "6febb6f0-b0fc-11ee-93cb-73a07daf38c5"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
    InternalError.DbOperationFailed Failed to query the database.
    InternalError.GetVpcFailed Failed to get the VPC.
    InternalError.InternalHttpServerError An exception occurred while executing the HTTP request.
    InternalError.SystemError Internal system error.
    InternalError.UnknownError Unknown internal error.
    InvalidParameterValue.ClusterNotFound No cluster found.
    InvalidParameterValue.InstanceNotFound The instance does not exist.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
    InvalidParameterValue.SubnetNotFound The selected subnet could not be found.
    OperationDenied.VersionNotSupportError Serverless is not supported on this version.
    ResourceNotFound.ClusterNotFoundError The cluster does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款