1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
本接口(DescribeAccounts)用于查询数据库账号列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAccounts。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
| ClusterId | 是 | String | 集群ID 示例值：cynosdbmysql-on5xw0ni |
| AccountNames.N | 否 | Array of String | 需要过滤的账户列表 示例值：[admin] |
| DbType | 否 | String | 数据库类型，取值范围: 该参数已废用 示例值：MYSQL |
| Hosts.N | 否 | Array of String | 需要过滤的账户列表 示例值：[0.0.0.0] |
| Limit | 否 | Integer | 限制量 示例值：10 |
| Offset | 否 | Integer | 偏移量 示例值：0 |
| AccountRegular | 否 | String | 模糊匹配关键字(同时匹配AccountName和AccountHost，返回并集结果，支持正则) 示例值：“test" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AccountSet | Array of Account | 数据库账号列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 账号总数量 示例值：5 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询数据库账号列表
查询数据库账号列表
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccounts
<公共请求参数>
{
"ClusterId": "cynosdbysql-on5xw0ni"
}输出示例
{
"Response": {
"AccountSet": [
{
"AccountName": "abc",
"Description": "abc",
"CreateTime": "2020-09-22 00:00:00",
"UpdateTime": "2020-09-22 00:00:00",
"Host": "abc",
"MaxUserConnections": 0
}
],
"TotalCount": 0,
"RequestId": "abc"
}
}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.DatabaseAccessError | 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.OperationFailedError | 操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.SystemError | 系统内部错误。 |
| InvalidParameterValue.InstanceNotFound | 实例不存在。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
| OperationDenied.ServerlessInstanceStatusDenied | serverless实例当前状态不允许该操作。 |
| ResourceNotFound.ClusterNotFoundError | 集群不存在。 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |