Skip to content

Commit eca11ae

Browse files
Areo-JoeAreo-Joe
committed
chore: update api doc
1 parent 13755ad commit eca11ae

106 files changed

Lines changed: 7403 additions & 2750 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎config/.claude/skills/cloudbase-api-direct/references/1003-101559-TDSQL-C-MySQL-版-获取集群数据库列表_腾讯云.md‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
## 获取集群数据库列表
2+
3+
最近更新时间：2025-09-12 01:53:31
4+
5+
- 微信扫一扫
6+
- QQ
7+
- 新浪微博
8+
- 复制链接
9+
10+
链接复制成功
11+
12+
13+
_我的收藏_
14+
15+
## 1\. 接口描述
16+
17+
接口请求域名： cynosdb.tencentcloudapi.com 。
18+
19+
本接口（DescribeClusterDatabases）用于获取集群数据库列表。
20+
21+
默认接口请求频率限制：20次/秒。
22+
23+
推荐使用 API Explorer
24+
25+
[点击调试](https://console.cloud.tencent.com/api/explorer?Product=cynosdb&Version=2019-01-07&Action=DescribeClusterDatabases)
26+
27+
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
28+
29+
## 2\. 输入参数
30+
31+
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 [公共请求参数](/document/api/1003/48100) 。
32+
33+
| 参数名称 | 必选 | 类型 | 描述 |
34+
| --- | --- | --- | --- |
35+
| Action | 是 | String | [公共参数](/document/api/1003/48100) ，本接口取值：DescribeClusterDatabases。 |
36+
| Version | 是 | String | [公共参数](/document/api/1003/48100) ，本接口取值：2019-01-07。 |
37+
| Region | 是 | String | [公共参数](/document/api/1003/48100) ，详见产品支持的 [地域列表](/document/api/1003/48100#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) ，本接口仅支持其中的: 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 。 |
38+
| ClusterId | 是 | String | 集群id
39+
示例值：cynosdbmysql-ck8fmk11 |
40+
| Offset | 否 | Integer | 分页偏移
41+
示例值：0 |
42+
| Limit | 否 | Integer | 分页限制数量
43+
示例值：10 |
44+
45+
## 3\. 输出参数
46+
47+
| 参数名称 | 类型 | 描述 |
48+
| --- | --- | --- |
49+
| TotalCount | Integer | 总条数
50+
示例值：3 |
51+
| Offset | Integer | 分页偏移
52+
示例值：1 |
53+
| Databases | Array of String | 数据库列表
54+
示例值：\["database\_1","database\_2"\] |
55+
| Limit | Integer | 分页限制数
56+
示例值：20 |
57+
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
58+
59+
## 4\. 示例
60+
61+
### 示例1 获取集群数据库列表
62+
63+
#### 输入示例
64+
65+
```
66+
POST / HTTP/1.1
67+
Host: cynosdb.tencentcloudapi.com
68+
Content-Type: application/json
69+
X-TC-Action: DescribeClusterDatabases
70+
<公共请求参数>
71+
72+
{
73+
"ClusterId": "cynosdbmysql-tsjwe7iu"
74+
}
75+
```
76+
77+
#### 输出示例
78+
79+
```json
80+
{
81+
"Response": {
82+
"TotalCount": 3,
83+
"Limit": 20,
84+
"Offset": 0,
85+
"RequestId": "806fe1c8-5567-4aa8-a521-ea2414c793b4",
86+
"Databases": [
87+
"database_1",
88+
"database_2"
89+
]
90+
}
91+
}
92+
```
93+
94+
## 5\. 开发者资源
95+
96+
### 腾讯云 API 平台
97+
98+
[腾讯云 API 平台](https://cloud.tencent.com/api) 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
99+
100+
### API Inspector
101+
102+
用户可通过 [API Inspector](https://cloud.tencent.com/document/product/1278/49361) 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 [API Explorer](https://cloud.tencent.com/document/product/1278/46697) 进行在线调试。
103+
104+
### SDK
105+
106+
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
107+
108+
- Tencent Cloud SDK 3.0 for Python: [CNB](https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-python/-/blob/master/tencentcloud/cynosdb/v20190107/cynosdb_client.py), [GitHub](https://github.com/TencentCloud/tencentcloud-sdk-python/blob/master/tencentcloud/cynosdb/v20190107/cynosdb_client.py), [Gitee](https://gitee.com/TencentCloud/tencentcloud-sdk-python/blob/master/tencentcloud/cynosdb/v20190107/cynosdb_client.py)
109+
- Tencent Cloud SDK 3.0 for Java: [CNB](https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-java/-/blob/master/src/main/java/com/tencentcloudapi/cynosdb/v20190107/CynosdbClient.java), [GitHub](https://github.com/TencentCloud/tencentcloud-sdk-java/blob/master/src/main/java/com/tencentcloudapi/cynosdb/v20190107/CynosdbClient.java), [Gitee](https://gitee.com/TencentCloud/tencentcloud-sdk-java/blob/master/src/main/java/com/tencentcloudapi/cynosdb/v20190107/CynosdbClient.java)
110+
- Tencent Cloud SDK 3.0 for PHP: [CNB](https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-php/-/blob/master/src/TencentCloud/Cynosdb/V20190107/CynosdbClient.php), [GitHub](https://github.com/TencentCloud/tencentcloud-sdk-php/blob/master/src/TencentCloud/Cynosdb/V20190107/CynosdbClient.php), [Gitee](https://gitee.com/TencentCloud/tencentcloud-sdk-php/blob/master/src/TencentCloud/Cynosdb/V20190107/CynosdbClient.php)
111+
- Tencent Cloud SDK 3.0 for Go: [CNB](https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-go/-/blob/master/tencentcloud/cynosdb/v20190107/client.go), [GitHub](https://github.com/TencentCloud/tencentcloud-sdk-go/blob/master/tencentcloud/cynosdb/v20190107/client.go), [Gitee](https://gitee.com/TencentCloud/tencentcloud-sdk-go/blob/master/tencentcloud/cynosdb/v20190107/client.go)
112+
- Tencent Cloud SDK 3.0 for Node.js: [CNB](https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-nodejs/-/blob/master/src/services/cynosdb/v20190107/cynosdb_client.ts), [GitHub](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/services/cynosdb/v20190107/cynosdb_client.ts), [Gitee](https://gitee.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/services/cynosdb/v20190107/cynosdb_client.ts)
113+
- Tencent Cloud SDK 3.0 for.NET: [CNB](https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-dotnet/-/blob/master/TencentCloud/Cynosdb/V20190107/CynosdbClient.cs), [GitHub](https://github.com/TencentCloud/tencentcloud-sdk-dotnet/blob/master/TencentCloud/Cynosdb/V20190107/CynosdbClient.cs), [Gitee](https://gitee.com/TencentCloud/tencentcloud-sdk-dotnet/blob/master/TencentCloud/Cynosdb/V20190107/CynosdbClient.cs)
114+
- Tencent Cloud SDK 3.0 for C++: [CNB](https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-cpp/-/blob/master/cynosdb/src/v20190107/CynosdbClient.cpp), [GitHub](https://github.com/TencentCloud/tencentcloud-sdk-cpp/blob/master/cynosdb/src/v20190107/CynosdbClient.cpp), [Gitee](https://gitee.com/TencentCloud/tencentcloud-sdk-cpp/blob/master/cynosdb/src/v20190107/CynosdbClient.cpp)
115+
- Tencent Cloud SDK 3.0 for Ruby: [CNB](https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-ruby/-/blob/master/tencentcloud-sdk-cynosdb/lib/v20190107/client.rb), [GitHub](https://github.com/TencentCloud/tencentcloud-sdk-ruby/blob/master/tencentcloud-sdk-cynosdb/lib/v20190107/client.rb), [Gitee](https://gitee.com/TencentCloud/tencentcloud-sdk-ruby/blob/master/tencentcloud-sdk-cynosdb/lib/v20190107/client.rb)
116+
117+
### 命令行工具
118+
119+
- [Tencent Cloud CLI 3.0](https://cloud.tencent.com/document/product/440/6176)
120+
121+
## 6\. 错误码
122+
123+
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 [公共错误码](/document/api/1003/48104#.E5.85.AC.E5.85.B1.E9.94.99.E8.AF.AF.E7.A0.81) 。
124+
125+
| 错误码 | 描述 |
126+
| --- | --- |
127+
| FailedOperation.DatabaseAccessError | 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
128+
| FailedOperation.OperationFailedError | 操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
129+
| InternalError.DbOperationFailed | 查询数据库失败。 |
130+
| InternalError.GetSecurityGroupDetailFailed | 获取安全组信息失败。 |
131+
| InternalError.GetSubnetFailed | 获取子网失败。 |
132+
| InternalError.GetVpcFailed | 获取VPC失败。 |
133+
| InternalError.ListInstanceFailed | 安全组查询实例失败。 |
134+
| InternalError.OperateWanFail | 操作外网失败。 |
135+
| InternalError.OperationNotSupport | 操作不支持。 |
136+
| InternalError.QueryDatabaseFailed | 查询数据库失败。 |
137+
| InternalError.SystemError | 系统内部错误。 |
138+
| InvalidParameter.IsolateNotAllowed | 当前实例不可隔离。 |
139+
| InvalidParameterValue.AccountExist | 账号已存在。 |
140+
| InvalidParameterValue.DBTypeNotFound | 不支持的实例类型。 |
141+
| InvalidParameterValue.FlowNotFound | 任务流ID不存在。 |
142+
| InvalidParameterValue.IllegalInstanceName | 实例名称字符非法。 |
143+
| InvalidParameterValue.IllegalOrderBy | 无效的排序字段。 |
144+
| InvalidParameterValue.IllegalPassword | 密码不符合要求。 |
145+
| InvalidParameterValue.InstanceNotFound | 实例不存在。 |
146+
| InvalidParameterValue.InternalAccount | 内置账号不允许操作。 |
147+
| InvalidParameterValue.InvalidDBVersion | 实例版本非法。 |
148+
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
149+
| InvalidParameterValue.InvalidSpec | 实例规格非法。 |
150+
| InvalidParameterValue.ParamError | 参数错误。 |
151+
| InvalidParameterValue.RegionZoneUnavailable | 所选地域和可用区不可用。 |
152+
| InvalidParameterValue.StoragePoolNotFound | 未找到相关存储pool。 |
153+
| InvalidParameterValue.SubnetNotFound | 找不到所选子网。 |
154+
| InvalidParameterValue.VpcNotFound | 找不到所选VPC网络。 |
155+
| LimitExceeded.UserInstanceLimit | 用户实例个数超出限制。 |
156+
| OperationDenied.InstanceStatusLimitError | 实例未处于运行状态 |
157+
| ResourceNotFound.ClusterNotFoundError | 集群不存在。 |
158+
| ResourceUnavailable.InstanceLockFail | 锁定实例失败，暂时不可操作。 |
159+
| ResourceUnavailable.InstanceStatusAbnormal | 实例状态异常，暂时不可操作。 |
160+
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |
161+
162+
目录

0 commit comments

Comments
 (0)