This topic outlines the API operations for Express Connect. You can use this topic as a quick reference to find the operations that you need.
Express Connect circuits
| Feature categorization | API | Description | References |
| Basic Features | ListGeographicSubRegions | Call the ListGeographicSubRegions operation to query region information. | None |
| Dedicated Express Connect circuit connections | |||
| Create a dedicated Express Connect circuit connection | DescribeAccessPoints | Call the DescribeAccessPoints operation to query information about the access points of Express Connect circuits in a specified region. | Connection process for dedicated Express Connect circuits |
| OpenPhysicalConnectionService | Call the OpenPhysicalConnectionService operation to enable billing for outbound traffic. | ||
| GetPhysicalConnectionServiceStatus | Call the GetPhysicalConnectionServiceStatus operation to check whether billing for outbound traffic is enabled for the current account. | ||
| CreatePhysicalConnection | Call the CreatePhysicalConnection operation to apply for a connection over an Express Connect circuit. | ||
| CreatePhysicalConnectionSetupOrder | Call the CreatePhysicalConnectionSetupOrder operation to create an order for the initial installation fee. | ||
| ApplyPhysicalConnectionLOA | Call the ApplyPhysicalConnectionLOA operation to apply for a Letter of Authorization (LOA). | ||
| DescribePhysicalConnectionLOA | Call the DescribePhysicalConnectionLOA operation to query the LOA information of an Express Connect circuit. | ||
| CompletePhysicalConnectionLOA | Call the CompletePhysicalConnectionLOA operation to confirm the completion of the circuit installation. | ||
| CreatePhysicalConnectionOccupancyOrder | Call the CreatePhysicalConnectionOccupancyOrder operation to create an order for the resource usage fee. | ||
| ConfirmPhysicalConnection | Call the ConfirmPhysicalConnection operation to accept an Express Connect circuit. After you accept the circuit, its status changes to Confirmed. | ||
| EnablePhysicalConnection | Call the EnablePhysicalConnection operation to enable an Express Connect circuit that is in the Confirmed state. After the circuit is enabled, its status changes to Enabled. | ||
| ListBusinessAccessPoints | Call the ListBusinessAccessPoints operation to query information about the access points of an Express Connect circuit. | None | |
| Manage a dedicated Express Connect circuit connection | DescribePhysicalConnections | Call the DescribePhysicalConnections operation to query information about Express Connect circuits and shared Express Connect circuits that are created over the Express Connect circuits in a specified region. | Other operations |
| ModifyPhysicalConnectionAttribute | Call the ModifyPhysicalConnectionAttribute operation to modify the configuration of an Express Connect circuit. | ||
| CancelPhysicalConnection | Before an Express Connect circuit is enabled, call the CancelPhysicalConnection operation to cancel the connection request. After the request is canceled, the status of the circuit changes to Canceled. | ||
| TerminatePhysicalConnection | After an Express Connect circuit is enabled, call the TerminatePhysicalConnection operation to stop the connection over the circuit. | ||
| RecoverPhysicalConnection | Call the RecoverPhysicalConnection operation to resume a connection over an Express Connect circuit. | ||
| DeletePhysicalConnection | Call the DeletePhysicalConnection operation to delete an Express Connect circuit. | ||
| Manage a hosted connection over an Express Connect circuit | |||
| A partner creates a hosted connection for a tenant | CreateVirtualPhysicalConnection | A partner calls the CreateVirtualPhysicalConnection operation to create a hosted connection for a tenant. | |
| OpenPhysicalConnectionService | A tenant calls the OpenPhysicalConnectionService operation to enable billing for outbound traffic. | ||
| GetPhysicalConnectionServiceStatus | A tenant calls the GetPhysicalConnectionServiceStatus operation to check whether billing for outbound traffic is enabled for the current account. | ||
| CreatePhysicalConnectionOccupancyOrder | A tenant calls the CreatePhysicalConnectionOccupancyOrder operation to create an order for the resource usage fee. | ||
| ConfirmPhysicalConnection | A tenant calls the ConfirmPhysicalConnection operation to accept a hosted connection. After the tenant accepts the connection, its status changes to Confirmed. | ||
| A partner converts an existing virtual border router (VBR) for a tenant to a shared port | CreateVpconnFromVbr | A partner calls the CreateVpconnFromVbr operation to convert an existing shared Express Connect circuit that uses a VBR. The conversion changes the sharing method from pushing a cross-account VBR to pushing a cross-account shared port. | |
| OpenPhysicalConnectionService | A tenant calls the OpenPhysicalConnectionService operation to enable billing for outbound traffic. | ||
| GetPhysicalConnectionServiceStatus | A tenant calls the GetPhysicalConnectionServiceStatus operation to check whether billing for outbound traffic is enabled for the current account. | ||
| CreatePhysicalConnectionOccupancyOrder |
| ||
| ConfirmPhysicalConnection | A tenant calls the ConfirmPhysicalConnection operation to accept a hosted connection. After the tenant accepts the connection, its status changes to Confirmed. | ||
| AttachVbrToVpconn | A partner calls the AttachVbrToVpconn operation to associate a VBR with a hosted connection. | ||
| Manage a hosted connection over an Express Connect circuit | ListVirtualPhysicalConnections | Call the ListVirtualPhysicalConnections operation to query information about hosted connections. | None |
| UpdateVirtualPhysicalConnection | A partner calls the UpdateVirtualPhysicalConnection operation to modify the estimated bandwidth of a hosted connection. Then, the partner can call the DescribePhysicalConnections and ListVirtualPhysicalConnections operations to view the estimated bandwidth. The new bandwidth takes effect only after the payment is complete. | None | |
| TerminatePhysicalConnection | After a hosted connection is enabled, call the TerminatePhysicalConnection operation to stop the connection. | Stop an instance connection | |
| RecoverPhysicalConnection | Call the RecoverPhysicalConnection operation to resume a connection over an Express Connect circuit. | None | |
| DeletePhysicalConnection | Call the DeletePhysicalConnection operation to delete a hosted connection. | Delete a shared port | |
Virtual border routers
| API | Description | References |
| Configure a VBR | ||
| CreateVirtualBorderRouter | Call the CreateVirtualBorderRouter operation to create a VBR. | Create a VBR instance |
| DescribeVirtualBorderRouters | Call the DescribeVirtualBorderRouters operation to query information about created VBRs. | None |
| DescribeVirtualBorderRoutersForPhysicalConnection | Call the DescribeVirtualBorderRoutersForPhysicalConnection operation to query information about the VBRs that are created over a specified Express Connect circuit. The VBRs can belong to the owner of the Express Connect circuit or other accounts. | None |
| ModifyVirtualBorderRouterAttribute | Call the ModifyVirtualBorderRouterAttribute operation to modify the configuration of a VBR. | Modify the bandwidth of a VBR |
| UpdateVirtualBorderBandwidth | Call the UpdateVirtualBorderBandwidth operation to modify the bandwidth limit of a VBR. | Modify the bandwidth of a VBR |
| DeleteVirtualBorderRouter | Call the DeleteVirtualBorderRouter operation to delete a VBR. | Delete a VBR instance |
| Associate a VBR with an Express Connect circuit | ||
| AssociatePhysicalConnectionToVirtualBorderRouter | Call the AssociatePhysicalConnectionToVirtualBorderRouter operation to associate a VBR with an Express Connect circuit. | None |
| UnassociatePhysicalConnectionFromVirtualBorderRouter | Call the UnassociatePhysicalConnectionFromVirtualBorderRouter operation to dissociate a VBR from an Express Connect circuit. | None |
| Stop a VBR | ||
| TerminateVirtualBorderRouter | Call the TerminateVirtualBorderRouter operation to stop a VBR. | None |
| RecoverVirtualBorderRouter | Call the RecoverVirtualBorderRouter operation to resume a stopped VBR. | None |
| Configure a failover group | ||
| CreateVbrHa | Call the CreateVbrHa operation to create a VBR failover group. | Configure a failover group |
| DescribeVbrHa | Call the DescribeVbrHa operation to query created VBR failover groups. | None |
| DeleteVbrHa | Call the DeleteVbrHa operation to delete a VBR failover group. | None |
| Configure prefix-based routing | ||
| UpdateVbrAllowPrefixes | Call the UpdateVbrAllowPrefixes operation to update prefix-based routes. | Add and manage routes that are synchronized based on a specified CIDR block |
| DescribeVbrAllowPrefixes | Call the DescribeVbrAllowPrefixes operation to query the prefix-based routes of a VBR that are taking effect or being modified. | |
| DescribeVbrAllowPrefixesHistory | Call the DescribeVbrAllowPrefixesHistory operation to view the reference history of the prefix-based routes of a VBR. | |
| Configure routes for a VBR | ||
| CreateRouteEntry | Call the CreateRouteEntry operation to create a custom route entry in the route table of a VPC router or a VBR. | Add a custom route entry |
| DescribeRouteEntryList | Call the DescribeRouteEntryList operation to query a list of routes. | None |
| DeleteRouteEntry | Call the DeleteRouteEntry operation to delete a custom route entry. | Delete a custom route entry |
| ModifyRouteEntry | Call the ModifyRouteEntry operation to modify the name and description of a custom route entry. | None |
BGP
| API | Description | References |
| Configure a BGP group | ||
| CreateBgpGroup | Call the CreateBgpGroup operation to create a Border Gateway Protocol (BGP) group for a specified VBR. | Create a BGP group |
| DescribeBgpGroups | Call the DescribeBgpGroups operation to query information about BGP groups in a specified region. | None |
| ModifyBgpGroupAttribute | Call the ModifyBgpGroupAttribute operation to modify the configuration of a BGP group. | None |
| DeleteBgpGroup | Call the DeleteBgpGroup operation to delete a specified BGP group. | None |
| Configure a BGP peer | ||
| CreateBgpPeer | Call the CreateBgpPeer operation to add a BGP peer to a specified BGP group. | Create a BGP peer |
| DescribeBgpPeers | Call the DescribeBgpPeers operation to query information about BGP peers in a specified region. | |
| ModifyBgpPeerAttribute | Modifies the properties of a BGP peer. | None |
| DeleteBgpPeer | Call the DeleteBgpPeer operation to delete a specified BGP peer. | None |
| Configure BGP networks | ||
| AddBgpNetwork | Call the AddBgpNetwork operation to advertise a BGP network. | Advertise a BGP network |
| DescribeBgpNetworks | Call the DescribeBgpNetworks operation to query advertised BGP networks. | None |
| DeleteBgpNetwork | Call the DeleteBgpNetwork operation to delete an advertised BGP network. | None |
Router interfaces
| API | Description |
| CreateRouterInterface | Call the CreateRouterInterface operation to create a router interface. |
| DescribeRouterInterfaceAttribute | Call the DescribeRouterInterfaceAttribute operation to view the configuration of a router interface. |
| DescribeRouterInterfaces | Call the DescribeRouterInterfaces operation to query information about router interfaces in a specified region. |
| ConnectRouterInterface | Call the ConnectRouterInterface operation to initiate a connection from a requester router interface to an accepter router interface. |
| ActivateRouterInterface | Call the ActivateRouterInterface operation to activate a router interface that is in the Inactive state. |
| GrantInstanceToVbr | Call the GrantInstanceToVbr operation to grant permissions on a VPC-connected instance to a VBR instance in a cross-account VBR connection scenario. |
| RevokeInstanceFromVbr | Call the RevokeInstanceFromVbr operation to revoke the permissions on a VPC-connected instance from a VBR instance in a cross-account VBR connection scenario. |
| DescribeEcGrantRelation | Call the DescribeEcGrantRelation operation to query the authorization relationship between a VPC-connected instance and a VBR instance in a cross-account VBR connection scenario. |
| ModifyRouterInterfaceSpec | Call the ModifyRouterInterfaceSpec operation to modify the specification of a router interface. |
| ModifyRouterInterfaceAttribute | Call the ModifyRouterInterfaceAttribute operation to modify the configuration of a router interface. |
| DeactivateRouterInterface | Call the DeactivateRouterInterface operation to freeze a router interface. |
| DeleteRouterInterface | Call the DeleteRouterInterface operation to delete a router interface. |
Tags
| API | Description |
| UntagResourcesForExpressConnect | Call the UntagResourcesForExpressConnect operation to detach tags from a list of specified Express Connect resources. |
| ListTagResourcesForExpressConnect | Call the ListTagResourcesForExpressConnect operation to query a list of tags that are attached to Express Connect resources. |
| TagResourcesForExpressConnect | Call the TagResourcesForExpressConnect operation to create and attach tags to specified Express Connect circuit instances. |
| DescribeTagKeysForExpressConnect | Call the DescribeTagKeysForExpressConnect operation to return a list of tags for Express Connect. |
Resource groups
| API | Description |
| ChangeResourceGroup | Call the ChangeResourceGroup operation to change the resource group to which an Express Connect circuit resource belongs. |
该文章对您有帮助吗？