黑石私有网络查询VPN网关

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeVpnGateways。
Version	是	String	公共参数，本接口取值：2018-06-25。
Region	是	String	公共参数，详见产品支持的地域列表。
VpnGatewayIds.N	否	Array of String	VPN网关实例ID。形如：bmvpngw-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpnGatewayIds和Filters。
Filters.N	否	Array of Filter	过滤条件，参数不支持同时指定VpnGatewayIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID形如：vpc-f49l6u0z。 state - String - （过滤条件 VPN状态：creating，available，createfailed，changing，changefailed，deleting，deletefailed。 zone - String - （过滤条件）VPN所在可用区，形如：ap-guangzhou-2。 vpngw-name - String - （过滤条件）vpn网关名称。
Offset	否	Integer	偏移量
Limit	否	Integer	请求对象个数
OrderField	否	String	排序字段, 支持"CreateTime"排序
OrderDirection	否	String	排序方向, “asc”、“desc”

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的实例数量。
VpnGatewaySet	Array of VpnGateway	VPN网关实例详细信息列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询VPN网关

输入示例

https://bmvpc.tencentcloudapi.com/?Action=DescribeVpnGateways
&Version=2018-06-25
&Offset=0
&Limit=2
&Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "VpnGatewaySet": [
            {
                "VpcId": "vpc-ah9e9qu9",
                "VpnGatewayId": "bmvpngw-5aluhh9t",
                "VpnGatewayName": "joantest",
                "State": 0,
                "PublicIpAddress": "",
                "InternetMaxBandwidthOut": 100,
                "CreateTime": "2015-08-20 19:39:01",
                "VpcName": "test",
                "VpcCidrBlock": "172.16.0.0/16",
                "VpnConnNum": 2,
                "Zone": "ap-guangzhou"
            }
        ],
        "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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。

查询VPN网关

本页目录：