有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

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

2. 输入参数

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

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

  • 示例值:BGP
    Offset Integer 偏移量。
    示例值:0
    Limit Integer 返回数量。
    示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的对象数。
    示例值:2
    RouteSet Array of DirectConnectGatewayCcnRoute 云联网路由(IDC网段)列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

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

    输入示例

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

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。