查询VPN网关

最近更新时间:2018-10-26 15:00:51

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeVpnGateways)用于查询VPN网关列表。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpnGateways
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
VpnGatewayIds.N Array of String VPN网关实例ID。形如:vpngw-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpnGatewayIds和Filters。
Filters.N Array of FilterObject 过滤条件,参数不支持同时指定VpnGatewayIds和Filters。
  • vpc-id - String - (过滤条件)VPC实例ID形如:vpc-f49l6u0z。
  • vpn-gateway-id - String - (过滤条件)VPN实例ID形如:vpngw-5aluhh9t。
  • vpn-gateway-name - String - (过滤条件)VPN实例名称。
  • type - String - (过滤条件)VPN网关类型:'IPSEC', 'SSL'。
  • public-ip-address- String - (过滤条件)公网IP。
  • renew-flag - String - (过滤条件)网关续费类型,手动续费:'NOTIFY_AND_MANUAL_RENEW'、自动续费:'NOTIFY_AND_AUTO_RENEW'。
  • zone - String - (过滤条件)VPN所在可用区,形如:ap-guangzhou-2。
  • Offset Integer 偏移量
    Limit Integer 请求对象个数

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    VpnGatewaySet Array of VpnGateway VPN网关实例详细信息列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询VPN网关

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeVpnGateways
    &Version=2017-03-12
    &Offset=0
    &Limit=2
    &Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-2
    &Filters.0.Values.0=ap-guangzhou-3
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "feb949ef-8eb8-4eda-ba73-4fc5705bf8f5",
        "TotalCount": 2,
        "VpnGatewaySet": [
          {
            "CreatedTime": "2015-08-20 19:39:01",
            "ExpiredTime": "0000-00-00 00:00:00",
            "InstanceChargeType": "PREPAID",
            "InternetMaxBandwidthOut": 0,
            "IsAddressBlocked": false,
            "NewPurchasePlan": "",
            "PublicIpAddress": "",
            "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
            "RestrictState": "NORMAL",
            "State": "DELETING",
            "Type": "IPSEC",
            "VpcId": "vpc-ah9e9qu9",
            "VpnGatewayId": "vpngw-5aluhh9t",
            "VpnGatewayName": "joantest",
            "Zone": "ap-guangzhou-2"
          },
          {
            "CreatedTime": "2017-07-03 14:39:16",
            "ExpiredTime": "2018-05-31 13:03:47",
            "InstanceChargeType": "PREPAID",
            "InternetMaxBandwidthOut": 10,
            "IsAddressBlocked": false,
            "NewPurchasePlan": "PREPAID_TO_POSTPAID",
            "PublicIpAddress": "",
            "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
            "RestrictState": "PROTECTIVELY_ISOLATED",
            "State": "AVAILABLE",
            "Type": "IPSEC",
            "VpcId": "vpc-5rkcp0wb",
            "VpnGatewayId": "vpngw-97yhzme3",
            "VpnGatewayName": "leohli-simulate3",
            "Zone": "ap-guangzhou-3"
          }
        ]
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InvalidVpnGatewayId.Malformed 无效的VPN网关,VPN实例ID不合法。
    InvalidVpnGatewayId.NotFound 无效的VPN网关,VPN实例不存在,请再次核实您输入的资源信息是否正确。