文档

DescribeDcdnWafPolicy - 获取单个防护策略信息

更新时间:

调用DescribeDcdnWafPolicy获取指定防护策略详细信息。

接口说明

说明 单用户调用频率:20 次/秒。

调试

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

授权信息

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

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

请求参数

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

防护策略 ID,仅支持单个输入。

1000001

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

66A98669-CC6E-4F3E-80A6-3014697B11AE
Policyobject

防护策略信息。

PolicyStatusstring

防护策略状态,取值:

  • on:开启。

  • off:关闭。

on
DefenseScenestring

防护策略类型,目前支持以下场景:

  • waf_group:Web 基础防护。

  • custom_acl:自定义防护策略。

  • whitelist:白名单。

waf_group
DomainCountinteger

使用该防护策略的域名个数。

22
RuleConfigsstring

该防护策略对应的具体防护规则配置(仅支持 Bot 场景)。具体请参见 BatchCreateDcdnWafRules

{"type":"target_type", "status":"on","config":{"target":"app"},"action":""}
PolicyNamestring

防护策略名称。

policy_test
PolicyIdlong

防护策略 ID。

100001
RuleCountlong

该防护策略下的防护规则个数。

9
GmtModifiedstring

修改时间。日期格式按照 ISO8601 表示法,并使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2021-12-29T17:08:45Z
PolicyTypestring

当前策略是否为默认策略,取值:

  • default:默认策略。

  • custom:非默认策略。

default

示例

正常返回示例

JSON格式

{
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "Policy": {
    "PolicyStatus": "on",
    "DefenseScene": "waf_group",
    "DomainCount": 22,
    "RuleConfigs": "{\"type\":\"target_type\",  \"status\":\"on\",\"config\":{\"target\":\"app\"},\"action\":\"\"}",
    "PolicyName": "policy_test",
    "PolicyId": 100001,
    "RuleCount": 9,
    "GmtModified": "2021-12-29T17:08:45Z",
    "PolicyType": "default"
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.参数错误

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

  • 本页导读 (1)