查询VPN通道列表

1. 接口描述

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

本接口（DescribeVpnConnections）用于查询VPN通道列表。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 DescribeVpnConnections返回示例

查询VPN通道

输入示例

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

{
    "Limit": "5",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "VpnConnectionSet": [
            {
                "VpcId": "vpc-8ro3x6md",
                "VpnConnectionId": "vpnx-df9oztok",
                "VpnConnectionName": "testcon-1",
                "VpnGatewayId": "vpngw-6x0wxvtp",
                "CustomerGatewayId": "cgw-apytvc1n",
                "PreShareKey": "123",
                "VpnProto": "IPSEC",
                "EncryptProto": "IKE",
                "RouteType": "StaticRoute",
                "IKEOptionsSpecification": {
                    "PropoAuthenAlgorithm": "MD5",
                    "PropoEncryAlgorithm": "AES-CBC-128",
                    "ExchangeMode": "MAIN",
                    "LocalIdentity": "ADDRESS",
                    "RemoteIdentity": "ADDRESS",
                    "LocalAddress": "6.6.6.6",
                    "RemoteAddress": "1.1.3.2",
                    "LocalFqdnName": "",
                    "RemoteFqdnName": "",
                    "DhGroupName": "GROUP1",
                    "IKESaLifetimeSeconds": 86400,
                    "IKEVersion": "IKEV1"
                },
                "IPSECOptionsSpecification": {
                    "EncryptAlgorithm": "AES-CBC-128",
                    "IntegrityAlgorith": "MD5",
                    "PfsDhGroup": "NULL",
                    "IPSECSaLifetimeSeconds": 3600,
                    "IPSECSaLifetimeTraffic": 1843200
                },
                "CreatedTime": "2022-07-22 14:05:07",
                "SecurityPolicyDatabaseSet": [
                    {
                        "LocalCidrBlock": "0.0.0.0/0",
                        "RemoteCidrBlock": [
                            "0.0.0.0/0"
                        ]
                    }
                ],
                "State": "AVAILABLE",
                "NetStatus": "AVAILABLE",
                "NegotiationType": "flowTrigger",
                "DpdEnable": 1,
                "DpdTimeout": "30",
                "DpdAction": "clear",
                "EnableHealthCheck": false,
                "HealthCheckLocalIp": "",
                "HealthCheckRemoteIp": "",
                "HealthCheckStatus": "",
                "TagSet": []
            },
            {
                "VpcId": "vpc-8ro3x6md",
                "VpnConnectionId": "vpnx-eal8tpn2",
                "VpnConnectionName": "testcon-2",
                "VpnGatewayId": "vpngw-6x0wxvtp",
                "CustomerGatewayId": "cgw-876ql2tz",
                "PreShareKey": "123",
                "VpnProto": "IPSEC",
                "EncryptProto": "IKE",
                "RouteType": "StaticRoute",
                "IKEOptionsSpecification": {
                    "PropoAuthenAlgorithm": "MD5",
                    "PropoEncryAlgorithm": "AES-CBC-128",
                    "ExchangeMode": "MAIN",
                    "LocalIdentity": "ADDRESS",
                    "RemoteIdentity": "ADDRESS",
                    "LocalAddress": "6.6.6.6",
                    "RemoteAddress": "169.168.10.4",
                    "LocalFqdnName": "",
                    "RemoteFqdnName": "",
                    "DhGroupName": "GROUP1",
                    "IKESaLifetimeSeconds": 86400,
                    "IKEVersion": "IKEV1"
                },
                "IPSECOptionsSpecification": {
                    "EncryptAlgorithm": "AES-CBC-128",
                    "IntegrityAlgorith": "MD5",
                    "PfsDhGroup": "NULL",
                    "IPSECSaLifetimeSeconds": 3600,
                    "IPSECSaLifetimeTraffic": 1843200
                },
                "CreatedTime": "2022-07-22 14:14:48",
                "SecurityPolicyDatabaseSet": [
                    {
                        "LocalCidrBlock": "0.0.0.0/0",
                        "RemoteCidrBlock": [
                            "0.0.0.0/0"
                        ]
                    }
                ],
                "State": "AVAILABLE",
                "NetStatus": "AVAILABLE",
                "NegotiationType": "passive",
                "DpdEnable": 1,
                "DpdTimeout": "31",
                "DpdAction": "clear",
                "EnableHealthCheck": false,
                "HealthCheckLocalIp": "",
                "HealthCheckRemoteIp": "",
                "HealthCheckStatus": "",
                "TagSet": []
            }
        ],
        "RequestId": "1f4fa69d-0a9b-4342-83e1-002533feca94"
    }
}

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. 错误码

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