华为云用户手册

参数解释 “UnLockUserName_AR5002”和“LockUserName_AR5002”模板无参数。 “UnLockUserName_AR5002”下发到设备的命令行： undo configuration exclusive by-user-name huawei “LockUserName_AR5002”下发到设备的命令行： configuration exclusive by-user-name huawei

响应示例 返回状态码为201：创建成功，响应体参考TerminalScanResponse。 HTTPS 201 OK Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "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": "" }

请求示例 HTTP的示例 post /controller/campus/api/v1/terminal/scanrule 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 { "id": null, "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" }

响应示例 返回状态码为200：删除成功，响应体参考ScanRuleDeleteResponse。 HTTPS 200 OK Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "successList": [ { "scanRuleId": "6c2c567e-8a03-4152-af2d-cf2ff1d47a59", "scanRuleName": "rule01" }, { "scanRuleId": "48659df8-26b7-40a1-94aa-015db7c1f4e0", "scanRuleName": "rule02" } ], "failList": [ { "errcode": "0x00c80014", "errmsg": "rule00 not exist", "scanRuleId": "1b42f734-b298-438d-a02d-d3d286429e4d", "scanRuleName": "rule00" } ] } 返回状态码为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": "" }

请求示例 HTTP的示例 post /controller/campus/api/v1/terminal/scanrule/batch-delete HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "ids": [ "1b42f734-b298-438d-a02d-d3d286429e4d","6c2c567e-8a03-4152-af2d-cf2ff1d47a59","48659df8-26b7-40a1-94aa-015db7c1f4e0" ] }

响应参数 返回状态码为200：删除成功，响应体参考ScanRuleDeleteResponse。 表3 ScanRuleDeleteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" successList ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 删除成功的列表。 - failList ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 删除失败的列表。 - 表4 ScanRuleDeleteDetail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 scanRuleId string 0~36个字符。 - 删除成功的扫描规则ID。 "7cdf9b29-d85e-46ed-b0ca-332d2189b434" scanRuleName string 0~128个字符。 - 删除成功的扫描规则名称。 "scanrule2" 表5 ScanRuleDeleteFailDetail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0x03060001" errmsg string 0~256个字符。 - 错误信息。 "The site ID is malformed or the device group does not exist." scanRuleId string 0~36个字符。 - 删除失败的扫描规则ID。 "7cdf9b29-d85e-46ed-b0ca-332d2189b434" scanRuleName string 0~128个字符。 - 删除失败的扫描规则名称。 "scanrule2" 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。

响应示例 返回状态码为200：返回操作是否成功 HTTP/1.1 200 OK { "errorCode": 0, "errorMsg": null, "totalSize": 2, "regionDetails": [ { "nodeId": "7f75baad-c780-43a0-b2df-40e77b602e93", "tenantId": null, "siteId": null, "resType": "Region", "name": "2F", "remark": null, "parentNodeId": "82cc0ef8-0a10-4a44-bdb2-47244a7b6059", "posX": 564.0, "posY": 300.0, "longitude": null, "latitude": null, "scaleLength": "0.01999", "bgImageName": "1685515888186.jpg", "regionType": "region" }, { "nodeId": "09e6f195-65f6-44e3-a4c1-b366b3d2c044", "tenantId": null, "siteId": null, "resType": "Region", "name": "1F", "remark": null, "parentNodeId": "82cc0ef8-0a10-4a44-bdb2-47244a7b6059", "posX": 500.0, "posY": 300.0, "longitude": null, "latitude": null, "scaleLength": "0.01229", "bgImageName": null, "regionType": "region" } ] } 返回状态码为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 返回状态码为403：URL鉴权 HTTP/1.1 403 Forbidden 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 返回状态码为406：流控限流 HTTP/1.1 406 Not Acceptable 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 返回状态码为502：网关错误 HTTP/1.1 502 Bad Gateway 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 返回状态码为503：服务不可用 HTTP/1.1 503 Service Unavailable 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 返回状态码为504：表示时间超时，总线超时时间300s HTTP/1.1 504 Gateway Timeout 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

URI /rest/openapi/network/wlan/region-topo/region-details 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 params 是 string 0~8192个字符。 - 查询区域详情的过滤条件(参数项含义可参考OpenApiRegionDetailQueryModel模型)。 必填参数项：page、limit、siteId(站点Id，已规划站点时必填，其他场景不填该参数)。 可选参数项：sortColumn、sortMode、regionIds、regionTypes、name、remark、posX、posY、longitude、latitude。 {"page" : 1, "limit" : 20, "sortColumn" : "regionType", "sortMode" : "asc", "regionIds" : [ "980f46a9-a25d-48cb-ac45-b263fb511740" ], "regionTypes" : [ "region" ], "name" : "floor1", "remark" : "", "posX" : 500, "poxY" : 300}

请求示例 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-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/network/wlan/region-topo/region-details?params={page : 1, limit : 20, sortColumn : regionType, sortMode : asc, regionIds : [ 980f46a9-a25d-48cb-ac45-b263fb511740 ], regionTypes : [ region ], name : floor1, remark : , posX : 500, poxY : 300}' HTTP的示例 GET /rest/openapi/network/wlan/region-topo/region-details?params={page : 1, limit : 20, sortColumn : regionType, sortMode : asc, regionIds : [ 980f46a9-a25d-48cb-ac45-b263fb511740 ], regionTypes : [ region ], name : floor1, remark : , posX : 500, poxY : 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

响应参数 返回状态码为200：返回操作是否成功 表2 OpenApiRegionDetailsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 状态码 - errorMsg string - - 新增、修改、删除异常时的错误信息 - totalSize int32 - - 区域详情总条数 - regionDetails ARRAY_REFERENCE 详细请参见表3。 区域详情列表 - 表3 OpenApiRegionDetailModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nodeId string - - 对象ID - tenantId string - - 租户ID - siteId string - - 站点ID - resType string - - 资源类型 - name string - - 对象名称 - remark string - - 描述信息 - parentNodeId string - - 父节点ID - posX double - - 节点的X坐标 - posY double - - 节点的Y坐标 - longitude double - - 经度 - latitude double - - 纬度 - regionType string - - 区域类型 - scaleLength string - - 比例尺长度 - bgImageName string - - 背景图名称 - 返回状态码为400：参数错误 详细信息请参见实际响应消息体。 返回状态码为403：URL鉴权 详细信息请参见实际响应消息体。 返回状态码为404：rest接口没找到 详细信息请参见实际响应消息体。 返回状态码为406：流控限流 详细信息请参见实际响应消息体。 返回状态码为500：默认ServiceException异常码，应用内部错误 详细信息请参见实际响应消息体。 返回状态码为502：网关错误 详细信息请参见实际响应消息体。 返回状态码为503：服务不可用 详细信息请参见实际响应消息体。 返回状态码为504：表示时间超时，总线超时时间300s 详细信息请参见实际响应消息体。

配置接口下绑定VPN缺省模板（仅V300版本AR设备） 表1 ConfigPortBindVPN模板参数解释 参数名称 类型 取值范围 参数解释 portName String - 绑定VPN实例的接口，例如Tunnel0/0/1 vpnInstanceName String 1～31 接口上绑定的VPN实例。设备已存在的VPN实例，并且VPN实例必须已经使能IPv4地址值族。 下发到设备的命令行： interface portName ip bind vpn-instance vpnInstanceName 父主题： iMaster NCE-Campus内置缺省模板参数介绍

响应参数 返回状态码为200：成功 表4 query-temporary-change-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:output REFERENCE 详细请参见表5。 - - 表5 query-temporary-change-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 change-template-infos ARRAY_REFERENCE 详细请参见表6。 template info - process int32 [0-65535] - 完成进度 50 total int32 [0-65535] - 总模板数量 10 表6 change-template-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-id string 0~128个字符。 - configure template id - template-name string 1~128个字符。 - template name - change-template-content string 0~1048576个字符。 - configure template content - error-message string 0~256个字符。 - error message - 返回状态码为400：失败 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：成功 HTTP/1.1 200 OK Date: Thu,21 Dec 2023 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" : { "change-template-infos" : [ { "template-id" : "58f9035e-ce63-4c6c-b588-7998c7c9168b", "template-name" : "test", "change-template-content": "---\nhuawei-nce-e-ifm:interface:\n- name: \"GE1/1/1\"\n ifm-class: \"main-interface\"\n type: \"GE\"\n number: \"1/1/1\"\n level: \"L2\"\n link-up-down-trap-enable: true\n admin-status: \"down\"\n description: \"description\"\n" } ], "process" : 50, "total" : 10 } } 返回状态码为400：失败 HTTP/1.1 400 Bad Request Date: Thu,21 Dec 2023 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template:query-temporary-change HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-nce-aoc-config-template:input": { "job-id": "5c261eb5-2f4a-4acc-a747-c77ee1d18083", "content-type":"yaml" } }

iMaster NCE-Campus内置缺省模板参数介绍 缺省情况下，iMaster NCE-Campus内置了以下模板，本章对缺省模板参数和下发命令进行详细介绍。 ACL缺省模板介绍（仅V300版本AR设备） SNMP缺省模板介绍（仅V300版本AR设备） WebSSHtimeout缺省模板介绍（仅V300版本AR设备） NetStream缺省模板介绍（仅V300版本AR设备） PBR缺省模板介绍（仅V300版本AR设备支持） 设备注册缺省模板介绍（仅V300版本AR设备） IPv6静态路由缺省模板介绍（仅V300版本AR设备） 配置Loopback接口缺省模板（仅V300版本AR设备） 配置Tunnel接口缺省模板（仅V300版本AR设备） 配置接口下绑定VPN缺省模板（仅V300版本AR设备） SNMPTemplate缺省模板（仅V600版本AR设备） KeychainTemplate缺省模板（仅V600版本AR设备） 在线升级IPS特征库和AV病毒库缺省模板介绍（仅V300版本AR设备） 开启URL远程查询功能缺省模板介绍（仅V300版本AR设备） 锁定/解锁huawei用户缺省模板（仅V600版本AR设备） 配置本地admin用户账号过期时间缺省模板（仅V300版本AR设备） 配置接口状态缺省模板（仅V600版本AR设备） 配置VTY优先级缺省模板（仅V600版本AR设备） 配置SSH服务端的IPv4源地址缺省模板（仅V600版本AR设备） 配置ACL规则缺省模板（仅V600版本AR设备） 配置密码策略缺省模板（仅V600版本AR设备） 配置地址集对象缺省模板（仅V600版本AR设备） 配置 域名 组缺省模板（仅V600版本AR设备） 配置安全区域缺省模板（仅V600版本AR设备） 配置NAT Server缺省模板（仅V600版本AR设备） 配置NAT功能缺省模板（仅V600版本AR设备） 配置安全策略缺省模板（仅V600版本AR设备） 父主题： 模板管理

响应示例 返回状态码为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" : [ { "neip" : "10.136.252.60", "nename" : "FW_B", "nedn" : "047f72d1-7ad3-11e9-b906-000c29b01448", "portdn" : "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1,SS=-1,PP=|1025|0|GigabitEthernet1/0/0", "framedn" : "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1", "slotdn" : "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1", "subslotdn" : "-1", "frameno" : 1, "slotno" : 1, "subslotno" : -1, "portindex" : 67387406, "portno" : 0, "descr" : "Port", "name" : "GigabitEthernet1/0/0", "adminstatus" : 1, "operstatus" : 2, "ifindex" : 6, "iftype" : 2, "ipaddress" : "10.0.0.0", "ifspeed" : "1000000000" } ], "pageSize" : 1, "totalSize" : 100, "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/port?neip=10.136.252.60&nename=FW_B&nedn=047f72d1-7ad3-11e9-b906-000c29b01448&portdn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1,SS=-1,PP=|1025|0|GigabitEthernet1/0/0&framedn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1&slotdn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1&subslotdn=-1&frameno=1&slotno=1&subslotno=-1&portindex=67387406&portno=0&descr=Port&name=GigabitEthernet1/0/0&adminstatus=1&operstatus=2&ifindex=6&iftype=2&ipaddress=10.0.0.0&ifspeed=1000000000&start=0&size=20&orderby=nedn&desc=true&fields=nedn' HTTP的示例 GET /rest/openapi/network/port?neip=10.136.252.60&nename=FW_B&nedn=047f72d1-7ad3-11e9-b906-000c29b01448&portdn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1,SS=-1,PP=|1025|0|GigabitEthernet1/0/0&framedn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1&slotdn=047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1&subslotdn=-1&frameno=1&slotno=1&subslotno=-1&portindex=67387406&portno=0&descr=Port&name=GigabitEthernet1/0/0&adminstatus=1&operstatus=2&ifindex=6&iftype=2&ipaddress=10.0.0.0&ifspeed=1000000000&start=0&size=20&orderby=nedn&desc=true&fields=nedn 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 PortResResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - 0 操作返回码。可以是如下值之一： 0：成功 非0：失败 0 data ARRAY_REFERENCE 详细请参见表3。 - - pageSize integer - - 记录总页数。 1 totalSize integer - - 记录总数。 100 description string - - 描述信息。 Operation success 表3 PortResData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 neip string - - 设备IP地址（通过，分隔）。 "10.136.252.60" nename string - - 设备名称。 "FW_B" nedn string - - 设备dn。 "047f72d1-7ad3-11e9-b906-000c29b01448" portdn string - - 端口dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1,SS=-1,PP=|1025|0|GigabitEthernet1/0/0" framedn string - - 机框dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1" slotdn string - - 单板dn。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1" subslotdn string - - 子卡dn。 "-1" frameno int32 - - 机框序号。 1 slotno int32 - - 单板序号。 1 subslotno int32 - - 子卡序号。 -1 portindex int32 - - 端口索引。 67387406 portno int32 - - 端口编号。 0 descr string - - 端口描述。 "Port" name string - - 端口名称。 "GigabitEthernet1/0/0" adminstatus int32 - - 管理状态。 1 operstatus int32 - - 操作状态。 2 ifindex int32 - - 接口索引。 6 iftype int32 - - 端口类型。 2 ipaddress string - - 端口IP地址。 "10.0.0.0" ipnetmask string - - 端口子网掩码。 - ifspeed string - - 端口速率（bps）。 "1000000000" 返回状态码为400：参数错误。 详细信息请参见实际响应消息体。 返回状态码为404：rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为500：默认ServiceException异常码，应用内部错误。 详细信息请参见实际响应消息体。

URI /rest/openapi/network/port 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 neip 否 string 1~100个字符。 - 设备IP地址。 "10.136.252.60" nename 否 string 1~100个字符。 - 设备名称。 "FW_B" nedn 否 string 1~100个字符。 - 设备DN。 "047f72d1-7ad3-11e9-b906-000c29b01448" portdn 否 string 1~100个字符。 - 端口DN。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1,SS=-1,PP=|1025|0|GigabitEthernet1/0/0" framedn 否 string 1~100个字符。 - 机框DN。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1" slotdn 否 string 1~100个字符。 - 单板DN。 "047f72d1-7ad3-11e9-b906-000c29b01448,FR=1,S=1" subslotdn 否 string 1~100个字符。 - 子卡DN。 "-1" frameno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 机框序号。 1 slotno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 单板序号。 1 subslotno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 子卡序号。 -1 portindex 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 端口索引。 67387406 portno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 端口编号。 0 descr 否 string 1~100个字符。 - 端口描述。 "Port" name 否 string 1~100个字符。 - 端口名称。 "GigabitEthernet1/0/0" adminstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 端口管理状态，可以是如下值之一： 1：up 2：down 3：planning 1 operstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 端口操作状态，可以是如下值之一： 1：up 2：down 3：testing 4：unknown 5：dormant 6：notPresent 7：lowerLayerDown 2 ifindex 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 接口索引。 6 iftype 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 端口类型，可以是如下值之一： 2：Ethernet 5：Atm 6：Pos 7：Serial 9：E1 10：T1 11：Cpos 19：Aux 20：E3 21：T3 22：Meth 32：Cellular 2 ipaddress 否 string 1~100个字符。 - 端口IP地址。 "10.0.0.0" ifspeed 否 string 1~100个字符。 - 端口速率（bps）。 "1000000000" start 否 integer - 0 指定从哪个起始记录位置开始返回查询结果集。缺省值是0。说明：如果值小于0，将使用缺省值。 0 size 否 integer - 20 指定返回查询结果集总数，支持1～100条，缺省值是20。说明：如果值小于1或大于100时，将使用缺省值。 20 orderby 否 string - nedn 指定查询结果集采用的排序字段。缺省排序字段是nedn。可指定的排序字段包括：nedn、nename、portdn，name(端口名) 说明： 指定多个排序字段时字段间用英文半角逗号“,”分隔。 说明： 使用“start”和“size”参数进行分页查询时，必须指定“orderby”参数为“portdn”。 "nedn" desc 否 boolean - false 指定查询结果是否按降序排序。缺省值是false。说明：此请求参数只有指定了“orderby”请求参数后才有效。 true fields 否 string - - 指定查询结果所包含的列。需要查询的列名为fields参数的值，多个列名时可用英文逗号隔开。 说明： 此请求参数只有指定了fields请求参数后才有效，不指定默认返回所有字段。 "nedn"

URI /controller/campus/v1/networkservice/networkconfig/net/aptunnel/sites/{siteId}/config 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为200：修改成功，返回结构体参见APTunelServiceResponseDto。 HTTP/1.1 200 OK Date: Thu,13 Sep 2018 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "00000000000000000000000000000000", "name" : "tunnel1", "master-ip" : "192.168.0.1", "backup-ip" : "192.168.0.2", "auto-restore-enable" : true, "auto-restore-delay" : "100", "vlan" : "20,30-200,500", "dtls" : "disable", "backupDtls" : "disable" } ] }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/aptunnel/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/config 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 { "id" : "00000000000000000000000000000000", "name" : "tunnel1", "master-ip" : "192.168.0.1", "backup-ip" : "192.168.0.2", "auto-restore-enable" : true, "auto-restore-delay" : 100, "vlan" : "20,30-200,500", "dtls" : "disable", "dtlsKey" : "tunnelkey", "backupDtls" : "disable", "backupDtlsKey" : "tunnelkey" }

响应参数 返回状态码为200：查询成功返回体。 表3 DevicePluginInfosRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 插件列表。 - totalNum int64 [0-100000] - 总数。 "0" errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 " " 表4 DevicePluginInfoRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 1~64个字符。 - id。 "e9a51c61-f6cb-4884-9b3f-c54b8716feed" deviceId string 1~64个字符。 - 设备ID。 "9c24d989-49d7-4877-933a-67d285879319" deviceName string 1~64个字符。 - 设备名称。 "AirEngine5773-21_4A096F85" deviceStatus int32 [0-10] - 设备状态，0：在线，1：告警，3：离线，4：未注册。 0 esn string 1~64个字符。 - 设备ESN。 "21500831023000000000" siteName string 1~64个字符。 - 站点名称。 "site1" pluginName string 1~64个字符。 - 插件名称。 "plugin1" status int32 [0-10] - 部署状态（0：初始化，1：部署中，2：部署成功，3：部署失败，4：卸载中，5：卸载成功，6：卸载失败）。 0 failreason string 0~256个字符。 - 失败原因。 "This configuration is not supported by the current model or version of the device." 返回状态码为400：查询失败返回体。 DevicePluginInfosRsp对象的参数列表，详细请参见表3。

响应示例 返回状态码为200：查询成功返回体。 { "data": [ { "id": "e9a51c61-f6cb-4884-9b3f-c54b8716feed", "deviceId": "9c24d989-49d7-4877-933a-67d285879319", "deviceName": "2102353GES10LA000052", "deviceStatus": 0, "esn": "2102353GES10LA000052", "siteName": "name", "pluginName": "test", "status": 2, "failreason": null } ], "totalNum": 1, "errcode": "0", "errmsg": null } 返回状态码为400：查询失败返回体。 { "data": [], "totalNum": 0, "errcode": "0x00c80035", "errmsg": "Invalid parameter pluginType." }

响应示例 返回状态码为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

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template-binding:unbound-template-binding Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "input": { "delete-config-from-device": true, "device": [{ "device-id": "8d394835-cb84-38f3-a4d5-36a7f2074b78" }], "template-binding-id": "7b685011-e7bd-4649-9264-c1e0557ba15b" } }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 unbound-devices-from-binding 是 REFERENCE 详细请参见表2。 unbound devices from binding. - 表2 unbound-devices-from-binding-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template-binding:input REFERENCE 详细请参见表3。 - - 表3 unbound-devices-from-binding-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 device 是 ARRAY_REFERENCE 详细请参见表6。 list device - template-binding-id 否 string 0~128个字节。 - the identifier of the template application. "f3685151-6e70-46a8-934f-4004c532dcc4" delete-config-from-device 否 boolean true false false Whether delete config from device. true

响应示例 返回状态码为200：绑定成功，响应体参考ScanRuleBindInfoGetOutputDto。 HTTPS 200 OK Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "pageIndex": 1, "pageSize": 10, "totalSize": 1, "deviceList": [ { "scanRuleId": "8f356904-45c8-6409-bc0f-fc6d98e7c74a", "deviceId": "6a7b14c1-6b6f-3726-b6c5-a14a77c51ca2", "deviceName": "dev01", "deviceEsn": "1019A0055991", "deviceRole": "ACC", "siteName": "site1", "siteId": "968d34cc-6cd2-719a-73dd-857bd328d141", "scanUpdateTime": "2023-01-16 14:35:55", "scanResult": 0, "scanFailureCause": "" } ] } 返回状态码为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": "" }

请求示例 HTTP的示例 get /controller/campus/api/v1/terminal/scanrule/getBindInfo?scanRuleId=5843d82def3e44e4aab60cd4e180117e&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：绑定成功，响应体参考ScanRuleBindInfoGetOutputDto。 表2 ScanRuleBindInfoGetOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" pageIndex int32 [1-100] - 当前页码。 1 pageSize int32 [5-100] - 分页大小。 10 totalSize int32 [0-100] - 当前扫描规则绑定设备总数目。 100 deviceList ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 绑定设备列表 - 表3 GetBindDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 scanRuleId string 0~36个字符。 - 扫描规则ID "11111111-1111-1111-1111-111111111112" deviceId string 0~36个字符。 - 设备ID "11111111-1111-1111-1111-111111111113" deviceName string 0~64个字符。 - 设备名称 "device1" deviceEsn string 0~64个字符。 - 设备ESN "0002353AJS0000000000" deviceRole string 0~36个字符。 - 设备角色 "接入" siteName string 0~64个字符。 - 站点名称 "site1" siteId string 0~36个字符。 - 站点ID "11111111-1111-1111-1111-111111111110" scanUpdateTime string 0~32个字符。 - 终端扫描更新时间。 "2023-01-16 14:35:55" scanType int32 [0-1] 0 扫描类型，0表示普通扫描，1表示深度扫描 0 scanResult int32 [0-10] - 立即扫描结果，0表示成功，1表示失败。 0 scanFailureCause string 0~256个字符。 - 立即扫描失败原因。 "device offline" 返回状态码为400：接口调用失败，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。 返回状态码为500：内部错误，响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表，详细请参见表7。