-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template?templateId=fbb684c8-0d37-496f-bafa-4b06d515j7l6 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
-
响应示例 返回状态码为200:接口调用成功,响应体参考OverlayWanBgpPolicyTemplateResponse。 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" : {
"templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"templateName" : "Template1",
"templateDesc" : "template desc",
"importRoutePolicy" : {
"nodes" : [
{
"nodeIndex" : 20060,
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"name" : "",
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 25,
"lessEqual" : 28
}
],
"ipv6PrefixFilters" : [
{
"ipv6Address" : "fc00::",
"maskLength" : 96,
"greaterEqual" : 96,
"lessEqual" : 96
}
]
},
"communityFilters" : [
{
"name" : "bgpCommunityFilterTest",
"communityNodes" : [
{
"matchMode" : "permit",
"communityMembers" : [
"65520:4555"
]
}
],
"wholeMatch" : ""
}
]
},
"applyAction" : {
"applyCommunity" : {
"communityNumbers" : [
"1000"
],
"additive" : "",
"none" : ""
},
"applyExtCommunity" : {
"rtFilters" : [
"65520:4552"
],
"additive" : true
},
"applyCommunityDelete" : {
"communityFilterName" : "communityTest"
},
"applyAsPath" : {
"asNumbers" : [
"1000"
],
"additive" : "",
"overwrite" : "",
"none" : ""
},
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100
},
"nextNode" : {
"nextNodeIndex" : 20080
}
}
]
},
"exportRoutePolicy" : {
"nodes" : [
{
"nodeIndex" : 20060,
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"name" : "",
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 25,
"lessEqual" : 28
}
],
"ipv6PrefixFilters" : [
{
"ipv6Address" : "fc00::",
"maskLength" : 96,
"greaterEqual" : 96,
"lessEqual" : 96
}
]
},
"communityFilters" : [
{
"name" : "bgpCommunityFilterTest",
"communityNodes" : [
{
"matchMode" : "permit",
"communityMembers" : [
"65520:4555"
]
}
],
"wholeMatch" : ""
}
]
},
"applyAction" : {
"applyCommunity" : {
"communityNumbers" : [
"1000"
],
"additive" : "",
"none" : ""
},
"applyExtCommunity" : {
"rtFilters" : [
"65520:4552"
],
"additive" : true
},
"applyCommunityDelete" : {
"communityFilterName" : "communityTest"
},
"applyAsPath" : {
"asNumbers" : [
"1000"
],
"additive" : "",
"overwrite" : "",
"none" : ""
},
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100
},
"nextNode" : {
"nextNodeIndex" : 20080
}
}
]
}
}
} 返回状态码为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的示例 GET /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/all?templateName=Template1&pageIndex=1&pageSize=10&sortKey=Template1&sortDir=DESC 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:接口调用成功,响应体参考OverlayWanBgpPolicyAllTemplateResponse。 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" : "",
"pageIndex" : 1,
"pageSize" : 10,
"totalRecords" : 10,
"data" : [
{
"templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"templateName" : "Template1",
"templateDesc" : "template desc",
"vpnId" : "310473a6-8006-48a3-9558-543d32ea1757",
"vpnName" : "VPN",
"siteCount" : "20"
}
]
} 返回状态码为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:接口调用成功,响应体参考OverlayWanBgpPolicyAllTemplateResponse。 表2 OverlayWanBgpPolicyAllTemplateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 - - 分页索引 1 pageSize int32 - - 分页大小 10 totalRecords int32 - - 总数 10 data ARRAY_REFERENCE 0-2000个列表项,详细请参见表3。 BGP路由模板列表。 - 表3 OverlayWanBgpPolicyTemplateStatisticsInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 templateId string - - 模板ID。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" templateName string - - 模板名称。 "Template1" templateDesc string - - 模板描述。 "template desc" vpnId string - - 关联VPN ID。 "310473a6-8006-48a3-9558-543d32ea1757" vpnName string - - 关联VPN名称。 "VPN" siteCount string - - 关联站点数。 "20" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
URI /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/all 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templateName 否 string - - 模板名称。 "Template1" pageIndex 否 int32 [0-2147483647] - 页面索引,不填时默认为1。 1 pageSize 否 int32 [0-1000] - 页面大小。 10 sortKey 否 string - - 排序字段,支持templateName, siteCount, 不填时按照更新时间降序排序。 "Template1" sortDir 否 string - - 升降序字段,支持ASC和DESC,默认是DESC。 "DESC"
-
响应示例 返回状态码为200:接口调用成功,响应体参考OverlayWanBgpPolicyTemplateDelResponse。 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" : [
{
"templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"templateName" : "Template1",
"errcode" : "0",
"errmsg" : ""
}
],
"fail" : [
{
"templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"templateName" : "Template1",
"errcode" : "0",
"errmsg" : ""
}
]
} 返回状态码为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:接口调用成功,响应体参考OverlayWanBgpPolicyTemplateDelResponse。 表4 OverlayWanBgpPolicyTemplateDelResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 成功删除模板。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 失败删除模板。 - 表5 OverlayWanBgpPolicyDelTemplateInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 templateId string - - 模板ID。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" templateName string - - 模板名称。 "Template1" errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayWanBgpPolicyTemplate 是 REFERENCE 详细请参见表2。 删除请求体。请求的Overlay WAN侧BGP路由策略信息中仅包含对应templateId即可。 - 表2 OverlayWanBgpPolicyTemplateDelInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templateIds 否 ARRAY_REFERENCE 1-2000个列表项,详细请参见表3。 模板列表。 - 表3 OverlayWanBgpPolicyTempDelReqInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templateId 是 string - - 模板ID。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" templateName 否 string - - 模板名称。 "template1"
-
请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template 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
{
"templateIds" : [
{
"templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"templateName" : "template1"
}
]
}
-
请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/site 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
{
"vpnId" : "310473a6-8006-48a3-9558-543d32ea1757",
"templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"siteIds" : ["00000000-0000-0000-0000-000000000000"]
}
-
响应示例 返回状态码为201:接口调用成功,响应体参考OverlayWanBgpPolicyTemplateBindSiteResponse。 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" : "",
"data" : "00000000-0000-0000-0000-000000000000"
} 返回状态码为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
-
响应示例 返回状态码为201:接口调用成功,响应体参考OverlayWanBgpPolicyTemplateChangeResponse。 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" : "",
"data" : "00000000-0000-0000-0000-000000000000"
} 返回状态码为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
-
响应参数 返回状态码为201:接口调用成功,响应体参考OverlayWanBgpPolicyTemplateChangeResponse。 表18 OverlayWanBgpPolicyTemplateChangeResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data string 0~256个字符。 - 模板ID。 "00000000-0000-0000-0000-000000000000" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template 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
{
"templateName" : "Template1",
"templateDesc" : "template desc",
"importRoutePolicy" : {
"nodes" : [
{
"nodeIndex" : 20060,
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"name" : "",
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 25,
"lessEqual" : 28
}
],
"ipv6PrefixFilters" : [
{
"ipv6Address" : "fc00::",
"maskLength" : 96,
"greaterEqual" : 96,
"lessEqual" : 96
}
]
},
"communityFilters" : [
{
"name" : "bgpCommunityFilterTest",
"communityNodes" : [
{
"matchMode" : "permit",
"communityMembers" : [
"65520:4555"
]
}
],
"wholeMatch" : ""
}
]
},
"applyAction" : {
"applyCommunity" : {
"communityNumbers" : [
"1000"
],
"additive" : "",
"none" : ""
},
"applyExtCommunity" : {
"rtFilters" : [
"65520:4552"
],
"additive" : true
},
"applyCommunityDelete" : {
"communityFilterName" : "communityTest"
},
"applyAsPath" : {
"asNumbers" : [
"1000"
],
"additive" : "",
"overwrite" : "",
"none" : ""
},
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100
},
"nextNode" : {
"nextNodeIndex" : 20080
}
}
]
},
"exportRoutePolicy" : {
"nodes" : [
{
"nodeIndex" : 20060,
"mode" : "permit",
"matchCondition" : {
"ipPrefix" : {
"name" : "",
"prefixFilters" : [
{
"ipv4Address" : "10.1.0.0",
"maskLength" : 24,
"greaterEqual" : 25,
"lessEqual" : 28
}
],
"ipv6PrefixFilters" : [
{
"ipv6Address" : "fc00::",
"maskLength" : 96,
"greaterEqual" : 96,
"lessEqual" : 96
}
]
},
"communityFilters" : [
{
"name" : "bgpCommunityFilterTest",
"communityNodes" : [
{
"matchMode" : "permit",
"communityMembers" : [
"65520:4555"
]
}
],
"wholeMatch" : ""
}
]
},
"applyAction" : {
"applyCommunity" : {
"communityNumbers" : [
"1000"
],
"additive" : "",
"none" : ""
},
"applyExtCommunity" : {
"rtFilters" : [
"65520:4552"
],
"additive" : true
},
"applyCommunityDelete" : {
"communityFilterName" : "communityTest"
},
"applyAsPath" : {
"asNumbers" : [
"1000"
],
"additive" : "",
"overwrite" : "",
"none" : ""
},
"applyMetric" : {
"cost" : "24",
"sign" : "add"
},
"localPreference" : 100,
"preferredValue" : 100
},
"nextNode" : {
"nextNodeIndex" : 20080
}
}
]
}
}