DescribeAccounts を呼び出してデータベースアカウントをクエリ - AnalyticDB for PostgreSQL

操作説明

この操作は、AnalyticDB for PostgreSQL インスタンス内の特権アカウント（例：状態、説明、関連インスタンス）の情報を照会するために呼び出されます。

制限事項

アカウントあたり、1 秒間に最大 1,000 回までこの操作を呼び出すことができます。1 秒あたりの呼び出し回数がこの上限を超えると、速度制限が適用され、ビジネスに影響を及ぼす可能性があります。本操作を呼び出す際には、この制限を十分にご確認ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gpdb:DescribeAccounts

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。説明すべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）に関する情報をリージョン単位で照会するには、「DescribeDBInstances」操作をご利用ください。	gp-bp***************
AccountName	string	任意	データベースアカウントの名前。	testuser
AccountType	string	任意	照会対象のデータベースアカウントの種類。有効な値は Super、Normal、All です。デフォルト値は Super です。このパラメーターを Super に設定すると、特権アカウントの情報が返されます。このパラメーターを Normal に設定すると、すべての標準アカウントの情報が返されます。このパラメーターを All に設定すると、すべてのデータベースアカウントの情報が返されます。	Super

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	7565770E-7C45-462D-BA4A-8A5396F2CAD1
Accounts	object
DBInstanceAccount	array<object>	照会されたデータベースアカウント。
	object
AccountStatus	string	アカウントの状態。 0: アカウント作成中。 1: 利用中。 3: アカウント削除中。	1
AccountDescription	string	アカウントの説明。	testuser
DBInstanceId	string	インスタンス ID。	gp-bp***************
AccountName	string	アカウント名。	testuser
AccountType	string	データベースアカウントの種類。有効な値は Super および Normal です。Super は特権アカウント、Normal は標準アカウントを示します。	Super

例

成功レスポンス

JSONJSON

{
  "RequestId": "7565770E-7C45-462D-BA4A-8A5396F2CAD1",
  "Accounts": {
    "DBInstanceAccount": [
      {
        "AccountStatus": "1",
        "AccountDescription": "testuser",
        "DBInstanceId": "gp-bp***************",
        "AccountName": "testuser",
        "AccountType": "Super\n"
      }
    ]
  }
}

エラーコード

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

変更履歴

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