文档

DescribeDomain

调用DescribeDomain查询已添加到WAF防护的域名的配置信息。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action

String

DescribeDomain

要执行的动作。取值:DescribeDomain

Domain

String

www.example.com

要查询的域名名称。

说明

您可以调用DescribeDomainNames查询所有已添加到WAF防护的域名。

InstanceId

String

waf-cn-7pp26f1****

WAF实例的ID。

说明

您可以调用DescribeInstanceInfo查询当前WAF实例的ID。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称

类型

示例值

描述

RequestId

String

D827FCFE-90A7-4330-9326-D33C8B4C7726

本次请求的ID。

Domain

Struct

域名的配置信息。

AccessHeaderMode

Integer

1

WAF获取客户端真实IP的方式。取值:

  • 0:表示WAF读取请求头中X-Forwarded-For(XFF)字段的第一个值作为客户端IP。

  • 1:表示WAF读取请求头中由您设置的自定义字段值作为客户端IP。

说明

仅当IsAccessProduct取值为1(表示WAF前有其他七层代理服务)时,返回该参数。

AccessHeaders

List

["X-Client-IP"]

用于获取客户端IP的自定义字段列表。

说明

仅当AccessHeaderMode取值为1(表示WAF读取请求头中由您设置的自定义字段值作为客户端IP)时,返回该参数。

AccessType

String

waf-cloud-dns

域名接入方式。取值:

  • waf-cloud-dns:表示CNAME接入。

  • waf-cloud-native:表示透明接入。

CloudNativeInstances

Array of CloudNativeInstances

透明接入的配置列表。

说明

仅当AccessType取值为waf-cloud-native(表示域名使用透明接入方式接入WAF)时,返回该参数。

CloudNativeProductName

String

ALB

云产品实例的类型。取值:

  • SLB:表示传统型负载均衡CLB(原SLB)实例。

  • ECS:表示云服务器ECS实例。

  • ALB:表示应用型负载均衡ALB实例。

IPAddressList

String

["39.XX.XX.197"]

云产品实例的公网IP地址列表。

InstanceId

String

alb-s65nua68wdedsp****

云产品实例的ID。

ProtocolPortConfigs

Array of ProtocolPortConfigs

协议及端口配置列表。

Ports

String

[80]

端口列表。

Protocol

String

http

协议类型。取值:

  • http:表示HTTP协议。

  • https:表示HTTPS协议。

RedirectionTypeName

String

ALB

引流端口的类型。取值:

  • SLB-L4:表示从传统型负载均衡CLB(原SLB)实例的四层监听端口引流到WAF进行防护。

  • SLB-L7:表示从传统型负载均衡CLB(原SLB)实例的七层监听端口引流到WAF进行防护。

  • ECS:表示从云服务器ECS实例的监听端口引流到WAF进行防护。

  • ALB:表示从应用型负载均衡ALB实例的HTTP、HTTPS监听端口引流到WAF进行防护。

ClusterType

Integer

0

WAF实例对应的集群类型。取值:

  • 0:表示物理集群。

  • 1:表示虚拟集群,即WAF独享集群。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

Cname

String

kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com

WAF为域名分配的CNAME地址。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

ConnectionTime

Integer

5

WAF集群的连接超时时长。单位:秒。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

Http2Port

List

[443,8443]

HTTP 2.0端口列表。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)且HttpsPort取值不为空(表示域名使用HTTPS协议)时,返回该参数。

HttpPort

List

[80]

HTTP端口列表。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

HttpToUserIp

Integer

0

是否开启了HTTP回源功能。取值:

  • 0:表示未开启。

  • 1:表示已开启。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)且HttpsPort取值不为空(表示域名使用HTTPS协议)时,返回该参数。

HttpsPort

List

[443,8443]

HTTPS端口列表。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

HttpsRedirect

Integer

0

是否开启了HTTPS强制跳转。取值:

  • 0:表示未开启。

  • 1:表示已开启。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)且HttpsPort取值不为空(表示域名使用HTTPS协议)时,返回该参数。

IpFollowStatus

Integer

1

是否开启了IPv4/IPv6回源协议跟随。取值:

  • 0:表示未开启。

  • 1:表示已开启。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

IsAccessProduct

Integer

1

域名在WAF前是否配置有其他七层代理(例如高防、CDN等),即客户端访问流量到WAF前是否有经过其他七层代理转发。取值:

  • 0:表示否。

  • 1:表示是。

LoadBalancing

Integer

2

回源时采用的负载均衡算法。取值:

  • 0:表示IP Hash算法。

  • 1:表示轮询算法。

  • 2:表示Least Time算法。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

LogHeaders

Array of LogHeader

域名的流量标记字段和值,用于标记经过WAF处理的流量。

说明

仅当域名开启了流量标记功能时,返回该参数。

k

String

ALIWAF-TAG

流量标记字段的名称。

v

String

Yes

流量标记字段的值。

ReadTime

Integer

120

WAF集群的读连接超时时长。单位:秒。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

ResourceGroupId

String

rg-acfm2mkrunv****

WAF实例所属资源组ID。

SniHost

String

waf.example.com

SNI扩展字段的自定义值。取值为空表示未自定义SNI值,默认使用请求头中Host字段的值作为SNI扩展字段的值。

说明

仅在SniStatus取值为1(表示开启SNI回源)时,返回该参数。

SniStatus

Integer

1

是否开启了回源SNI。回源SNI表示WAF转发客户端请求到源站服务器,在与源站进行TLS握手时,通过SNI扩展字段(Server Name Indicator extension)指定要访问的主机,并与该主机建立HTTPS连接。取值:

  • 0:表示未开启。

  • 1:表示已开启。

说明

仅在AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式)且HttpsPort取值不为空(表示域名使用HTTPS协议)时,返回该参数。

SourceIps

List

["39.XX.XX.197"]

源站服务器地址。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

Version

Long

40

当前域名配置的版本。

WriteTime

Integer

120

WAF集群的写连接超时时长。单位:秒。

说明

仅当AccessType取值为waf-cloud-dns(表示域名使用CNAME接入方式接入WAF)时,返回该参数。

Retry

Boolean

true

WAF回源失败时,是否重试。取值:

  • true(默认):表示重试。

  • false:表示不重试。

Keepalive

Boolean

true

是否保持长连接。取值:

  • true(默认):表示保持长连接。

  • false:表示不保持长连接。

KeepaliveRequests

Integer

1000

复用长连接的请求个数。取值范围:60~1000,单位:个。

说明

开启长连接后,复用多少个长连接。

KeepaliveTimeout

Integer

15

空闲长连接超时时间,取值范围:1~60,默认15,单位:秒。

说明

复用的长连接空闲多长时间后释放。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDomain
&Domain=www.example.com
&InstanceId=waf-cn-7pp26f1****
&<公共请求参数>

正常返回示例

XML格式

<DescribeDomainResponse>
	  <RequestId>D827FCFE-90A7-4330-9326-D33C8B4C7726</RequestId>
	  <Domain>
		    <HttpToUserIp>0</HttpToUserIp>
		    <HttpPort>80</HttpPort>
		    <IsAccessProduct>1</IsAccessProduct>
		    <AccessHeaderMode>1</AccessHeaderMode>
		    <ResourceGroupId>rg-acfm2mkrunv****</ResourceGroupId>
		    <AccessHeaders>X-Client-IP</AccessHeaders>
		    <ReadTime>120</ReadTime>
		    <SourceIps>39.XX.XX.197</SourceIps>
		    <IpFollowStatus>1</IpFollowStatus>
		    <ClusterType>0</ClusterType>
		    <LoadBalancing>2</LoadBalancing>
		    <Cname>kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com</Cname>
		    <LogHeaders>
			      <v>Yes</v>
			      <k>ALIWAF-TAG</k>
		    </LogHeaders>
		    <WriteTime>120</WriteTime>
		    <Http2Port>443</Http2Port>
		    <Http2Port>8443</Http2Port>
		    <Version>40</Version>
		    <HttpsRedirect>0</HttpsRedirect>
		    <ConnectionTime>5</ConnectionTime>
		    <AccessType>waf-cloud-dns</AccessType>
		    <HttpsPort>443</HttpsPort>
		    <HttpsPort>8443</HttpsPort>
        <Keepalive>true</Keepalive>
        <KeepaliveTimeout>15</KeepaliveTimeout>
        <Retry>true</Retry>
        <KeepaliveRequests>1000</KeepaliveRequests>
	  </Domain>
</DescribeDomainResponse>

JSON格式

{
  "RequestId": "D827FCFE-90A7-4330-9326-D33C8B4C7726",
  "Domain": {
    "HttpToUserIp": 0,
    "HttpPort": [
      80
    ],
    "IsAccessProduct": 1,
    "AccessHeaderMode": 1,
    "ResourceGroupId": "rg-acfm2mkrunv****",
    "AccessHeaders": [
      "X-Client-IP"
    ],
    "ReadTime": 120,
    "SourceIps": [
      "39.XX.XX.197"
    ],
    "IpFollowStatus": 1,
    "ClusterType": 0,
    "LoadBalancing": 2,
    "Cname": "kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com",
    "LogHeaders": [
      {
        "v": "Yes",
        "k": "ALIWAF-TAG"
      }
    ],
    "WriteTime": 120,
    "Http2Port": [
      443,
      8443
    ],
    "Version": 40,
    "HttpsRedirect": 0,
    "ConnectionTime": 5,
    "AccessType": "waf-cloud-dns",
    "HttpsPort": [
      443,
      8443
    ],
    "Keepalive": true,
    "KeepaliveTimeout": 15,
    "SniStatus": 0,
    "Retry": true,
    "KeepaliveRequests": 1000
  }
}

错误码

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

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