DescribeAccounts - 查询数据库账号 - 云原生数据仓库AnalyticDB

查询集群的数据库账号。

接口说明

当前服务的接入地址请参见服务接入点。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

adb:DescribeAccounts

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	湖仓版集群 ID。	amv-bp11q28kvl688****
AccountName	string	否	数据库账号。说明此参数不填写时，默认返回所有数据库账号信息。	test_accout
Engine	string	否	数据库引擎，取值： AnalyticDB（默认）：AnalyticDB MySQL 引擎 Clickhouse：宽表引擎	Clickhouse

返回参数

名称	类型	描述	示例值
	object	数据库账号列表。
RequestId	string	请求 ID。	9CCFAAB4-97B7-5800-B9F2-685EB596E3EF
AccountList	object
DBAccount	array<object>	数据库账号列表。
	array<object>	详细信息。
AccountName	string	数据库账号。	test_accout
AccountStatus	string	账号状态。取值说明： Creating：创建中。 Available：可用。 Deleting：删除中。	Available
AccountDescription	string	账号描述。	测试数据库账号
RamUsers	string	RAM 用户的账号 ID。	1958134230****
AccountType	string	账号类型，取值说明： Normal：普通账号。 Super：高权限账号。	Normal
Engine	string	数据库引擎，取值： AnalyticDB：AnalyticDB MySQL 引擎。 Clickhouse：宽表引擎。	Clickhouse
RamUserList	object
RamUserList	array	绑定的阿里云 RAM 用户 ID 列表。
	string	绑定的阿里云 RAM 用户 ID 。	20732900249392****

示例

正常返回示例

JSON格式

{
  "RequestId": "9CCFAAB4-97B7-5800-B9F2-685EB596E3EF",
  "AccountList": {
    "DBAccount": [
      {
        "AccountName": "test_accout",
        "AccountStatus": "Available",
        "AccountDescription": "测试数据库账号",
        "RamUsers": "1958134230****",
        "AccountType": "Normal",
        "Engine": "Clickhouse",
        "RamUserList": {
          "RamUserList": [
            "20732900249392****"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	DBClusterId参数不正确，请确认参数是否符合规范。
400	ACS.Sql.CannotConnect	Cannot connect instance which type is %s.	无法连接到给定类型的子实例。

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

变更历史

更多信息，参考变更详情。