GetWafQuota - 获取WAF资源相关配额_边缘安全加速(ESA)-阿里云帮助中心

获取Web应用防火墙（WAF）相关资源的配额详情。这些配额定义了客户可以使用的对应资源的数量限制，例如托管规则组、自定义列表、自定义响应页面以及场景防护规则数量等。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
esa:GetWafQuota	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Paths	string	否	WAF 配额的路径，例如： managed_rules_group：表示 WAF 托管规则组的配额 list：表示自定义列表的配额 page：表示自定义响应页面的配额 scene_policy：表示场景防护的配额	page

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	36af3fcc-43d0-441c-86b1-428951dc8225
Quota	object	返回的配额信息。
ManagedRulesGroup	object	WAF 托管规则组相关的配额信息。
Enable	boolean	表示 WAF 托管规则组是否启用。
NumberTotal	WafQuotaInteger	表示允许的 WAF 托管规则组的总数量配额。
List	object	自定义列表相关的配额信息。
Enable	boolean	表示自定义列表是否启用。
NumberTotal	WafQuotaInteger	允许的自定义列表的总数量配额。
NumberItemsTotal	WafQuotaInteger	所有自定义列表中允许的项目总数量配额。
NumberItemsPerList	WafQuotaInteger	每个自定义列表中允许的项目数量配额。
Items	object	包含自定义列表中每种项目类型的配额信息的对象。
	object	自定义列表中项目的配额信息的对象。
Enable	boolean	对应自定义列表项目类型的开关。
Value	WafQuotaString	对应自定义列表中项目类型的格式限制。
Page	object	自定义响应页面相关的配额信息。
Enable	boolean	表示自定义响应页面是否启用。
NumberTotal	WafQuotaInteger	允许的自定义响应页面的总数量配额。
ContentTypes	object	包含自定义响应页面中每种 Content-Type 的配额信息的对象。
	object	自定义响应页面中 Content-Type 配额信息的对象。
Enable	boolean	对应自定义响应页面 Content-Type 类型开关。
ContentLength	WafQuotaInteger	对应自定义响应页面 Content-Type 的内容长度配额。
ScenePolicy	object	场景防护相关的配额信息。
Enable	boolean	表示场景防护功能是否启用。
NumberTotal	WafQuotaInteger	允许的场景防护规则的总数量配额。

示例

正常返回示例

JSON格式

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Quota": {
    "ManagedRulesGroup": {
      "Enable": true,
      "NumberTotal": {
        "Equal": 0,
        "GreaterThan": 0,
        "GreaterThanOrEqual": 0,
        "LessThan": 0,
        "LessThanOrEqual": 0
      }
    },
    "List": {
      "Enable": true,
      "NumberTotal": {
        "Equal": 0,
        "GreaterThan": 0,
        "GreaterThanOrEqual": 0,
        "LessThan": 0,
        "LessThanOrEqual": 0
      },
      "NumberItemsTotal": {
        "Equal": 0,
        "GreaterThan": 0,
        "GreaterThanOrEqual": 0,
        "LessThan": 0,
        "LessThanOrEqual": 0
      },
      "Items": {
        "key": {
          "Enable": true,
          "Value": {
            "Regexp": ""
          }
        }
      }
    },
    "Page": {
      "Enable": true,
      "ContentTypes": {
        "key": {
          "Enable": true
        }
      }
    },
    "ScenePolicy": {
      "Enable": true
    }
  }
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-09-25	OpenAPI 错误码发生变更	查看变更详情
2024-09-18	OpenAPI 错误码发生变更	查看变更详情