All Products
Search
Document Center

Cloud Firewall:DescribePrivateDnsEndpointDetail

Last Updated:Oct 16, 2025

Queries the details of a private DNS endpoint.

Operation description

This operation queries the details of a private DNS endpoint.

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

Yes

The instance ID.

pd-12345

RegionNo

string

Yes

The ID of the region where the instance is located.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The ID of the request.

4E7F94C7-781F-5192-86CF-DB0850****

AliUid

integer

The UID of the Alibaba Cloud account.

119898001566xxxx

MemberUid

integer

The UID of the member account.

258039427902****

RegionNo

string

The ID of the region where the instance is located.

cn-hangzhou

FirewallType

array

The type of the Cloud Firewall. Valid values:

  • internet

  • vpc

  • nat

string

The type of the Cloud Firewall. Valid values:

  • internet

  • vpc

  • nat

[ "internet", "vpc", "nat" ]

AccessInstanceId

string

The instance ID.

pd-12345

AccessInstanceName

string

The name of the access instance.

测试

PrivateDnsType

string

The type of the private DNS. Valid values:

  • PrivateZone

  • Custom (Default)

Custom

VpcId

string

The ID of the VPC.

vpc-uf6b5lyul0x******

PrimaryVSwitchId

string

The ID of the primary vSwitch.

vsw-8vbno9zxz8j9qiot****

PrimaryZoneId

string

The zone of the primary vSwitch.

cn-shenzhen-d

PrimaryVSwitchIp

string

The IP address of the primary vSwitch.

10.1.1.1

StandbyVSwitchId

string

The ID of the standby vSwitch.

vsw-8vb6jk75wfcwnuq****

StandbyZoneId

string

The zone of the standby vSwitch.

cn-shenzhen-e

StandbyVSwitchIp

string

The IP address of the standby vSwitch.

10.1.1.2

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.

80

IpProtocol

string

The IP protocol. Valid values:

  • TCP

  • UDP

tcp

Status

string

The instance status. Valid values:

  • creating: Creating.

  • deleting: Deleting.

  • normal: Normal.

  • updating: Updating.

normal

EndpointId

string

The endpoint ID.

ep-1nmi412c28c374****

TaskId

string

The ID of the task.

132

GmtCreate

integer

The time when the endpoint was created. This is a UNIX timestamp in seconds.

1715075765

Examples

Success response

JSON format

{
  "RequestId": "4E7F94C7-781F-5192-86CF-DB0850****",
  "AliUid": 0,
  "MemberUid": 0,
  "RegionNo": "cn-hangzhou",
  "FirewallType": [
    "[\n  \"internet\",\n  \"vpc\",\n  \"nat\"\n]"
  ],
  "AccessInstanceId": "pd-12345",
  "AccessInstanceName": "测试",
  "PrivateDnsType": "Custom",
  "VpcId": "vpc-uf6b5lyul0x******",
  "PrimaryVSwitchId": "vsw-8vbno9zxz8j9qiot****",
  "PrimaryZoneId": "cn-shenzhen-d",
  "PrimaryVSwitchIp": "10.1.1.1",
  "StandbyVSwitchId": "vsw-8vb6jk75wfcwnuq****",
  "StandbyZoneId": "cn-shenzhen-e",
  "StandbyVSwitchIp": "10.1.1.2",
  "PrimaryDns": "1.1.1.1",
  "StandbyDns": "1.1.1.2",
  "Port": 80,
  "IpProtocol": "tcp",
  "Status": "normal",
  "EndpointId": "ep-1nmi412c28c374****",
  "TaskId": "132",
  "GmtCreate": 1715075765
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.