通過DescribeAccounts API查詢資料庫帳號資訊-雲資料庫 ClickHouse-阿里雲

查詢指定雲資料庫ClickHouse叢集的資料庫帳號資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:DescribeAccounts

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。	cc-bp108z124a8o7****
AccountName	string	否	資料庫帳號的名稱。說明如果不配置該參數，預設查詢所有資料庫帳號的資訊。	testAccount
PageSize	integer	否	每頁記錄數，取值如下： 30（預設值） 50 100	30
PageNumber	integer	否	頁數，取值為大於 0 且不超過整數資料類型的最大值。預設值為 1。	1

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	總記錄數。	1
PageSize	integer	每頁記錄數。	30
RequestId	string	請求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	integer	頁數。	1
Accounts	object
Account	array<object>	資料庫帳號列表。
	object
AccountStatus	string	資料庫帳號的狀態，取值說明： Creating：建立中。 Available：可用。 AuthorityModifying：許可權變更中。 Deleting：刪除中。說明僅 XML 配置方式的資料帳號才會有 AuthorityModifying 狀態。	Creating
AccountDescription	string	資料庫帳號的描述。	test
AccountType	string	資料庫帳號的類型，取值說明： Super：高許可權帳號。 Normal：普通帳號。	Super
AccountName	string	資料庫帳號的名稱。	test
ConfigType	string	資料庫帳號的配置方式。	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	錯誤碼	錯誤資訊	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。