获取实例用户列表

最近更新时间:2018-09-18 17:03:21

1. 接口描述

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

本接口(DescribeAccounts)用于获取实例用户列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAccounts
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DBInstanceId String 实例ID,形如postgres-6fego161
Limit Integer 分页返回,每页最大返回数目,默认20,取值范围为1-100
Offset Integer 分页返回,返回第几页的用户数据。页码从0开始计数
OrderBy String 返回数据按照创建时间或者用户名排序。取值只能为createTime或者name。createTime-按照创建时间排序;name-按照用户名排序
OrderByType String 返回结果是升序还是降序。取值只能为desc或者asc。desc-降序;asc-升序

3. 输出参数

参数名称 类型 描述
TotalCount Integer 本次调用接口共返回了多少条数据。
Details Array of AccountInfo 帐号列表详细信息。
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 获取实例postgres-apzvwncr的用户列表

输入示例

https://postgres.tencentcloudapi.com/?Action=DescribeAccounts
&DBInstanceId=postgres-apzvwncr
&<公共请求参数>

输出示例

{
  "Response": {
    "Details": [
      {
        "CreateTime": "2018-06-12 17:21:54",
        "DBInstanceId": "postgres-apzvwncr",
        "Remark": "(测试)这个账户是无效的",
        "Status": 2,
        "UpdateTime": "2018-06-12 17:21:57",
        "UserName": "root"
      }
    ],
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
    "TotalCount": 1
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.SystemError 系统错误。出现这种错误时,请联系客服支持。
InvalidParameter 输入参数错误。
InvalidParameterValue.InstanceNotExist 当前实例不存在。