DescribeAccounts を呼び出してデータベースアカウントをクエリする - ClickHouse

指定された ApsaraDB for ClickHouse クラスターのデータベースアカウントについて説明します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

clickhouse:DescribeAccounts

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	cc-bp108z124a8o7****
AccountName	string	任意	データベースアカウント名。説明このパラメーターが指定されていない場合、操作はすべてのデータベースアカウントに関する情報を照会します。	testAccount
PageSize	integer	任意	各ページで返されるエントリ数。有効な値: 30 (デフォルト) 50 100	30
PageNumber	integer	任意	ページ番号。値は 0 より大きく、Integer データ型の最大値を超えない整数である必要があります。デフォルト値: 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

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。