接口功能介绍
查询专线网关下的静态路由
接口约束
无
URI
GET /v4/cda/static-route/list
路径参数
无
Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vrfName | 是 | String | 专线网关ID |
请求参数
请求头 header 参数
无
请求体 body 参数
无
响应参数
| 参数 | 参数类型 | 描述 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| error | String | 错误 | ||
| details | String | 错误明细 |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| staticRouteList | Array of Object | 静态路由列表 | StaticRoute |
表StaticRoute
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ipVersion | String | 本参数表示包周期类型。 取值范围： IPV4 IPV6 DUALSTACK |
||
| vrfName | String | 专线网关名字 | ||
| dstCidr | Array of String | 目的IPV4地址列表 | ||
| dstCidrV6 | Array of String | 目的IPV6地址列表 | ||
| nextHop | Array of Object | 下一跳及优先级列表 | NextHop | |
| nextHopV6 | Array of Object | 下一跳及优先级列表 | NextHop | |
| SRID | String | 静态路由ID |
表NextHop
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| remoteGatewayIp | String | 下一跳，即物理专线的远端互联ip | ||
| priority | Integer | 优先级 | 50 | |
| track | Integer | 0为关闭，1为开启 | ||
| bfd | Boolean | 是否开启bfd功能，true为开启，false为关闭 |
请求示例
请求url
/v4/cda/static-route/list?vrfName=nm8CTYUN14
请求头
无
请求体 body
无
响应示例
{
"returnObj": {
"staticRouteList": [{
"dstCidr": ["192.168.10.0/24"],
"vrfName": "nm8CTYUN14",
"nextHopV6": null,
"nextHop": [{
"priority": 50,
"track": 0,
"remoteGatewayIp": "67.22.60.33"
}],
"ipVersion": "IPV4",
"SRID": "1RB10L9DYFOC142G6J0TT9EWB5NX",
"dstCidrV6": null
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.CDA.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
