文档

DescribeDefenseRule - 查询单个防护规则

更新时间:

查询单个防护规则。

调试

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

授权信息

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

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

请求参数

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

WAF 实例 ID。

说明 您可以通过调用 DescribeInstance 接口查看您当前 WAF 实例 ID。
waf_cdnsdf3****
TemplateIdlong

要查询的防护模板 ID。

10318
RuleIdlong

要查询的防护规则 ID。

20026192
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-acfm***q
RegionIdstring

WAF 实例所属地域。取值:

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

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

cn-hangzhou

返回参数

名称类型描述示例值
object

请求结果。

RequestIdstring

请求 ID。

D7861F61-5B61-46CE-A47C-6B19160D5EB0
Ruleobject

规则配置内容,以一系列参数构造的 JSON 格式转化成字符串。

Configstring

防护规则详情,以一系列参数构造的 JSON 格式转化成字符串。更多信息,请参见 CreateDefenseRule防护规则参数描述

{\"status\":1,\"policyId\":1012,\"action\":\"block\"}
DefenseOriginstring

防护来源。取值:

  • custom:用户自定义。

  • system:系统自动生成。

custom
DefenseScenestring

防护场景。更多信息,请参见 CreateDefenseRuleDefenseScene 参数。

waf_group
GmtModifiedlong

防护规则修改时间。

1665196746000
RuleIdlong

防护规则 ID。

2732975
RuleNamestring

防护规则名称。

test1
Statusinteger

防护规则状态。取值:

  • 0:表示关闭。

  • 1:表示开启。

1
TemplateIdlong

防护规则模板 ID。

9114

示例

正常返回示例

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Rule": {
    "Config": "{\\\"status\\\":1,\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
    "DefenseOrigin": "custom",
    "DefenseScene": "waf_group",
    "GmtModified": 1665196746000,
    "RuleId": 2732975,
    "RuleName": "test1",
    "Status": 1,
    "TemplateId": 9114
  }
}

错误码

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

  • 本页导读 (1)