文档捉虫大赛:人工智能与机器学习专题> HOT

1. 接口描述

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

本接口(DescribeVpnConnections)用于查询VPN通道列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpnConnections。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpnConnectionIds.N Array of String VPN通道实例ID。形如:vpnx-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpnConnectionIds和Filters。
示例值:vpnx-f49l6u0z
Filters.N Array of Filter 过滤条件。每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定VpnConnectionIds和Filters。
  • vpc-id - String - VPC实例ID,形如:vpc-0a36uwkr
  • vpn-gateway-id - String - VPN网关实例ID,形如:vpngw-p4lmqawn
  • customer-gateway-id - String - 对端网关实例ID,形如:cgw-l4rblw63
  • vpn-connection-name - String - 通道名称,形如:test-vpn
  • vpn-connection-id - String - 通道实例ID,形如:vpnx-5p7vkch8"

  • 示例值:null
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值:0
    Limit Integer 返回数量,默认为20,最大值为100。
    示例值:10

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    示例值:1
    VpnConnectionSet Array of VpnConnection VPN通道实例。
    示例值:[ { "CreatedTime": "2022-05-12 12:50:06", "CustomerGatewayId": "cgw-972gvd00", "DpdAction": "clear", "DpdEnable": 1, "DpdTimeout": "30", "EnableHealthCheck": false, "EncryptProto": "IKE", "HealthCheckLocalIp": "", "HealthCheckRemoteIp": "", "HealthCheckStatus": "", "IKEOptionsSpecification": { "DhGroupName": "GROUP1", "ExchangeMode": "MAIN", "IKESaLifetimeSeconds": 86400, "IKEVersion": "IKEV1", "LocalAddress": "33.113.108.46", "LocalFqdnName": "", "LocalIdentity": "ADDRESS", "PropoAuthenAlgorithm": "MD5", "PropoEncryAlgorithm": "3DES-CBC", "RemoteAddress": "1.2.3.4", "RemoteFqdnName": "", "RemoteIdentity": "ADDRESS" }, "IPSECOptionsSpecification": { "EncryptAlgorithm": "AES-CBC-128", "IPSECSaLifetimeSeconds": 3600, "IPSECSaLifetimeTraffic": 1843200, "IntegrityAlgorith": "MD5", "PfsDhGroup": "NULL" }, "NegotiationType": "flowTrigger", "NetStatus": "UNAVAILABLE", "PreShareKey": "123", "RouteType": "StaticRoute", "SecurityPolicyDatabaseSet": [ { "LocalCidrBlock": "0.0.0.0/0", "RemoteCidrBlock": [ "0.0.0.0/0" ] } ], "State": "AVAILABLE", "TagSet": [], "VpcId": "vpc-ejaaeaja", "VpnConnectionId": "vpnx-1rwdb4qz", "VpnConnectionName": "test-conn", "VpnGatewayId": "vpngw-f61esawc", "VpnProto": "IPSEC" } ]
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    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。

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.ModuleError 内部模块错误。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。
    UnsupportedOperation 操作不支持。