查询VPN网关

1. 接口描述

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

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

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询VPN网关

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

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVpnGateways
<公共请求参数>

{
    "VpnGatewayIds": [
        "vpngw-xxxxx"
    ],
    "Offset": 0,
    "Limit": 1
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "VpnGatewaySet": [
            {
                "VpnGatewayId": "vpngw-xxxx",
                "VpcId": "vpc-xxxx",
                "VpnGatewayName": "vpn_name",
                "Type": "CCN",
                "State": "AVAILABLE",
                "PublicIpAddress": "142.133.53.16",
                "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
                "InstanceChargeType": "POSTPAID_BY_HOUR",
                "InternetMaxBandwidthOut": 10,
                "CreatedTime": "2020-09-22 00:00:00",
                "ExpiredTime": "2020-09-22 00:00:00",
                "IsAddressBlocked": false,
                "NewPurchasePlan": "",
                "RestrictState": "NORMAL",
                "Zone": "ap-beijing-1",
                "VpnGatewayQuotaSet": [
                    {
                        "Bandwidth": 5,
                        "Cname": "微小型",
                        "Name": "cdmini"
                    },
                    {
                        "Bandwidth": 20,
                        "Cname": "中型",
                        "Name": "cdmiddle"
                    },
                    {
                        "Bandwidth": 50,
                        "Cname": "大型",
                        "Name": "cdlarge"
                    },
                    {
                        "Bandwidth": 10,
                        "Cname": "小型",
                        "Name": "cdsmall"
                    },
                    {
                        "Bandwidth": 100,
                        "Cname": "超大型",
                        "Name": "cdsuperLarge"
                    },
                    {
                        "Bandwidth": 1000,
                        "Cname": "超大型4",
                        "Name": "cdsuperLarge4"
                    },
                    {
                        "Bandwidth": 200,
                        "Cname": "超大型2",
                        "Name": "cdsuperLarge2"
                    },
                    {
                        "Bandwidth": 500,
                        "Cname": "超大型3",
                        "Name": "cdsuperLarge3"
                    },
                    {
                        "Bandwidth": 3000,
                        "Cname": "超大型5",
                        "Name": "cdsuperLarge5"
                    }
                ],
                "Version": "abc",
                "NetworkInstanceId": "abc",
                "CdcId": "abc",
                "MaxConnection": 5
            }
        ],
        "RequestId": "dc43b486-80aa-4cf0-9f8a-4b95e9092685"
    }
}

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: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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