租户端 网络 私有网络（VPC） VPN网关相关接口 DescribeVpnConnections

DescribeVpnConnections

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名： vpc.api3.gsesgpucloud.com。

本接口（DescribeVpnConnections）查询VPN通道列表。

默认接口请求频率限制：100次/秒。

接口更新时间：2019-10-21 20:36:13。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeVpnConnections
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
VpnConnectionIds 否 否 Array of String VPN通道实例ID。形如：vpnx-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpnConnectionIds和Filters。
示例值：
Filters 否 否 Array of Filter 过滤条件。每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定VpnConnectionIds和Filters。
  • vpc-id - String - VPC实例ID，形如：vpc-0a36uwkr。
  • vpn-gateway-id - String - VPN网关实例ID，形如：vpngw-p4lmqawn。
  • customer-gateway-id - String - 对端网关实例ID，形如：cgw-l4rblw63。
  • vpn-connection-name - String - 通道名称，形如：test-vpn。
  • vpn-connection-id - String - 通道实例ID，形如：vpnx-5p7vkch8"。

    • 示例值：查看
    Offset 否 否 Uint64 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值：
    Limit 否 否 Uint64 返回数量，默认为20，最大值为100。
    示例值：

    3. 输出参数

    参数名称 类型 描述
    TotalCount Uint64 符合条件的实例数量。
    示例值：
    VpnConnectionSet VpnConnection VPN通道实例。
    示例值：查看
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。
    InvalidParameter.Coexist 参数不支持同时指定。