All Products
Search
Document Center

Web Application Firewall:DescribeDomainDNSRecord

Last Updated:Apr 23, 2024

Checks whether the Domain Name System (DNS) settings of a domain name are properly configured.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the Web Application Firewall (WAF) instance.

Note You can call the DescribeInstance operation to query the ID of the WAF instance.
waf_v3prepaid_public_cn-nwy****is02
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q
DomainstringYes

The domain name whose DNS settings you want to check.

xxx.aliyundoc.com
RegionIdstringNo

The region in which the WAF instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

D827FCFE-90A7-4330-9326-D33C8B4C****
DNSStatusstring

The status of the DNS settings. Valid values:

  • cnameMatched: The DNS settings are properly configured.
  • vipMatched: An A record maps the domain name to the WAF virtual IP address (VIP).
  • wafVip: An A record maps the domain name to another WAF VIP.
  • unRecord: The domain name does not have a DNS record.
  • unUsed: The domain name is not pointed to WAF.
  • checkTimeout: The check times out.
cnameMatched

Examples

Sample success responses

JSONformat

{
  "RequestId": "D827FCFE-90A7-4330-9326-D33C8B4C****",
  "DNSStatus": "cnameMatched"
}

Error codes

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