文档

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

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeVpnGatewayRead
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

请求参数

名称类型必填描述示例值
RegionIdstring

VPN 网关所在的地域 ID。

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

cn-hangzhou
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-bp1r3v1xqkl0w519g****
IncludeReservationDataboolean

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

  • false(默认值):不包含未生效的订单数据。

  • true:包含未生效的订单数据。

true

返回参数

名称类型描述示例值
object

返回结果。

VpnTypestring

VPN 网关类型。

取值:

  • Normal:普通型。

  • NationalStandard:国密型。

Normal
Statusstring

VPN 网关的状态。取值:

  • init:初始化。

  • provisioning:准备中。

  • active:正常。

  • updating:更新中。

  • deleting:删除中。

init
VpcIdstring

VPN 网关所属 VPC 的 ID。

vpc-bp19m2yx1m5q0avyq****
SslMaxConnectionslong

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

5
Specstring

VPN 网关的带宽规格。单位:Mbps。

5
InternetIpstring
  • 在 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
CreateTimelong

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

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

1495382400000
AutoPropagateboolean

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

  • true:自动传播。

  • false:不自动传播。

true
ChargeTypestring

付费类型。仅取值:

Prepay,包年包月。

中国站示例值:Prepay,国际站示例值:POSTPAY
VpnGatewayIdstring

VPN 网关实例 ID。

vpn-bp1r3v1xqkl0w519g****
Tagstring

系统自动生成的 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\"}
IpsecVpnstring

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

  • enable:已开启。

  • disable:未开启。

enable
EndTimelong

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

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

1544666102000
VSwitchIdstring

VPN 网关所属交换机的 ID。

vsw-bp1dmzugdikc6hdgx****
RequestIdstring

请求 ID。

27E4E088-8DE0-4672-BF5C-0A412389DB9E
Descriptionstring

VPN 网关的描述信息。

vpngatewaydescription
EnableBgpboolean

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

  • true:已开启。

  • false:未开启。

true
BusinessStatusstring

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

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
SslVpnstring

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

  • enable:已开启。

  • disable:未开启。

enable
Namestring

VPN 网关的名称。

vpngatewayname
ReservationDataobject

未生效的订单数据。

说明 IncludeReservationData 传入 true 才会返回该组参数。
Statusstring

未生效订单状态。取值:

  • 1:表示续费或续费变配的订单未生效。

  • 2:表示临时升配的订单已生效。在到达还原时间后,系统会将 VPN 网关规格恢复到临时升配前的规格。此时 ReservationIpsecReservationMaxConnectionsReservationSpecReservationSsl 表示为 VPN 网关临时升配前的规格。

1
ReservationOrderTypestring

未生效订单类型。取值:

  • RENEWCHANGE:续费变配。

  • TEMP_UPGRADE:临时升配。

  • RENEW:续费。

TEMP_UPGRADE
ReservationIpsecstring

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

  • enable:已开启。

  • disable:未开启。

enable
ReservationSpecstring

未生效订单的带宽规格。单位:Mbps。

5
ReservationSslstring

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

  • enable:已开启。

  • disable:未开启。

enable
ReservationMaxConnectionsinteger

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

5
ReservationEndTimestring

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

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

2020-07-20T16:00:00Z
Tagsobject []

您自定义的 VPN 网关标签。

Keystring

标签键。

aaa
Valuestring

标签值。

bbb
NetworkTypestring

VPN 网关的网络类型。

  • public:公网 VPN 网关。
  • private:私网 VPN 网关。
public
DisasterRecoveryInternetIpstring

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

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

47.91.XX.XX
DisasterRecoveryVSwitchIdstring

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

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

vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIpstring

SSL-VPN 连接的 IP 地址。

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

47.74.XX.XX
ResourceGroupIdstring

VPN 网关所属的资源组 ID。

您可以调用 ListResourceGroups 接口查询资源组信息。

rg-acfmzs372yg****
EniInstanceIdsarray

系统为 VPN 网关实例创建的弹性网卡 ENI(Elastic Network Interfaces)列表。

string

ENI ID。

eni-7xvcxgmd4y2ypibn****

示例

正常返回示例

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****",
  "EniInstanceIds": {
    "EniInstanceId": [
      "eni-7xvcxgmd4y2ypibn****"
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-05-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-10-19OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-06-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)