Tenant Cloud Network Virtual Private Cloud VPN Gateway APIs DescribeVpnGateways

DescribeVpnGateways

Last Updated At: 2026-08-02 00:06:22

1. Interface Description

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

This API (DescribeVpnGateways) is used to query a list of VPN gateways.

Default interface request rate limit: 100 times per second.

Interface update time: 2019-11-09 00:58:10.

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: DescribeVpnGateways
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
VpnGatewayIds No No Array of String VPN gateway instance ID, e.g., vpngw-f49l6u0z. The maximum number of instances per request is 100. Parameters VpnGatewayIds and Filters must not be specified simultaneously.
Example: vpngw-5aluhh9t
Filters No No Array of FilterObject Filter conditions. The parameters VpnGatewayIds and Filters cannot be specified at the same time.
  • vpc-id - String - VPC instance ID for filtering. For example, vpc-f49l6u0z.
  • vpn-gateway-id - String - VPN gateway instance ID for filtering. For example, vpngw-5aluhh9t.
  • vpn-gateway-name - String - VPN gateway instance name for filtering.
  • type - String - VPN gateway type for filtering. Valid values: 'IPSEC' and 'SSL'.
  • public-ip-address - String - Public IP address for filtering.
  • renew-flag - String - Gateway renewal type. 'NOTIFY_AND_MANUAL_renew': manual renewal; 'NOTIFY_AND_AUTO_renew': automatic renewal.
  • zone - String - VPN gateway availability zone for filtering. For example, ap-region-2.

    • Example:View
    Offset No No Uint64 Offset
    Example: 0
    Limit No No Uint64 Number of Request Objects
    Example: 20

    3. Output Parameters

    Parameter name Type Description
    TotalCount Uint64 Number of eligible instances.
    Example: 1
    VpnGatewaySet Array of VpnGateway VPN gateway instance detail list.
    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
    InvalidVpnGatewayId.Malformed Invalid VPN gateway. VPN instance ID is invalid.
    InvalidVpnGatewayId.NotFound Invalid VPN gateway. The VPN instance does not exist. Verify whether the resource information you entered is correct.