1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
本接口(DescribeAccounts)用于查询云数据库的所有账户信息。
默认接口请求频率限制:50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAccounts。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。 示例值:cdb-f35wr6wj |
Offset | 否 | Integer | 记录偏移量,默认值为0。 示例值:0 |
Limit | 否 | Integer | 单次请求返回的数量,默认值为20,最小值为1,最大值为100。 示例值:1 |
AccountRegexp | 否 | String | 匹配账号名的正则表达式,规则同 MySQL 官网。 示例值:"" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合查询条件的账号数量。 示例值:2 |
Items | Array of AccountInfo | 符合查询条件的账号详细信息。 |
MaxUserConnections | Integer | 用户可设置实例最大连接数。 示例值:10240 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询云数据库的所有账号信息
输入示例
https://cdb.tencentcloudapi.com/?Action=DescribeAccounts
&InstanceId=cdb-f35wr6wj
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2,
"MaxUserConnections": 10240,
"Items": [
{
"Notes": "test",
"Host": "localhost",
"User": "test_user",
"ModifyTime": "2020-11-10 01:00:00",
"ModifyPasswordTime": "2020-11-10 01:00:00",
"CreateTime": "2020-11-10 01:00:00",
"MaxUserConnections": 20
},
{
"Notes": "test2",
"Host": "localhost",
"User": "root",
"ModifyTime": "2020-11-10 01:00:00",
"ModifyPasswordTime": "2020-11-10 01:00:00",
"CreateTime": "2020-11-10 01:00:00",
"MaxUserConnections": 20
}
]
}
}
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.CreateAccountError | 创建失败,请检查用户是否已存在。 |
FailedOperation.DBOperationActionError | 数据库操作失败。 |
FailedOperation.GetPrivilegeError | 获取权限错误。 |
FailedOperation.InstanceQueryError | 查询失败。 |
FailedOperation.PrivilegeDataIllegal | 执行的权限修改操作非法。您可以参照产品文档,了解当前实例支持哪些权限修改操作,如有疑问,请您咨询客服进行处理。 |
FailedOperation.ResponseValueError | 后台请求服务异常,请您联系客服解决。 |
FailedOperation.StartFlowError | 操作发起失败,请稍后重试。如果操作持续不成功,请您联系客服进行处理。 |
FailedOperation.SubmitAsyncTaskError | 提交任务失败,请稍后重试。如果持续提交失败,请您联系客服进行处理。 |
InternalError.CdbError | 系统错误。 |
InternalError.HttpError | Http请求异常。 |
InternalError.InternalAssertError | 内部服务异常,请您联系客服进行处理。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InternalError.InternalRequestError | 后台请求服务失败,请稍后重试。 |
InternalError.RegexpCompileError | 正则表达式编译错误。 |
InternalError.UndefinedError | 未知错误。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ControllerNotFoundError | 未找到该接口。 |
InvalidParameter.InstanceNotFound | 实例不存在。 |
InvalidParameterValue.AccountDescriptionCharacterError | 账号描述信息包含特殊字符。 |
InvalidParameterValue.AccountDescriptionLengthError | 账号描述信息长度超过255个字符。 |
InvalidParameterValue.AccountHostRuleError | 账号主机参数规则错误。 |
InvalidParameterValue.AccountPasswordCharacterError | 账号密码中包含无效的字符。 |
InvalidParameterValue.AccountPasswordLengthError | 账号密码不符合长度。 |
InvalidParameterValue.AccountPasswordRuleError | 密码规则错误,至少包含字母、数字和字符(_+-&=!@#$%^*())中的两种,长度为8-64个字符。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
InvalidParameterValue.UserNameRuleError | 账号用户名规则错误。 |
InvalidParameterValue.UserNotExistError | 账号信息不存在。 |
InvalidParameterValue.VerifyAccountNoRootError | 未找到root账号信息。 |
InvalidParameterValue.VerifyAccountPasswordError | 账号密码无效。 |
InvalidParameterValue.VerifyAccountPrivError | 账号无GRANT权限。 |
MissingParameter.AccountMissingParameterError | 缺失账号相关参数。 |
OperationDenied.DeleteRootAccountError | root账号禁止被删除。 |
OperationDenied.InstTypeNotSupport | 当前类型实例不支持该操作。 |
OperationDenied.NotSupportModifyLocalRootHostError | 不支持修改本地root账号host信息。 |
OperationDenied.OperationDeniedError | 操作拒绝。 |
ResourceNotFound.CdbInstanceNotFoundError | 未找到数据库实例,请确认您的实例状态是否正常。 |
ResourceNotFound.InstanceNotFundError | 该实例不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.PrivilegesUnsupportedError | 权限不支持。 |