DescribeClusters

Last updated: 2025-11-13 20:51:29

DescribeClusters

Last updated: 2025-11-13 20:51:29

1. API Description

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

This API is used to describe clusters.

A maximum of 1000 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: DescribeClusters.
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.
DbType	No	String	Engine type. Currently, `MYSQL` is supported.
Limit	No	Integer	Number of returned results. Default value: 20. Maximum value: 100
Offset	No	Integer	Record offset. Default value: 0
OrderBy	No	String	Sort by field. Valid values: CREATETIME: creation time PERIODENDTIME: expiration time
OrderByType	No	String	Sorting order. Valid values: ASC: ascending DESC: descending
Filters.N	No	Array of QueryFilter	Filter. If more than one filter exists, the logical relationship between these filters is `AND`.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of clusters
ClusterSet	Array of CynosdbCluster	Cluster list
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 Query a Cluster List

Query a Cluster List

Input Example

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

{
    "DbType": "MYSQL",
    "Limit": 20,
    "Filters": [
        {
            "Values": [
                "cynosdbpg-ins-bzkxxrmt"
            ],
            "Names": [
                "InstanceId"
            ],
            "ExactMatch": "true"
        }
    ],
    "Offset": 0
}

Output Example

{
    "Response": {
        "ClusterSet": [
            {
                "Ability": {
                    "IsSupportManualSnapshot": "no",
                    "IsSupportRo": "yes",
                    "IsSupportSlaveZone": "yes",
                    "IsSupportTransparentDataEncryption": "no",
                    "NoSupportTransparentDataEncryptionReason": "current cluster not support transparent data encryption",
                    "NonsupportRoReason": "yes",
                    "NonsupportSlaveZoneReason": "current cluster not support ro"
                },
                "AppId": 2372636427,
                "BusinessType": "bus_a",
                "ClusterId": "cynosdbmysql-cbsg6tsg",
                "ClusterName": "MyClusterName",
                "CreateTime": "2024-05-30 19:26:42",
                "CynosVersion": "2.1.12",
                "DbMode": "NORMAL",
                "DbType": "MYSQL",
                "DbVersion": "5.7",
                "HasSlaveZone": "yes",
                "InstanceNum": 2,
                "IsFreeze": "no",
                "MasterZone": "ap-singapore-3",
                "MaxStorageSize": 30000,
                "MinStorageSize": 10,
                "NetAddrs": [
                    {
                        "Description": "descirption",
                        "InstanceGroupId": "cynosdbpg-grp-sbh6ywhs",
                        "NetType": "singleRo",
                        "UniqSubnetId": "subnet-cnhsb8iu",
                        "UniqVpcId": "vpc-iskx6ygc",
                        "Vip": "1.1.1.1",
                        "Vport": 3306,
                        "WanDomain": "cynosdbpg-bzbsxrmt.wan.domain.com",
                        "WanIP": "3.45.1.9",
                        "WanPort": 3306,
                        "WanStatus": "init"
                    },
                    {
                        "Description": "descirption",
                        "InstanceGroupId": "cynosdbpg-grp-bc2b3us4",
                        "NetType": "ha",
                        "UniqSubnetId": "subnet-7shw8ijc",
                        "UniqVpcId": "vpc-y7us28sn",
                        "Vip": "1.1.1.1",
                        "Vport": 3306,
                        "WanDomain": "cynosdbpg-bzkxxrmt.wan.domain.com",
                        "WanIP": "3.23.1.5",
                        "WanPort": 3306,
                        "WanStatus": "init"
                    }
                ],
                "OrderSource": "lhdb",
                "PayMode": 1,
                "PeriodEndTime": "2024-06-30 19:32:51",
                "PhysicalZone": "ap-singapore-3",
                "ProcessingTask": "taskUpgradeStorage",
                "ProjectID": 23,
                "Region": "ap-singapore",
                "RenewFlag": 1,
                "ResourcePackages": [
                    {
                        "DeductionPriority": 0,
                        "PackageId": "package-nxuyx1op",
                        "PackageType": "CCU"
                    }
                ],
                "ResourceTags": [
                    {
"TagKey": "Operating product"
"TagValue": "Tencent Cloud billing product other_1649"
                    },
                    {
"TagKey": "Operation Department"
"TagValue": "billing product center_1013"
                    },
                    {
"TagKey": "Level-1 Business"
"TagValue": "[N][Tencent Cloud billing product other]_979685"
                    },
                    {
"TagKey": "Level-2 business"
"TagValue": "[license Management][license Data Engine]123"
                    }
                ],
                "ServerlessStatus": "paused",
                "SlaveZones": [
                    "ap-singapore-4"
                ],
                "Status": "running",
"StatusDesc": "Running"
                "Storage": 0,
                "StorageId": "cynosdbpg-bcsu6tsg",
                "StorageLimit": 30000,
                "StoragePayMode": 0,
                "SubnetId": "subnet-ybs8jcnw",
                "Tasks": [
                    {
                        "ObjectId": "cynosdbmysql-k5sm8sh3",
                        "ObjectType": "taskObjTypeCluster",
                        "TaskId": 1207003,
                        "TaskStatus": "processing",
                        "TaskType": "taskDtsLockResource"
                    }
                ],
                "Uin": "237462834",
                "UpdateTime": "2024-05-30 19:43:06",
                "Vip": "1.1.1.1",
                "VpcId": "vpc-ybs8ue2y",
                "Vport": 3306,
                "Zone": "ap-singapore-3"
            }
        ],
        "RequestId": "51169b54-61d4-4604-a07e-e519a5527923",
        "TotalCount": 31
    }
}

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

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud