All Products
Search
Document Center

Cloud Firewall:DescribeDomainResolve

Last Updated:Mar 19, 2024

Queries Domain Name System (DNS) records.

Operation description

You can use this operation to query the DNS record of a domain name. This operation can retrieve DNS records only from Alibaba Cloud DNS. Before you can call this operation, make sure that your domain name is hosted on Alibaba Cloud DNS.

Limits

You can call this operation up to 10 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

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

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-cloudfirewall:DescribeDomainResolveRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpdeprecatedstringNo

The source IP address of the request.

192.0.XX.XX
LangstringNo

The language of the content within the response.

Valid values:

  • zh: Chinese (default)
  • en: English
zh
DomainstringYes

The domain name whose DNS record you want to query.

www.aliyundoc.com
IpVersionstringNo

The IP version of the asset that is protected by Cloud Firewall. Valid values:

  • 4: IPv4 (default)
  • 6: IPv6
6

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
ResolveResultobject

The details about the DNS record of the domain name.

IpAddrsstring

The IP address to which the domain name is resolved. Multiple IP addresses are separated by commas (,).

11.1.X.X,12.1.X.X
UpdateTimelong

The time when the domain name was resolved. The value of this parameter is a timestamp. Unit: seconds.

1579091739

Examples

Sample success responses

JSONformat

{
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "ResolveResult": {
    "IpAddrs": "11.1.X.X,12.1.X.X",
    "UpdateTime": 1579091739
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ErrorParametersA parameter error occurred.A parameter error occurred.
400ErrorDBSelectAn error occurred while querying database.An error occurred while querying database.
400ErrorDomainResolveA domain resolution error occurred.An error occurred while resolving the domain.

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

Change history

Change timeSummary of changesOperation
No change history