Help Center/ Enterprise Switch/ API Reference/ Layer 2 Connection/ Binding a Virtual IP Address to a Layer 2 Connection

Updated on 2025-12-04 GMT+08:00

View PDF

Binding a Virtual IP Address to a Layer 2 Connection

Function

This API is used to bind a virtual IP address to a Layer 2 connection.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
esw:connection:bindVport	Write	-	-	-	-

URI

POST /v3/{project_id}/l2cg/connections/{connection_id}/vports/bind

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
connection_id	Yes	String	Definition: ID of a Layer 2 connection. Constraints: The value is in the UUID format with hyphens (-). Range: N/A Default value: N/A
project_id	Yes	String	Definition: ID of the project to which the enterprise switch belongs. Constraints: N/A Range: N/A Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
vport	Yes	Vport object	Definition: Request body for binding a virtual IP address port. Constraints: N/A Range: N/A Default value: N/A

**Table 3** Vport
Parameter	Mandatory	Type	Description
id	Yes	String	Definition: Unique ID of the virtual IP address. Constraints: The value must be the ID of a resource that can be operated by the current tenant. Range: N/A Default value: N/A

Response Parameters

Status code: 204

The POST operation is successful. For more status codes, see Status Codes.

None

Example Requests

POST https://{endpoint}/v3/05137572fa00d5eb2fdcc014b0f5c751/l2cg/connections/6a9c6b1a-0d5c-495a-8e0c-4f631bde397f/vports/bind

{
  "vport" : {
    "id" : "84beed10-ef3e-42a8-902c-9d6cdc0d4e20"
  }
}