设备基本信息管理-Netconf-华为云

华为乾坤-查询设备:响应示例

响应示例返回状态码为200：查询设备信息成功，响应体参考GetDeviceResponseBean。 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" : "success", "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 2, "data" : [ { "id" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "name" : "AR1", "esn" : "2102351BTJ0000000666", "deviceModel" : "AR161EW", "deviceType" : "AR", "status" : "0", "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "mac" : "xx-xx-xx-xx-xx-xx", "ip" : "192.168.0.10", "manageIp" : "192.168.0.10", "neType" : "AR161EW", "version" : "V300R003C00", "vendor" : "HUAWEI", "description" : "HUAWEI", "resourceId" : "HUAWEI", "tenantId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "tenantName" : "tenant@huawei.com", "siteName" : "test1", "createTime" : "2017-12-13 01:37:28", "registerTime" : "2017-12-13 01:37:28", "modifyTime" : "2017-12-13 01:37:28", "startupTime" : "2017-12-13 01:37:28", "tags" : ["AP01"], "systemIp" : "192.168.1.1", "patchVersion" : "V200R019SPH", "ztpConfirm" : false, "manageStatus" : "ABNORMAL", "manageStatusDownReason" : ["NEED_ZTP_CONFIRM","DEVICE_HAS_BEEN_ISOLATED"], "role" : ["Gateway"], "performance" : 0, "uptime" : "0 天 1 时 10 分" } ] } 返回状态码为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

华为乾坤设备基本信息管理-Netconf

华为乾坤-查询设备:请求示例

请求示例 HTTP的示例 GET /controller/campus/v3/devices?pageIndex=1&pageSize=20&neType=AP,AR&deviceType=AP,AR&siteId=ea25fdbf-8dee-4823-bac2-5bfe8e3359ca&sort=name&name=deviceName&preciseName=deviceName&esn=1002352CQW1910029317&mac=xx-xx-xx-xx-xx-xx&ip=192.168.1.1®isterTimeBegin=1598494534®isterTimeEnd=1598494534&createTimeBegin=1598494534&createTimeEnd=1598494534 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

华为乾坤设备基本信息管理-Netconf

华为乾坤-查询设备:接口约束

接口约束 1、该接口支持租户下北向管理员（用户角色为“Open Api Operator”）和msp下北向管理员（用户角色为“Open Api Operator”）访问，必须在用户会话建立后使用。 2、若pageSize和pageIndex参数不传或者为非法参数，则默认按照pageSize=1000，pageIndex=1返回查询结果。 3、在资产同步场景，ip、version为空时（即设备的IP和软件版本），设备资产不同步。

华为乾坤设备基本信息管理-Netconf

华为乾坤-查询设备:URI

URI /controller/campus/v3/devices 表1 query参数列表参数名称必选类型参数值域默认值参数说明参数示例 pageIndex 否 int32 [0-2147483647] 1 分页的序号。 1 pageSize 否 int32 [0-1000] 1000 分页的大小。 20 neType 否 string 0~128个字符。 - 设备类型，类型可以是'AR'，'AP'，'LSW'，'FW'，如果多个类型用逗号分隔（如：AR，AP）。不推荐使用，请尽量以deviceType为主。 "AP,AR" deviceType 否 string 0~128个字符。 - 设备类型，类型可以是'AR'，'AP'，'LSW'，'FW'，如果多个类型用逗号分隔（如：AR，AP）。如果跟neType同时出现，以deviceType为主。 "AP,AR" siteId 否 string 0~128个字符。 - 站点ID，查询单个站点下设备列表，为空查询所有设备。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" sort 否 string 0~128个字符。 - 排序字段，支持name，esn，deviceModel，deviceType，status，mac，ip，neType，version，description，createTime，registerTime，modifyTime。 "name" name 否 string 0~128个字符。 - 设备名称模糊查询，不支持正则。 "deviceName" preciseName 否 string 0~128个字符。 - 设备名称精确查询 "deviceName" esn 否 string 0~128个字符。 - 设备ESN精确查询。 "1002352CQW1910029317" mac 否 string 0~128个字符。 - 设备MAC地址精确查询。 "xx-xx-xx-xx-xx-xx" ip 否 string 0~128个字符。 - 设备IP地址精确查询。 "192.168.1.1" registerTimeBegin 否 int64 - - 注册时间查询范围起始值。 1598494534 registerTimeEnd 否 int64 - - 注册时间查询范围结束值。 1598494534 createTimeBegin 否 int64 - - 创建时间查询范围起始值。 1598494534 createTimeEnd 否 int64 - - 创建时间查询范围结束值。 1598494534

华为乾坤设备基本信息管理-Netconf

华为乾坤-修改设备:请求示例

请求示例 HTTP的示例 PUT /controller/campus/v3/devices/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 { "name" : "AR1", "description" : "AR", "resourceId" : "HUAWEI", "siteId" : "00000000-0000-0000-0000-000000000001", "esn" : "2102351BTJ0000000666", "tags" : ["AP01"], "systemIp" : "192.168.1.1", "ztpConfirm" : true, "role" : ["Gateway"], "performance" : 0 }

华为乾坤设备基本信息管理-Netconf

华为乾坤-修改设备:响应示例

响应示例返回状态码为200：修改设备基本信息成功，响应体参考ModifyDeviceBean。 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" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000001", "name" : "AR1", "description" : "AR", "resourceId" : "HUAWEI", "siteId" : "00000000-0000-0000-0000-000000000001", "esn" : "2102351BTJ0000000666", "tags" : ["AP01"], "systemIp" : "192.168.1.1", "ztpConfirm" : true, "role" : ["Gateway"] } } 返回状态码为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

华为乾坤设备基本信息管理-Netconf

华为乾坤-恢复开局配置:响应示例

响应示例返回状态码为200：恢复开局配置成功，响应体参考ResetDeployResultDto。 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" : "", "successList" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "esn" : "AP05ZXV1230123456789", "name" : "LSW01", "result" : "LSW01" } ], "failList" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "00000000-0000-0000-0000-000000000000", "esn" : "AP05ZXV1230123456789", "name" : "LSW01", "result" : "LSW01" } ] } 返回状态码为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

华为乾坤设备基本信息管理-Netconf

华为乾坤-恢复开局配置:请求示例

请求示例 HTTP的示例 POST /controller/campus/v3/deploy/reset 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 { "deviceIdList" : [ "00000000-0000-0000-0000-000000000001" ] }

华为乾坤设备基本信息管理-Netconf

华为乾坤-恢复开局配置:响应参数

响应参数返回状态码为200：恢复开局配置成功，响应体参考ResetDeployResultDto。表3 ResetDeployResultDto对象的参数列表参数名称类型参数值域默认值参数说明参数示例 errcode string - - 错误码 "0" errmsg string - - 错误信息 "" successList ARRAY_REFERENCE 0-10000个列表项，详细请参见表4。成功时返回的集合 - failList ARRAY_REFERENCE 0-10000个列表项，详细请参见表5。失败时返回的集合 - 表4 DeviceObj对象的参数列表参数名称类型参数值域默认值参数说明参数示例 deviceId string - - 设备ID "00000000-0000-0000-0000-000000000000" esn string - - 设备ESN 该字段对应UI页面上是：UI【ESN】 "AP05ZXV1230123456789" name string - - 设备名称该字段对应UI页面上是：UI【名称】 "LSW01" result string - - 结果展示，失败时显示失败原因 "LSW01" 表5 FailDeviceObj对象的参数列表参数名称类型参数值域默认值参数说明参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" deviceId string - - 设备ID "00000000-0000-0000-0000-000000000000" esn string - - 设备ESN 该字段对应UI页面上是：UI【ESN】 "AP05ZXV1230123456789" name string - - 设备名称该字段对应UI页面上是：UI【名称】 "LSW01" result string - - 结果展示，失败时显示失败原因 "LSW01" 返回状态码为500：恢复开局配置内部错误，无返回体。详细信息请参见实际响应消息体。

华为乾坤设备基本信息管理-Netconf

华为乾坤-删除设备:响应示例

响应示例返回状态码为200：删除设备成功，响应体参考DeleteDeviceBean。 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" : "", "success" : ["00000000-0000-0000-0000-000000000001"], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : "00000000-0000-0000-0000-000000000001" } ] } 返回状态码为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

华为乾坤设备基本信息管理-Netconf

华为乾坤-删除设备:请求示例

请求示例 HTTP的示例 DELETE /controller/campus/v3/devices 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" : ["00000000-0000-0000-0000-000000000001"], "reset" : "true" }

华为乾坤设备基本信息管理-Netconf

华为乾坤-替换设备款型:请求参数

请求参数表1 body参数列表参数名称必选类型参数值域默认值参数说明参数示例 replaceOriginalDeviceDto 是 REFERENCE 详细请参见表2。设备替换入参模型。 - 表2 ReplaceOriginalDeviceDto对象的参数列表参数名称必选类型参数值域默认值参数说明参数示例 originalDeviceId 是 UUID 0~64个字符。 - 待替换设备的ID。 "00000000-0000-0000-0000-000000000001" newEsn 是 string 0~64个字符。 - 该字段必填。newEsn字段合法则替换原有esn，newEsn字段不合法将originalDeviceId对应的设备esn置空。 "2102351BTJ0000000666" newDeviceModel 否 string 0~64个字符。 - 替换设备的新款型，替换前后设备款型必须一致(交换机除外)，对于交换机需要设备的款型为同一系列下的设备款型。 "S8700-6"

华为乾坤设备基本信息管理-Netconf

华为乾坤-替换设备款型:响应示例

响应示例返回状态码为200：设备替换成功，响应体参考CommonResponseBean。 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

华为乾坤设备基本信息管理-Netconf

华为乾坤-替换设备款型:请求示例

请求示例 HTTP的示例 POST /controller/campus/v3/devices/replacement 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 { "originalDeviceId" : "00000000-0000-0000-0000-000000000001", "newEsn" : "2102351BTJ0000000666", "newDeviceModel" : "S8700-6" }

华为乾坤设备基本信息管理-Netconf

华为乾坤-替换设备:请求示例

请求示例 HTTP的示例 POST /controller/campus/v3/devices/replace 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 { "originalDeviceId" : "00000000-0000-0000-0000-000000000001", "replaceDeviceId" : "00000000-0000-0000-0000-000000000002" }

华为乾坤设备基本信息管理-Netconf

云服务器内容精选

设备基本信息管理-Netconf

7*24

备案

专业服务

退订

建议反馈

售前咨询热线