All Products
Search
Document Center

Cloud Firewall:AddPrivateDnsDomainName

Last Updated:Oct 16, 2025

Adds a private DNS domain name.

Operation description

This operation retrieves the DNS resolution results for a domain name. The domain name that you query must use Alibaba Cloud DNS because this operation can retrieve results only from Alibaba Cloud DNS.

QPS limit

The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed this limit, your API calls are throttled, which may affect your business. Call this operation at a reasonable frequency to prevent throttling.

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 ID of the private DNS instance.

cfw-xxx

RegionNo

string

Yes

The ID of the region where the instance is located.

Note

For more information about the regions that Cloud Firewall supports, see Supported regions.

cn-shenzhen

DomainNameList

array

Yes

The list of private domain names to add.

string

No

The list of private domain names to add.

[ "internal.xxx.com", "api.xxx.com" ]

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

F0F82705-CFC7-5F83-86C8-A063892F****

Examples

Success response

JSON format

{
  "RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****"
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorPrivateDnsNotFound private dns not found. The specified private DNS does not exist
400 ErrorPrivateDnsDomainName private dns domain name error. Private DNS domain name error
400 ErrorPrivateDnsDomainNameMaxLimit the number of private DNS domain names exceeds the maximum limit. The number of private DNS domain names exceeds the maximum specification limit

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.