华为云用户手册

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 aclPolicy 是 REFERENCE 详细请参见表2。 设备基础ACL信息。 - 表2 BasicACLPolicyInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid 0~36个字符。 - 站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid 0~36个字符。 - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" aclNum 是 int32 [2000-2999] - ACL编号，同一设备的IPv4和IPv6的ACL编号不能相同。 2100 type 否 string 0~8个字符。 IPv4 基础ACL类型，该字段可以设置为以下几种： a) IPv4 b) IPv6 默认为IPv4。 "IPv4" ruleList 是 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 ACL规则列表。配置ACL必须配置规则。 - 表3 ACLRule对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ruleId 是 int64 [0-4294967294] - 基础ACL规则优先级。 10 operateType 是 int32 [1-2] - 操作类型，取值范围：1---允许、2---拒绝。 1 ipRange 是 string 0~150个字符。 - IP地址范围，支持IPv4和IPv6，格式：IP地址/掩码或Any。其中IPv4的掩码范围为0-32，IPv6的掩码范围为1-128。若需要配置全地址（即IPv4掩码为0、IPv6前缀为0），可以输入“Any”（不区分大小写）。 IPv4地址如：192.168.1.1/16； IPv6地址如：fc22::1010/64。 "192.168.1.1/16"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/acl/basic 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 { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] }

响应示例 返回状态码为200：接口调用成功，响应体参考Ipv6BgpRoutePeerResponse。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "Ipv6PeerIp" : "fc00::1101", "localIp" : "fc00::1102", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "addressFamilys" : [ { "familyType" : "ipv6-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv6Address" : "fc00::1", "maskLength" : 64, "greaterEqual" : 64, "lessEqual" : 64 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv6Address" : "fc00::1", "maskLength" : 64, "greaterEqual" : 64, "lessEqual" : 64 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ] } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "Ipv6PeerIp" : "fc00::1101", "localIp" : "fc00::1102", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "addressFamilys" : [ { "familyType" : "ipv6-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv6Address" : "fc00::1", "maskLength" : 64, "greaterEqual" : 64, "lessEqual" : 64 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv6Address" : "fc00::1", "maskLength" : 64, "greaterEqual" : 64, "lessEqual" : 64 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ] } ] } } ] } 返回状态码为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/routing-protocol/ipv6bgp-peer-info 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 { "peerInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "Ipv6PeerIp" : "fc00::1101", "localIp" : "fc00::1102", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "addressFamilys" : [ { "familyType" : "ipv6-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv6Address" : "fc00::1", "maskLength" : 64, "greaterEqual" : 64, "lessEqual" : 64 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv6Address" : "fc00::1", "maskLength" : 64, "greaterEqual" : 64, "lessEqual" : 64 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ] } ] } ] }

响应示例 返回状态码为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-direct-route-vlink:vlink-if/GE0%2F0%2F3 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-direct-route-vlink:vlink-if" : { "if-name" : "GE0/0/3", "vlink-route" : [ { "address-family" : "ipv4uni" } ], "vlink-configuration" : { "preference" : 233 } } }

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-direct-route-vlink:vlink-if 是 REFERENCE 详细请参见表4。 ARP Vlink直连路由。 -

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-direct-route-vlink:vlink-if/{if-name} 表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" if-name 是 string 1~63个字符。 - interface name "GE0/0/3"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/site/inter/connect/ipsec/tunnel 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 { "ipsecTunnelInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "securityZone" : "underlay_untrust" } ] }

响应示例 返回状态码为201：接口调用成功，响应体参考IpsecTunnelResponse。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "securityZone" : "underlay_untrust" } ] } 返回状态码为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：接口调用成功，响应体参考IpsecTunnelResponse。 表4 IpsecTunnelResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表5。 成功添加或更新的Ipsec Tunnel配置。 - 表5 IpsecTunnelInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 0~64个字符。 - 对应站点的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId string 0~64个字符。 - 对应设备的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" id string 0~64个字符。 - Ipsec Tunnel ID,更新,删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" tunnelPortName string 0~128个字符。 - Ipsec Tunnel端口名，不能重复。创建时必填。 "Tunnel0/0/400" wanLinkId string 0~64个字符。 - Wan链路的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId string 0~64个字符。 - 业务VPN ID，和Wan链路的ID二选一。 FW网关不支持配置此项。 "00000000-0000-0000-0000-000000000000" ipAddress string 0~64个字符。 - Ipsec隧道IP地址。创建时必填。 "192.168.0.1/24" srcIpAddress string 0~64个字符。 - Ipsec隧道源IP地址。创建时必填。 "192.168.1.1" srcType string 0~32个字符。 - 源接口类型，可选值：IP、WanLink、LoopBack。 "IP" srcInterfaceId string 0~64个字符。 - 源接口Id，对应LOOPBACK ID或者WANLINK ID；与SRCIPADDRESS二选一。 "00000000-0000-0000-0000-000000000000" dstIpAddress string 0~64个字符。 - Ipsec隧道目的IP地址。创建时必填。 "192.168.1.2" ipsecProfileId string 0~64个字符。 - IPSec模板ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" mtu int32 [46-9600] 1500 MTU，取值范围：46-9600，默认1500。 1500 TCPmss int32 [230-2048] 1200 TCP MSS, 取值范围：230-2048，默认1200，建议MSS的值≤MTU的值-40。 FW网关设备不支持配置此项。 1200 securityZone string 0~32个字符。 underlay_untrust 安全域，取值范围：underlay_untrust、自定义安全域。 FW网关设备IPSec隧道必须指定安全域。 非FW网关设备IPSec隧道不支持指定安全域。 "underlay_untrust" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipsecTunnelRequest 是 REFERENCE 详细请参见表2。 创建Ipsec Tunnel配置请求数据。 - 表2 IpsecTunnelRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipsecTunnelInfos 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 Ipsec Tunnel列表。 - 表3 IpsecTunnelInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 0~64个字符。 - 对应站点的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 否 string 0~64个字符。 - 对应设备的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" id 否 string 0~64个字符。 - Ipsec Tunnel ID,更新,删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" tunnelPortName 否 string 0~128个字符。 - Ipsec Tunnel端口名，不能重复。创建时必填。 "Tunnel0/0/400" wanLinkId 否 string 0~64个字符。 - Wan链路的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 string 0~64个字符。 - 业务VPN ID，和Wan链路的ID二选一。 FW网关不支持配置此项。 "00000000-0000-0000-0000-000000000000" ipAddress 否 string 0~64个字符。 - Ipsec隧道IP地址。创建时必填。 "192.168.0.1/24" srcIpAddress 否 string 0~64个字符。 - Ipsec隧道源IP地址。创建时必填。 "192.168.1.1" srcType 否 string 0~32个字符。 - 源接口类型，可选值：IP、WanLink、LoopBack。 "IP" srcInterfaceId 否 string 0~64个字符。 - 源接口Id，对应LOOPBACK ID或者WANLINK ID；与SRCIPADDRESS二选一。 "00000000-0000-0000-0000-000000000000" dstIpAddress 否 string 0~64个字符。 - Ipsec隧道目的IP地址。创建时必填。 "192.168.1.2" ipsecProfileId 否 string 0~64个字符。 - IPSec模板ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" mtu 否 int32 [46-9600] 1500 MTU，取值范围：46-9600，默认1500。 1500 TCPmss 否 int32 [230-2048] 1200 TCP MSS, 取值范围：230-2048，默认1200，建议MSS的值≤MTU的值-40。 FW网关设备不支持配置此项。 1200 securityZone 否 string 0~32个字符。 underlay_untrust 安全域，取值范围：underlay_untrust、自定义安全域。 FW网关设备IPSec隧道必须指定安全域。 非FW网关设备IPSec隧道不支持指定安全域。 "underlay_untrust"

响应示例 返回状态码为200：修改AP站点模板IPV6开关配置的消息返回体。 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" : { "ipv6Enable" : false } } 返回状态码为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

请求示例 HTTP的示例 PUT /controller/campus/v3/networkconfig/site-templates/fbb684c8-0d37-496f-bafa-4b06d5151e2e/ipv6 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 { "ipv6Enable" : false }

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

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 IPV6开关配置。 - 表3 Ipv6Configs对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv6Enable 是 boolean true false false IPV6业务开关。默认值为false。 false

响应示例 返回状态码为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" : "", "total" : 10, "pageIndex" : 1, "data" : [ { "deviceId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "esn" : "AP50082935AAAAAAAAA1", "mac" : "1324-4567-6789", "deviceModel" : "AP6050DN", "siteId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "status" : 0, "apId" : 1, "illegalStatus" : 1 } ] }

URI /controller/campus/v1/networkservice/networkconfig/net/wac/{acId}/fitaps 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 acId 是 string - - WAC设备ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageSize 是 integer [1-100] - 分页的大小。 20 pageIndex 是 integer [1-300000] - 分页的序号。 1

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/wac/fbb684c8-0d37-496f-bafa-4b06d5151e2e/fitaps?pageSize=20&pageIndex=1 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：查询成功。 表3 WACFitQueryResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" total int32 - - 总的数据条数。 10 pageIndex int32 - - 当前页。 1 data ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 Fit AP设备信息的数据结构。 - 表4 FitApInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string - - Fit AP设备ID。 "fbb684c8-0d37-406f-bafa-4b06d6151e2e" esn string - - Fit AP设备ESN。 "AP50082935AAAAAAAAA1" mac string 0~14个字符。 - Fit AP设备MAC。 "1324-4567-6789" deviceModel string - - Fit AP设备型号。 "AP6050DN" siteId string - - Fit AP设备归属的站点ID。 "fbb684c8-0d37-406f-bafa-4b06d6151e2e" status int32 - - 设备状态。0---正常、1---告警、3---离线、4---未注册。 0 apId int64 - - 给Fit AP设备分配的ID。 1 illegalStatus int32 - - 设备异常状态。0---合法、1---未纳管、2---不在AC组内。 1

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-l3-sub-interface:l3-sub-interface 是 REFERENCE 详细请参见表4。 l3 sub interface parameters -

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-l3-sub-interface:l3-sub-interface/Vbdif20.20 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-l3-sub-interface:l3-sub-interface" : [ { "config-status" : "", "last-committed-time" : "", "related-pkg-version" : "", "edit-state" : "", "if-name" : "Vbdif20.20", "dot1q-vlans" : { "vlan-list" : "20" }, "vlan-type-dot1q" : { "vlan-type-vid" : 20 } } ] }

响应示例 返回状态码为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-l3-sub-interface:l3-sub-interface/{if-name} 表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" if-name 是 string 1~63个字符。 - Interface name "Vbdif20.20"

响应示例 返回状态码为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-cli:command-aliases 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-cli:command-aliases" : { "command-alias" : [ { "alias" : "test1", "command" : "test2", "parameter" : "$test3" } ] } }

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-cli:command-aliases 是 REFERENCE 详细请参见表4。 别名配置参数。 - 表4 command-aliases-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-cli:command-aliases 否 REFERENCE 详细请参见表5。 别名配置参数。 - 表5 command-aliases-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 command-alias 否 ARRAY_REFERENCE 0-200个列表项，详细请参见表6。 别名实例。 - 表6 command-aliases-command-alias-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 alias 否 string 1~63个字符。满足正则表达[a-zA-Z][a-zA-Z0-9-]*。 - 指定别名。必填，支持大、小写字母，数字及连字符"-"，字母开头，不区分大小写，字符间不能有空格。别名定义出现循环嵌套或嵌套层次超过16层时，该别名节点无效，不会用于进行字符串替换。单一主键字段。 "test1" command 否 string 1~511个字符。满足正则表达[^?]+。 - 指定别名命令行。必填，不支持英文问号，如果字符之间有空格，则字符串外必须使用双引号。指定别名参数配置后，必须在指定别名命令行里面包含进去。例如参数包含$a，则命令行格式应该为$a，"$a"，"xxx $a"，"xxx $a $xx"这样的形式。多个$参数必须连续保持在最后。 "test2" parameter 否 string 2~511个字符。 - 指定别名参数。支持大、小写字母，数字及连字符"-"，必须以"$"符号开头，不区分大小写，取值范围是2～63，最多支持32个参数，参数之间以空格进行分隔。指定别名命令行配置后，必须在指定别名参数里面定义。例如命令行格式为$a，"$a"，"xxx $a"，"xxx $a $xx"这样的形式，则指定别名参数必须包含$a。 "$test3"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-cli:command-aliases 表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 { "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 1, "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e451", "name" : "siteTemplate1", "type" : "lsw", "devices" : 1, "organizationName" : "lsw" } ] } 返回状态码为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 /controller/campus/v1/networkservice/networkconfig/site-template-binding-relationship/{siteTemplateId}/sites 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板ID，UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e451" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageSize 否 int32 [0-1000] - 每页大小，默认值为20。 20 pageIndex 否 int32 [0-1000] - 页码。 1 sort 否 string 0~32个字符。 - 排序字段，支持name。 "name"