华为云用户手册

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-cli:command-aliases/command-alias 表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"

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 command-alias 是 REFERENCE 详细请参见表4。 别名实例。 - 表4 command-aliases-exactProperties-command-alias-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-cli:command-alias 否 REFERENCE 详细请参见表5。 别名实例。 - 表5 command-alias-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 alias 是 string 1~63个字符。满足正则表达[a-zA-Z][a-zA-Z0-9-]*。 - 指定别名。必填，支持大、小写字母，数字及连字符"-"，字母开头，不区分大小写，字符间不能有空格。别名定义出现循环嵌套或嵌套层次超过16层时，该别名节点无效，不会用于进行字符串替换。单一主键字段。 "test1" command 否 string 1~511个字符。满足正则表达[^?]+。 - 指定别名命令行。必填，不支持英文问号，如果字符之间有空格，则字符串外必须使用双引号。指定别名参数配置后，必须在指定别名命令行里面包含进去。例如参数包含$a，则命令行格式应该为$a，"$a"，"xxx $a"，"xxx $a $xx"这样的形式。多个$参数必须连续保持在最后。 "test2" parameter 否 string 2~511个字符。 - 指定别名参数。支持大、小写字母，数字及连字符"-"，必须以"$"符号开头，不区分大小写，取值范围是2～63，最多支持32个参数，参数之间以空格进行分隔。指定别名命令行配置后，必须在指定别名参数里面定义。例如命令行格式为$a，"$a"，"xxx $a"，"xxx $a $xx"这样的形式，则指定别名参数必须包含$a。 "$test3"

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/qos-profiles 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 { "qosProfiles" : [ { "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：修改成功，响应体参考QosProfileResponse。 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", "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", "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 } } ] } 返回状态码为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/ospf/interface-param 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid - - VPN ID。格式是uuid，vpnId与tnpId只能填一个，两者都不填表示查询站点下所有underlay数据。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - TNP ID。格式是uuid，vpnId与tnpId只能填一个，两者都不填表示查询站点下所有underlay数据。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID。格式是uuid。 "a99f794e-b510-438c-a75d-de59f02347eb"

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/ospf/interface-param?vpnId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb 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：接口调用成功，响应体参考QueryOspfRouteInterfaceInfoResponse。 表2 QueryOspfRouteInterfaceInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-8个列表项，详细请参见表5。 OSPF路由接口信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考QueryOspfRouteInterfaceInfoResponse。 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "processId" : 501, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "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, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 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

响应示例 返回状态码为200：查询成功的信息，响应体参考MobileTerminalListDto。 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" : 10, "totalRecords" : 30, "data" : [ { "id" : "62008e2c-6bf2-48ea-a17c-d278c594d83a", "imsi" : "460030912121001", "imei" : "990000862471854", "msisdn" : "11111111111", "authorIpv4" : "192.168.10.1", "authorIpv6" : "FC00::1101/64", "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "isBlocked" : false, "description" : "Huawei phone" } ] } 返回状态码为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

响应参数 返回状态码为200：查询成功的信息，响应体参考MobileTerminalListDto。 表3 MobileTerminalListDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 - - 位于查询记录第几页。 1 pageSize int32 - - 一页里查询记录的数量。 10 totalRecords int32 - - 查询记录总条数。 30 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 终端详细信息列表。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/terminalmgr/mobile/endpoint/list 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" : 20, "imei" : "990000862471854", "imsi" : "460030912121001", "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "isBlocked" : false, "msisdn" : "11111111111", "authorIpv4" : "192.168.10.1", "authorIpv6" : "FC00::1101/64" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryParam 是 REFERENCE 详细请参见表2。 待查询终端的信息。 - 表2 MobileTerminalSelectDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [1-2147483647] 1 查询的页码。 1 pageSize 是 int32 [1-1000] 10 每页查询终端的数量。 20 imei 否 string 0~20个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端唯一标识，imei和imsi不填写时查询终端组下所有终端。。 "990000862471854" imsi 否 string 0~20个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 SIM卡唯一标识，该参数传值时，请填写10-20位数字。 "460030912121001" terminalGroupId 是 string 32~36个字符。 - 自定义终端组ID。uuid格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" isBlocked 否 boolean true false false 是否加入黑名单，处于黑名单的终端无法认证。默认值为false。 false msisdn 否 string 0~128个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端的msisdn，只能是数字或者以+开头的数字。 "11111111111" authorIpv4 否 string 0~20个字符。 - 终端ip，只支持IPv4地址。 "192.168.10.1" authorIpv6 否 string 0~128个字符。 - 终端IPv6地址，可以带前缀长度 "FC00::1101/64"

响应示例 返回状态码为200：返回200 OK 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：Invalid tag value { "errcode": "0", "errmsg": "success", "success": [], "fail": [ { "errcode": null, "errmsg": "device status is offline", "esn": "102190145576" } ] }

响应参数 返回状态码为200：返回200 OK 返回状态码为400：Invalid tag value 表4 LicenseActivateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~128个字符。 - 错误码： 当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 错误信息 "" success ARRAY_REFERENCE 0-300个列表项，详细请参见表5。 开始配置成功的设备的信息列表。 - fail ARRAY_REFERENCE 0-300个列表项，详细请参见表6。 开始配置成功失败的设备的信息列表。 - 表5 ActivateLicenseSuccessBean对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 esn string 10~256个字符。 - 设备ESN号。 "21500829350000009990" 表6 ActivateLicenseFailBean对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~128个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "esn or fileId is empty!" esn string 10~256个字符。 - 设备ESN号。 "21500829350000009990"

请求示例 HTTP的示例 POST /controller/campus/v3/device/license/action/activate 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 { "DevLicenseList" : [ { "esn" : "21500102392SG7900075", "fileId" : "fb8f0638-cd9b-4c12-b785-24e8225e8b3e" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 激活license请求体 - 表2 LicenseActivateRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 DevLicenseList 是 ARRAY_REFERENCE 1-1000个列表项，详细请参见表3。 激活license接口列表 - 表3 LicenseActivateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 esn 是 string 10~256个字符。 - 设备esn "21500102392SG7900075" fileId 是 string 0~36个字符。 - 文件ID "fb8f0638-cd9b-4c12-b785-24e8225e8b3e"

响应示例 返回状态码为200：站点切换组织成功，响应体参考BaseOrgOut。 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" : "" }

请求示例 HTTP的示例 PUT /controller/campus/api/v1/organization/path/sites 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 { "siteId" : "7dbda77a-2d6f-42b4-ba5a-1f9c6f84c1d5", "org" : "/org" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 switchOrgIn 是 REFERENCE 详细请参见表2。 站点切换组织入参。 - 表2 SwitchOrgPathIn对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 1~64个字符。 - 站点ID。 "7dbda77a-2d6f-42b4-ba5a-1f9c6f84c1d5" org 否 string 0~512个字符。 - 组织路径，为空表示从组织中移出 "/org"

响应示例 返回状态码为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" : "No Rights", "totalRecords" : 10, "data" : [ { "deviceId" : "936815c9-f7b3-48ab-bd1a-475cb8b1f092", "deviceName" : "Device_AP", "esn" : "2102353GSG10LA002185", "certFileName" : "ca.pem", "deviceModel" : "AP4050DN", "dueDate" : "2035-04-17 14:47:30", "status" : 0, "failureCause" : "No Rights" } ] } 返回状态码为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" : "0x00000003", "errMsg" : "No Rights" }

请求示例 HTTP的示例 POST /controller/campus/v2/certification/tasks/action/status-query 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, "siteId" : "595ffa80-3f6a-42b2-a79f-3e54dd8d121a", "keyword" : "DeviceName", "importTaskStatus" : [-1,0,1,2], "dueTimeBegin" : 1697457554059, "dueTimeEnd" : 1697457554059, "sortField" : "esn" }

响应参数 返回状态码为200：操作成功 表3 QueryImportTaskOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~64个字符。 - 错误码。 "0" errMsg string 0~256个字符。 - 错误信息。 "No Rights" totalRecords int32 [0-200000] - 任务总数 10 data ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 证书导入任务信息 - 表4 DeviceCertImportTaskDetail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 36个字符。 - 设备ID "936815c9-f7b3-48ab-bd1a-475cb8b1f092" deviceName string 0~64个字符。 - 设备名称 "Device_AP" esn string 0~64个字符。 - 设备ESN "2102353GSG10LA002185" certFileName string 0~64个字符。 - 证书文件名称 "ca.pem" deviceModel string 0~64个字符。 - 设备型号 "AP4050DN" dueDate string 0~36个字符。 - 过期时间(示例为UTC时间，格式YYYY-MM-DD HH:MM:SS) "2035-04-17 14:47:30" status int32 [-1-2] - 证书更新任务状态(-1：失败，0：成功，1：初始化，2：执行中） 0 failureCause string 0~256个字符。 - 失败原因 "No Rights" 返回状态码为400：查询异常 CommonErrDto对象的参数列表，详细请参见表3。

响应示例 返回状态码为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" : { "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,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/upgradeable-devices 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 32~36个字符。 - 站点ID "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" pageIndex 是 int32 [0-1000] - 当前页数 1 pageSize 是 int32 [1-300] - 分页大小 300

响应参数 返回状态码为200：查询任务成功 表2 QueryNeedUpgradeDeviceResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string 0~10个字符。 - 响应编码 "0" errorMsg string 0~256个字符。 - 响应信息 "" data REFERENCE 详细请参见表3。 查询结果 - 表3 NeedUpgradeDeviceData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 upgradeDeviceList ARRAY_REFERENCE 0-300个列表项，详细请参见表4。 查询结果 - totalSize int32 [0-1000] - 待升级的设备 - 表4 DeviceUpgradeStatusDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 0~36个字符。 - 设备ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" stackId string 0~36个字符。 - 堆叠ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" deviceName string 0~256个字符。 - 设备名称。 "AP-4-5" esn string 0~256个字符。 - 设备ESN。 "21500829352SH1903543" deviceStatus int32 [0-5] - 设备状态。 0：正常 1：告警 3：离线 4：未注册 0 deviceModel string 0~256个字符。 - 设备款型。 "AP6050DN" deviceType string 0~256个字符。 - 设备类型，取值为AP，AR，LSW，FW其中之一。 "AP" curPkgVer string 0~256个字符。 - 软件包版本。 "0" curPatchVer string 0~256个字符。 - 补丁版本。 "0" suggestPkgVer string 0~256个字符。 - 目标软件包版本。 "0" suggestPatchVer string 0~256个字符。 - 目标补丁版本。 "0" suggestVerDescZh string 0~256个字符。 - 目标软件版本的中文说明。 "0" suggestVerDescEn string 0~256个字符。 - 目标软件版本的英文说明。 "0" pkgDownloadPercent int32 [0-100] - 软件包下载进度。 0 patchDownloadPercent int32 [0-100] - 软件包下载进度。 0 failureCause string 0~256个字符。 - 失败原因。 "The service is abnormal." upgradeTime string 13~16个字符。 - 任务创建时间。 "1647310956667" upgradeStatus int32 [0-100] - 设备升级状态。 0 返回状态码为400：参数错误，查询失败。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /v1/upgrade/upgradeable-devices?siteId=ea25fdbf-8dee-4823-bac2-5bfe8e3359ca&pageIndex=1&pageSize=300 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 /controller/campus/v3/networkconfig/site-templates/fbb684c8-0d37-496f-bafa-4b06d5151e2e/devicemgrauth?isForceOverride=true 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 { "authType" : "default", "profileId" : "aeb684c8-0d37-496f-bafa-4b06d5151e2e", "cmdEnable" : true, "authProtocol" : "PAP", "authenticationEnable" : false, "authorizationEnable" : false, "accountingEnable" : false }

响应示例 返回状态码为200：修改站点模板的设备登录认证配置成功后的消息返回体。 { "errcode": "0", "errmsg": "", "data": { "authType": "tacacs", "profileId": "0aaf4ab3-3afd-4703-85cc-8e18c4fd05c1", "cmdEnable": false, "authProtocol": null, "authenticationEnable": true, "authorizationEnable": false, "accountingEnable": 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

URI /controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/devicemgrauth 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板ID, UUID格式，通过站点模板管理三方接口下的查询站点模板接口获取。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 isForceOverride 否 boolean true false - 是否强制覆盖。 true

请求参数 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表4。 设备登录认证配置。 - 表4 DeviceMgrAuthConfigs对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 authType 否 string default tacacs radius - 设备管理认证方式。取值范围：default---默认、tacacs---HWTACA CS 认证、radius---RADIUS认证。 "default" profileId 否 string 36个字符。 - 设备管理认证服务器模板ID。字符串为UUID格式。当authType为tacacs或radius时，profileId必填。 获取方式： 1.authType为tacacs时，profileId通过TACACS模板管理三方接口下的查询TACACS模板接口获取。 2.authType为radius时，profileId通过RADIUS模板管理三方接口下的查询RADIUS模板接口获取。 "aeb684c8-0d37-496f-bafa-4b06d5151e2e" cmdEnable 否 boolean true false false 命令行授权，当authType为tacacs时，cmdEnable必填。默认值为false。 true authProtocol 否 string PAP CHAP PAP 认证协议，当authType为radius时，authProtocol必填。默认值为PAP。 "PAP" authenticationEnable 否 boolean true false false 认证逃生使能。当authType为tacacs或radius时，authenticationEnable必填。默认值为false。 false authorizationEnable 否 boolean true false false 授权逃生使能。当authType为tacacs时，authorizationEnable必填。默认值为false。 false accountingEnable 否 boolean true false false 计费逃生使能。当authType为tacacs或radius时，accountingEnable必填。默认值为false。 false