AddPrivateDnsDomainName-阿里云帮助中心

Operation description

This operation is used to obtain DNS resolution results for a domain name. Currently, only resolution results from Alibaba Cloud DNS are supported. The domain name that you want to query must use Alibaba Cloud DNS before you can obtain its resolution results.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

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:AddPrivateDnsDomainName

create

*PrivateDNS

acs:yundun-cloudfirewall::{#accountId}:privatedns/{#AccessInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
AccessInstanceId	string	Yes	The ID of the private DNS resolution instance.	cfw-xxx
RegionNo	string	Yes	The region ID of the instance. Note For more information about the regions supported by Cloud Firewall, see Supported regions.	cn-shenzhen
DomainNameList	array	Yes	The list of private domain names to add.
	string	No	The list of private domain names to add.	[ "internal.xxx.com", "api.xxx.com" ]

Response elements

Element	Type	Description	Example
	object
RequestId	string	Id of the request	F0F82705-CFC7-5F83-86C8-A063892F****

Examples

Success response

JSON format

{
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorPrivateDnsNotFound	private dns not found.	The specified private DNS does not exist
400	ErrorPrivateDnsDomainName	private dns domain name error.	Private DNS domain name error
400	ErrorPrivateDnsDomainNameMaxLimit	the number of private DNS domain names exceeds the maximum limit.	The number of private DNS domain names exceeds the maximum specification limit

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.