API standard and pre-built SDKs in multi-language
This product (Vpc/2016-04-28) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Physical connection
| API | Title | Description |
|---|---|---|
| Virtual physical connection | Virtual physical connection | |
| CreateVirtualPhysicalConnection | CreateVirtualPhysicalConnection | Creates a hosted connection over Express Connect circuit. |
| UpdateVirtualPhysicalConnection | UpdateVirtualPhysicalConnection | Changes the virtual local area network (VLAN) ID of a hosted connection over Express Connect circuit. |
| ListVirtualPhysicalConnections | ListVirtualPhysicalConnections | Queries hosted connections. |
| OpenPhysicalConnectionService | OpenPhysicalConnectionService | Enables billing for outbound data transfer. |
| CreatePhysicalConnection | CreatePhysicalConnection | Applies for an Express Connect circuit. |
| ApplyPhysicalConnectionLOA | ApplyPhysicalConnectionLOA | Applies for a Letter of Authorization (LOA) for an Express Connect circuit. |
| SecondApplyPhysicalConnectionLOA | SecondApplyPhysicalConnectionLOA | If your application for a Letter of Authorization (LOA) by calling the ApplyPhysicalConnectionLOA operation is denied, you can call this operation to apply again. |
| CreatePhysicalConnectionSetupOrder | CreatePhysicalConnectionSetupOrder | Creates an order for initial installation of an Express Connect circuit. |
| CreatePhysicalConnectionOccupancyOrder | CreatePhysicalConnectionOccupancyOrder | Creates an order for resource occupation of an Express Connect circuit. |
| CreateHighReliablePhysicalConnection | CreateHighReliablePhysicalConnection | Creates Express Connect circuits in high reliability mode. This improves the stability of multiple Express Connect circuits and prevents service interruptions caused by single points of failures (SPOFs). |
| CreateVpconnFromVbr | CreateVpconnFromVbr | Adds a shared port to a hosted connection. |
| DeletePhysicalConnection | DeletePhysicalConnection | Deletes a connection over an Express Connect circuit. |
| CancelPhysicalConnection | CancelPhysicalConnection | Cancels an Express Connect circuit before it is enabled. After you perform this operation, the Express Connect circuit enters the Canceled state. |
| ModifyPhysicalConnectionAttribute | ModifyPhysicalConnectionAttribute | Modifies the configurations of an Express Connect circuit. |
| EnablePhysicalConnection | EnablePhysicalConnection | Enables an Express Connect circuit that is in the Confirmed state. After you perform this operation, the Express Connect circuit enters the Enabled state. |
| TerminatePhysicalConnection | TerminatePhysicalConnection | Disables an Express Connect circuit after it is enabled. |
| RecoverPhysicalConnection | RecoverPhysicalConnection | Resumes an Express Connect circuit. |
| AttachVbrToVpconn | AttachVbrToVpconn | Associates a virtual border router (VBR) with a hosted connection. |
| GetPhysicalConnectionServiceStatus | GetPhysicalConnectionServiceStatus | Checks whether outbound data transfer billing is enabled for the current account. |
| ConfirmPhysicalConnection | ConfirmPhysicalConnection | Changes the status of an Express Connect circuit to Confirmed. |
| DescribePhysicalConnections | DescribePhysicalConnections | Queries Express Connect circuits in a region. |
| ListPhysicalConnectionFeatures | ListPhysicalConnectionFeatures | Querying the connection features supported by a Express Connect circuit. |
| CompletePhysicalConnectionLOA | CompletePhysicalConnectionLOA | Generates a report for an installed Express Connect circuit. |
| DescribePhysicalConnectionLOA | DescribePhysicalConnectionLOA | Queries the LOA information about an Express Connect circuit. |
| ListGeographicSubRegions | ListGeographicSubRegions | Queries the most recent region list. |
| ListBusinessRegions | ListBusinessRegions | Queries the list of regions available for an Express Connect circuit. |
| ListBusinessAccessPoints | ListBusinessAccessPoints | Queries the access points of an Express Connect circuit. |
Failover test
| API | Title | Description |
|---|---|---|
| CreateFailoverTestJob | CreateFailoverTestJob | Creates a failover test. |
| StartFailoverTestJob | StartFailoverTestJob | Performs a failover test. |
| StopFailoverTestJob | StopFailoverTestJob | Terminates a failover test. |
| UpdateFailoverTestJob | UpdateFailoverTestJob | Updates a failover test. |
| DeleteFailoverTestJob | DeleteFailoverTestJob | Deletes a failover test. |
| DescribeFailoverTestJob | DescribeFailoverTestJob | Queries failover tests. |
| DescribeFailoverTestJobs | DescribeFailoverTestJobs | Queries failover tests for Express Connect. |
QoS
| API | Title | Description |
|---|---|---|
| DescribeExpressConnectTrafficQosRule | DescribeExpressConnectTrafficQosRule | Queries quality of service (QoS) rules. Paging parameters are not supported. |
| DescribeExpressConnectTrafficQosQueue | DescribeExpressConnectTrafficQosQueue | Queries the information about the quality of service (QoS) queues of the Express Connect circuit. |
| DescribeExpressConnectTrafficQos | DescribeExpressConnectTrafficQos | Queries the quality of service (QoS) policies of Express Connect. The response can be displayed by page. |
| DeleteExpressConnectTrafficQosQueue | DeleteExpressConnectTrafficQosQueue | Deletes a quality of service (QoS) queue. |
| DeleteExpressConnectTrafficQos | DeleteExpressConnectTrafficQos | Deletes a quality of service (QoS) policy. |
| DeleteExpressConnectTrafficQosRule | DeleteExpressConnectTrafficQosRule | Deletes a quality of service (QoS) rule. |
| ModifyExpressConnectTrafficQos | ModifyExpressConnectTrafficQos | Modifies a quality of service (QoS) policy or associates a QoS policy with a dedicated Express Connect circuit. |
| ModifyExpressConnectTrafficQosQueue | ModifyExpressConnectTrafficQosQueue | Modifies a quality of service (QoS) queue. |
| ModifyExpressConnectTrafficQosRule | ModifyExpressConnectTrafficQosRule | Modifies a quality of service (QoS) rule. |
| CreateExpressConnectTrafficQos | CreateExpressConnectTrafficQos | Creates a quality of service (QoS) policy. |
| CreateExpressConnectTrafficQosQueue | CreateExpressConnectTrafficQosQueue | Creates a quality of service (QoS) queue. |
| CreateExpressConnectTrafficQosRule | CreateExpressConnectTrafficQosRule | Creates a quality of service (QoS) rule. |
VBR
| API | Title | Description |
|---|---|---|
| VBR failover group | VBR failover group | |
| CreateVbrHa | CreateVbrHa | Creates a virtual border router (VBR) failover group. |
| DeleteVbrHa | DeleteVbrHa | Deletes a virtual border router (VBR) failover group. |
| DescribeVbrHa | DescribeVbrHa | Queries virtual border router (VBR) failover groups. |
| AssociatePhysicalConnectionToVirtualBorderRouter | AssociatePhysicalConnectionToVirtualBorderRouter | Associates a virtual border router (VBR) with a specified Express Connect circuit. |
| CreateVirtualBorderRouter | CreateVirtualBorderRouter | Creates a virtual border router (VBR). |
| DeleteVirtualBorderRouter | DeleteVirtualBorderRouter | Deletes a virtual border router (VBR). |
| UnassociatePhysicalConnectionFromVirtualBorderRouter | UnassociatePhysicalConnectionFromVirtualBorderRouter | Disassociates a virtual border router (VBR) from an Express Connect circuit. |
| UpdateVirtualBorderBandwidth | UpdateVirtualBorderBandwidth | Updates the maximum bandwidth value of outbound data transfer for a virtual border router (VBR). |
| ModifyVirtualBorderRouterAttribute | ModifyVirtualBorderRouterAttribute | Modifies the configuration of a virtual border router (VBR). |
| TerminateVirtualBorderRouter | TerminateVirtualBorderRouter | Terminates a virtual border router (VBR). |
| RecoverVirtualBorderRouter | RecoverVirtualBorderRouter | Enables a disabled virtual border router (VBR). |
| DescribeVirtualBorderRouters | DescribeVirtualBorderRouters | Queries virtual border routers (VBRs). |
| DescribeGrantRulesToEcr | DescribeGrantRulesToEcr | Queries the cross-account authorization list of an Express Connect Router (ECR). |
| DescribeVirtualBorderRoutersForPhysicalConnection | DescribeVirtualBorderRoutersForPhysicalConnection | Queries the virtual border routers (VBRs) that are associated with an Express Connect circuit. The VBRs can be created by the owner of the Express Connect circuit and by other Alibaba Cloud accounts. |
BGP
| API | Title | Description |
|---|---|---|
| AddBgpNetwork | AddBgpNetwork | Advertises a Border Gateway Protocol (BGP) network. |
| CreateBgpGroup | CreateBgpGroup | Creates a BGP group for a virtual border router (VBR). |
| CreateBgpPeer | CreateBgpPeer | Adds a Border Gateway Protocol (BGP) peer to a BGP group. |
| DeleteBgpGroup | DeleteBgpGroup | Deletes a Border Gateway Protocol (BGP) group. |
| DeleteBgpNetwork | DeleteBgpNetwork | Deletes an advertised Border Gateway Protocol (BGP) network. |
| DeleteBgpPeer | DeleteBgpPeer | Deletes a Border Gateway Protocol (BGP) peer. |
| ModifyBgpGroupAttribute | ModifyBgpGroupAttribute | Modifies the configuration of a Border Gateway Protocol (BGP) group. |
| ModifyBgpPeerAttribute | ModifyBgpPeerAttribute | Modifies the configuration of a BGP peer. |
| DescribeBgpGroups | DescribeBgpGroups | Queries BGP groups in a specified region. |
| DescribeBgpNetworks | DescribeBgpNetworks | Queries advertised Border Gateway Protocol (BGP) networks. |
| DescribeBgpPeers | DescribeBgpPeers | Queries Border Gateway Protocol (BGP) peers in a region. |
Tag
| API | Title | Description |
|---|---|---|
| TagResources | TagResources | Creates and adds tags to resources. |
| TagResourcesForExpressConnect | TagResourcesForExpressConnect | Creates tags and adds the tags to an Express Connect circuit. |
| UnTagResources | UnTagResources | Removes tags from resources. |
| UntagResourcesForExpressConnect | UntagResourcesForExpressConnect | Removes tags from an Express Connect circuit at a time. |
| ListTagResources | ListTagResources | Queries the tags that are added to resources. |
| DescribeTags | DescribeTags | Queries tags that meet the specified filter conditions. |
| DescribeTagKeys | DescribeTagKeys | Queries tag keys. |
| ListTagResourcesForExpressConnect | ListTagResourcesForExpressConnect | Queries the tags that are added to an Express Connect circuit. |
| DescribeTagKeysForExpressConnect | DescribeTagKeysForExpressConnect | Queries the tags of an Express Connect circuit. |
Router interface
| API | Title | Description |
|---|---|---|
| CreateRouterInterface | CreateRouterInterface | Creates a router interface. |
| DeleteRouterInterface | DeleteRouterInterface | Deletes a router interface. |
| DeleteExpressConnect | DeleteExpressConnect | Deletes a Express Connect instance, including the initiator and acceptor. |
| ModifyRouterInterfaceAttribute | ModifyRouterInterfaceAttribute | Modifies the configuration of a router interface. |
| ModifyRouterInterfaceSpec | ModifyRouterInterfaceSpec | Modifies the specification of a router interface. |
| DescribeRouterInterfaces | DescribeRouterInterfaces | Queries router interfaces in a specified region. |
| DescribeEcGrantRelation | DescribeEcGrantRelation | Queries whether permissions on a virtual private cloud (VPC) are granted to a virtual border router (VBR). |
| DescribeRouterInterfaceAttribute | DescribeRouterInterfaceAttribute | Queries the configuration of a router interface. |
| DeactivateRouterInterface | DeactivateRouterInterface | Deactivates a router interface. |
| GrantInstanceToVbr | GrantInstanceToVbr | Grants a virtual border router (VBR) the permissions to connect to a virtual private cloud (VPC) that belongs to another Alibaba Cloud account. |
| ActivateRouterInterface | ActivateRouterInterface | Activates a router interface that is in the Inactive state. |
| RevokeInstanceFromVbr | RevokeInstanceFromVbr | Revokes the permissions granted to a virtual border router (VBR) on a virtual private cloud (VPC). |
| ConnectRouterInterface | ConnectRouterInterface | Initiates a connection from the router interface of an initiator to the router interface of an accepter. |
Resource group
| API | Title | Description |
|---|---|---|
| MoveResourceGroup | MoveResourceGroup | Moves a resource to another resource group. |
| ChangeResourceGroup | ChangeResourceGroup | Moves an Express Connect circuit to a new resource group. |
Other
| API | Title | Description |
|---|---|---|
| DescribeVpcGrantRulesToEcr | DescribeVpcGrantRulesToEcr | Queries the cross-account authorization information of an ECR for a specified network instance. |