保護ルールのページ分割されたリストを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-waf:DescribeDefenseRules

list

*All Resource

*

acs:ResourceGroupId

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	Web Application Firewall (WAF) インスタンスの ID。説明 DescribeInstance 操作を呼び出して、WAF インスタンスの ID を照会します。	waf_cdnsdf3****
RuleType	string	任意	保護ルールのタイプ。有効な値は次のとおりです。 whitelist: ホワイトリストルール defense (デフォルト): 保護ルール説明このパラメーターは、DefenseType が template に設定されている場合にのみ必須です。	whitelist
Query	string	任意	クエリ条件。このパラメーターを JSON 文字列として指定します。説明保護ルールのクエリ結果は、クエリ条件によって異なります。詳細については、「クエリパラメーターの詳細」をご参照ください。	{\"name\":\"IPblock_20220822_10\",\"scene\":\"custom_acl\",\"templateId\":5327}
PageNumber	integer	任意	返されるページの番号。デフォルト値: 1。	1
PageSize	integer	任意	各ページで返されるエントリの数。デフォルト値: 10。	10
DefenseType	string	任意	保護ルールのタイプ。有効な値は次のとおりです。 template (デフォルト): テンプレート保護ルール。 resource: 保護対象のルール。 global: グローバルルール。列挙値: template : テンプレート resource : リソース global : グローバル	template
RegionId	string	任意	WAF インスタンスが存在するリージョン。有効な値は次のとおりです。 cn-hangzhou: 中国本土。 ap-southeast-1: 中国本土以外。	cn-hangzhou
ResourceManagerResourceGroupId	string	任意	Alibaba Cloud リソースグループの ID。	rg-acfm***q

クエリパラメーターの詳細

テンプレート保護ルール (template)

DefenseType を template に設定した場合、以下のパラメーターが利用可能です。

パラメーターの説明

Name	Type	Required	Example	Description
name	String	No	test	照会する保護ルールの名前。このパラメーターを設定して、保護ルールを完全一致検索できます。
nameId	String	No	test1	照会する保護ルールの ID または名前。このパラメーターを設定して、保護ルールをあいまい検索できます。
nameLike	String	No	test.aliyundoc.c	照会する保護ルールの名前。このパラメーターを設定して、保護ルールをあいまい検索できます。
scene	String	No	waf_group	照会する保護シナリオ。このパラメーターを設定して、特定のシナリオの保護ルールを完全一致検索できます。有効な値は次のとおりです。 - waf_group: 基本保護の正規表現ルール。 - waf_base: 新しいウェブコア保護機能のルール。 - waf_base_compliance: 基本保護のプロトコルコンプライアンスルール。 - waf_base_sema: 基本保護のセマンティックルール。 - cc: HTTP フラッド攻撃対策。 - antiscan_dirscan: スキャン保護のためのディレクトリトラバーサルブロック。 - antiscan_highfreq: スキャン保護のための高頻度スキャンブロック。 - antiscan_scantools: スキャン保護のためのスキャナーブロック。 - ip_blacklist: IP アドレスブラックリスト。 - custom_acl: カスタムルール。 - region_block: 地域ブロック。 - tamperproof: ウェブページ改ざん防止。 - dlp: データ漏えい防止。 - custom_response_block: カスタム応答。
ruleId	Long	No	33444	照会する保護ルールの ID。このパラメーターを設定して、保護ルールを完全一致検索できます。
ruleIdIn	Array	No	[3334455643,345555]	照会する保護ルール ID の範囲。このパラメーターを設定して、複数の保護ルールを照会できます。複数のルール ID はコンマ (,) で区切ります。
templateId	Long	No	24354	照会する保護テンプレートの ID。このパラメーターを設定して、保護テンプレート内の保護ルールを照会できます。
orderBy	String	No	name	保護ルールのソート方法。有効な値は次のとおりです。 - name: 名前でルールをソートします。 - gmtModified: 変更時間でルールをソートします。 - id: ID でルールをソートします。 - templateId: テンプレート ID でルールをソートします。
desc	Boolean	No	true	ソート順。有効な値は次のとおりです。 - false: 昇順。 - true: 降順。

例

{
    "name": "test",
    "nameId ": "test1,
    "nameLike": "test.aliyundoc.c",
    "nameIn": "test.aliyundoc.c",
    "InstaneId": "test1.aliyundoc.com,test2.aliyundoc.com",
    "templateId": 24354
}

保護対象のルール (resource)

DefenseType を resource に設定した場合、以下のパラメーターが利用可能です。

パラメーターの説明

Name	Type	Required	Example	Description
resource	String	No	sec****-waf	ルールが適用される保護対象。
scene	String	No	waf_group	照会する保護シナリオ。このパラメーターを設定して、特定のシナリオの保護ルールを完全一致検索できます。有効な値は次のとおりです。 - account_identifier: アカウントフェッチルール。 - custom_response: 新しいカスタム応答。

例

{
    "resource": "sec****-waf",
    "scene ": "account_identifier"
}

グローバルルール (global)

DefenseType を global に設定した場合、以下のパラメーターが利用可能です。

パラメーターの説明

Name	Type	Required	Example	Description
scene	String	No	regular_custom	照会する保護シナリオ。このパラメーターを設定して、特定のシナリオの保護ルールを完全一致検索できます。有効な値は次のとおりです。 - regular_custom: カスタム正規表現ルール。 - custom_response: 新しいカスタム応答。
detectType	String	No	sqli	照会する検出モジュール。有効な値は次のとおりです。 - sqli: SQL インジェクション。 - xss: クロスサイトスクリプティング (XSS)。 - cmdi: OS コマンドインジェクション。 - expression_injection: 式インジェクション。 - java_deserialization: Java デシリアライゼーション。 - dot_net_deserialization: .NET デシリアライゼーション。 - php_deserialization: PHP デシリアライゼーション。 - code_exec: コード実行。 - ssrf: Server-Side Request Forgery (SSRF)。 - path_traversal: パストラバーサル。 - arbitrary_file_uploading: 任意のファイルアップロード。 - webshell: ウェブシェル。 - rfilei: リモートファイルインクルード (RFI)。 - lfilei: ローカルファイルインクルード。 - protocol_violation: プロトコル違反。 - scanner_behavior: スキャナー動作。 - logic_flaw: ビジネスロジックのバグ。 - arbitrary_file_reading: 任意のファイル読み取り。 - arbitrary_file_download: 任意のファイルダウンロード。 - xxe: 外部エンティティインジェクション。 - csrf: CSRF。 - crlf: CRLF。 - other: その他。重要このパラメーターは、scene が regular_custom に設定されている場合にのみサポートされます。
riskLevel	String	No	strict	照会する脅威レベル。有効な値は次のとおりです。 - super_strict: Super Strict。 - strict: Strict。 - medium: Medium。 - loose: Loose。重要このパラメーターは、scene が regular_custom に設定されている場合にのみサポートされます。
templateId	Long	No	24354	照会する保護テンプレートの ID。このパラメーターを設定して、保護テンプレート内の保護ルールを照会できます。重要このパラメーターは、scene が regular_custom に設定されている場合にのみサポートされます。

例

{
    "detectType": "sqli",
    "riskLevel ": "strict",
    "templateId": 24354
}

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
TotalCount	integer	返されたエントリの総数。	2
RequestId	string	リクエスト ID。	80736FA5-FA87-55F6-AA69-C5477C6FE6D0
Rules	array<object>	保護ルールのリスト。
	object	保護ルール。
Status	integer	保護ルールのステータス。有効な値は次のとおりです。 0: 無効。 1: 有効。	1
DefenseOrigin	string	保護ルールのソース。有効な値は次のとおりです。 custom: ユーザーによって作成されたルール。 system: システムによって自動生成されたルール。	custom
Config	string	保護ルールの詳細。値は JSON 文字列です。詳細については、「CreateDefenseRule」の Rule パラメーターの説明をご参照ください。	{\"policyId\":1012,\"action\":\"block\"}
RuleId	integer	保護ルールの ID。	42755
DefenseScene	string	保護シナリオ。 DefenseType リクエストパラメーターが template に設定されている場合、有効な値は次のとおりです。 waf_group: 基本保護の正規表現ルール。 waf_base: 新しいウェブコア保護機能のルール。 waf_base_compliance: 基本保護のプロトコルコンプライアンスルール。 waf_base_sema: 基本保護のセマンティックルール。 cc: HTTP フラッド攻撃対策。 antiscan_dirscan: スキャン保護のためのディレクトリトラバーサルブロック。 antiscan_highfreq: スキャン保護のための高頻度スキャンブロック。 antiscan_scantools: スキャン保護のためのスキャナーブロック。 ip_blacklist: IP アドレスブラックリスト。 custom_acl: カスタムルール。 region_block: 地域ブロック。 tamperproof: ウェブページ改ざん防止。 dlp: データ漏えい防止。 custom_response_block: カスタム応答。 spike_throttle: ピークトラフィックのスロットリング。 DefenseType リクエストパラメーターが resource に設定されている場合、有効な値は次のとおりです。 account_identifier: アカウント識別子。 custom_response: 新しいカスタム応答。 waf_codec: WAF コーデック。 DefenseType リクエストパラメーターが global に設定されている場合、有効な値は次のとおりです。 regular_custom: カスタム正規表現。 address_book: アドレス帳。 custom_response: 新しいカスタム応答。	waf_group
GmtModified	integer	保護ルールが最後に変更された時間。この値は UNIX タイムスタンプです。単位: ミリ秒。	1665460629000
RuleName	string	保護ルールの名前。	rules_41
TemplateId	integer	保護テンプレートの ID。	5673
GmtCreate	integer	保護ルールが作成された時間。この値は UNIX タイムスタンプです。単位: ミリ秒。	1665460629000
Resource	string	ルールが適用される保護対象。説明このパラメーターは、DefenseType リクエストパラメーターが resource に設定されている場合にのみ返されます。	rencs***-waf
DefenseType	string	保護ルールのタイプ。有効な値は次のとおりです。 template (デフォルト): テンプレート保護ルール。 resource: 保護対象のルール。 global: グローバルルール。	template
Description `deprecated`	string	このパラメーターは非推奨です。	rule description
RuleType `deprecated`	string	このパラメーターは非推奨です。	custom_cc
ActionExternal `deprecated`	string	このパラメーターは非推奨です。	42755
DetailRuleIds `deprecated`	string	このパラメーターは非推奨です。	42755
ExternalInfo `deprecated`	string	このパラメーターは非推奨です。	{\"DetectType\":\"sqli\"}

例

成功レスポンス

JSONJSON

{
  "TotalCount": 2,
  "RequestId": "80736FA5-FA87-55F6-AA69-C5477C6FE6D0",
  "Rules": [
    {
      "Status": 1,
      "DefenseOrigin": "custom",
      "Config": "{\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
      "RuleId": 42755,
      "DefenseScene": "waf_group",
      "GmtModified": 1665460629000,
      "RuleName": "rules_41",
      "TemplateId": 5673,
      "GmtCreate": 1665460629000,
      "Resource": "rencs***-waf",
      "DefenseType": "template",
      "Description": "rule description",
      "RuleType": "custom_cc",
      "ActionExternal": "42755",
      "DetailRuleIds": "42755",
      "ExternalInfo": "{\\\"DetectType\\\":\\\"sqli\\\"}"
    }
  ]
}

エラーコード

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

変更履歴

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