DescribeDomainResolve - Cloud Firewall - Alibaba Cloud Documentation Center

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

Operation description

This operation retrieves the DNS resolution result for a domain name. You can retrieve resolution results only for domain names that use Alibaba Cloud DNS.

QPS limit

The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed the limit, API calls are throttled. This may affect your business. You should call this operation at a reasonable rate.

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-cloudfirewall:DescribeDomainResolve

get

*Domain

acs:yundun-cloudfirewall::{#accountId}:domain/{#Domain}

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp `deprecated`	string	No	The source IP address of the visitor.	192.0.XX.XX
Lang	string	No	The language of the message that you receive. Valid values: zh (default): Chinese en: English	zh
Lang	string	No	The language of the message that you receive. Valid values: zh (default): Chinese en: English	zh
Domain	string	Yes	The domain name that you want to resolve.	www.aliyundoc.com
IpVersion	string	No	The IP version of the asset that is protected by Cloud Firewall. Valid values: 4 (default): IPv4 6: IPv6	6

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
ResolveResult	object	The DNS resolution result of the domain name.
IpAddrs	string	The DNS resolution result. Multiple IP addresses are separated by commas (,).	11.1.X.X,12.1.X.X
UpdateTime	integer	The timestamp of the resolution. Unit: seconds.	1579091739

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
200	ErrorParametersUid	The aliUid is invalid.	The aliUid is invalid.
400	ErrorParameters	A parameter error occurred.	A parameter error occurred.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorDomainResolve	A domain resolution error occurred.	An error occurred while resolving the domain.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.