IP ホワイトリストとセキュリティグループによる PolarDB クラスターアクセス制御 - PolarDB - Alibaba Cloud - PolarDB

データベースクラスターへのアクセスが許可されている IP ホワイトリストおよびセキュリティグループを照会します。

今すぐお試しください

この 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:DescribeDBClusterAccessWhitelist

get

*DBCluster。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。	pc-***************
PfsInstanceId	string	任意	PFS インスタンスの ID。	pfs-xxx

レスポンスフィールド

フィールド	型	説明	例
	object
DBClusterSecurityGroups	object
DBClusterSecurityGroup	array<object>	クラスターに関連付けられている ECS セキュリティグループのリスト。
	object
SecurityGroupId	string	ECS セキュリティグループの ID。	sg-bp**************
SecurityGroupName	string	ECS セキュリティグループ名。	vpc-********************
Items	object
DBClusterIPArray	array<object>	クラスターの IP ホワイトリストグループのリスト。
	object
DBClusterIPArrayAttribute	string	IP ホワイトリストグループの属性。	hidden
DBClusterIPArrayName	string	IP ホワイトリストグループの名前。	default
SecurityIps	string	IP ホワイトリストグループ内の IP アドレス。最大値は 1000 個の IP アドレスです。複数の IP アドレスはカンマ (,) で区切ります。以下の 2 つのフォーマットがサポートされています。 IP アドレス形式 (例: 10.xx.xx.24)。 CIDR 形式 (例: 10.xx.xx.24/24) (Classless Inter-Domain Routing、24 はアドレス内のプレフィックスの長さを示し、範囲は 1～32 です)。	11.*..,11...*
RequestId	string	リクエスト ID。	559E91A2-CDA3-4E9F-808B-29D738******

例

成功レスポンス

JSONJSON

{
  "DBClusterSecurityGroups": {
    "DBClusterSecurityGroup": [
      {
        "SecurityGroupId": "sg-bp**************",
        "SecurityGroupName": "vpc-********************"
      }
    ]
  },
  "Items": {
    "DBClusterIPArray": [
      {
        "DBClusterIPArrayAttribute": "hidden",
        "DBClusterIPArrayName": "default",
        "SecurityIps": "11.***.***.***,11.***.***.***"
      }
    ]
  },
  "RequestId": "559E91A2-CDA3-4E9F-808B-29D738******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	指定されたクラスターインスタンス ID が存在しないため、操作は失敗しました。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	指定された DBClusterId が現在のレコードに存在しません。

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

変更履歴

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