华为云用户手册

AOC配置模板应用 该模块定义模板应用模型。 新建模板应用中的模板或者设备 查询模板应用 更新模板应用中的模板和设备 删除模板应用 查询模板应用中的模板 替换模板应用中的模板参数 删除模板应用中的模板 查询模板应用中的模板参数 替换模板应用的单个模板参数 删除模板应用的单个模板参数 根据模板应用ID查询特定模板应用中的设备 删除模板应用中的设备 替换模板应用中的设备的模板参数 查询模板应用中的设备的模板参数 替换模板应用的设备的单个模板参数 删除模板应用的设备的单个模板参数 预览模板应用中的设备配置 创建模板应用 使用过滤条件查询模板应用中的设备 批量删除模板应用中的设备 提交模板应用 父主题： 开放可编程接口

响应参数 返回状态码为200：Successful operation 表4 create-template-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:output REFERENCE 详细请参见表5。 - - 表5 create-template-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-id string 1~128个字节。 - 模板ID "26559bd3-a00e-4c6d-a573-e6b711a897b3" 返回状态码为204：No content 返回状态码为400：Bad Request 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template:create-template Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-aoc-template:input": { "template-name": "tetlt", "template-description": "", "package-type": "GND", "template-content": "{\n \"huawei-nce-e-vlan:vlan\" : [ {\n \"vlan-id\" : 20,\n \"mac-learning\" : \"enable\"\n } ],\n \"huawei-nce-e-ifm:interface\" : [ {\n \"name\" : \"Eth-Trunk33\",\n \"ifm-class\" : \"main-interface\",\n \"type\" : \"Eth-Trunk\",\n \"number\" : \"33\",\n \"level\" : \"L2\"\n } ]\n}", "create-type": "customize", "template-format": "ui", "parent-template-id": "cb006caf-e335-459c-8e01-b74f6466d92f" } }

响应示例 返回状态码为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": { "template-id": "03e65ab2-64f3-4dcc-b3e3-33575ffd011c" } } 返回状态码为204：No content HTTP/1.1 204 No Content 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 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 create-template 是 REFERENCE 详细请参见表2。 创建模型 - 表2 create-template-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:input REFERENCE 详细请参见表3。 - - 表3 create-template-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-name 是 string 0~128个字节。 - 配置模板名称 "test" package-type 是 string SND GND SSP - 包模型 "GND" template-content 是 string 0~2097152个字节。 - 模板内容 "\"{\\n \\\"traffic-engineering-uni-gnd:te\\\" : {\\n \\\"config-status\\\" : \\\"reserved\\\",\\n \\\"global\\\" : {\\n \\\"teAttributeEnable\\\" : false\\n },\\n \\\"affinity-define\\\" : {\\n \\\"description\\\" : \\\"23\\\",\\n \\\"affinity-mappings\\\" : {\\n \\\"affinity-mapping\\\" : [ {\\n \\\"attribute-name\\\" : \\\"12\\\",\\n \\\"bit-sequence\\\" : 12\\n } ]\\n }\\n }\\n },\\n \\\"dtls-server-uni-gnd:dtls-server\\\" : { },\\n \\\"bfd-session-uni-gnd:bfd-session\\\" : [ {\\n \\\"name\\\" : \\\"789\\\"\\n } ]\\n}\"" template-domain 否 string 0~128个字节。 - 模板所属域 "null" template-description 否 string 0~1024个字节。 - 模板描述 "test" create-type 否 string preset customize - 模板来源类型 preset：预置模板。 customize：自定义创建新模板（包含创建新模板、复制MSP模板、导入模板）。 "customize" template-format 否 string ui text - 模板编辑格式 ui：配置为ui后，可以在界面呈现该模板。 text：配置为text后，界面不呈现该模板，只能通过北向接口操作。 "ui" parent-template-id 否 string 0~128个字节。 - 该模板的父模板ID -

响应示例 返回状态码为200：接口执行成功 HTTP/1.1 200 OK { "errorCode": 0, "errorMsg": null, "imgData": { "tenantId": null, "bgImageName": "test.jpg", "fileSize": 389, "bgImageWidth": 1515.0, "bgImageHeight": 343.0, "totalShardCount": 1, "currentShardIndex": 0, "shardContent": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDACgcHiMeGSgjISMt" } } 返回状态码为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

请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-AC CES S-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/network/wlan/region-topo/background-image?regionId=0e6124e0-106d-4ecc-990e-0be0d04198ab&shardIndex=0' HTTP的示例 GET /rest/openapi/network/wlan/region-topo/background-image?regionId=0e6124e0-106d-4ecc-990e-0be0d04198ab&shardIndex=0 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 OpenApiTopoBgImageResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 状态码 - errorMsg string - - 新增、修改、删除异常时的错误信息 - imgData REFERENCE 详细请参见表3。 图片数据 - 表3 OpenApiBackgroundImageModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 tenantId string - - 租户ID - bgImageName string - - 背景图名称 - fileSize int64 - - 图片文件大小，单位是字节 - bgImageWidth double - - 背景图宽度 - bgImageHeight double - - 背景图高度 - totalShardCount int32 - - 分片总数量 - currentShardIndex int32 - - 分片索引 - shardContent byte - - 分片二进制字节流(Base64编码) - 返回状态码为400：参数错误 详细信息请参见实际响应消息体。 返回状态码为403：URL鉴权 详细信息请参见实际响应消息体。 返回状态码为404：rest接口没找到 详细信息请参见实际响应消息体。 返回状态码为406：流控限流 详细信息请参见实际响应消息体。 返回状态码为500：默认ServiceException异常码，应用内部错误 详细信息请参见实际响应消息体。 返回状态码为502：网关错误 详细信息请参见实际响应消息体。 返回状态码为503：服务不可用 详细信息请参见实际响应消息体。 返回状态码为504：表示时间超时，总线超时时间300s 详细信息请参见实际响应消息体。

URI /rest/openapi/network/wlan/region-topo/background-image 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 regionId 是 string 0~64个字符。 - 区域ID "0e6124e0-106d-4ecc-990e-0be0d04198ab" shardIndex 是 int32 - - 分片索引(从0开始) 0

SNMP缺省模板介绍（仅V300版本AR设备） 如果SNMP首次下发到设备失败，必须将SNMP配置回滚到首次下发之前，然后重新对设备下发SNMP配置。 为保证更好的安全性，建议使用SNMPv3版本。 通过以下模板完成SNMPv2功能的配置，配置流程如下： 步骤 配置功能 使用模板 step1 创建ACL CreateACL模板，参考ACL缺省模板介绍ACL缺省模板介绍（仅V300版本AR设备）。 step2 创建团体名 SNMPCommunity模板（表1），其中SNMPCommunity的community_acl依赖模板CreateACL的acl_num。 step3 创建traphost SNMPv2TrapHost模板（表2），其中SNMPv2TrapHost的security_name依赖模板SNMPCommunity的community_name。 通过以下模板完成SNMPv3功能的配置，配置流程如下： 步骤 配置功能 使用模板 step1 创建V3用户组和用户名 SNMPv3CreateUser模板（表3）。 step2 创建traphost SNMPv3TrapHost模板（表4），其中SNMPv3TrapHost的user_name依赖模板SNMPv3CreateUser的user_name。 表1 SNMPCommunity模板参数介绍 参数名称 类型 取值范围 参数说明 community_acl Int 只支持基本ACL范围：2000～2999 团体名关联ACL编号，为已创建的ACL。 community_name String 8～32或88 SNMP团体名称，字符串形式，不支持空格，区分大小写。 当输入的字符串长度在8-32之间时，系统默认为是明文输入，会对明文加密。 当输入的字符串长度为88时，系统默认为密文输入，讲判断该密文能否解析。 说明： 至少包含两种字符，包括：大写字母、小写字母、数字、特殊字符。 index String 1～32 SNMP团体名索引，区分大小写。 下发到设备的命令行： snmp-agent community read community_name acl 2001 community_name为密文形式。 表2 SNMPv2TrapHost模板参数介绍 参数名称 类型 取值范围 参数说明 snmp_host String - 目的主机的IP地址，支持IPv4地址格式。 snmp_port Int 1～65535 目的主机用于接收Trap报文的端口号。 vpn_instance_name String 1～31 VPN实例名，不支持空格，区分大小写。 snmp_param_name String 1～32 目的主机使用的Trap报文发送参数信息列表名称，区分大小写。 queue_size Int 1～1000，缺省值为100 报文队列长度。 complexity_check Boolean true或false 配置团体名、SNMPv3用户认证密码和SNMPv3用户加密密码复杂度检查功能。 source_interface String - 发送Trap报文的源接口类型和编号： GigabitEthernet：例如：GigabitEthernet0/0/1。 GigabitEthernet子接口：例如：GigabitEthernet0/0/1.10。 XGigabitEthernet：例如：XGigabitEthernet0/0/2。 XGigabitEthernet子接口：例如：XGigabitEthernet0/0/2.10。 Ethernet：例如：Ethernet1/0/1。 Ethernet子接口：例如：Ethernet1/0/1.10。 LoopBack ：例如：LoopBack10。 Tunnel ：例如：Tunnel10/0/10。 Vlanif：例如：Vlanif10。 Etrunk：例如：Eth-Trunk3。 security_name String 可输入的字符串长度： 1～32（明文） 48～68（密文） 生成Trap报文的主体名。 下发到设备的命令行： snmp-agent sys-info version v2c snmp-agent target-host trap-hostname snmp_host address snmp_host udp-port snmp_port vpn-instance vpn_instance_name trap-paramsname snmp_param_name snmp-agent target-host trap-paramsname snmp_param_name v2c securityname security_name snmp-agent trap source source_interface snmp-agent trap enable undo snmp-agent trap enable feature-name bgp trap-name ESTABLISHED undo snmp-agent trap enable feature-name bgp trap-name BACKWARD snmp-agent trap queue-size queue_size snmp-agent complexity-check disable security_name为密文形式。 表3 SNMPv3CreateUser模板参数介绍 参数名称 类型 取值范围 参数说明 user_name String 1～32 用户名，字符串形式，不支持空格，区分大小写。 user_group String 1～32 SNMPv3用户对应的组名，字符串形式，不支持空格，区分大小写。 priv_algorithm String 取值为： aes128：AES-128 aes256：AES-256 使用aes128或aes256加密算法对报文中的PDU部分进行加密。 auth_key String - 表示认证协议为HMAC-SHA-96的认证密码。规则如下： 不可以和priv_key相同。 长度范围为8-64字符。 至少包含2种特殊字符：大写字母、小写字母、数字、特殊字符（不包括空格）。 字符要先转换成ASCII码，ASCII码只保留后两位，使用英文冒号“:”隔开。例如：“Example@1234”对应ASCII码“\u0045\u0078\u0061\u006d\u0070\u006c\u0065\u0040\u0031\u0032\u0033\u0034”，则输入为：“45:78:61:6d:70:6c:65:40:31:32:33:34”。 priv_key String - 加密算法为AES-128或AES-256的加密密码。规则如下： 不可以和auth_key相同。 长度范围为8-64字符。 至少包含2种特殊字符：大写字母、小写字母、数字、特殊字符（不包括空格）。 字符要先转换成ASCII码，ASCII码只保留后两位，使用英文冒号“:”隔开。例如：“Example@123”对应ASCII码“\u0041\u0064\u006d\u0069\u006e\u0040\u0031\u0032\u0033”，则输入为：“45:78:61:6d:70:6c:65:40:31:32:33”。 security_level String 取值为： no-auth-no-priv：既不认证也不加密 auth-no-priv：认证但不加密 auth-priv：既认证又加密 SNMPv3用户组的安全级别。 下发到设备的命令行： snmp-agent group v3 user_group authentication write-view ViewDefault notify-view ViewDefault snmp-agent usm-user v3 user_name snmp-agent usm-user v3 user_name group user_group snmp-agent usm-user v3 user_name authentication-mode sha auth_key snmp-agent usm-user v3 user_name privacy-mode priv_algorithm priv_key auth_key和priv_algorithm priv_key为密文形式。 表4 SNMPv3TrapHost模板参数介绍 参数名称 类型 取值范围 参数说明 snmp_host ip address - 目的主机的IP地址，支持IPv4地址格式。 snmp_port Int 1～65535 目的主机用于接收Trap报文的端口号。 snmp_param_name String 1～32 目的主机使用的Trap报文发送参数信息列表名称，区分大小写。 vpn_instance_name String 1～31 VPN实例名，不支持空格，区分大小写。 queue_size Int 1～1000，缺省值为100 报文队列长度。 complexity_check Boolean true或false 配置团体名、SNMPv3用户认证密码和SNMPv3用户加密密码复杂度检查功能。 source_interface String - 发送Trap报文的源接口类型和编号： GigabitEthernet：例如：GigabitEthernet0/0/1。 GigabitEthernet子接口：例如：GigabitEthernet0/0/1.10。 XGigabitEthernet：例如：XGigabitEthernet0/0/2。 XGigabitEthernet子接口：例如：XGigabitEthernet0/0/2.10。 Ethernet：例如：Ethernet1/0/1。 Ethernet子接口：例如：Ethernet1/0/1.10。 LoopBack ：例如：LoopBack10。 Tunnel ：例如：Tunnel0/0/10。 Vlanif：例如：Vlanif10。 Eth-Trunk：例如：Eth-Trunk3。 user_name String 1～32 用户名，字符串形式，不支持空格，区分大小写。 security_level String 取值为： no-auth-no-priv：既不认证也不加密 auth-no-priv：认证但不加密 auth-priv：既认证又加密 SNMPv3用户组的安全级别。 下发到设备的命令行： snmp-agent target-host trap-hostname snmp_host address snmp_host udp-port snmp_port vpn-instance vpn_instance_name trap-paramsname snmp_param_name snmp-agent target-host trap-paramsname snmp_param_name v3 securityname user_name security_level snmp-agent trap source source_interface snmp-agent trap enable undo snmp-agent trap enable feature-name bgp trap-name ESTABLISHED undo snmp-agent trap enable feature-name bgp trap-name BACKWARD snmp-agent trap queue-size queue_size snmp-agent complexity-check disable security_name为密文形式。 父主题： iMaster NCE-Campus内置缺省模板参数介绍

响应示例 返回状态码为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": { "template-infos": [ { "template-id": "f2ce253d-5ad3-44c7-a845-e6d70d57fbac", "template-name": "test", "package-type": "GND", "create-type": "customize", "template-format": "ui", "children-number": 0, "empty-template": false, "feature-view-mode": "full" }, { "template-id": "d6f23e9a-58d6-4195-82d3-20946c8cc673", "template-name": "hq", "package-type": "GND", "create-type": "customize", "template-format": "ui", "children-number": 1, "empty-template": false, "feature-view-mode": "full" } ], "total-num": 2 } } 返回状态码为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

响应参数 返回状态码为200：Successful operation 表4 query-templates-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:output REFERENCE 详细请参见表5。 - - 表5 query-templates-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-infos ARRAY_REFERENCE 详细请参见表6。 模板信息 - total-num int32 [-2147483648-2147483647] - 总数量 10 表6 template-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-id string 0~128个字节。 - 配置模板ID "d6f23e9a-58d6-4195-82d3-20946c8cc673" template-name string 0~128个字节。 - 配置模板名称 "test" package-type string SND GND SSP - 包模型 "GND" create-type string preset customize - 导入模板创建方式 "customize" template-format string ui text - 模板编辑格式 "ui" template-domain string 0~128个字节。 - 模板所属域 "null" template-description string 0~max个字节。 - 模板描述 "test" parent-template-id string 0~128个字节。 - 父模板ID "26559bd3-a00e-4c6d-a573-e6b711a897b2" children-number int32 [-2147483648-2147483647] - 子模板数量 2 empty-template boolean true false - 空模板 true feature-view-mode string full simplified - 特性查看模式 "full" 返回状态码为400：Bad Request 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template:query-templates HTTP/1.1 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":{ "create-type":"customize", "sort-field":"template-name", "sort-mode":"desc", "limit":10, "offset":1, "view-mode": "root" } }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 query-templates 是 REFERENCE 详细请参见表2。 查询模板 - 表2 query-templates-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:input REFERENCE 详细请参见表3。 - - 表3 query-templates-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-name 否 string 0~128个字节。 - 模板名称 "test" package-type 否 string SND GND SSP - 包类型 "GND" create-type 否 string preset customize - 创建类型 "customize" template-format 否 string ui text - 格式类型 "ui" sort-field 否 string template-name update-time template-name 排序字段 "template-name" sort-mode 否 string asc desc asc 排序模式 "asc" offset 否 int32 [-2147483648-2147483647] - 偏移量 1 limit 否 int32 [1-100] 10 限制 10 view-mode 否 string full root root 查看模式 "root"

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 resetInput 是 REFERENCE 详细信息请参见表 resetInput对象的参数列表。 撤销事务参数。 表2 resetInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 huawei-ac-restconf-transactions:input 否 REFERENCE 详细信息请参见表 huawei-ac-restconf-transactions:input对象的参数列表。 - 表3 huawei-ac-restconf-transactions:input对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 trans-id 是 string 1~255个字符 - 事务ID。

请求示例 cURL示例 curl -k -s -L -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925' 'https://{ip:port}/restconf/operations/huawei-ac-restconf-transactions:reset' -d '{"huawei-ac-applications:input":{"trans-id":"3d80e8be-7b7e-469b-acd6-034dabbaed6e"}}' HTTP示例 POST /restconf/operations/huawei-ac-restconf-transactions:reset HTTP/1.1 Host: {ip:port} Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925

响应参数 返回状态码为204：撤销成功。 返回状态码为500：撤销失败。 表4 错误码描述 Status Code Error Code Error Message Parameter 错误说明 500 0x00c80017 {0}不能被删除 {0} ：指定的对象。 指定的对象或者记录不能被删除。 500 0x01600001 事务\"{0}\"已经过期，未下发的配置已经失效。 {0}：用户事务ID 事务默认5天过期，或者该事务已经被提交。

请求示例 新建模板应用中的模板的HTTP的示例 POST /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-application-id} Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "template": [ { "template-id": "a76c5de4-de30-4c2f-a358-42bf89e3b788" } ] }

响应示例 返回状态码为201：Successful operation HTTP/1.1 201 OK 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} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-application-id 是 string 0~128个字节。 - the identifier of the template application. "a945675d-ccff-4ea3-afb4-8d04ac3100c2"

响应示例 返回状态码为200：获取查询到的设备信息 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "resultList": [{ "neDn": "e1daadbb-71cd-11e9-82c8-000c291661a5", "neName": "huawei", "startupErrorCode": 0, "runningErrorCode": 0, "backupType": null, "startupFileName": null, "runningFileName": null, "errorCode": 0, "errorMsg": "" }], "error_code": 0, "error_msg": "Successful.", "sessionId": 1589, "briefErrorCode": 0, "briefErrorMsg": null, "status": 0 }

请求示例 cURL的示例 curl -k -s -L -i -X POST -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/conffilemgmtservice/v1/conffile/action/backup' -d '[ "e1daadbb-71cd-11e9-82c8-000c291661a5" ]' HTTP的示例 POST /rest/openapi/conffilemgmtservice/v1/conffile/action/backup 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 [ "e1daadbb-71cd-11e9-82c8-000c291661a5" ]

响应参数 返回状态码为200：获取查询到的设备信息 表2 OperateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 error_code int32 - 0 错误码。 - error_msg string - Successful. 错误消息。 - resultList ARRAY_REFERENCE 详细请参见表3。 设备恢复结果 - sessionId int64 - - 会话id - briefErrorCode int32 - 0 下发操作的结果（0：全部成功，1：全部失败，2：部分成功） - briefErrorMsg string - - 整体操作结果描述 - status int32 - 0 下发操作的进展（0：初始化，1：运行中，2：结束） - 表3 DeviceOperateResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 neDn string 0~100个字符。 - 设备dn - neName string 0~255个字符。 - 设备名称 - errorCode int32 - 0 失败码 - startupErrorCode int32 - 0 启动配置错误码 - runningErrorCode int32 - 0 运行配置错误码 - backupType string 0~255个字符。 - 备份类型 - errorMsg string - - 失败原因 - startupFileName string 0~255个字符。 - 启动配置文件名 - runningFileName string 0~255个字符。 - 运行配置文件名 -

请求示例 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": false, "template-binding": [{ "template-binding-id": "7b685011-e7bd-4649-9264-c1e0557ba15b" }] } }

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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 unbound-template-binding 是 REFERENCE 详细请参见表2。 unbound template binding. - 表2 unbound-template-binding-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template-binding:input REFERENCE 详细请参见表3。 - - 表3 unbound-template-binding-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-binding 是 ARRAY_REFERENCE 详细请参见表4。 list template binding. - delete-config-from-device 否 boolean true false false Whether delete config from device. true 表4 template-binding-group-template-binding对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template 否 ARRAY_REFERENCE 详细请参见表4。 template list. - device 是 ARRAY_REFERENCE 详细请参见表6。 list device - template-binding-name 否 string 0~max个字节。 - the name of the template binding. "vlan-binding" template-binding-description 否 string 0~1024个字节。 - the description of the template binding. "vlan-binding" create-time 否 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2})。 - create time. "2022-12-18T13:59:02Z" create-time-ui 否 string 0~max个字节。 - create time. "2022-12-18 13:59:02" device-count 否 int64 [0-9223372036854775807] - Number of devices being bound. 1 deploying-device-count 否 int64 [0-9223372036854775807] - Number of devices being deploying or in-queue. 0 unbound-status 否 boolean true false false Whether the template binding is unbound. the value is true when you unbound the template binding with deleting the config deployed by this binding from the devices. the binding will be deleted after the config deleted from the devices. false template-binding-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}。 - the identifier of the template binding. "e5f97d04-7c18-41b7-a25a-702db1c108d7"

响应示例 返回状态码为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-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "deviceIds": ['f0039bfc-5cf0-1f24-2865-86016a8a83c0', 'e555c570-2247-a16e-03e4-033e142474da'] }

请求参数 表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