-
响应示例 返回状态码为200:切换注册WAN链路成功,响应体参考SiteManagerLinkChangeResponse。 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" : "a99f794e-b510-438c-a75d-de59f02347eb",
"deviceId" : "a99f794e-b510-438c-a75d-de59f02347aa",
"wanLinkId" : "a99f794e-b510-438c-a75d-de59f02347bb",
"protocol" : "IPv4",
"southAccessRole" : 1,
"accessIpMode" : 0
}
} 返回状态码为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:切换注册WAN链路成功,响应体参考SiteManagerLinkChangeResponse。 表3 SiteManagerLinkChangeResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表4。 调用设备切换当前注册AC的WAN链路返回结果。 - 表4 SiteManagerLinkChange对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId UUID - - 站点ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId UUID - - 设备ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347aa" wanLinkId string 0~64个字符。 - 链路ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347bb" protocol string 0~32个字符。 - 注册AC链路的协议:IPv4、IPv6,默认值IPv4。 "IPv4" southAccessRole integer [1-2] 1 南向接入服务,1表示南向接入服务1、2表示南向接入服务2,默认值为1。IPv6不支持使用南向接入服务2。 1 accessIpMode integer [0-1] 0 南向接入IP模式,0表示主用南向IP、1表示备用南向IP,默认值为0。 0 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteManagerLinkUpdateRequest 是 REFERENCE 详细请参见表2。 入参 - 表2 SiteManagerLinkChange对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 UUID - - 站点ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 UUID - - 设备ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347aa" wanLinkId 否 string 0~64个字符。 - 链路ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347bb" protocol 否 string 0~32个字符。 - 注册AC链路的协议:IPv4、IPv6,默认值IPv4。 "IPv4" southAccessRole 否 integer [1-2] 1 南向接入服务,1表示南向接入服务1、2表示南向接入服务2,默认值为1。IPv6不支持使用南向接入服务2。 1 accessIpMode 否 integer [0-1] 0 南向接入IP模式,0表示主用南向IP、1表示备用南向IP,默认值为0。 0
-
请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/site-manage-link 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
{
"siteId" : "a99f794e-b510-438c-a75d-de59f02347eb",
"deviceId" : "a99f794e-b510-438c-a75d-de59f02347aa",
"wanLinkId" : "a99f794e-b510-438c-a75d-de59f02347bb",
"protocol" : "IPv4",
"southAccessRole" : 1,
"accessIpMode" : 0
}
-
响应示例 返回状态码为200:查看当前站点纳管的WAN链路成功,响应体参考QuerySiteManagerLinkResponse。 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" : "a99f794e-b510-438c-a75d-de59f02347eb",
"deviceId" : "a99f794e-b510-438c-a75d-de59f02347cd",
"deviceName" : "Device1",
"wanLinkId" : "a99f794e-b510-438c-a75d-de59f02347dd",
"wanName" : "link1",
"protocol" : "IPv4",
"interfaceName" : "GigabitEthernet0/0/4",
"switchState" : "failed",
"reasons" : "连接失败",
"linkUpdateState" : "success"
}
]
} 返回状态码为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:查看当前站点纳管的WAN链路成功,响应体参考QuerySiteManagerLinkResponse。 表2 QuerySiteManagerLinkResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-1000个列表项,详细请参见表3。 当前站点纳管的WAN链路。 - 表3 SiteManagerLinkInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId UUID - - 站点ID,格式为uuid。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId UUID - - 设备ID,格式为uuid。 "a99f794e-b510-438c-a75d-de59f02347cd" deviceName string - - 设备名称。 "Device1" wanLinkId string - - 链路ID,格式为uuid。 "a99f794e-b510-438c-a75d-de59f02347dd" wanName string - - WAN链路名称。 "link1" protocol string - - 注册AC链路的协议:IPv4、IPv6。 "IPv4" interfaceName string - - 物理接口名称。 "GigabitEthernet0/0/4" switchState string - - 切换状态。 "failed" reasons string - - 失败原因。 "连接失败" linkUpdateState string - - 链路更新状态。该字段已废弃。 "success" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/site-manage-link?siteId=a99f794e-b510-438c-a75d-de59f02347eb&deviceId=a99f794e-b510-438c-a75d-de59f02347cd 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
-
URI /controller/campus/v1/sdwan/net/site-manage-link 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 UUID - - 站点ID,格式为uuid,站点ID和设备ID至少有一个。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 UUID - - 设备ID,格式为uuid,站点ID和设备ID至少有一个。 "a99f794e-b510-438c-a75d-de59f02347cd"