请求示例 POST https://{host}:{port}/iodm/northbound/v1.5.0/operations/softwareUpgrade Content-Type: application/json app_key: ****** Authorization: Bearer ****** { "fileId": "**********", "targets": { "devices": [ "*****" ] } }

错误码 Http状态码 错误码 错误描述 说明 400 120015 Bad request error. 请求错误。 处理建议：请检查请求参数的是否有误。 400 123016 The parameter is error, targetversion not match with device. 参数不正确，目标版本与指定设备不匹配。 处理建议：请检查接口请求中deviceType、manufacturerName、model，与参数fileId指定的目标版本包信息是否一致。 400 123019 manufacturerName is null. 厂商名称内容为空。 处理建议：请检查接口请求中的manufacturerName是否为空。 400 123020 deviceType is null 设备类型内容为空。 处理建议：请检查接口请求中的deviceType是否为空。 400 123021 model is null. 设备型号内容为空。 处理建议：请检查接口请求中的model是否为空。 400 123022 deviceGroups and devices cannot be null together deviceGroups和devices不能同时为空。 处理建议：deviceGroups与devices必须要选择一个进行赋值。 400 123023 deviceGroups and devices cannot be exist together deviceGroups和devices不能同时存在。 处理建议：deviceGroups与devices只能选择一个进行赋值。 400 123024 The number of deviceGroups or devices reached upper limit deviceGroups或devices内容数量达到上限。 处理建议：请检查deviceGroups或devices的内容，数量不能超过256个。 400 123025 executeType is error or can not to be null. executeType有误或不能为空。 处理建议：请检查接口请求中的executeType是否为空或者是否有误。 400 123026 startTime or endTime is null or error. startTime或endTime为空或有误。 处理建议：请检查接口请求中的startTime和endTime是否为空或者格式有误。 400 123028 retryTimes is null or beyond the limit. retryTimes为空或超出上限。 处理建议：请检查接口请求中的retryTimes是否为空，或者不能小于1或者大于5。 400 123032 startTime can not be later than the endTime. startTime的时间不能比endTime晚。 处理建议：请检查接口请求中的startTime是否晚于endTime。 400 123033 startTime can not be earlier than the now. startTime的时间不能比当前时间早。 处理建议：请检查接口请求中的startTime是否早于当前时间。 400 123034 endtime must be greater than 5 minutes. endtime要比startTime大5分钟。 处理建议：请检查接口请求中的startTime和endTime间隔时间必须大于5分钟。 403 1010009 app throttle exceed. 应用调用接口过于频繁，超过流控值（默认值是100次/60s）。 处理建议：联系 物联网平台 维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。 处理建议：请检查接口请求中所携带的accessToken是否有误。 404 123002 Device or package file not found. 设备或包不存在 处理建议：请检查接口请求中的fileId是否正确。

响应示例 返回状态码为200：创建成功的返回信息。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：创建成功的返回信息。 表10 PolicyConfigRes对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "error" data ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表11。 升级计划。 - 表11 UpgradePolicyDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" upgradeMode int32 [0-10] 0 设备升级模式，默认值为0。 0：按照设备型号升级 1：按照单设备升级 0 autoRemoveOld boolean true false true 设备空间不足以存放软件升级包时，升级过程自动清理空间，包含非系统启动大包、补丁和部分历史日志，默认值为true。 true autoSaveConfig int32 [0-1] 0 设备配置自动保存，默认值为0。 0：不保存 1：保存 0 downloadPolicyDto REFERENCE 详细请参见表12。 - - restartPolicyDto REFERENCE 详细请参见表13。 - - upPath ARRAY_REFERENCE 1-1000个列表项，详细请参见表14。 升级路径。 - 表12 DownloadPolicyDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 type string 0~256个字符。 immediately 下载策略，immediately（立即下载），weektime（周期下载）二者之一。 如果是立即下载场景，type填写immediately，其余字段不用填写； 如果是周期下载场景，type填写weektime，day，daytime和timeZoneOffSet会生效，默认值为immediately。 "weektime" timestamp string 0~13个字符。 - 特定时间升级时间戳。 "1647310956667" day string 0~256个字符。 - 如果配置周期下载，这里配置下载日期，格式为：monday、tuesday… "monday" daytime string 0~256个字符。 - 按周下载，配置下载时间，格式为hh:mm:ss。 "06:12:33" timeZoneOffSet string 0~256个字符。 - 时区，UTC+08:00。 "+08:00" 表13 RestartPolicyDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 type string 0~256个字符。 immediately 重启策略，immediately（立即重启），weektime（周期重启）二者之一。 如果是立即重启场景，type填写immediately； 如果是周期重启场景，type填写|weektime，day，dayTime和timeZoneOffSet会生效，默认值为immediately。 "weektime" day string 0~256个字符。 - 如果配置周期下载，这里配置下载日期，格式为：monday、tuesday… "monday" daytime string 0~256个字符。 - 按周重启，配置重启时间，格式为hh:mm:ss。 "06:12:33" timeZoneOffSet string 0~256个字符。 - 时区，UTC+08:00。 "+08:00" 表14 UpPath对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceModel string 0~256个字符。 - 设备款型。 "AR161FW" deviceId uuid 0~36个字符。 - 设备Id。 "sa15fdvg-4jet-4356-nas1-3bvf5e3324c1" targetSoftwareId uuid - - 目标软件版本ID。从/controller/campus/v1/oamservice/upgrade/version这个接口的返回的pkgList获取。targetSoftwareId和targetPatchId至少填一个。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359c1" targetPatchId uuid - - 目标补丁ID。从/controller/campus/v1/oamservice/upgrade/version这个接口的返回的pkgPatchMap获取。targetSoftwareId和targetPatchId至少填一个。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359c2" isUninstall int32 [0-1] 0 是否卸载旧补丁，默认值为0。 1：是 0：否 0 priority int32 [0-1024] - 设备升级优先级，顺序是从大到小开始升级。 0 status int32 [0-10] 0 升级状态。查询站点升级计划和详情时返回，默认值为0。 0：未创建升级任务 1：无需升级 2：升级成功 3：升级失败 4：下载完成 5：升级中 创建多站点升级计划时无需填写。 0 downloadPolicyOutput REFERENCE 详细请参见表15。 - - restartPolicyOutput REFERENCE 详细请参见表16。 - - upgradePolicyFeatureList ARRAY_REFERENCE 0-100个列表项，详细请参见表17。 特性包升级信息,V600及以后版本防火墙和交换机以及AR设备支持。 - 表15 DownloadPolicyOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 type string 0~256个字符。 - 该字段用来替代返回体中的DownloadPolicyDto，表示站点下具体款型的下载策略，返回体中的DownloadPolicyDto表示最新一次创建的站点下载策略，已废弃，请不要再使用，当前为了保证前项兼容保留。 下载策略，immediately（立即下载），datetime（特定时间下载），weektime（周期下载）三者之一。 "weektime" downloadTime string 0~256个字符。 - 本次下载时间，格式为yyyy-MM-dd HH:mm:ss。 "2021-07-10 15:35:00" nextDownloadTime string 0~256个字符。 - 下次下载时间，，当创建升级任务时DownloadPolicyDto中type字段为weektime时该字段才会生效，格式为yyyy-MM-dd HH:mm:ss。 "2021-07-17 15:35:00" downLoadTimeLength string 0~256个字符。 - 下载时长，只有特定时间下载，并指定下载时长，该字段才会生效，格式为hh:mm:ss。 "02:15:00" timeZoneOffSet string 0~256个字符。 - 服务器所在时区，UTC+08:00。 "+08:00" 表16 RestartPolicyOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 type string 0~256个字符。 - 该字段用来替代返回体中的RestartPolicyDto，表示站点下具体款型的重启策略，返回体中的RestartPolicyDto表示最新一次创建的站点重启策略，已废弃，请不要再使用，当前为了保证前项兼容保留。 重启策略，immediately（立即重启），weektime（周期重启）二者之一。 "weektime" restartTime string 0~256个字符。 - 本次重启时间，当创建升级任务时RestartPolicyDto中type字段为weektime时该字段才会生效，格式为yyyy-MM-dd HH:mm:ss。 "2021-07-10 16:35:00" nextRestartTime string 0~256个字符。 - 下次重启时间，当创建升级任务时RestartPolicyDto中type字段为weektime时该字段才会生效，格式为yyyy-MM-dd HH:mm:ss。 "2021-07-17 16:35:00" timeZoneOffSet string 0~256个字符。 - 服务器所在时区，UTC+08:00。 "+08:00" 表17 FeaturePath对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 featureFileId uuid 36个字符。 - 文件ID。 "57f879c7-7f6a-4d3a-88af-bf2585cb61e1" featureFileName string 0~256个字符。 - 特性包文件名称。 "Behavior-Control_6.23.0.1.270.ccx" featureName string 0~256个字符。 - 特性包名称。 "Behavior-Control" operateType integer [-1-2] - 操作类型-1:不升级，0：安装，1：升级，2：卸载。 -1 targetVersion string 0~128个字符。 - 目标版本。 "V600R023C00" 返回状态码为400：参数错误，创建失败。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/upgrade/policy 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 { "deviceUpgradePolicy" : [ { "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" } ] } ] } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyConfig 是 REFERENCE 详细请参见表2。 多站点升级计划。 - 表2 PolicyConfig对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceUpgradePolicy 是 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 站点升级计划。 - 表3 UpgradePolicyDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" upgradeMode 否 int32 [0-10] 0 设备升级模式，默认值为0。 0：按照设备型号升级 1：按照单设备升级 0 autoRemoveOld 否 boolean true false true 设备空间不足以存放软件升级包时，升级过程自动清理空间，包含非系统启动大包、补丁和部分历史日志，默认值为true。 true autoSaveConfig 否 int32 [0-1] 0 设备配置自动保存，默认值为0。 0：不保存 1：保存 0 downloadPolicyDto 是 REFERENCE 详细请参见表4。 - - restartPolicyDto 是 REFERENCE 详细请参见表5。 - - upPath 是 ARRAY_REFERENCE 1-1000个列表项，详细请参见表6。 升级路径。 - 表4 DownloadPolicyDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 type 否 string 0~256个字符。 immediately 下载策略，immediately（立即下载），weektime（周期下载）二者之一。 如果是立即下载场景，type填写immediately，其余字段不用填写； 如果是周期下载场景，type填写weektime，day，daytime和timeZoneOffSet会生效，默认值为immediately。 "weektime" timestamp 否 string 0~13个字符。 - 特定时间升级时间戳。 "1647310956667" day 否 string 0~256个字符。 - 如果配置周期下载，这里配置下载日期，格式为：monday、tuesday… "monday" daytime 否 string 0~256个字符。 - 按周下载，配置下载时间，格式为hh:mm:ss。 "06:12:33" timeZoneOffSet 否 string 0~256个字符。 - 时区，UTC+08:00。 "+08:00" 表5 RestartPolicyDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 type 否 string 0~256个字符。 immediately 重启策略，immediately（立即重启），weektime（周期重启）二者之一。 如果是立即重启场景，type填写immediately； 如果是周期重启场景，type填写|weektime，day，dayTime和timeZoneOffSet会生效，默认值为immediately。 "weektime" day 否 string 0~256个字符。 - 如果配置周期下载，这里配置下载日期，格式为：monday、tuesday… "monday" daytime 否 string 0~256个字符。 - 按周重启，配置重启时间，格式为hh:mm:ss。 "06:12:33" timeZoneOffSet 否 string 0~256个字符。 - 时区，UTC+08:00。 "+08:00" 表6 UpPath对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceModel 是 string 0~256个字符。 - 设备款型。 "AR161FW" deviceId 否 uuid 0~36个字符。 - 设备Id。 "sa15fdvg-4jet-4356-nas1-3bvf5e3324c1" targetSoftwareId 否 uuid - - 目标软件版本ID。从/controller/campus/v1/oamservice/upgrade/version这个接口的返回的pkgList获取。targetSoftwareId和targetPatchId至少填一个。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359c1" targetPatchId 否 uuid - - 目标补丁ID。从/controller/campus/v1/oamservice/upgrade/version这个接口的返回的pkgPatchMap获取。targetSoftwareId和targetPatchId至少填一个。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359c2" isUninstall 否 int32 [0-1] 0 是否卸载旧补丁，默认值为0。 1：是 0：否 0 priority 否 int32 [0-1024] - 设备升级优先级，顺序是从大到小开始升级。 0 status 否 int32 [0-10] 0 升级状态。查询站点升级计划和详情时返回，默认值为0。 0：未创建升级任务 1：无需升级 2：升级成功 3：升级失败 4：下载完成 5：升级中 创建多站点升级计划时无需填写。 0 downloadPolicyOutput 否 REFERENCE 详细请参见表7。 - - restartPolicyOutput 否 REFERENCE 详细请参见表8。 - - upgradePolicyFeatureList 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表9。 特性包升级信息,V600及以后版本防火墙和交换机以及AR设备支持。 - 表7 DownloadPolicyOutput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 type 否 string 0~256个字符。 - 该字段用来替代返回体中的DownloadPolicyDto，表示站点下具体款型的下载策略，返回体中的DownloadPolicyDto表示最新一次创建的站点下载策略，已废弃，请不要再使用，当前为了保证前项兼容保留。 下载策略，immediately（立即下载），datetime（特定时间下载），weektime（周期下载）三者之一。 "weektime" downloadTime 否 string 0~256个字符。 - 本次下载时间，格式为yyyy-MM-dd HH:mm:ss。 "2021-07-10 15:35:00" nextDownloadTime 否 string 0~256个字符。 - 下次下载时间，，当创建升级任务时DownloadPolicyDto中type字段为weektime时该字段才会生效，格式为yyyy-MM-dd HH:mm:ss。 "2021-07-17 15:35:00" downLoadTimeLength 否 string 0~256个字符。 - 下载时长，只有特定时间下载，并指定下载时长，该字段才会生效，格式为hh:mm:ss。 "02:15:00" timeZoneOffSet 否 string 0~256个字符。 - 服务器所在时区，UTC+08:00。 "+08:00" 表8 RestartPolicyOutput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 type 否 string 0~256个字符。 - 该字段用来替代返回体中的RestartPolicyDto，表示站点下具体款型的重启策略，返回体中的RestartPolicyDto表示最新一次创建的站点重启策略，已废弃，请不要再使用，当前为了保证前项兼容保留。 重启策略，immediately（立即重启），weektime（周期重启）二者之一。 "weektime" restartTime 否 string 0~256个字符。 - 本次重启时间，当创建升级任务时RestartPolicyDto中type字段为weektime时该字段才会生效，格式为yyyy-MM-dd HH:mm:ss。 "2021-07-10 16:35:00" nextRestartTime 否 string 0~256个字符。 - 下次重启时间，当创建升级任务时RestartPolicyDto中type字段为weektime时该字段才会生效，格式为yyyy-MM-dd HH:mm:ss。 "2021-07-17 16:35:00" timeZoneOffSet 否 string 0~256个字符。 - 服务器所在时区，UTC+08:00。 "+08:00" 表9 FeaturePath对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 featureFileId 否 uuid 36个字符。 - 文件ID。 "57f879c7-7f6a-4d3a-88af-bf2585cb61e1" featureFileName 否 string 0~256个字符。 - 特性包文件名称。 "Behavior-Control_6.23.0.1.270.ccx" featureName 否 string 0~256个字符。 - 特性包名称。 "Behavior-Control" operateType 否 integer [-1-2] - 操作类型-1:不升级，0：安装，1：升级，2：卸载。 -1 targetVersion 否 string 0~128个字符。 - 目标版本。 "V600R023C00"

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/upgrade/reupgrade 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 { "deviceIds" : [ "57f879c7-7f6a-4d3a-88af-bf2585cb61e0" ] }

响应示例 返回状态码为200：重新升级成功的返回值。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 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,16 Feb 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/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,16 Feb 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,16 Feb 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,16 Feb 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：删除成功的返回值。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policySiteCancelInputList 是 REFERENCE 详细请参见表2。 删除多站点升级计划入参。 - 表2 PolicySiteCancelInputList对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policySiteCancelInput 是 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 站点入参。 - 表3 PolicySiteInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" deviceModelList 是 ARRAY_REFERENCE 1-100个列表项，详细请参见表4。 设备款型。 - 表4 DeviceModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceModel 否 string 0~256个字符。 - 设备款型。 "AR161FW"

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/upgrade/policy/site/cancel 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 { "policySiteCancelInput" : [ { "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "deviceModelList" : [ { "deviceModel" : "AR161FW" } ] } ] }

响应示例 返回状态码为200：查询任务成功 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errorCode" : "0", "errorMsg" : "", "data" : { "upgradeDeviceList" : [ { "deviceId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "stackId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "deviceName" : "AP-4-5", "esn" : "21500829352SH1903543", "deviceStatus" : 0, "deviceModel" : "AP6050DN", "deviceType" : "AP", "curPkgVer" : "0", "curPatchVer" : "0", "suggestPkgVer" : "0", "suggestPatchVer" : "0", "suggestVerDescZh" : "0", "suggestVerDescEn" : "0", "pkgDownloadPercent" : 0, "patchDownloadPercent" : 0, "failureCause" : "The service is abnormal.", "upgradeTime" : "1647310956667", "upgradeStatus" : 0 } ], "totalSize" : "" } } 返回状态码为400：参数错误，查询失败。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive