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:ModifyFirewallRules

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-*****************
RuleName	string	必須	ファイアウォールルールの名前。一度に 1 つのルール名のみ指定できます。説明 DescribeFirewallRules 操作を呼び出して、ルール名を含む、ターゲットクラスターのすべてのファイアウォールルールの詳細をクエリします。指定されたルール名が現在のクラスターに存在しない場合、システムはルール名と `RuleConfig` の値に基づいて新しいファイアウォールルールを自動的に作成します。	test
RuleConfig	string	必須	変更するファイアウォールルールの構成パラメーターとその値を含む JSON 文字列。パラメーター値は文字列です。例: { "id": "test", "enabled": "true", "mode": "Defending", "users": { "applies_to": [] }, "endpoint": "[{"EndpointName":"pe-*************","EndpointType":"Cluster","DBEndpointDescription":"Cluster Endpoint"},{"EndpointName":"pe-***********","EndpointType":"Custom","DBEndpointDescription":"pc-***********"},{"EndpointName":"pe-***********","EndpointType":"Custom","DBEndpointDescription":"pc-***********"}]", "type": "BlackList", "sub_rules": [] }, "RuleName": "test" }。パラメーターは次のように記述されます: `"id"`: 必須。ファイアウォールルールの名前。 `"databases"`: オプション。ルールが適用されるデータベースの名前。複数のデータベース名を指定できます。名前をコンマ (,) で区切ります。このパラメーターを空のままにすると、ルールはクラスター内のすべてのデータベースに適用されます。 `"tables"`: オプション。ルールが適用されるテーブルの名前。複数のテーブル名を指定できます。名前をコンマ (,) で区切ります。このパラメーターを空のままにすると、ルールはクラスター内のすべてのテーブルに適用されます。 `"columns"`: 必須。ルールが適用されるフィールドの名前。複数のフィールド名を指定できます。名前をコンマ (,) で区切ります。 `"description"`: オプション。データマスキングルールの説明。説明は最大 64 文字です。 `"enabled"`: 必須。データマスキングルールを有効にするか無効にするかを指定します。有効な値: true (有効) および false** (無効)。 `"applies_to"`: ルールが適用されるデータベースアカウントの名前。複数のデータベースアカウント名を指定できます。名前をコンマ (,) で区切ります。 `"exempted"`: ルールが適用されないデータベースアカウントの名前。複数のデータベースアカウント名を指定できます。名前をコンマ (,) で区切ります。説明 `RuleName` パラメーターを指定する場合、`RuleConfig` パラメーターは必須です。 `"applies_to"` または `"exempted"` のいずれかを指定する必要があります。	{"id":"test","enabled":"true","mode":"Collecting","users":{"applies_to":[]},"endpoint":"[{"EndpointName":"pe-**********","EndpointType":"Cluster","DBEndpointDescription":"Cluster Address"},{"EndpointName":"pe-********","EndpointType":"Custom","DBEndpointDescription":"pc-********"},{"EndpointName":"pe-********","EndpointType":"Custom","DBEndpointDescription":"pc-**********K"}]","type":"WhiteList"}

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID	A8DBA3A7-82FB-5CBE-A002-8959E47D1D61
Message	string	返されるメッセージ。説明リクエストが成功した場合、「Successful」が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
Success	boolean	リクエストの結果。有効な値: true: リクエストは成功です。 false: リクエストは失敗です。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "A8DBA3A7-82FB-5CBE-A002-8959E47D1D61",
  "Message": "Successful",
  "Success": true
}

エラーコード

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

変更履歴

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