文档

DescribeAccounts - 查询账号信息

更新时间:

查询指定云数据库ClickHouse集群的数据库账号信息。

调试

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

授权信息

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

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

请求参数

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

集群 ID。

cc-bp108z124a8o7****
AccountNamestring

数据库账号的名称。

说明 如果不配置该参数,默认查询所有数据库账号的信息。
test
PageSizeinteger

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberinteger

页数,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1

1

返回参数

名称类型描述示例值
object
TotalCountinteger

总记录数。

1
PageSizeinteger

每页记录数。

30
RequestIdstring

请求 ID。

F5178C10-1407-4987-9133-DE4DC9119F75
PageNumberinteger

页数。

1
Accountsobject []

数据库账号列表。

AccountStatusstring

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

  • Creating:创建中。

  • Available:可用。

  • AuthorityModifying: 权限变更中。

  • Deleting:删除中。

说明 仅 XML 配置方式的数据账号才会有 AuthorityModifying 状态。
Creating
AccountDescriptionstring

数据库账号的描述。

test
AccountTypestring

数据库账号的类型,取值说明:

  • Super:高权限账号。
  • Normal:普通账号。
Super
AccountNamestring

数据库账号的名称。

test
ConfigTypestring

数据库账号的配置方式。

SQL

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": 1,
  "Accounts": {
    "Account": [
      {
        "AccountStatus": "Creating",
        "AccountDescription": "test",
        "AccountType": "Super",
        "AccountName": "test",
        "ConfigType": "SQL"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
2022-11-25OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈