接口功能介绍
编辑智能网关ospf协议配置
接口约束
智能网关必须配成双臂旁挂,且开启智能网关ospf开关
输入参数名称类长度不超过64位,描述类长度不超过128位
URI
POST /v4/sdwan/edge-ospf/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
edgeID | 是 | String | 智能网关ID | 87a74704-3efd-11ed-910d-005056893e3e | |
ospfIntfIP | 是 | String | ospf接口IP | 10.1.1.1/24 | |
authEnable | 是 | Boolean | 是否开启md5认证 | true | |
keyID | 是 | Integer | md5认证的key-id,范围1-255 | 1 | |
mdsKey | 是 | String | md5认证的mds-key,长度不超过16 | 123456 | |
helloTime | 是 | Integer | 上传Hello数据包的时间(单位:秒),范围1-65535 | 20 | |
deadTime | 是 | Integer | 等待接收Hello数据包的时间(单位:秒),范围1-65536 | 60 | |
areaID | 是 | Integer | 区域ID,范围1-65535 | 1 | |
routerID | 是 | String | ospf业务标识,必须为IPv4格式 | 100.0.0.1 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | Integer | 返回状态码(800为成功,900为失败) ,默认值:800 | 800 | |
errorCode | 否 | String | 业务细分码,为product.module.code三段式码 | ||
message | 否 | String | 失败时的错误描述,一般为英文描述 | ||
description | 否 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 否 | Array of Strings | 返回参数 |
请求示例
请求头header
无
请求体body
{
"edgeID": "87a74704-3efd-11ed-910d-005056893e3e",
"ospfIntfIP": "10.1.1.1/24",
"authEnable": true,
"keyID": 123,
"mdsKey": "123456",
"helloTime": 20
"deadTime": 60,
"areaID": 1,
"routerID": "100.0.0.1"
}
响应示例
{
"statusCode": 800,
"returnObj": [],
"errorCode": "",
"message": "",
"description": ""
}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.SdwanSdwan.UpdateError | 内部错误,请重试。如果多次尝试失败,请提交工单 |