华为云用户手册

响应参数 返回状态码为200：操作成功，返回用户组ID，响应体参考AddUsergroupOutputDto。 表3 AddUsergroupOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息描述。 "" data REFERENCE 详细请参见表4。 返回数据内容。 - 表4 AddUsergroupOutData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 用户组ID。UUID格式 "a91e1696-02a2-4a68-bad4-aa639359c8cf" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：操作成功，返回用户组ID，响应体参考AddUsergroupOutputDto。 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" : { "id" : "a91e1696-02a2-4a68-bad4-aa639359c8cf" } } 返回状态码为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的示例 POST /controller/campus/v1/accountservice/usergroups 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 { "parentId" : "a91e1696-02a2-4a68-bad4-aa639359c8cf", "name" : "friend", "address" : "Xihu North Community", "postalCode" : "125744", "adminEmail" : "xxx@example.com", "description" : "common user group" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 用户组结构。 - 表2 AddUsergroupInputDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parentId 是 string - - 父用户组ID。UUID格式 "a91e1696-02a2-4a68-bad4-aa639359c8cf" name 是 string 1~128个字符。 - 用户组名称，不能包含=+%,#"特殊字符。 "friend" address 否 string 0~256个字符。 - 地址。 "Xihu North Community" postalCode 否 string 0~50个字符。 - 邮编。 "125744" adminEmail 否 string 0~100个字符。 - 用户组管理员邮箱。 "xxx@example.com" description 否 string 0~256个字符。 - 用户组描述信息。 "common user group"

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/unbind-policy 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 { "policyId" : "00000000-0000-0000-0000-000000000000", "policyType" : "qos", "effectImmediate" : true, "sites" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site1", "tnpIds" : [ "00000000-0000-0000-0000-000000000000" ], "externalPortIds" : [ "00000000-0000-0000-0000-000000000000" ], "lanPortIds" : [ "00000000-0000-0000-0000-000000000000" ], "devicePortTypes" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "portType" : "EvpnTunnel" } ], "destSites" : [ "00000000-0000-0000-0000-000000000000" ] } ], "status" : "committing" }

响应示例 返回状态码为200：配置成功，响应体参考ApplyPolicyResponse。 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" : "", "errparam" : "["policyName"]", "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考ApplyPolicyResponse。 HTTP/1.1 202 Accepted 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 返回状态码为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、该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、当policyType为vpn bandwidth时，接口返回202，表示请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功；接口返回其他状态码，表示请求已处理完成。当policyType为其他类型时，接口在提交之后立即返回，实际业务还在执行中，可通过对应策略的查询接口查询执行状态。

响应参数 返回状态码为200：配置成功，响应体参考ApplyPolicyResponse。 ApplyPolicyResponse对象的参数列表，详细请参见表6。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考ApplyPolicyResponse。 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除成功，响应体参考CommonDeviceManagerResponse。 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" : "" } 返回状态码为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的示例 DELETE /controller/campus/v1/sdwan/aaa/devicemanager/00000000-0000-0000-0000-000000000000 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：正常响应,返回体参考QueryInterlinkRouteResponse。 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" : 20, "totalRecords" : 1, "success" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "interlinkRoutes" : [ { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "helloTimer" : 5, "timerDead" : 15, "enableImportDefaultRoute" : false } ] } } 返回状态码为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/net/interlink-route?pageIndex=1&pageSize=20&vpnId=00000000-0000-0000-0000-000000000000&siteId=00000000-0000-0000-0000-000000000000 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：正常响应,返回体参考QueryInterlinkRouteResponse。 表2 QueryInterlinkRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 - - 页码。 1 pageSize int32 - - 页大小。 20 totalRecords int32 - - 总数。 1 success REFERENCE 详细请参见表3。 - - 表3 InterlinkRouteInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vpnId uuid 0~36个字符。 - VPN ID，uuid格式。 "00000000-0000-0000-0000-000000000000" interlinkRoutes ARRAY_REFERENCE 1-100个列表项，详细请参见表4。 双网关互联链路路由信息。 - 表4 InterlinkRouteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 0~36个字符。 - ID，uuid格式。 "00000000-0000-0000-0000-000000000000" siteId uuid 0~36个字符。 - 站点ID，uuid格式。 "00000000-0000-0000-0000-000000000000" helloTimer int32 [1-65535] 5 Hello报文时间间隔。建议Hello报文时间间隔取值不小于5，否则可能会造成邻接关系的中断。缺省情况下，P2P、Broadcast类型接口发送Hello报文的时间间隔的值为10秒；P2MP、NBMA类型接口发送Hello报文的时间间隔的值为30秒 5 timerDead int32 [1-65535] - OSPF的邻居失效时间，必须大于Hello报文的时间间隔。 15 enableImportDefaultRoute boolean true false - 是否引入双网关默认路由。 false 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功。 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" : [ { "id" : "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845", "nameCn" : "(UTC)协调世界时，加那利群岛", "nameEn" : "(UTC)UTC,Canary Islands", "timezoneUtcOffset" : "0" } ] }

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/timezones 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：查询成功。 表1 TimezoneRespDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表2。 所有时区资源。 - 表2 TimezoneDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 时区ID，字符串格式为UUID。 "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845" nameCn string 1~128个字符。 - 时区名称（中文） "(UTC)协调世界时，加那利群岛" nameEn string 1~128个字符。 - 时区名称（英文）。 "(UTC)UTC,Canary Islands" timezoneUtcOffset string 1~4个字符。 - 时区区号。 "0"

响应示例 返回状态码为200：接口调用成功，响应体参考IPv6OspfRouteResponse，返回的IPv6 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, "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的示例 POST /controller/campus/v1/sdwan/routing-protocol/ipv6ospf/action/batch-delete 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" } ] }

URI /controller/campus/v1/performanceservice/station/client/device/{deviceId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID，UUID格式。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [1-65535] 1 分页查询的页码。 1 pageSize 是 int32 [20-100] 20 分页查询每页数量。 20 status 否 string online offline online 用户在线状态，online---在线、offline---离线，不填代表查询全部状态。 - terminalMac 否 string 14~256个字符。 - 终端MAC，需要符合mac地址的格式，例如xx-xx-xx-xx-xx-xx，需要区分大小写字母。 "xx-xx-xx-xx-xx-xx" terminalIP 否 string 0~256个字符。 - 终端IP，需要符合IP地址的格式，例如192.168.1.2。 "192.168.1.2" ssid 否 string 0~256个字符。 - WiFi名。 "wifi" sortKey 否 string 0~256个字符。 - 排序列，所有支持accessTime/accessType/account/ap/authType/channel/cumulativeTraffic/downwardSpeed/dualFrequency/frequencyBand/hostName/mode/onlineStatus/onlineTime/packageLossRate/retransRate/rssi/sendPackageSpeed/signalNoiseRatio/ssid/stickyTags/terminalIp/terminalMac/timeStamp/upwardSpeed/vlan均支持排序。如：+accessTime:按accesstime升序，-accessTime:按accessTime降序。 "+accessTime" account 否 string 0~256个字符。 - 用户名。 "test"

请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/station/client/device/b473118d-17ff-4f4f-9fa9-a4c0e1e87e42?pageIndex=1&pageSize=20&terminalMac=xx-xx-xx-xx-xx-xx&terminalIP=192.168.1.2&ssid=wifi&sortKey=+accessTime&account=test 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：接口调用成功，响应体参考StationDataResp。 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" : "", "total" : 10, "data" : [ { "accessTime" : 0, "accessMac" : "xx:xx:xx:xx:xx:xx", "accessType" : 0, "account" : "user1", "deviceName" : "device1", "authType" : "WPA2-PSK", "channel" : 1, "cumulativeTraffic" : 1024, "downwardSpeed" : 0, "dualFrequency" : 1, "frequencyBand" : 2, "hostName" : "Honor 8", "mode" : 4, "onlineStatus" : 1, "onlineTime" : 100, "packageLossRate" : 1, "portIndex" : 0, "retransRate" : 0, "rssi" : 0, "sendPackageSpeed" : 0, "signalNoiseRatio" : 0, "ssid" : "wifi123", "stickyTags" : 1, "terminalIP" : "192.168.2.34", "terminalMac" : "xx:xx:xx:xx:xx:xx", "upwardSpeed" : 0, "vlan" : 100 } ] } 返回状态码为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

响应示例 返回状态码为201：接口调用成功，响应体参考PortResponse。 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" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portType" : "GE", "portNumber" : "2/0/0", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Device1", "portSwitch" : "layer2-port", "isPhysical" : false, "stpEnable" : true, "pnpVlanEnable" : true, "linkInfo" : { "linkType" : "Ethernet", "cellular" : { "apn" : "abc" }, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 }, "ethernet" : { "negotiationMode" : "auto", "media" : "copper", "duplex" : "full", "speed" : 100 } }, "isMemberEthTrunk" : true, "isMemberWanLink" : true, "isInterLink" : true, "bandwidth" : 10, "trustEnable" : false, "trust" : "dscp", "description" : "port description", "isRuLink" : true, "ruMntAddress" : "192.168.2.1", "prefixLength" : 24 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portType" : "GE", "portNumber" : "2/0/0", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Device1", "portSwitch" : "layer2-port", "isPhysical" : false, "stpEnable" : true, "pnpVlanEnable" : true, "linkInfo" : { "linkType" : "Ethernet", "cellular" : { "apn" : "abc" }, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 }, "ethernet" : { "negotiationMode" : "auto", "media" : "copper", "duplex" : "full", "speed" : 100 } }, "isMemberEthTrunk" : true, "isMemberWanLink" : true, "isInterLink" : true, "bandwidth" : 10, "trustEnable" : false, "trust" : "dscp", "description" : "port description", "isRuLink" : true, "ruMntAddress" : "192.168.2.1", "prefixLength" : 24 } } ] } 返回状态码为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的示例 POST /controller/campus/v1/sdwan/net/ports 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 { "ports" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portType" : "GE", "portNumber" : "2/0/0", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Device1", "portSwitch" : "layer2-port", "isPhysical" : false, "stpEnable" : true, "pnpVlanEnable" : true, "linkInfo" : { "linkType" : "Ethernet", "cellular" : { "apn" : "abc" }, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 }, "ethernet" : { "negotiationMode" : "auto", "media" : "copper", "duplex" : "full", "speed" : 100 } }, "isMemberEthTrunk" : true, "isMemberWanLink" : true, "isInterLink" : true, "bandwidth" : 10, "trustEnable" : false, "trust" : "dscp", "description" : "port description", "isRuLink" : true, "ruMntAddress" : "192.168.2.1", "prefixLength" : 24 } ] }

响应示例 返回状态码为200：查询成功，响应体参考SyslogSitesRsp。 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" : 0, "pageSize" : 10, "totalRecords" : 100, "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "platform" : "pnf", "associatedType" : "overlay", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "SyslogDeviceInfo" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "configuredSourceIp" : "192.168.0.1", "configuredSourcePort" : "", "linkInfos" : [ { "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link1", "used" : true } ], "sourceInfos" : [ { "sourceIp" : "192.168.0.1", "sourceInterface" : "loopback601", "used" : true } ], "isConfigured" : true } ] } ] } 返回状态码为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：查询成功，响应体参考SyslogSitesRsp。 表3 SyslogSitesRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" pageIndex int32 - - 当前页。 0 pageSize int32 - - 页大小。 10 totalRecords int32 - - 总数。 100 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 主体数据。 - 表4 SyslogSiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string - - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "site1" platform string - - 站点下设备是否是V600系列版本的标识。pnf表示是V600系列版本的设备。 "pnf" associatedType string - - 关联方式，存在如下两种：overlay、underlay。 "overlay" vpnId string - - VPN ID。 "00000000-0000-0000-0000-000000000000" vpnName string - - VPN名称。 "vpn1" SyslogDeviceInfo ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 设备日志服务器关联设备点信息。 - 表5 SyslogDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string - - 设备ID。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "device1" configuredSourceIp string - - 配置过的设备日志源Ip，用于记录V600系列版本的设备配置，或者二进制日志场景设备。 "192.168.0.1" configuredSourcePort integer [10240-55534] - 二进制日志场景设备日志源端口。 - linkInfos ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 underlay关联时，该设备下所有链路信息。 - sourceInfos ARRAY_REFERENCE 0-100个列表项，详细请参见表7。 overlay关联时，该设备当前vpnId下所有loopback口信息。 - isConfigured boolean true false - 当前设备是否配置了设备日志服务器。true表示已配置，false表示未配置。 true 表6 LinkInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" linkName string - - 链路名称。 "link1" used boolean true false - 该链路是否已经被使用，true为是，false为否。 true 表7 SourceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 sourceIp string - - loopback口的Ip。 "192.168.0.1" sourceInterface string - - loopback口的接口名。 "loopback601" used boolean true false - 该loopback口是否已经被使用，true为是，false为否。 true 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

URI /controller/campus/v2/sdwansyslog/syslog/{id}/usedsite 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 0~36个字符。 - 设备日志服务器id。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 integer [1-10000] - 当前页。 pageIndex或pageSize不填写时表示全量查询。 1 pageSize 否 integer [1-1000] - 页大小。 pageIndex或pageSize不填写时表示全量查询。 10 siteName 否 string - - 站点名称。 支持模糊查询。 "site1"

请求示例 HTTP的示例 GET /controller/campus/v2/sdwansyslog/syslog/00000000-0000-0000-0000-000000000000/usedsite?pageIndex=1&pageSize=10&siteName=site1 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：删除成功，响应体参考QosWredProfileResponse。 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" : { "name" : "wred1", "fullReplace" : false, "dscpInfos" : [ { "wredMode" : 1, "value" : 10, "lowLimit" : 10, "highLimit" : 10, "percentage" : 10 } ], "id" : "00000000-0000-0000-0000-000000000000" } } 返回状态码为204：执行成功，无响应体。 HTTP/1.1 204 No Content 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 返回状态码为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的示例 DELETE /controller/campus/v1/sdwan/policy/traffic/qos/wred-profile?id=00000000-0000-0000-0000-000000000000&dscpValue=10 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/policy/traffic/qos/wred-profile 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 uuid - - 模板ID。 "00000000-0000-0000-0000-000000000000" dscpValue 否 int32 [0-63] - 指定DSCP值。dscpValue不为空表示删除Wred模板中特定DscpInfo，为空表示删除整个Wred模板。 10