All Products
Search

This Product

    VPN Gateway:List of operations by function

    Document Center

    VPN Gateway:List of operations by function

    Last Updated:Dec 23, 2025
    This product(Vpc/2016-04-28) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts.
    Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

    VPN gateway

    APITitleDescription
    CreateVpnGatewayCreateVpnGatewayCreates a VPN gateway.
    DeleteVpnGatewayDeleteVpnGatewayDeletes a VPN gateway.
    ModifyVpnGatewayAttributeModifyVpnGatewayAttributeModifies the name and description of a VPN Gateway or the automatic route advertisement feature.
    MoveVpnResourceGroupMoveVpnResourceGroupMoves a VPN gateway resource to a new resource group.
    DescribeVpnGatewayDescribeVpnGatewayQueries the detailed information about a VPN gateway.
    DescribeVpnGatewaysDescribeVpnGatewaysQueries VPN gateways in a region.
    DiagnoseVpnGatewayDiagnoseVpnGatewayDiagnoses a VPN gateway.
    GetVpnGatewayDiagnoseResultGetVpnGatewayDiagnoseResultQueries the diagnostic result of a VPN gateway.
    DescribeVpnGatewayAvailableZonesDescribeVpnGatewayAvailableZonesQueries zones that support IPsec-VPN connections in a region.

    Customer gateway

    APITitleDescription
    CreateCustomerGatewayCreateCustomerGatewayCreates a customer gateway.
    DeleteCustomerGatewayDeleteCustomerGatewayDeletes a customer gateway.
    ModifyCustomerGatewayAttributeModifyCustomerGatewayAttributeModifies the configuration of a customer gateway.
    DescribeCustomerGatewayDescribeCustomerGatewayQueries details of a customer gateway.
    DescribeCustomerGatewaysDescribeCustomerGatewaysQueries customer gateways.

    Associate a VPN gateway

    APITitleDescription
    CreateVpnConnectionCreateVpnConnectionCreates an IPsec-VPN connection.
    DeleteVpnConnectionDeleteVpnConnectionDeletes an IPsec-VPN connection.
    ModifyVpnConnectionAttributeModifyVpnConnectionAttributeModifies the configuration of an IPsec-VPN connection.
    ModifyTunnelAttributeModifyTunnelAttributeModifies a VPN tunnel.
    DescribeVpnConnectionDescribeVpnConnectionQueries the detailed information about an IPsec-VPN connection.
    DescribeVpnConnectionsDescribeVpnConnectionsQueries IPsec-VPN connections.
    DownloadVpnConnectionConfigDownloadVpnConnectionConfigQueries the configuration of an IPsec-VPN connection.
    DescribeVpnConnectionLogsDescribeVpnConnectionLogsQueries logs of IPsec-VPN connections.
    DiagnoseVpnConnectionsDiagnoseVpnConnectionsDiagnoses IPsec-VPN connections.
    VPN gateway destination-based routeVPN gateway destination-based route
    CreateVpnRouteEntryCreateVpnRouteEntryCreates a destination-based route entry for a VPN gateway.
    PublishVpnRouteEntryPublishVpnRouteEntryAdvertises a VPN route to a VPC.
    DeleteVpnRouteEntryDeleteVpnRouteEntryDeletes a destination-based route from a VPN gateway.
    ModifyVpnRouteEntryWeightModifyVpnRouteEntryWeightModifies the weight of a destination-based route.
    DescribeVpnRouteEntriesDescribeVpnRouteEntriesQueries destination-based and BGP route entries of a VPN gateway.
    VPN gateway policy-based routeVPN gateway policy-based route
    CreateVpnPbrRouteEntryCreateVpnPbrRouteEntryCreates a policy-based route for a VPN gateway.
    DeleteVpnPbrRouteEntryDeleteVpnPbrRouteEntryDeletes a policy-based route from a VPN gateway.
    ModifyVpnPbrRouteEntryWeightModifyVpnPbrRouteEntryWeightModifies the weight of a policy-based route of a VPN gateway.
    ModifyVpnPbrRouteEntryPriorityModifyVpnPbrRouteEntryPriorityModifies the priority of a policy-based route.
    ModifyVpnPbrRouteEntryAttributeModifyVpnPbrRouteEntryAttributeModifies the weight and priority of a policy-based route.
    DescribeVpnPbrRouteEntriesDescribeVpnPbrRouteEntriesQueries policy-based routes configured for a VPN gateway.

    Associate transit routers

    APITitleDescription
    CreateVpnAttachmentCreateVpnAttachmentCreates an IPsec-VPN connection. After you create the IPsec-VPN connection, you can associate the IPsec-VPN connection with a transit router.
    CreateVcoRouteEntryCreateVcoRouteEntryAdds a destination-based route for an IPsec-VPN connection.
    DeleteVpnAttachmentDeleteVpnAttachmentDeletes an IPsec-VPN connection.
    DeleteVcoRouteEntryDeleteVcoRouteEntryDeletes a destination-based route from an IPsec-VPN connection.
    ModifyVpnAttachmentAttributeModifyVpnAttachmentAttributeModifies the configuration of an IPsec-VPN connection.
    ModifyVcoRouteEntryWeightModifyVcoRouteEntryWeightModifies the weight of a destination-based route for an IPsec-VPN connection.
    DescribeVpnAttachmentsDescribeVpnAttachmentsQueries the IPsec-VPN connections associated with a transit router.
    DescribeVcoRouteEntriesDescribeVcoRouteEntriesQueries the routes of an IPsec-VPN connection.
    CheckVpnBgpEnabledCheckVpnBgpEnabledChecks whether the region of an IPsec-VPN connection supports BGP.
    DescribeVpnCrossAccountAuthorizationsDescribeVpnCrossAccountAuthorizationsQueries the cross-account authorization information about an IPsec-VPN connection.

    Tag

    APITitleDescription
    TagResourcesTagResourcesCreates and adds tags to resources.
    UnTagResourcesUnTagResourcesRemoves tags from resources.
    ListTagResourcesListTagResourcesQueries the tags that are added to resources.