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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAccounts

系统规定参数。取值:DescribeAccounts

DBClusterId String cc-bp108z124a8o7****

集群ID。

AccountName String test

数据库账号。

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

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
PageNumber Integer 1

页数。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

总记录数。

PageSize Integer 30

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
RequestId String F5178C10-1407-4987-9133-DE4DC9119F75

请求ID。

PageNumber Integer 1

页数。

Accounts Array of Account

数据库账号列表。

Account
AccountStatus String Creating

数据库账号状态,取值:

  • Creating:创建中。
  • Available:可用。
  • Deleting:删除中。
AccountDescription String test

数据库账号描述。

AccountType String Super

数据库账号类型,取值:

  • Normal:普通账号。
  • Super:高权限账号。
AccountName String test

数据库账号。

示例

请求示例

http(s)://clickhouse.aliyuncs.com/?Action=DescribeAccounts
&DBClusterId=cc-bp108z124a8o7****
&AccountName=test
&PageSize=30
&PageNumber=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAccountsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PageNumber>1</PageNumber>
    <Accounts>
        <Account>
            <AccountStatus>Creating</AccountStatus>
            <AccountDescription>test</AccountDescription>
            <AccountType>Super</AccountType>
            <AccountName>test</AccountName>
        </Account>
    </Accounts>
</DescribeAccountsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

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