DescribeAccounts - 查询账号信息

更新时间:

查询AnalyticDB PostgreSQL版数据库的账号信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeAccountsget
*DBInstance
acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp***************
AccountNamestring

数据库账号的名称。

testuser
AccountTypestring

默认值为 Super,此时查询高权限账号。当参数为 Normal 时,此时查询普通权限账号。当参数为 All 时,此时查询所有账号信息。

Super

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

7565770E-7C45-462D-BA4A-8A5396F2CAD1
Accountsarray<object>

数据库账号的信息。

DBInstanceAccountobject
AccountStatusstring

数据库账号的状态,取值说明:

  • 0:创建中。
  • 1:使用中。
  • 3:删除中。
1
AccountDescriptionstring

数据库账号的描述。

testuser
DBInstanceIdstring

实例 ID。

gp-bp***************
AccountNamestring

数据库账号的名称。

testuser
AccountTypestring

账号类型,取值为 Super 或 Normal。Super 表示高权限账号,Normal 表示普通权限账号。

Super

示例

正常返回示例

JSON格式

{
  "RequestId": "7565770E-7C45-462D-BA4A-8A5396F2CAD1",
  "Accounts": {
    "DBInstanceAccount": [
      {
        "AccountStatus": "1",
        "AccountDescription": "testuser",
        "DBInstanceId": "gp-bp***************",
        "AccountName": "testuser",
        "AccountType": "Super\n"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-08-20OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情