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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeVpnGateway

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

RegionId String 是 cn-shanghai

VPN网关所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

VpnGatewayId String 是 vpn-bp1r3v1xqkl0w519g****

VPN网关实例ID。

IncludeReservationData Boolean 否 true

是否包含未生效的订单数据，取值：

  • false（默认）：不包含未生效的订单数据。
  • true：包含未生效的订单数据。

返回数据

名称 类型 示例值 描述
VpnGatewayId String vpn-bp1r3v1xqkl0w519g****

VPN网关实例ID。
VpcId String vpc-bp19m2yx1m5q0avyq****

VPN网关所属VPC的ID。
VSwitchId String vsw-bp1dmzugdikc6hdgx****

VPN网关所属交换机的ID。
InternetIp String 47.XX.XX.22

VPN网关的公网IP地址。
CreateTime Long 1495382400000

创建VPN网关的时间戳。
EndTime Long 1495382400000

VPN网关到期时间戳。
Spec String 5

VPN网关的带宽规格。单位：Mbps。
Name String vpngatewayname

VPN网关的名称。
Description String vpngatewaydescription

VPN网关的描述信息。
Status String init

VPN网关的状态。

  • init：初始化。
  • provisioning：准备中。
  • active：正常。
  • updating：更新中。
  • deleting：删除中。
BusinessStatus String Normal

VPN网关的付费状态。

  • Normal：正常。
  • FinancialLocked：欠费锁定。
AutoPropagate Boolean true

是否将BGP路由自动传播到VPC。

  • true：自动传播。
  • false：不自动传播。
ChargeType String 中国站示例值：Prepay，国际站示例值：POSTPAY

付费类型。仅取值：

Prepay，包年包月。

EnableBgp Boolean true

VPN网关BGP功能的开启状态。

  • true：已开启。
  • false：未开启。
IpsecVpn String enable

是否开启了IPsec-VPN功能。

  • enable：已开启。
  • disable：未开启。
RequestId String 27E4E088-8DE0-4672-BF5C-0A412389DB9E

请求ID。
ReservationData Struct

未生效的订单数据。

说明 仅 IncludeReservationData传入 true才会返回该组参数。
ReservationEndTime String 2020-07-20T16:00:00Z

如果未生效订单类型为TEMP_UPGRADE（临时升配）时，该参数表示为临时升配的还原时间。

如果未生效订单类型为RENEWCHANGE（续费变配）或RENEW（续费）时，该参数表示为续费或续费变配开始生效时间。

ReservationIpsec String enable

未生效订单IPsec-VPN功能开启状态。

  • enable：已开启。
  • disable：未开启。
ReservationMaxConnections Integer 5

未生效订单SSL-VPN并发连接用户数的规格。
ReservationOrderType String TEMP_UPGRADE

未生效订单类型。

  • RENEWCHANGE：续费变配。
  • TEMP_UPGRADE：临时升配。
  • RENEW：续费。
ReservationSpec String 5

未生效订单的带宽规格。单位：Mbps。
ReservationSsl String enable

未生效订单SSL-VPN功能开启状态。

  • enable：已开启。
  • disable：未开启。
Status String 1

未生效订单状态。

  • 1：表示续费或续费变配的订单未生效。
  • 2：表示临时升配的订单已生效。在到达还原时间后，系统会将VPN网关规格恢复到临时升配前的规格。此时ReservationIpsec、ReservationMaxConnections、ReservationSpec、ReservationSsl表示为VPN网关临时升配前的规格。
SslMaxConnections Long 5

SSL-VPN并发连接用户数的规格。
SslVpn String enable

SSL-VPN功能的开启状态。

  • enable：已开启。
  • disable：未开启。
Tag String {\"VpnNewImage\":\"true\",\"VpnVersion\":\"v1.2.2\"}

系统自动生成的VPN网关标签。
Tags Array of Tag

您自定义的VPN网关标签。
Tag
Key String aaa

标签键。
Value String bbb

标签值。
VpnType String Normal

VPN网关类型。取值：

  • Normal：普通型。
  • NationalStandard：国密型。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpnGateway
&RegionId=cn-shanghai
&VpnGatewayId=vpn-bp1r3v1xqkl0w519g****
&<公共请求参数>

正常返回示例

XML格式 

<DescribeVpnGatewayResponse>
  <Status>active</Status>
  <IpsecVpn>enable</IpsecVpn>
  <SslVpn>disable</SslVpn>
  <VpnType>Normal</VpnType>
  <EnableBgp>false</EnableBgp>
  <RequestId>27E4E088-8DE0-4672-BF5C-0A412389DB9E</RequestId>
  <EndTime>1616428800000</EndTime>
  <VSwitchId>vsw-bp1dmzugdikc6hdgx****</VSwitchId>
  <CreateTime>1613974090000</CreateTime>
  <BusinessStatus>Normal</BusinessStatus>
  <Name></Name>
  <VpcId>vpc-bp19m2yx1m5q0avyq****</VpcId>
  <InternetIp>47.XX.XX.22</InternetIp>
  <VpnGatewayId>vpn-bp1r3v1xqkl0w519g****</VpnGatewayId>
  <ChargeType>Prepay</ChargeType>
  <Tag>{"VpnNewImage":"true","VpnVersion":"v1.2.2"}</Tag>
  <Spec>5M</Spec>
</DescribeVpnGatewayResponse>

JSON格式 

{
  "Status": "active",
  "IpsecVpn": "enable",
  "SslVpn": "disable",
  "VpnType": "Normal",
  "EnableBgp": false,
  "RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "EndTime": 1616428800000,
  "VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
  "CreateTime": 1613974090000,
  "BusinessStatus": "Normal",
  "Name": "",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "InternetIp": "47.XX.XX.22",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "ChargeType": "Prepay",
  "Tag": "{\"VpnNewImage\":\"true\",\"VpnVersion\":\"v1.2.2\"}",
  "Spec": "5M"
}

错误码

HttpCode 错误码 错误信息 描述
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 网关是否正确。

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