调用DescribeDomain接口获取已添加的域名配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDomain |
要执行的动作。取值:DescribeDomain。 |
Domain | String | 是 | www.example.com |
已添加的域名名称。 |
InstanceId | String | 是 | waf_elasticity-cn-0xldbqt**** |
WAF实例ID。 说明 您可以通过调用DescribeInstanceInfo接口查看当前WAF实例ID。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | Struct |
域名配置信息。 |
|
ClusterType | Integer | 0 |
WAF实例的集群类别,取值:
|
Cname | String | xxxxxx.yundunwaf3.com |
WAF实例为该域名配置记录所分配的CNAME。 |
ConnectionTime | Integer | 5 |
WAF独享集群连接超时时长,单位:秒。 |
Http2Port | List | [443] |
HTTP 2.0端口。 |
HttpPort | List | [80] |
HTTP端口。 |
HttpToUserIp | Integer | 0 |
是否开启HTTP回源功能,开启后HTTPS访问请求将通过HTTP协议转发回源站,默认回源端口为80端口:
|
HttpsPort | List | [443] |
HTTPS端口。 |
HttpsRedirect | Integer | 0 |
是否开启HTTPS强制跳转:
|
IsAccessProduct | Integer | 0 |
该域名在WAF前是否配置有七层代理(例如,高防、CDN等),即客户端访问流量到WAF前是否有经过其它七层代理转发:
|
LoadBalancing | Integer | 0 |
回源时采用的负载均衡算法:
|
LogHeaders | Array |
域名的流量标记字段和值,用于标记经过WAF的流量。 |
|
k | String | wafmark |
字段名称。 |
v | String | test |
字段值。 |
ReadTime | Integer | 120 |
WAF独享集群读连接超时时长,单位:秒。 |
ResourceGroupId | String | rg-atstuj3rtop**** |
资源组ID。 |
SourceIps | List | [1.1.1.1,2.2.2.2] |
源站服务器IP地址。 |
Version | Long | 0 |
系统数据版本标识,用于实现乐观锁控制。 |
WriteTime | Integer | 120 |
WAF独享集群写连接超时时长,单位:秒。 |
RequestId | String | D7861F61-5B61-46CE-A47C-6B19160D5EB0 |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeDomain
&Domain=www.example.com
&InstanceId=waf_elasticity-cn-0xldbqt****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeDomainResponse>
<Domain>
<HttpPort>80</HttpPort>
<HttpToUserIp>0</HttpToUserIp>
<WriteTime>120</WriteTime>
<IsAccessProduct>0</IsAccessProduct>
<Http2Port>443</Http2Port>
<Version>0</Version>
<HttpsRedirect>0</HttpsRedirect>
<SourceIps>1.1.1.1</SourceIps>
<SourceIps>2.2.2.2</SourceIps>
<ConnectionTime>5</ConnectionTime>
<Cname>xxxxxx.yundunwaf3.com</Cname>
<LoadBalancing>0</LoadBalancing>
<HttpsPort>443</HttpsPort>
<LogHeaders>
<k>wafmark</k>
<v>test</v>
</LogHeaders>
<ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
<ReadTime>120</ReadTime>
</Domain>
<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</DescribeDomainResponse>
JSON
格式
{
"Domain": {
"HttpPort": [
80
],
"HttpToUserIp": 0,
"WriteTime": 120,
"IsAccessProduct": 0,
"Http2Port": [
443
],
"Version": 0,
"HttpsRedirect": 0,
"SourceIps": [
"1.1.1.1",
"2.2.2.2"
],
"ConnectionTime": 5,
"Cname": "xxxxxx.yundunwaf3.com",
"LoadBalancing": 0,
"HttpsPort": [
443
],
"LogHeaders": {
"k": "wafmark",
"v": "test"
},
"ResourceGroupId": "rg-atstuj3rtop****",
"ReadTime": 120
},
"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交