查询专用通道列表

最近更新时间:2018-09-18 16:59:42

1. 接口描述

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

用于查询专用通道列表。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDirectConnectTunnels
Version String 公共参数,本接口取值:2018-04-10
Region String 公共参数,本接口不需要传递此参数。
Filters.N Array of Filter 过滤条件:
参数不支持同时指定DirectConnectTunnelIds和Filters。
  • direct-connect-tunnel-name, 专用通道名称。
  • direct-connect-tunnel-id, 专用通道实例ID,如dcx-abcdefgh。
  • direct-connect-id, 物理专线实例ID,如,dc-abcdefgh。
  • DirectConnectTunnelIds.N Array of String 专用通道 ID数组
    Offset Integer 偏移量,默认为0
    Limit Integer 返回数量,默认为20,最大值为100

    3. 输出参数

    参数名称 类型 描述
    DirectConnectTunnelSet Array of DirectConnectTunnel 专用通道列表
    TotalCount Integer 符合专用通道数量。
    RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

    4. 示例

    示例1 查询BGP路由的专用通道

    输入示例

    https://dc.tencentcloudapi.com/?Action=DescribeDirectConnectTunnels
    &Filters.0.Name=direct-connect-tunnel-id
    &Filters.0.Values.0=dcx-r3sml04o
    &Limit=20
    &Offset=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DirectConnectTunnelSet": [
          {
            "BgpPeer": {
              "Asn": 65139,
              "AuthKey": "tencent"
            },
            "CreatedTime": "2018-06-01 14:59:16",
            "CustomerAddress": "169.254.64.2/30",
            "DirectConnectGatewayId": "dcg-r70hz833",
            "DirectConnectId": "dc-9s5kpgyp",
            "DirectConnectOwnerAccount": "2407912486",
            "DirectConnectTunnelId": "dcx-r3sml04o",
            "DirectConnectTunnelName": "测试专用通道",
            "NetworkRegion": "ap-guangzhou",
            "NetworkType": "VPC",
            "OwnerAccount": "2407912486",
            "RouteFilterPrefixes": [],
            "RouteType": "BGP",
            "State": "PENDING",
            "TencentAddress": "169.254.64.1/30",
            "Vlan": 1321,
            "VpcId": "vpc-aipqhdez"
          }
        ]
      }
    }

    示例2 查询STATIC路由的专用通道

    输入示例

    https://dc.tencentcloudapi.com/?Action=DescribeDirectConnectTunnels
    &Filters.0.Name=direct-connect-tunnel-id
    &Filters.0.Values.0=dcx-r3sml04o
    &Limit=20
    &Offset=2
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DirectConnectTunnelSet": [
          {
            "BgpPeer": {
              "Asn": -1,
              "AuthKey": ""
            },
            "CreatedTime": "2018-06-01 14:59:16",
            "CustomerAddress": "169.254.64.2/30",
            "DirectConnectGatewayId": "dcg-r70hz833",
            "DirectConnectId": "dc-9s5kpgyp",
            "DirectConnectOwnerAccount": "2407912486",
            "DirectConnectTunnelId": "dcx-r3sml04o",
            "DirectConnectTunnelName": "测试专用通道",
            "NetworkRegion": "ap-guangzhou",
            "NetworkType": "VPC",
            "OwnerAccount": "2407912486",
            "RouteFilterPrefixes": [
              {
                "Cidr": "172.18.27.6/32"
              },
              {
                "Cidr": "172.18.27.0/24"
              }
            ],
            "RouteType": "STATIC",
            "State": "PENDING",
            "TencentAddress": "169.254.64.1/30",
            "Vlan": 1321,
            "VpcId": "vpc-aipqhdez"
          }
        ]
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误
    ResourceNotFound 资源不存在
    ResourceNotFound.DirectConnectTunnelIdIsNotExist 专用通道不存在。