DescribeDomains - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the domain names that are added to Web Application Firewall (WAF).

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:DescribeDomains

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to view the ID of the WAF instance.	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
Domain	string	No	The domain name that is added to WAF.	www.aliyundoc.com
Backend	string	No	The IP address of the origin server or the back-to-origin domain name. You can specify only one of these options.	1.1.XX.XX
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
DomainId	string	No	The ID of the domain name.	www.aliyundoc.com-waf
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
Tag	array<object>	No	The tags of the resource. A maximum of 20 tags are supported.
	object	No	The tag of the resource.
Key	string	No	The tag key.	TagKey1
Value	string	No	The tag value.	TagValue1

Response elements

Element	Type	Description	Example
	object	The list of domain names that are added in CNAME mode.
RequestId	string	The request ID.	ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCount	integer	The total number of domain name configurations.	146
Domains	array<object>	A list of domain names that are added in CNAME mode.
	array<object>	The details of a domain name added in CNAME mode.
Domain	string	The domain name that is added to WAF.	www.aliyundoc.com
Status	integer	The status of the domain name. Valid values: 1: The domain name is in a normal state. 2: The domain name is being created. 3: The domain name is being modified. 4: The domain name is being released. 5: WAF no longer forwards traffic for the domain name.	1
Cname	string	The CNAME that is assigned by WAF to the domain name.	xxxxxcvdaf.****.com
ListenPorts	object	The listener configuration.
Http	array	A list of HTTP listener ports.
	integer	An HTTP listener port.	80
Https	array	A list of HTTPS listener ports.
	integer	An HTTPS listener port.	443
Backeds	object	The back-to-origin configuration.
Http	array<object>	A list of origin addresses for the HTTP protocol.
	object	An origin address for the HTTP protocol.
Backend	string	The origin address for the HTTP protocol.	1.1.XX.XX
Https	array<object>	A list of origin addresses for the HTTPS protocol.
	object	An origin address for the HTTPS protocol.
Backend	string	The origin address for the HTTPS protocol.	1.1.XX.XX
ResourceManagerResourceGroupId	string	The ID of the Alibaba Cloud resource group.	rg-acfmvtc5z52****
DomainId	string	The ID of the domain name.	www.aliyundoc.com-waf

Examples

Success response

JSON format

{
  "RequestId": "ABF68BB3-2C48-5FA4-9750-D5FE55700E36",
  "TotalCount": 146,
  "Domains": [
    {
      "Domain": "www.aliyundoc.com",
      "Status": 1,
      "Cname": "xxxxxcvdaf.****.com",
      "ListenPorts": {
        "Http": [
          80
        ],
        "Https": [
          443
        ]
      },
      "Backeds": {
        "Http": [
          {
            "Backend": "1.1.XX.XX"
          }
        ],
        "Https": [
          {
            "Backend": "1.1.XX.XX"
          }
        ]
      },
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "DomainId": "www.aliyundoc.com-waf"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.