EnableVpcEndpointConnection - PrivateLink - Alibaba Cloud Documentation Center

Accepts an endpoint connection request.

Operation description

EnableVpcEndpointConnection is an asynchronous operation. After you send a request, the system returns a request ID, but the endpoint connection is not immediately established. The system establishes the connection in the background. Call the GetVpcEndpointAttribute operation to query the status of the endpoint connection:
- Connecting indicates that the endpoint connection is being established.
- Connected indicates that the endpoint connection is established.
The EnableVpcEndpointConnection operation does not support concurrent calls to accept endpoint connection requests from the same Alibaba Cloud account.

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:EnableVpcEndpointConnection

update

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the endpoint service is deployed. Call the DescribeRegions operation to query the most recent list of regions.	cn-huhehaote
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Make sure that the client token is unique for each request. The token can contain only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run to check the request without accepting the connection. The system checks for required parameters, the request format, and service limits. If the check fails, the system returns an error. If the check passes, the system returns the `DryRunOperation` error code. false (default): Sends a normal request. If the request passes the check, the system accepts the connection request and returns an HTTP 2xx status code.	false
ServiceId	string	Yes	The ID of the endpoint service.	epsrv-hp3vpx8yqxblby3i****
EndpointId	string	Yes	The ID of the endpoint.	ep-hp33b2e43fays7s8****
Bandwidth	integer	No	The bandwidth of the endpoint connection in Mbps. Note If the backend resource is an Application Load Balancer (ALB) or a Classic Load Balancer (CLB), the valid values are 100 to 10,240. If the backend resource is a Network Load Balancer (NLB), the valid values are 100 to 25,600.	3072
RegionId	string	Yes	The ID of the region where the endpoint service is deployed. Call the DescribeRegions operation to query the most recent list of regions.	cn-huhehaote
TrafficControlMode	string	No	Scalability: The connection bandwidth is elastic. In this mode, the Bandwidth parameter is ignored. BandwidthLimit: A bandwidth cap is set for the connection. The cap is the value of the Bandwidth parameter. Note If the service resource is a Network Load Balancer (NLB) instance, TrafficControlMode is set to Scalability by default. You can set this parameter to BandwidthLimit and specify a bandwidth cap using the Bandwidth parameter. If the service resource is a Classic Load Balancer (CLB) instance, TrafficControlMode can only be set to BandwidthLimit. This means the service consumer provides a default bandwidth limit for each endpoint. If the service resource is a Gateway Load Balancer (GWLB) instance, TrafficControlMode can only be set to Scalability.	BandwidthLimit

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Success response

JSON format

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.
400	EndpointConnectionNotFound	The specified endpoint connection does not exist.	The specified endpoint connection does not exist.
400	EndpointConnectionOperationDenied	The endpoint is being connected.	The endpoint is being connected.
400	EndpointOperationDenied	The specified operation of endpoint is not allowed.	The specified operation of endpoint is not allowed.
400	OperationDenied.NoAvailableServiceResource	The operation is not allowed because of there are no resource in some available zones of endpoint service.	The operation is not allowed because of there are no resource in some available zones of endpoint service.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.