查询云联网路由策略

最近更新时间:2018-10-26 15:01:08

1. 接口描述

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

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

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

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

2. 输入参数

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

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

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的对象数。
    RouteSet Array of CcnRoute CCN路由策略对象。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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": {
        "RequestId": "6e446c86-d8c9-4981-9b33-d10956585058",
        "RouteSet": [
          {
            "DestinationCidrBlock": "10.33.0.0/24",
            "InstanceId": "vpc-r1ckkpid",
            "InstanceName": "vpc0420",
            "InstanceRegion": "ap-guangzhou",
            "InstanceType": "VPC",
            "InstanceUin": "979137",
            "RouteId": "ccnr-bvipc87w",
            "UpdateTime": "2018-06-21 11:32:29"
          },
          {
            "DestinationCidrBlock": "192.168.0.0/24",
            "InstanceId": "dcg-98qosdc3",
            "InstanceName": "test",
            "InstanceRegion": "ap-guangzhou",
            "InstanceType": "DIRECTCONNECT",
            "InstanceUin": "979137",
            "RouteId": "ccnr-oc61so0o",
            "UpdateTime": "2018-06-21 11:32:29"
          }
        ],
        "TotalCount": 2
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    ResourceNotFound 资源不存在。