华为云用户手册

  • 响应示例 返回状态码为200:正常响应返回体。返回的VPN信息中仅包含对应的ID。 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" : [ { "name" : "vpn_1", "description" : "Default", "vpnNameInDevice" : "vpn_1", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ], "overlayHeadLength" : 36, "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "ipsecEncryption" : true, "enableIPv6" : true, "defaultVpn" : true, "vpnIndex" : 0, "deleteStatus" : true } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "name" : "vpn_1", "description" : "Default", "vpnNameInDevice" : "vpn_1", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ], "overlayHeadLength" : 36, "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "ipsecEncryption" : true, "enableIPv6" : true, "defaultVpn" : true, "vpnIndex" : 0, "deleteStatus" : true } } ] } 返回状态码为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:查询成功。 表2 TopoPlanQueryResDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "参数非法" data REFERENCE 详细请参见表3。 返回数据 - 表3 TopoPlanQueryModelDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 36个字符。 - 网络规划主键ID。 "bc1846c5-2eff-6d4d-2a2d-23dff3d12344" siteId uuid 36个字符。 - 站点ID。 "acc846c5-2fff-694d-2b2d-12dff3d1231a" tenantId string 32个字符。 - 租户ID。 "fbb684c80d37496fbafa4b06d5151e2e" progress integer [0-100] - 网络规划创建进度。取值范围0-100,100表示资源创建完成。 0 deviceCreationResult REFERENCE 详细请参见表4。 - - boardCreationResult REFERENCE 详细请参见表9。 - - linkCreationResult REFERENCE 详细请参见表12。 - - stackCreationResult REFERENCE 详细请参见表15。 - - mlagGroupCreationResult REFERENCE 详细请参见表18。 - - 表4 DeviceCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-500个列表项,详细请参见表5。 创建设备成功列表 - failedList ARRAY_REFERENCE 0-500个列表项,详细请参见表6。 创建设备失败列表 - 表5 TopoPlanDeviceDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 order int32 [0-500] - 设备序号 0 id uuid 36个字符。 - 设备id,UUID格式。 "813a76d4-6eec-4264-ae45-a6f261482b60" name string 1~64个字符。 - 设备名称。最多允许输入64个字符。设备名称不能重复。 "device1" esn string 0~40个字符。 - 设备ESN。10~40个字符,由英文字母和数字组成。如果“ESN”为空,则“设备名称”和“设备型号”为必填字段。如果“ESN”不为空,也推荐填写“设备型号”,否则可能添加失败。 "AA980106121234567893" type string 0~32个字符。 - 设备型号。 "S12704" deviceRole string 0~32个字符。满足正则表达^(CORE|Gateway|Gateway\+CORE|Gateway\+vRR|Firewall|ACC|AGG|WAC|AP|)$。 ACC 设备角色,取值:CORE|Gateway|Gateway+CORE|Gateway+vRR|Firewall|ACC|AGG|WAC|AP "ACC" description string 0~255个字符。 - 描述 "ACC1" stackName string 0~64个字符。 - 堆叠名称。(堆叠设备必填,非堆叠设备无需填写),不能包含“?”'、"?"或制表符TAB "ACC1" stackSlotId int32 [0-9] - (堆叠设备必填,非堆叠设备无需填写)盒式设备范围为0~9,框式设备范围为1~2,并且同一堆叠内的堆叠编号不重复。 1 stackPriority int32 [1-255] 100 堆叠优先级。(非必填)请输入数字,范围为1~255。如果堆叠设备此字段不填写,默认为100 2 wacEsn string 0~40个字符。 - WAC设备ESN。(非必填)由英文字母和数字组成。将Fit Ap设备与所填写的WAC ESN关联。 "AA980106121234567893" wacName string 0~64个字符。 - WAC设备名称。 "device1" mlagName string 0~64个字符。 - M-LAG组名称。(非必填) 1、相同MLAG组名称的设备,自动组成M-LAG设备组 2、DFS Group ID默认为1, 随机生成认证密码, 优先级随机取一台为150 3、成员口为双活模式。最多允许输入64个字符。 "mlag1" mlagMode string 0~20个字符。满足正则表达^(active-active|active-standby|)$。 - M-LAG模式,active-active / active-standby。 "active-active" mlagPriority int32 [1-255] - M-LAG优先级。 2 表6 DeviceCreationFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanDeviceDto REFERENCE 详细请参见表5。 设备创建失败信息 - 表7 Errcode对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 Errcode string 0~36个字符。 - 错误码 - 表8 Errmsg对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 Errmsg string 0~256个字符。 - 错误描述 - 表9 BoardCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-500个列表项,详细请参见表10。 创建单板成功列表 - failedList ARRAY_REFERENCE 0-500个列表项,详细请参见表11。 创建单板失败列表 - 表10 TopoPlanBoardDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 devId string 36个字符。 - 设备id,UUID格式。 "813a76d4-6eec-4264-ae45-a6f261482b60" deviceName string 1~64个字符。 - 设备名称。(必填)堆叠设备支持填写设备名称或堆叠名称。 "21500829352SH1904172" slotId string 0~8个字符。 - 堆叠编号,v5盒式设备为0-8,pnf盒式设备为1-9,框式设备为1-2。 "slot1/4" slotType string 1~12个字符。 - 单板型号。 "LSG7SRUEX500" 表11 BoardCreationFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanBoardDto REFERENCE 详细请参见表10。 创建单板失败信息 - 表12 LinkCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-2000个列表项,详细请参见表13。 创建链路成功列表 - failedList ARRAY_REFERENCE 0-2000个列表项,详细请参见表14。 创建链路失败列表 - 表13 TopoPlanLinkDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 order int32 [0-2000] - 设备链路序号 0 srcPortName string 1~30个字符。 - 上游设备物理端口号。设备真实存在的物理端口 "GigabitEthernet0/0/1" srcDevName string 1~64个字符。 - 上游设备名称。堆叠设备支持填写设备名称或堆叠名称。 "device1" srcEthTrunk string 0~14个字符。 - 上游设备端Eth-Trunk名称。(Eth-Trunk链路必填)Eth-Trunk1~1023之间的整数。当前接口是下行接口,除M-LAG Peer-Link与双主检测链路外,均默认开启Eth-Trunk自协商(单设备的Eth-Trunk不可重复使用) "Eth-Trunk1" srcEthPnpStartSwitchEnable boolean true false false 源EthTrunk PNP启动开关使能。 false dstPortName string 1~30个字符。 - 下游设备物理端口号。设备真实存在的物理端口 "GigabitEthernet1/0/1" dstDevName string 1~64个字符。 - 下游设备名称。(必填)最多允许输入64个字符。堆叠设备支持填写设备名称或堆叠名称。 "device2" dstEthTrunk string 0~14个字符。 - 下游设备端Eth-Trunk名称。(Eth-Trunk链路必填)Eth-Trunk1~1023之间的整数(单设备的Eth-Trunk不可重复使用) "Eth-Trunk2" dstEthPnpStartSwitchEnable boolean true false false 目的EthTrunk PNP启动开关使能。 false mlagLinkType string 0~24个字符。满足正则表达^(peer-link|member-link|dual-active-detect-link|)$。 - M-LAG链路类型。peer-link|member-link|dual-active-detect-link "peer-link" mlagIpPoolName string 0~32个字符。 - 双主检测链路IP资源池。(M-LAG链路类型为双主检测链路时必填)允许输入1~32位英文字母、数字或特殊符号(问号和空格除外) "pool1" mlagId string 0~12个字符。 - 上、下游端口M-LAG ID。(非必填)双归接入端口跨设备定义为相同的ID,M-LAG ID取值范围1-2048。上、下游值需用","分隔,同时指定。上下游端口M-LAG ID输入示例 "1,2", 指定上游端口M-LAG ID示例 "1" "1,2" 表14 LinkCreationFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanLinkDto REFERENCE 详细请参见表13。 创建链路失败信息 - 表15 StackCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-500个列表项,详细请参见表16。 创建堆叠成功列表 - failedList ARRAY_REFERENCE 0-500个列表项,详细请参见表17。 创建堆叠失败列表 - 表16 TopoPlanStackDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 36个字符。 - 堆叠设备id,UUID格式。 "813a76d4-6eec-4264-ae45-a6f261482b60" name string 1~64个字符。 - 堆叠设备名称。 "stack1" stackRole string 0~32个字符。 - 堆叠角色。 "CORE" stackMember ARRAY_REFERENCE 1-9个列表项,详细请参见表5。 堆叠成员信息。 - 表17 StackCreationFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanStackDto REFERENCE 详细请参见表16。 创建堆叠失败信息 - 表18 MlagGroupCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-500个列表项,详细请参见表19。 创建M-Lag组成功列表 - failedList ARRAY_REFERENCE 0-500个列表项,详细请参见表20。 创建M-Lag组失败列表 - 表19 TopoPlanMlagGroupDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 36个字符。 - M-Lag组id。 "18f461fa-4f1b-3e2b-90e4-f3d29d0dcf9b" name string 0~64个字符。 - M-Lag组名称。 "mlag1" groupId int32 [1-2048] - M-LAG ID 1 mode string 0~20个字符。满足正则表达^(active-active|active-standby|)$。 - M-LAG模式,active-active / active-standby。 "active-active" mlagMember ARRAY_REFERENCE 0-6个列表项,详细请参见表5。 M-LAG成员 - 表20 TopoPlanMlagGroupFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanMlagGroupDto REFERENCE 详细请参见表19。 创建M-LAG失败信息 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /v1/networkservice/sites/f3a4f7d3-2f1e-4b2a-9f4c-1c2d2a4e5b6c/topo-plans/bc1846c5-2eff-6d4d-2a2d-23dff3d12344 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
  • URI /v1/networkservice/sites/{siteId}/topo-plans/{id} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid 36个字符。 - 站点id "f3a4f7d3-2f1e-4b2a-9f4c-1c2d2a4e5b6c" id 是 uuid 36个字符。 - 网络规划创建时的id "bc1846c5-2eff-6d4d-2a2d-23dff3d12344"
  • 响应示例 返回状态码为200:查询LACP LAG信息成功,响应体参考LacpLagInfoResultDto。 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" : { "ethtrunk" : [ { "lagId" : 1, "mode" : "lacp", "hash" : "diffluence", "leastActive" : 20, "maxActive" : 64, "opStatus" : "up", "portCount" : 10, "sysPrio" : 10, "sysId" : "xx:xx:xx:xx:xx:xx", "interfaces" : [ { "ifId" : 1, "ifName" : "interface 0/0/1", "remPrio" : 10, "remId" : "xx:xx:xx:xx:xx:xx", "ifOpStatus" : "up", "ifWeight" : 30 } ] } ] } }
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkresource/topomanager/device/d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0/ethtrunk 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:查询LACP LAG信息成功,响应体参考LacpLagInfoResultDto。 表2 LacpLagInfoResultDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误描述。 "" data REFERENCE 详细请参见表3。 - - 表3 data对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ethtrunk ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 Eth-trunk数据。 - 表4 EthTrunkDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 lagId integer - - LAG ID。 1 mode string - - trunk模式:lacp、manual。 "lacp" hash string - - 端口负载均衡的hash算法:dst-ip、dst-mac、src-ip、src-mac、src-dst-ip、src-dst-mac、enhanced、diffluence。 "diffluence" leastActive integer - - Eth-trunk中活动链路数量的下限。 20 maxActive integer - - 最大激活链路数。 64 opStatus string - - 操作状态:up、down。 "up" portCount integer - - Eth-trunk上行端口数量。 10 sysPrio integer - - 本地系统优先级。 10 sysId string - - 本地系统ID。 "xx:xx:xx:xx:xx:xx" interfaces ARRAY_REFERENCE 0-1000个列表项,详细请参见表5。 接口列表。 - 表5 EthTrunkInterfacesDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ifId integer - - 接口ID。 1 ifName string - - 接口名称。 "interface 0/0/1" remPrio integer - - 远端系统优先级。 10 remId string - - 远端系统ID。 "xx:xx:xx:xx:xx:xx" ifOpStatus string - - 接口操作状态:up、down。 "up" ifWeight integer - - 接口负载的权重。 30
  • URI /controller/campus/v1/networkresource/topomanager/device/{deviceId}/ethtrunk 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID,UUID格式。 "d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0"
  • 响应示例 返回状态码为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
  • 请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-global 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" { "huawei-nce-e-dhcpv4:dhcpv4-global" : { "enable" : false, "option82" : { "global-formats" : { "global-format" : [ { "sub-option-type" : "remote-id", "option82-format" : "user-defined", "user-defind-text" : "77" } ] }, "encapsulation" : { "suboption" : "circuit-id remote-id subscriber-id vendor-specific-id" } } } }
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:dhcpv4-global 是 REFERENCE 详细请参见表4。 全局DHCP配置。 - 表4 dhcpv4-global-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:dhcpv4-global 否 REFERENCE 详细请参见表5。 全局DHCP配置。 - 表5 dhcpv4-global-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能全局DHCP。 false option82 否 REFERENCE 详细请参见表6。 配置DHCP option82特性。AR6700V主设备和AR6700V子设备不支持。 - 表6 option82-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global-formats 否 REFERENCE 详细请参见表7。 Option82全局格式列表。 - encapsulation 否 REFERENCE 详细请参见表9。 配置DHCP Option82域子选项。 - 表7 global-formats-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global-format 否 ARRAY_REFERENCE 详细请参见表8。 配置DHCP Option82全局模式。 - 表8 global-formats-global-format-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sub-option-type 是 string circuit-id remote-id circuit-remote - DHCP option82全局子选项类型,单一主键字段。 "remote-id" option82-format 否 string common extend user-defined default type1 type2 self-define default-extra cn-telecom self-define-extra intracom-vxlan cn-telecom-inherit - DHCP option82子选项格式类型。 "user-defined" user-defind-text 否 string 0~255个字符。满足正则表达([^ ]{0,})。 - 用户定义DHCP Option82格式。关键词包含: sysname, portname, porttype, iftype, mac, slot, subslot, port, sVLAN, cVLAN,和length.可进行如下配置: '%portname:%sVLAN.%cVLAN %sysname/0/0/0/0/0' 或 0 %length %sVLAN %5slot %3subslot %8port 等等。请参考用户操作手册获取更多信息。 "77" 表9 encapsulation-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 suboption 否 string - - 配置DHCP Option82域子选项。 "circuit-id remote-id subscriber-id vendor-specific-id"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:dhcpv4-global 表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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ipv4-urpf:ipv4-urpf 表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"
  • 请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ipv4-urpf:ipv4-urpf 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 /controller/sdwan/v1/naas/device 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 { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000" }
  • 响应示例 返回状态码为201:创建成功返回。 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" : "" } 返回状态码为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:查询子组织成功,响应体参考GetSubOrgOut。 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" : "", "subOrgs" : [ { "orgId" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "path" : "/org1/org2", "level" : "2" } ] }
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/organization/id/sub-org?id=b473118d-17ff-4f4f-9fa9-a4c0e1e87e42 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的示例 POST /controller/campus/v1/sdwan/policy/traffic/escape/qos-policies 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 { "qosPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "271ccbca-138c-4dee-aae5-c98e9296074c", "siteName" : "hub", "policyName" : "qos1", "priority" : 1, "trafficTemplateId" : "00000000-0000-0000-0000-000000000000", "trafficTemplateName" : "qosClassificationName", "wanQosProfileId" : "00000000-0000-0000-0000-000000000000", "wanQosProfileName" : "templateName" } ] }
  • 响应示例 返回状态码为201:创建成功,响应体参考EscapeQosPolicyResponse。 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" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "271ccbca-138c-4dee-aae5-c98e9296074c", "siteName" : "hub", "policyName" : "qos1", "priority" : 1, "trafficTemplateId" : "00000000-0000-0000-0000-000000000000", "trafficTemplateName" : "qosClassificationName", "wanQosProfileId" : "00000000-0000-0000-0000-000000000000", "wanQosProfileName" : "templateName" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "271ccbca-138c-4dee-aae5-c98e9296074c", "siteName" : "hub", "policyName" : "qos1", "priority" : 1, "trafficTemplateId" : "00000000-0000-0000-0000-000000000000", "trafficTemplateName" : "qosClassificationName", "wanQosProfileId" : "00000000-0000-0000-0000-000000000000", "wanQosProfileName" : "templateName" } } ], "processInstanceId" : "" } 返回状态码为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(渠道服务商)已帮您代建华为乾坤租户账号,请跳转到步骤3。登录控制台后,建议您立即修改密码并签署隐私政策和华为乾坤云服务协议。 在登录页面单击“立即注册”。 图1 控制台登录页(区域一) 查看资源调整公告,如图2所示。 由于当前控制台所属“区域一”资源不足,对于新注册用户场景有如下调整: 新注册云管理网络服务的用户时,需要参考图2根据页面提示跳转到“区域二”进行注册并登录,具体参见2.c。 新注册安全云服务的用户时,需要通过邮箱huaweiqiankun@huawei.com联系工作人员进行注册,注册成功后可继续在“区域一”进行登录。 图2 华为乾坤资源调整及新用户注册指南 在“区域二”新注册云管理网络服务用户。 在“区域二”首页单击右上角“注册”按钮,或单击右上角“登录”按钮后单击“立即注册”,页面弹出“注册”窗口,如图3所示,输入用户名、密码等信息后进行注册并登录。 为提高安全性,密码设置要求如下,如果设置的密码不符合要求,请按照界面提示修改: 字符串形式,长度不小于8个字符,不超过32个字符。 至少包含1个字母和1个数字。 不能含用户名、用户手机号码和电子邮箱等敏感信息。 不建议使用密码强度低或常见的密码。 图3 注册云管理网络服务用户 “用户名”和“密码”是用于登录控制台的账号信息。此账号相当于一级租户管理员,登录后还可以继续创建下级租户,进行分权分域管理;“租户名”相当于一个企业或客户名称。 注册成功后您将自动登录到华为乾坤控制台,同时您的注册手机号码将收到注册账号信息。 登录华为乾坤控制台。 图4 登录华为乾坤控制台(区域二) 账号密码登录:在控制台登录页面输入“用户名/手机号”和“密码”后单击“登录”。 验证码登录:在控制台登录页面单击“验证码登录”并输入“手机号”和“验证码”后单击“登录”。若该手机号码未注册过华为乾坤,则无法直接登录,需要先注册再登录。 注册并登录控制台即可免费使用云管理网络的基础纳管功能,如设备注册、配置下发、准入认证、设备基础监控和设备升级功能。 通过“区域一”注册的存量用户,只能登录区域一控制台;通过“区域二”新注册的用户,只能登录区域二控制台。 请牢记注册的华为乾坤账号和密码,避免无法登录。 如果连续5次登录失败,界面会自动锁定(禁止登录)10分钟。 登录后不进行任何操作,30分钟后该账号将自动登出。
  • 注册华为坤灵账号 华为坤灵账号用来登录华为坤灵APP。华为坤灵APP是一款专门为工程商伙伴打造的一站式平台,在办公或家庭等小型网络场景下使用,该APP聚合了工程商所需的设备开局、远程维护、产品资讯、报价工具、场景化方案、营销物料等功能和内容。 下载坤灵APP。主要通过如下方式下载: 方式一:在华为应用市场搜索“华为坤灵”(iOS系统用户在APP Store搜索),按提示进行下载。 方式二:可通过网页浏览器的扫码功能,扫描图5所示的二维码进行下载。 图5 华为坤灵APP下载二维码 当前,iOS系统不支持华为坤灵APP的开局运维功能。 注册账号。在华为坤灵APP界面点击“注册”,可以选择使用手机号注册或者使用邮箱注册。默认使用手机号注册。 使用手机号注册。按页面提示输入相关信息,并勾选我已阅读并同意《华为公司用户注册协议》和《隐私声明》,点击“注册”完成账号注册。 使用邮箱注册。在注册页面选择“使用邮箱注册”,按页面提示输入相关信息,并勾选我已阅读并同意《华为公司用户注册协议》和《隐私声明》,点击“注册”完成账号注册。
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/dhcpv6/bfd 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 { "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "tnpId" : "00000000-0000-0000-0000-000000000000", "minRxInterval" : 100, "detectMultiplier" : 3 } ] }
  • 响应示例 返回状态码为200:修改BFD for DHCPv6返回体,参考BfdResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "tnpId" : "00000000-0000-0000-0000-000000000000", "minRxInterval" : 100, "detectMultiplier" : 3 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "tnpId" : "00000000-0000-0000-0000-000000000000", "minRxInterval" : 100, "detectMultiplier" : 3 } } ] } 返回状态码为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
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nqa:nqa 是 REFERENCE 详细请参见表4。 NQA配置参数。 -
  • 请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nqa:nqa/TestName 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" { "huawei-nce-e-nqa:nqa" : { "test-name" : "TestName", "type" : "ipv4", "ipv4-dest-address" : "192.168.1.1", "ipv4-next-hop" : "192.168.1.2", "ipv6-dest-address" : "FC00::1101", "ipv6-next-hop" : "FC00::1102", "out-if-name" : "GE0/0/1", "vpn-instance" : "_public_", "probe-count" : 5, "interval" : 4, "timeout" : 3, "frequency" : 22, "data-size" : 0, "ttl" : 30, "tos" : 0, "send-trap-bits" : "resultchange", "execution-switch" : true } }
  • 响应示例 返回状态码为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
  • 响应示例 返回状态码为201:设置站点时区成功,响应体参考SiteApiResponse。 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" : "", "success" : [ "a99f794e-b510-438c-a75d-de59f02347eb" ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : "a99f794e-b510-438c-a75d-de59f02347eb" } ], "processInstanceId" : "" } 返回状态码为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的示例 PUT /controller/campus/v1/sdwan/net/site/timezone 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 { "siteTimeZones" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : false, "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } } } ] }
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全