DescribeAccounts - - Alibaba Cloud ドキュメントセンター

PolarDB クラスターのデータベースアカウントに関する情報をクエリします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeAccounts

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-***************
AccountName	string	任意	アカウント名。	test_acc
NodeType	string	任意	ノードタイプ。PolarDB 検索ノードアカウントをクエリする場合に必要です。 Search	Search
PageNumber	integer	任意	返されるページのページ番号。値は 0 より大きい整数である必要があります。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりに返されるエントリ数。有効な値： 30 50 100 デフォルト値は 30 です。	30

レスポンスフィールド

フィールド	型	説明	例
	object
PageRecordCount	integer	1 ページあたりに返されるエントリ数。	1
RequestId	string	リクエスト ID。	155462B9-205F-4FFC-BB43-4855FE******
PageNumber	integer	ページ番号。ページは 1 から始まります。	1
Accounts	array<object>	アカウントの詳細。
	array<object>
AccountDescription	string	データベースアカウントの説明。	test
AccountStatus	string	データベースアカウントのステータス。有効な値： Creating：アカウントは作成中です。 Available：アカウントは利用可能です。 Deleting：アカウントは削除中です。	Available
AccountLockState	string	アカウントのロックステータス。有効な値： UnLock：アカウントはロックされていません。 Lock：アカウントはロックされています。	UnLock
AccountPasswordValidTime	string	パスワードの有効期間。	undefined
AccountType	string	アカウントのタイプ。有効な値： Normal：標準アカウント。 Super：特権アカウント。 ReadOnly：グローバル読み取り専用アカウント。	Normal
DatabasePrivileges	array<object>	アカウントに付与されているデータベース権限のリスト。
	object
AccountPrivilege	string	アカウントの権限。	ReadOnly
DBName	string	データベース名。	DBtest
AccountName	string	データベースアカウントの名前。	test_acc

例

成功レスポンス

JSONJSON

{
  "PageRecordCount": 1,
  "RequestId": "155462B9-205F-4FFC-BB43-4855FE******",
  "PageNumber": 1,
  "Accounts": [
    {
      "AccountDescription": "test",
      "AccountStatus": "Available",
      "AccountLockState": "UnLock",
      "AccountPasswordValidTime": "undefined",
      "AccountType": "Normal",
      "DatabasePrivileges": [
        {
          "AccountPrivilege": "ReadOnly",
          "DBName": "DBtest"
        }
      ],
      "AccountName": "test_acc"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist
400	Account.QueryError	Instance %s query account error
400	Connect.Timeout	Service can not connect to instance temporarily.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

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

変更履歴

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