DescribePrivateDnsEndpointList-阿里云帮助中心

Queries a list of private DNS endpoints.

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

get

*PrivateDNS

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

None

Request parameters

Parameter	Type	Required	Description	Example
AccessInstanceId	string	No	The ID of the instance.	pd-12345
RegionNo	string	No	The ID of the region.	cn-hangzhou
VpcId	string	No	The ID of the VPC.	vpc-8vbwbo90rq0anm6t****
AccessInstanceName	string	No	The name of the private instance.	test
FirewallType	string	No	The type of Cloud Firewall. Valid values: internet vpc nat	vpc
Status	string	No	The status of the instance. Valid values: creating: The instance is being created. deleting: The instance is being deleted. normal: The instance is running as expected. updating: The instance is being updated.	normal
MemberUid	integer	No	The UID of the member account.	135809047715****
PageNo	integer	No	The page number.	1
PageSize	integer	No	The number of the page to return.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	850A84D6-0DE4-4797-A1E8-00090****
TotalCount	integer	The total number of entries.	3
PageNo	integer	The page number.	1
PageSize	integer	The number of entries to return on each page.	10
AccessInstanceList	array<object>	A list of private instances.
	object	A list of private instances.
AliUid	integer	The UID of the Alibaba Cloud account that owns the Cloud Firewall.	1379490574415****
MemberUid	integer	The UID of the Cloud Firewall member account.	1844802493****
RegionNo	string	The ID of the region where the instance resides.	cn-hangzhou
FirewallType	array	The type of Cloud Firewall. Valid values: internet vpc nat
	string	The type of Cloud Firewall. Valid values: internet vpc nat	[ "internet", "vpc", "nat" ]
AccessInstanceId	string	The ID of the instance.	123
AccessInstanceName	string	The name of the private instance.	test
PrivateDnsType	string	The type of private DNS. Valid values: PrivateZone Custom (default)	Custom
VpcId	string	The ID of the VPC.	vpc-2zelphbaourpun****
PrimaryDns	string	The primary DNS server.	1.1.1.1
StandbyDns	string	The standby DNS server.	1.1.1.2
Port	integer	The port number.	443
IpProtocol	integer	The IP protocol. Valid values: TCP UDP	tcp
Status	integer	The status of the instance. Valid values: creating: The instance is being created. deleting: The instance is being deleted. normal: The instance is running as expected. updating: The instance is being updated. abnormal: The instance is in an abnormal state.	normal
DomainNameCount	integer	The number of domain names.	3
TaskId	string	The unique ID of the task.	123
GmtCreate	integer	The time when the instance was created. The value is a UNIX timestamp measured in seconds.	1715075765

Examples

Success response

JSON format

{
  "RequestId": "850A84D6-0DE4-4797-A1E8-00090****",
  "TotalCount": 3,
  "PageNo": 1,
  "PageSize": 10,
  "AccessInstanceList": [
    {
      "AliUid": 0,
      "MemberUid": 0,
      "RegionNo": "cn-hangzhou",
      "FirewallType": [
        "[\n  \"internet\",\n  \"vpc\",\n  \"nat\"\n]"
      ],
      "AccessInstanceId": "123",
      "AccessInstanceName": "test",
      "PrivateDnsType": "Custom",
      "VpcId": "vpc-2zelphbaourpun****",
      "PrimaryDns": "1.1.1.1",
      "StandbyDns": "1.1.1.2",
      "Port": 443,
      "IpProtocol": 0,
      "Status": 0,
      "DomainNameCount": 3,
      "TaskId": "123",
      "GmtCreate": 1715075765
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.