调用DescribeDcdnWafPolicyValidDomains查询可被自定义防护策略绑定的域名列表。
使用说明
单用户调用频率:20次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDcdnWafPolicyValidDomains | 系统规定参数。取值:DescribeDcdnWafPolicyValidDomains。 |
DefenseScene | String | 是 | custom_acl | WAF防护策略类型,目前支持以下场景:
|
DomainNameLike | String | 否 | example.com | 防护域名,支持模糊查询。 |
PageNumber | Integer | 否 | 1 | 页码。取值范围为:1~100000。默认值为1。 |
PageSize | Integer | 否 | 20 | 每页显示的域名个数,默认值20,取值范围:1~500之间的任意整数。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 20 | 每页显示的域名个数,同请求参数的PageSize。 |
RequestId | String | 3C6CCEC4-6B88-4D4A-93E4-D47B3D92C630 | 请求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 | 是否为默认防护策略,取值:
|
Policies | Array of Policy | 域名所绑定的策略。 |
|
Id | Long | 10000002 | 策略ID。 |
Name | String | test2 | 策略名称。 |
Type | String | 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>
<PageSize>20</PageSize>
<RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92C630</RequestId>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<Domains>
<PolicyName>test1</PolicyName>
<PolicyId>1000001</PolicyId>
<DomainName>example.com</DomainName>
<PolicyType>default</PolicyType>
<Policies>
<Id>10000002</Id>
<Name>test2</Name>
<Type>custom</Type>
</Policies>
</Domains>
</DescribeDcdnWafPolicyValidDomainsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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"
} ]
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 无效的参数值。 |
访问错误中心查看更多错误码。