DescribeDBInstanceIPArrayList で IP ホワイトリストを取得・監査 - AnalyticDB for PostgreSQL

操作説明

この操作を使用して、AnalyticDB for PostgreSQL インスタンスへアクセス可能な IP アドレスのホワイトリストを照会できます。

使用制限

アカウントあたり、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:DescribeDBInstanceIPArrayList

get

*DBInstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceGroupId	string	任意	インスタンスが属するリソースグループの ID です。リソースグループの ID を取得する方法については、「リソースグループの基本情報を表示する」をご参照ください。	null
DBInstanceId	string	必須	インスタンス ID です。説明すべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）の詳細をリージョン単位で照会するには、「DescribeDBInstances」操作をご利用ください。	gp-bp***************
DBInstanceIPArrayName	string	任意	IP アドレスホワイトリストの名前です。このパラメーターを指定しない場合、デフォルトのホワイトリストが照会されます。説明各インスタンスは最大 50 個の IP アドレスホワイトリストをサポートします。	Default

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	CB7AA0BF-BE41-480E-A3DC-C97BF85A391B
Items	object
DBInstanceIPArray	array<object>	照会された IP アドレスホワイトリストです。
	object
DBInstanceIPArrayName	string	IP アドレスホワイトリストの名前です。	Default
SecurityIPList	string	ホワイトリストに登録された IP アドレスです。1 つのホワイトリストには最大 1,000 個の IP アドレスをカンマ (,) で区切って登録できます。IP アドレスは、以下のいずれかの形式である必要があります： 0.0.0.0/0 10.23.12.24（標準的な IP アドレス） 10.23.12.24/24（CIDR ブロック）。`/24` は CIDR ブロックのプレフィックス長が 24 ビットであることを示します。`1 ～ 32` の範囲内の任意の値に置き換え可能です。	127.0.0.1
DBInstanceIPArrayAttribute	string	IP アドレスホワイトリストの属性です。デフォルトでは空文字列になります。`hidden` 属性を持つホワイトリストは、コンソール上に表示されません。	hidden

例

成功レスポンス

JSONJSON

{
  "RequestId": "CB7AA0BF-BE41-480E-A3DC-C97BF85A391B",
  "Items": {
    "DBInstanceIPArray": [
      {
        "DBInstanceIPArrayName": "Default",
        "SecurityIPList": "127.0.0.1",
        "DBInstanceIPArrayAttribute": "hidden"
      }
    ]
  }
}

エラーコード

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

変更履歴

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