ListUserWafRulesets による WAF ルールセットのフィルタリングとページネーション - Edge Security Acceleration

指定されたインスタンスの WAF ルールセットを取得します。フェーズ、名前、その他の条件でフィルタリングできます。

操作説明

InstanceId は、クエリ対象の WAF インスタンスを指定する必須パラメーターです。
Phase パラメーターは、カスタムルールやレート制限ルールなど、WAF 処理フェーズによってルールセットをフィルタリングします。
QueryArgs の NameLike を使用して、ルールセット名であいまい検索を実行します。
PageNumber および PageSize パラメーターはページネーションを制御し、デフォルト値はそれぞれ 1 と 20 です。
レスポンスには、リクエスト ID、現在のプラン使用量、レコード総数、およびルールセット詳細のリストが含まれます。

今すぐお試しください

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

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンス ID。	esa-xxxxxxx
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
QueryArgs	object	任意	結果をフィルタリングおよびソートするためのパラメーター。
NameLike	string	任意	ルールセット名のあいまい検索に使用する文字列。	example
OrderBy	string	任意	結果をソートする基準となるフィールド。	id
Desc	boolean	任意	結果を降順でソートするかどうかを指定します。
PageNumber	integer	任意	返すページ番号。	1
PageSize	integer	任意	各ページで返すエントリ数。	20

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ。
RequestId	string	リクエスト ID。	36af3fcc-43d0-441c-86b1-428951dc8225
InstanceUsage	integer	インスタンスの使用量。	10
TotalCount	integer	フィルタリング後のレコード総数。	5
Rulesets	array<object>	WAF ルールセットオブジェクトのリスト。
	object	WAF ルールセットオブジェクト。
Id	integer	WAF ルールセット ID。	10000001
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
Name	string	WAF ルールセット名。	example
Description	string	WAF ルールセットの説明。	example
Status	string	WAF ルールセットのステータス。	on
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりに返されるエントリ数。	20

例

成功レスポンス

JSONJSON

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "InstanceUsage": 10,
  "TotalCount": 5,
  "Rulesets": [
    {
      "Id": 10000001,
      "Position": 1,
      "Phase": "http_custom",
      "Name": "example",
      "Description": "example",
      "Status": "on"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

エラーコード

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

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

変更履歴

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