调用DescribeVpnGateways查询满足指定条件的VPN网关。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeVpnGateways

要执行的操作，取值：DescribeVpnGateways。

Version String 必选示例值：2020-04-01

API版本信息。

PageSize Integer 可选示例值：20

查询结果的分页大小。最大值：100，默认值：20。

PageNumber Integer 可选示例值：1

查询结果的页码。

如需传入此参数，请传入非负整数。

不传或传入0，则均默认为1。

VpnGatewayIds.N String 可选示例值：vgw-3tehy14c6c0v****

VPN网关的ID。

参数 - N：表示VPN网关ID的序号。

多个ID之间用&分隔。

VpnGatewayName String 可选示例值：VpnGateway-test

VPN网关的名称。

VpcId String 可选示例值：vpc-3tijjfd0ul4bwbhc****

VPN网关所在VPC的ID。您可调用DescribeVpcs查询VPC的ID信息。

SubnetId String 可选示例值：subnet-3tijjfftzh4bwbhc****

VPN网关所在子网的ID。您可调用DescribeSubnets查询子网的ID信息。

IpAddress String 可选示例值：22.XX.XX.18

VPN网关的出口IP地址。

ProjectName String 可选示例值：Project_1

VPN网关所属的项目。

传入该字段，表示查询指定项目下的VPN网关实例。

不传入该字段，表示查询所有项目的VPN网关实例。

TagFilters.N.Key String 可选示例值：k1

根据标签查询资源时指定的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。

不允许重复。

TagFilters.N.Values.M String 可选示例值：v1

根据标签查询资源时指定的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。

多个标签值之间用&分隔。

如果传入该参数，则必须先传入TagFilters.N.Key。

如果不传该参数仅传入TagFilters.N.Key，表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.N，多个TagFilters.N.Values.N之间的关系为逻辑“或(OR)”。

IpsecEnabled Boolean 可选示例值：true

IPSec连接功能的开启状态。

true：开启

false：未开启

SslEnabled Boolean 可选示例值：false

SSL连接功能的开启状态。

true：开启

false：未开启

Status String 可选示例值：Available

VPN网关的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：可用

IpVersion String 可选示例值：ipv4

VPN网关的IP地址类型，取值如下：

ipv4：IPv4地址类型。

ipv6：IPv6地址类型。

IpStackType String 可选示例值：ipv4_only

VPN 网关的协议类型，取值如下：

ipv4_only：IPv4协议类型。

ipv6_only：IPv6协议类型。

ipv4_ipv6：双栈协议类型。

DualTunnelEnabled Boolean 可选示例值：enable

VPN网关是否为双隧道模式，取值如下：

enable：双隧道模式。

disable：单隧道模式。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：20220322145233010225243081016A****

请求ID。

PageSize Integer 示例值：20

当前分页的行数。

PageNumber Integer 示例值：1

当前页码。

TotalCount Integer 示例值：33

符合查询条件的VPN网关总数。

VpnGateways Object[] 示例值：-

VPN网关信息集合。

AccountId String 示例值：20005****

VPN网关所属账户的ID。

VpnGatewayId String 示例值：vgw-3tehy13n2l4c6c0v****

VPN网关的ID。

VpcId String 示例值：vpc-1234567****

VPN网关所在VPC的ID。

SubnetId String 示例值：subnet-3thgqai7my4e8i4****

VPN网关使用的端口所属子网的ID。

CreationTime String 示例值：2021-04-09T08:36:47+08:00

创建VPN网关的时间。

UpdateTime String 示例值：2021-04-10T08:36:47+08:00

更新VPN网关的时间。

VpnGatewayName String 示例值：VpnGateway-test

VPN网关的名称。

IpAddress String 示例值：202.XX.XX.19

VPN网关的IP地址。

Description String 示例值：This is a sample description

VPN网关的描述。

Status String 示例值：Available

VPN网关的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：可用

Bandwidth Integer 示例值：20

VPN网关的带宽规格。

ConnectionCount Integer 示例值：10

VPN网关关联的IPsec连接的数量。

RouteCount Integer 示例值：20

VPN网关上的路由条目数量。

BillingType Integer 示例值：1

VPN网关的计费类型。

1：包年包月。

2：按量计费（按固定配置）。

BusinessStatus String 示例值：Normal

VPN网关的计费状态。

Normal: 正常。

FinancialLocked: 被锁定。

LockReason String 示例值：unlock

VPN网关的锁定原因。

financial: 因欠费被锁定。

security: 因安全被锁定。

unlock ：未锁定。

ExpiredTime String 示例值：2022-04-21 23:59:59

VPN网关的到期时间。

DeletedTime String 示例值：2022-05-06 23:59:59

VPN网关的到期删除时间。

Tags Object[] 示例值：-

VPN网关已添加的全部标签信息。

Key String 示例值：key1

标签键。

Value String 示例值：value1

标签值。

ProjectName String 示例值：Project_1

VPN网关所属的项目。

IpsecEnabled Boolean 示例值：true

IPSec连接功能是否开启。

true：开启

false：关闭

SslEnabled Boolean 示例值：false

SSL连接功能是否开启。

true：开启

false：关闭

SslMaxConnections Integer 示例值：10

SSL连接数规格。

OverdueTime String 示例值：2023-08-07T23:23:23+08:00

资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。

IsBlocked Boolean 示例值：false

当前资源的状态是否被封禁。

true：封禁

false：未封禁

Asn Long 示例值：65534

VPN网关的ASN。

DualTunnelEnabled Boolean 示例值：true

VPN网关是否开启双隧道模式。

true：开启

false：关闭

SecondarySubnetId String 示例值：subnet-1b2f52ju7fojk17q7y1rk****

VPN网关实例关联的第二个子网的ID。

仅双隧道模式的VPN网关实例返回该参数，单隧道模式的VPN网关实例不返回该参数。

SecondaryIpAddress String 示例值：47.XX.XX.22

VPN网关的第二个公网IP地址。

仅双隧道模式的VPN网关实例返回该参数，单隧道模式的VPN网关实例不返回该参数。

IpVersion String 示例值：ipv4

VPN网关的IP地址类型。

ipv4：IPv4地址类型。

ipv6：IPv6地址类型。

IpStackType String 示例值：ipv4_only

VPN 网关的协议类型。

ipv4_only：IPv4协议类型。

ipv6_only：IPv6协议类型。

ipv4_ipv6：双栈协议类型。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidResourceType.NotFound	The specified resource type does not exist.	指定的资源类型不存在。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。
400	LimitExceeded.VpnGatewayId	You've reached the limit on the number of VPN gateway IDs that you can describe.	已达到可查询的VPN网关ID数量上限。
400	MissingParameter	The request is missing a required parameter.	该请求缺少必要参数。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。
500	InternalError	An internal error has occurred.	发生内部错误。

VPN连接