GetWafFilter - Edge Security Acceleration - Alibaba Cloud ドキュメントセンター

指定された WAF フェーズでサイトのマッチングエンジン情報を取得します。このフェーズは、WAF がさまざまなネットワークリクエストを検出して処理する方法を定義します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:GetWafFilter

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SiteId	integer	任意	サイトの ID を指定します。この ID は ListSites 操作を呼び出すことで取得できます。	1
Phase	string	任意	マッチングエンジン情報を取得する WAF フェーズを指定します。	http_bot
Target	string	任意	マッチングエンジンのアプリケーションターゲットを指定します。	characteristics
Type	string	任意	ルールタイプを指定します。	http_custom_cc

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエスト ID。	36af3fcc-43d0-441c-86b1-428951dc8225
Filter	object	返されたマッチングエンジンの構成。
Phase	string	WAF がリクエストを処理するフェーズ。	http_bot
Target	string	マッチングエンジンのターゲット。	characteristics
Type	string	ルールタイプ。	http_custom_cc
Fields	array<object>	マッチオブジェクトとそのプロパティのリスト。
	array<object>	マッチオブジェクト。
Enable	boolean	現在のプランがこのマッチオブジェクトをサポートしているかどうかを示します。	false
MinPlan	string	現在のプランがサポートしていない場合に、このマッチオブジェクトをサポートする最小プラン。	high
Label	string	マッチオブジェクトのラベル。	Header
Key	string	マッチオブジェクトの内部キー。	http.request.headers
Sub	boolean	マッチオブジェクトにサブフィールドが含まれているかどうかを示します。	true
SubTip	string	サブフィールドの値を入力するためのヒント。	e.g. Content-Type
Selector	object	マッチオブジェクトの選択方法を定義するセレクター。
Kind	string	セレクターのタイプ。データ項目または他のエンティティをターゲットにするかどうかを示します。	data
Data	array<object>	セレクターの `Kind` が `data` の場合に利用可能なデータオプションのリスト。
	object	セレクターの `Kind` が `data` の場合に利用可能なデータオプション。
Label	string	データオプションのラベル。	China
Value	string	データオプションの値。	CN
Logics	array<object>	マッチング条件を定義する論理演算子のリスト。
	array<object>	マッチオブジェクトに適用される論理演算子。
Enable	boolean	現在のプランがこの演算子をサポートしているかどうかを示します。	false
MinPlan	string	現在のプランがサポートしていない場合に、この演算子をサポートする最小プラン。	high
Symbol	string	演算子の内部識別子。	eq
Operator	string	演算子のラベル。	Does not equal
Negative	boolean	マッチ結果を否定するかどうかを示します。
Type	string	値のタイプ。有効な値： `integer`：整数。 `integer_slice`：整数配列。 `string`：文字列。 `string_slice`：文字列配列。	string
Kind	string	値の入力タイプ。有効な値： `select:single`：単一選択入力。 `select:multi`：複数選択入力。 `input:single`：単一値テキスト入力。 `input:multi`：複数値テキスト入力。	input:single
Attributes	integer	大文字と小文字の区別など、設定可能な属性。	1
Tip	string	有効な値を入力するためのヒント。	e.g. image/jpeg
Validator	object	値の検証ルールを定義するバリデーター。
Length	WafQuotaInteger	値の長さ制限。
Pattern	string	値の正規表現パターン。	^example$
Range	WafQuotaInteger	数値検証のための値の範囲。
ErrMsg	string	検証が失敗した場合に返されるエラーメッセージ。	Enter a valid expression

例

成功レスポンス

JSONJSON

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Filter": {
    "Phase": "http_bot",
    "Target": "characteristics",
    "Type": "http_custom_cc",
    "Fields": [
      {
        "Enable": false,
        "MinPlan": "high",
        "Label": "Header",
        "Key": "http.request.headers",
        "Sub": true,
        "SubTip": "e.g. Content-Type",
        "Selector": {
          "Kind": "data",
          "Data": [
            {
              "Label": "China",
              "Value": "CN"
            }
          ]
        },
        "Logics": [
          {
            "Enable": false,
            "MinPlan": "high",
            "Symbol": "eq",
            "Operator": "Does not equal",
            "Negative": false,
            "Type": "string",
            "Kind": "input:single",
            "Attributes": 1,
            "Tip": "e.g. image/jpeg",
            "Validator": {
              "Length": {
                "Equal": 1,
                "GreaterThan": 1,
                "GreaterThanOrEqual": 1,
                "LessThan": 1,
                "LessThanOrEqual": 1
              },
              "Pattern": "^example$",
              "Range": {
                "Equal": 1,
                "GreaterThan": 1,
                "GreaterThanOrEqual": 1,
                "LessThan": 1,
                "LessThanOrEqual": 1
              },
              "ErrMsg": "Enter a valid expression"
            }
          }
        ]
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.

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

変更履歴

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