All Products
Search

This Product

    PrivateLink:EnableVpcEndpointZoneConnection

    Document Center

    PrivateLink:EnableVpcEndpointZoneConnection

    Last Updated:Feb 27, 2024

    Accepts a connection request from an endpoint in the specified zone.

    Operation description

    • You can call this operation only when the state of the endpoint is Connected and the state of the associated zone is Disconnected.

    • EnableVpcEndpointZoneConnection 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 ListVpcEndpointZones operation to check whether the endpoint service accepts a connection request from the endpoint in the associated zone.

      • If the zone is in the Connecting state, the endpoint service is accepting the connection request from the endpoint.
      • If the zone is in the Connected state, the endpoint service has accepted the connection request from the endpoint.

    • You cannot repeatedly call the EnableVpcEndpointZoneConnection operation to allow an endpoint service to accept a connection request from an endpoint in the associated zone 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

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The ID of the region where the endpoint connection request is accepted. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    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 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, 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****
    ZoneIdstringYes

    The ID of the zone that is associated with the endpoint.

    		cn-hangzhou-b

    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.
    400IncorrectBusinessStatus.VpcEndpointThe business status of %s [%s] is incorrect.-
    400IncorrectBusinessStatus.VpcEndpointServiceThe business status of %s [%s] is incorrect.-
    400IncorrectStatus.VpcEndpointThe status of %s [%s] is incorrect.-
    400IncorrectStatus.VpcEndpointConnectionThe status of %s [%s] is incorrect.-
    400IncorrectStatus.VpcEndpointServiceThe status of %s [%s] is incorrect.-
    400IncorrectStatus.VpcEndpointZoneThe status of %s [%s] is incorrect.-
    404ResourceNotFound.VpcEndpointThe specified resource %s is not found.-
    404ResourceNotFound.VpcEndpointConnectionThe specified resource %s is not found.-
    404ResourceNotFound.VpcEndpointServiceThe specified resource %s is not found.-
    404ResourceNotFound.VpcEndpointZoneThe specified resource %s is not found.-

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

    Change history

    Change timeSummary of changesOperation
    No change history