ListWafRulesets - 列举WAF规则集 - 边缘安全加速

列举出当前WAF运行阶段下的规则集列表，通过此接口查看分页查询规则集的基本信息和状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListWafRulesets

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

无

请求参数

名称	类型	必填	描述	示例值
SiteId	integer	是	站点 ID，可通过调用 ListSites 接口获取。	1
SiteVersion	integer	否	站点配置的版本号。开启了配置版本管理的站点，可以通过该参数指定配置生效的站点版本，默认为版本 0。	0
Phase	string	是	WAF 规则运行阶段。 http_whitelist：白名单规则 http_custom：自定义规则 http_managed：托管规则 http_anti_scan：扫描防护规则 http_ratelimit：频次控制规则 ip_access_rule：IP 访问规则 http_bot：高级模式 Bots http_security_level_rule：安全规则	http_bot
QueryArgs	object	否	查询参数，以 JSON 格式传递，包含各种筛选条件。	http_bot
NameLike	string	否	模糊查询规则集名称。	example
AnyLike	string	否	模糊查询规则集 ID、规则集名称、规则 ID、规则名称。	example
OrderBy	string	否	指定排序的列。	id
Desc	boolean	否	是否倒序排列。
PageNumber	integer	否	页面号码，分页查询时指定当前页码。	1
PageSize	integer	否	页面大小，分页查询时指定每页的记录数量。	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	36af3fcc-43d0-441c-86b1-428951dc8225
SiteUsage	integer	站点在该 WAF 运行阶段已使用的 WAF 规则集数量。	5
InstanceUsage	integer	实例在该 WAF 运行阶段已使用的 WAF 规则集数量。	10
TotalCount	integer	过滤后总记录数。	5
Rulesets	array<object>	规则集信息列表，包含规则集的详细信息。
	object	规则集信息
UpdateTime	string	规则集的最后修改时间。	2024-01-01T00:00:00Z
Id	integer	WAF 规则集的 ID，可通过调用 ListWafRulesets 接口获取。	10000001
Name	string	规则集名称。	example
Status	string	规则集状态。	on
Phase	string	WAF 规则运行阶段。 http_whitelist：白名单规则 http_custom：自定义规则 http_managed：托管规则 http_anti_scan：扫描防护规则 http_ratelimit：频次控制规则 ip_access_rule：IP 访问规则 http_bot：高级模式 Bots http_security_level_rule：安全规则	http_bot
Types	array	规则类型列表。
	string	规则类型。	http_custom_cc
Target	string	http_bot 中防护目标类型。	web
Fields	array	匹配对象列表。
	string	匹配对象。	http.request.headers
PageNumber	integer	当前页码。	1
PageSize	integer	页面大小。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "SiteUsage": 5,
  "InstanceUsage": 10,
  "TotalCount": 5,
  "Rulesets": [
    {
      "UpdateTime": "2024-01-01T00:00:00Z",
      "Id": 10000001,
      "Name": "example",
      "Status": "on",
      "Phase": "http_bot",
      "Types": [
        "http_custom_cc"
      ],
      "Target": "web",
      "Fields": [
        "http.request.headers"
      ]
    }
  ],
  "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.	调用服务失败，请稍后重试或联系客服咨询详情。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。