DocsICP FilingConsole
首页 DescribeVpnGateway

DescribeVpnGateway

更新时间: 2023-08-03 15:27:16

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

调试

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

请求参数

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

系统规定参数。取值：DescribeVpnGateway。
RegionId String 是 ap-southeast-2

VPN网关所在的地域ID。

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

VpnGatewayId String 是 vpn-bp1r3v1xqkl0w519g****

VPN网关实例ID。

IncludeReservationData Boolean 否 true

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

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

返回数据

名称 类型 示例值 描述
VpnType String Normal

VPN网关类型。

取值：

  • Normal：普通型。
  • NationalStandard：国密型。
Status String init

VPN网关的状态。取值：

  • init：初始化。
  • provisioning：准备中。
  • active：正常。
  • updating：更新中。
  • deleting：删除中。
VpcId String vpc-bp19m2yx1m5q0avyq****

VPN网关所属VPC的ID。
SslMaxConnections Long 5

SSL-VPN并发连接用户数的规格。
Spec String 5

VPN网关的带宽规格。单位：Mbps。
InternetIp String 47.22.XX.XX
  • 在VPN网关实例支持创建单隧道模式IPsec-VPN连接的场景下，该地址为VPN网关实例的IP地址，可用于创建IPsec-VPN连接或SSL-VPN连接。

  • 在VPN网关实例支持创建双隧道模式IPsec-VPN连接的场景下，该地址为用于创建IPsec-VPN连接的第一个IP地址，不能用于创建SSL-VPN连接。

    在VPN网关实例支持创建双隧道模式IPsec-VPN连接的场景下，系统会为VPN网关实例分配两个IPsec地址，用于创建双隧道模式的IPsec-VPN连接。
CreateTime Long 1495382400000

创建VPN网关的时间戳。单位：毫秒。

时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至创建VPN网关时的总时长。
AutoPropagate Boolean true

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

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

付费类型。仅取值：

Prepay，包年包月。
VpnGatewayId String vpn-bp1r3v1xqkl0w519g****

VPN网关实例ID。
Tag String {\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.7\",\"VpnVersion\":\"v1.2.4\"}

系统自动生成的VPN网关标签。

  • VpnEnableBgp：表示VPN网关是否支持BGP功能。
    • true：支持。
    • false：不支持。
  • VisuallySsl：表示VPN网关是否支持查看SSL客户端的连接信息。
    • true：支持。
    • false：不支持。
  • PbrPriority：表示VPN网关是否支持为策略路由配置策略优先级。
    • true：支持。
    • false：不支持。
  • VpnNewImage：表示VPN网关是否为新型VPN网关。
    • true：是。
    • false：否。
  • description：表示VPN网关的描述信息，仅供系统内部使用。
  • VpnVersion：表示VPN网关的版本号。
IpsecVpn String enable

是否开启了IPsec-VPN功能。取值：

  • enable：已开启。
  • disable：未开启。
EndTime Long 1544666102000

VPN网关到期时间戳。单位：毫秒。

时间戳的格式采用Unix时间戳，表示从格林威治时间1970年01月01日00时00分00秒至VPN网关到期时的总时长。
VSwitchId String vsw-bp1dmzugdikc6hdgx****

VPN网关所属交换机的ID。
RequestId String 27E4E088-8DE0-4672-BF5C-0A412389DB9E

请求ID。
Description String vpngatewaydescription

VPN网关的描述信息。
EnableBgp Boolean true

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

  • true：已开启。
  • false：未开启。
BusinessStatus String Normal

VPN网关的付费状态。取值：

  • Normal：正常。
  • FinancialLocked：欠费锁定。
SslVpn String enable

SSL-VPN功能的开启状态。取值：

  • enable：已开启。
  • disable：未开启。
Name String vpngatewayname

VPN网关的名称。
ReservationData Object

未生效的订单数据。

说明 仅IncludeReservationData传入true才会返回该组参数。
Status String 1

未生效订单状态。取值：

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

未生效订单类型。取值：

  • RENEWCHANGE：续费变配。
  • TEMP_UPGRADE：临时升配。
  • RENEW：续费。
ReservationIpsec String enable

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

  • enable：已开启。
  • disable：未开启。
ReservationSpec String 5

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

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

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

未生效订单SSL-VPN并发连接用户数的规格。
ReservationEndTime String 2020-07-20T16:00:00Z

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

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

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

标签键。
Value String bbb

标签值。
NetworkType String public

VPN网关的网络类型。

  • public：公网VPN网关。
  • private：私网VPN网关。
DisasterRecoveryInternetIp String 47.91.XX.XX

系统为VPN网关实例分配的用于创建IPsec-VPN连接的第二个IP地址。

仅支持创建双隧道模式IPsec-VPN连接的VPN网关实例会返回当前参数。
DisasterRecoveryVSwitchId String vsw-p0w95ql6tmr2ludkt****

VPN网关实例关联的第二个交换机ID。

仅支持创建双隧道模式IPsec-VPN连接的VPN网关实例会返回当前参数。
SslVpnInternetIp String 47.74.XX.XX

SSL-VPN连接的IP地址。

仅支持创建双隧道模式IPsec-VPN连接的公网网络类型的VPN网关实例开启SSL-VPN功能后，才会返回当前参数。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVpnGateway
&RegionId=ap-southeast-2
&VpnGatewayId=vpn-bp1r3v1xqkl0w519g****
&IncludeReservationData=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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",
  "DisasterRecoveryVSwitchId" : "vsw-p0w95ql6tmr2ludkt****",
  "DisasterRecoveryInternetIp" : "47.91.XX.XX",
  "SslVpnInternetIp" : "47.74.XX.XX",
  "ReservationData" : {
    "Status" : "1",
    "ReservationOrderType" : "TEMP_UPGRADE",
    "ReservationIpsec" : "enable",
    "ReservationSpec" : "5",
    "ReservationSsl" : "enable",
    "ReservationMaxConnections" : 5,
    "ReservationEndTime" : "2020-07-20T16:00:00Z"
  },
  "Tags" : [ {
    "Key" : "aaa",
    "Value" : "bbb"
  } ],
  "NetworkType" : "public"
}

错误码

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 网关是否正确。

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

阿里云首页 专有网络VPC 相关技术圈