API standards and multilingual preset SDKs
The OpenAPI of this product (Vpc/2016-04-28) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
VPN gateway
|
API |
Title |
Description |
| CreateVpnGateway | Create a VPN gateway | Creates a VPN gateway. |
| CreateEnhancedVpnGateway | Create an enhanced VPN gateway | Creates an enhanced VPN gateway. |
| DeleteVpnGateway | Delete a specified VPN gateway | Deletes a specified VPN gateway. |
| ModifyVpnGatewayAttribute | Modify the name, description, or automatic route propagation feature of a VPN gateway | Modifies the name, description, or automatic route propagation feature of a VPN gateway. |
| MoveVpnResourceGroup | Modify the resource group of a VPN gateway resource | Modifies the resource group to which a VPN gateway resource belongs. |
| DescribeVpnGateway | Query details of a specified VPN gateway | Queries the details of a specified VPN gateway. |
| DescribeVpnGateways | Query created VPN gateways | Queries VPN gateways created in a specified region by calling the DescribeVpnGateways operation. |
| DiagnoseVpnGateway | Perform a one-click diagnosis on a specified VPN gateway instance | Calls the DiagnoseVpnGateway operation to perform a one-click diagnosis on a specified VPN gateway instance. |
| GetVpnGatewayDiagnoseResult | Query the one-click diagnosis result of a VPN gateway instance | Queries the one-click diagnosis result of a VPN gateway instance. |
| DescribeVpnGatewayAvailableZones | Query zones that support iPsec-VPN connection deployment in a specified region | Queries the list of zones that support IPsec-VPN connection deployment in a specified region. |
Customer gateway
|
API |
Title |
Description |
| CreateCustomerGateway | Create a customer gateway | Creates a customer gateway. |
| DeleteCustomerGateway | Delete a specified customer gateway | Deletes a specified customer gateway. |
| ModifyCustomerGatewayAttribute | Modify the name and description of a customer gateway | Modifies the configuration of a customer gateway. |
| DescribeCustomerGateway | Query a created customer gateway | Queries the details of a created customer gateway. |
| DescribeCustomerGateways | Query created customer gateways | Queries information about customer gateways. |
Associate VPN gateway instances
|
API |
Title |
Description |
| CreateVpnConnection | Create an iPsec-VPN connection | Creates an IPsec-VPN connection. |
| DeleteVpnConnection | Delete a specified iPsec-VPN connection | Deletes a specified IPsec-VPN connection. |
| ModifyVpnConnectionAttribute | Modify the configurations of an iPsec-VPN connection | Modifies the configurations of an IPsec-VPN connection. |
| ModifyTunnelAttribute | Modify VPN tunnel information | Calls the ModifyTunnelAttribute operation to modify the tunnel configuration of a high-availability VPN gateway. |
| DescribeVpnConnection | Query details of an iPsec-VPN connection | Queries the information about a specified IPsec-VPN connection. |
| DescribeVpnConnections | Query created iPsec-VPN connections | Queries information about IPsec-VPN connections. |
| DownloadVpnConnectionConfig | Retrieve the configuration of an iPsec-VPN connection | Retrieves the configuration of an IPsec-VPN connection by calling the DownloadVpnConnectionConfig operation. |
| DescribeVpnConnectionLogs | Query iPsec-VPN connection logs | Queries the log information of an IPsec-VPN connection by calling the DescribeVpnConnections operation. |
| DiagnoseVpnConnections | Diagnose iPsec-VPN connections | Diagnoses IPsec-VPN connections by calling the DiagnoseVpnConnections operation. |
| Destination-based routing | Destination-based routing | |
| CreateVpnRouteEntry | Create a destination route | Creates a destination route for a VPN gateway. After the destination route is created, the VPN gateway matches the destination route based on the destination IP address of the traffic and forwards the traffic based on the matched destination route. |
| PublishVpnRouteEntry | Publish or withdraw a VPN route | Publishes a destination-based route or policy-based route to the system route table of a VPC, or withdraws a published destination-based route or policy-based route from the system route table of a VPC. |
| DeleteVpnRouteEntry | Delete a VPN destination route | Deletes a VPN destination route. |
| ModifyVpnRouteEntryWeight | Modify the weight of a destination route | Modifies the weight of a destination route. |
| DescribeVpnRouteEntries | Query destination routes and BGP routes | Queries the destination route entries and BGP route entries of a VPN gateway instance. |
| Policy-based routing | Policy-based routing | |
| CreateVpnPbrRouteEntry | Create a VPN policy-based route | Creates a VPN policy-based route. |
| DeleteVpnPbrRouteEntry | Delete a policy-based route | Deletes a policy-based route. |
| ModifyVpnPbrRouteEntryWeight | Modify the weight of a VPN policy-based route | Modifies the weight of a VPN policy-based route. |
| ModifyVpnPbrRouteEntryPriority | Modify the policy priority of policy-based routing | Invokes the ModifyVpnPbrRouteEntryPriority operation to modify the policy priority of policy-based routing. |
| ModifyVpnPbrRouteEntryAttribute | Modify the weight and policy priority of policy-based routing | Invokes the ModifyVpnPbrRouteEntryAttribute operation to modify the weight and policy priority of policy-based routing. |
| DescribeVpnPbrRouteEntries | Query policy-based routes | Queries the policy-based routes configured for a VPN gateway instance by calling the DescribeVpnPbrRouteEntries operation. |
Associate transit router instances
|
API |
Title |
Description |
| CreateVpnAttachment | Create an iPsec-VPN connection | Creates an IPsec-VPN connection to be associated with a transit router instance by calling the CreateVpnAttachment operation. |
| CreateVcoRouteEntry | Add a destination route entry to an iPsec-VPN connection | Calls the CreateVcoRouteEntry operation to add a destination route entry to an IPsec-VPN connection. |
| DeleteVpnAttachment | Delete an iPsec-VPN connection | Deletes an IPsec-VPN connection. |
| DeleteVcoRouteEntry | Delete a destination route entry from an iPsec-VPN connection | Deletes a destination route entry from an IPsec-VPN connection. |
| ModifyVpnAttachmentAttribute | Modify the configuration of an iPsec-VPN connection | Modifies the configuration of an IPsec-VPN connection. |
| ModifyVcoRouteEntryWeight | Modify the weight of a destination route entry for an iPsec-VPN connection | Modifies the weight of a destination route entry for an IPsec-VPN connection. |
| DescribeVpnAttachments | Query configuration information of iPsec-VPN connections associated with transit router instances | Queries the configuration information of IPsec-VPN connections that are associated with transit router instances. |
| DescribeVcoRouteEntries | Query routes of an iPsec-VPN connection | Queries the route information of an IPsec-VPN connection by calling the DescribeVcoRouteEntries operation. |
| CheckVpnBgpEnabled | Query whether the region of an iPsec-VPN connection supports BGP | Calls the CheckVpnBgpEnabled operation to query whether the region to which an IPsec-VPN connection belongs supports the BGP feature. |
| DescribeVpnCrossAccountAuthorizations | Query cross-account authorization information of an iPsec-VPN connection | Queries the cross-account authorization information of an IPsec-VPN connection. |
Tags
|
API |
Title |
Description |
| TagResources | Create and bind tags to specified resources | Creates and binds tags to specified resources. |
| UnTagResources | Unbind tags from a list of resources | Unbinds tags from a specified list of resources. |
| ListTagResources | Query tags bound to cloud resources | Queries the tags that are bound to cloud resources. |