All Products
Search
Document Center

PrivateLink:EnableVpcEndpointConnection

Last Updated:Feb 18, 2024

Accepts connection requests from an endpoint.

Operation description

  • EnableVpcEndpointConnection is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the GetVpcEndpointAttribute operation to query the state of the endpoint connection.

    • If the state is Connecting, the endpoint connection is being established.
    • If the state is Connected, the endpoint connection is established.
  • You cannot repeatedly call the EnableVpcEndpointConnection operation to allow an endpoint service of an Alibaba Cloud account to accept a connection request from an endpoint within a specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
privatelink:EnableVpcEndpointConnectionWRITE
  • VpcEndpointService
    acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the connection request is accepted.

You can call the DescribeRegions operation to query the most recent region list.

cn-huhehaote
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRunbooleanNo

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 parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
false
ServiceIdstringYes

The endpoint service ID.

epsrv-hp3vpx8yqxblby3i****
EndpointIdstringYes

The endpoint ID.

ep-hp33b2e43fays7s8****
BandwidthintegerNo

The bandwidth of the endpoint connection. Unit: Mbit/s. Valid values: 3072 to 10240.

Note The bandwidth of an endpoint connection is in the range of 100 to 10,240 Mbit/s. The default bandwidth is 3,072 Mbit/s. When the endpoint is connected to the endpoint service, the default bandwidth is the minimum bandwidth. In this case, the connection bandwidth range is 3,072 to 10,240 Mbit/s. If Classic Load Balancer (CLB) instances or Application Load Balancer (ALB) instances are specified as service resources, you can modify the endpoint connection bandwidth based on your business requirements. This parameter is invalid if Network Load Balancer (NLB) instances are specified as service resources.
1024

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400EndpointServiceNotFoundThe specified Service does not exist.The specified Service does not exist.
400EndpointConnectionNotFoundThe specified endpoint connection does not exist.The specified endpoint connection does not exist.
400EndpointConnectionOperationDeniedThe endpoint is being connected.The endpoint is being connected.
400EndpointOperationDeniedThe specified operation of endpoint is not allowed.The specified operation of endpoint is not allowed.

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

Change history

Change timeSummary of changesOperation
No change history