DescribeDomain - 获取已添加的域名配置信息_Web应用防火墙(WAF)-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeDomain	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstanceInfo 查询当前 WAF 实例的 ID。	waf-cn-7pp26f1****
Domain	string	是	要查询的域名名称。说明您可以调用 DescribeDomainNames 查询所有已添加到 WAF 防护的域名。	www.example.com
ResourceGroupId	string	否	资源组 ID。	rg-acfm2pz25js****
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou

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

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	D827FCFE-90A7-4330-9326-D33C8B4C7726
Domain	object	域名的配置信息。
HttpToUserIp	integer	是否开启了 HTTP 回源功能。取值： 0：表示未开启。 1：表示已开启。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）且 HttpsPort 取值不为空（表示域名使用 HTTPS 协议）时，返回该参数。	0
SniStatus	integer	是否开启了回源 SNI。回源 SNI 表示 WAF 转发客户端请求到源站服务器，在与源站进行 TLS 握手时，通过 SNI 扩展字段（Server Name Indicator extension）指定要访问的主机，并与该主机建立 HTTPS 连接。取值： 0：表示未开启。 1：表示已开启。说明仅在 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式）且 HttpsPort 取值不为空（表示域名使用 HTTPS 协议）时，返回该参数。	1
IsAccessProduct	integer	域名在 WAF 前是否配置有其他七层代理（例如高防、CDN 等），即客户端访问流量到 WAF 前是否有经过其他七层代理转发。取值： 0：表示否。 1：表示是。	1
AccessHeaderMode	integer	WAF 获取客户端真实 IP 的方式。取值： 0：表示 WAF 读取请求头中 X-Forwarded-For（XFF）字段的第一个值作为客户端 IP。 1：表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP。说明仅当 IsAccessProduct 取值为 1（表示 WAF 前有其他七层代理服务）时，返回该参数。	1
HttpsRedirect	integer	是否开启了 HTTPS 强制跳转。取值： 0：表示未开启。 1：表示已开启。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）且 HttpsPort 取值不为空（表示域名使用 HTTPS 协议）时，返回该参数。	0
IpFollowStatus	integer	是否开启了 IPv4/IPv6 回源协议跟随。取值： 0：表示未开启。 1：表示已开启。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。	1
LoadBalancing	integer	回源时采用的负载均衡算法。取值： 0：表示 IP Hash 算法。 1：表示轮询算法。 2：表示 Least Time 算法。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。	2
AccessType	string	域名接入方式。取值： waf-cloud-dns：表示 CNAME 接入。 waf-cloud-native：表示透明接入。	waf-cloud-dns
Version	long	当前域名配置的版本。	40
ClusterType	integer	WAF 实例对应的集群类型。取值： 0：表示物理集群。 1：表示虚拟集群，即 WAF 独享集群。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。	0
ReadTime	integer	WAF 集群的读连接超时时长。单位：秒。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。	120
WriteTime	integer	WAF 集群的写连接超时时长。单位：秒。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。	120
SniHost	string	SNI 扩展字段的自定义值。取值为空表示未自定义 SNI 值，默认使用请求头中 Host 字段的值作为 SNI 扩展字段的值。说明仅在 SniStatus 取值为 1（表示开启 SNI 回源）时，返回该参数。	waf.example.com
ResourceGroupId	string	WAF 实例所属资源组 ID。	rg-acfm2mkrunv****
Cname	string	WAF 为域名分配的 CNAME 地址。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。	kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com
ConnectionTime	integer	WAF 集群的连接超时时长。单位：秒。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。	5
LogHeaders	object []	域名的流量标记字段和值，用于标记经过 WAF 处理的流量。说明仅当域名开启了流量标记功能时，返回该参数。
k	string	流量标记字段的名称。	ALIWAF-TAG
v	string	流量标记字段的值。	Yes
CloudNativeInstances	object []	透明接入的配置列表。说明仅当 AccessType 取值为waf-cloud-native（表示域名使用透明接入方式接入 WAF）时，返回该参数。
RedirectionTypeName	string	引流端口的类型。取值： SLB-L4：表示从传统型负载均衡 CLB（原 SLB）实例的四层监听端口引流到 WAF 进行防护。 SLB-L7：表示从传统型负载均衡 CLB（原 SLB）实例的七层监听端口引流到 WAF 进行防护。 ECS：表示从云服务器 ECS 实例的监听端口引流到 WAF 进行防护。 ALB：表示从应用型负载均衡 ALB 实例的 HTTP、HTTPS 监听端口引流到 WAF 进行防护。	ALB
CloudNativeProductName	string	云产品实例的类型。取值： SLB：表示传统型负载均衡 CLB（原 SLB）实例。 ECS：表示云服务器 ECS 实例。 ALB：表示应用型负载均衡 ALB 实例。	ALB
InstanceId	string	云产品实例的 ID。	alb-s65nua68wdedsp****
IPAddressList	array	云产品实例的公网 IP 地址列表。
	string	云产品实例的公网 IP 地址。	39.XX.XX.197
ProtocolPortConfigs	object []	协议及端口配置列表。
Ports	array	端口列表。
	integer	端口。	80
Protocol	string	协议类型。取值： http：表示 HTTP 协议。 https：表示 HTTPS 协议。	http
HttpPort	array	HTTP 端口列表。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。
	integer	HTTP 端口。	80
Http2Port	array	HTTP 2.0 端口列表。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）且 HttpsPort 取值不为空（表示域名使用 HTTPS 协议）时，返回该参数。
	integer	HTTP 2.0 端口。	8443
SourceIps	array	源站服务器地址。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。
	string	源站服务器地址。	39.XX.XX.197
HttpsPort	array	HTTPS 端口列表。说明仅当 AccessType 取值为waf-cloud-dns（表示域名使用 CNAME 接入方式接入 WAF）时，返回该参数。
	integer	HTTPS 端口。	443
AccessHeaders	array	用于获取客户端 IP 的自定义字段列表。说明仅当 AccessHeaderMode 取值为 1（表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP）时，返回该参数。
	string	用于获取客户端 IP 的自定义字段。	X-Client-IP
Retry	boolean	WAF 回源失败时，是否重试。取值： true：表示重试。 false：表示不重试。	false
Keepalive	boolean	是否保持长连接。取值： true：表示保持长连接。 false：表示不保持长连接。	true
KeepaliveRequests	integer	复用长连接的请求个数。取值范围：60~1000，单位：个。说明开启长连接后，复用多少个长连接。	1000
KeepaliveTimeout	integer	空闲长连接超时时间，取值范围：1~60，默认 15，单位：秒。说明复用的长连接空闲多少长后释放。	15

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-08-22

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-05-23

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。