All Products
Search
Document Center

API Gateway:CreatePrivateDNS

Last Updated:Jul 31, 2025

Creates an internal domain name resolution and adds a resolution record.

Operation description

An internal domain name resolution of the virtual private cloud (VPC) type can be bound only to traditional dedicated instances. An internal domain name resolution of the A type can be bound only to VPC integration dedicated instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:CreatePrivateDNScreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IntranetDomainstringYes

The internal domain name.

api.demo.com
TypestringYes

The internal domain name resolution type. Valid values:

  • VPC: resolution for VPC access authorizations. A resolution of this type can be bound only to traditional dedicated instances.
  • A: resolution that supports A records. A resolution of this type can be bound only to VPC integration dedicated instances.
A
Recordsarray<object>No

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

objectNo

The information about the resolution record.

RecordstringNo

The resolution record.

192.168.0.1
WeightintegerNo

The weight of the record.

100

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ015

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history