华为云用户手册

响应示例 返回状态码为200：接口调用成功，响应体参考NetworkOrchestrationResourcesResponse。 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" : { "vpnType" : "bgp-evpn", "networkOrchestrationResources" : { "bgpAsNum" : 65001, "communityPool" : [1,2], "interlinkProtocolType" : "ospf", "communityPoolStatus" : 1, "siteScale" : "1000+", "dsvpnIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "evpnIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "innerTunnelIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "interConnectIPpool" : "192.168.1.0/26", "evpnIpv6Pool" : ["2100::/96","2200::/96"], "innerTunnelIpv6Pool" : ["fd00::/96","fd10::/96"], "interConnectIpv6Pool" : "fd01::/96", "linkLocalIPV6pool" : "fe80::/96", "enableDelayTime" : false, "delayTime" : 50, "unsecurePktDiscardEnable" : false, "enableBgpKeepaliveTime" : false, "bgpKeepaliveTime" : 720, "transportNetworks" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "mpls1", "routingDomain" : "mpls", "description" : "a mpls link", "priority" : 1 } ], "routingDomain" : [ { "name" : "mpls1", "ipsecEncryption" : true, "isMspRD" : true } ], "ipsecEncryptionParameter" : { "authenticationAlgorithm" : "SHA2_256", "encrptionAlgorithm" : "AES128", "lifeTime" : 1440, "preSharedKey" : "", "dhGroup" : "group19", "antiReplayEnable" : false, "antiReplayWindow" : 1024 }, "defaultMngInterfaceConfig" : { "cleanDefaultMngInterfaceConfig" : false }, "linkQualityDetectionParameter" : { "enable" : true, "interval" : 100, "retryTimes" : 6, "priority" : 5 }, "trafficSteeringPolicyPeriodConfig" : { "enable" : true, "switchingPeriod" : 100, "statisticsPeriod" : 100, "flappingSuppression" : 100, "enableFlappingSuppressionEnhanced" : false, "symmetricForward" : true, "bandwidthUtilizationEnable" : true, "maxBandwidthUtilization" : 95, "sameTnFirst" : false, "siteIdSmallerFirst" : false, "basedRulesVo" : { "tnpPriorityEnable" : true, "basedTnpPriorityVo" : { "mode" : "larger", "priority" : 1 }, "tnpRoleEnable" : true, "basedRoleVo" : { "mode" : "hub", "priority" : 2 }, "tnpBandwidthEnable" : true, "basedBandwidthVo" : { "mode" : "smaller", "priority" : 3 } } }, "provisionUrlParameter" : { "encryptUrlEnable" : false, "encryptSensitiveParameters" : false, "oldDevceiVersionEnable" : false, "encryptionKey" : "12345abc", "validityPeriod" : 7, "urlWebInfoEnable" : false, "urlWebInfo" : { "webUser" : "abcd1234", "webPassword" : "Example@123" } }, "portConfiguration" : { "cusPortConfigEnable" : true, "dtlsServerPort" : 55100, "stunServerPort" : 3478, "connectionDefaultPort" : { "connectPortEnable" : true, "srcPort" : 4501, "portNum" : 0, "portStep" : 10 } }, "dataPackageFormat" : { "extFormatSign" : false, "extUdpHeaderSign" : false, "srcPort" : 4755, "destPort" : 4755 }, "linkDetectIntervalConfig" : { "enable" : false, "interval" : "" } } } } 返回状态码为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代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、TNP激活后，communityPool，bgpAsNum无法修改，如需修改，请先清空站点；其中地址池参数（evpnIPpool，innerTunnelIPpool，interConnectIPpool，evpnIpv6Pool，innerTunnelIpv6Pool，interConnectIpv6Pool，linkLocalIPV6pool），可以扩充地址段，但已被站点使用的地址段不能修改或删除。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/network-orchestration-resources 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 { "bgpAsNum" : 65001, "communityPool" : [1,2], "interlinkProtocolType" : "ospf", "communityPoolStatus" : 1, "siteScale" : "1000+", "dsvpnIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "evpnIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "innerTunnelIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "interConnectIPpool" : "192.168.1.0/26", "evpnIpv6Pool" : ["2100::/96","2200::/96"], "innerTunnelIpv6Pool" : ["fd00::/96","fd10::/96"], "interConnectIpv6Pool" : "fd01::/96", "linkLocalIPV6pool" : "fe80::/96", "enableDelayTime" : false, "delayTime" : 50, "unsecurePktDiscardEnable" : false, "enableBgpKeepaliveTime" : false, "bgpKeepaliveTime" : 720, "transportNetworks" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "mpls1", "routingDomain" : "mpls", "description" : "a mpls link", "priority" : 1 } ], "routingDomain" : [ { "name" : "mpls1", "ipsecEncryption" : true, "isMspRD" : true } ], "ipsecEncryptionParameter" : { "authenticationAlgorithm" : "SHA2_256", "encrptionAlgorithm" : "AES128", "lifeTime" : 1440, "preSharedKey" : "", "dhGroup" : "group19", "antiReplayEnable" : false, "antiReplayWindow" : 1024 }, "defaultMngInterfaceConfig" : { "cleanDefaultMngInterfaceConfig" : false }, "linkQualityDetectionParameter" : { "enable" : true, "interval" : 100, "retryTimes" : 6, "priority" : 5 }, "trafficSteeringPolicyPeriodConfig" : { "enable" : true, "switchingPeriod" : 100, "statisticsPeriod" : 100, "flappingSuppression" : 100, "enableFlappingSuppressionEnhanced" : false, "symmetricForward" : true, "bandwidthUtilizationEnable" : true, "maxBandwidthUtilization" : 95, "sameTnFirst" : false, "siteIdSmallerFirst" : false, "basedRulesVo" : { "tnpPriorityEnable" : true, "basedTnpPriorityVo" : { "mode" : "larger", "priority" : 1 }, "tnpRoleEnable" : true, "basedRoleVo" : { "mode" : "hub", "priority" : 2 }, "tnpBandwidthEnable" : true, "basedBandwidthVo" : { "mode" : "smaller", "priority" : 3 } } }, "provisionUrlParameter" : { "encryptUrlEnable" : false, "encryptSensitiveParameters" : false, "oldDevceiVersionEnable" : false, "encryptionKey" : "12345abc", "validityPeriod" : 7, "urlWebInfoEnable" : false, "urlWebInfo" : { "webUser" : "abcd1234", "webPassword" : "Example@123" } }, "portConfiguration" : { "cusPortConfigEnable" : true, "dtlsServerPort" : 55100, "stunServerPort" : 3478, "connectionDefaultPort" : { "connectPortEnable" : true, "srcPort" : 4501, "portNum" : 0, "portStep" : 10 } }, "dataPackageFormat" : { "extFormatSign" : false, "extUdpHeaderSign" : false, "srcPort" : 4755, "destPort" : 4755 }, "linkDetectIntervalConfig" : { "enable" : false, "interval" : "" } }

响应示例 返回状态码为200：配置成功，响应体参考RestResponse。 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" : "", "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956" } } ], "processInstanceId" : "00000000-0000-0000-0000-000000000000" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考RestResponse。 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 返回状态码为403：接口无权限。 HTTP/1.1 403 Forbidden 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：配置成功，响应体参考RestResponse。 表4 RestResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~16个字符。 - 错误码。 "0" errmsg string 0~1024个字符。 - 错误信息。 "" fail ARRAY_REFERENCE 0-10000个列表项，详细请参见表5。 配置失败站点 - processInstanceId string 0~64个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 "00000000-0000-0000-0000-000000000000" 表5 ConfigFailed对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~16个字符。 - 错误码。 "0" errmsg string 0~1024个字符。 - 错误信息。 "" data REFERENCE 详细请参见表6。 站点信息。 - 表6 SiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 1~36个字符。 - UUID格式。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考RestResponse。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为403：接口无权限。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/sdwan/monitor/{metric}/switch 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 metric 是 string 0~64个字符。 - 采集项，该字段可以设置为以下几种： a) netstream：应用流量 b) tcpfpm：应用质量 c) wanlink：WAN链路流量 d) linkqualityEnhance：WAN链路质量增强 e) sourceip：LAN IP采集（源IP） f) wanSourceIp：WAN IP采集（源IP） g) wanDestIp：WAN IP采集（目的IP） h) wanSession：WAN IP采集（会话） i) thirdPartyNetstream：第三方Netstream sourceip，wanSourceIp，wanDestIp，wanSession只能使能其中一个，当已使能其中一个时，且再次使能剩下三个之一，须先去使能。 V600系列设备不支持linkqualityEnhance，sourceip，wanSourceIp，wanDestIp，wanSession。 "netstream"

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/monitor/netstream/switch 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 { "cfgSiteIds" : [ "fbb684c8-0d37-496f-bafa-4b06d515a7l6" ], "uncfgSiteIds" : [ "bab674c8-4d47-58d9-aaba-5b06d715f945" ], "fixPacketsNum" : 1 }

请求示例 HTTP的示例 POST /controller/campus/v2/sdwansyslog/syslog 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 { "enableHec" : true, "hecToken" : "00000000-0000-0000-0000-000000000000", "domainName" : "www.example.org", "address" : "10.136.108.65", "port" : 514, "hostname" : "sysname", "time" : "utc", "level" : "error", "logFormat" : "SYS LOG ", "syslogType" : ["IPS","AV"], "binarylogType" : ["SESSION_LOG"], "enableSsl" : true }

响应示例 返回状态码为201：创建成功，响应体参考SyslogResponse。 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" : "00000000-0000-0000-0000-000000000000", "syslog" : { "enableHec" : true, "hecToken" : "00000000-0000-0000-0000-000000000000", "domainName" : "www.example.org", "address" : "10.136.108.65", "port" : 514, "hostname" : "sysname", "time" : "utc", "level" : "error", "logFormat" : "SYSLOG", "syslogType" : ["IPS","AV"], "binarylogType" : ["SESSION_LOG"], "enableSsl" : true } }, "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

响应示例 返回状态码为200：修改成功，返回信息，结构体参见initLocalUserInfoResponse。 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" : "" }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/localuser/users/accampus 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 { "password" : "Iam@example", "operationRange" : "new" }

响应示例 返回状态码为200：接口调用成功，响应体参考QueryStaticRouteResponse。 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" : "", "totalRecords" : 10, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "10.1.0.0/16", "nextHopType" : "ip-address", "ipAddress" : "10.1.1.1", "track" : true, "target" : "10.1.0.0", "configSource" : "Wan", "isDefaultVpn" : false, "outBoundInterface" : "Tunnel0/0/400", "outBoundInterfaceDisplayName" : "GE0/0/2", "outBoundInterfaceType" : "IPSec" } ] } 返回状态码为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/sdwan/routing-protocol/static 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - 0 当前页，默认值为0。小于等于0时，取所有数据。 0 pageSize 否 int32 - 20 每页显示数量，默认值为20。当前页的值小于等于0时，该值不予使用。 20 sort 否 string 0~255个字符。 - 排序字段，默认按ID降序排序，当前未实现。 "id" vpnId 否 uuid - - VPN ID，UUID格式。查询LAN路由时使用。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - 传输网络端口ID，UUID格式。查询WAN路由时使用。 "a99f794e-b510-438c-a75d-de59f02347eb" isDefaultVpn 否 boolean true false - 是否查询公网VPN的路由，为null表示查询条件不生效。 false deviceId 否 uuid - - 设备ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" keyword 否 string 0~64个字符。 - 查询关键字，如目的网段或下一跳IP地址，支持模糊查询。 "10.1.0.0/24"

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/static?pageIndex=0&pageSize=20&sort=id&vpnId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&isDefaultVpn=false&deviceId=a99f794e-b510-438c-a75d-de59f02347eb&keyword=10.1.0.0/24 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：接口调用成功，响应体参考QueryStaticRouteResponse。 表2 QueryStaticRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords integer - - 总数据条数。 10 pageSize integer - 20 每页显示数量，默认20。 20 pageIndex integer - - 当前页，从1开始。 1 data ARRAY_REFERENCE 0-2000个列表项，详细请参见表5。 静态路由信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nat-policy:nat-policy-rules 表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-nat-policy:nat-policy-rules 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 返回状态码为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：删除成功，响应体参考TrafficBehaviorResponse。 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", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : false } } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : false } } } ] } 返回状态码为204：执行成功。 HTTP/1.1 204 No Content 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的示例 POST /controller/campus/v1/sdwan/policy/traffic/behavior-profile/action/batch-delete 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 { "trafficBehaviors" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : 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 返回状态码为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-bgp:bgp 是 REFERENCE 详细请参见表4。 BGP配置。 - 表4 bgp-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:bgp 否 REFERENCE 详细请参见表5。 BGP配置。 - 表5 bgp对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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" local-as 否 string 1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。 - 本地AS，6700V子设备不支持。 "65001" graceful-restart-enable 否 boolean true false false GR 使能，AR6700V主设备和AR6700V子设备不支持。 true

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bgp:bgp 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-bgp:bgp" : { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "local-as" : "65001", "graceful-restart-enable" : true } }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bgp:bgp 表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 { "totalRecords" : 100, "progress" : 0.9, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "TemplateBinding1", "templateId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1713880927744", "description" : "this is TemplateBinding1", "totalDeviceNum" : 100, "deployedLastestSuccessDeviceCount" : 100, "templateBindingStatus" : "last-template-partly-deployed", "deployLastVersion" : true, "templateName" : "this is template1", "devices" : { "totalRecords" : 100, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "device1", "ip" : "127.0.0.1", "siteName" : "site1", "deployStatus" : "deployment-successed", "deployTime" : "1713880927744", "deployLastVersion" : true, "deployErrorMsg" : {"errorCode":"0x00c8000c","errorType":"APPLICATION","message":"The request failed because the mandatory node is empty"} } ] } } ] } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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 /v1/networkservice/hierarchy-template/template-groups/members/fbde1c5d-5b94-49e3-a912-48641015e45c/properties/details 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 { "pageIndex" : 1, "pageSize" : 10, "templateName" : "template1", "bindingName" : "binding1", "deviceName" : "device1", "siteName" : "site1", "templateGroupMemberProperties" : { "bindingName" : "binding1", "deviceRoles" : ["Gateway","CORE"], "deviceTypes" : ["AP","LSW"], "deviceModels" : ["S12700E-4","S12700E-12"], "deviceNameContains" : "device1" }, "id" : "00000000-0000-0000-0000-000000000000" }

URI /v1/networkservice/hierarchy-template/template-groups/members/{id}/properties/details 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。 - 模板组成员ID，uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c"

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bindingPropertiesInput 是 REFERENCE 详细请参见表3。 修改绑定属性入参 - 表3 GetUpdateBindingPropertiesDetailsInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [1-1000] 1 页码。 1 pageSize 是 int32 [1-100] 10 每页大小，最大值为100。 10 templateName 否 string 0~1024个字符。 - 模板名称。 "template1" bindingName 否 string 0~128个字符。 - 绑定名称。 "binding1" deviceName 否 string 0~1024个字符。 - 设备名称。 "device1" siteName 否 string 0~1024个字符。 - 站点名称。 "site1" templateGroupMemberProperties 是 REFERENCE 详细请参见表3。 批量操作绑定属性入参。 - id 否 string 36个字符。 - 绑定关系ID，UUID格式。 "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/localuser/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/users 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 { "userName" : "test", "password" : "Iam@example", "role" : 1, "serviceType" : ["http","ssh","terminal"], "configRu" : false }

响应示例 返回状态码为201：创建成功，返回配置后的本地用户信息，结构体参见createLocalUserInfoResponse。 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" : { "userName" : "test", "role" : 1, "serviceType" : ["http","ssh","terminal"], "configRu" : false } }