All Products
Search
Document Center

API Gateway:UpdatePrivateDNS

Last Updated:Aug 28, 2026

Modifies private DNS 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

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

apigateway:UpdatePrivateDNS

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

IntranetDomain

string

Yes

The internal domain name.

api.demo.com

Type

string

Yes

The private DNS resolution type. Valid values:

  • VPC: resolution for VPC access authorization. Binds only to traditional dedicated instances.

  • A: resolution supporting A records. Binds only to VPC integration dedicated instances.

Valid values:

  • A :

    A

  • VPC :

    VPC

A

Records

array<object>

Yes

The resolution records. This parameter is valid only when Type is set to A.

object

No

The information about the resolution record.

Record

string

No

The resolution record.

192.168.0.2

Weight

integer

No

The weight of the record.

100

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

EF924FE4-2EDD-4CD3-89EC-34E4708574E7

Examples

Success response

JSON format

{
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.