调用DescribeVpnGateway查询指定VPN网关的详细信息

调用DescribeVpnGateway接口查询指定VPN网关的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeVpnGateway	Read	VpnGateway acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	VPN网关所在的地域ID。您可以通过调用DescribeRegions接口获取地域ID。	ap-southeast-2
VpnGatewayId	string	是	VPN网关实例ID。	vpn-bp1r3v1xqkl0w519g****
IncludeReservationData	boolean	否	是否包含未生效的订单数据。取值： false（默认值）：不包含未生效的订单数据。 true：包含未生效的订单数据。	true

返回参数

名称	类型	描述	示例值
	object	返回结果。
VpnType	string	VPN网关类型。取值： Normal：普通型。 NationalStandard：国密型。	Normal
Status	string	VPN网关的状态。取值： init：初始化。 provisioning：准备中。 active：正常。 updating：更新中。 deleting：删除中。	init
VpcId	string	VPN网关所属VPC的ID。	vpc-bp19m2yx1m5q0avyq****
SslMaxConnections	long	SSL-VPN并发连接用户数的规格。	5
Spec	string	VPN网关的带宽规格。单位：Mbps。	5
InternetIp	string	在VPN网关实例支持创建单隧道模式IPsec-VPN连接的场景下，该地址为VPN网关实例的IP地址，可用于创建IPsec-VPN连接或SSL-VPN连接。在VPN网关实例支持创建双隧道模式IPsec-VPN连接的场景下，该地址为用于创建IPsec-VPN连接的第一个IP地址，不能用于创建SSL-VPN连接。在VPN网关实例支持创建双隧道模式IPsec-VPN连接的场景下，系统会为VPN网关实例分配两个IPsec地址，用于创建双隧道模式的IPsec-VPN连接。	47.22.XX.XX
CreateTime	long	创建VPN网关的时间戳。单位：毫秒。时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至创建VPN网关时的总时长。	1495382400000
AutoPropagate	boolean	是否将BGP路由自动传播到VPC。取值： true：自动传播。 false：不自动传播。	true
ChargeType	string	付费类型。仅取值： Prepay，包年包月。	中国站示例值：Prepay，国际站示例值：POSTPAY
VpnGatewayId	string	VPN网关实例ID。	vpn-bp1r3v1xqkl0w519g****
Tag	string	系统自动生成的VPN网关标签。 VpnEnableBgp：表示VPN网关是否支持BGP功能。 true：支持。 false：不支持。 VisuallySsl：表示VPN网关是否支持查看SSL客户端的连接信息。 true：支持。 false：不支持。 PbrPriority：表示VPN网关是否支持为策略路由配置策略优先级。 true：支持。 false：不支持。 VpnNewImage：表示VPN网关是否为新型VPN网关。 true：是。 false：否。 description：表示VPN网关的描述信息，仅供系统内部使用。 VpnVersion：表示VPN网关的版本号。	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.7\",\"VpnVersion\":\"v1.2.4\"}
IpsecVpn	string	是否开启了IPsec-VPN功能。取值： enable：已开启。 disable：未开启。	enable
EndTime	long	VPN网关到期时间戳。单位：毫秒。时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至VPN网关到期时的总时长。	1544666102000
VSwitchId	string	VPN网关所属交换机的ID。	vsw-bp1dmzugdikc6hdgx****
RequestId	string	请求ID。	27E4E088-8DE0-4672-BF5C-0A412389DB9E
Description	string	VPN网关的描述信息。	vpngatewaydescription
EnableBgp	boolean	VPN网关BGP功能的开启状态。取值： true：已开启。 false：未开启。	true
BusinessStatus	string	VPN网关的付费状态。取值： Normal：正常。 FinancialLocked：欠费锁定。	Normal
SslVpn	string	SSL-VPN功能的开启状态。取值： enable：已开启。 disable：未开启。	enable
Name	string	VPN网关的名称。	vpngatewayname
ReservationData	object	未生效的订单数据。说明仅IncludeReservationData传入true才会返回该组参数。
Status	string	未生效订单状态。取值： 1：表示续费或续费变配的订单未生效。 2：表示临时升配的订单已生效。在到达还原时间后，系统会将VPN网关规格恢复到临时升配前的规格。此时ReservationIpsec、ReservationMaxConnections、ReservationSpec、ReservationSsl表示为VPN网关临时升配前的规格。	1
ReservationOrderType	string	未生效订单类型。取值： RENEWCHANGE：续费变配。 TEMP_UPGRADE：临时升配。 RENEW：续费。	TEMP_UPGRADE
ReservationIpsec	string	未生效订单IPsec-VPN功能开启状态。取值： enable：已开启。 disable：未开启。	enable
ReservationSpec	string	未生效订单的带宽规格。单位：Mbps。	5
ReservationSsl	string	未生效订单SSL-VPN功能开启状态。取值： enable：已开启。 disable：未开启。	enable
ReservationMaxConnections	integer	未生效订单SSL-VPN并发连接用户数的规格。	5
ReservationEndTime	string	如果未生效订单类型为TEMP_UPGRADE（临时升配）时，该参数表示为临时升配的还原时间。如果未生效订单类型为RENEWCHANGE（续费变配）或RENEW（续费）时，该参数表示为续费或续费变配开始生效时间。	2020-07-20T16:00:00Z
Tags	object []	您自定义的VPN网关标签。
Key	string	标签键。	aaa
Value	string	标签值。	bbb
NetworkType	string	VPN网关的网络类型。 public：公网VPN网关。 private：私网VPN网关。	public
DisasterRecoveryInternetIp	string	系统为VPN网关实例分配的用于创建IPsec-VPN连接的第二个IP地址。仅支持创建双隧道模式IPsec-VPN连接的VPN网关实例会返回当前参数。	47.91.XX.XX
DisasterRecoveryVSwitchId	string	VPN网关实例关联的第二个交换机ID。仅支持创建双隧道模式IPsec-VPN连接的VPN网关实例会返回当前参数。	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	SSL-VPN连接的IP地址。仅支持创建双隧道模式IPsec-VPN连接的公网网络类型的VPN网关实例开启SSL-VPN功能后，才会返回当前参数。	47.74.XX.XX
ResourceGroupId	string	VPN网关所属的资源组ID。您可以调用ListResourceGroups接口查询资源组信息。	rg-acfmzs372yg****

示例

正常返回示例

JSON格式

{
  "VpnType": "Normal",
  "Status": "init",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections": 5,
  "Spec": "5",
  "InternetIp": "47.22.XX.XX",
  "CreateTime": 1495382400000,
  "AutoPropagate": true,
  "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.7\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\"}",
  "IpsecVpn": "enable",
  "EndTime": 1544666102000,
  "VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
  "RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "Description": "vpngatewaydescription",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "SslVpn": "enable",
  "Name": "vpngatewayname",
  "ReservationData": {
    "Status": "1",
    "ReservationOrderType": "TEMP_UPGRADE",
    "ReservationIpsec": "enable",
    "ReservationSpec": "5",
    "ReservationSsl": "enable",
    "ReservationMaxConnections": 5,
    "ReservationEndTime": "2020-07-20T16:00:00Z"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ]
  },
  "NetworkType": "public",
  "DisasterRecoveryInternetIp": "47.91.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "47.74.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	您没有权限操作该资源，请您申请操作权限后再试。
403	Forbidden	User not authorized to operate on the specified resource.	您没有权限操作指定资源，请申请权限后再操作。
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	指定的 VPN 网关不存在，请您检查 VPN 网关是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-10-19

OpenAPI 描述信息更新，OpenAPI 去除了 deprecated 标记，OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
API 描述	OpenAPI 描述信息更新
API 弃用说明(deprecated)	OpenAPI 去除了 deprecated 标记
错误码	OpenAPI 错误码发生变更
	删除错误码：403
	删除错误码：404
出参	OpenAPI 返回结构发生变更

2023-06-30

OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：403
	删除错误码：404
出参	OpenAPI 返回结构发生变更