1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
本接口（DescribeClusters）用于查询集群列表。
默认接口请求频率限制：1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusters。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: 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 。 |
| DbType | 否 | String | 引擎类型：目前支持“MYSQL”， “POSTGRESQL” 示例值：MYSQL |
| Limit | 否 | Integer | 返回数量，默认为 20，最大值为 100 示例值：20 |
| Offset | 否 | Integer | 记录偏移量，默认值为0 示例值：0 |
| OrderBy | 否 | String | 排序字段，取值范围： 示例值："CREATETIME" |
| OrderByType | 否 | String | 排序类型，取值范围： 示例值："DESC" |
| Filters.N | 否 | Array of QueryFilter | 搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 集群数 示例值：3 |
| ClusterSet | Array of CynosdbCluster | 集群列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群列表
查询集群列表
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusters
<公共请求参数>
{
"DbType": "MYSQL",
"Limit": 20,
"Filters": [
{
"Values": [
"cynosdbpg-ins-bzkxxrmt"
],
"Names": [
"InstanceId"
],
"ExactMatch": "true"
}
],
"Offset": 0
}输出示例
{
"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": "运营产品",
"TagValue": "腾讯云计费产品其它_1649"
},
{
"TagKey": "运营部门",
"TagValue": "计费产品中心_1013"
},
{
"TagKey": "一级业务",
"TagValue": "[N][腾讯云计费产品其它]_979685"
},
{
"TagKey": "二级业务",
"TagValue": "[license管理][license数据引擎]123"
}
],
"ServerlessStatus": "paused",
"SlaveZones": [
"ap-singapore-4"
],
"Status": "running",
"StatusDesc": "运行中",
"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. 开发者资源
腾讯云 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CamCheckResourceError | 获取权限失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.DatabaseAccessError | 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.InternalHttpServerError | http请求执行异常。 |
| InternalError.SystemError | 系统内部错误。 |
| InternalError.UnknownError | 未知的内部错误。 |
| InvalidParameterValue.IllegalOrderBy | 无效的排序字段。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
| InvalidParameterValue.ParamBothSetError | 该两个参数不可以同时设定。 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |
