tencent cloud

APIs

DescribeLibraDBClusters

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-05-29 10:56:29

1. API Description

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

Query the analysis cluster list

A maximum of 70 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: DescribeLibraDBClusters.
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.
Limit No Integer Limit
Offset No Integer Offset
OrderBy No String Sorting field.
OrderByType No String Sort method
Filters.N No Array of QueryFilter Filter criteria.

3. Output Parameters

Parameter Name Type Description
ClusterSet Array of LibraDBClusterSet Cluster information.
TotalCount Integer Number of clusters
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 Querying the TDSQL-C Analysis Cluster List

Query TDSQL-C analytical cluster list

Input Example

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

{}

Output Example

{
    "Response": {
        "ClusterSet": [
            {
                "AppId": 1251966477,
                "ClusterId": "libradb-e9p7dqqm",
"ClusterName": "Pay-as-you-go"
                "CreateTime": "2025-06-20 17:01:53",
                "CynosVersion": "",
                "CynosVersionTag": "",
                "DbVersion": "3.2503.1.0",
                "InstanceNum": 1,
                "IsFreeze": "no",
                "MasterZone": "ap-qingyuan-1",
                "NetAddrs": [
                    {
                        "Description": "",
                        "InstanceGroupId": "",
                        "NetType": "libradbRo",
                        "UniqSubnetId": "subnet-mfsl0rqo",
                        "UniqVpcId": "vpc-95mugkpt",
                        "Vip": "192.168.254.39",
                        "Vport": 3306,
                        "WanDomain": "",
                        "WanIP": "",
                        "WanPort": 0,
                        "WanStatus": "init"
                    }
                ],
                "PayMode": 0,
                "PeriodEndTime": "0001-01-01 00:00:00",
                "PhysicalZone": "",
                "ProjectID": 0,
                "Region": "ap-qingyuan",
                "RenewFlag": 0,
                "Status": "running",
"StatusDesc": "Running"
                "Storage": 100,
                "SubnetId": "subnet-mfsl0rqo",
                "Tasks": [],
                "Uin": "3374998458",
                "UpdateTime": "2025-06-23 17:42:21",
                "Vip": "192.168.254.39",
                "VpcId": "vpc-95mugkpt",
                "Vport": 3306,
                "Zone": ""
            }
        ],
        "RequestId": "e22849e3-a047-4ad8-9d4d-c6929eeec965",
        "TotalCount": 1
    }
}

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.CamCheckResourceError Failed to get permissions. 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.
InternalError.DbOperationFailed Failed to query the database.
InternalError.InternalHttpServerError An exception occurred while executing the HTTP request.
InternalError.SystemError Internal system error.
InternalError.UnknownError Unknown internal error.
InvalidParameterValue.IllegalOrderBy Invalid sort by field.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
InvalidParameterValue.ParamBothSetError These two parameters cannot be set at the same time.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백