設定の監査のための GetUserWafRuleset による WAF ルールセット詳細の取得 - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

指定されたインスタンスの WAF ルールセットの詳細を照会します。

操作説明

操作の説明

GetUserWafRuleset 操作を呼び出すことで、インスタンス ID とルールセット ID に基づいて特定の Web アプリケーションファイアウォール (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:GetUserWafRuleset

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	esa-xxxxxxx
Id	integer	必須	WAF ルールセットの ID。	10000001

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
RequestId	string	リクエストの ID。	36af3fcc-43d0-441c-86b1-428951dc8225
Ruleset	object	WAF ルールセット。	{}
Id	integer	WAF ルールセットの ID。	10000001
Position	integer	WAF ルールセットの位置。	1
Name	string	WAF ルールセットの名前。	example
Description	string	WAF ルールセットの説明。	example
Status	string	WAF ルールセットのステータス。	on
Expression	string	WAF ルールセットの式。	ip.src == 1.1.1.1
Phase	string	WAF ルールが実行される位相。有効な値: http_whitelist: ホワイトリストルール http_custom: カスタムルール http_managed: マネージドルール http_anti_scan: スキャン保護ルール http_ratelimit: 頻度制御ルール	http_custom
Shared	WafBatchRuleShared	WAF ルールセットの共有構成。	{}
Rules	array<object>	WAF ルールセット内のルール構成のリスト。	[{}]
	object	WAF ルールセット内のルール構成。	{}
UpdateTime	string	WAF ルールが最後に更新された時間。	2025-07-07T15:00:00Z
RulesetId	integer	WAF ルールセットの ID。	10000001
Id	integer	WAF ルールの ID。	20000001
Position	integer	WAF ルールの位置。	1
Phase	string	WAF ルールの評価フェーズ。有効な値： `http_whitelist`：ホワイトリストルール。 `http_custom`：カスタムルール。 `http_managed`：マネージドルール。 `http_anti_scan`：スキャン保護ルール。 `http_ratelimit`：レート制限ルール。 `ip_access_rule`：IP アクセスルール。 `http_bot`：ボット管理ルール。 `http_security_level_rule`：セキュリティレベルルール。	http_custom
Type	string	WAF ルールのタイプ。	http_ratelimit
Name	string	WAF ルールの名前。	example
Status	string	WAF ルールのステータス。	on
Fields	array	WAF ルールの一致フィールドのリスト。	["ip.src"]
	string	WAF ルールの一致フィールド。	ip.src
CharacteristicsFields	array	WAF ルールの統計フィールドのリスト。	["http.host"]
	string	WAF ルールの統計フィールド。	http.host
Action	string	ルールのアクション。有効な値： `deny`：リクエストをブロックします。 `monitor`：リクエストを監視します。 `js`：JS チャレンジをトリガーします。 `captcha`：CAPTCHA チャレンジをトリガーします。	deny
Skip	string	WAF ルールのスキップモード。	all
Tags	array	ルールがスキップするフェーズ。	["http_custom"]
	string	ルールがスキップするフェーズ。	http_custom
Config	WafRuleConfig	WAF ルールの設定。	{ "Id": 20000001, "Name": "rule1", "Expression": "ip.src eq 1.1.1.1", "Action": "deny" }

例

成功レスポンス

JSONJSON

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Ruleset": {
    "Id": 10000001,
    "Position": 1,
    "Name": "example",
    "Description": "example",
    "Status": "on",
    "Expression": "ip.src == 1.1.1.1",
    "Phase": "http_custom",
    "Shared": {
      "Target": "web",
      "Mode": "automatic",
      "CrossSiteId": 10000001,
      "Name": "example",
      "Match": {
        "Logic": "and",
        "Criteria": [
          {
            "Logic": "and",
            "Criteria": [
              {
                "Logic": "and",
                "Criteria": [
                  {
                    "MatchType": "ip.src",
                    "MatchOperator": "eq",
                    "MatchValue": "1.1.1.1",
                    "Negate": false,
                    "ConvertToLower": false
                  }
                ],
                "MatchType": "ip.src",
                "MatchOperator": "eq",
                "MatchValue": "1.1.1.1",
                "Negate": false,
                "ConvertToLower": false
              }
            ],
            "MatchType": "ip.src",
            "MatchOperator": "eq",
            "MatchValue": "1.1.1.1",
            "Negate": false,
            "ConvertToLower": false
          }
        ],
        "MatchType": "ip.src",
        "MatchOperator": "eq",
        "MatchValue": "1.1.1.1",
        "Negate": false,
        "ConvertToLower": false
      },
      "Action": "deny",
      "Actions": {
        "Response": {
          "Id": 50000001,
          "Code": 403
        }
      },
      "Expression": "ip.src eq 1.1.1.1"
    },
    "Rules": [
      {
        "UpdateTime": "2025-07-07T15:00:00Z",
        "RulesetId": 10000001,
        "Id": 20000001,
        "Position": 1,
        "Phase": "http_custom",
        "Type": "http_ratelimit",
        "Name": "example",
        "Status": "on",
        "Fields": [
          "ip.src"
        ],
        "CharacteristicsFields": [
          "http.host"
        ],
        "Action": "deny",
        "Skip": "all",
        "Tags": [
          "http_custom"
        ],
        "Config": {
          "Status": "on",
          "Action": "deny",
          "Actions": {
            "Response": {
              "Id": 50000001,
              "Code": 403
            },
            "Bypass": {
              "Skip": "part",
              "RegularRules": [
                100001
              ],
              "CustomRules": [
                20000001
              ],
              "RegularTypes": [
                "sqli"
              ],
              "Tags": [
                "http_custom"
              ]
            }
          },
          "ManagedList": "intelligence_crawler",
          "ManagedRulesets": [
            {
              "ProtectionLevel": 4,
              "Action": "deny",
              "ManagedRules": [
                {
                  "Status": "on",
                  "Action": "deny",
                  "Id": 100001
                }
              ],
              "AttackType": 11,
              "NumberTotal": 100,
              "NumberEnabled": 50
            }
          ],
          "Sigchl": [
            "sig"
          ],
          "Name": "example",
          "AppSdk": {
            "CustomSign": {
              "Value": "examplesignvalue",
              "Key": "sign"
            },
            "CustomSignStatus": "on",
            "FeatureAbnormal": [
              "wxbb_invalid_sign"
            ]
          },
          "RateLimit": {
            "Characteristics": {
              "Logic": "and",
              "Criteria": [
                {
                  "Logic": "and",
                  "Criteria": [
                    {
                      "Logic": "and",
                      "Criteria": [
                        {
                          "MatchType": "ip.src",
                          "MatchOperator": "eq",
                          "MatchValue": "1.1.1.1",
                          "Negate": false,
                          "ConvertToLower": false
                        }
                      ],
                      "MatchType": "ip.src",
                      "MatchOperator": "eq",
                      "MatchValue": "1.1.1.1",
                      "Negate": false,
                      "ConvertToLower": false
                    }
                  ],
                  "MatchType": "ip.src",
                  "MatchOperator": "eq",
                  "MatchValue": "1.1.1.1",
                  "Negate": false,
                  "ConvertToLower": false
                }
              ],
              "MatchType": "ip.src",
              "MatchOperator": "eq",
              "MatchValue": "1.1.1.1",
              "Negate": false,
              "ConvertToLower": false
            },
            "OnHit": true,
            "TTL": 10,
            "Threshold": {
              "ManagedRulesBlocked": 10,
              "DistinctManagedRules": 10,
              "ResponseStatus": {
                "Ratio": 10,
                "Count": 10,
                "Code": 404
              },
              "Traffic": "10Gb",
              "Request": 10
            },
            "Interval": 10
          },
          "Type": "http_custom",
          "AppPackage": {
            "PackageSigns": [
              {
                "Sign": "sign",
                "Name": "name"
              }
            ]
          },
          "ManagedGroupId": 30000001,
          "Timer": {
            "Scopes": "permanent",
            "Zone": 8,
            "Periods": [
              {
                "Start": "2025-01-01T00:00:00Z",
                "End": "2025-01-01T01:00:00Z"
              }
            ],
            "WeeklyPeriods": [
              {
                "Days": "1",
                "DailyPeriods": [
                  {
                    "Start": "00:00:00",
                    "End": "01:00:00"
                  }
                ]
              }
            ]
          },
          "Expression": "ip.src eq 10.0.0.1",
          "SecurityLevel": {
            "Value": "low"
          },
          "Value": "10.0.0.1",
          "Id": 20000001,
          "Notes": "example notes"
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The specified parameter is invalid.	入力パラメーターのフォーマット検証が失敗しました。有効な値を指定してください。
400	InternalException	Failed to call the service. Try again later or contact technical support.	サービスの呼び出しに失敗しました。後でもう一度お試しいただくか、詳細についてはカスタマーサポートにお問い合わせください。

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

変更履歴

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