1. 接口描述

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

本接口（DescribeVpnGateways）用于查询VPN网关列表。

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

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

2. 输入参数

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

3. 输出参数

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": {
    "TotalCount": 2,
    "VpnGatewaySet": [
      {
        "VpcId": "vpc-ah9e9qu9",
        "VpnGatewayId": "vpngw-5aluhh9t",
        "VpnGatewayName": "joantest",
        "Type": "IPSEC",
        "State": "DELETING",
        "PublicIpAddress": "",
        "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
        "InstanceChargeType": "PREPAID",
        "InternetMaxBandwidthOut": 0,
        "CreatedTime": "2015-08-20 19:39:01",
        "ExpiredTime": "0000-00-00 00:00:00",
        "IsAddressBlocked": false,
        "NewPurchasePlan": "",
        "RestrictState": "NORMAL",
        "Zone": "ap-guangzhou-2",
        "VpnGatewayQuotaSet": [
          {
            "Bandwidth": 5,
            "Cname": "微小型",
            "Name": "mini"
          },
          {
            "Bandwidth": 20,
            "Cname": "中型",
            "Name": "middle"
          },
          {
            "Bandwidth": 100,
            "Cname": "超大型",
            "Name": "superLarge"
          },
          {
            "Bandwidth": 10,
            "Cname": "小型",
            "Name": "small"
          },
          {
            "Bandwidth": 50,
            "Cname": "大型",
            "Name": "large"
          }
        ]
      },
      {
        "VpcId": "vpc-5rkcp0wb",
        "VpnGatewayId": "vpngw-97yhzme3",
        "VpnGatewayName": "leohli-simulate3",
        "Type": "IPSEC",
        "State": "AVAILABLE",
        "PublicIpAddress": "",
        "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
        "InstanceChargeType": "PREPAID",
        "InternetMaxBandwidthOut": 10,
        "CreatedTime": "2017-07-03 14:39:16",
        "ExpiredTime": "2018-05-31 13:03:47",
        "IsAddressBlocked": false,
        "NewPurchasePlan": "PREPAID_TO_POSTPAID",
        "RestrictState": "PROTECTIVELY_ISOLATED",
        "Zone": "ap-guangzhou-3",
        "VpnGatewayQuotaSet": [
          {
            "Bandwidth": 5,
            "Cname": "微小型",
            "Name": "mini"
          },
          {
            "Bandwidth": 20,
            "Cname": "中型",
            "Name": "middle"
          },
          {
            "Bandwidth": 100,
            "Cname": "超大型",
            "Name": "superLarge"
          },
          {
            "Bandwidth": 10,
            "Cname": "小型",
            "Name": "small"
          },
          {
            "Bandwidth": 50,
            "Cname": "大型",
            "Name": "large"
          }
        ]
      }
    ],
    "RequestId": "feb949ef-8eb8-4eda-ba73-4fc5705bf8f5"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++
• Tencent Cloud SDK 3.0 for Ruby

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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