文档中心 API 中心 私有网络 专线网关相关接口 查询专线网关云联网路由

查询专线网关云联网路由

最近更新时间:2019-07-26 17:02:34

1. 接口描述

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

本接口(DescribeDirectConnectGatewayCcnRoutes)用于查询专线网关的云联网路由(IDC网段)

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDirectConnectGatewayCcnRoutes
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
DirectConnectGatewayId String 专线网关ID,形如:dcg-prpqlmg1
CcnRouteType String 云联网路由学习类型,可选值:
  • BGP - 自动学习。
  • STATIC - 静态,即用户配置,默认值。
  • Offset Integer 偏移量。
    Limit Integer 返回数量。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的对象数。
    RouteSet Array of DirectConnectGatewayCcnRoute 云联网路由(IDC网段)列表。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询专线网关云联网路由

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeDirectConnectGatewayCcnRoutes
    &DirectConnectGatewayId=dcg-prpqlmg1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RouteSet": [
          {
            "RouteId": "ccnr-bvipc87w",
            "DestinationCidrBlock": "10.33.0.0/24",
            "ASPath": [
              "1000",
              "2000",
              "3000"
            ]
          },
          {
            "RouteId": "ccnr-oc61so0o",
            "DestinationCidrBlock": "192.168.0.0/24",
            "ASPath": []
          }
        ],
        "TotalCount": 2,
        "RequestId": "6e446c86-d8c9-4981-9b33-d10956585058"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

    该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码