DescribeAccounts - 查询账号列表_云数据库 ClickHouse(ClickHouse)-阿里云帮助中心

调用DescribeAccounts接口查询指定云数据库ClickHouse集群的数据库账号列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:DescribeAccounts	list	EnterpriseDBCluster acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
DBInstanceId	string	是	集群 ID。	cc-bp100p4q1g9z3****
PageNumber	string	否	页数。	1
PageSize	string	否	每页记录数，取值： 30（默认值） 50 100	30
Product	string	否	产品 code。	clickhouse

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
Data	object	返回结果。
TotalCount	integer	总记录数。	1
PageNumber	integer	页数。	1
PageSize	integer	每页记录数，取值： 30（默认值） 50 100	30
Accounts	array<object>	账号列表。
Account	object
Account	string	数据库账号。	test
Description	string	备注信息。	测试使用
AccountType	string	数据库账号的类型，取值说明： NormalAccount：普通账号。 SuperAccount：高权限账号。	NormalAccount
Status	string	账号状态。取值说明： 0：创建中。 1：使用中。 3：删除中。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "Data": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 30,
    "Accounts": [
      {
        "Account": "test",
        "Description": "测试使用",
        "AccountType": "NormalAccount",
        "Status": "1"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.

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

变更历史

变更时间	变更内容概要	操作
2024-05-13	OpenAPI 错误码发生变更	查看变更详情