All Products
Search
Document Center

Cloud Firewall:DescribePrivateDnsDomainNameList

Last Updated:Oct 16, 2025

Queries a list of private DNS domain names.

Operation description

Queries the list of domain names that use a private DNS endpoint 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

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 region ID.

cn-hangzhou

DomainName

string

No

The domain name.

example.com

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.

822B9125-6E1A-551C-8EAF-6E7AE74****

TotalCount

integer

The total number of private DNS domain names.

132

PageNo

integer

The page number.

1

PageSize

integer

The number of entries on the current 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.