查询路由
接口功能介绍
查询路由
接口约束
无
URI
GET /v4/ec/route/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 是 | String | 云间高速实例ID | 0f368a3c-05ca-4cb6-9131-4c7d723fb2ef | |
| cgwID | 是 | String | 云网关ID | 41371a2e-4e42-4006-b6b2-e364e41b2dbc | |
| rtbID | 是 | String | 路由表ID | 5ef2e991-e37e-4a1f-a6bd-c3d44b63176b | |
| status | 否 | String | 运行状态 取值范围: "1": 正常 "2":异常 |
1 | |
| routeType | 否 | String | 路由类型 取值范围: "1":自动学习 "2":自定义（默认） |
2 | |
| nexthopType | 否 | String | 下一跳路由类型 取值范围: "1":vpc "2":云专线 "3":SDWAN "4":VPN "5":EDS "20":黑洞路由 "30":跨域连接 |
2 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表 results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 否 | String | 云间高速id | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 否 | String | 云网关id | 16c40584-fe8f-49b0-9e09-ef915caeee10 | |
| rtbID | 否 | String | 路由表id | 16c40584-fe8f-49b0-9e09-ef915caeee10 | |
| routeID | 否 | String | 路由ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| routeType | 是 | String | 路由类型 取值范围: "1":自动学习 "2":自定义（默认） |
2 | |
| routeCIDR | 否 | String | 子网信息 | 12.3.4.0/24 | |
| nexthopType | 是 | String | 下一跳路由类型 取值范围: "1":vpc "2":云专线 "3":SDWAN "4":VPN "5":EDS "20":黑洞路由 "30":跨域连接 |
2 | |
| nexthopID | 否 | String | 目的实例ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| IPVersion | 否 | String | 子网类型 取值范围: "1":IPv4类型 "2":IPv6类型 |
1 | |
| routeDescription | 否 | String | 路由描述信息 | 路由001 | |
| status | 否 | String | 运行状态 取值范围 "1":正常 "2":异常 |
1 | |
| createDate | 否 | String | 创建时间 | 2022-09-19 02:05:28 |
请求示例
请求url
/v4/ec/route/list?ecID=0f368a3c-05ca-4cb6-9131-4c7d723fb2ef&rtbID=5ef2e991-e37e-4a1f-a6bd-c3d44b63176b&cgwID=41371a2e-4e42-4006-b6b2-e364e41b2dbc
请求头header
无
请求体body
无
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj":{
"totalCount":1,
"totalPage":1,
"currentCount":1,
"results":[
{
"ecID": "0f368a3c-05ca-4cb6-9131-4c7d723fb2ef",
"cgwID": "41371a2e-4e42-4006-b6b2-e364e41b2dbc",
"rtbID": "5ef2e991-e37e-4a1f-a6bd-c3d44b63176b",
"routeID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"routeType": "2",
"routeCIDR": "12.3.4.0/24",
"nexthopType": "1",
"nexthopID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"IPVersion": "1",
"routeDescription": "路由001",
"status": "2",
"createDate": "2022-09-19 02:05:28"
}
]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.RouteEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
