全部产品
Search

搜索本产品

    Web 应用防火墙：DescribeApisecRules - 查询API安全策略配置规则

    文档中心

    Web 应用防火墙：DescribeApisecRules - 查询API安全策略配置规则

    更新时间：Nov 15, 2024

    查询API安全策略配置规则。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    WAF 实例的 ID。

    说明 您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。
    		waf_elasticity-cn-0x***
    Typestring是

    规则类型。取值：

    • risk：表示风险检测。
    • event：表示安全事件。
    • sensitive_word：表示敏感数据。
    • auth_flag：表示鉴权凭证。
    • api_tag：表示业务用途。
    • desensitization：表示脱敏。
    • whitelist：表示白名单。
    • recognition：表示接口。
    • offline_api：表示生命周期管理。
    		risk
    Levelstring否

    规则的等级。

    对于风险检测（risk）、安全事件（event），取值：

    • high：表示高危。
    • medium：表示中危。
    • low：表示低危。

    对于敏感数据（sensitive_word），取值：

    • S1：表示 S1 等级。
    • S2：表示 S2 等级。
    • S3：表示 S3 等级。
    • S4：表示 S4 等级。
    		high
    Namestring否

    规则名称。

    		信息泄露
    Originstring否

    规则的来源。取值：

    • custom：表示自定义。
    • default：表示内置。
    		custom
    Statuslong否

    规则的开启状态。取值：

    • 1：表示开启。

    • 0：表示关闭。

    		1
    PageNumberlong否

    分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。

    		1
    PageSizelong否

    分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。

    		10
    RegionIdstring否

    WAF 实例所属地域。取值：

    • cn-hangzhou：表示中国内地。

    • ap-southeast-1：表示非中国内地。

    		cn-hangzhou
    ResourceManagerResourceGroupIdstring否

    阿里云资源组 ID。

    		rg-acfm***q

    返回参数

    名称类型描述示例值
    object

    请求结果。

    TotalCountlong

    返回结果的总数。

    		6
    RequestIdstring

    请求 ID。

    		D7861F61-5B61-46CE-A47C-6B19160D5EB0
    Dataarray<object>

    规则的列表。

    ruleobject

    规则的信息。

    Statuslong

    规则的状态。取值：

    • 1：表示开启。

    • 0：表示关闭。

    		1
    Typestring

    规则类型。取值：

    • risk：表示风险检测。
    • event：表示安全事件。
    • sensitive_word：表示敏感数据。
    • auth_flag：表示鉴权凭证。
    • api_tag：表示业务用途。
    • desensitization：表示脱敏。
    • whitelist：表示白名单。
    • recognition：表示接口。
    • offline_api：表示生命周期管理。
    		risk
    UpdateTimelong

    规则的更新时间，格式为 Unix 时间戳（UTC 时间），单位为秒。

    		1721095301
    Idlong

    规则的 ID。

    		34933
    Rulestring

    规则详情，以一系列参数构造的 JSON 格式转化成字符串。

    		{ "ext": "日期", "regex": "-", "code": "2009", "level": "S1", "origin": "default", "name": "2009" }

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 6,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "Status": 1,
      "Type": "risk",
      "UpdateTime": 1721095301,
      "Id": 34933,
      "Rule": "{\n    \"ext\": \"日期\",\n    \"regex\": \"-\",\n    \"code\": \"2009\",\n    \"level\": \"S1\",\n    \"origin\": \"default\",\n    \"name\": \"2009\"\n}\n"
    }
  ]
}

    错误码

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