DescribePrivateDnsEndpointList - Cloud Firewall - Alibaba Cloud Documentation Center

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AccessInstanceId	string	No	The instance ID.	pd-12345
RegionNo	string	No	The region ID.	cn-hangzhou
VpcId	string	No	The ID of the VPC instance.	vpc-8vbwbo90rq0anm6t****
AccessInstanceName	string	No	The name of the private instance.	测试
FirewallType	string	No	The type of Cloud Firewall. Valid values: internet vpc nat	vpc
Status	string	No	The instance status. 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 page number to return.	10

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The request ID.	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 per page.	10
AccessInstanceList	array<object>	The list of private instances.
	object	The list of private instances.
AliUid	integer	The UID of the Cloud Firewall account.	1379490574415****
MemberUid	integer	The UID of the member account of Cloud Firewall.	1844802493****
RegionNo	string	The ID of the region where the instance is located.	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 instance ID.	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 instance.	vpc-2zelphbaourpun****
PrimaryDns	string	The primary DNS server.	1.1.1.1
StandbyDns	string	The secondary 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 instance status. 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
DomainNameCount	integer	The number of domain names.	3
TaskId	string	The task ID. It is the unique identifier of a task.	123
GmtCreate	integer	The time when the instance was created. This value is a UNIX timestamp. Unit: 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.