接口功能介绍
查询智能网关ospf配置信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/edge-ospf/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | 智能网关ID | 87a74704-3efd-11ed-910d-005056893e3e |
请求参数
请求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 | 查询ospf | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ospfIntfIP | 否 | String | ospf接口IP | 10.1.1.1/24 | |
| ospfEnable | 否 | Boolean | 是否启用ospf | true | |
| authEnable | 否 | Boolean | 是否开启md5认证 | true | |
| helloTime | 否 | Integer | 上传Hello包之间的周期性间隔(单位：秒) | 20 | |
| deadTime | 否 | Integer | 等待接收Hello数据包的时间(单位：秒) | 60 | |
| areaID | 否 | Integer | 区域ID | 1 | |
| routerID | 否 | String | ospf业务标识 | 100.1.1.1 | |
| keyID | 否 | Integer | md5认证的key-id | 1 | |
| mdsKey | 否 | String | md5认证的mds-key | 123456 |
请求示例
请求url
/v4/sdwan/edge-ospf/list?edgeID=87a74704-3efd-11ed-910d-005056893e3e
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"ospfIntfIP": "10.1.1.1/24",
"ospfEnable": true,
"authEnable": true,
"helloTime": 20,
"deadTime": 60,
"areaID": 1,
"routerID": "100.0.0.1",
"keyID": 1,
"mdsKey": "123456"
}
],
"totalCount": 1,
"currentCount": 1
}，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| EdgeOspf.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
