Web Application Firewall:DescribeDomainDetail - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Queries the details of a Website Config.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeDomainDetail

get

DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}-waf

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call DescribeInstance to query the ID of the current WAF instance.	waf_cdnsdf3****
DomainId	string	No	The domain name ID.	www.aliyundoc.com-waf
Domain	string	No	The domain name to query.	www.aliyundoc.com
RegionId	string	No	The region where the WAF instance resides. Valid values:	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The CNAME details.
RequestId	string	The request ID.	BAEF9CA9-66A0-533E-BD09-5D5D7AA8****
Domain	string	The domain name.	www.aliyundoc.com
DomainId	string	The domain name ID.	www.aliyundoc.com-waf
Status	integer	The domain name status. Valid values:	1
Cname	string	The CNAME assigned by WAF to the domain name.	xxxxxcvdaf.****.com
Listen	object	The listener configuration.
HttpPorts	array	The listening port for the HTTP protocol.
	integer	The listening port for the HTTP protocol.	80
HttpsPorts	array	The listening port for the HTTPS protocol.
	integer	The listening port for the HTTPS protocol.	443
Http2Enabled	boolean	Indicates whether HTTP/2 is enabled. Valid values: true: HTTP/2 is enabled. false: HTTP/2 is not enabled.	true
CertId	string	The ID of the certificate.	123
TLSVersion	string	The TLS version. Valid values: tlsv1: Supports TLS 1.0 and later. Provides the highest compatibility and the lowest security. tlsv1.1: Supports TLS 1.1 and later. Provides good compatibility and good security. tlsv1.2: Supports TLS 1.2 and later. Provides good compatibility and the highest security. tlsv1.3: Supports only TLS 1.3. Provides the highest security and the lowest compatibility.	tlsv1.2
EnableTLSv3	boolean	Indicates whether TLS 1.3 is supported. Valid values:	true
CipherSuite	integer	The type of the cipher suite. Valid values:	2
CustomCiphers	array	The custom cipher suites.
	string	The custom cipher suites.	ECDHE-ECDSA-AES256-SHA384
FocusHttps	boolean	Indicates whether HTTPS forced redirect is enabled. Valid values:	true
SM2Enabled	boolean	Indicates whether the China Encryption Standard (SM) certificate is enabled. Valid values:	true
SM2CertId	string	The ID of the China Encryption Standard (SM) certificate to add. This parameter is used only when SM2Enable is set to true.	123-cn-hangzhou
SM2AccessOnly	boolean	Indicates whether only SM client access is allowed. This parameter is used only when SM2Enable is set to true.	true
XffHeaderMode	integer	The method that WAF uses to obtain the originating IP address of the client. Valid values: 0: The client access traffic is not forwarded by other Layer 7 proxies before reaching WAF. 1: WAF reads the first value in the X-Forwarded-For (XFF) header field of the request as the client IP address. 2: WAF reads the value of a custom header field that you specify in the request as the client IP address. 3: WAF reads the Client IP from the Proxy Protocol header as the client IP address.	2
XffHeaders	array	The custom header fields used to obtain the client IP address.
	string	The custom header fields used to obtain the client IP address.	Client-ip
IPv6Enabled	boolean	Indicates whether IPv6 is enabled. Valid values: true: IPv6 is enabled. false: IPv6 is not enabled.	true
ProtectionResource	string	The type of protection resource to use. Valid values:	share
ExclusiveIp	boolean	Indicates whether an exclusive IP address is enabled. Valid values: true: An exclusive IP address is enabled. false: An exclusive IP address is not enabled.	true
HstsIncludeSubDomain	boolean	Indicates whether HSTS includes subdomains. Valid values: true: Enabled. false: Not enabled.
HstsPreload	boolean	Indicates whether HSTS preloading is enabled. This feature is disabled by default. Valid values:	false
HstsMaxAge	integer	The HSTS expiration time. Unit: seconds.	365000
Redirect	object	The forwarding configuration.
Backends `deprecated`	array<object>	The back-to-origin addresses of the domain name.
	object	The IP address or domain name of the origin server.
Backend	string	The IP address or domain name of the origin server for the domain name.	1.1.XX.XX
Loadbalance	string	The load balancing algorithm used for back-to-origin requests. Valid values: iphash: IP Hash algorithm. roundRobin: round-robin algorithm. leastTime: Least Time algorithm.	iphash
FocusHttpBackend	boolean	Indicates whether forced HTTP back-to-origin is enabled. Valid values: true: Forced HTTP back-to-origin is enabled. false: Forced HTTP back-to-origin is not enabled.	true
SniEnabled	boolean	Indicates whether Server Name Indication (SNI) is enabled for back-to-origin requests. Valid values: true: SNI is enabled for back-to-origin requests. false (default): SNI is not enabled for back-to-origin requests.	true
SniHost	string	The value of the custom SNI extension field.	www.aliyundoc.com
RequestHeaders	array<object>	The traffic tag fields and values of the domain name, which are used to tag traffic processed by WAF.
	object	The traffic tag fields and values of the domain name, which are used to tag traffic processed by WAF.
Key	string	The custom request header field.	aaa
Value	string	The value of the custom request header field.	bbb
ConnectTimeout	integer	The connection timeout period. Unit: seconds.	120
WriteTimeout	integer	The write timeout period. Unit: seconds.	200
ReadTimeout	integer	The read timeout period. Unit: seconds.	200
Keepalive	boolean	Specifies whether to keep the connection alive. Valid values: true (default): The connection is kept alive. false: The connection is not kept alive.	true
Retry	boolean	Specifies whether to retry when WAF fails to forward requests to the origin server. Valid values: true (default): Retry. false: Do not retry.	true
KeepaliveRequests	integer	The number of requests that reuse a persistent connection. Valid values: 60 to 1000.	1000
KeepaliveTimeout	integer	The idle timeout period for persistent connections. Valid values: 1 to 60. Default value: 15. Unit: seconds.	15
XffProto	boolean	Indicates whether X-Forward-For-Proto is used to pass the protocol used by WAF. Valid values:	true
BackupBackends `deprecated`	array<object>	The secondary origin addresses of the domain name. Note This parameter is about to be deprecated. Use BackUpBackendList to obtain the related information.
	object	The IP address or domain name of the origin server.
Backend	string	The IP address or domain name of the secondary origin server for the domain name.	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	Specifies whether WAF is allowed to overwrite X-Client-IP. Valid values: true (default): WAF is allowed to overwrite the header. false: WAF is not allowed to overwrite the header.	true
XTrueIp	boolean	Specifies whether WAF is allowed to overwrite the X-True-IP header. Valid values: true (default): WAF is allowed to overwrite the header. false: WAF is not allowed to overwrite the header.	true
WebServerType	boolean	Specifies whether WAF is allowed to overwrite the Web-Server-Type header. Valid values: true (default): WAF is allowed to overwrite the header. false: WAF is not allowed to overwrite the header.	true
WLProxyClientIp	boolean	Specifies whether WAF is allowed to overwrite the WL-Proxy-Client-IP header. Valid values: true (default): WAF is allowed to overwrite the header. false: WAF is not allowed to overwrite the header.	true
MaxBodySize	integer	The maximum request body size. Valid values: 2 to 10. Default value: 2. Unit: GB.	2
Http2Origin	boolean	Indicates whether HTTP/2 back-to-origin is enabled.	true
Http2OriginMaxConcurrency	integer	The maximum number of concurrent connections for HTTP/2 back-to-origin.	128
ProxyProtocol	boolean	Indicates whether the client source IP address preservation feature is enabled. true: The client source IP address preservation feature is enabled. After this feature is enabled, backend services can view the original IP address of the client. false: The client source IP address preservation feature is not enabled.	false
BackendList	array	The list of origin server IP addresses or back-to-origin domain names for the domain name.
	string	The IP address or domain name of the origin server for the domain name.	1.1.XX.XX
BackUpBackendList	array	The list of backup origin server IP addresses or back-to-origin domain names for the domain name.
	string	The backup origin server IP address or back-to-origin domain name for the domain name.	2.2.XX.XX
BackendPorts	array<object>	The custom port configuration. By default, the port is the same as the listener port.
	object	The custom port configuration. By default, the port is the same as the listener port.
ListenPort	integer	The listener port.	80
BackendPort	integer	The back-to-origin port.	80
Protocol	string	The protocol type of the listener port. Valid values:	http
ResourceManagerResourceGroupId	string	The Alibaba Cloud resource group ID.	rg-acfm***q
CertDetail	object	The SSL certificate details.
Name	string	The certificate name.	test-cert-name
Id	string	The SSL certificate ID.	123-cn-hangzhou
StartTime	integer	The effective period of the certificate. The value is in the format of a UNIX timestamp (UTC). Unit: milliseconds.	1677772800000
EndTime	integer	The time when the certificate expires. The value is a UNIX timestamp (UTC). Unit: milliseconds.	1685590400000
CommonName	string	The common name (CN).	test.aliyundoc.com
Sans	array	All domain names that are bound to the certificate.
	string	All domain names that are bound to the certificate.	www.aliyundoc.com
SM2CertDetail	object	The SM2 certificate information.
Name	string	The certificate name.	test-sm2-cert-name
Id	string	The SSL certificate ID.	123-cn-hangzhou
StartTime	integer	The effective period of the certificate. The value is in the format of a UNIX timestamp (UTC). Unit: milliseconds.	1657551525000
EndTime	integer	The time when the certificate expires. The value is a UNIX timestamp (UTC). Unit: milliseconds.	1665590400000
CommonName	string	The common name (CN).	test.aliyundoc.com
Sans	array	All domain names that are bound to the certificate.
	string	All domain names that are bound to the certificate.	www.aliyundoc.com

Examples

Success response

JSON format

{
  "RequestId": "BAEF9CA9-66A0-533E-BD09-5D5D7AA8****",
  "Domain": "www.aliyundoc.com",
  "DomainId": "www.aliyundoc.com-waf",
  "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,
    "HstsIncludeSubDomain": false,
    "HstsPreload": false,
    "HstsMaxAge": 365000
  },
  "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,
    "BackupBackends": [
      {
        "Backend": "[\n    \"1.1.XX.XX\",\n    \"2.2.XX.XX\"\n]\n"
      }
    ],
    "XClientIp": true,
    "XTrueIp": true,
    "WebServerType": true,
    "WLProxyClientIp": true,
    "MaxBodySize": 2,
    "Http2Origin": true,
    "Http2OriginMaxConcurrency": 128,
    "ProxyProtocol": false,
    "BackendList": [
      "1.1.XX.XX"
    ],
    "BackUpBackendList": [
      "2.2.XX.XX"
    ],
    "BackendPorts": [
      {
        "ListenPort": 80,
        "BackendPort": 80,
        "Protocol": "http"
      }
    ]
  },
  "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"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.	The domain name and domain name ID cannot be empty at the same time.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.	The input parameters Domain and DomainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.	Illegal entry DomainId

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.