Accept an endpoint connection request using EnableVpcEndpointConnection - PrivateLink - Alibaba Cloud - PrivateLink

Operation description

EnableVpcEndpointConnection is an asynchronous operation. After a request is sent, the system returns a request ID. However, the endpoint service connection is not yet established, and the connection task is still being run in the background. You can call the GetVpcEndpointAttribute operation to query the status of the endpoint service connection:
- If the connection is in the Connecting state, the endpoint service connection is being established.
- If the connection is in the Connected state, the endpoint service connection is established.
The EnableVpcEndpointConnection operation does not support concurrently accepting endpoint connection requests under the same Alibaba Cloud account (primary 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 region ID of the endpoint connection to be accepted. You can call the DescribeRegions operation to query the region IDs.	cn-huhehaote
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. ClientToken can contain only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing required parameters, the request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the connection request is accepted.	false
ServiceId	string	Yes	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
EndpointId	string	Yes	The endpoint ID.	ep-hp33b2e43fays7s8****
Bandwidth	integer	No	The bandwidth of the endpoint connection. Unit: Mbit/s. Note The valid values vary depending on the service resource type: NLB: 100 to 50000. ALB: 100 to 25000. CLB: 100 to 10240. Default value: 3072. GWLB: 100 to 25000.	3072
RegionId	string	Yes	The region ID of the endpoint connection to be accepted. You can call the DescribeRegions operation to query the region IDs.	cn-huhehaote
TrafficControlMode	string	No	Scalability: automatic scaling. In this mode, the connection bandwidth configured for the endpoint connection does not take effect. BandwidthLimit: supports setting a bandwidth upper limit for the endpoint connection. The bandwidth upper limit is the value of Bandwidth. Note When the service resource is NLB, TrafficControlMode is set to Scalability by default. You can set it to BandwidthLimit and modify the value of Bandwidth to provide a bandwidth upper limit. When the service resource is CLB, TrafficControlMode can only be set to BandwidthLimit, which indicates that the service provider provides default bandwidth throttling for each endpoint. When the service resource is GWLB, TrafficControlMode can only be set to Scalability.	BandwidthLimit

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	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.