操作指南

API文档

查询VPN通道列表

最近更新时间:2021-03-05 08:13:35

我的收藏

1. 接口描述

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

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

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

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

推荐使用 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。
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"
  • Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    Limit Integer 返回数量,默认为20,最大值为100。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    VpnConnectionSet Array of VpnConnection VPN通道实例。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询VPN通道列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeVpnConnections
    &Version=2017-03-12
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b",
        "TotalCount": 1,
        "VpnConnectionSet": [
          {
            "VpcId": "vpc-0a36uwkr",
            "VpnConnectionId": "vpnx-5p7vkch8",
            "VpnConnectionName": "testjoan",
            "VpnGatewayId": "vpngw-p4lmqawn",
            "CustomerGatewayId": "cgw-l4rblw63",
            "PreShareKey": "123456",
            "VpnProto": "IPSEC",
            "EncryptProto": "IKE",
            "RouteType": "STATIC",
            "IKEOptionsSpecification": {
              "PropoAuthenAlgorithm": "MD5",
              "PropoEncryAlgorithm": "3DES-CBC",
              "ExchangeMode": "MAIN",
              "LocalIdentity": "ADDRESS",
              "RemoteIdentity": "ADDRESS",
              "LocalAddress": "183.60.249.17",
              "RemoteAddress": "183.60.249.126",
              "LocalFqdnName": "",
              "RemoteFqdnName": "",
              "DhGroupName": "GROUP1",
              "IKESaLifetimeSeconds": "86400",
              "IKEVersion": "IKEV1"
            },
            "IPSECOptionsSpecification": {
              "EncryptAlgorithm": "3DES-CBC",
              "IntegrityAlgorith": "MD5",
              "PfsDhGroup": "NULL",
              "IPSECSaLifetimeSeconds": "3600",
              "IPSECSaLifetimeTraffic": "1843200"
            },
            "CreatedTime": "2017-08-0510: 27: 32",
            "State": "AVAILABLE",
            "NetStatus": "UNAVAILABLE",
            "SecurityPolicyDatabaseSet": [
              {
                "LocalCidrBlock": "172.16.0.0/16",
                "RemoteCidrBlock": [
                  "10.10.0.0/16"
                ]
              }
            ]
          }
        ]
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。
    目录