华为云用户手册

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

请求示例 HTTP的示例 POST /controller/campus/ui/v2/sdwan/openapi/maintenance/cli/export HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/octerstream,application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy { "exportPassword" : "Example@123", "exportAll" : true, "siteIds" : [ "00000000-0000-0000-0000-000000000000" ], "deviceIds" : [ "00000000-0000-0000-0000-000000000000" ], "esns" : [ "AR500102390000000001" ] }

响应示例 返回状态码为200：导出成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误，响应体参考ExportCmdResponse。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "error", "errmsg" : "" } 返回状态码为500：系统内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：导出成功。 返回状态码为400：请求参数错误，响应体参考ExportCmdResponse。 表3 ExportCmdResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码，0表示成功，非0表示失败。 "error" errmsg string - - 错误信息。 "" 返回状态码为500：系统内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "huawei-nce-e-mpls:mpls" : { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "enable" : true, "lsr-id" : "10.1.1.1" } } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-mpls:mpls 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-mpls:mpls 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

响应参数 返回状态码为200：操作成功。 表3 mpls-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls:mpls REFERENCE 详细请参见表4。 全局MPLS配置参数。 - 表4 mpls对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 config-status string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态，对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态；不支持编辑，仅查询返回。 "configured-database-success" last-committed-time string 0~255个字符。 - 最后提交时间，该特性最后提交时间；不支持编辑，仅查询返回。 "2022-01-01 00:00:00" related-pkg-version string 0~255个字符。 - 包版本，插件包版本；不支持编辑，仅查询返回。 "1.0.1" edit-state string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态，对应运行状态、候选状态、取消部署状态、未部署状态；不支持编辑，仅查询返回。 "RUNNING" enable boolean true false false 使能。 true lsr-id string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - LSR ID，IPv4地址格式。 "10.1.1.1" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为201：新增StaticMac成功。 HTTP/1.1 201 Created Date: Sun,11 May 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" : { "macAddress" : "XX:XX:XX:XX:XX:XX", "vlanId" : 1, "interfaceName" : "GigabitEthernet0/0/1", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为201：新增StaticMac成功。 表4 ConfigStaticMacResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 - - 表5 StaticMacConfigDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 macAddress string 17个字符。 - mac地址，mac格式：XX:XX:XX:XX:XX:XX。 "XX:XX:XX:XX:XX:XX" vlanId integer [1-4094] - vlanId，在与mac进行绑定之前，需要将接口加入对应的VLAN。 1 interfaceName string 1~30个字符。 - 端口名称。 "GigabitEthernet0/0/1" id string 32个字符。 - MAC静态绑定配置ID。 "de5813f8ff1e41f5ba9c324da70b49ed" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/lswstaticmac/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/staticmac 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 { "macAddress" : "XX:XX:XX:XX:XX:XX", "vlanId" : 1, "interfaceName" : "GigabitEthernet0/0/1" }

URI /controller/campus/v1/networkservice/networkconfig/net/lswstaticmac/devices/{deviceId}/staticmac 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 MAC静态绑定配置的参数体。 - 表3 CreateStaticMacInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 macAddress 是 string 17个字符。 - mac地址，mac格式：XX:XX:XX:XX:XX:XX。 "XX:XX:XX:XX:XX:XX" vlanId 是 integer [1-4094] - vlanId，在与mac进行绑定之前，需要将接口加入对应的VLAN。 1 interfaceName 是 string 1~30个字符。 - 端口名称。 "GigabitEthernet0/0/1"

响应示例 返回状态码为200：更新成功返回。 HTTP/1.1 200 OK Date: Sun,11 May 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" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreBgpFamilyInfos" : [ { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1, "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ], "gwBgpFamilyInfos" : [ { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1, "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ] }, "fail" : [ { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreBgpFamilyInfos" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ], "gwBgpFamilyInfos" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ] } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：更新成功返回。 表4 BgpRouteAdvanceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success REFERENCE 详细请参见表3。 部署成功的BGP高级配置。 - fail ARRAY_REFERENCE 0-2个列表项，详细请参见表5。 BGP路由配置失败的信息。 - 表5 FailBgpFamilyInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vnId string 36个字符。 - VN标识 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" siteId string 36个字符。 - 站点标识 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" coreBgpFamilyInfos ARRAY_REFERENCE 0-16个列表项，详细请参见表6。 核心侧BGP地址组参数。 - gwBgpFamilyInfos ARRAY_REFERENCE 0-2个列表项，详细请参见表6。 网关侧BGP地址组参数。 - 表6 FailBgpFamilyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" deviceId string 0~64个字符。 - 设备名称 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /controller/campus/v1/lanwan/interconnection/route/bgp/bgp-advance-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 { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreBgpFamilyInfos" : [ { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1, "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ], "gwBgpFamilyInfos" : [ { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1, "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ] }

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-syslog:syslog-config/info-center-source 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "huawei-nce-e-syslog:info-center-source" : [ { "module-name" : "default", "channel-id" : 5, "enable-log" : "", "enable-log-level" : "", "enable-trap" : "", "enable-trap-level" : "" } ] } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：操作成功。 表3 info-center-source-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-syslog:info-center-source ARRAY_REFERENCE 详细请参见表4。 信息通道 - 表4 syslog-config-exactProperties-info-center-source对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 module-name string 1~31个字符。满足正则表达[^A-Z]*。 - 模块名称."1-31位小写字母或数字，如a-z或0-9，例如：default,其他特性在设备产品文档"日志参考"中可以查到设备当前支持的所有模块名称，如aaa、am，具体以设备产品文档为准。" "default" channel-id int64 [0-9] - 通道ID 5 enable-log boolean true false - 使能日志 - enable-log-level string emergencies alert critical error warning notification informational debugging - 使能日志级别 - enable-trap boolean true false - 使能Trap - enable-trap-level string emergencies alert critical error warning notification informational debugging debugging 使能Trap级别 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-syslog:syslog-config/info-center-source 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

安装云化设备 根据部署规划时的网络设备安装点位设计、设备间互联等信息，完成网络设备的硬件安装、连线、上电等操作，参见表1。 表1 硬件安装与布线任务一览表 任务 任务说明 参考链接 安装硬件设备 硬件设备安装需要遵循施工规范，常见的硬件施工规范有： 物理设备必须可靠接地。 物理设备谨慎搬运，要连带外纸箱或泡沫垫，不要裸机搬运。 所有光纤、网线、高速电缆和电源线分开布线，规范折弯有序捆扎。 所有光纤、网线和电源线需要考虑长度和传输距离是否能够满足环境的需求。 请单击以下设备名称，进入“硬件安装与维护指南”手册，查看对应设备款型的安装指导。 若无法找到，请在搜索框中输入设备款型查找安装指导。 AP 连接线缆 根据布线规划完成线缆连接，连接时注意按照规范在线缆两端打上标签。 设备配电、上电 请按照规划的配电参数和各个产品的产品文档来执行设备上电操作。 在租户网络现场，可以使用华为乾坤APP的“扫码上线”功能，将云化设备（AP）的SN录入华为乾坤云平台。

响应参数 返回状态码为200：查询成功，响应体参考QueryDynamicNatResponse。 表2 QueryDynamicNatResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码，0表示成功，非0表示失败。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 查询动态返回NAT结构体。 - 表3 QueryDynamicNatResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 totalRecords int32 [0-10000] - 返回数据总数。 1 data ARRAY_REFERENCE 0-10000个列表项，详细请参见表6。 动态NAT数组。 -

响应示例 返回状态码为200：查询成功，响应体参考QueryDynamicNatResponse。 HTTP/1.1 200 OK Date: Sun,11 May 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" : { "totalRecords" : 1, "data" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "natMode" : "EASY_IP", "startAddress" : "192.168.1.1", "endAddress" : "192.168.1.2", "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ] } }

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/nat/dynamicnat?vpnId=00000000-0000-0000-0000-000000000000&siteId=00000000-0000-0000-0000-000000000000&policyId=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

URI /controller/campus/v1/sdwan/policy/traffic/nat/dynamicnat 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 string 0~64个字符。 - VPN业务ID。 Overlay NAT，填写WAN虚拟网络ID； Underlay NAT，填写“UnderlayId”。 "00000000-0000-0000-0000-000000000000" siteId 是 string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" policyId 否 string 0~64个字符。 - 策略ID。 "00000000-0000-0000-0000-000000000000"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-mpls:mpls 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 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: Sun,11 May 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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

接口约束 该接口支持msp视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V和AR6700V子设备； 或者支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V-L款型。 该API可能会直接或间接影响现网业务运行，导致业务中断、关键数据丢失等，请谨慎操作！

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-mpls:mpls 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-traffic-behavior:traffic-behavior 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"