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。 |
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": {
"RouteSet": [
{
"RouteId": "ccnr-bvipc87w",
"DestinationCidrBlock": "10.33.0.0/24",
"InstanceType": "VPC",
"InstanceId": "vpc-r1ckkpid",
"InstanceName": "vpc0420",
"InstanceRegion": "ap-guangzhou",
"InstanceUin": "979137",
"UpdateTime": "2018-06-21 11:32:29"
},
{
"RouteId": "ccnr-oc61so0o",
"DestinationCidrBlock": "192.168.0.0/24",
"InstanceType": "DIRECTCONNECT",
"InstanceId": "dcg-98qosdc3",
"InstanceName": "test",
"InstanceRegion": "ap-guangzhou",
"InstanceUin": "979137",
"UpdateTime": "2018-06-21 11:32:29"
}
],
"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。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.Coexist | 参数不支持同时指定。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
ResourceNotFound | 资源不存在。 |