DescribeFirewallRules で SQL ファイアウォールルールをクエリする - 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:DescribeFirewallRules

get

*DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-*****************
RuleNameList	string	任意	照会するファイアウォールルールの名前。複数のルールを照会するには、ルール名をカンマ (,) で区切ります。説明 DescribeFirewallRules 操作を呼び出して、ルール名など、ターゲットクラスターのすべてのファイアウォールルールの詳細を表示します。	testrule

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264
Message	string	応答メッセージ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Message
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
Data	object	結果セット。
RuleList	array	ファイアウォールルールのリスト。
	string	ルールオブジェクト。	"{"mode":"Defending","endpoint":"[{"EndpointName":"pe-************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-********","EndpointType":"Custom","DBEndpointDescription":"pc-*******"},{"EndpointName":"pe-**********","EndpointType":"Custom","DBEndpointDescription":"pc-*********"}]","id":"test","sub_rules":[],"type":"BlackList","enabled":"true","users":{"applies_to":[]}}"
DBClusterId	string	クラスター ID。	pc-*****************

例

成功レスポンス

JSONJSON

{
  "RequestId": "84D7DCD2-54F7-5BD2-B055-F5DE9D2B5264",
  "Message": "Message",
  "Success": true,
  "Data": {
    "RuleList": [
      "\"{\"mode\":\"Defending\",\"endpoint\":\"[{\"EndpointName\":\"pe-**************\",\"EndpointType\":\"Cluster\",\"DBEndpointDescription\":\"Cluster Address\"},{\"EndpointName\":\"pe-************\",\"EndpointType\":\"Custom\",\"DBEndpointDescription\":\"pc-***********\"},{\"EndpointName\":\"pe-**************\",\"EndpointType\":\"Custom\",\"DBEndpointDescription\":\"pc-***********\"}]\",\"id\":\"test\",\"sub_rules\":[],\"type\":\"BlackList\",\"enabled\":\"true\",\"users\":{\"applies_to\":[]}}\""
    ]
  },
  "DBClusterId": "pc-*****************\n"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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