1. 接口描述
接口请求域名： dtf.api3.fincloud.tencent.cn。
获取集群
默认接口请求频率限制：200次/秒。
接口更新时间：2023-04-19 16:51:16。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeClusters |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-05-06 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ClusterId | 否 | 否 | String | 集群id 示例值： |
| Offset | 否 | 否 | Int64 | 分页游标 示例值： |
| Limit | 否 | 否 | Int64 | 分页限制 示例值： |
| Namespace | 否 | 否 | String | 命名空间 示例值： |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | PagedCluster | 集群分页列表 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.GroupCreateFailed | 事务分组创建失败。 |
| AuthFailure | CAM签名/鉴权错误。 |
| ResourceInUse.GroupInUse | 事务分组%s协调器%s正在被使用，不可清理。 |
| UnknownParameter | 未知参数错误。 |
| InvalidParameterValue.DuplicateGroupName | 事务分组名称重复。 |
| FailedOperation.GroupClusterDeleteFailed | 事务分组-协调器集群关联关系删除失败。 |
| MissingParameter.GroupIdRequired | 事务分组ID称未填写。 |
| LimitExceeded | 超过配额限制。 |
| UnsupportedOperation | 操作不支持。 |
| FailedOperation.GroupQueryFailed | 事务分组查询失败。 |
| ResourceInUse | 资源被占用。 |
| FailedOperation.TransactionManagerGroupCountFailed | 协调器事务分组统计失败。 |
| InternalError | 内部错误。 |
5. 示例
示例1 示例1
输入示例
POST / HTTP/1.1
Host: oapi.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeClusters
<公共请求参数>
{
"Action": "DescribeClusters",
"AppId": 1,
"ClientIp": "182.140.153.175",
"Language": "zh-CN",
"OperatorUin": "130000000253",
"Region": "region-name",
"RequestId": "eff49217-7238-cd28-9078-1e6ac178f29b",
"RequestSource": "MC",
"SubAccountUin": "130000000253",
"Uin": "909619400",
"Version": "2020-05-06"
}
输出示例
{
"Response": {
"RequestId": "eff49217-7238-cd28-9078-1e6ac178f29b",
"Result": {
"Content": [
{
"ClusterId": "test",
"ClusterType": null,
"ComponentVersions": null,
"CreationTime": 1744270397,
"Creator": "test",
"Database": {
"Address": "192.168.51.69:3306",
"Password": null,
"User": "root"
},
"Description": null,
"GroupQuantity": 0,
"Namespace": "test-cq",
"Phase": "TADAppNotReady",
"ReadOnly": null,
"ScheduleParamStr": "{\"affinity\":null,\"creator\":null,\"database\":null,\"databaseType\":null,\"description\":null,\"manager\":null,\"nodeSelector\":null,\"readOnly\":null,\"region\":null,\"runtimeUser\":null,\"server\":null,\"solution\":null,\"tdsqlClusterIndex\":null,\"tolerations\":null}",
"Status": null,
"StorageMode": "mysql"
},
{
"ClusterId": "99-10",
"ClusterType": null,
"ComponentVersions": null,
"CreationTime": 1726715900,
"Creator": "seansshang",
"Database": null,
"Description": "ssssjjjj",
"GroupQuantity": 3,
"Namespace": "dts-mysql",
"Phase": "Ready",
"ReadOnly": false,
"ScheduleParamStr": "{\"affinity\":null,\"creator\":null,\"database\":null,\"databaseType\":null,\"description\":null,\"manager\":null,\"nodeSelector\":null,\"readOnly\":null,\"region\":null,\"runtimeUser\":null,\"server\":null,\"solution\":null,\"tdsqlClusterIndex\":null,\"tolerations\":null}",
"Status": null,
"StorageMode": "mysql"
},
{
"ClusterId": "88-99",
"ClusterType": null,
"ComponentVersions": null,
"CreationTime": 1726715874,
"Creator": "seansshang",
"Database": null,
"Description": "test UpdateCluster.",
"GroupQuantity": 0,
"Namespace": "dts-redis",
"Phase": "Ready",
"ReadOnly": false,
"ScheduleParamStr": "{\"affinity\":null,\"creator\":null,\"database\":null,\"databaseType\":null,\"description\":null,\"manager\":null,\"nodeSelector\":null,\"readOnly\":null,\"region\":null,\"runtimeUser\":null,\"server\":null,\"solution\":null,\"tdsqlClusterIndex\":null,\"tolerations\":null}",
"Status": null,
"StorageMode": "mysql"
},
{
"ClusterId": "default",
"ClusterType": null,
"ComponentVersions": null,
"CreationTime": 1724383775,
"Creator": "admin",
"Database": {
"Address": "10.29.0.144:24095,10.29.0.147:24095",
"Password": null,
"User": "yvonne"
},
"Description": "DTF default cluster",
"GroupQuantity": 17,
"Namespace": "default",
"Phase": "SubHealthy",
"ReadOnly": null,
"ScheduleParamStr": "{\"affinity\":null,\"creator\":null,\"database\":null,\"databaseType\":null,\"description\":null,\"manager\":null,\"nodeSelector\":null,\"readOnly\":null,\"region\":null,\"runtimeUser\":null,\"server\":null,\"solution\":null,\"tdsqlClusterIndex\":null,\"tolerations\":null}",
"Status": null,
"StorageMode": "mysql"
}
],
"TotalCount": 4
}
}
}