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.
VPN gateway
| API | Title | Description |
|---|---|---|
| CreateVpnGateway | CreateVpnGateway | Creates a VPN gateway. |
| DeleteVpnGateway | DeleteVpnGateway | Deletes a VPN gateway. |
| ModifyVpnGatewayAttribute | ModifyVpnGatewayAttribute | Modifies the name and description of a VPN Gateway or the automatic route advertisement feature. |
| MoveVpnResourceGroup | MoveVpnResourceGroup | Moves a VPN gateway resource to a new resource group. |
| DescribeVpnGateway | DescribeVpnGateway | Queries the detailed information about a VPN gateway. |
| DescribeVpnGateways | DescribeVpnGateways | Queries VPN gateways in a region. |
| DiagnoseVpnGateway | DiagnoseVpnGateway | Diagnoses a VPN gateway. |
| GetVpnGatewayDiagnoseResult | GetVpnGatewayDiagnoseResult | Queries the diagnostic result of a VPN gateway. |
| DescribeVpnGatewayAvailableZones | DescribeVpnGatewayAvailableZones | Queries zones that support IPsec-VPN connections in a region. |
Customer gateway
| API | Title | Description |
|---|---|---|
| CreateCustomerGateway | CreateCustomerGateway | Creates a customer gateway. |
| DeleteCustomerGateway | DeleteCustomerGateway | Deletes a customer gateway. |
| ModifyCustomerGatewayAttribute | ModifyCustomerGatewayAttribute | Modifies the configuration of a customer gateway. |
| DescribeCustomerGateway | DescribeCustomerGateway | Queries details of a customer gateway. |
| DescribeCustomerGateways | DescribeCustomerGateways | Queries customer gateways. |
Associate a VPN gateway
| API | Title | Description |
|---|---|---|
| CreateVpnConnection | CreateVpnConnection | Creates an IPsec-VPN connection. |
| DeleteVpnConnection | DeleteVpnConnection | Deletes an IPsec-VPN connection. |
| ModifyVpnConnectionAttribute | ModifyVpnConnectionAttribute | Modifies the configuration of an IPsec-VPN connection. |
| ModifyTunnelAttribute | ModifyTunnelAttribute | Modifies a VPN tunnel. |
| DescribeVpnConnection | DescribeVpnConnection | Queries the detailed information about an IPsec-VPN connection. |
| DescribeVpnConnections | DescribeVpnConnections | Queries IPsec-VPN connections. |
| DownloadVpnConnectionConfig | DownloadVpnConnectionConfig | Queries the configuration of an IPsec-VPN connection. |
| DescribeVpnConnectionLogs | DescribeVpnConnectionLogs | Queries logs of IPsec-VPN connections. |
| DiagnoseVpnConnections | DiagnoseVpnConnections | Diagnoses IPsec-VPN connections. |
| VPN gateway destination-based route | VPN gateway destination-based route | |
| CreateVpnRouteEntry | CreateVpnRouteEntry | Creates a destination-based route entry for a VPN gateway. |
| PublishVpnRouteEntry | PublishVpnRouteEntry | Advertises a VPN route to a VPC. |
| DeleteVpnRouteEntry | DeleteVpnRouteEntry | Deletes a destination-based route from a VPN gateway. |
| ModifyVpnRouteEntryWeight | ModifyVpnRouteEntryWeight | Modifies the weight of a destination-based route. |
| DescribeVpnRouteEntries | DescribeVpnRouteEntries | Queries destination-based and BGP route entries of a VPN gateway. |
| VPN gateway policy-based route | VPN gateway policy-based route | |
| CreateVpnPbrRouteEntry | CreateVpnPbrRouteEntry | Creates a policy-based route for a VPN gateway. |
| DeleteVpnPbrRouteEntry | DeleteVpnPbrRouteEntry | Deletes a policy-based route from a VPN gateway. |
| ModifyVpnPbrRouteEntryWeight | ModifyVpnPbrRouteEntryWeight | Modifies the weight of a policy-based route of a VPN gateway. |
| ModifyVpnPbrRouteEntryPriority | ModifyVpnPbrRouteEntryPriority | Modifies the priority of a policy-based route. |
| ModifyVpnPbrRouteEntryAttribute | ModifyVpnPbrRouteEntryAttribute | Modifies the weight and priority of a policy-based route. |
| DescribeVpnPbrRouteEntries | DescribeVpnPbrRouteEntries | Queries policy-based routes configured for a VPN gateway. |
Associate transit routers
| API | Title | Description |
|---|---|---|
| CreateVpnAttachment | CreateVpnAttachment | Creates an IPsec-VPN connection. After you create the IPsec-VPN connection, you can associate the IPsec-VPN connection with a transit router. |
| CreateVcoRouteEntry | CreateVcoRouteEntry | Adds a destination-based route for an IPsec-VPN connection. |
| DeleteVpnAttachment | DeleteVpnAttachment | Deletes an IPsec-VPN connection. |
| DeleteVcoRouteEntry | DeleteVcoRouteEntry | Deletes a destination-based route from an IPsec-VPN connection. |
| ModifyVpnAttachmentAttribute | ModifyVpnAttachmentAttribute | Modifies the configuration of an IPsec-VPN connection. |
| ModifyVcoRouteEntryWeight | ModifyVcoRouteEntryWeight | Modifies the weight of a destination-based route for an IPsec-VPN connection. |
| DescribeVpnAttachments | DescribeVpnAttachments | Queries the IPsec-VPN connections associated with a transit router. |
| DescribeVcoRouteEntries | DescribeVcoRouteEntries | Queries the routes of an IPsec-VPN connection. |
| CheckVpnBgpEnabled | CheckVpnBgpEnabled | Checks whether the region of an IPsec-VPN connection supports BGP. |
| DescribeVpnCrossAccountAuthorizations | DescribeVpnCrossAccountAuthorizations | Queries the cross-account authorization information about an IPsec-VPN connection. |
Tag
| API | Title | Description |
|---|---|---|
| TagResources | TagResources | Creates and adds tags to resources. |
| UnTagResources | UnTagResources | Removes tags from resources. |
| ListTagResources | ListTagResources | Queries the tags that are added to resources. |