tencent cloud

APIs

DescribeLibraDBClusterDetail

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-10-22 10:47:35

1. API Description

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

Queries TDSQL-C analysis cluster information

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: DescribeLibraDBClusterDetail.
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-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId Yes String Analysis Cluster ID
GetServerInfo No String Whether to get more server information. Available values: yes, no

3. Output Parameters

Parameter Name Type Description
Detail LibraDBClusterDetail Cluster information.
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 View TDSQL-C Analysis Cluster Details

View the details of an analytics cluster

Input Example

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

{
    "ClusterId": "libradb-i8okw971"
}

Output Example

{
    "Response": {
        "Detail": {
            "ClusterId": "libradb-i8okw971",
            "ClusterName": "libradb-i8okw971",
            "CreateTime": "2025-05-15 15:42:58",
            "CynosVersion": "",
            "CynosVersionTag": "",
            "DbVersion": "1.2404.21.0",
            "InstanceSet": [
                {
                    "DbMode": "",
                    "InstanceCpu": 4,
                    "InstanceDeviceType": "Common",
                    "InstanceId": "libradb-ins-6231eq34",
                    "InstanceMemory": 16,
                    "InstanceName": "libradb-ins-6231eq34",
                    "InstanceRole": "libradbRo",
                    "InstanceStatus": "running",
                    "InstanceStatusDesc": "Running",
                    "InstanceStorage": 20,
                    "InstanceStorageType": "CLOUD_TCS",
                    "InstanceType": "libradbRo",
                    "MaintainDuration": 3600,
                    "MaintainStartTime": 10800,
                    "MaintainWeekDays": [
                        "Mon",
                        "Tue",
                        "Wed",
                        "Thu",
                        "Fri",
                        "Sat",
                        "Sun"
                    ],
                    "NodeList": [
                        "libradbn-0"
                    ]
                }
            ],
            "IsFreeze": "no",
            "MasterZone": "ap-guangzhou-7",
            "NoSupportAddRo": "",
            "PayMode": 0,
            "PeriodEndTime": "0001-01-01 00:00:00",
            "PhysicalZone": "",
            "ProjectID": 0,
            "Region": "ap-guangzhou",
            "RenewFlag": 0,
            "RoAddr": [
                {
                    "IP": "172.16.0.67",
                    "Port": 3306
                }
            ],
            "Status": "running",
            "StatusDesc": "running",
            "Storage": 20,
            "SubnetId": "subnet-558rhwt2",
            "SubnetName": "Default-Subnet",
            "Tasks": [],
            "UsedStorage": 0,
            "Vip": "172.16.0.67",
            "VpcId": "vpc-nnakli31",
            "VpcName": "Default-VPC",
            "Vport": 3306,
            "Zone": ""
        },
        "RequestId": "7d579362-a249-4dd0-9cf3-d1c68af42d2b"
    }
}

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. Try again later. If the issue persists, contact customer service.
FailedOperation.DatabaseAccessError Database access failed. Try again later. If the issue persists, contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the issue persists, contact customer service.
InternalError.DbOperationFailed Query database failed.
InternalError.GetVpcFailed Failed to get the VPC.
InternalError.InternalHttpServerError http request execution error.
InternalError.SystemError Internal system error.
InternalError.UnknownError Unknown internal error.
InvalidParameterValue.ClusterNotFound Cluster not found.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.InvalidParameterValueError Parameter value is invalid.
InvalidParameterValue.SubnetNotFound Subnet not found.
OperationDenied.VersionNotSupportError Serverless does not support this version.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

Ajuda e Suporte

Esta página foi útil?

comentários