-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/ospf/interface-param/delete HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN: x-yyyyyy
{
"interfaceParams" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"processId" : 501,
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
]
}
]
}
-
响应示例 返回状态码为200:接口调用成功,响应体参考OspfRouteInterfaceParamResponse,返回的OSPF路由信息中仅包含对应的ID。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"success" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"processId" : 501,
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
]
}
],
"fail" : [
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"processId" : 501,
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
]
}
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应示例 返回状态码为200:接口调用成功,响应体参考IPv6OspfRouteResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"success" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"routerId" : "192.168.1.1",
"processId" : 501,
"defaultRouteAdvertisement" : false,
"defaultRouteCost" : 1,
"internalPreference" : 10,
"asePreference" : 150,
"routeRedistribute" : [
{
"type" : "DIRECT",
"processId" : 501,
"cost" : 1
}
],
"exportRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv6Address" : "FC00:3::1",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"importRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv6Address" : "FC00:3::1",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerDead" : 1,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerDead" : 1,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"configSource" : "Wan"
}
],
"fail" : [
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"routerId" : "192.168.1.1",
"processId" : 501,
"defaultRouteAdvertisement" : false,
"defaultRouteCost" : 1,
"internalPreference" : 10,
"asePreference" : 150,
"routeRedistribute" : [
{
"type" : "DIRECT",
"processId" : 501,
"cost" : 1
}
],
"exportRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv6Address" : "FC00:3::1",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"importRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv6Address" : "FC00:3::1",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerDead" : 1,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerDead" : 1,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"configSource" : "Wan"
}
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/routing-protocol/ipv6ospf HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"routes" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"routerId" : "192.168.1.1",
"processId" : 501,
"defaultRouteAdvertisement" : false,
"defaultRouteCost" : 1,
"internalPreference" : 10,
"asePreference" : 150,
"routeRedistribute" : [
{
"type" : "DIRECT",
"processId" : 501,
"cost" : 1
}
],
"exportRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv6Address" : "FC00:3::1",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"importRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv6Address" : "FC00:3::1",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerDead" : 1,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerDead" : 1,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"configSource" : "Wan"
}
]
}
-
响应示例 返回状态码为201:接口调用成功,响应体参考OspfRouteInterfaceParamResponse,返回的OSPF路由信息中仅包含对应的ID。 HTTP/1.1 201 Created
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"success" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"processId" : 501,
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
]
}
],
"fail" : [
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"processId" : 501,
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
]
}
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ospfRouteInterfaceParamInfos 是 REFERENCE 详细请参见表2。 OSPF路由接口信息。 - 表2 OspfRouteInterfaceParamInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaceParams 否 ARRAY_REFERENCE 1-8个列表项,详细请参见表3。 Ospf路由接口参数信息。 - 表3 OspfRouteInterfaceParamInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 对应站点ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 是 uuid - - 设备ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 uuid - - 所在VPN ID。格式是uuid,创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId 否 uuid - - 所在TNP ID。格式是uuid,创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" processId 是 int32 [1-65535] - 接口需要绑定的ospf进程id 501 ipSubnets 否 ARRAY_REFERENCE 0-64个列表项,详细请参见表13。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts 否 ARRAY_REFERENCE 0-64个列表项,详细请参见表13。 TNP接口参数。创建underlay ospf时必填。 -
-
响应参数 返回状态码为201:接口调用成功,响应体参考OspfRouteInterfaceParamResponse,返回的OSPF路由信息中仅包含对应的ID。 表4 OspfRouteInterfaceParamResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-8个列表项,详细请参见表5。 创建或者更新成功的OSPF路由全局进程信息。 - fail ARRAY_REFERENCE 0-8个列表项,详细请参见表6。 创建或者更新失败的OSPF路由全局进程信息。 - 表5 OspfRouteInterfaceParamInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 对应站点ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId uuid - - 设备ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId uuid - - 所在VPN ID。格式是uuid,创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId uuid - - 所在TNP ID。格式是uuid,创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" processId int32 [1-65535] - 接口需要绑定的ospf进程id 501 ipSubnets ARRAY_REFERENCE 0-64个列表项,详细请参见表25。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts ARRAY_REFERENCE 0-64个列表项,详细请参见表25。 TNP接口参数。创建underlay ospf时必填。 - 表6 FailOspfRouteInterfaceParamInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 OSPF路由接口信息 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/ospf/interface-param HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"interfaceParams" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"processId" : 501,
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerPoll" : 1,
"timerRetransmit" : 1,
"timerDead" : 1,
"mtuEnable" : false,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
]
}
]
}
-
响应参数 返回状态码为200:接口调用成功,响应体参考QueryIPv6OspfRouteResponse。 表2 QueryIPv6OspfRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-8个列表项,详细请参见表14。 IPv6 OSPF路由信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/ipv6ospf?vpnId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
-
响应示例 返回状态码为200:接口调用成功,响应体参考QueryIPv6OspfRouteResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"data" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"routerId" : "192.168.1.1",
"processId" : 501,
"defaultRouteAdvertisement" : false,
"defaultRouteCost" : 1,
"internalPreference" : 10,
"asePreference" : 150,
"routeRedistribute" : [
{
"type" : "DIRECT",
"processId" : 501,
"cost" : 1
}
],
"exportRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv6Address" : "FC00:3::1",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"importRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv6Address" : "FC00:3::1",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"ipSubnets" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerDead" : 1,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"transportNetworkPorts" : [
{
"interfaceType" : "tunnel",
"interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"areaId" : "0",
"areaType" : "normal",
"authMode" : "none",
"cryptographicSuit" : "hmac-sha256",
"key" : 1,
"cryptographicPwd" : "1",
"helloTimer" : 1,
"timerDead" : 1,
"networkType" : "broadcast",
"cost" : 1,
"drPriority" : 1
}
],
"configSource" : "Wan"
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
URI /controller/campus/v1/sdwan/routing-protocol/ipv6ospf 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid - - VPN ID。格式是uuid,vpnId与tnpId只能填一个,两者都不填表示查询站点下所有underlay数据。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - TNP ID。格式是uuid,当前不支持。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID。格式是uuid。 "a99f794e-b510-438c-a75d-de59f02347eb"
-
响应示例 返回状态码为200:接口调用成功,响应体参考OspfRouteGlobalResponse,返回的OSPF路由信息中仅包含对应的ID。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"success" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"routerId" : "192.168.1.1",
"processId" : 501,
"defaultRouteAdvertisement" : false,
"defaultRouteCost" : 1,
"defaultRouteType" : 1,
"internalPreference" : 10,
"asePreference" : 150,
"routeRedistribute" : [
{
"type" : "BGP",
"processId" : 501,
"cost" : 1,
"externalRouteType" : 1
}
],
"asbrSummarys" : [
{
"ipAddress" : "10.1.0.0/16",
"cost" : 0,
"tag" : 1,
"distributeDelay" : 1,
"advertise" : true,
"generateNull0Route" : false
}
],
"exportRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"importRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"configSource" : "Wan"
}
],
"fail" : [
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"routerId" : "192.168.1.1",
"processId" : 501,
"defaultRouteAdvertisement" : false,
"defaultRouteCost" : 1,
"defaultRouteType" : 1,
"internalPreference" : 10,
"asePreference" : 150,
"routeRedistribute" : [
{
"type" : "BGP",
"processId" : 501,
"cost" : 1,
"externalRouteType" : 1
}
],
"asbrSummarys" : [
{
"ipAddress" : "10.1.0.0/16",
"cost" : 0,
"tag" : 1,
"distributeDelay" : 1,
"advertise" : true,
"generateNull0Route" : false
}
],
"exportRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"importRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"configSource" : "Wan"
}
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应参数 返回状态码为200:接口调用成功,响应体参考OspfRouteGlobalResponse,返回的OSPF路由信息中仅包含对应的ID。 表4 OspfRouteGlobalResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-8个列表项,详细请参见表5。 创建或者更新成功的OSPF路由全局进程信息。 - fail ARRAY_REFERENCE 0-8个列表项,详细请参见表6。 创建或者更新失败的OSPF路由全局进程信息。 - 表5 OspfRouteGlobalInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 对应站点ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId uuid - - 设备ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId uuid - - 所在VPN ID。格式是uuid,创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId uuid - - 所在TNP ID。格式是uuid,创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" routerId string - - 用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.1网段。 "192.168.1.1" processId int32 [1-65535] - 进程号。创建时必填。EVPN隧道模式下,Underlay场景,取值范围20001-30000;Overlay场景,取值范围:1-20000。 501 defaultRouteAdvertisement boolean true false false 是否开启通告默认路由。创建时必填。 false defaultRouteCost int32 [1-16777214] 1 默认路由开销。开启通告默认路由时必填。 1 defaultRouteType int32 - 2 OSPF通告默认路由时的外部路由类型,开启通告默认路由时必填,取值范围1-2,Type1外部路由表示此类路由的可信度高,Type2外部路由表示此类路由的可信度低。 1 internalPreference int32 [1-255] 10 内部优先级。创建时必填。 10 asePreference int32 [1-255] 150 ASE优先级。创建时必填。 150 routeRedistribute ARRAY_REFERENCE 0-64个列表项,详细请参见表16。 路由引入。 - asbrSummarys ARRAY_REFERENCE 0-64个列表项,详细请参见表17。 边界路由聚合列表。 - exportRoutePolicy REFERENCE 详细请参见表18。 发布路由策略 - importRoutePolicy REFERENCE 详细请参见表18。 接收路由策略 - configSource string 0~32个字符。 - 配置源信息,用于区分是WAN业务还是LanWan互联业务,仅查询接口使用,不能修改,取值范围:Wan、LanWan。 "Wan" 表6 FailOspfRouteGlobalInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 OSPF路由全局进程信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/ospf/global HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"globalInfos" : [
{
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"routerId" : "192.168.1.1",
"processId" : 501,
"defaultRouteAdvertisement" : false,
"defaultRouteCost" : 1,
"defaultRouteType" : 1,
"internalPreference" : 10,
"asePreference" : 150,
"routeRedistribute" : [
{
"type" : "BGP",
"processId" : 501,
"cost" : 1,
"externalRouteType" : 1
}
],
"asbrSummarys" : [
{
"ipAddress" : "10.1.0.0/16",
"cost" : 0,
"tag" : 1,
"distributeDelay" : 1,
"advertise" : true,
"generateNull0Route" : false
}
],
"exportRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"importRoutePolicy" : {
"nodes" : [
{
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 24,
"lessEqual" : 24
}
]
},
"tag" : 100
},
"applyAction" : {
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100,
"applyTag" : 100
}
}
]
},
"configSource" : "Wan"
}
]
}