Call the CreateVpcEndpoint API to create a VPC endpoint - PrivateLink - Alibaba Cloud - PrivateLink

create an endpoint.

Operation description

The CreateVpcEndpoint API operation is asynchronous. The system returns an instance ID, but the endpoint is not fully created and background tasks are still in progress. You can call the GetVpcEndpointAttribute operation to query the creation status of the endpoint:

If the endpoint is in the Creating state, the endpoint is being created.
If the endpoint is in the Active state, the endpoint is created.

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

privatelink:CreateVpcEndpoint

create

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/*

*SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

privatelink:VpcEndpointServiceId

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint. You can call the DescribeRegions operation to query region IDs.	cn-huhehaote
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate the parameter value on your client to ensure that the value is unique across different requests. The ClientToken parameter supports only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to only perform a dry run for this request. Valid values: true: The system performs a dry run and does not create an endpoint. The system checks whether required parameters are specified, the request format, and service limits. If the request fails the dry run, the corresponding error is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): The system sends a normal request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed.	false
EndpointName	string	No	The name of the endpoint. The name must be 2 to 128 characters in length, and must start with a letter or a Chinese character. It can contain digits, hyphens (-), and underscores (_).	test
EndpointType	string	No	The endpoint type. Valid values: Interface: interface endpoint. You can add EPS resource types such as Application Load Balancer (ALB), Classic Load Balancer (CLB), and Network Load Balancer (NLB) for load balancing. Reverse: reverse endpoint. You can add a VPC NAT gateway as a service resource. GatewayLoadBalancer: Gateway Load Balancer endpoint (GWLBe). You can add a Gateway Load Balancer (GWLB) as a service resource. Note Services that support reverse endpoints are provided only by Alibaba Cloud and ecosystem partners. By default, you cannot create such services. To create one, contact your account manager.	Interface
ZonePrivateIpAddressCount	integer	No	The number of private IP addresses for the endpoint elastic network interface (ENI) in each zone. Set the value to 1.	1
EndpointDescription	string	No	The description of the endpoint. The description must be 2 to 256 characters in length, and cannot start with `http://` or `https://`.	This is my Endpoint.
VpcId	string	Yes	The virtual private cloud (VPC) to which the endpoint belongs.	vpc-hp356stwkxg3fn2xe****
ServiceId	string	No	The endpoint service that is associated with the endpoint.	epsrv-hp3xdsq46ael67lo****
ServiceName	string	No	The name of the endpoint service that is associated with the endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Zone	array<object>	No	The list of endpoint zones. The specified zones must be supported by the endpoint service. Otherwise, the EndpointServiceNotSupportedZone error is returned.
	object	No	The zone ID in the current region. The system creates resources in the specified zone.
VSwitchId	string	No	The vSwitch in the zone where the endpoint ENI is created. You can specify up to 10 vSwitches.	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	No	The zone of the endpoint. You can specify up to 10 zones.	cn-huhehaote-b
ip	string	No	The IPv4 address of the ENI in the specified endpoint zone.	192.168.XX.XX
Ipv6Address	string	No	The IPv6 address of the ENI in the specified endpoint zone. Note You can specify this parameter only when the AddressIpVersion parameter is set to DualStack.	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	No	The list of endpoint security groups associated with the endpoint ENI.	sg-hp33bw6ynvm2yb0e****
	string	No	The endpoint security group associated with the endpoint ENI. The security group can control data communication from the VPC to the endpoint ENI.	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	No	Specifies whether to enable managed protection. This parameter takes effect only for Security Token Service (STS) calls. Valid values: true: Enable managed protection. After managed protection is enabled, only the user who created the endpoint can modify or delete the endpoint by using STS. false (default): Disable managed protection.	false
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key.	env
Value	string	No	The tag value.	prod
ResourceGroupId	string	No	The resource group ID.	rg-acfmy*****
PolicyDocument	string	No	The Resource Access Management (RAM) access policy. For more information about access policy definitions, see Basic elements of an access policy.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oss:List", "oss:PutObject", "oss:GetObject" ], "Resource": [ "acs:oss:oss-::pvl-policy-test/policy-test.txt" ], "Principal": { "RAM": [ "acs:ram::14199xxxxxx:" ] } } ] }
AddressIpVersion	string	No	The IP version. Valid values: IPv4: IPv4 (default). DualStack: dual-stack. Note To use dual-stack for the endpoint, both the associated endpoint service and the VPC where the endpoint resides must support dual-stack.	IPv4
ZoneAffinityEnabled	boolean	No	Specifies whether to support nearest access resolution for the endpoint domain name of the connected service. Valid values: true: yes. false (default): no.	false
ServiceRegionId	string	No	The region ID of the endpoint service. The default value is the current region, which is the region where you create an endpoint.	cn-huhehaote
CrossRegionBandwidth	integer	No	The cross-region bandwidth. This parameter is required only when the endpoint and the endpoint service are in different regions. Unit: Mbit/s. Valid values: Default value: 1000 for cross-region connections within the Chinese mainland, and 100 for other scenarios. Minimum value: 100. Maximum value: Subject to the quota of the current account. For more information, see the Quotas and limits section. Note To specify this parameter, make sure that you are creating a cross-region endpoint.	1000

Response elements

Element	Type	Description	Example
	object
EndpointDomain	string	The endpoint domain name.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
CreateTime	string	The time when the endpoint was created. The time follows the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time is displayed in UTC.	2022-01-02T19:11:12Z
EndpointBusinessStatus	string	The business status of the endpoint. Valid values: Normal: normal. FinancialLocked: financial lock due to overdue payment.	Normal
EndpointDescription	string	The description of the endpoint.	This is my Endpoint.
ServiceId	string	The ID of the endpoint service that is associated with the endpoint.	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	The status of the endpoint. Valid values: Creating: The endpoint is being created. Active: The endpoint is available. Pending: The endpoint is being modified. Deleting: The endpoint is being deleted.	Active
VpcId	string	The virtual private cloud (VPC) to which the endpoint belongs.	vpc-hp356stwkxg3fn2xe****
EndpointName	string	The name of the endpoint.	test
ServiceName	string	The name of the endpoint service that is associated with the endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	The connection bandwidth of the endpoint. Unit: Mbit/s.	200
EndpointId	string	The endpoint ID.	ep-hp33b2e43fays7s8****
ConnectionStatus	string	Endpoint connection status of the endpoint. Valid values: Pending: Endpoint connection is being modified. Connecting: Endpoint connection is being established. Connected: Endpoint connection is established. Disconnecting: Endpoint connection is being disconnected. Disconnected: Endpoint connection is disconnected. Deleting: Endpoint connection is being deleted.	Disconnected
AddressIpVersion	string	The IP version. Valid values: IPv4: IPv4 (default). DualStack: dual-stack.	IPv4
ZoneAffinityEnabled	boolean	Indicates whether nearest access resolution is supported for the endpoint domain name of the connected service. Valid values: true: yes. false: no.	false
ServiceRegionId	string	The region ID of the endpoint service.	cn-huhehaote
CrossRegionBandwidth	integer	The cross-region bandwidth of the endpoint. This parameter is returned only when the endpoint and the endpoint service are in different regions. Unit: Mbit/s.	1000

Examples

Success response

JSON format

{
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "CreateTime": "2022-01-02T19:11:12Z",
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "This is my Endpoint.",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-hp356stwkxg3fn2xe****",
  "EndpointName": "test",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 200,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "ConnectionStatus": "Disconnected",
  "AddressIpVersion": "IPv4",
  "ZoneAffinityEnabled": false,
  "ServiceRegionId": "cn-huhehaote",
  "CrossRegionBandwidth": 1000
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointExist	The specified Endpoint already exists.	The specified Endpoint already exists.
400	EndpointZoneDuplicated	The zone is duplicated for the Endpoint.	The zone is duplicated for the Endpoint.
400	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.	The specified endpoint service does not support the zone.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	SecurityGroupNotFound	The specified security group does not exist.	The specified security group does not exist.
400	VpcTunnelNotFound	The specified VPC tunnel does not exist.	The specified VPC tunnel does not exist.
400	VpcNotFound	The specified VPC does not exist.	The specified VPC does not exist.
400	GenerateResourceIdFailed	Failed to generate ResourceId.	Failed to generate ResourceId.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.	The resource you applied for has exceeded the quota.
400	EndpointMustContainSecurityGroup	The specified endpoint must have at least one security group.	The specified endpoint must have at least one security group.
400	EndpointDuplicated	The endpoint of the service already exists and cannot be created again.	An endpoint for this service already exists. Do not create it again.
400	EndpointServiceDeleted	The specified Service is already deleted.	The specified Service is already deleted.
400	EndpointServiceResourceNotFound	The specified service resource is not found.	The endpoint service resource was not found.
400	SecurityGroupTypeNotSupport	The specified security group type is not supported.	The security group type is not supported.
400	EniIpUnavailable	The specified IP address is unavailable.	The specified IP address is unavailable.
400	EndpointServiceNotAuthorized	The specified endpoint service is not authorized to user.	The specified endpoint service is not authorized to user.
400	SecurityGroupTypeOnlySingleTypeSupporteded	The specified security group only support one type.	A security group supports only one type.
400	QuotaExceeded.IpQuotaPerEp	The quota of %s is exceeded, usage %s/%s.
400	Mismatch.EndpointType	The %s is mismatched for %s and %s.
400	IncorrectStatus.VpcEndpointService	The status of %s [%s] is incorrect.
400	CheckServiceLinkRoleError	The ServiceLink role check error.	ServiceLinkRole check error
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	The number of vSwitch IP addresses is insufficient.
400	VSwitchStatusNotAllowed	The specified vswitch status is not Available.	The status of the vSwitch is not available.
400	QuotaExceeded.epZonePerEndpoint	The quota of %s is exceeded, usage %s/%s.	The number of endpoints in a zone has reached the upper limit.
400	QuotaExceeded.totalEpPerVpc	The quota of %s is exceeded, usage %s/%s.	The number of VPC endpoints has reached the upper limit.
400	QuotaExceeded.totalIdleEndpoint	The quota of %s is exceeded, usage %s/%s.	The total number of idle endpoints has reached the upper limit.
400	OperationDenied.EndpointPolicyNotSupport	The operation is not allowed because of EndpointPolicyNotSupport.	The operation is not allowed because the endpoint policy is not supported.
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.	The operation is not supported due to %s.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.	The operation is not supported due to %s.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.	The resource %s depends on %s, which prevents the operation from being completed.
400	GatewayLoadBalancerNotSupportSecurityGroup	The gateway load balancer not support security group.	The gateway load balancer type does not support setting a security group.
400	GatewayLoadBalancerZoneCountDeny	The GatewayLoadBalancer zone count not support	The number of available zones does not meet the limit and cannot be operated.
400	OperationDenied.EndpointTypeNotSupportDualstack	The specified endpoint type does not support dualstack, only the Interface and GatewayLoadBalancer types support dual stack.	The specified endpoint type does not support dualstack, only the Interface and GatewayLoadBalancer types support dual stack.
400	OperationDenied.EndpointServiceNotSupportDualstack	The specified endpoint service does not support dualstack.	The specified endpoint service does not support dualstack.
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.	The specified VSwitch does not support dualstack.
400	OperationDenied.AddressIpVersionNotSupportSpecifyIpv6	The AddressIpVersion of the endpoint does not support specifying IPv6 address.	The AddressIpVersion of the endpoint does not support specifying an IPv6 address.
400	IllegalParam.Ip	The specified parameter IP is invalid.	The specified parameter IP is invalid.
400	IllegalParam.Ipv6Address	The specified parameter Ipv6Address is invalid.	The specified parameter Ipv6Address is invalid.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.	The specified parameter AddressIpVersion does not meet the requirements.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.	the specified alb instance is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.