DescribeDomainResource - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the configurations of a forwarding rule.

Operation description

You can call the DescribeDomainResource operation to query the configurations of the forwarding rules that you create for a website by page. The configurations include the domain name-related configurations, protocol-related configurations, HTTPS-related configurations, and configurations that are used to mitigate HTTP flood attacks.

You can call this operation by using Terraform. For more information about Terraform, see What is Terraform?.

Limits

You can call this operation up to 50 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeDomainResource	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Domain	string	No	The domain name of the website that you want to query.	www.example.com
QueryDomainPattern	string	No	The match mode. Valid values: fuzzy: fuzzy match. This is the default value. exact: exact match.	fuzzy
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	10
InstanceIds	array	No	An array that consists of the IDs of instances to query.
	string	No	The ID of the instance to query. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-mp91j1ao****

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of forwarding rules.	1
RequestId	string	The ID of the request.	39499F01-19D9-4EA4-A0E9-C6014BA5CDBE
WebRules	array<object>	The configurations of the forwarding rule.
WebRule	object
Domain	string	The domain name of the website.	www.example.com
Http2HttpsEnable	boolean	Indicates whether Enable HTTPS Redirection is turned on. Valid values: true false	false
SslProtocols	string	The version of the TLS protocol. Valid values: tls1.0: TLS 1.0 or later tls1.1: TLS 1.1 or later tls1.2: TLS 1.2 or later	tls1.0
PunishReason	integer	The reason why the domain name is invalid. Valid values: 1: No Content Provider (ICP) filing is completed for the domain name. 2: The business for which you registered the domain name does not meet regulatory requirements. If the two reasons are both involved, the value 2 is returned.	1
CcTemplate	string	The mode of Frequency Control. Valid values: default: the Normal mode gf_under_attack: the Emergency mode gf_sos_verify: the Strict mode gf_sos_verify: the Super Strict mode	default
HttpsExt	string	The advanced HTTPS settings. This parameter takes effect only when the value of the ProxyType parameter includes https. The value is a string that consists of a JSON struct. The JSON struct contains the following fields: Http2https: indicates whether Enable HTTPS Redirection is turned on. Data type: integer. Valid values: 0 and 1. The value 0 indicates that Enable HTTPS Redirection is turned on. The value 1 indicates that Enable HTTPS Redirection is turned off. Https2http: indicates whether Enable HTTP Redirection of Back-to-origin Requests is turned on. Data type: integer. Valid values: 0 and 1. The value 0 indicates that the feature is turned on. The value 1 indicates that the feature is turned off. Http2: indicates whether Enable HTTP/2 is turned on. Data type: integer. Valid values: 0 and 1. The value 0 indicates that Enable HTTP/2 is turned off. The value 1 indicates that Enable HTTP/2 is turned on.	{"Https2http":0,"Http2":0,"Http2https":0}
CcEnabled	boolean	Indicates whether Frequency Control is enabled. Valid values: true false	true
SslCiphers	string	The type of the cipher suite. Valid values: default: custom cipher suite all: all cipher suites strong: strong cipher suites	default
CcRuleEnabled	boolean	Indicates whether the Custom Rules switch of Frequency Control is turned on. Valid values: true false	true
Ssl13Enabled	boolean	Indicates whether TLS 1.3 is supported. Valid values: true false	false
RsType	integer	The address type of the origin server. Valid values: 0: IP address 1: domain name	0
PunishStatus	boolean	Indicates whether the domain name is invalid. Valid values: true: The domain name is invalid. You can view the specific reasons from the PunishReason parameter. false: The domain name is valid.	false
ProxyEnabled	boolean	Indicates whether the instance forwards the traffic that is destined for the website. Valid values: true false	true
CertName	string	The name of the SSL certificate used by the domain name.	49944XX.pem
PolicyMode	string	The scheduling algorithm for back-to-origin traffic. Valid values: ip_hash: the IP hash algorithm. This algorithm is used to redirect the requests from the same IP address to the same origin server. rr: the round-robin algorithm. This algorithm is used to redirect requests to origin servers in turn. least_time: the least response time algorithm. This algorithm is used to minimize the latency when requests are forwarded from the instance to origin servers based on the intelligent DNS resolution feature.	ip_hash
Cname	string	The CNAME provided by the instance to which the domain name is added.	0ekb69x3j9wvXXXX.aliyunddosXXXX.com
OcspEnabled	boolean	Indicates whether the Online Certificate Status Protocol (OCSP) feature is turned on. Valid values: true false	false
Http2Enable	boolean	Indicates whether Enable HTTP/2 is turned on. Valid values: true false	false
Https2HttpEnable	boolean	Indicates whether Enable HTTP Redirection of Back-to-origin Requests is turned on. Valid values: true false	false
ProxyTypes	array<object>	The details about the protocol type and port number.
ProxyConfig	object
ProxyType	string	The type of the protocol. Valid values: http https websocket websockets	http
ProxyPorts	array	The port numbers.
ProxyPort	string	The port number.	80
InstanceIds	array	The IDs of the instances to which the domain name is added.
InstanceIds	string	The ID of the instance to which the domain name is added.	ddoscoo-cn-st21zbyq****
CustomCiphers	array	The custom cipher suites.
CustomCipher	string	The custom cipher suite.	ECDHE-RSA-AES256-SHA384
WhiteList	array	The IP addresses that are included in the whitelist of the domain name.
WhiteItem	string	The IP address that is included in the whitelist of the domain name. Note This parameter is returned only when the IP address whitelist is configured for the domain name. You can call the ConfigWebIpSet operation to configure the IP address whitelist and the IP address blacklist for the domain name.	3.XX.XX.3
BlackList	array	The IP addresses that are included in the blacklist of the domain name.
BlackItem	string	The IP address that is included in the blacklist of the domain name. Note This parameter is returned only when the IP address blacklist is configured for the domain name. You can call the ConfigWebIpSet operation to configure the IP address whitelist and the IP address blacklist for the domain name.	2.XX.XX.2
RealServers	array	The addresses of origin servers.
RealServers	string	The address of the origin server.	1.XX.XX.1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "39499F01-19D9-4EA4-A0E9-C6014BA5CDBE",
  "WebRules": [
    {
      "Domain": "www.example.com",
      "Http2HttpsEnable": false,
      "SslProtocols": "tls1.0",
      "PunishReason": 1,
      "CcTemplate": "default",
      "HttpsExt": "{\"Https2http\":0,\"Http2\":0,\"Http2https\":0}",
      "CcEnabled": true,
      "SslCiphers": "default",
      "CcRuleEnabled": true,
      "Ssl13Enabled": false,
      "RsType": 0,
      "PunishStatus": false,
      "ProxyEnabled": true,
      "CertName": "49944XX.pem",
      "PolicyMode": "ip_hash",
      "Cname": "0ekb69x3j9wvXXXX.aliyunddosXXXX.com",
      "OcspEnabled": false,
      "Http2Enable": false,
      "Https2HttpEnable": false,
      "ProxyTypes": [
        {
          "ProxyType": "http",
          "ProxyPorts": [
            "80"
          ]
        }
      ],
      "InstanceIds": [
        "ddoscoo-cn-st21zbyq****"
      ],
      "CustomCiphers": [
        "ECDHE-RSA-AES256-SHA384"
      ],
      "WhiteList": [
        "3.XX.XX.3"
      ],
      "BlackList": [
        "2.XX.XX.2"
      ],
      "RealServers": [
        "1.XX.XX.1"
      ],
      "description": ""
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-30	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-06-30	The response structure of the API has changed	View Change Details