DescribeDefenseRules_Web 应用防火墙_API调试-阿里云OpenAPI开发者门户

请求参数

字段名称	字段详情
InstanceIdstring	WAF 实例 ID。展开详情示例值:waf_cdnsdf3****参考取值来源: SyncProductInstance DescribeInstance CreatePostpaidInstance
RuleTypestring	防护规则类型。取值：展开详情示例值:whitelist参考取值来源: DescribeRuleHitsTopTuleType
Querystring	查询条件，以一系列参数构造的 JSON 格式转化成字符串。展开详情示例值:{\"name\":\"IP压制_20220822_10\",\"scene\":\"custom_acl\",\"templateId\":5327}
PageNumberinteger<int32>	分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。示例值:1
PageSizeinteger<int32>	分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。示例值:10
RegionIdstring	WAF 实例所属地域。取值：展开详情示例值:cn-hangzhou参考取值来源: DescribeResourceRegionId
ResourceManagerResourceGroupIdstring	阿里云资源组 ID。示例值:rg-acfm***q参考取值来源: DescribeHybridCloudResources

请求说明

Query 参数详解

参数描述

名称	类型	是否必选	示例值	描述
name	String	可选	test	要查询的防护规则名称。您可以设置该参数，精确查询某条防护规则。
nameId	String	可选	test1	要查询的防护规则 ID 或名称。您可以设置该参数，模糊查询某条防护规则。
nameLike	String	可选	test.aliyundoc.c	要查询的防护规则名称。您可以设置该参数，模糊查询某条防护规则。
scene	String	可选	waf_group	要查询的防护场景。您可以设置该参数，精确查询某个防护场景的防护规则。取值： - waf_group：表示基础防护的正则规则。 - waf_base_compliance：表示基础防护的协议合规规则。 - waf_base_sema：表示基础防护的语义规则。 - cc：表示 cc 防护。 - antiscan_dirscan：表示扫描防护中的目录遍历封禁。 - antiscan_highfreq：表示扫描防护中的高频扫描封禁。 - antiscan_scantools：表示扫描防护中的扫描工具封禁。 - ip_blacklist：表示 IP 黑名单。 - custom_acl：表示自定义规则。 - region_block：表示区域封禁。 - tamperproof：表示网页防篡改。 - dlp：表示信息泄漏防护。 - custom_response_block：表示自定义响应。
ruleId	Long	可选	33444	要查询的防护规则 ID。您可以设置该参数，精确查询某条防护规则。
ruleIdIn	Array	可选	[3334455643,345555]	要查询的防护规则 ID 范围。您可以设置该参数，查询多个防护规则。多个防护规则之间使用英文逗号（,）分隔。
templateId	Long	可选	24354	要查询的防护模板 ID。您可以设置该参数，查询某个防护模板中的防护规则。
orderBy	String	可选	name	设置防护规则排序方式。取值： - name : 表示按防护规则名称排序。 - gmtModified : 表示按防护规则修改时间排序。 - id : 表示按规则 ID 排序。 - templateId : 表示按防护模板 ID 排序。
desc	Boolean	可选	true	设置排序顺序。取值： - false : 表示正序显示。 - true : 表示倒序显示。

示例

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

返回参数

字段名称	字段详情
TotalCountinteger<int64>	返回结果的总数。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:2
RequestIdstring	请求 ID。示例值:80736FA5-FA87-55F6-AA69-C5477C6FE6D0
Rulesarray<object>	防护规则列表。

变更历史

	变更时间	变更内容概要	操作
	2025-03-27	删除返回参数