文档

DescribeDcdnWafPolicyValidDomains - 查询可被自定义防护策略绑定的域名

更新时间:

调用DescribeDcdnWafPolicyValidDomains查询可被自定义防护策略绑定的域名列表。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

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

  • waf_group:Web 基础防护

  • custom_acl:自定义防护策略

  • whitelist:白名单

  • ip_blacklist:IP 黑名单。

  • region_block:区域封禁。

  • bot:Bot 管理。

custom_acl
DomainNameLikestring

防护域名,支持模糊查询。

example.com
PageNumberinteger

页码。取值范围为:1~100000。默认值为 1

1
PageSizeinteger

每页显示的域名个数,默认值 20,取值范围:1~500 之间的任意整数。

20

返回参数

名称类型描述示例值
object
PageSizeinteger

每页显示的域名个数,同请求参数的 PageSize。

20
RequestIdstring

请求 ID。

3C6CCEC4-6B88-4D4A-93E4-D47B3D92C630
PageNumberinteger

页码,同请求参数的 PageNumber。

1
TotalCountinteger

查询到的域名总数。

2
Domainsobject []

防护域名列表。

PolicyNamestring

防护策略名称。

test1
PolicyIdlong

防护策略 ID。

1000001
DomainNamestring

防护域名。

example.com
PolicyTypestring

是否为默认防护策略,取值:

  • default:默认

  • custom:非默认

default
Policiesobject []

域名所绑定的策略。

Idlong

策略 ID。

10000002
Namestring

策略名称。

test2
Typestring

策略类型。

custom

示例

正常返回示例

JSON格式

{
  "PageSize": 20,
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92C630",
  "PageNumber": 1,
  "TotalCount": 2,
  "Domains": [
    {
      "PolicyName": "test1",
      "PolicyId": 1000001,
      "DomainName": "example.com",
      "PolicyType": "default",
      "Policies": [
        {
          "Id": 10000002,
          "Name": "test2",
          "Type": "custom"
        }
      ]
    }
  ]
}

错误码

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

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

  • 本页导读 (1)
文档反馈