AddResolverEndpoint - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

You can call this operation to add an 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

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

pvtz:AddResolverEndpoint

create

*Endpoint

acs:pvtz:*:{#accountId}:endpoint/*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the endpoint. The name can be up to 20 characters long. An error is reported if the limit is exceeded.	endpoint-test-name
VpcRegionId	string	Yes	The region ID of the outbound VPC.	cn-hangzhou
VpcId	string	Yes	The ID of the outbound virtual private cloud (VPC). All outbound DNS query traffic from the Resolver is forwarded through this VPC. Note To prevent service interruptions, you cannot change this value after you create the outbound endpoint.	vpc-129343jslslsks
SecurityGroupId	string	Yes	The ID of the security group. The rules in the security group are applied to the outbound VPC. Note To prevent service interruptions, you cannot change this value after you create the outbound endpoint.	kqlqlqjqqkq
IpConfig	array<object>	Yes	The list of source IP addresses for outbound traffic. You must add at least two IP addresses. You can add up to six IP addresses. Note To ensure high availability (HA), add at least two source IP addresses for the outbound endpoint. We recommend that you allocate these IP addresses in different zones. You can add a maximum of six source IP addresses.
	object	No	Information about a source IP address for outbound traffic.
VSwitchId	string	Yes	The vSwitch ID.	sjqkql
CidrBlock	string	Yes	The IPv4 CIDR block of the vSwitch.	172.16.0.0/24
AzId	string	Yes	The ID of the zone where the vSwitch resides.	cn-hangzhou-a
Ip	string	No	The IP address. The IP address must be within the specified CIDR block. If you leave this parameter empty, the system automatically assigns an IP address.	172.16.xx.xx
Lang	string	No	The language of the response. Valid values: zh: Chinese. en: English. Default value: en	en

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	32436208-E1AF-4DAB-B3B8-24F5F25B0950
EndpointId	string	The endpoint ID.	hra0**

Examples

Success response

JSON format

{
  "RequestId": "32436208-E1AF-4DAB-B3B8-24F5F25B0950",
  "EndpointId": "hra0**"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.