查询账号列表

最近更新时间:2018-09-28 14:59:55

1. 接口描述

接口请求域名: dcdb.tencentcloudapi.com 。

本接口(DescribeAccounts)用于查询指定云数据库实例的账号列表。

默认接口请求频率限制:20次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:dcdb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAccounts
Version String 公共参数,本接口取值:2018-04-11
Region String 公共参数,详见产品支持的地域列表
InstanceId String 实例ID,形如:dcdbt-ow728lmc。

3. 输出参数

参数名称 类型 描述
InstanceId String 实例ID,透传入参。
Users Array of DBAccount 实例用户列表。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 查询云数据库账号列表

输入示例

https://dcdb.tencentcloudapi.com/?Action=DescribeAccounts
&InstanceId=dcdbt-fdpjf5zh
&<公共请求参数>

输出示例

{
  "Response": {
    "InstanceId": "dcdbt-fdpjf5zh",
    "RequestId": "1e74e824-6d2b-495d-b347-5250cdf8e964",
    "Users": [
      {
        "CreateTime": "2016-07-15 18:39:47",
        "DelayThresh": 0,
        "Description": "测试帐号",
        "Host": "172.17.%",
        "ReadOnly": 0,
        "UpdateTime": "2016-07-18 12:42:31",
        "UserName": "testuser1"
      },
      {
        "CreateTime": "2016-07-18 11:51:33",
        "DelayThresh": 0,
        "Description": "测试帐号",
        "Host": "%",
        "ReadOnly": 0,
        "UpdateTime": "2016-07-18 12:42:44",
        "UserName": "testuser2"
      }
    ]
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError.CamAuthFailed CAM鉴权请求失败。
InternalError.DbOperationFailed 查询数据库失败。
InternalError.GetUserListFailed 获取账号列表失败。
InvalidParameter.GenericParameterError 参数合法性校验错误。
ResourceUnavailable.InstanceAlreadyDeleted 数据库实例已被删除。
ResourceUnavailable.InstanceStatusAbnormal 数据库实例状态不正确,当前无法操作。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。