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

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDcdnWafPolicyValidDomains

系统规定参数。取值:DescribeDcdnWafPolicyValidDomains

DefenseScene String custom_acl

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

  • waf_group:Web基础防护
  • custom_acl:自定义防护策略
  • whitelist:白名单
  • ip_blacklist:IP黑名单。
  • region_block:区域封禁。
  • bot:Bot管理。
DomainNameLike String example.com

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

PageNumber Integer 1

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

PageSize Integer 20

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

返回数据

名称 类型 示例值 描述
PageSize Integer 20

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

RequestId String 153ca2cd-3c01-44be-52c6-64dbc6c88630

请求ID。

PageNumber Integer 1

页码,同请求参数的PageNumber。

TotalCount Integer 2

查询到的域名总数。

Domains Array of DomainItem

防护域名列表。

PolicyName String test1

防护策略名称。

PolicyId Long 1000001

防护策略ID。

DomainName String example.com

防护域名。

PolicyType String default

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

  • default:默认
  • custom:非默认

示例

请求示例

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnWafPolicyValidDomains
&DefenseScene=custom_acl
&DomainNameLike=example.com
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDcdnWafPolicyValidDomainsResponse>
    <RequestId>153ca2cd-3c01-44be-52c6-64dbc6c88630</RequestId>
    <TotalCount>2</TotalCount>
    <Domains>
        <DomainName>example.com</DomainName>
        <PolicyId>1000001</PolicyId>
        <PolicyName>test1</PolicyName>
        <PolicyType>default</PolicyType>
    </Domains>
    <Domains>
        <DomainName>example2.com</DomainName>
        <PolicyId>1000002</PolicyId>
        <PolicyName>test2</PolicyName>
        <PolicyType>custom</PolicyType>
    </Domains>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
</DescribeDcdnWafPolicyValidDomainsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "153ca2cd-3c01-44be-52c6-64dbc6c88630",
  "TotalCount" : 2,
  "Domains" : [ {
    "DomainName" : "example.com",
    "PolicyId" : 1000001,
    "PolicyName" : "test1",
    "PolicyType" : "default"
  }, {
    "DomainName" : "example2.com",
    "PolicyId" : 1000002,
    "PolicyName" : "test2",
    "PolicyType" : "custom"
  } ],
  "PageNumber" : 1,
  "PageSize" : 20
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter The specified parameter is invalid. 无效的参数值。

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