1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
本接口(DescribeMySQLClusterDetail)查询Mysql集群信息。
调用该接口前需要先查询Mysql是否开通,可通过 DescribeCreateMySQLResult 查询,只有已开通的才能查到集群信息,Mysql开通成功后,可通过接口设置数据库账号相关功能包括但不限于【创建账号、删除账号、查询可授权权限列表、查询账号已有权限、修改主机、修改配置、修改账号库表权限】、集群操作相关【查询集群参数、修改集群参数】,连接设置相关【关闭外网、开通外网、查询集群信息】,备份回档相关【创建手动回档、删除手动回档、修改自动备份配置信息、查询备份文件列表、集群回档、查询任务列表、获取table列表、获取集群数据库列表、查询备份下载地址】,相关功能接口文档:TDSQL-C MySQL API文档,可以通过 RunSql 接口来执行 MySql 命令,比如创建表格、插入数据、删除表格等 MySql 命令。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeMySQLClusterDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 云开发环境ID 示例值:***p**-8g1j2dbc0df14561 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | MySQLClusterDetail | 集群详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeMySQLClusterDetail
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMySQLClusterDetail
<公共请求参数>
{
"EnvId": "*******p**-8g1j2dbc0df14561"
}
输出示例
{
"Response": {
"Data": {
"DbClusterId": "cynos*******-6gian***",
"DbInfo": {
"ClusterStatus": "running",
"DbType": "MYSQL",
"DbVersion": "5.7",
"IsOpenPubNetAccess": false,
"MaxCpu": 0.5,
"MinCpu": 0.25,
"ServerlessStatus": "pause",
"Status": "running",
"StorageLimit": 100000,
"UsedStorage": 21000000,
"WanStatus": "init"
},
"NetInfo": {
"Net": "vpc-py8*****/subnet-68*****p",
"PrivateNetAddress": "10*******3:3306",
"PubNetAddress": "",
"SubnetId": "subnet-68****d*",
"SubnetName": "cloudbase_run_tdsqlc_subnet",
"VpcId": "vpc-py******",
"VpcName": "tcb_pre-**l*f*s**r*******q098a0434e"
}
},
"RequestId": "72b253f4-a578-4940-8d99-cb417f26e286"
}
}
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.DataSourceNotExist | 数据不存在 |