接口功能介绍
查询静态路由
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/edge-static-route/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | 智能网关Id | 4f4d9452-388c-11ed-a977-005056898fe0 | |
| pageNo | 否 | Integer | 页数 | 1 | |
| pageSize | 否 | Integer | 页大小 | 5 | |
| search | 否 | String | 模糊查询 | 中关村 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 查询静态路由 | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 当前页总数 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| routeID | 否 | String | 静态路由Id | 65768712-3890-11ed-a977-005056898fe0 | |
| protocol | 否 | String | 本参数表示ip协议版本 取值范围： IPv4：IPv4协议 IPv6: IPv6协议 |
IPv4 | |
| edgeCIDR | 否 | String | 子网 | 156.13.5.3/32 | |
| nextHopList | 否 | Array of Objects | 下一跳信息 | nextHopList | |
| status | 否 | String | 本参数表示路由状态 取值范围： success：生效 |
success |
表nextHopList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| nextHop | 否 | String | 下一跳地址 | 123.4.7.9 | |
| priority | 否 | Integer | 优先级 | 90 | |
| interfaceName | 否 | String | 出接口 | wan1 |
请求示例
请求url
/v4/sdwan/edge-static-route/list?edgeID=4f4d9452-388c-11ed-a977-005056898fe0
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"routeID": "65768712-3890-11ed-a977-005056898fe0",
"protocol": "IPv4",
"edgeCIDR": "156.13.5.3/32",
"nextHopList": [
{
"nextHop": "123.4.6.7",
"priority": 70,
"interfaceName": "wan1"
}
],
"status": "success"
}
],
"totalCount": 1,
"currentCount": 1
}，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
