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

查询VPN网关

最近更新时间: 2024-09-03 18:49:50

1. 接口描述

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

本接口（DescribeVpnGateways）用于查询VPN网关列表。

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

接口更新时间：2019-11-07 16:58:10。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeVpnGateways
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，详见产品支持的地域列表(TODO)
VpnGatewayIds 否 否 Array of String VPN网关实例ID。形如：vpngw-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpnGatewayIds和Filters。
Filters 否 否 Array of FilterObject 过滤条件，参数不支持同时指定VpnGatewayIds和Filters。<br><li>vpc-id - String - （过滤条件）VPC实例ID形如：vpc-f49l6u0z。</li><br><li>vpn-gateway-id - String - （过滤条件）VPN实例ID形如：vpngw-5aluhh9t。</li><br><li>vpn-gateway-name - String - （过滤条件）VPN实例名称。</li><br><li>type - String - （过滤条件）VPN网关类型：'IPSEC', 'SSL'。</li><br><li>public-ip-address- String - （过滤条件）公网IP。</li><br><li>renew-flag - String - （过滤条件）网关续费类型，手动续费：'NOTIFY_AND_MANUAL_RENEW'、自动续费：'NOTIFY_AND_AUTO_RENEW'。</li><br><li>zone - String - （过滤条件）VPN所在可用区，形如：ap-guangzhou-2。</li>
Offset 否 否 Uint64 偏移量
Limit 否 否 Uint64 请求对象个数

3. 输出参数

参数名称 类型 描述
TotalCount Uint64 此参数对外不可见。
符合条件的实例数量。
VpnGatewaySet VpnGateway 此参数对外不可见。
VPN网关实例详细信息列表。
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidVpnGatewayId.Malformed
InvalidVpnGatewayId.NotFound