华为云用户手册

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template:delete-temporary-job 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" } }

响应示例 返回状态码为204：成功 HTTP/1.1 204 No Content 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 返回状态码为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

配置密码策略缺省模板（仅V600版本AR设备） 表1 ConfigAaaPasswordChangeCheck模板参数解释 参数名称 类型 取值范围 参数解释 change-check Boolean 布尔型，具体取值如下： true。 false。 使能第一次配置的密码修改提醒功能。 true：使能初始密码修改提醒功能。 false：去使能初始密码修改提醒功能。 缺省情况下，密码修改提醒功能处于使能状态。配置为“false”后将会关闭密码修改提醒功能，关闭密码修改提醒功能后将存在安全风险，建议保持缺省状态。 下发到设备的命令： aaa undo password alert original //此命令对应“change-check”取值为“false”，去使能初始密码修改提醒功能。 父主题： iMaster NCE-Campus内置缺省模板参数介绍

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

请求示例 HTTP的示例 GET /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-AC CES S-TOKEN: x-yyyyyy

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

响应示例 返回状态码为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-application:output": { "template-task": [ { "task-id": "93a41284-935a-3b5e-b3b9-222bcb848f94" } ] } } 返回状态码为400：Bad Request 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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 submit-template-application 是 REFERENCE 详细请参见表2。 submit template application - 表2 submit-template-application-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template-application:input REFERENCE 详细请参见表3。 - - 表3 submit-template-application-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-application-id 是 string 1~128个字节。 - the identifier of the template application. "a945675d-ccff-4ea3-afb4-8d04ac3100c2" no-check-service-overwrite 否 boolean true false false does not check whether data source conflicts exist in the current configuration true trans-id 否 string 0~128个字节。 - the identifier of the user transaction. "a945675d-ccff-4ea3-afb4-8d04ac3189c2"

请求示例 HTTP的示例 POST /operations/huawei-nce-aoc-config-template-application:submit-template-application Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "input": { "template-application-id": {{app-id}}, "no-check-service-overwrite": true } }

响应参数 返回状态码为200：Successful operation 表4 submit-template-application-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template-application:output REFERENCE 详细请参见表5。 - - 表5 submit-template-application-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-task ARRAY_REFERENCE 详细请参见表6。 list template task. - 表6 submit-template-application-output-body-template-task对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 task-id string 0~128个字节。 - task id get from taskmgr. "a945688d-ccff-4ea3-afb4-8d04ac3123c2" 返回状态码为400：Bad Request 详细信息请参见实际响应消息体。

请求示例 HTTP示例1 POST /restconf/v1/data/huawei-ac-applications:applications HTTP/1.1 Host: {ip:port} Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 HTTP示例2 POST /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/8d394835-cb84-38f3-a4d5-36a7f2074b47 Host: {ip:port} Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 body示例 { "bngBngPairs:bngBngPairs": [ { "bngBngPairsName": "bngPair", "bngServiceName": "hbng_ins", "pairName": "LS01" } ] }

响应参数 返回状态码为200：编辑成功。 返回状态为400或500：编辑失败。 表2 错误码描述 Status Code Error Code Error Message Parameter 错误说明 500 0x00c80022 {0}下发转发器失败，“{1}”。 {0}：节点名称，“{1}”：详细原因。 下发转发器失败，请检查预配置；如果预配置正确，请根据对应设备的详细错误信息进行分析。 500 0x01600004 业务{0}分解的网元数据{1}存在冲突，请重新编辑。 {0}：业务名称，{1}，网元数据Path。 两个业务修改了同一个网元数据，并且数据不一致。 500 0x01600001 事务\"{0}\"已经过期，未下发的配置已经失效。 {0}：用户事务ID。 事务默认5天过期，或者该事务已经被提交。

请求参数 表1 参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 neId 否 string 1~255个字符 - 设备id。 xxx 否 string 1~255个字符 - 业务名称。北向API接口根据三方包中的YANG模型动态生成，生成的规则是URI通过“/”拼接三方包中YANG模型各层级节点。body示例中以bng业务为例，实际使用时以所使用的三方包的YANG模型为准，具体使用xxx订制URI的北向API清单请参考附录（可定制编程接口）

URI /restconf/v1/data/huawei-ac-applications:applications/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/[neId]/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/[neId]/{xxx} /restconf/v1/operations/{xxx} /restconf/v1/operations/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}

请求示例 HTTP的示例 { "id" : "00000000000000000000000000000000", "tunnelName" : "tunnel1", "masterTunnelIp" : "192.168.0.1", "slaveTunnelIp" : "192.168.0.2", "autoRestoreEnable" : true, "autoRestoreDelay" : 100, "vlanRanges" : "20,30-200,500", "dtlsType" : "disable", "backUpDtlsType" : "disable" }

响应示例 返回状态码为200：修改成功，结构体参见SiteTemplateAptunnelResponseDto。 HTTPS/1.1 200 OK Date: Thu,13 MAY 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "00000000000000000000000000000000", "tunnelName" : "tunnel1", "masterTunnelIp" : "192.168.0.1", "slaveTunnelIp" : "192.168.0.2", "autoRestoreEnable" : true, "autoRestoreDelay" : 100, "vlanRanges" : "20,30-200,500", "dtlsType" : "disable", "backUpDtlsType" : "disable" } ] }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ApTunnelDto 是 REFERENCE 详细请参见表3。 站点模板AP隧道配置参数，结构体参见ApTunnelDto。 - 表3 ApTunnelDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 string 32个字符。 - 隧道ID。 "00000000000000000000000000000000" tunnelName 是 string 1~35个字符。 - 隧道名称。取值范围：1~35个半角字符，不能以双引号开头或结尾且不能包含空格和问号。不支持修改。 "tunnel1" masterTunnelIp 是 string 7~15个字符。 - 主隧道IP。 "192.168.0.1" slaveTunnelIp 否 string 7~15个字符。 - 备隧道IP。 "192.168.0.2" autoRestoreEnable 否 boolean true false false 自动恢复。默认值为false。 true autoRestoreDelay 否 int32 [60-600] - 自动恢复延时。 100 vlanRanges 是 string 1~100个字符。 - 2-4094范围内的整数或段，多个整数或段间用“,”分割，最多可输入10组。且配置的隧道VLAN不能与管理VLAN相同，否则隧道VLAN不生效。 "20,30-200,500" dtlsType 否 string 1~20个字符。满足正则表达disable|psk|mandatory-cert。 - 主隧道传输层数据包安全协议。取值范围：disable---不配置、psk---秘钥、mandatory-cert---证书。 "disable" securityKey 否 password 1~64个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 主隧道认证秘钥，当传输层数据包安全协议选择psk时生效。取值范围：8~32个字符，至少包含大写字母、小写字母、数字或特殊字符中的两种，不能包含问号和空格。 "tunnelkey" backUpDtlsType 否 string 1~20个字符。满足正则表达disable|psk|mandatory-cert。 - 备隧道传输层数据包安全协议。取值范围：disable---不配置、psk---秘钥、mandatory-cert---证书。 "disable" backUpSecurityKey 否 password 1~64个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 备隧道认证秘钥，当传输层数据包安全协议选择psk时生效。取值范围：8~32个字符，至少包含大写字母、小写字母、数字或特殊字符中的两种，不能包含问号和空格。 "tunnelkey" backUpKeyInvalid 否 boolean true false false 备用密钥是否有效。默认值为false。 true keyInvalid 否 boolean true false false 主密钥是否有效。默认值为false。 true isForceOverride 否 boolean true false false 是否强制覆盖。默认为false。 true

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

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

请求示例 HTTP的示例 DELETE /restconf/data/huawei-nce-aoc-config-template-application:template-application/a945675d-ccff-4ea3-afb4-8d04ac3100c2/template/a926f75d-ccff-4ea3-afb4-8d04ac3100c2/variable/aoc-variable-name 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

响应示例 返回状态码为200：返回查询的配置文件变更信息 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF8 { "code": 0, "description": "enterprise.app.configfilemgr.openapi.configchange.success", "data": { "configChangeInfo": [{ "neDn": "657770f1-4b9b-3112-a9d3-57b31851163f", "changeTime": 1599135850363, "oldFile": "20200903202115R.cfg", "newFile": "20200903202357R.cfg", "fileType": "r", "added": null, "modified": null, "baseModified": null, "deleted": null, "addNum": 0, "modifyNum": 3, "deleteNum": 0 }], "curPage": 1, "totalPage": 1 } }

URI /rest/openapi/configfile/configchange 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 changeTime 是 int64 - - 起始时间（UTC时间，精确到毫秒），表示查询从该时间到现在的配置文件变更信息。 1598889600000 pageNo 是 int32 - - 指定从第几页开始返回查询结果集，从1开始 1 pageSize 是 int32 - - 每页大小，最小值为1，最大值为100。 10

请求示例 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/configfile/configchange?changeTime=1598889600000&pageNo=1&pageSize=10' HTTP的示例 GET /rest/openapi/configfile/configchange?changeTime=1598889600000&pageNo=1&pageSize=10 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 NorthCfgChangeResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - - 操作返回码（0：成功；非0：失败）。 0 description string - - 接口调用结果的描述信息。 "enterprise.app.configfilemgr.openapi.configchange.success" data REFERENCE 详细请参见表3。 配置文件变更信息 - 表3 NorthCfgChangeData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 configChangeInfo ARRAY_REFERENCE 详细请参见表4。 配置文件变更信息 - curPage int32 - - 当前页数 1 totalPage int32 - - 总页数 1 表4 NorthCfgChangeModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 neDn string - - 网元的唯一标识 "657770f1-4b9b-3112-a9d3-57b31851163f" changeTime int64 - - 变更时间（UTC时间，精确到毫秒） 1599135850363 oldFile string - - 变更前文件名称 "20200903202115R.cfg" newFile string - - 变更后文件名称 "20200903202357R.cfg" fileType string - - 备份文件类型，"r"：运行配置；“s”:启动配置 "r" added string - - 新增的命令 - modified string - - 修改的命令 - baseModified string - - 修改前的命令 - deleted string - - 删除的命令 - addNum int32 - - 新增的行数 0 modifyNum int32 - - 修改的行数 3 deleteNum int32 - - 删除的行数 0

配置NAT Server缺省模板（仅V600版本AR设备） 表1 ConfigNatServer模板参数解释 参数名称 类型 取值范围 参数解释 name String 1~255 NAT Server的名称。不建议使用空格或特殊字符，大小写敏感。 此字段创建后不可修改，修改此参数将导致配置下发失败。 global_vpn_name String 1~31 NAT Server的公网VPN。不建议使用空格或特殊字符，大小写敏感。 global_zone String 1~32 NAT Server的公网安全域。不建议使用空格或特殊字符，大小写敏感。 protocol enum 枚举值，区分大小写。具体取值如下： icmp：表示icmp协议。 tcp：表示tcp协议。 udp：表示udp协议。 ipv6：表示Ipv6封装。 gre：表示通用路由封装协议。 esp：表示封装安全载荷。 ah：表示验证头协议。 sctp：表示流控制传输协议。 承载的协议类型。 global_start_ip String IPv4地址，格式为点分十进制。 global_start_ip：公网起始IP。格式为IPv4类型或IPv6类型。 global_end_ip：公网结束IP。格式为IPv4类型或IPv6类型。 说明： “global_start_ip”和“global_end_ip”同时配置时，不能配置“global_start_port”和“global_end_port”。 global_end_ip String IPv4地址，格式为点分十进制。 global_start_port Integer 0~65535 global_start_port：公网起始端口。仅当协议类型为tcp或udp时，NAT Server支持配置端口号。 global_end_port：公网结束端口。仅当协议类型为tcp或udp时，NAT Server支持配置端口号。 global_end_port Integer 0~65535 inside_start_ip String IPv4地址，格式为点分十进制。 inside_start_ip：私网起始IP。格式为IPv4类型或IPv6类型。 inside_end_ip：私网结束IP。格式为IPv4类型或IPv6类型。 说明： “inside_start_ip”和“inside_end_ip”同时配置时，“inside_start_port”和“inside_end_port”不可同时配置。 inside_end_ip String IPv4地址，格式为点分十进制。 inside_start_port Integer 0~65535。 inside_start_port：私网起始端口。仅当协议类型为tcp或udp时，NAT Server支持配置端口号。 inside_end_port：私网结束端口。仅当协议类型为tcp或udp时，NAT Server支持配置端口号。 inside_end_port Integer 0~65535。 reverse_enable Boolean 布尔型，具体取值如下： true。 false。 NAT Server是否支持反向转换。 如果没有配置该字段，则默认生成正反向Server-map。 inside_vpn_name String 1~31 NAT Server的私网VPN。不建议使用空格或特殊字符，大小写敏感。 下发到设备的命令： nat server name [ vpn-instance vpn-instance-name1 ] [ zone zone-name ] [ protocol protocol-type ] global global-address [ global-address-end ] inside host-address [ host-address-end ] [ no-reverse ] [ vpn-instance vpn-instance-name2 ] 父主题： iMaster NCE-Campus内置缺省模板参数介绍

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template-binding:query-template-bindings-with-devices Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "input": { "template-binding-ids": ["bfa990a2-443b-4312-a94d-be4b584de5f9"], "device-ids": ["8d394835-cb84-38f3-a4d5-36a7f2074b77"] } }

响应参数 返回状态码为200：Successful operation 表4 query-template-bindings-with-devices-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template-binding:output REFERENCE 详细请参见表5。 - - 表5 query-template-bindings-with-devices-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-binding ARRAY_REFERENCE 详细请参见表6。 list template binding. - 返回状态码为400：Bad Request 详细信息请参见实际响应消息体。

响应示例 返回状态码为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-binding:output": { "template-binding": [ { "template-binding-id": "bfa990a2-443b-4312-a94d-be4b584de5f9", "template-binding-name": "1705300910474", "unbound-status": false, "template": [ { "template-id": "d9acd7df-d178-46b2-bac1-da56f034ba04", "template-name": "12" } ], "device": [ { "device-id": "c7f62b8a-b6a0-478b-ad88-933c7aab1bcf", "device-name": "apaas_test", "deploy-status": "un-deploy", "unbound-status": false, "deploy-last-version": true, "deploy-last-variable-version": false, "override-variable": false, "offline-mode": true } ] } ] } } 返回状态码为400：Bad Request 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/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 { "huawei-ac-application-template-north:output" : { "total": 0 "templates": [ { "template-name": "string", "description": "string", "template-dad-id": "string", "is-used": true } ] } }