文档

DescribeVpnGateways - 查询已创建的VPN网关

更新时间:

调用DescribeVpnGateways接口查询指定地域下已创建的VPN网关。

调试

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

授权信息

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

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

请求参数

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

VPN 网关所在的地域 ID。

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

cn-hangzhou
VpcIdstring

VPN 网关所属专有网络 VPC(Virtual Private Cloud)的 ID。

vpc-bp1m3i0kn1nd4wiw9****
VpnGatewayIdstring

VPN 网关的 ID。

vpn-bp17lofy9fd0dnvzv****
Statusstring

VPN 网关的状态。取值:

  • init :初始化。

  • provisioning :准备中。

  • active :正常。

  • updating :更新中。

  • deleting :删除中。

active
BusinessStatusstring

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

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的条目数。取值范围:1~50。默认值:10

10
IncludeReservationDataboolean

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

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

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

true
Tagobject []

VPN 网关绑定的标签列表。

Keystring

标签的标签键。一旦输入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

一次最多支持输入 20 个标签键。

FinanceDept
Valuestring

标签的标签值。

标签值最多支持 128 个字符,可以为空字符串,不能以aliyunacs:开头,不能包含http://或者https://

一个标签键对应一个标签值。一次最多支持输入 20 个标签值。

FinanceJoshua
ResourceGroupIdstring

VPN 网关所属的资源组 ID。

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

rg-acfmzs372yg****

返回参数

名称类型描述示例值
object

返回结果。

PageSizeinteger

分页查询时每页的条目数。

10
RequestIdstring

请求 ID。

DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
VpnGatewaysobject []

VPN 网关信息列表。

VpnTypestring

VPN 网关类型。

  • Normal:普通型。
  • NationalStandard:国密型。
Normal
Statusstring

VPN 网关的状态。

  • init :初始化。

  • provisioning :准备中。

  • active :正常。

  • updating :更新中。

  • deleting :删除中。

active
VpcIdstring

VPN 网关所属 VPC 的 ID。

vpc-bp1m3i0kn1nd4wiw9****
SslMaxConnectionslong

VPN 网关 SSL 连接数的规格。

5
Specstring

VPN 网关的带宽峰值。M 表示单位 Mbps。

5M
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.12.XX.XX
CreateTimelong

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

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

1515383700000
AutoPropagateboolean

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

  • true:自动传播。

  • false:不自动传播。

true
ChargeTypestring

VPN 网关的付费类型。

仅取值:Prepay,包年包月。

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

VPN 网关的 ID。

vpn-bp17lofy9fd0dnvzv****
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

VPN 网关是否开启了 IPsec-VPN 功能。

  • enable:已开启。

  • disable:未开启。

enable
EndTimelong

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

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

1518105600000
VSwitchIdstring

VPN 网关所属交换机的 ID。

vsw-bp15lbk8sgtr6r5b0****
Descriptionstring

VPN 网关的描述信息。

test
EnableBgpboolean

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

  • true:已开启。

  • false:未开启。

true
BusinessStatusstring

VPN 网关的付费状态。

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
SslVpnstring

VPN 网关是否开启了 SSL-VPN 功能。

  • enable:已开启。

  • disable:未开启。

enable
Namestring

VPN 网关的名称。

test
NetworkTypestring

VPN 网关的网络类型。

  • public:公网 VPN 网关。
  • private:私网 VPN 网关。
public
Tagsobject []

VPN 网关绑定的标签列表。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua
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(续费)时,该参数表示为续费或续费变配开始生效时间。

2021-07-20T16:00:00Z
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****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnGateways": {
    "VpnGateway": [
      {
        "VpnType": "Normal",
        "Status": "active",
        "VpcId": "vpc-bp1m3i0kn1nd4wiw9****",
        "SslMaxConnections": 5,
        "Spec": "5M",
        "InternetIp": "47.12.XX.XX",
        "CreateTime": 1515383700000,
        "AutoPropagate": true,
        "ChargeType": "中国站示例值:Prepay,国际站示例值:POSTPAY",
        "VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
        "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.7\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\"}",
        "IpsecVpn": "enable",
        "EndTime": 1518105600000,
        "VSwitchId": "vsw-bp15lbk8sgtr6r5b0****",
        "Description": "test",
        "EnableBgp": true,
        "BusinessStatus": "Normal",
        "SslVpn": "enable",
        "Name": "test",
        "NetworkType": "public",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "ReservationData": {
          "Status": "1",
          "ReservationOrderType": "TEMP_UPGRADE",
          "ReservationIpsec": "enable",
          "ReservationSpec": "5",
          "ReservationSsl": "enable",
          "ReservationMaxConnections": 5,
          "ReservationEndTime": "2021-07-20T16:00:00Z"
        },
        "DisasterRecoveryInternetIp": "47.91.XX.XX",
        "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
        "SslVpnInternetIp": "47.74.XX.XX",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "EniInstanceIds": {
          "EniInstanceId": [
            ""
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.TagKeyThe specified parameter TagKey is invalid.指定的参数TagKey不合规范。
400InvalidParameter.TagValueThe specified parameter TagValue is invalid.指定的参数TagValue不合规范。
400Duplicated.TagKeyThe specified parameter TagKey is duplicated.指定的参数TagKey重复。
400InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误
403Forbidden.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.您没有权限操作指定资源,请申请权限后再操作。

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

变更历史

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