调用DescribeVpnGatewayAttributes查看指定VPN网关的信息。

调试

API Explorer

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

去调试

请求参数

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

Action String 必选示例值：DescribeVpnGatewayAttributes

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

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

API版本信息。

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

待查看VPN网关的ID。您可调用DescribeVpnGateways查询VPN网关的ID信息。

返回参数

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

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

请求ID。

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

预期资源强制回收时间。

Tags Object[] 示例值：-

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

Key String 示例值：key1

标签键。

Value String 示例值：value1

标签值。

ProjectName String 示例值：Project_1

VPN网关所属的项目。

IpsecEnabled Boolean 示例值：true

是否开启IPSec功能。

true：开启

false：关闭

SslEnabled Boolean 示例值：false

是否开启SSL VPN功能。

true：开启

false：关闭

SslMaxConnections Integer 示例值：10

SSL连接数规格。

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

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

IsBlocked Boolean 示例值：false

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

true：封禁

false：未封禁

Asn Integer 示例值：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网关实例不返回该参数。

IpStackType String 示例值：ipv4_only

VPN 网关的协议类型。

ipv4_only：IPv4协议类型。

ipv6_only：IPv6协议类型。

ipv4_ipv6：双栈协议类型。

IpVersion String 示例值：ipv4

VPN网关的IP地址类型。

ipv4：IPv4地址类型。

ipv6：IPv6地址类型。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	MissingParameter	The request is missing a required parameter.	该请求缺少必要参数。
404	InvalidVpnGateway.NotFound	The specified VPN gateway does not exist.	指定的VPN网关不存在。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。
500	InternalError	An internal error has occurred.	发生内部错误。

VPN连接