查询指定实例下的WAF规则集列表，支持按阶段、名称等条件过滤。
接口说明
请求说明
InstanceId是必填参数，用于指定要查询的 WAF 实例。Phase参数允许用户根据 WAF 的不同处理阶段（如自定义规则、频次控制规则等）来筛选规则集。使用
QueryArgs中的NameLike可以进行规则集名称的模糊搜索。分页信息通过
PageNumber和PageSize控制，默认值分别为 1 和 20。返回结果中包含请求 ID、当前套餐使用量、总记录数以及具体的规则集详情列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
esa-xxxxxxx |
| Phase |
string |
否 |
WAF 阶段。 |
● 自定义规则 - http_custom ● 频次控制规则 - http_ratelimit ● 托管规则 - http_managed ● 白名单规则 - http_whitelist ● 扫描防护规则 - http_anti_scan |
| QueryArgs |
object |
否 |
查询参数。 |
|
| NameLike |
string |
否 |
模糊查询规则集名称。 |
example |
| OrderBy |
string |
否 |
指定排序列。 |
id |
| Desc |
boolean |
否 |
是否倒序排列。 |
|
| PageNumber |
integer |
否 |
页面号码。 |
1 |
| PageSize |
integer |
否 |
页面大小 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
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_custom |
| Name |
string |
WAF 规则集名称。 |
example |
| Description |
string |
WAF 规则集描述。 |
example |
| Status |
string |
WAF 规则集状态。 |
on |
| PageNumber |
integer |
页面号码 |
1 |
| PageSize |
integer |
页面大小 |
20 |
示例
正常返回示例
JSON格式
{
"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 status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 输入参数规范校验失败。 |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 调用服务失败，请稍后重试或联系客服咨询详情。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。