云数据库 PostgreSQL 查询实例的数据库账号列表-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（DescribeAccounts）用于查询实例的数据库账号列表。

默认接口请求频率限制：1000次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	本次调用接口共返回了多少条数据。示例值：1
Details	Array of AccountInfo	账号列表详细信息。当CreateTime项为0000-00-00 00:00:00时，意味着对应账号是直连数据库创建的，并非通过CreateAccount接口创建。示例值：[{"CreateTime":"0000-00-00 00:00:00","DBInstanceId":"postgres-hpe52jnz","Remark":"","Status":2,"UpdateTime":"2024-06-06 21:00:12","UserName":"test","UserType":"tencentDBSuper"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取实例postgres-hpe52jnz的账户列表

获取实例postgres-hpe52jnz的账户列表

输入示例

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAccounts
<公共请求参数>

{
    "DBInstanceId": "postgres-hpe52jnz"
}

输出示例

{
    "Response": {
        "Details": [
            {
                "CreateTime": "0000-00-00 00:00:00",
                "DBInstanceId": "postgres-hpe52jnz",
                "Remark": "",
                "Status": 2,
                "UpdateTime": "2024-06-06 21:00:12",
                "UserName": "test",
                "UserType": "tencentDBSuper"
            }
        ],
        "RequestId": "1299fe3a-9958-440a-bfd0-e4eb1e71b7eb",
        "TotalCount": 1
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure.UnauthorizedOperation	鉴权失败。
DBError	后台DB执行错误。
FailedOperation.CamSigAndAuthError	鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.DatabaseAccessError	管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.DatabaseAffectedError	数据操作失败，请联系客服进行处理。
FailedOperation.FailedOperationError	操作失败，请稍后重试。
FailedOperation.PreCheckError	操作预检查失败。
InternalError.DBError	后台DB执行错误。
InternalError.InternalHttpServerError	请求执行异常。
InternalError.SystemError	系统错误。出现这种错误时，请联系客服支持。
InvalidParameter.ParameterCheckError	参数检查失败。
InvalidParameterValue.AccountNotExist	当前账号不存在。
InvalidParameterValue.InstanceNotExist	当前实例不存在。
InvalidParameterValue.InvalidParameterValueError	参数值有误。
InvalidParameterValue.ParameterHandleError	参数处理失败，请检参数值设置是否有效。
OperationDenied.CamDeniedError	当前操作被限制。
ResourceNotFound.InstanceNotFoundError	实例不存在。

查询实例的数据库账号列表

本页目录：