云服务器内容精选

  • 响应示例 返回状态码为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
  • 请求示例 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" } ] } ] } ] }
  • 响应参数 返回状态码为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:内部服务器错误。 详细信息请参见实际响应消息体。
  • 请求参数 表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"
  • 响应示例 返回状态码为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" : [ { "deviceId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "deviceName" : "AP-4-5", "esn" : "21500829352SH1903543", "deviceStatus" : 0, "deviceModel" : "AR6120", "deviceType" : "AP", "siteName" : "test", "pkgVer" : "0", "pkgPercent" : 70, "pkgUpStatus" : 0, "patVer" : "V200R020C00SPC001", "patPercent" : 70, "patUpStatus" : 0, "failureCause" : "设备异常.", "rebootTime" : 1637800000, "downloadTime" : 1637800000, "featureUpgradeList" : [ { "name" : "Behavior-Control", "targetVersion" : "V600R022C10", "downloadProcess" : 0, "upgradeStatus" : 0, "failReason" : "下载失败。" } ] } ] } 返回状态码为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-detail/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceModel 否 string - - 设备款型。 如果不填就是站点下所有设备。 如果填写了设备款型,只对该站点下改款型设备升级。 "AR161FW"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/upgrade/policy-detail/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:查询成功的返回信息。 表3 DeviceDetailListRes对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "error" data ARRAY_REFERENCE 1-100个列表项,详细请参见表4。 具体设备升级状态。 - 表4 UpgradeDetail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId uuid - - 设备ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" deviceName string 0~256个字符。 - 设备名称。 "AP-4-5" esn string 0~256个字符。 - 设备ESN。 "21500829352SH1903543" deviceStatus int32 [0-10] - 设备状态。 0:正常 1:告警 3:离线 4:未注册 0 deviceModel string 0~256个字符。 - 设备款型。 "AR6120" deviceType string 0~256个字符。 - 设备类型,取值为AP,AR,LSW,FW其中之一。 "AP" siteName string 0~256个字符。 - 站点名称。 "test" pkgVer string 0~256个字符。 - 软件包版本。 "0" pkgPercent int32 [0-100] - 软件包下载进度。 70 pkgUpStatus int32 [0-100] - 大包升级状态。 0:已创建升级任务,未升级 1:正在下载 2:已下载 5:升级完成 6:无需升级 8:升级失败 9:等待重启上线 10:正在激活大包 11:激活完成 16:取消升级成功 17:取消升级失败 18:下载停止 40:配置保存中 41:配置保存完成 0 patVer string 0~256个字符。 - 补丁版本。 "V200R020C00SPC001" patPercent int32 [0-100] - 补丁下载进度。 70 patUpStatus int32 [0-100] - 补丁升级状态。 0:已创建升级任务,未升级 1:正在下载 2:已下载 5:升级完成 6:无需升级 8:升级失败 9:等待重启上线 12:正在补丁操作 13:补丁操作完成 16:取消升级成功 17:取消升级失败 18:下载停止 40:配置保存中 41:配置保存完成 0 failureCause string 0~256个字符。 - 失败原因。 "设备异常." rebootTime int64 [0-4102416000] - 重启时间。UTC时间。 1637800000 downloadTime int64 [0-4102416000] - 下载时间。UTC时间。 1637800000 featureUpgradeList ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 设备所有特性包升级详细信息。 - 表5 FeatureUpgradeDetail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~64个字符。 - 特性名称。 "Behavior-Control" targetVersion string 1~64个字符。 - 特性版本。 "V600R022C10" downloadProcess int32 [0-100] - 特性包下载进度。 0 upgradeStatus int32 [0-20] - 特性包升级状态。 0 failReason string 1~256个字符。 - 失败原因 "下载失败。" 返回状态码为400:参数错误,查询失败。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务器错误。 详细信息请参见实际响应消息体。
  • 响应参数 返回状态码为200:查询任务成功 表2 QueryDevicesUpgradeStatusResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string 0~10个字符。 - 响应编码 "0" errorMsg string 0~256个字符。 - 响应信息 "" data REFERENCE 详细请参见表3。 查询结果 - 表3 DevicesUpgradeStatusData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceUpgradeStatusDtoList ARRAY_REFERENCE 0-300个列表项,详细请参见表4。 查询结果 - totalSize int32 [0-1000] - 待升级的设备 1 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务器错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /v1/upgrade/upgrade-details?siteId=ea25fdbf-8dee-4823-bac2-5bfe8e3359ca&pageIndex=1&pageSize=300&keyword=21500829352SH1903543 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 { "errorCode" : "0", "errorMsg" : "", "data" : { "deviceUpgradeStatusDtoList" : [ { "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" : 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
  • URI /v1/upgrade/upgrade-details 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 32~36个字符。 - 站点ID "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" pageIndex 是 int32 [0-1000] - 当前页数 1 pageSize 是 int32 [1-300] - 分页大小 300 keyword 否 string 0~256个字符。 - 匹配字段:设备ESN,设备名称。 "21500829352SH1903543"
  • 响应示例 返回状态码为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" : "" } 返回状态码为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/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" ] }
  • 请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/upgrade/version?deviceModel=AP6050DN 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
提示

您即将访问非华为云网站,请注意账号财产安全