DescribePrivateDnsDomainNameList-阿里云帮助中心

Operation description

Queries the list of domain names that require private DNS endpoints for domain name resolution.

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

get

*PrivateDNS

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

None

Request parameters

Parameter	Type	Required	Description	Example
AccessInstanceId	string	Yes	The instance ID.	pd-12345
RegionNo	string	Yes	The region ID.	cn-hangzhou
DomainName	string	No	The domain name.	example.com
PageNo	integer	No	The page number of the current page.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	822B9125-6E1A-551C-8EAF-6E7AE74****
TotalCount	integer	The total number of private DNS domain names.	132
PageNo	integer	The page number of the current page.	1
PageSize	integer	The number of entries per page.	10
DomainNameList	array	The list of domain names.
	string	The list of domain names.	[\"example.com\"]

Examples

Success response

JSON format

{
  "RequestId": "822B9125-6E1A-551C-8EAF-6E7AE74****",
  "TotalCount": 132,
  "PageNo": 1,
  "PageSize": 10,
  "DomainNameList": [
    "[\\\"example.com\\\"]"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParameters	Parameters error.	Parameter error.
400	ErrorPrivateDnsNotFound	private dns not found.	The specified private DNS does not exist
400	ErrorParametersPageSizeOrNo	Either pageSize or pageNo is invalid.	Either pageSize or pageNo is invalid.
400	ErrorPrivateDnsRegionNotAvailable	private dns region not available.	Private dns zones are not available.
400	ErrorMarshalJSON	An error occurred while encoding JSON.	An error occurred while encoding JSON.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.