All Products
Search

This Product

    Web Application Firewall:DescribeDomainDNSRecord

    Document Center

    Web Application Firewall:DescribeDomainDNSRecord

    Last Updated:Nov 15, 2024

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

    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:DescribeDomainDNSRecordget
    *All Resources
    *
      none
    		none

    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.