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

1. 接口描述

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

本接口(DescribeCcnRoutes)用于查询已加入云联网(CCN)的路由。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCcnRoutes。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
CcnId String CCN实例ID,形如:ccn-gree226l
示例值:ccn-gree226l
RouteIds.N Array of String CCN路由策略唯一ID,形如:ccnr-f49l6u0z
示例值:-
Filters.N Array of Filter 过滤条件,参数不支持同时指定RouteIds和Filters。
  • route-id - String -(过滤条件)路由策略ID。
  • cidr-block - String -(过滤条件)目的端。
  • instance-type - String -(过滤条件)下一跳类型。
  • instance-region - String -(过滤条件)下一跳所属地域。
  • instance-id - String -(过滤条件)下一跳实例ID。
  • route-table-id - String -(过滤条件)路由表ID列表,形如ccntr-1234edfr,可以根据路由表ID 过滤。
  • Offset Integer 偏移量
    示例值:-
    Limit Integer 返回数量
    示例值:-

    3. 输出参数

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

    4. 示例

    示例1 查询云联网路由列表

    查询云联网路由列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeCcnRoutes
    &CcnId=ccn-gree226l
    &Filters.0.Name=route-id
    &Filters.0.Values.0=ccnr-bvipc87w
    &Filters.0.Values.1=ccnr-oc61so0o
    &Filters.1.Name=instance-type
    &Filters.1.Values.0=VPC
    &Filters.1.Values.1=DIRECTCONNECT
    &Filters.2.Name=instance-region
    &Filters.2.Values.0=ap-guangzhou
    &Filters.2.Values.1=ap-beijing
    &Filters.2.Values.2=ap-shanghai
    &Filters.2.Values.3=eu-frankfurt
    &Filters.3.Name=instance-id
    &Filters.3.Values.0=vpc-r1ckkpid
    &Filters.3.Values.1=dcg-98qosdc3
    &Filters.4.Name=cidr-block
    &Filters.4.Values.0=10.33.0.0/16
    &Filters.4.Values.1=192.168.0.0/24
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "RequestId": "3e866888-83ea-4716-b99b-21592cba6548",
            "RouteSet": [
                {
                    "DestinationCidrBlock": "10.33.0.0/16",
                    "UpdateTime": "2020-09-22 00:00:00",
                    "RoutePriority": 1,
                    "InstanceId": "vpc-r1ckkpid",
                    "InstanceUin": "234532345",
                    "Enabled": true,
                    "InstanceExtraName": "test",
                    "IsBgp": true,
                    "InstanceRegion": "ap-guangzhou",
                    "ExtraState": "Running",
                    "RouteId": "ccnr-bvipc87w",
                    "InstanceName": "test",
                    "InstanceType": "VPC"
                },
                {
                    "DestinationCidrBlock": "192.168.0.0/24",
                    "UpdateTime": "2020-09-22 00:00:00",
                    "RoutePriority": 1,
                    "InstanceId": "vpc-r1ckkpid",
                    "InstanceName": "test",
                    "Enabled": true,
                    "InstanceExtraName": "test",
                    "IsBgp": true,
                    "InstanceRegion": "ap-guangzhou",
                    "ExtraState": "Running",
                    "RouteId": "ccnr-oc61so0o",
                    "InstanceUin": "234532345",
                    "InstanceType": "VPC"
                }
            ]
        }
    }

    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 参数不支持同时指定。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.ParameterMismatch 参数值格式不匹配。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。
    UnsupportedOperation.AppIdNotFound APPId不存在。