All Products
Search
Document Center

Web Application Firewall:DescribeDomains

Last Updated:Nov 15, 2024

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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:DescribeDomainsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The page number of the page to return. Default value: 1.

waf_cdnsdf3****
ResourceManagerResourceGroupIdstringNo

The ID of the resource group.

rg-acfm***q
DomainstringNo

The ID of the request.

www.aliyundoc.com
BackendstringNo

An array of HTTPS listener ports.

1.1.XX.XX
PageNumberlongNo

The page number. Default value: 1.

1
PageSizelongNo

The number of entries per page. Default value: 10.

10
RegionIdstringNo

The region where the WAF instance resides. Valid values:

  • cn-hangzhou: the Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou
Tagarray<object>No

The tag of the resource. You can specify up to 20 tags.

objectNo
KeystringNo

The tag key.

TagKey1
ValuestringNo

The tag value.

TagValue1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

ABF68BB3-2C48-5FA4-9750-D5FE55700E36
TotalCountlong

The total number of returned entries.

146
Domainsarray<object>

The domain names that are added to WAF in CNAME record mode.

Domainobject
Domainstring

The domain name that is added to WAF in CNAME record mode.

www.aliyundoc.com
Statusinteger

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 that is sent to the domain name.
1
Cnamestring

The CNAME assigned by WAF to the domain name.

xxxxxcvdaf.****.com
ListenPortsobject

The configurations of the listeners.

Httparray

The HTTP listener ports.

Httplong

The HTTP listener port.

80
Httpsarray

The HTTPS listener ports.

Httpslong

The HTTPS listener port.

443
Backedsobject

The back-to-origin settings.

Httparray<object>

The HTTP addresses of the origin server.

httpobject
Backendstring

The HTTP address of the origin server.

1.1.XX.XX
Httpsarray<object>

The HTTPS addresses of the origin server.

httpsobject
Backendstring

The HTTPS address of the origin server.

1.1.XX.XX
ResourceManagerResourceGroupIdstring

The ID of the resource group.

rg-acfmvtc5z52****

Examples

Sample success responses

JSONformat

{
  "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****"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-04-18The request parameters of the API has changed. The response structure of the API has changedView Change Details