1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
下载分析集群列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DownloadLibraDBClusterList。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: 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 | 否 | Integer | 限制数 示例值：0 |
| Offset | 否 | Integer | 偏移值 示例值：0 |
| OrderBy | 否 | String | 排序字段 示例值：cluster |
| OrderByType | 否 | String | 排序方式，desc,asc,DESC,ASC 示例值：desc |
| Filters.N | 否 | Array of QueryFilter | 过滤条件 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterSet | Array of LibraClusterSet | 分析集群信息 |
| TotalCount | Integer | 总数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 下载分析集群列表
查看 TDSQL-C分析集群列表
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DownloadLibraDBClusterList
<公共请求参数>
{
"Limit": 10,
"Offset": 0
}输出示例
{
"Response": {
"ClusterSet": [
{
"AppId": 1300274166,
"ClusterId": "libradb-80jv0tgn",
"ClusterName": "内核_1.2404.21.0_0",
"CreateTime": "",
"DbVersion": "1.2404.21.0",
"InstanceSet": [
{
"DbMode": "",
"InstanceCpu": 4,
"InstanceDeviceType": "Common",
"InstanceGroupId": "cynosdbmysql-grp-80f54u73",
"InstanceId": "libradb-ins-7d5sa2qi",
"InstanceMemory": 16,
"InstanceName": "libradb-ins-7d5sa2qi",
"InstancePayMode": 0,
"InstancePeriodEndTime": "0001-01-01 00:00:00 +0000 UTC",
"InstanceRole": "libradbRo",
"InstanceStatus": "running",
"InstanceStatusDesc": "运行中",
"InstanceStorage": 14,
"InstanceStorageType": "CLOUD_TCS",
"NetType": "libradbRo",
"UniqSubnetId": "subnet-558rhwt2",
"UniqVpcId": "vpc-nnakli31",
"Vip": "172.16.0.69",
"Vport": 3307,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"ProjectID": 0,
"Region": "ap-guangzhou",
"RenewFlag": 1,
"Status": "running",
"StatusDesc": "运行中",
"Storage": 14,
"UsedStorage": 0,
"Vip": "172.16.0.69",
"Vport": 3307
},
{
"AppId": 1300274166,
"ClusterId": "libradb-8gtc896t",
"ClusterName": "内核_1.2404.21.0_1",
"CreateTime": "",
"DbVersion": "1.2404.21.0",
"InstanceSet": [
{
"DbMode": "",
"InstanceCpu": 4,
"InstanceDeviceType": "Common",
"InstanceGroupId": "cynosdbmysql-grp-ed1anndp",
"InstanceId": "libradb-ins-ag7bj07o",
"InstanceMemory": 16,
"InstanceName": "libradb-ins-ag7bj07o",
"InstancePayMode": 0,
"InstancePeriodEndTime": "0001-01-01 00:00:00 +0000 UTC",
"InstanceRole": "libradbRo",
"InstanceStatus": "running",
"InstanceStatusDesc": "运行中",
"InstanceStorage": 14,
"InstanceStorageType": "CLOUD_TCS",
"NetType": "libradbRo",
"UniqSubnetId": "subnet-558rhwt2",
"UniqVpcId": "vpc-nnakli31",
"Vip": "172.16.0.68",
"Vport": 3307,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"ProjectID": 0,
"Region": "ap-guangzhou",
"RenewFlag": 1,
"Status": "running",
"StatusDesc": "运行中",
"Storage": 14,
"UsedStorage": 0,
"Vip": "172.16.0.68",
"Vport": 3307
},
{
"AppId": 1300274166,
"ClusterId": "libradb-i8okw971",
"ClusterName": "duckduckgogogo",
"CreateTime": "",
"DbVersion": "1.2404.21.0",
"InstanceSet": [
{
"DbMode": "",
"InstanceCpu": 4,
"InstanceDeviceType": "Common",
"InstanceGroupId": "cynosdbmysql-grp-3y4xkenx",
"InstanceId": "libradb-ins-6231eq34",
"InstanceMemory": 16,
"InstanceName": "libradb-ins-6231eq34",
"InstancePayMode": 0,
"InstancePeriodEndTime": "0001-01-01 00:00:00 +0000 UTC",
"InstanceRole": "libradbRo",
"InstanceStatus": "running",
"InstanceStatusDesc": "运行中",
"InstanceStorage": 20,
"InstanceStorageType": "CLOUD_TCS",
"NetType": "libradbRo",
"UniqSubnetId": "subnet-558rhwt2",
"UniqVpcId": "vpc-nnakli31",
"Vip": "172.16.0.67",
"Vport": 3306,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"ProjectID": 0,
"Region": "ap-guangzhou",
"RenewFlag": 0,
"Status": "running",
"StatusDesc": "运行中",
"Storage": 20,
"UsedStorage": 0,
"Vip": "172.16.0.67",
"Vport": 3306
},
{
"AppId": 1300274166,
"ClusterId": "libradb-lr1andl9",
"ClusterName": "_202504221150",
"CreateTime": "",
"DbVersion": "1.2404.21.0",
"InstanceSet": [
{
"DbMode": "",
"InstanceCpu": 4,
"InstanceDeviceType": "Common",
"InstanceGroupId": "cynosdbmysql-grp-k38ncwfx",
"InstanceId": "libradb-ins-bivqnt26",
"InstanceMemory": 16,
"InstanceName": "libradb-ins-bivqnt26",
"InstancePayMode": 0,
"InstancePeriodEndTime": "0001-01-01 00:00:00 +0000 UTC",
"InstanceRole": "libradbRo",
"InstanceStatus": "running",
"InstanceStatusDesc": "运行中",
"InstanceStorage": 20,
"InstanceStorageType": "CLOUD_TCS",
"NetType": "libradbRo",
"UniqSubnetId": "subnet-558rhwt2",
"UniqVpcId": "vpc-nnakli31",
"Vip": "172.16.0.64",
"Vport": 3306,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"ProjectID": 0,
"Region": "ap-guangzhou",
"RenewFlag": 0,
"Status": "running",
"StatusDesc": "运行中",
"Storage": 20,
"UsedStorage": 0,
"Vip": "172.16.0.64",
"Vport": 3306
},
{
"AppId": 1300274166,
"ClusterId": "libradb-bqywwgqp",
"ClusterName": "libradb-bqywwgqp",
"CreateTime": "",
"DbVersion": "1.2404.21.0",
"InstanceSet": [
{
"DbMode": "",
"InstanceCpu": 4,
"InstanceDeviceType": "Common",
"InstanceGroupId": "cynosdbmysql-grp-20dug0z7",
"InstanceId": "libradb-ins-698y8oya",
"InstanceMemory": 16,
"InstanceName": "libradb-ins-698y8oya",
"InstancePayMode": 0,
"InstancePeriodEndTime": "0001-01-01 00:00:00 +0000 UTC",
"InstanceRole": "libradbRo",
"InstanceStatus": "creating",
"InstanceStatusDesc": "创建中",
"InstanceStorage": 20,
"InstanceStorageType": "CLOUD_TCS",
"NetType": "libradbRo",
"UniqSubnetId": "subnet-558rhwt2",
"UniqVpcId": "vpc-nnakli31",
"Vip": "172.16.0.63",
"Vport": 3306,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"ProjectID": 0,
"Region": "ap-guangzhou",
"RenewFlag": 0,
"Status": "creating",
"StatusDesc": "创建中",
"Storage": 20,
"UsedStorage": 0,
"Vip": "172.16.0.63",
"Vport": 3306
},
{
"AppId": 1300274166,
"ClusterId": "libradb-7dm4j9tx",
"ClusterName": "edison_libra_cluster_0",
"CreateTime": "",
"DbVersion": "1.2404.21.0",
"InstanceSet": [
{
"DbMode": "",
"InstanceCpu": 4,
"InstanceDeviceType": "Common",
"InstanceGroupId": "cynosdbmysql-grp-3g3loqbh",
"InstanceId": "libradb-ins-g0qln86o",
"InstanceMemory": 16,
"InstanceName": "libradb-ins-g0qln86o",
"InstancePayMode": 0,
"InstancePeriodEndTime": "0001-01-01 00:00:00 +0000 UTC",
"InstanceRole": "libradbRo",
"InstanceStatus": "creating",
"InstanceStatusDesc": "创建中",
"InstanceStorage": 13,
"InstanceStorageType": "CLOUD_TCS",
"NetType": "libradbRo",
"UniqSubnetId": "subnet-558rhwt2",
"UniqVpcId": "vpc-nnakli31",
"Vip": "172.16.0.61",
"Vport": 3307,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"ProjectID": 0,
"Region": "ap-guangzhou",
"RenewFlag": 1,
"Status": "creating",
"StatusDesc": "创建中",
"Storage": 13,
"UsedStorage": 0,
"Vip": "172.16.0.61",
"Vport": 3307
},
{
"AppId": 1300274166,
"ClusterId": "libradb-hgl460lr",
"ClusterName": "edison_libra_cluster_1",
"CreateTime": "",
"DbVersion": "1.2404.21.0",
"InstanceSet": [
{
"DbMode": "",
"InstanceCpu": 4,
"InstanceDeviceType": "Common",
"InstanceGroupId": "cynosdbmysql-grp-6kvf8jav",
"InstanceId": "libradb-ins-f0wqweae",
"InstanceMemory": 16,
"InstanceName": "libradb-ins-f0wqweae",
"InstancePayMode": 0,
"InstancePeriodEndTime": "0001-01-01 00:00:00 +0000 UTC",
"InstanceRole": "libradbRo",
"InstanceStatus": "creating",
"InstanceStatusDesc": "创建中",
"InstanceStorage": 13,
"InstanceStorageType": "CLOUD_TCS",
"NetType": "libradbRo",
"UniqSubnetId": "subnet-558rhwt2",
"UniqVpcId": "vpc-nnakli31",
"Vip": "172.16.0.62",
"Vport": 3307,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"ProjectID": 0,
"Region": "ap-guangzhou",
"RenewFlag": 1,
"Status": "creating",
"StatusDesc": "创建中",
"Storage": 13,
"UsedStorage": 0,
"Vip": "172.16.0.62",
"Vport": 3307
},
{
"AppId": 1300274166,
"ClusterId": "libradb-7drs3ypz",
"ClusterName": "_202504221150",
"CreateTime": "",
"DbVersion": "1.2404.21.0",
"InstanceSet": [
{
"DbMode": "",
"InstanceCpu": 4,
"InstanceDeviceType": "Common",
"InstanceGroupId": "cynosdbmysql-grp-gxjduamv",
"InstanceId": "libradb-ins-432ihin0",
"InstanceMemory": 16,
"InstanceName": "libradb-ins-432ihin0",
"InstancePayMode": 0,
"InstancePeriodEndTime": "0001-01-01 00:00:00 +0000 UTC",
"InstanceRole": "libradbRo",
"InstanceStatus": "creating",
"InstanceStatusDesc": "创建中",
"InstanceStorage": 20,
"InstanceStorageType": "CLOUD_TCS",
"NetType": "libradbRo",
"UniqSubnetId": "subnet-558rhwt2",
"UniqVpcId": "vpc-nnakli31",
"Vip": "172.16.0.60",
"Vport": 3306,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"ProjectID": 0,
"Region": "ap-guangzhou",
"RenewFlag": 0,
"Status": "creating",
"StatusDesc": "创建中",
"Storage": 20,
"UsedStorage": 0,
"Vip": "172.16.0.60",
"Vport": 3306
}
],
"RequestId": "66b0f00c-d5bf-48b0-a0de-f76566e3ca31",
"TotalCount": 22
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, 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鉴权不通过。 |
