华为云用户手册

响应示例 返回状态码为200：查询成功，响应体参考QueryDevicesOutputDto。 HTTPS 200 OK Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "data": [ { "devIsBound": false, "id": "d3e43f5a-a654-4ec9-a2bc-34abb43ffa75", "name": "devcie01", "esn": "1019A0055991", "deviceModel": "LSW", "deviceRole": "ACC", "manageType": 0, "siteId": "104d216d-99f9-62ff-f7fa-f1e50024d8d5", "siteName": "site01", "mac"："11-11-11-11-11" } ] } 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 HTTPS 400 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80014", "errmsg":"data not exist", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" } 返回状态码为500：内部错误，响应体参考CommonErrorDto。 HTTPS 500 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80018", "errmsg":"internal error", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" }

响应参数 返回状态码为200：查询成功，响应体参考QueryDevicesOutputDto。 表3 QueryDevicesOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~20个字符。 - 状态码，0：请求成功。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "" data ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 查询的设备信息。 - 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。

请求示例 HTTP的示例 post /controller/campus/api/v1/terminal/scanrule/devices/action/batch-query HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "deviceIds": ['f0039bfc-5cf0-1f24-2865-86016a8a83c0', 'e555c570-2247-a16e-03e4-033e142474da'] }

响应参数 返回状态码为200：导入文件结果 表3 NorthUploadCfgResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 导入文件结果错误码，成功0，失败1 "0" addFileInfoResultDto REFERENCE 详细请参见表4。 结果对象 - 表4 NorthCfgOperateResultModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 result string - - 导入文件结果 "20200109111354R.cfg: Upload Success"

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 data 是 REFERENCE 详细请参见表2。 导入文件数据 - 表2 NorthCfgFileImportModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 file 是 file - - 文件 "/opt/20200109111354R.cfg" fileName 是 string 0~64个字符。 - 文件名称 "20200109111354R.cfg" displayName 是 string 0~64个字符。 - 文件显示名称 "20200109111354R.cfg" type 是 int32 - - 文件类型，配置文件为21 21 size 是 int32 - - 文件大小，单位Byte 4247 localFilePath 否 string 0~1000个字符。 - 文件上传时的本地路径 "filepath" desc 否 string 0~255个字符。 - 文件描述 "string" Md5 是 string - - 文件的Hash值 "616BF378ACDD6ABF31EBCB06CE02B8D5" pieceEnable 否 boolean true false false 文件分段，配置文件为False false

请求示例 cURL的示例 curl -k -s -L -i -X POST -H 'Content-Type: multipart/form-data' -H 'Accept: multipart/form-data' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/openapi/conffilemgmtservice/v1/file/upload' -d '{ "file" : "/opt/20200109111354R.cfg", "fileName" : "20200109111354R.cfg", "displayName" : "20200109111354R.cfg", "type" : 21, "size" : 4247, "localFilePath" : "filepath", "desc" : "string", "Md5" : "616BF378ACDD6ABF31EBCB06CE02B8D5", "pieceEnable" : false }' HTTP的示例 POST /openapi/conffilemgmtservice/v1/file/upload HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: multipart/form-data Accept: multipart/form-data Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "file" : "/opt/20200109111354R.cfg", "fileName" : "20200109111354R.cfg", "displayName" : "20200109111354R.cfg", "type" : 21, "size" : 4247, "localFilePath" : "filepath", "desc" : "string", "Md5" : "616BF378ACDD6ABF31EBCB06CE02B8D5", "pieceEnable" : false }

响应示例 返回状态码为200：机框资源查询成功。 HTTP/1.1 200 OK Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "code" : 0, "data" : [ { "neDN" : "047f72d1-7ad3-11e9-b906-000c29b01448", "neName" : "FW_B", "frameDN" : "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1", "shelfIndex" : -1, "frameIndex" : 67108867, "frameNo" : 1, "vendorType" : ".1.3.6.1.4.1.2011.20021210.11.16715812", "mfgName" : "Huawei", "serialNum" : "020LKTD0A9000233", "physicalClass" : 3, "descr" : "Eudemon1000E-N6", "frameName" : "Eudemon1000E-N6", "adminStatus" : 4, "operStatus" : 3, "standBystatus" : 1, "softVersion" : "V500R001C80SPC100" } ], "description" : "查询成功。" } 返回状态码为400：参数错误。 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404：rest接口没找到。 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：默认ServiceException异常码，应用内部错误。 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/rest/openapi/network/frame?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&nename=FW_B&framedn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1&shelfindex=-1&frameindex=67108867&frameno=1&vendortype=.1.3.6.1.4.1.2011.20021210.11.16715812&mfgname=Huawei&serialnum=020LKTD0A9000233&physicalclass=3&descr=Eudemon1000E-N6&framename=Eudemon1000E-N6&adminstatus=4&operstatus=3&standbystatus=1&softversion=V500R001C80SPC100&start=0&size=20&orderby=nedn&desc=true' HTTP的示例 GET /rest/openapi/network/frame?nedn=047f72d1-7ad3-11e9-b906-000c29b01448&nename=FW_B&framedn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1&shelfindex=-1&frameindex=67108867&frameno=1&vendortype=.1.3.6.1.4.1.2011.20021210.11.16715812&mfgname=Huawei&serialnum=020LKTD0A9000233&physicalclass=3&descr=Eudemon1000E-N6&framename=Eudemon1000E-N6&adminstatus=4&operstatus=3&standbystatus=1&softversion=V500R001C80SPC100&start=0&size=20&orderby=nedn&desc=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-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan

响应参数 返回状态码为200：机框资源查询成功。 表2 FrameResResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - 0 操作返回码。可以是如下值之一： 0：成功 非0：失败 0 data ARRAY_REFERENCE 详细请参见表3。 - - description string - - 描述信息。 "查询成功。" 表3 FrameResData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 neDN string - - 设备dn。 "047f72d1-7ad3-11e9-b906-000c29b01448" neName string - - 网元名称。 "FW_B" frameDN string - - 机框dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1" shelfIndex int32 - - 机架索引，所有资源的根索引。 -1 frameIndex int32 - - 机框索引。 67108867 frameNo int32 - - 机框序号。 1 vendorType string - - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.11.16715812" mfgName string - - 物理固件的制造厂商。 "Huawei" serialNum string - - 序列号。 "020LKTD0A9000233" physicalClass int32 - - 设备上实体大类型： 3：框 4：背板 5：子槽 6：电源 7：风扇 9：板 10：端口 3 descr string - - 机框描述。 "Eudemon1000E-N6" frameName string - - 机框名称。 "Eudemon1000E-N6" adminStatus int32 - - 管理状态，可以是如下值之一： 4、11：正常 2、3、12：错误 13：LoopBack 其他：未知 4 operStatus int32 - - 操作状态，可以是如下值之一： 3、11、13、15、16：正常 2、12、17：错误 4：离线 其他：未知 3 standBystatus int32 - - 主备状态： 1：notSupported 2：hotStandby 3：coldStandby 4：providingService 1 softVersion string - - 软件版本。 "V500R001C80SPC100" 返回状态码为400：参数错误。 详细信息请参见实际响应消息体。 返回状态码为404：rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为500：默认ServiceException异常码，应用内部错误。 详细信息请参见实际响应消息体。

URI /rest/openapi/network/frame 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nedn 否 string 1~100个字符。 - 设备dn。 "047f72d1-7ad3-11e9-b906-000c29b01448" nename 否 string 1~100个字符。 - 网元名称。 "FW_B" framedn 否 string 1~100个字符。 - 机框Dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1" shelfindex 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 机架索引，所有资源的根索引。 -1 frameindex 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 机框索引。 67108867 frameno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 机框序号。 1 vendortype 否 string 1~100个字符。 - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.11.16715812" mfgname 否 string 1~100个字符。 - 物理固件的制造厂商。 "Huawei" serialnum 否 string 1~100个字符。 - 序列号。 "020LKTD0A9000233" physicalclass 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 设备上实体大类型： 3：框 4：背板 5：子槽 6：电源 7：风扇 9：板 10：端口 3 descr 否 string 1~100个字符。 - 机框描述。 "Eudemon1000E-N6" framename 否 string 1~100个字符。 - 机框名称 "Eudemon1000E-N6" adminstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 管理状态，可以是如下值之一： 4、11：正常 2、3、12：错误 13：LoopBack 其他：未知 4 operstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 操作状态，可以是如下值之一： 3、11、13、15、16：正常 2、12、17：错误 4：离线 其他：未知 3 standbystatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 主备状态： 1：notSupported 2：hotStandby 3：coldStandby 4：providingService 1 softversion 否 string 1~100个字符。 - 软件版本。 "V500R001C80SPC100" start 否 integer - 0 指定从哪个起始记录位置开始返回查询结果集。缺省值是0。说明，如果值小于0，将使用缺省值。 0 size 否 integer - 20 指定返回查询结果集总数。缺省值是20。说明，如果值小于0，将使用缺省值。 20 orderby 否 string - nedn 指定查询结果集采用的排序字段。缺省排序字段是nedn。可指定的排序字段包括：nedn、nename、framedn、framename（机框名称）。 说明： 使用“start”和“size”参数进行分页查询时，必须指定“orderby”参数为“framedn” "nedn" desc 否 boolean - false 指定查询结果是否按降序排序。缺省值是false。说明，此请求参数只有指定了“orderby”请求参数后才有效。 true

响应示例 返回状态码为200：Successful operation HTTP/1.1 200 OK Date: Fri,03 Dec 2021 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "huawei-nce-aoc-config-template:output": { "children-templates": [ { "template-id": "4cb280c4-fd5c-471c-9b71-a7ff205484a5", "template-name": "江苏省", "parent-template-name": "中国区" }, { "template-id": "eb6bf0c7-cf68-489b-a6d4-2a33947c2249", "template-name": "南京市", "parent-template-name": "江苏省" }, { "template-id": "301a5e9e-813e-4b9f-a92a-e6a83d51a5fd", "template-name": "Zhejiang Province", "parent-template-name": "中国区" }, { "template-id": "fadebbff-d0c9-4916-85e7-d0fe314d47af", "template-name": "Hangzhou City", "parent-template-name": "Zhejiang Province" } ] } } 返回状态码为400：Bad Request HTTP/1.1 400 Bad Request Date: Thu,05 Jan 2023 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 query-children-templates-by-id 是 REFERENCE 详细请参见表2。 查询子孙模板 - 表2 query-children-templates-by-id-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:input REFERENCE 详细请参见表3。 - - 表3 query-children-templates-by-id-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-id 否 string 1~128个字节。 - 模板ID 参数template-id与template-name必须选择其一写入请求参数中，且不能同时存在。 "26559bd3-a00e-4c6d-a573-e6b711a897b2" template-name 否 string 0~128个字节。 - 模板名称 参数template-id与template-name必须选择其一写入请求参数中，且不能同时存在。 "test"

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template:query-children-templates-by-id Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-nce-aoc-config-template:input": { "template-name":"中国区" // 或 "template-id":"b8308c56-9ea7-49e8-b0fd-9d886b4fddd2" } }

响应参数 返回状态码为200：Successful operation 表4 query-children-templates-by-id-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:output REFERENCE 详细请参见表5。 - - 表5 query-children-templates-by-id-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 children-templates ARRAY_REFERENCE 详细请参见表6。 子孙模板 - 表6 query-children-templates-by-id-output-body-children-templates对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-id string 0~128个字节。 - 模板ID "26559bd3-a00e-4c6d-a573-e6b711a897b2" template-name string 0~128个字节。 - 模板名称 "test" template-description string 0~max个字节。 - 模板描述 "test" parent-template-name string 0~128个字节。 - 模板名称 "test-parent" 返回状态码为400：Bad Request 详细信息请参见实际响应消息体。

响应参数 返回状态码为204：删除成功。 返回状态码为40X：参数不正确。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。 表2 错误码描述 Status Code Error Code Error Message Parameter 错误说明 400 0x006e004b 解析请求体发生错误。 错误的参数字段。 请求体body存在错误。 409 0x00c80014 设备组{0}不存在。 {0}：设备组名。 删除的设备组不存在。 500 0x00c80006 操作数据库异常。 - 系统内部错误，操作数据库存在异常。

响应示例 HTTP/1.1 204 No Content Server: product only Date: Tue, 19 Nov 2019 21:38:43 GMT Connection: keep-alive Keep-Alive: timeout=60 X-Frame-Options: DENY Strict-Transport-Security: max-age=31536000;incodeSubDomains Cache-Control: no-cache, no-store, must-revalidate X-Content-Type-Options: nosniff Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT X-XSS-Protection: 1; mode=block

请求示例 cURL示例 curl -k -s -L -i -X DELETE \ https://{ip:port}/restconf/data/device-shell-group-northbound:device-shell-group/device-group/cccc2 \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -H 'x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9' HTTP示例 DELETE /restconf/data/device-shell-group-northbound:device-shell-group/device-group/cccc2 HTTP/1.1 Host: {ip:port} Content-Type: application/json x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9 Cache-Control: no-cache

响应参数 返回状态码为200：查询成功，响应体参考QueryPageInfoOutputDto。 表2 QueryPageInfoOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表3。 Portal定制页面信息列表。 - 表3 PortalPageInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - Portal定制页面id，UUID格式 "68b5bc98ed4340dfb586faa161803c56" pageName string 1~128个字符。 - Portal定制页面名称 "page" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QueryPageInfoOutputDto。 HTTP/1.1 200 OK Date: Tue,31 Dec 2024 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" : "68b5bc98ed4340dfb586faa161803c56", "pageName" : "page" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Tue,31 Dec 2024 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: Tue,31 Dec 2024 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /controller/campus/v2/accountservice/portalpage/page?pageName=pageName 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的示例 get /controller/campus/api/v1/terminal/scanrule/scanrules?filter=sortField::+name|keyword::rule&page=pageIndex::1|pageSize::10 HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925

响应参数 返回状态码为200：扫描成功，响应体参考ScanRuleGetOutputDto。 表2 ScanRuleGetOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [0-100] - 当前页码。 1 pageSize int32 [0-100] - 分页大小。 10 totalSize int32 [0-100] - 当前租户下扫描规则总数目。 100 errcode string 0~12个字符。 - 错误码 - errmsg string 0~256个字符。 - 错误信息 - data ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 扫描规则列表 - 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。

响应示例 返回状态码为200：扫描成功，响应体参考ScanRuleGetOutputDto。 HTTPS 200 OK Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "pageIndex": 1, "pageSize": 10, "totalSize": 1, "errcode": "0", "errmsg": "", "data": [ { "id": "f0039bfc-5cf0-1f24-2865-86016a8a83c0", "name": "scanRule", "description": "scanRule", "scanType": [ "Real-time","Periodic" ], "scanPeriod": 30, "scanRangeList": [ { "id": "e555c570-2247-a16e-03e4-033e142474da", "sourceIp": "xxx", "vlanId": 1234, "scanIp": "xxx", "mask": 24, "description": "scanRange" } ], "vendors": [ "huawei","hikvision","dahua","uniview","tplink" ], "categories": "ip-camera" } ] } 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 HTTPS 400 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80014", "errmsg":"data not exist", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" } 返回状态码为500：内部错误，响应体参考CommonErrorDto。 HTTPS 500 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80018", "errmsg":"internal error", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" }

URI /controller/campus/api/campusaccesscfgservice/v1/terminal/scanrule/query-scan-rules 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 filter 否 string 0~200个字符。 - 查询条件。 "sortField::+name|keyword::rule" page 否 string 0~32个字符。 - 分页。 "pageIndex::1|pageSize::10"

请求示例 HTTP的示例 PUT /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-application-id}/device/{device-id}/template/{template-id}/variable/{variable-name} Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "variable":[ { "variable-name": "v2c", "variable-value":"valuex" } ] }

响应示例 返回状态码为204：Successful operation HTTP/1.1 204 No Content Date: Fri,30 Dec 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：Internal Error HTTP/1.1 400 Bad Request Date: Fri,30 Dec 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-application-id}/device/{device-id}/template/{template-id}/variable/{variable-name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-application-id 是 string 0~128个字节。 - the identifier of the template application. "a945675d-ccff-4ea3-afb4-8d04ac3100c2" device-id 是 string 0~128个字节。 - the identifier of the device. "8d394835-cb84-38f3-a4d5-36a7f2074b49" template-id 是 string 1~128个字节。 - the identifier of the template. "a926f75d-ccff-4ea3-afb4-8d04ac3100c2" variable-name 是 string 1~512个字节。 - name of the variable. "aoc-variable-name"

参数说明 表1 “策略模板”（URL模板） 参数名称 说明 名称 用于唯一标识URL模板。 模板类型 “云平台中继认证”和“第三方认证”可供选择。 模板参数 赋值方式 范围： 替换控制器已有值：选择iMaster NCE-Campus已有参数。 用户自定义：用户自定义参数值。 约束和限制：赋值方式仅“云平台中继认证”类型有效。 参数内容 指定在URL中携带的模板参数信息。 模板类型不同，支持定义的模板参数也不同。各参数详细说明以及填写要求请参见表2。 参数名称 第三方portal服务器认证所需参数名称。 MAC地址格式设置（仅“模板类型”选择为“云平台中继认证”可配置） 默认不开启，开启后可设置“模板参数”中的“参数内容”为ap-mac、device-mac、user-mac参数的MAC地址格式。 开关开启时支持的设置的格式包含： MAC地址大小写：“大写”，“小写”。 MAC地址连接符：“横杠（-）”，“点（.）”，“冒号（：）”，“无连接符”。 MAC地址格式：“XXXX-XXXX-XXXX”，“XX-XX-XX-XX-XX-XX”。 URL参数加密（仅“模板类型”选择为“云平台中继认证”可配置） URL参数名称 为了传输数据的安全，希望Portal服务器和控制器之间传递的URL参数能够经过加密处理时，可通过使能此开关实现。 开启后URL参数会整体加密，仅支持AES-CBC算法。 密钥 三方认证系统和iMaster NCE-Campus对接时，该系统使用的对接密钥和密钥向量。 密钥IV向量 表2 模板参数 模板类型 参数 参数说明 取值 云平台中继认证 device-mac 指定在URL中携带认证设备的MAC地址。 取值为1~64位字母、短线、数字或下划线，不能以数字开头。 redirect-url 指定在URL中携带用户重定向前访问的原始URL。 ssid 指定在URL中携带用户关联的SSID名称。 user-ip 指定在URL中携带接入用户的IP地址。 user-mac 指定在URL中携带接入用户的MAC地址。 loginurl 指定在URL中携带iMaster NCE-Campus提供的用户认证的URL。 ap-location 指定在URL中携带AP的位置信息。 fitap-mac 指定在URL中携带WAC+FitAP认证场景下，FitAP的MAC地址信息。 sync-login-url 指定在URL中携带三方Portal服务器回调的认证同步接口信息。 sync-login-http-url 指定在URL中携带三方Portal服务器回调的认证同步HTTP接口信息。 site-code 指定在URL中携带站点认证码信息。 device-type 指定在URL中携带认证设备的设备类型信息。 site-name 指定在URL中携带站点名称信息。 第三方认证 ap-ip AP的IP地址。 取值为1~16位的半角字符，不能包含空格。 device-ip 认证设备的IP地址，对于普通云AP，需要使用ap-ip参数。 ap-mac AP的MAC地址。 redirect-url 用户重定向前访问的原始URL。 ssid 用户关联的SSID名称。 sysname 认证设备的系统名称。 user-ip 用户的IP地址。 user-mac 用户的MAC地址。 device-mac 认证设备的MAC地址，对于普通云AP，需要使用ap-mac参数。 interface 用户接入的设备接口。 esn 认证设备的ESN。 ap-location AP的位置信息。 login-url 认证设备的登录URL。其中： url-key：重定向时携带给Portal服务器登录URL的识别关键字。 url：接入设备上指定的URL。 说明： 中心AP不支持此参数。 “login-url”有两个值需要填充，url-key和url之间需要用空格隔开。例如：XX Y。 url-key：重定向时携带给Portal服务器登录URL的识别关键字。字符串形式，不支持空格、问号、和号和等于号，区分大小写，长度范围是1～16。 url：接入设备上指定的URL。字符串形式，不支持空格，区分大小写，长度范围是1～247。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 modifyIfBody 是 REFERENCE 详细请参见表2。 设备接口描述信息修改参数模型 - 表2 ApiModifyIfData对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nedn 是 string 0~255个字符。 - 设备dn。 说明：添加设备时分配的唯一标识 "00000000-0000-0000-0000-000000000000" interfaceId 否 string 1~255个字符。 - 接口id。 说明：接口添加时分配的唯一标识。 "00000000-0000-0000-0000-000000000000" ifIndex 否 integer [1-65535] - 接口索引。 说明：从设备上获取。 7 ifDesc 是 string 1~255个字符。 - 接口名称。 说明：从设备上获取。 GigabitEthernet1/0/1 ifAlias 是 string 1~242个字符。 - 接口别名。 说明：从设备上获取，可修改。如果设备不支持特殊字符和中文，接口返回错误码-3，错误信息为“snmp-error-set-10”。 "aaa"

请求示例 cURL的示例 curl -k -s -L -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-mk5ciqtg7yg9qrqlvt09fubsgb45gbburt8aupqko4ulap7x87jtfwo6cbeo8agbgbqo6lvvvzuqtf9cvugak42pqphd2ptj3vsa3xhevzo76ks9piermrlddhurrtfv' 'https://192.168.1.125:18002/rest/openapi/networkinventoryservice/v1/interfaces/modify-tasks/action' -d '{ "nedn":"827714c8-8898-3f00-b7f3-77a489e6a3bc", "ifDesc":"100GE1/0/1", "ifAlias":"test" }' HTTP的示例 PUT /rest/openapi/networkinventoryservice/v1/interfaces/modify-tasks/action HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-mk5ciqtg7yg9qrqlvt09fubsgb45gbburt8aupqko4ulap7x87jtfwo6cbeo8agbgbqo6lvvvzuqtf9cvugak42pqphd2ptj3vsa3xhevzo76ks9piermrlddhurrtfv { "nedn":"827714c8-8898-3f00-b7f3-77a489e6a3bc", "ifDesc":"100GE1/0/1", "ifAlias":"test" }