Tenant Cloud Network Virtual Private Cloud VPN Gateway APIs DescribeVpnConnections

DescribeVpnConnections

Last Updated At: 2026-08-03 00:05:57

1. Interface Description

Interface request domain name: vpc.api3.convergecloud.com.

This API (DescribeVpnConnections) is used to query the VPN tunnel list.

Default interface request rate limit: 100 times per second.

Interface update time: 2019-10-23 04:36:13.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeVpnConnections
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
VpnConnectionIds No No Array of String VPN tunnel instance ID, e.g., vpnx-f49l6u0z. The maximum number of instances per request is 100. Parameters VpnConnectionIds and Filters must not be specified simultaneously.
Example: vpnx-f49l6u0z
Filters No No Array of Filter Filtering conditions. Each request can include up to 10 Filters, with a maximum of 5 values for each Filter.Values. The parameters VpnConnectionIds and Filters cannot be specified simultaneously.
  • vpc-id - String - VPC instance ID, such as vpc-0a36uwkr.
  • vpn-gateway-id - String - VPN gateway instance ID, such as vpngw-p4lmqawn.
  • customer-gateway-id - String - customer gateway instance ID, such as cgw-l4rblw63.
  • vpn-connection-name - String - channel name, such as demo-vpn.
  • vpn-connection-id - String - channel instance ID, such as vpnx-5p7vkch8".

    • Example:View
    Offset No No Uint64 Offset. The default value is 0. For further introduction about Offset, refer to the relevant sections in the API Overview.
    Example: 0
    Limit No No Uint64 Number of returns, 20 by default, up to 100.
    Example: 10

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of eligible instances.
    Example: 1
    VpnConnectionSet Array of VpnConnection VPN tunnel instance.
    Example:View
    RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

    4. Error Code

    The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

    Error Code Description
    InvalidParameterValue.Malformed Invalid input format.
    ResourceNotFound The resource does not exist
    InvalidParameter.Coexist The parameters must not be specified simultaneously.