华为云用户手册

响应示例 返回状态码为200：接口调用成功，响应体参考QueryStaticRouteResponse。 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" : "", "totalRecords" : 10, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "10.1.0.0/16", "nextHopType" : "ip-address", "ipAddress" : "10.1.1.1", "track" : true, "target" : "10.1.0.0", "configSource" : "Wan", "isDefaultVpn" : false, "outBoundInterface" : "Tunnel0/0/400", "outBoundInterfaceDisplayName" : "GE0/0/2", "outBoundInterfaceType" : "IPSec" } ] } 返回状态码为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/static 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - 0 当前页，默认值为0。小于等于0时，取所有数据。 0 pageSize 否 int32 - 20 每页显示数量，默认值为20。当前页的值小于等于0时，该值不予使用。 20 sort 否 string 0~255个字符。 - 排序字段，默认按ID降序排序，当前未实现。 "id" vpnId 否 uuid - - VPN ID，UUID格式。查询LAN路由时使用。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - 传输网络端口ID，UUID格式。查询WAN路由时使用。 "a99f794e-b510-438c-a75d-de59f02347eb" isDefaultVpn 否 boolean true false - 是否查询公网VPN的路由，为null表示查询条件不生效。 false deviceId 否 uuid - - 设备ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" keyword 否 string 0~64个字符。 - 查询关键字，如目的网段或下一跳IP地址，支持模糊查询。 "10.1.0.0/24"

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/static?pageIndex=0&pageSize=20&sort=id&vpnId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&isDefaultVpn=false&deviceId=a99f794e-b510-438c-a75d-de59f02347eb&keyword=10.1.0.0/24 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：接口调用成功，响应体参考QueryStaticRouteResponse。 表2 QueryStaticRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords integer - - 总数据条数。 10 pageSize integer - 20 每页显示数量，默认20。 20 pageIndex integer - - 当前页，从1开始。 1 data ARRAY_REFERENCE 0-2000个列表项，详细请参见表5。 静态路由信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nat-policy:nat-policy-rules 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-policy:nat-policy-rules 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

响应示例 返回状态码为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 返回状态码为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/policy/traffic/behavior-profile/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 { "trafficBehaviors" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : false } } ] }

响应示例 返回状态码为200：删除成功，响应体参考TrafficBehaviorResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : false } } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : false } } } ] } 返回状态码为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

响应示例 返回状态码为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 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bgp:bgp 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-bgp:bgp" : { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "local-as" : "65001", "graceful-restart-enable" : true } }

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:bgp 是 REFERENCE 详细请参见表4。 BGP配置。 - 表4 bgp-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:bgp 否 REFERENCE 详细请参见表5。 BGP配置。 - 表5 bgp对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 config-status 否 string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态，对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态；不支持编辑，仅查询返回。 "configured-database-success" last-committed-time 否 string 0~255个字符。 - 最后提交时间，该特性最后提交时间；不支持编辑，仅查询返回。 "2022-01-01 00:00:00" related-pkg-version 否 string 0~255个字符。 - 包版本，插件包版本；不支持编辑，仅查询返回。 "1.0.1" edit-state 否 string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态，对应运行状态、候选状态、取消部署状态、未部署状态；不支持编辑，仅查询返回。 "RUNNING" local-as 否 string 1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。 - 本地AS，6700V子设备不支持。 "65001" graceful-restart-enable 否 boolean true false false GR 使能，AR6700V主设备和AR6700V子设备不支持。 true

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bgp:bgp 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

URI /v1/networkservice/hierarchy-template/template-groups/members/{id}/properties/details 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。 - 模板组成员ID，uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c"

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bindingPropertiesInput 是 REFERENCE 详细请参见表3。 修改绑定属性入参 - 表3 GetUpdateBindingPropertiesDetailsInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [1-1000] 1 页码。 1 pageSize 是 int32 [1-100] 10 每页大小，最大值为100。 10 templateName 否 string 0~1024个字符。 - 模板名称。 "template1" bindingName 否 string 0~128个字符。 - 绑定名称。 "binding1" deviceName 否 string 0~1024个字符。 - 设备名称。 "device1" siteName 否 string 0~1024个字符。 - 站点名称。 "site1" templateGroupMemberProperties 是 REFERENCE 详细请参见表3。 批量操作绑定属性入参。 - id 否 string 36个字符。 - 绑定关系ID，UUID格式。 "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 POST /v1/networkservice/hierarchy-template/template-groups/members/fbde1c5d-5b94-49e3-a912-48641015e45c/properties/details 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 { "pageIndex" : 1, "pageSize" : 10, "templateName" : "template1", "bindingName" : "binding1", "deviceName" : "device1", "siteName" : "site1", "templateGroupMemberProperties" : { "bindingName" : "binding1", "deviceRoles" : ["Gateway","CORE"], "deviceTypes" : ["AP","LSW"], "deviceModels" : ["S12700E-4","S12700E-12"], "deviceNameContains" : "device1" }, "id" : "00000000-0000-0000-0000-000000000000" }

响应示例 返回状态码为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 { "totalRecords" : 100, "progress" : 0.9, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "TemplateBinding1", "templateId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1713880927744", "description" : "this is TemplateBinding1", "totalDeviceNum" : 100, "deployedLastestSuccessDeviceCount" : 100, "templateBindingStatus" : "last-template-partly-deployed", "deployLastVersion" : true, "templateName" : "this is template1", "devices" : { "totalRecords" : 100, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "device1", "ip" : "127.0.0.1", "siteName" : "site1", "deployStatus" : "deployment-successed", "deployTime" : "1713880927744", "deployLastVersion" : true, "deployErrorMsg" : {"errorCode":"0x00c8000c","errorType":"APPLICATION","message":"The request failed because the mandatory node is empty"} } ] } } ] } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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：创建成功，返回配置后的本地用户信息，结构体参见createLocalUserInfoResponse。 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" : { "userName" : "test", "role" : 1, "serviceType" : ["http","ssh","terminal"], "configRu" : false } }

URI /controller/campus/v1/networkservice/networkconfig/net/localuser/sites/{siteId}/users 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/localuser/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/users 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 { "userName" : "test", "password" : "Iam@example", "role" : 1, "serviceType" : ["http","ssh","terminal"], "configRu" : false }

请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/upgrade/policy/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca?deviceModel=AR161FW 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：查询成功的返回信息。 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" : "error", "data" : [ { "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "upgradeMode" : 0, "autoRemoveOld" : true, "autoSaveConfig" : 0, "downloadPolicyDto" : { "type" : "weektime", "timestamp" : "1647310956667", "day" : "monday", "daytime" : "06:12:33", "timeZoneOffSet" : "+08:00" }, "restartPolicyDto" : { "type" : "weektime", "day" : "monday", "daytime" : "06:12:33", "timeZoneOffSet" : "+08:00" }, "upPath" : [ { "deviceModel" : "AR161FW", "deviceId" : "sa15fdvg-4jet-4356-nas1-3bvf5e3324c1", "targetSoftwareId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359c1", "targetPatchId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359c2", "isUninstall" : 0, "priority" : 0, "status" : 0, "downloadPolicyOutput" : { "type" : "weektime", "downloadTime" : "2021-07-10 15:35:00", "nextDownloadTime" : "2021-07-17 15:35:00", "downLoadTimeLength" : "02:15:00", "timeZoneOffSet" : "+08:00" }, "restartPolicyOutput" : { "type" : "weektime", "restartTime" : "2021-07-10 16:35:00", "nextRestartTime" : "2021-07-17 16:35:00", "timeZoneOffSet" : "+08:00" }, "upgradePolicyFeatureList" : [ { "featureFileId" : "57f879c7-7f6a-4d3a-88af-bf2585cb61e1", "featureFileName" : "Behavior-Control_6.23.0.1.270.ccx", "featureName" : "Behavior-Control", "operateType" : -1, "targetVersion" : "V600R023C00" } ] } ] } ] } 返回状态码为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/oamservice/upgrade/policy/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceModel 否 string - - 设备款型。 如果不填就是站点下所有设备。 如果填写了设备款型，只对该站点下改款型设备升级。 "AR161FW"

响应参数 返回状态码为200：查询成功，响应体参考PolicyInfoResponse。 表2 PolicyInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 policyList ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 VPN QoS组信息。 - 表3 PolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - policy ID,不可以为空。 "00000000-0000-0000-0000-000000000000" name string 1~64个字符。 - 关联policy名称 "policyName" type string - - 关联policy类型，包含qos,traffic,bandwidthMgr "qos" 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/vpn-qosgroup/policy?id=00000000-0000-0000-0000-000000000000&keyword=policy1 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：查询成功，响应体参考PolicyInfoResponse。 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" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "policyList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "policyName", "type" : "qos" } ] } 返回状态码为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：查询成功，查询指设备的RU-201信息。 表2 QueryRuResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 RuInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ruInfos ARRAY_REFERENCE 0-10000个列表项，详细请参见表4。 - - 表4 RuInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId uuid 0~36个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" deviceName string 0~256个字符。 - 设备名称。 "device1" interfaceName string 1~64个字符。 - 接入接口名称。 "GigabitEthernet/0/0/1" status string 1~32个字符。 - 状态，取值范围：0：离线，1：在线，2：已连接，3：下载。 "1" deviceType string - - RU类型。 "RU-201" esn string 0~64个字符。 - RU设备ESN。 "UTJ7500A13000350" version string - - RU设备版本号 "3.0.0.1" ip string - - RU设备版本号 "3.0.0.1" 返回状态码为400：参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：系统内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，查询指设备的RU-201信息。 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" : { "ruInfos" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "interfaceName" : "GigabitEthernet/0/0/1", "status" : "1", "deviceType" : "RU-201", "esn" : "UTJ7500A13000350", "version" : "3.0.0.1", "ip" : "3.0.0.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

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/queryru?deviceId=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

请求示例 HTTP的示例 PUT /v1/networkconfig/wlan/site-templates/00000000-0000-0000-0000-000000000000/ap/vlanpools/unbind 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" : ["00000000-0000-0000-0000-0000000"] }