ListWafUsageOfRules - 列举WAF规则的使用情况 - 边缘安全加速

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListWafUsageOfRules

list

*Site

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

无

请求参数

名称	类型	必填	描述	示例值
SiteId	integer	否	站点 ID，可通过调用 ListSites 接口获取。	1
InstanceId	string	否	WAF 实例 ID。当该参数为空时，API 直接返回空结果，建议始终传入。	esa-site-b0wdsrlba3nk
Phase	string	否	WAF 规则运行阶段，必填。常用取值：http_custom、http_ratelimit、http_anti_scan、http_bot、http_managed、http_whitelist、http_threat_intelligence 等。说明注意：该参数在服务端为强制必填，未指定时 API 返回 InvalidParameter(400)。	http_custom

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	36af3fcc-43d0-441c-86b1-428951dc8225
Sites	array<object>	站点使用量列表。
	object	站点使用量详情。
Id	integer	站点 ID。	1
Name	string	站点名称。	example.com
Usage	integer	WAF 规则/WAF 规则集的已使用量。	1
BatchConfigUsage	integer	实例级批量配置下，指定 Phase 的规则/规则集数量。	1
InstanceUsage	integer	该实例在指定 Phase 下的规则/规则集总用量（包含站点级与实例级）。	2

示例

正常返回示例

JSON格式

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Sites": [
    {
      "Id": 1,
      "Name": "example.com",
      "Usage": 1
    }
  ],
  "BatchConfigUsage": 1,
  "InstanceUsage": 2
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	输入参数规范校验失败。
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。

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

变更历史

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