华为云用户手册

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bgpRouteInfos 是 REFERENCE 详细请参见表2。 至多支持同一站点两个设备同时创建。 - 表2 BgpPublicPeerInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 peerInfos 否 ARRAY_REFERENCE 0-11个列表项，详细请参见表3。 BGP路由public peer信息。 - 表3 BgpPublicPeerInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 否 uuid - - 设备ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" peers 否 ARRAY_REFERENCE 0-8个列表项，详细请参见表5。 peer信息，删除时不可为空。 - addressFamilyGlobals 否 ARRAY_REFERENCE 0-1个列表项，详细请参见表23。 当前不支持该字段，后续扩展用。 -

响应参数 返回状态码为201：接口调用成功，响应体参考BgpRoutePublicPeerResponse。 表4 BgpRoutePublicPeerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-2个列表项，详细请参见表5。 BGP路由配置成功的信息。 - fail ARRAY_REFERENCE 0-2个列表项，详细请参见表6。 BGP路由配置失败的信息。 - 表5 BgpPublicPeerInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId uuid - - 设备ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" peers ARRAY_REFERENCE 0-8个列表项，详细请参见表28。 peer信息，删除时不可为空。 - addressFamilyGlobals ARRAY_REFERENCE 0-1个列表项，详细请参见表46。 当前不支持该字段，后续扩展用。 - 表6 FailBgpPublicPeerInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 BGP路由public peer信息列表。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为201：接口调用成功，响应体参考OverlayWanBgpPolicyResponse。 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" : { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515a7e6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7e6", "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "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 } } ] }, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "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

响应参数 返回状态码为201：接口调用成功，响应体参考OverlayWanBgpPolicyResponse。 表3 OverlayWanBgpPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表4。 Overlay WAN侧BGP路由信息。 - 表4 OverlayWanBgpPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vpnId uuid - - VPN ID，UUID格式，创建、修改、删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d515a7e6" siteId uuid - - 站点ID，UUID格式，创建、修改、删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d515a7e6" importRoutePolicy REFERENCE 详细请参见表31。 接收路由策略，其中FW不支持IPV6路由策略。importRoutePolicy和exportRoutePolicy不可同时为空。 - exportRoutePolicy REFERENCE 详细请参见表31。 发布路由策略，其中FW不支持IPV6路由策略。importRoutePolicy和exportRoutePolicy不可同时为空。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy 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 { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515a7e6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7e6", "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "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 } } ] }, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "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 } } ] } }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayWanBgpPolicy 是 REFERENCE 详细请参见表2。 Overlay WAN侧BGP路由信息。 - 表2 OverlayWanBgpPolicyInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid - - VPN ID，UUID格式，创建、修改、删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d515a7e6" siteId 否 uuid - - 站点ID，UUID格式，创建、修改、删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d515a7e6" importRoutePolicy 否 REFERENCE 详细请参见表8。 接收路由策略，其中FW不支持IPV6路由策略。importRoutePolicy和exportRoutePolicy不可同时为空。 - exportRoutePolicy 否 REFERENCE 详细请参见表8。 发布路由策略，其中FW不支持IPV6路由策略。importRoutePolicy和exportRoutePolicy不可同时为空。 -

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

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/ssh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/sshfirstenable 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 { "sshFirstTimeEnable" : true, "sshPnfFirstTimeEnable" : 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 { "errcode" : "0", "errmsg" : "", "data" : { "sshFirstTimeEnable" : true, "sshPnfFirstTimeEnable" : true } }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 SSH客户端首次认证免公钥开关参数体。 - 表3 SSHFirstEnableDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sshFirstTimeEnable 是 boolean true false false 用于标识SSH客户端首次认证免公钥开关是否打开。默认值为false。 true sshPnfFirstTimeEnable 否 boolean true false true 用于标识pnf设备SSH客户端首次认证免公钥开关是否打开。默认值为true。 true

响应示例 返回状态码为200：接口调用成功，响应体参考BgpRouteAdvanceResponse。 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", "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } ], "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", "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } } ] } 返回状态码为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/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 { "advanceConfigs" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } ] }

响应参数 返回状态码为200：接口调用成功，响应体参考BgpRouteAdvanceResponse。 表4 BgpRouteAdvanceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-2个列表项，详细请参见表3。 BGP路由配置成功的信息。 - fail ARRAY_REFERENCE 0-2个列表项，详细请参见表5。 BGP路由配置失败的信息。 - 表5 FailBgpAdvanceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 BGP路由高级信息列表。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bgpRouteInfos 是 REFERENCE 详细请参见表2。 至多支持同一站点两个设备同时更新。 - 表2 BgpAdvanceInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 advanceConfigs 是 ARRAY_REFERENCE 0-11个列表项，详细请参见表3。 BGP路由高级信息。 - 表3 BgpAdvanceInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID，UUID格式，更新时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 是 uuid - - 设备ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId 否 uuid - - tnpID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 uuid - - vpnID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" addressFamilyGlobals 否 ARRAY_REFERENCE 0-1个列表项，详细请参见表23。 BGP地址族全局配置。当前只支持ipv4-unicast。 -

响应示例 返回状态码为201：创建mac帐号成功，响应体参考DataMacDto。 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" : { "name" : "macAccountName", "description" : "mac test", "terminalMacs" : ["11-11-11-11-11-11","22-22-22-22-22-22"], "userGroupId" : "a7953ba5-2779-4fb4-aaf0-6f39fac19c5e", "roleIds" : ["a7953ba5-2779-4fb4-aaf0-6f39fac19c5e"], "email" : "xxx@example.com", "telephone" : "1xxxxxxxxxx", "validPeriodLong" : "1571710215000", "bindAccessInfo" : { "bindDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "G0/0/1", "vlan" : "3377" } ], "bindAccDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "G0/0/1", "vlan" : "3377" } ], "bindEsn" : "21500829352SH1903955,21500829352SH1903977", "bindIP" : "10.1.1.1,10.1.1.2" }, "fields" : [ { "customFieldId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359cb", "customFieldValue" : "aaa" } ], "supportDpsk" : false, "dpsk" : "", "id" : "d50a4732-f933-410b-88c0-7adf0ba59550", "userGroupPath" : "ROOT\\Guest" } } 返回状态码为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的示例 POST /controller/campus/v1/accountservice/mac 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 { "name" : "macAccountName", "description" : "mac test", "terminalMacs" : ["11-11-11-11-11-11","22-22-22-22-22-22"], "userGroupId" : "a7953ba5-2779-4fb4-aaf0-6f39fac19c5e", "roleIds" : ["a7953ba5-2779-4fb4-aaf0-6f39fac19c5e"], "email" : "xxx@example.com", "telephone" : "1xxxxxxxxxx", "validPeriodLong" : "1571710215000", "bindAccessInfo" : { "bindDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "G0/0/1", "vlan" : "3377" } ], "bindAccDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "G0/0/1", "vlan" : "3377" } ], "bindEsn" : "21500829352SH1903955,21500829352SH1903977", "bindIP" : "10.1.1.1,10.1.1.2" }, "fields" : [ { "customFieldId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359cb", "customFieldValue" : "aaa" } ], "supportDpsk" : false, "dpsk" : "" }

响应示例 返回状态码为200：绑定成功，响应体参考SitesInPrivacyOperOutput。 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" : "", "successSiteIds" : ["4b573916-11f3-4dd6-ba5b-ebf04c74dae8","cadc3289-184b-4ac9-9a8a-429bfe724011"], "failedSites" : [ { "siteId" : "cadc3289-184b-4ac9-9a8a-429bfe724011", "siteName" : "site1", "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

请求示例 HTTP的示例 POST /controller/campus/api/v1/terminal-privacy/b9b34988-0dff-4def-9e55-7bc0b3dc21b4/site/bind 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 { "siteIds" : ["4b573916-11f3-4dd6-ba5b-ebf04c74dae8","cadc3289-184b-4ac9-9a8a-429bfe724011"] }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nat-if:nat-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"

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

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-if:nat-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-nat-if:nat-if" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "if-name" : "GE0/0/3", "nat-enable" : 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

响应参数 返回状态码为200：查询成功，响应体参考QueryBuildingsResponse。 表2 QueryBuildingsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "error" data ARRAY_REFERENCE 详细请参见表3。 楼栋列表。 - 表3 BuildingDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 楼栋ID，格式UUID。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" name string - - 楼栋名称。 "N1" floorList ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 楼层列表。 - 表4 FloorDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 楼层ID，格式UUID。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" number string - - 楼层号。 "7" name string - - 楼层名称。 "F2" 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QueryBuildingsResponse。 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" : "error", "data" : [ { "id" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2", "name" : "N1", "floorList" : [ { "id" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2", "number" : "7", "name" : "F2" } ] } ] } 返回状态码为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 /controller/campus/v1/indoormapservice/sites/75ade72a-e7a9-4c81-8fca-894e7ca9c2c2/buildings 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：更新拓扑成功，响应体参考TopologyResponse。 TopologyResponse对象的参数列表，详细请参见表9。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考TopologyResponse。 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：更新拓扑成功，响应体参考TopologyResponse。 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" : "", "topology" : { "areas" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "area_1", "areaType" : "leaf", "topologyType" : "hub-spoke", "enableDynamicTunnel" : "", "gatewayIPv6Enable" : false, "hubWorkMode" : "with-interconnection", "isFullReplaceSite" : "", "siteAttachments" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "siteRoles" : [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}], "accessServiceHubs" : [ { "siteName" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "accessPriority" : 2 } ], "borderRelationShip" : { "activeBorderSiteId" : "00000000-0000-0000-0000-000000000000", "activeBorderSiteName" : "Site Name", "standbyBorderSiteId" : "00000000-0000-0000-0000-000000000000", "standbyBorderSiteName" : "Site Name" }, "enableHubLanConnect" : "" } ] } ] }, "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考TopologyResponse。 HTTP/1.1 202 Accepted 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

接口约束 1、该接口支持msp视图、租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、修改拓扑导致gateway角色变化（gateway角色丢失、gateway角色变化为其他类型 如border）时，如果此gateway已经配置的了vpn的路由策略，将会自动删除对应的路由策略。 3、若Topology中已有站点数超过100个，更新Topology处理耗时长，建议先规划好Topology部署，再增加站点。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology 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 { "areas" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "area_1", "areaType" : "leaf", "topologyType" : "hub-spoke", "enableDynamicTunnel" : "", "gatewayIPv6Enable" : false, "hubWorkMode" : "with-interconnection", "isFullReplaceSite" : "", "siteAttachments" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "siteRoles" : [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}], "accessServiceHubs" : [ { "siteName" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "accessPriority" : 2 } ], "borderRelationShip" : { "activeBorderSiteId" : "00000000-0000-0000-0000-000000000000", "activeBorderSiteName" : "Site Name", "standbyBorderSiteId" : "00000000-0000-0000-0000-000000000000", "standbyBorderSiteName" : "Site Name" }, "enableHubLanConnect" : "" } ] } ] }

响应示例 返回状态码为201：新增的站点模板内SSID配置信息，返回结构体参见SiteTemplateConfigSsidResponse。 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" : { "id" : "de5813f8ff1e41f5ba9c324da70b49ed", "name" : "Huawei-Guest", "pki" : "default", "tags" : [ { "name" : "testApTag" } ], "enable" : true, "timeTemplateId" : "2c3918cb-f0bd-44e3-963b-119870bfc779", "connectionMode" : "nat", "vlans" : [ { "vlanId" : 10, "vlanDesc" : "work" } ], "customVlans" : [ { "priority" : 0, "vlanId" : 10, "vlanDesc" : "work", "tags" : [ { "name" : "testApTag" } ] } ], "vlanMode" : "vlanId", "vlanPoolId" : "1e930b21-a307-45a9-96a2-f1443ca84f39", "vlanPoolName" : "vlanPool", "hidedEnable" : false, "autoOffTrackLinkEnable" : false, "arpCheckEnable" : true, "ipCheckEnable" : true, "dhcpStrictEnable" : false, "dhcpv6SlaacStrictEnable" : 0, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "gameSpeedUpEnable" : false, "relativeRadios" : 3, "relativeOnlyTwoRadios" : 3, "dtimInterval" : 1, "advertiseApNameSwitch" : true, "frequencyNavigation" : true, "maxUserNumber" : 64, "blackAndWhite" : { "bindingType" : 2, "terminalMacList" : [ "XX:XX:XX:XX:XX:XX" ], "terminalOUIList" : [ "02:02:01" ] }, "userSeparation" : false, "separationOption" : "disable", "userL2LanIsolate" : false, "staNetworkDetect" : true, "muMiMo" : true, "associationTimeout" : 5, "erSuSwitch" : true, "userFlowSyslogEnable" : false, "multiLinkOper" : false, "lay3RoamSwitch" : true, "suExtendedRangeSwitch" : false, "muRtsSwitch" : false, "muRtsThreshold" : 2347, "forbiddenOldTerminal" : false, "reachMaxSta" : 1, "igmpSnooping" : false, "multicast2Unicast" : "disable", "bcmcDenyAll" : false, "bonjourTransparent" : false, "powerSave" : false, "beacon2gRate" : "1Mbps", "beacon5gRate" : "6Mbps", "beacon6gRate" : "6Mbps", "sipPort" : 5060, "timeTemplateName" : "全天", "seaSwitch" : false, "overDsPrivate" : "disable", "ssidAuth" : { "mode" : "ppsk", "oweTransitionMode" : true, "transitionOpenSsid" : "de5813f8ff1e41f5ba9c324da70b49ed", "pskEncryptType" : "wpa2", "wepType" : "WEP40", "wepDefaultKey" : 0, "enableMacAuth" : false, "securityKey" : "", "saeEncryptType" : "", "saeSecurityKey" : "", "pskSaeEncryptType" : "", "pskSaeSecurityKey" : "", "securityKeyType" : "AES", "dot1xEncryptType" : "", "dot1xQuietPeriod" : 60, "dot1xQuietTimes" : 10, "macAutoBinding" : true, "macAuthMethod" : "", "escapeStrategy" : "noAuth", "escapeProfileName" : "escapeStrategy1", "escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c", "portal" : { "mode" : "portalThirdIndirect", "pushProtocol" : "https", "freeAuthEnable" : true, "authExpireUnit" : "day", "authExpire" : 10, "escapeStrategy" : 2, "escapeProfileName" : "escapeStrategy1", "escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c", "freeAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "freeAclTmplName" : "free-acl-name", "controllerPortalType" : "haca", "masterPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "masterPortalTmplName" : "", "bakPortalEnable" : false, "bakPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "bakPortalTmplName" : "", "authRedirectUrlCarryEnable" : false, "radiusEnable" : false, "radiusTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "radiusTmplName" : "", "fastPushEnable" : true, "portalPageId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "wechatUrlAuthEnable" : false, "weComAuthEnable" : false, "dingTalkEnable" : false, "normalEnable" : false, "registerEnable" : false, "registerExpire" : 2, "registerExpireUnit" : "hour", "userRegisterMaxAccessNumber" : 0, "userGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "smsAuthEnable" : false, "smsPasswordExpire" : 5, "smsPasswordExpireUnit" : "minute", "smsUserRegisterEnable" : false, "smsUserExpire" : 2, "smsUserExpireUnit" : "hour", "smsUserMaxAccessNumber" : 0, "smsUserGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "emailAuthEnable" : false, "passCodeEnable" : false, "oneKeyAuthEnable" : false, "anonymousEnable" : false, "socialMediaEnable" : false, "twitterEnable" : false, "sinaEnable" : false, "qqEnable" : false, "qrCodeAuthEnable" : false, "qrCodeRegisterEnable" : false, "googleEnable" : false, "accountingEnable" : false, "accountingExpire" : 15, "interconnectionMode" : "API", "userNameKey" : "用户", "passwordKey" : "", "urlMatchMode" : 0, "successUrlKey" : "", "authFailedUrlKey" : "", "logoutSuccessUrlKey" : "", "logoutFailedUrlKey" : "", "logoutUrlKey" : "", "radiusModelId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc" }, "radius" : { "radiusTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "radiusTmplName" : "test", "staticEnable" : false, "iconnectAccessEnable" : "", "autoReauthenTime" : "", "hacaEnable" : false }, "haca" : { "authComponentId" : "00000000-0000-0000-0000-000000000000", "authComponentIp" : "10.20.0.0", "bakAuthComponentId" : "00000000-0000-0000-0000-000000000000", "bakAuthComponentIp" : "10.20.0.0" } }, "vapBackupConfig" : { "vapBackupEnable" : false, "radiusBackupTmplId" : "cf23f275-01e6-4301-890e-407e1d78c53e", "rejectNewAccess" : false }, "ssidPolicy" : { "securityPolicy" : { "highReliableSliceAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "highReliableSliceAclTplName" : "test-slice-acl", "highReliableSliceAclTplIdIpv6" : "b90f8190-e12f-4323-95f3-4018309209c4", "highReliableSliceAclTplNameIpv6" : "test-slice-acl", "securityAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "securityAclTmplName" : "test-security-acl", "securityIPv6AclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "securityIPv6AclTmplName" : "test-security-acl", "ipsecAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "ipsecAclTmplName" : "test-ipsec-acl", "tcpAdjustMss" : 1380, "appTrafficAcls" : { "appTrafficAclList" : [ { "direction" : "inbound", "index" : 0, "dscp" : 1, "appTrafficAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "appTrafficAclName" : "test-tunnel-acl" } ] }, "tunnelAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "tunnelAclTmplName" : "test-tunnel-acl", "urlFilter" : { "enable" : true, "mode" : 1, "urls" : [ "" ], "hostNames" : [ "" ] }, "appsPolicys" : { "siteSaList" : [ { "appId" : 1, "type" : "app", "appType" : 1, "appName" : "test_name", "action" : "permit", "dscp" : 1, "car" : 1000 } ] } }, "ssidRateLimit" : { "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0" }, "terminalRateLimit" : { "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0", "timeRange" : [ { "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0" } ] }, "terminalDynamicRateLimit" : { "dynamicEnable" : false, "dynamicLimit" : 16 }, "ipv6Enable" : false, "ndTrustPort" : false }, "dot11r" : false, "overDs" : false, "reassociateTimeout" : 1, "serviceGuarantee" : "performanceFirst", "activeDullClient" : false, "wmmScene" : "default", "edcaClientConfigList" : [ { "accessCategory" : "acvo", "aifsn" : 10, "ecwmax" : 10, "ecwmin" : 10, "txoplimit" : 10 } ], "insertOption82Enable" : false, "option82" : { "circuitId" : { "connectorPattern" : "colon", "contentType" : "ap-mac", "format" : "ascii", "userDefinedText" : "xxx" }, "remoteId" : { "connectorPattern" : "colon", "contentType" : "ap-mac", "format" : "ascii", "userDefinedText" : "xxx" } }, "forwardMode" : "direct", "softgreProfileId" : "fbde1c5d-5b94-49e3-a912-48641015e45f", "configName" : "ssid-tmp-config-name", "phyProtection" : "security-priority" } } 返回状态码为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