DescribeDomainDetail - 查询CNAME接入详情 - Web 应用防火墙

查询域名接入详情。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance 查询当前 WAF 实例的 ID。	waf_cdnsdf3****
Domain	string	是	要查询的域名名称。	www.aliyundoc.com
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示海外地区。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	CNAME 详情。
RequestId	string	请求 ID。	BAEF9CA9-66A0-533E-BD09-5D5D7AA8****
Domain	string	域名	www.aliyundoc.com
Status	long	域名状态。取值： 1：表示域名处于正常状态。 2：表示域名创建中。 3：表示域名修改中。 4：表示域名释放中。 5：表示域名停止转发。	1
Cname	string	WAF 为域名分配的 CNAME 地址。	xxxxxcvdaf.****.com
Listen	object	配置监听信息。
HttpPorts	array	HTTP 协议的监听端口。
	long	HTTP 协议的监听端口。	80
HttpsPorts	array	HTTPS 协议的监听端口。
	long	HTTPS 协议的监听端口。	443
Http2Enabled	boolean	是否开启 HTTP2。取值： true：表示开启 HTTP2。 false：表示不开启 HTTP2。	true
CertId	long	证书的 ID。	123
TLSVersion	string	TLS 的版本。取值： tlsv1 tlsv1.1 tlsv1.2	tlsv1.2
EnableTLSv3	boolean	是否支持 TLS1.3 版本。取值： true：表示支持 TLS1.3 版本。 false：表示不支持 TLS1.3 版本。	true
CipherSuite	long	加密套件类型。取值： 1：表示添加全部加密套件。 2：表示添加强加密套件。 99：表示添加自定义加密套件。	2
CustomCiphers	array	自定义加密套件。
	string	自定义加密套件。	xxx
FocusHttps	boolean	是否开启 HTTPS 的强制跳转。取值： true：表示开启 HTTPS 的强制跳转。 false：表示不开启 HTTPS 的强制跳转。	true
SM2Enabled	boolean	是否开启国密证书。取值： true：表示开启国密证书。 false：表示不开启国密证书。	true
SM2CertId	string	要添加的国密证书的 ID。仅 SM2Enable 取值为 true 时，使用该参数。	123-cn-hangzhou
SM2AccessOnly	boolean	是否仅客端访问。仅 SM2Enable 取值为 true 时，使用该参数。 true：仅国密客户端才可以访问。 false：国密和非国密均可以访问。	true
XffHeaderMode	long	WAF 获取客户端真实 IP 的方式。取值： 0：表示客户端访问流量到 WAF 前没有经过其他七层代理转发。 1：表示 WAF 读取请求头中 X-Forwarded-For（XFF）字段的第一个值作为客户端 IP。 2：表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP。	2
XffHeaders	array	设置用于获取客户端 IP 的自定义字段列表。
	string	设置用于获取客户端 IP 的自定义字段列表。	Client-ip
IPv6Enabled	boolean	是否开启 IPv6。取值： true：表示开启 IPv6。 false：表示不开启 IPv6。	true
ProtectionResource	string	要使用的防护资源类型。取值： share：表示使用共享集群。 gslb：表示使用共享集群智能负载均衡。	share
ExclusiveIp	boolean	是否开启独享 IP。取值： true：表示开启独享 IP。 false：表示不开启独享 IP。	true
Redirect	object	配置转发信息。
Backends	array<object>	域名对应的回源地址。
	object	源站服务器 IP 或服务器回源域名。
Backend	string	域名对应的源站服务器 IP 或服务器回源域名。	1.1.XX.XX
Loadbalance	string	回源时采用的负载均衡算法。取值： iphash：表示 IP Hash 算法。 roundRobin：表示轮询算法。 leastTime：表示 Least Time 算法。	iphash
FocusHttpBackend	boolean	是否开启强制 HTTP 回源。取值： true：表示开启强制 HTTP 回源。 false：表示不开启强制 HTTP 回源。	true
SniEnabled	boolean	是否开启回源 SNI。取值： true：表示开启回源 SNI。 false（默认）：表示不开启回源 SNI。	true
SniHost	string	设置自定义 SNI 扩展字段的值。	www.aliyundoc.com
RequestHeaders	array<object>	域名的流量标记字段和值，用于标记经过 WAF 处理的流量。
	object	域名的流量标记字段和值，用于标记经过 WAF 处理的流量。
Key	string	指定的自定义请求头部字段。	aaa
Value	string	指定的自定义请求头部字段设定的值。	bbb
ConnectTimeout	integer	连接超时时长。单位：秒。取值范围：5~120。	120
WriteTimeout	integer	写超时时长，单位：秒。取值范围：5~1800。	200
ReadTimeout	integer	读超时时长，单位：秒。取值范围：5~1800。	200
Keepalive	boolean	是否保持长连接。取值： true（默认）：表示保持长连接。 false：表示不保持长连接。	true
Retry	boolean	WAF 回源失败时，是否重试。取值： true（默认）：表示重试。 false：表示不重试。	true
KeepaliveRequests	integer	复用长连接的请求个数。取值范围：60~1000，单位：个。说明开启长连接后，复用多少个长连接。	1000
KeepaliveTimeout	integer	空闲长连接超时时间，取值范围：1~60，默认 15，单位：秒。说明复用的长连接空闲多长时间后释放。	15
XffProto	boolean	X-Forward-For-Proto 传递 WAF 的协议。取值： true（默认）：表示传递 WAF 的协议。 false：表示不传递 WAF 的协议。	true
ResourceManagerResourceGroupId	string	阿里云资源组 ID。	rg-acfm***q
CertDetail	object	SSL 证书详情。
Name	string	证书名称	test-cert-name
Id	string	SSL 证书 ID	123-cn-hangzhou
StartTime	long	证书生效时间，格式为 Unix 时间戳（UTC 时间），单位为毫秒。	1677772800000
EndTime	long	证书到期时间，格式为 Unix 时间戳（UTC 时间），单位为毫秒。	1685590400000
CommonName	string	通用名称（CN）	test.aliyundoc.com
Sans	array	证书绑定的所有域名。
	string	证书绑定的所有域名。	www.aliyundoc.com
SM2CertDetail	object	国密证书信息
Name	string	证书名称	test-sm2-cert-name
Id	string	SSL 证书 ID	123-cn-hangzhou
StartTime	long	证书生效时间，格式为 Unix 时间戳（UTC 时间），单位为毫秒。	1657551525000
EndTime	long	证书到期时间，格式为 Unix 时间戳（UTC 时间），单位为毫秒。	1665590400000
CommonName	string	通用名称（CN）	test.aliyundoc.com
Sans	array	证书绑定的所有域名。
	string	证书绑定的所有域名。	www.aliyundoc.com

示例

正常返回示例

JSON格式

{
  "RequestId": "BAEF9CA9-66A0-533E-BD09-5D5D7AA8****",
  "Domain": "www.aliyundoc.com",
  "Status": 1,
  "Cname": "xxxxxcvdaf.****.com",
  "Listen": {
    "HttpPorts": [
      80
    ],
    "HttpsPorts": [
      443
    ],
    "Http2Enabled": true,
    "CertId": 123,
    "TLSVersion": "tlsv1.2",
    "EnableTLSv3": true,
    "CipherSuite": 2,
    "CustomCiphers": [
      "xxx"
    ],
    "FocusHttps": true,
    "SM2Enabled": true,
    "SM2CertId": "123-cn-hangzhou",
    "SM2AccessOnly": true,
    "XffHeaderMode": 2,
    "XffHeaders": [
      "Client-ip"
    ],
    "IPv6Enabled": true,
    "ProtectionResource": "share",
    "ExclusiveIp": true
  },
  "Redirect": {
    "Backends": [
      {
        "Backend": "1.1.XX.XX"
      }
    ],
    "Loadbalance": "iphash",
    "FocusHttpBackend": true,
    "SniEnabled": true,
    "SniHost": "www.aliyundoc.com",
    "RequestHeaders": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ],
    "ConnectTimeout": 120,
    "WriteTimeout": 200,
    "ReadTimeout": 200,
    "Keepalive": true,
    "Retry": true,
    "KeepaliveRequests": 1000,
    "KeepaliveTimeout": 15,
    "XffProto": true
  },
  "ResourceManagerResourceGroupId": "rg-acfm***q",
  "CertDetail": {
    "Name": "test-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1677772800000,
    "EndTime": 1685590400000,
    "CommonName": "test.aliyundoc.com",
    "Sans": [
      "www.aliyundoc.com"
    ]
  },
  "SM2CertDetail": {
    "Name": "test-sm2-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1657551525000,
    "EndTime": 1665590400000,
    "CommonName": "test.aliyundoc.com\n",
    "Sans": [
      "www.aliyundoc.com\n"
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-06-06	OpenAPI 返回结构发生变更	查看变更详情
2024-01-30	OpenAPI 返回结构发生变更	查看变更详情
2023-04-27	OpenAPI 返回结构发生变更	查看变更详情
2023-04-18	OpenAPI 返回结构发生变更	查看变更详情