华为云用户手册

请求示例 HTTP的示例 GET /controller/campus/v1/indoormapservice/floors/75ade72a-e7a9-4c81-8fca-894e7ca9c2c2/devices-details 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

响应示例 返回状态码为200：查询配置成功，响应体参考NatSessionLogConfigResult。 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" : { "natSessionLogEnable" : true, "logInterval" : 30, "binaryNatSessionLogEnable" : true, "binaryLogHostAddress" : "10.10.10.1", "binaryLogHostPort" : 30, "binaryLogSrcPort" : 10240 } }

请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/site/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca/apnatsessionlog 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：查询配置成功，响应体参考NatSessionLogConfigResult。 表2 NatSessionLogConfigResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "配置错误" data REFERENCE 详细请参见表3。 - - 表3 NatSessionLogConfigParam对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 natSessionLogEnable boolean true false false Nat日志上报使能开关。当natSessionLogEnable为true时，logInterval，binaryNatSessionLogEnable生效。默认值为false。 该字段对应UI页面上是：UI【NAT日志】 true logInterval int64 [1-400] 30 Nat日志上报时间间隔，单位：s，默认30s。 当natSessionLogEnable是true时，必须设置该字段。 该字段对应UI页面上是：UI【文本日志输出间隔(s)】 30 binaryNatSessionLogEnable boolean true false false 二进制格式的日志上报开关。当binaryNatSessionLogEnable为true时，binaryLogHostAddress，binaryLogHostPort，binaryLogSrcPort生效。当binaryNatSessionLogEnable为false时，Nat日志上报的格式为文本。默认值为false。 该字段对应UI页面上是：UI【二进制日志输出】 true binaryLogHostAddress string - - 二进制上报日志目标服务器IP地址。 当binaryNatSessionLogEnable是true时，必须设置该字段 该字段对应UI页面上是：UI【日志服务器地址】 "10.10.10.1" binaryLogHostPort int64 [1-65535] - 二进制上报日志目标服务器端口号，该字段的取值范围是：1-65535。 当binaryNatSessionLogEnable是true时，必须设置该字段 该字段对应UI页面上是：UI【端口】 30 binaryLogSrcPort int64 [10240-55534] - 二进制上报日志设备源端口号，该字段的取值范围是：10240-55534。 当binaryNatSessionLogEnable是true时，必须设置该字段 该字段对应UI页面上是：UI【源端口】 10240

响应示例 返回状态码为200：批量查询DfsGroup结果 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 { "data" : [ { "id" : "d25de9be-1d9a-4d06-a519-09ff92fee050", "name" : "dfs-group-name-1", "siteName" : "site-name-1", "members" : [ { "id" : "as25fdbf-8dee-4823-bac2-5bfe8e3359cb", "status" : 0, "name" : "devicename-1", "esn" : "21500102390000009990", "deviceModel" : "S6730-H28X6CZ-V2", "peerLinkIfName" : "Eth-trunk1" } ], "peerLinkStatus" : 1, "status" : 1, "physicalLinkId" : "e9bed25d-1d9a-4d06-a519-09ff92fee050" } ], "totalCount" : "" } 返回状态码为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 /v1/devicemgr/devices/dfs-groups 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 0~36个字符。 - 站点id,UUID格式,只有单站点和所有站点两种情况，为null查找所有站点 "9a79a511-94d0-4288-84ed-ab9710d2396c" keyword 否 string 0~64个字符。 - 模糊查询关键词，支持DfsGroup name的模糊查询 "dfs-group-name-1" pageIndex 否 int32 [1-10000] 1 分页查询分页索引，可选。可选择起始查询页，从1开始 10 pageSize 否 int32 [10-2500] 100 返回数据个数限制，默认值100，最大值2500 100

响应参数 返回状态码为200：批量查询DfsGroup结果 表2 DfsGroupsQueryResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 详细请参见表3。 DfsGroup数据 - totalCount int32 [0-100000] 0 总数 - 返回状态码为400：参数错误 详细信息请参见实际响应消息体。 返回状态码为500：服务内部错误 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /v1/devicemgr/devices/dfs-groups?siteId=9a79a511-94d0-4288-84ed-ab9710d2396c&keyword=dfs-group-name-1&pageIndex=10&pageSize=100 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：查询AP站点模板射频配置结果，返回结构体参见。 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" : { "countryCode" : "CN", "autoEnable" : true, "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "calibrate" : "auto", "dcaStartTime" : "03:00:00", "dcaInterval" : 1440, "calibratePolicy" : "rogueAp,noise,nonWifi", "dcaScheduleTime" : "03:00:00", "scanSwitch" : true, "scanSwitch5g" : true, "scanDuration" : "60", "scanInterval" : "10000", "scanChannel" : "country-channel", "beaconCycle" : 100, "dynamicSwitch" : true, "deauthFailTimes" : 0, "referenceDataAnalysis" : true, "selfCalibrate" : false, "mode" : "default", "spectrumAnalysis" : false, "rtsCtsMode" : "cts-to-self", "rtsCtsThreshold" : 1400, "airTimeFairSchedule" : true, "powerAutoAdjust" : true, "beamforming" : true, "smartRoam" : false, "smartRoamThresholdSnr" : 20, "beEdcaMode" : false, "beEdcaThreshold" : 6, "mediaEdcaMode" : false, "mediaVoiceThreshold" : 30, "mediaVideoThreshold" : 100, "tcpWindowTuningSwitch" : true, "mediaVoiceDelay" : 2, "mediaVideoDelay" : 2, "mediaVoiceRatio" : 2, "mediaVideoRatio" : 2, "wmmScene" : "default", "wmmMode" : true, "edcaClient" : [ { "ac" : "acVo", "aifsn" : 3, "ecwMin" : 4, "ecwMax" : 6, "txoplimit" : 0, "ackPolicy" : "normal" } ], "channelMonitor" : false, "coSrEnable" : true, "groupRadio2g" : { "dca2gChannelSet" : "1,6,11", "radio2gBaseRate" : "1,2", "radio2gSupportRate" : "1,2,5.5,6,9,11,12,18,24,36,48,54", "radio2gMulticastRate" : "5.5", "radio2gType" : "dot11ax", "tpc2gMaxTxPwr" : 127, "tpc2gMinTxPwr" : 9, "tpc2gCoverageThreshold" : -60, "uca2gClientEnable" : false, "access2gThrehold" : 64, "reachthresHold2G" : 1, "radio2Dot4GuardIntervalMode" : "short", "radio11ax2Dot4GuardIntervalMode" : "dot8", "enableFlag2g" : false, "smartRoamScene2g" : "general", "snr2g" : 5, "checkInterval2g" : 300, "utmostPower2g" : 1, "vipUser2dot4ModeUserDefine" : 20, "flexibleRadio" : 0, "fastpassusers2gEnable" : true, "fastpassusers2gNum" : 5, "fastpassusers2gPeriod" : "20ms", "fastpassusers2gRatio" : 25, "startThreshold2g" : 100, "gapThreshold2g" : 90, "snrThreshold2g" : 20, "denyThreshold2g" : 0, "clientBandExpire2g" : 35, "vipUser2gPhyProtection" : "security-priority" }, "groupRadio5g" : { "dcaBandwidth" : "20mhz", "dca5gChannelSet" : "44,56,36,48,161,153,165,157,149,60,40,52,64", "radio5gBaseRate" : "6,12,24", "radio5gSupportRate" : "6,9,12,18,24,36,48,54", "radio5gMulticastRate" : "6", "radio5gType" : "dot11ax", "radio5gVhtAMsduEnable" : false, "radio5gMaxFrameNum" : 2, "tpc5gMaxTxPwr" : 127, "tpc5gMinTxPwr" : 9, "tpc5gCoverageThreshold" : -60, "radio5GuardIntervalMode" : "short", "radio11ax5GuardIntervalMode" : "1dot6", "antennaMode" : "omnidirection", "uca5gClientEnable" : false, "access5gThrehold" : 64, "reachthresHold5G" : 1, "enableFlag5g" : false, "smartRoamScene5g" : "general", "snr5g" : 5, "checkInterval5g" : 300, "utmostPower5g" : 1, "vipUser5ModeUserDefine" : 20, "radio5gSliceEnable" : false, "radio5gSliceRtt" : 20, "radio5gSliceRatio" : 60, "radio5gSliceFrerEnhance" : false, "fastpassusers5gEnable" : true, "fastpassusers5gNum" : 5, "fastpassusers5gPeriod" : "20ms", "fastpassusers5gRatio" : 25, "vipUser5gPhyProtection" : "security-priority" }, "groupRadio6g" : { "dca6gChannelSet" : "44,56,36,48,161,153,165,157,149,60,40,52,64", "dca6gBandwidth" : "20mhz", "scanSwitch6g" : true, "radio11ax6GuardIntervalMode" : "1dot6", "tpc6gMinTxPwr" : 9, "tpc6gMaxTxPwr" : 127, "tpc6gCoverageThreshold" : -60, "uacClientEnableFlag6g" : false, "uacAccess6gThrehold" : 64, "uacReachthresHold6G" : 1, "radio6gVhtAMsduEnable" : false, "radio6gMaxFrameNum" : 2, "radio6gMulticastRate" : "6", "smartRoamScene6g" : "general", "smartRoamSnr6g" : 5, "smartRoamCheckInterval6g" : 300, "utmostPower6g" : 1, "vipUser6gModeUserDefine" : 20, "enableFlag6g" : false, "fastpassusers6gEnable" : true, "fastpassusers6gNum" : 5, "fastpassusers6gPeriod" : "20ms", "fastpassusers6gRatio" : 25, "vipUser6gPhyProtection" : "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

响应参数 返回状态码为200：查询AP站点模板射频配置结果，返回结构体参见。 表2 SiteTemplateGroupRadioResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 站点模板射频配置信息，结构体参见SiteTemplateGroupRadioDto。 - 表3 SiteTemplateGroupRadioDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 countryCode string - CN 国家码。支持的最大长度为2。默认为CN。对应关系参考：阿根廷：AR，亚美尼亚：AM，澳大利亚：AU，奥地利：AT，阿塞拜疆：AZ，巴林群岛：BH，孟加拉国：BD，比利时：BE，伯利兹：BZ，玻利维亚：BO，巴西：BR，文莱：BN，保加利亚：BG，加拿大：CA，智利：CL，中国：CN，哥伦比亚：CO，哥斯达黎加：CR，克罗地亚：HR，塞浦路斯：CY，捷克：CZ，丹麦：DK，多米尼加共和国：DO，萨尔瓦多：SV，厄瓜多尔：EC，埃及：EG，爱沙尼亚：EE，芬兰：FI，法国：FR，格鲁吉亚：GE，德国：DE，希腊：GR，危地马拉：GT，洪都拉斯：HN，中国香港：HK，匈牙利：HU，冰岛：IS，印度：IN，印度尼西亚：ID，爱尔兰：IE，以色列：IL，意大利：IT，日本：JP，约旦：JO，哈萨克斯坦：KZ，肯尼亚：KE，韩国：KR，科威特：KW，拉脱维亚：LV，列支敦士登：LI，立陶宛：LT，卢森堡：LU，中国澳门：MO，马其顿：MK，马来西亚：MY，马耳他：MT，墨西哥：MX，摩纳哥：MC，摩洛哥：MA，荷兰：NL，新西兰：NZ，尼日利亚：NG，挪威：NO，阿曼：OM，巴基斯坦：PK，巴拿马：PA，秘鲁：PE，菲律宾：PH，波兰：PL，葡萄牙：PT，波多黎各：PR，卡塔尔：QA，罗马尼亚：RO，俄罗斯：RU，西班牙：ES，斯里兰卡：LK，沙特阿拉伯：SA，塞尔维亚：RS，新加坡：SG，斯洛伐克：SK，斯洛文尼亚：SI，南非：ZA，瑞典：SE，瑞士：CH，泰国：TH，特立尼达和多巴哥：TT，突尼斯：TN，土耳其：TR，乌克兰：UA，阿拉伯联合酋长国：AE，大不列颠联合王国：GB，美国：US，乌拉圭：UY，乌兹别克斯坦：UZ，委内瑞拉：VE，越南：VN，也门：YE，白俄罗斯：BY，台湾：TW "CN" autoEnable boolean true false false 定时开启，可选值: true，false。默认值为false true timeTemplateId string 0~36个字符。 - 定时开启时的时间模板ID，仅autoEnable为true时，该字段可填值。时间模板ID可以通过第三方开放接口/controller/campus/v3/networkconfig/timetemplate得到 "b90f8190-e12f-4323-95f3-4018309209c4" calibrate string - manual 调优模式，只能为manual（手动调优），auto（自动调优），schedule（定时调优）其中一种。默认值为manual。 "auto" dcaStartTime hh:mm:ss - - 自动调优模式下有效。自动调优开始时间，时间格式hh:mm:ss。 "03:00:00" dcaInterval int32 [30-1440] - 自动调优模式下有效。自动调优时间周期，取值范围为30到1440之间的整数，单位（min）。 1440 calibratePolicy string 0~36个字符。 close 自动调优模式下射频调优策略(calibrate为auto时生效)，取值范围：close或者rogueAp（入侵模式）,noise（底噪调优）,nonWifi（非Wi-Fi）三个中选择一个或多个，英文逗号分隔。默认值为close。 "rogueAp,noise,nonWifi" dcaScheduleTime hh:mm:ss - - 定时调优模式下有效。定时调优开始时间，时间格式hh:mm:ss。 "03:00:00" scanSwitch boolean true false - 空口扫描是否开启，可选值: true(默认)，false。当开启时，扫描时长，扫描间隔，扫描信道为必填项。 true scanSwitch5g boolean true false - 空口扫描是否开启，可选值: true(默认)，false。当开启时，扫描时长，扫描间隔，扫描信道为必填项。 true scanDuration string - - 扫描时长，范围60~100，单位（ms）。 "60" scanInterval string - - 扫描间隔，范围300~600000，单位（ms）。 "10000" scanChannel string - country-channel 扫描信道，只能为country-channel（区域信道），dca-channel（调优信道），work-channel（作信道）其中一种。默认值为country-channel。 "country-channel" beaconCycle int32 [60-1000] 100 beacon周期。取值范围为60到1000之间的整数。单位（TUs）。默认值为100。 100 dynamicSwitch boolean true false false 负载均衡。默认值为false。 true deauthFailTimes int16 [0-5] 0 deauth方式迁移次数。默认为0 0 referenceDataAnalysis boolean true false - 基于历史数据进行射频调优，可选值: true(默认)，false。 true selfCalibrate boolean true false - 同一个站点下跨二层AP自调优，可选值: true，false(默认)。 false mode string default 2RadioStandard 2Radio2gEnhanced 3Radio 2RadioIndependentScan - 射频模式。取值范围为default（默认模式）、2RadioStandard（2射频标准）、2Radio2gEnhanced（2射频2G增强）、3Radio（3射频）、2RadioIndependentScan（2射频独立扫描）。 "default" spectrumAnalysis boolean true false false 频谱分析，可选值: false(默认)，true。 false rtsCtsMode string cts-to-self rts-cts disable rts-cts RTS- CTS 模式。取值范围为cts-to-self、rts-cts、disable，默认值为rts-cts。 "cts-to-self" rtsCtsThreshold int32 [64-2347] 1400 RTS-CTS阈值(byte)，默认值为1400。 1400 airTimeFairSchedule boolean true false true 空口时间公平调度开关。默认值为true。 true powerAutoAdjust boolean true false - 逐包功率控制开关。 true beamforming boolean true false - 波束成形功能开关。 true smartRoam boolean true false - 智能漫游开关。 false smartRoamThresholdSnr int32 [15-45] 20 智能漫游信噪比阈值 20 beEdcaMode boolean true false - BE动态优化开关。 false beEdcaThreshold int32 [1-1000] - BE优化阈值，BE动态优化开关打开时使用。取值范围为1-1000，单位为(包/秒)。 6 mediaEdcaMode boolean true false - 多媒体动态优化开关。 false mediaVoiceThreshold int32 [10-1000] - 音频优化阈值，多媒体动态优化开关打开时使用。取值范围为10-1000，单位为(包/秒)。 30 mediaVideoThreshold int32 [10-1000] - 视频优化阈值，多媒体动态优化开关打开时使用。取值范围为10-1000，单位为(包/秒)。 100 tcpWindowTuningSwitch boolean true false - TCP调窗功能开关，打开后当语音视频业务时延达到阈值，且大流量上行TCP背景业务发包时长达到阈值时，即可对TCP ACK中回复的RWND（Receiver Window，接收窗口值）进行动态调整，达到降低终端实际发送上行数据量以保障语音视频业务的用户体验。 true mediaVoiceDelay integer [1-4] - 多媒体语音切片时延。取值范围为1:低，2:中，3：高，4：关。默认值为2。 2 mediaVideoDelay integer [1-4] - 多媒体视频切片时延。取值范围为1:低，2:中，3：高，4：关。默认值为2。 2 mediaVoiceRatio integer [1-4] - 多媒体语音切片占比。取值范围为1:低，2:中，3：高，4：关。默认值为2。 2 mediaVideoRatio integer [1-4] - 多媒体视频切片占比。取值范围为1:低，2:中，3：高，4：关。默认值为2。 2 wmmScene string default voice voiceAndVideo - WMM场景，BE动态优化开关和多媒体动态优化开关同时关闭时使用。取值范围为default（默认）、voice（音频）、voiceAndVideo（音频和视频）。 "default" wmmMode boolean true false true 报文信道竞争开关，默认打开。 true edcaClient ARRAY_REFERENCE 0-4个列表项，详细请参见表4。 2.4G和5G射频模板自定义信道竞争参数，当wmmMode为true时可为空，此时下发默认配置，结构体参见DeviceRadioEdcaDto。 - channelMonitor boolean true false false 全信道扫描开关，可选值: false(默认)，true。 false coSrEnable boolean true false - CO-SR 开关 true groupRadio2g REFERENCE 详细请参见表5。 站点模板2G射频配置信息，结构体参见GroupRadio2gConfigDto。 - groupRadio5g REFERENCE 详细请参见表6。 站点模板5G射频配置信息，结构体参见GroupRadio5gConfigDto。 - groupRadio6g REFERENCE 详细请参见表7。 站点模板6G射频配置信息，结构体参见GroupRadio6gConfigDto。 - 表4 DeviceRadioEdcaDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ac string - - 报文的4个接入类别。可取值为：acVo、acVi、acBe、acBk。WMM协议将数据报文分为4个接入类别，分别为AC_VO（Voice）、AC_VI（Video）、AC_BE（BestEffort）、AC_BK（Background）。当ac为acVo时，表示接入类别为语音流；当ac为acVi时，表示接入类别为视频流；当ac为acBe时，表示接入类别为尽力而为流；当ac为acBk时，表示接入类别为背景流。 "acVo" aifsn int32 [1-15] - 指定仲裁帧间隙数，决定了用户的空闲等待时间长短。aifsn数值越大，用户的空闲等待时间越长，优先级越低。范围为1~15。 3 ecwMin int32 [0-15] - 指定最小竞争窗口指数，此参数与ecwMax一起决定了用户的平均退避时间。这两个数值越大，用户的平均退避时间越长，优先级越低。取值范围：0~15，且须小于或等于ecwMax。 4 ecwMax int32 [0-15] - 指定最大竞争窗口指数，此参数与ecwMin一起决定了用户的平均退避时间。这两个数值越大，用户的平均退避时间越长，优先级越低。取值范围：0~15，且须大于或等于ecwMin。 6 txoplimit int32 [0-255] - 用户一次竞争信道成功后，可占用信道的最大时间，这个数值越大，用户一次能占用的信道时长越大。如果是0，则每次占用信道后，只能发送一个报文。取值范围：0~255。 0 ackPolicy string - - ACK策略类型，对于发送端发送的每个单播报文，接收端在成功接收到报文后，都需要发送ACK帧进行确认。只可在normal和noAck中选择。normal表示正常发送ACK帧，noAck表示不发送ACK帧。 "normal" 表5 GroupRadio2gConfigDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dca2gChannelSet string - 1,6,11 2.4G调优信道集。可选"1，6，11"和"1，5，9，13"两种信道集。默认值为'1,6,11'。 "1,6,11" radio2gBaseRate string - 1,2 2.4基础速率。支持的速率有1，2，5.5，6，9，11，12，18，24，36，48，54。单位（Mbps）(radio2gType填dot11b时，取值范围为1,2,5.5,11)。至少选择一项。默认值为'1,2'。 "1,2" radio2gSupportRate string - 1,2,5.5,6,9,11,12,18,24,36,48,54 2.4G支持速率。支持的速率有1，2，5.5，6，9，11，12，18，24，36，48，54。单位（Mbps）(radio2gType填dot11b时，取值范围为1,2,5.5,11)。至少选择一项。默认值为'1,2,5.5,6,9,11,12,18,24,36,48,54'。 "1,2,5.5,6,9,11,12,18,24,36,48,54" radio2gMulticastRate string - - 2.4G射频模板无线组播速率，缺省值为0（自适应），取值范围为1，2，5.5，6，9，11，12，18，24，36，48，54。单位Mbps。 "5.5" radio2gType string - dot11ax 2.4G射频类型选择，可填dot11b(802.11b模式)、dot11g(802.11g模式，可向前兼容)、dot11n(802.11n模式，可向前兼容)、dot11ax(默认，802.11ax模式，可向前兼容)、dot11be(802.11be模式，可向前兼容)。当2G射频模板视图配置dot11b时，引用了此2G射频模板的AP 2GHz射频上生效的管理帧发送速率和无线报文组播发送速率均固定为1Mbps且再进行组播速率(multicast-rate)和管理帧发送速率(beacon-2g-rate)配置不生效。 "dot11ax" tpc2gMaxTxPwr int32 [1-127] 127 2.4G的TPC上限。取值范围为1到127之间的整数。单位（dBm）。默认值为127。2.4G的TPC上限需大于下限。 127 tpc2gMinTxPwr int32 [1-127] 9 2.4G的TPC下限。取值范围为1到127之间的整数。单位（dBm），默认值为9。 9 tpc2gCoverageThreshold int32 [-85--35] -60 2.4G的TPC阈值。取值范围为-85到-35之间的整数。 -60 uca2gClientEnable boolean true false - 2.4G射频接入用户数限制开关。 false access2gThrehold int32 [1-512] - 2.4G射频接入用户数阈值，接入用户数限制开关打开时使用。取值范围为1-512。 64 reachthresHold2G int32 [1-3] - 2.4G射频接入阈值策略，接入用户数限制开关打开时使用。取值范围为1（新用户禁止接入）、2（新用户禁止接入且隐藏SSID）、3（VIP用户优先接入）。 1 radio2Dot4GuardIntervalMode string - - 2.4G射频间隔（GI）模式，可填default（默认）、short（短间隔）或normal（普通间隔）。普通间隔的时间为800ns，在802.11n和802.11ac标准中允许使用短间隔，为400ns，可以提高802.11n和802.11ac的传输率。 "short" radio11ax2Dot4GuardIntervalMode string - dot8 2.4G射频802.11ax的间隔(GI)模式，可填dot8（代表800ns）、1dot6（代表1600ns）或3dot2（代表3200ns）。间隔时间越小，传输效率越高，间隔时间越大，抗干扰能力越强。室内环境干扰因素小，建议使用小的GI，室外环境干扰因素大，建议使用大的GI，默认值为dot8。 "dot8" enableFlag2g boolean true false - 2.4G射频弱信号终端强制下线开关。 false smartRoamScene2g string general highDensity userDefined - 2.4G射频弱信号终端强制下线场景，弱信号终端强制下线开关打开时使用。取值范围为general（普通）、highDensity（高密）、userDefined（自定义）。 "general" snr2g int32 [5-45] - 信噪比阈值，单位（dB），弱信号终端强制下线开关打开且场景为userDefined（自定义）时使用。取值范围为5-45。 5 checkInterval2g int32 [300-3000] - 检测周期，单位（ms），弱信号终端强制下线开关打开且场景为userDefined（自定义）时使用。取值范围为300-3000。 300 utmostPower2g int32 [0-2] - 2.4G射频极限功率开关。取值范围为(0) 开启、1(默认)、2（关闭）。 1 vipUser2dot4ModeUserDefine int32 [0-100] - 2.4G射频VIP用户带宽预留比例。取值范围为0-100。 20 flexibleRadio int32 [0-2] - 2.4G射频双频动态调整开关。取值范围为0（关闭）、1（自动切换成5G）、2（自动关闭2.4G）。 0 fastpassusers2gEnable boolean true false - 是否开启2G VIP超帧 true fastpassusers2gNum int32 [0-10] - 2G VIP超帧 保障用户数 5 fastpassusers2gPeriod string 4~5个字符。满足正则表达^(20|40|60|80|100)ms$。 - 2G VIP超帧 调度周期 （已废弃） "20ms" fastpassusers2gRatio int32 [5-75] - VIP超帧 调度周期超帧保障占比 （已废弃） 25 startThreshold2g int32 [0-100] - 双频间负载均衡负载起始阈值(终端数) 100 gapThreshold2g int32 [0-100] - 双频间负载均衡负载差值阈值(%) 90 snrThreshold2g int32 [10-35] - 双频间负载均衡SNR阈值(dB) 20 denyThreshold2g int32 [0-10] - 拒绝终端关联最大次数 0 clientBandExpire2g int64 [10-65535] - 终端支持频段信息老化probe次数 35 vipUser2gPhyProtection string 满足正则表达^(security-priority|business-priority|disable)$。 disable 密盾功能。可选:security-priority 安全优先，对于不支持MU-MIMO功能的终端会拒绝接入；business-priority 业务优先只保障支持MU-MIMO功能的终端的业务安全性；disable:不使能。 "security-priority" 表6 GroupRadio5gConfigDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dcaBandwidth string - 20mhz 5G调优频宽，只能为20mhz，40mhz，80mhz其中一种。默认值为20mhz。 "20mhz" dca5gChannelSet string - 44,56,36,48,161,153,165,157,149,60,40,52,64 5G调优信道集。当5G调优频宽为20MHz时，支持的信道有36，40，44，48，52，56，60，64，149，153，157，161，165； 当5G调优信道为40MHz或80MHz时，支持的信道有36，40，44，48，52，56，60，64，149，153，157，161。 为了确保校准结果，请选择至少三个选项。若可选信道少于三个，则此国家不支持配置此调优频宽。默认值为'44,56,36,48,161,153,165,157,149,60,40,52,64'。 "44,56,36,48,161,153,165,157,149,60,40,52,64" radio5gBaseRate string - 6,12,24 5G基础速率。支持的速率有6，9，12，18，24，36，48，54。单位（Mbps）。至少选择一项。默认值为'6,12,24'。 "6,12,24" radio5gSupportRate string - 6,9,12,18,24,36,48,54 5G支持速率。支持的速率有6，9，12，18，24，36，48，54。单位（Mbps）。至少选择一项。默认值为'6,9,12,18,24,36,48,54'。 "6,9,12,18,24,36,48,54" radio5gMulticastRate string - - 5G射频模板无线组播速率，缺省值为0（自适应），取值范围：6，9，12，18，24，36，48，54。单位：Mbps。 "6" radio5gType string - dot11ax 5G射频类型选择，可填dot11a(802.11a模式)、dot11n(802.11n模式，可向前兼容)、dot11ac(802.11ac模式，可向前兼容)、dot11ax(默认，802.11ax模式，可向前兼容)、dot11be(802.11be模式，可向前兼容)。射频类型配置为dot11a时，禁止非HT终端接入功能失效；射频类型配置超出AP支持的能力范围时，则按照AP实际支持的能力生效；对于使能了WDS或Mesh功能的射频，如果射频类型配置为不支持802.11n/ac，则会降低空口回传性能。 "dot11ax" radio5gVhtAMsduEnable boolean true false false A-MSDU聚合开关，默认为关闭。 false radio5gMaxFrameNum int32 [2-15] 2 最大聚合子帧数，取值范围：2~15，默认值为2。 2 tpc5gMaxTxPwr int32 [1-127] 127 5G的TPC上限。取值范围为1到127之间的整数。单位（dBm）。默认值为127。5G的TPC上限需大于下限。 127 tpc5gMinTxPwr int32 [1-127] 9 5G的TPC下限。取值范围为1到127之间的整数。单位（dBm）。默认值为9。 9 tpc5gCoverageThreshold int32 [-85--35] -60 5G的TPC阈值。取值范围为-85到-35之间的整数。默认值为-60。 -60 radio5GuardIntervalMode string - - 5G射频间隔（GI）模式，可填default（默认）、short（短间隔）或normal（普通间隔）。普通间隔的时间为800ns，在802.11n和802.11ac标准中允许使用短间隔，为400ns，可以提高802.11n和802.11ac的传输率。 "short" radio11ax5GuardIntervalMode string - dot8 5G射频802.11ax的间隔(GI)模式，可填dot8（代表800ns）、1dot6（代表1600ns）或3dot2（代表3200ns）。间隔时间越小，传输效率越高，间隔时间越大，抗干扰能力越强。室内环境干扰因素小，建议使用小的GI，室外环境干扰因素大，建议使用大的GI，默认值为dot8。 "1dot6" antennaMode string - omnidirection 天线模式，可填omnidirection（全向天线）或direction（定向天线）。 "omnidirection" uca5gClientEnable boolean true false - 5G射频接入用户数限制开关。 false access5gThrehold int32 [1-512] - 5G射频接入用户数阈值，接入用户数限制开关打开时使用。取值范围为1-512。 64 reachthresHold5G int32 [1-3] - 5G射频接入阈值策略，接入用户数限制开关打开时使用。取值范围为1（新用户禁止接入）、2（新用户禁止接入且隐藏SSID）、3（VIP用户优先接入）。 1 enableFlag5g boolean true false - 5G射频弱信号终端强制下线开关。 false smartRoamScene5g string - - 5G射频弱信号终端强制下线场景，弱信号终端强制下线开关打开时使用。取值范围为general（普通）、highDensity（高密）、userDefined（自定义）。 "general" snr5g int32 [5-45] - 信噪比阈值，单位（dB），弱信号终端强制下线开关打开且场景为userDefined（自定义）时使用。取值范围为5-45。 5 checkInterval5g int32 [300-3000] - 检测周期，单位（ms），弱信号终端强制下线开关打开且场景为userDefined（自定义）时使用。取值范围为300-3000。 300 utmostPower5g int32 [0-2] - 5G射频极限功率开关。取值范围为(0) 开启、1(默认)、2（关闭）。 1 vipUser5ModeUserDefine int32 [0-100] - 5G射频VIP用户带宽预留比例。取值范围为0-100。 20 radio5gSliceEnable boolean true false - 使能5G空口切片 false radio5gSliceRtt int32 [10-1000] - 5g空口切片时延，默认20ms 20 radio5gSliceRatio int32 [0-80] - 5g空口切片时间占比，默认80% 60 radio5gSliceFrerEnhance boolean true false - 双发选收增强开关 false fastpassusers5gEnable boolean true false - 是否开启 VIP超帧 true fastpassusers5gNum int32 [0-10] - VIP超帧 保障用户数 5 fastpassusers5gPeriod string 4~5个字符。满足正则表达^(20|40|60|80|100)ms$。 - VIP超帧 调度周期 （已废弃） "20ms" fastpassusers5gRatio int32 [5-75] - VIP超帧 调度周期超帧保障占比 （已废弃） 25 vipUser5gPhyProtection string 满足正则表达^(security-priority|business-priority|disable)$。 disable 密盾功能。可选:security-priority 安全优先，对于不支持MU-MIMO功能的终端会拒绝接入；business-priority 业务优先只保障支持MU-MIMO功能的终端的业务安全性；disable:不使能。 "security-priority" 表7 GroupRadio6gConfigDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dca6gChannelSet string 0~500个字符。 - 6G调优信道集。当5G调优频宽为20MHz时,支持的信道有1,5,9,13,17...233； 当6G调优信道为40MHz时,相邻2信道捆绑成一个信道,支持的信道有1,9,17,25...225或者5,13,21,29...229; 当6G调优信道为80MHz时,相邻4信道捆绑成一个信道,支持的信道有1,17,33,49...209； 当6G调优信道为160MHz时,相邻8信道捆绑成一个信道,支持的信道有1,33,65,97,129,161,193； 当6G调优信道为320MHz时,相邻16信道捆绑成一个信道,支持的信道有1,65,129； 为了确保校准结果,请选择至少三个选项。若可选信道少于三个,则此国家不支持配置此调优频宽。 "44,56,36,48,161,153,165,157,149,60,40,52,64" dca6gBandwidth string 20mhz 40mhz 80mhz 160mhz 320mhz - 6G调优频宽，只能为20mhz，40mhz，80mhz，160mhz其中一种。 "20mhz" scanSwitch6g boolean true false - 空口扫描是否开启，可选值: true(默认)，false。当开启时，扫描时长，扫描间隔，扫描信道为必填项 true radio11ax6GuardIntervalMode string 0~10个字符。 dot8 6G射频802.11ax的间隔(GI)模式，可填dot8（代表800ns）、1dot6（代表1600ns）或3dot2（代表3200ns）。间隔时间越小，传输效率越高，间隔时间越大，抗干扰能力越强。室内环境干扰因素小，建议使用小的GI，室外环境干扰因素大，建议使用大的GI，默认值为dot8。 "1dot6" tpc6gMinTxPwr int32 [1-127] - 6G TPC下限。 9 tpc6gMaxTxPwr int32 [1-127] - 6G TPC上限，需大于6G TPC下限。 127 tpc6gCoverageThreshold int32 [-85--35] - 6G TPC阈值。 -60 uacClientEnableFlag6g boolean true false - 6G接入用户阈值使能，可选值: true，false false uacAccess6gThrehold int32 [1-512] - 6G接入用户阈值 64 uacReachthresHold6G int32 [1-3] - 6G用户优先保障策略 范围：1：新用户禁止接入 2：用户禁止进入且隐藏 3：VIP用户优先接入 1 radio6gVhtAMsduEnable boolean true false false 6G射频模板A-MSDU聚合开关，默认为关闭。 false radio6gMaxFrameNum int32 [2-15] 2 6G射频模板最大聚合子帧数，取值范围2~15，默认值为2。 2 radio6gMulticastRate string 0~3个字符。 - 6G射频模板无线组播速率，缺省值为0（自适应），取值范围：6，9，12，18，24，36，48，54。单位Mbps。 "6" smartRoamScene6g string general highDensity userDefined - 6G弱信号终端强制下线场景，uacClientEnableFlag6g为true时生效，取值范围：general, highDensity, userDefined。 "general" smartRoamSnr6g int32 [5-45] - 6G信噪比阈值(dB)，smartRoamScene6g为userDefined时生效。 5 smartRoamCheckInterval6g int32 [300-3000] - 6G检测周期(ms)，smartRoamScene6g为userDefined时生效。 300 utmostPower6g int32 [0-2] - 6G极限功率，0 开启，1 默认，2 关闭 1 vipUser6gModeUserDefine int32 [0-100] - 6gVIP用户带宽预留比例(%) 20 enableFlag6g boolean true false - 6G弱信号终端强制下线。 false fastpassusers6gEnable boolean true false - 是否开启 VIP超帧 true fastpassusers6gNum int32 [0-10] - VIP超帧 保障用户数 5 fastpassusers6gPeriod string 4~5个字符。满足正则表达^(20|40|60|80|100)ms$。 - VIP超帧 调度周期 （已废弃） "20ms" fastpassusers6gRatio int32 [5-75] - VIP超帧 调度周期超帧保障占比 （已废弃） 25 vipUser6gPhyProtection string 满足正则表达^(security-priority|business-priority|disable)$。 disable 密盾功能。可选:security-priority 安全优先，对于不支持MU-MIMO功能的终端会拒绝接入；business-priority 业务优先只保障支持MU-MIMO功能的终端的业务安全性；disable:不使能。 "security-priority" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /v1/networkservice/hierarchy-template/template-groups/templates/action/batch-create 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 { "templates" : [ { "type" : "copy", "extendsTemplateInfo" : { "parentTemplateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1" }, "copyTemplateInfo" : { "sourceTemplateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1" } } ] }

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "type" : "copy", "originTemplateId" : "00000000-0000-0000-0000-000000000000", "templateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1", "rootTemplateId" : "00000000-0000-0000-0000-000000000000" } ], "fail" : [ { "errcode" : "0x00c80035", "errmsg" : "Invalid parameter.", "data" : { "type" : "copy", "originTemplateId" : "00000000-0000-0000-0000-000000000000", "templateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1", "rootTemplateId" : "00000000-0000-0000-0000-000000000000" } } ] } 返回状态码为207：部分成功。 HTTP/1.1 207 Multi-Status 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" : [ { "type" : "copy", "originTemplateId" : "00000000-0000-0000-0000-000000000000", "templateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1", "rootTemplateId" : "00000000-0000-0000-0000-000000000000" } ], "fail" : [ { "errcode" : "0x00c80035", "errmsg" : "Invalid parameter.", "data" : { "type" : "copy", "originTemplateId" : "00000000-0000-0000-0000-000000000000", "templateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1", "rootTemplateId" : "00000000-0000-0000-0000-000000000000" } } ] } 返回状态码为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" : "", "success" : [ { "type" : "copy", "originTemplateId" : "00000000-0000-0000-0000-000000000000", "templateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1", "rootTemplateId" : "00000000-0000-0000-0000-000000000000" } ], "fail" : [ { "errcode" : "0x00c80035", "errmsg" : "Invalid parameter.", "data" : { "type" : "copy", "originTemplateId" : "00000000-0000-0000-0000-000000000000", "templateId" : "00000000-0000-0000-0000-000000000000", "templateName" : "template1", "templateDescription" : "this is template1", "rootTemplateId" : "00000000-0000-0000-0000-000000000000" } } ] } 返回状态码为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：操作成功。 表6 CreateTemplatesResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 0 错误码。 "0" errmsg string 0~256个字符。 错误信息。 "" success ARRAY_REFERENCE 0-20个列表项，详细请参见表3。 成功的模板列表。 - fail ARRAY_REFERENCE 0-20个列表项，详细请参见表7。 失败的模板列表。 - 表7 DataDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 0 错误码。 "0x00c80035" errmsg string 0~256个字符。 错误信息。 "Invalid parameter." data REFERENCE 详细请参见表3。 模板信息。 - 返回状态码为207：部分成功。 CreateTemplatesResponse对象的参数列表，详细请参见表6。 返回状态码为400：校验异常。 CreateTemplatesResponse对象的参数列表，详细请参见表6。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templates 是 REFERENCE 详细请参见表2。 批量创建模板入参。 - 表2 CreateTemplatesInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templates 是 ARRAY_REFERENCE 1-20个列表项，详细请参见表3。 模板列表。 - 表3 Template对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 type 是 string 1~10个字符。满足正则表达extends|copy。 - 创建类型。extends：继承创建，copy：复制创建。 "copy" extendsTemplateInfo 否 REFERENCE 详细请参见表4。 继承创建入参。 - copyTemplateInfo 否 REFERENCE 详细请参见表5。 复制创建入参。 - 表4 ExtendsTemplateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parentTemplateId 是 string 36个字符。 - 父模板ID "00000000-0000-0000-0000-000000000000" templateName 是 string 1~128个字符。 - 名称。 "template1" templateDescription 否 string 0~1024个字符。 - 描述。 "this is template1" 表5 CopyTemplateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sourceTemplateId 是 string 36个字符。 - 源模板ID "00000000-0000-0000-0000-000000000000" templateName 是 string 1~128个字符。 - 名称。 "template1" templateDescription 否 string 0~1024个字符。 - 描述。 "this is template1"

请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/site-templates/fbde1c5d-5b94-49e3-a912-48641015e45c/apradio HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

URI /controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/apradio 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string - - 站点模板ID，UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c"

响应示例 返回状态码为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-bgp:vpn-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:vpn-bgp" : { "vpn-instance" : "_public_", "router-id" : "10.1.0.0", "ipv4-unicast" : { "enable" : true, "default-route-import" : true, "route-select-delay" : 10, "reflector-cluster-id" : 10, "reflect-change-path" : true, "auto-frr" : true, "mode" : "be", "down-switch" : true, "route-relay-tunnel-v6-selector" : "policy1", "preference" : { "external" : 10, "internal" : 10, "local" : 10 }, "aggregate-route" : [ { "address" : "192.168.1.1", "mask" : 24 } ], "network-route" : [ { "address" : "192.168.1.2", "mask" : 24, "route-policy" : "policy1" } ], "import-routing" : [ { "protocol" : "static", "thead-id" : 10, "cost" : 10, "route-policy" : "policy1" } ], "evpn" : { "srv6" : { "mode" : "be", "down-switch" : true }, "locator" : [ { "name" : "name" } ] }, "advertise-l2-evpn" : { "advertise-route-to-evpn" : [ { "protocol" : "all", "advertise-route-mode" : "all" } ] }, "locator" : [ { "name" : "name" } ] }, "ipv6-unicast" : { "enable" : true, "default-route-import" : true, "route-select-delay" : 10, "reflector-cluster-id" : 10, "reflect-change-path" : true, "auto-frr" : true, "mode" : "be", "down-switch" : true, "route-relay-tunnel-v6-selector" : "policy1", "preference" : { "external" : 10, "internal" : 10, "local" : 10 }, "aggregate-route" : [ { "address" : "fc00::7", "mask" : 96 } ], "network-route" : [ { "address" : "fc00::7", "mask" : 96 } ], "import-routing" : [ { "protocol" : "static", "thead-id" : 10, "cost" : 10, "route-policy" : "policy1" } ], "evpn" : { "srv6" : { "mode" : "be", "down-switch" : true }, "locator" : [ { "name" : "name" } ] }, "advertise-l2-evpn" : { "advertise-route-to-evpn" : [ { "protocol" : "all", "advertise-route-mode" : "all" } ] }, "locator" : [ { "name" : "name" } ], "locator-routes" : [ { "locator-name" : "name" } ] }, "ipv4-vpn" : { "enable" : true, "policy-vpntarget" : true }, "l2vpn-evpn" : { "enable" : true, "policy-vpn-target" : true, "reflect-change-path" : true }, "link-state-unicast" : { "enable" : "True", "domain-identifier" : "192.168.1.1", "reflector-cluster-id" : 10 }, "ipv6-srpolicy" : { "enable" : "True", "nexthop-select-depend-type" : "default", "router-id-filter" : true }, "bgp-peer" : [ { "peer-ip" : "192.168.1.1", "peer-as" : "1", "local-as-number" : "1", "local-if-name" : "GE0/0/0", "local-if-address" : "192.168.1.1", "ebgp-max-hop" : 10, "auth-type" : "password", "password-type" : "cipher", "password-text" : "Example@123", "key-chain-name" : "aa", "timer" : { "keep-alive-time" : 10, "host-time" : 10, "connect-retry-time" : 10 }, "ipv4-unicast" : { "enable" : true, "allow-as-loop" : 1, "advertise-community" : true, "advertise-ext-community" : true, "nexthop-config" : "local", "prefix-sid" : "default", "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1", "route-update-interval" : 10 }, "ipv6-unicast" : { "enable" : true, "allow-as-loop" : 1, "advertise-community" : true, "advertise-ext-community" : true, "nexthop-config" : "local", "prefix-sid" : "default", "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "ipv4-vpn" : { "enable" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "l2vpn-evpn" : { "enable" : true, "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "link-state-unicast" : { "enable" : "True", "reflect-client" : true, "export-route-policy" : "policy1" }, "ipv6-srpolicy" : { "enable" : "True", "reflect-client" : true, "advertise-ext-community" : true, "graceful-restart-static-timer" : 3600 }, "bfd" : { "enable" : true, "multiplier" : 3, "min-rx-interval" : 10, "min-tx-interval" : 10 } } ] } }

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:vpn-bgp 是 REFERENCE 详细请参见表4。 VPN BGP配置。 - 表4 nes-ne-vpn-bgp-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:vpn-bgp 否 REFERENCE 详细请参见表5。 VPN BGP配置。 - 表5 vpn-bgp-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpn-instance 否 string 1~31个字符。 - VPN，单一主键字段。 "_public_" router-id 否 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - Router ID。 "10.1.0.0" ipv4-unicast 否 REFERENCE 详细请参见表6。 IPv4地址族。 - ipv6-unicast 否 REFERENCE 详细请参见表17。 IPv6地址族，6700V子设备不支持。 - ipv4-vpn 否 REFERENCE 详细请参见表28。 VPNv4地址族，AR6700V主设备不支持。 - l2vpn-evpn 否 REFERENCE 详细请参见表29。 L2 EVPN，AR6700V主设备不支持。 - link-state-unicast 否 REFERENCE 详细请参见表30。 BGP-LS，AR6700V主设备和AR6700V子设备不支持。 - ipv6-srpolicy 否 REFERENCE 详细请参见表31。 IPv6 SR-Policy，AR6700V主设备和AR6700V子设备不支持。 - bgp-peer 否 ARRAY_REFERENCE 详细请参见表32。 BGP对等体。 - 表6 nes-ne-vpn-bgp-ipv4-unicast-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能IPv4地址族，AR6700V主设备不支持。 true default-route-import 否 boolean true false - 引入默认路由，AR6700V主设备不支持。 true route-select-delay 否 int32 [0-3600] - 延迟路由回切（秒），AR6700V主设备不支持。 10 reflector-cluster-id 否 int64 [1-4294967295] - 反射器集群ID，AR6700V主设备不支持。 10 reflect-change-path 否 boolean true false - 反射器改变路径，AR6700V主设备不支持。 true auto-frr 否 boolean true false - Auto frr，AR6700V主设备不支持。 true mode 否 string be te - SRv6 模式，AR6700V主设备和AR6700V子设备不支持。 "be" down-switch 否 boolean true false - TE隧道发生故障切换TE到BE，AR6700V主设备和AR6700V子设备不支持。 true route-relay-tunnel-v6-selector 否 string 1~40个字符。 - 隧道选择器，AR6700V主设备不支持。 "policy1" preference 否 REFERENCE 详细请参见表7。 优先级，AR6700V主设备不支持。 - aggregate-route 否 ARRAY_REFERENCE 详细请参见表8。 聚合路由，AR6700V主设备不支持。 - network-route 否 ARRAY_REFERENCE 详细请参见表9。 网段路由。 - import-routing 否 ARRAY_REFERENCE 详细请参见表10。 引入路由。 - evpn 否 REFERENCE 详细请参见表11。 EVPN，AR6700V主设备和AR6700V子设备不支持。 - advertise-l2-evpn 否 REFERENCE 详细请参见表14。 通告 L2 EVPN，AR6700V主设备不支持。 - locator 否 ARRAY_REFERENCE 0-1个列表项，详细请参见表16。 Locator，AR6700V主设备和AR6700V子设备不支持。 - 表7 ipv4-unicast-preference-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 external 否 int32 [1-255] - 外部优先级。 10 internal 否 int32 [1-255] - 内部优先级。 10 local 否 int32 [1-255] - 本地优先级。 10 表8 ipv4-unicast-aggregate-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 聚合路由地址，联合主键字段。 "192.168.1.1" mask 否 int32 [0-32] - 聚合路由掩码，联合主键字段。 24 表9 ipv4-unicast-network-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 网段路由地址，联合主键字段。 "192.168.1.2" mask 否 int32 [0-32] - 网段路由掩码，联合主键字段。 24 route-policy 否 string 1~200个字符。 - 路由策略。 "policy1" 表10 ipv4-unicast-import-routing-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 protocol 否 string direct ospf isis static rip unr op-route - 引入路由协议，联合主键字段。 "static" thead-id 否 int64 [0-4294967295] - 进程 ID，联合主键字段。 10 cost 否 int64 [0-4294967295] - 花销。 10 route-policy 否 string 1~200个字符。 - 路由策略。 "policy1" 表11 ipv4-unicast-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 srv6 否 REFERENCE 详细请参见表12。 SRv6 模式。 - locator 否 ARRAY_REFERENCE 0-1个列表项，详细请参见表13。 Locator。AR6700V-L款型不支持。 - 表12 evpn-srv6-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 否 string be te - SRv6 模式。 "be" down-switch 否 boolean true false - TE隧道发生故障切换TE到BE。 true 表13 evpn-locator-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - Locator 名称，单一主键字段。 "name" 表14 ipv4-unicast-advertise-l2-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 advertise-route-to-evpn 否 ARRAY_REFERENCE 详细请参见表15。 通告 L2 EVPN。 - 表15 advertise-route-to-evpn-type-advertise-route-to-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 protocol 否 string all - 路由协议，单一主键字段。 "all" advertise-route-mode 否 string all best valid - VPN向evrf发布路由模式，AR6700V子设备不支持。 "all" 表16 ipv4-unicast-locator-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - Locator 名称，单一主键字段。 "name" 表17 nes-ne-vpn-bgp-ipv6-unicast-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能IPv6地址族，AR6700V主设备不支持。 true default-route-import 否 boolean true false - 引入默认路由，AR6700V主设备不支持。 true route-select-delay 否 int32 [0-3600] - 延迟路由回切（秒），AR6700V主设备不支持。 10 reflector-cluster-id 否 int64 [1-4294967295] - 反射器集群ID，AR6700V主设备不支持。 10 reflect-change-path 否 boolean true false - 反射器改变路径，AR6700V主设备不支持。 true auto-frr 否 boolean true false - Auto frr，AR6700V主设备不支持。 true mode 否 string be te - SRv6 模式，AR6700V主设备不支持。 "be" down-switch 否 boolean true false - TE隧道发生故障切换TE到BE，AR6700V主设备不支持。 true route-relay-tunnel-v6-selector 否 string 1~40个字符。 - 隧道选择器，AR6700V主设备不支持。 "policy1" preference 否 REFERENCE 详细请参见表18。 优先级，AR6700V主设备不支持。 - aggregate-route 否 ARRAY_REFERENCE 详细请参见表19。 聚合路由，AR6700V主设备不支持。 - network-route 否 ARRAY_REFERENCE 详细请参见表20。 网段路由 - import-routing 否 ARRAY_REFERENCE 详细请参见表21。 引入路由。 - evpn 否 REFERENCE 详细请参见表22。 EVPN，AR6700V主设备不支持。 - advertise-l2-evpn 否 REFERENCE 详细请参见表25。 通告 L2 EVPN，AR6700V主设备不支持。 - locator 否 ARRAY_REFERENCE 详细请参见表26。 配置SRv6 locator，AR6700V主设备不支持。 - locator-routes 否 ARRAY_REFERENCE 详细请参见表27。 Locator 路由，AR6700V主设备不支持。 - 表18 ipv6-unicast-preference-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 external 否 int32 [1-255] - 外部优先级。 10 internal 否 int32 [1-255] - 内部优先级。 10 local 否 int32 [1-255] - 本地优先级。 10 表19 ipv6-unicast-aggregate-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 聚合路由地址，联合主键字段。 "fc00::7" mask 否 int32 [0-128] - 聚合路由掩码，联合主键字段。 96 表20 ipv6-unicast-network-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 网段路由地址，联合主键字段。 "fc00::7" mask 否 int32 [0-128] - 网段路由掩码，联合主键字段。 96 表21 ipv6-unicast-import-routing-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 protocol 否 string direct isis static ospfv3 ripng unr - 引入路由协议，联合主键字段。 "static" thead-id 否 int64 [0-4294967295] - 进程 ID，联合主键字段。 10 cost 否 int64 [0-4294967295] - 花销。 10 route-policy 否 string 1~200个字符。 - 路由策略。 "policy1" 表22 ipv6-unicast-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 srv6 否 REFERENCE 详细请参见表23。 SRv6。 - locator 否 ARRAY_REFERENCE 0-1个列表项，详细请参见表24。 Locator。AR6700V-L款型不支持。 - 表23 srv6对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 否 string be te - SRv6 模式。 "be" down-switch 否 boolean true false - TE隧道发生故障切换TE到BE。 true 表24 unicast-evpn-locator-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - Locator 名称，单一主键字段。 "name" 表25 ipv6-unicast-advertise-l2-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 advertise-route-to-evpn 否 ARRAY_REFERENCE 详细请参见表15。 通告 L2 EVPN。 - 表26 ipv6-unicast-locator-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - Locator 名称，单一主键字段。 "name" 表27 ipv6-unicast-locator-routes-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 locator-name 否 string 1~31个字符。 - Locator 名称，单一主键字段。 "name" 表28 nes-ne-vpn-bgp-ipv4-vpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能VPNv4地址族。 true policy-vpntarget 否 boolean true false - 对接收到的VPN路由启用/禁用基于VPN目标的过滤。只有导出RT属性与本地导入RT属性匹配的VPN路由才能添加到路由表中。该选项可用于Kompella方式的跨域VPN Option B解决方案和ASBR MP-EBGP跨域L2VPN解决方案。 true 表29 nes-ne-vpn-bgp-l2vpn-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能L2 EVPN。 true policy-vpn-target 否 boolean true false - 配置VPN Target。 true reflect-change-path 否 boolean true false - 反射器改变路径，AR6700V子设备不支持。 true 表30 nes-ne-vpn-bgp-link-state-unicast-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 string - - 使能BGP-LS。 "True" domain-identifier 否 string - - 区域标识符，IPv4地址格式。 "192.168.1.1" reflector-cluster-id 否 int64 [1-4294967295] - 反射器集群ID。 10 表31 nes-ne-vpn-bgp-ipv6-srpolicy-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 string - - 使能IPv6 SR-Policy。 "True" nexthop-select-depend-type 否 string default depend-ip - 下一跳迭代到IP地址时路由参与选路。 "default" router-id-filter 否 boolean true false - Router ID过滤。 true 表32 nes-ne-vpn-bgp-bgp-peer-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 peer-ip 否 string - - 对端IPv4或IPv6地址，单一主键字段。 "192.168.1.1" peer-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。 "1" local-as-number 否 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号。 "1" local-if-name 否 string 1~63个字符。 - 接口名称。 "GE0/0/0" local-if-address 否 string - - 接口地址。 "192.168.1.1" ebgp-max-hop 否 int64 [1-255] - EBGP允许最大跳数。 10 auth-type 否 string null password keychain - 认证方式。 "password" password-type 否 string cipher simple - 密码类型。 "cipher" password-text 否 string 1~432个字符。 - 密码。 "Example@123" key-chain-name 否 string 1~47个字符。满足正则表达[^A-Z]+。 - key-chain。 "aa" timer 否 REFERENCE 详细请参见表39。 保活时间。 - ipv4-unicast 否 REFERENCE 详细请参见表33。 IPv4地址族。 - ipv6-unicast 否 REFERENCE 详细请参见表34。 IPv6地址族，AR6700V主设备和AR6700V子设备不支持。 - ipv4-vpn 否 REFERENCE 详细请参见表35。 VPNv4地址族，AR6700V主设备不支持。 - l2vpn-evpn 否 REFERENCE 详细请参见表36。 L2 EVPN，AR6700V主设备不支持。 - link-state-unicast 否 REFERENCE 详细请参见表37。 BGP-LS，AR6700V主设备和AR6700V子设备不支持。 - ipv6-srpolicy 否 REFERENCE 详细请参见表38。 IPv6 SR-Policy，AR6700V主设备和AR6700V子设备不支持。 - bfd 否 REFERENCE 详细请参见表40。 BFD。 - 表33 ipv4-unicast对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能IPv4地址族。 true allow-as-loop 否 int32 [1-10] - AS号的重复次数。 1 advertise-community 否 boolean true false - 发布团体属性。 true advertise-ext-community 否 boolean true false - 发布扩展团体属性。 true nexthop-config 否 string local invariable - 下一跳配置。 "local" prefix-sid 否 string default enable disable - 使能/去使能设备与指定的IPv6对等体交换IPv4前缀SID。 "default" reflect-client 否 boolean true false - 使能/去使能本端设备作为路由反射器（RR），将对等体或对等体组作为其客户端。此配置仅适用于IBGP对等体之间。地址族中的RR及其客户端的配置仅在该地址族中有效。因此，建议将RR及其客户端配置在所需的指定地址族中。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略，路由策略名称。 "policy1" import-route-policy 否 string 1~200个字符。 - 引入路由策略，路由策略名称。 "policy1" route-update-interval 否 int32 [0-600] - 路由更新间隔（秒）。 10 表34 ipv6-unicast对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能IPv6地址族。 true allow-as-loop 否 int32 [1-10] - AS号的重复次数。 1 advertise-community 否 boolean true false - 发布团体属性。 true advertise-ext-community 否 boolean true false - 发布扩展团体属性。 true nexthop-config 否 string local invariable - 下一跳配置。 "local" prefix-sid 否 string default enable disable - 使能/去使能设备与指定的IPv6对等体交换IPv4前缀SID。 "default" reflect-client 否 boolean true false - 使能/去使能本端设备作为路由反射器（RR），将对等体或对等体组作为其客户端。此配置仅适用于IBGP对等体之间。地址族中的RR及其客户端的配置仅在该地址族中有效。因此，建议将RR及其客户端配置在所需的指定地址族中。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略，路由策略名称。 "policy1" import-route-policy 否 string 1~200个字符。 - 引入路由策略，路由策略名称。 "policy1" 表35 ipv4-vpn对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能VPNv4地址族。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略，路由策略名称。 "policy1" import-route-policy 否 string 1~200个字符。 - 引入路由策略，路由策略名称。 "policy1" 表36 l2vpn-evpn对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能L2 EVPN。 true reflect-client 否 boolean true false - RR反射，AR6700V子设备不支持。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略，路由策略名称。 "policy1" import-route-policy 否 string 1~200个字符。 - 引入路由策略，路由策略名称。AR6700V子设备不支持。 "policy1" 表37 link-state-unicast对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 string - - 使能BGP-LS。 "True" reflect-client 否 boolean true false - RR反射。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略，路由策略名称。 "policy1" 表38 ipv6-srpolicy对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 string - - 使能IPv6 SR-Policy。 "True" reflect-client 否 boolean true false - RR反射。 true advertise-ext-community 否 boolean true false - 发布扩展团体属性。 true graceful-restart-static-timer 否 int64 [3600-2147483647] - 等待对端GR恢复的最大时间。 3600 表39 timer-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 keep-alive-time 否 int32 [0-21845] - 存活时间（秒）。 10 host-time 否 int32 [0-65535] - 存持时间（秒）。 10 connect-retry-time 否 int32 [1-65535] - 连接重传时间（秒）。 10 表40 bfd-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能BFD。 true multiplier 否 int64 [3-50] - 本地检测倍数。 3 min-rx-interval 否 int64 [3-20000] - 最小接收间隔（毫秒）。 10 min-tx-interval 否 int64 [3-20000] - 最小发送间隔（毫秒）。 10

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

请求示例 HTTP的示例 DELETE /controller/campus/rest/sdwan/v1/device/dot1x/template 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 { "ids" : ["f01f8fa3-6477-49d7-9888-3c233fe38e6f","81d04156-90eb-495d-8de5-f71f283d1af2"] }

响应示例 返回状态码为200：删除成功，响应体参考CommonResponse。 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" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考Dot1xTemplateDeleteResponse。 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 { "errcode" : "0", "errmsg" : "", "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：删除成功，响应体参考CommonResponse。 表4 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考Dot1xTemplateDeleteResponse。 表5 Dot1xTemplateDeleteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology/policy?policyName=connectionPolicy 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：删除拓扑自定义策略成功。 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" : "", "customPolicys" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "partialMeshPolicy", "priority" : 1, "rules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "matchCondition" : { "ipAddressPrefix" : { "prefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ], "ipv6PrefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "siteIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "siteNames" : ["siteName1","siteName2"] }, "applyAction" : { "siteSource" : "tenant", "nextHops" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "preference" : 2 } ], "applyMode" : "additive", "mode" : "permit" } } ], "applyToSites" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "applyToSiteNames" : ["siteName1","siteName2"] } ] } 返回状态码为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/overlay-network/{vpnId}/topology/policy 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID，UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyName 否 string - - 自定义策略名称。不填时表示删除vpn下的所有策略，填写时表示删除指定名称的策略。 "connectionPolicy"

响应示例 返回状态码为200：查询成功，响应体参考QueryDeviceInterface。 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" : [ { "interfaceName" : "GigabitEthernet0/0/2", "ipv4" : "10.1.1.1", "ipv6" : "fd00:0000:0000:0000:0000:0000:0000:0000", "alias" : "GigabitEthernet0/0/2", "mgrStatus" : "1", "runStatus" : "1", "mtu" : "9600", "vpnInstanceName" : "", "description" : "HUAWEI, AR Series, Wlan-Radio0/0/0 Interface", "tcpAdjustMss" : "0", "physAddress" : "", "ipv4ProtocalStatus" : "2", "ipv6ProtocalStatus" : "2", "bandWidth" : "1Gbps", "mode" : "1", "opticalModuleInfo" : { "partNumber" : "FTLF8519P2BNL-HW", "serialNumber" : "PHN1WE3", "manufacturer" : "FINISAR CORP.", "status" : "0" } } ] } 返回状态码为400：Invalid parameters 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

响应参数 返回状态码为200：查询成功，响应体参考QueryDeviceInterface。 表2 QueryDeviceInterface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码，0表示成功，非0表示失败。 "0" errmsg string 0~256个字符。 - 错误信息。 - data ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表3。 设备接口信息。 - 表3 DeviceInterfaceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceName string - - 接口名称。 "GigabitEthernet0/0/2" ipv4 string - - IPv4。 "10.1.1.1" ipv6 string - - IPv6。 "fd00:0000:0000:0000:0000:0000:0000:0000" alias string - - 接口别名。 "GigabitEthernet0/0/2" mgrStatus integer - - 接口管理状态，1："up", 2:"down", 3:"test" "1" runStatus int32 [1-3] - 接口运行状态或物理状态，1："up", 2:"down", 3:"test" "1" mtu integer - - MTU，单位：字节。 "9600" vpnInstanceName string - - VPN实例名称。 "" description string - - 接口描述。 "HUAWEI, AR Series, Wlan-Radio0/0/0 Interface" tcpAdjustMss string - - TCP最大报文长度，取值范围：128~2048。 "0" physAddress string - - 物理地址。 "" ipv4ProtocalStatus integer - - IPv4协议状态, 1:"UP", 2:"DOWN" "2" ipv6ProtocalStatus integer - - IPv6协议状态, 1:"UP", 2:"DOWN" "2" bandWidth string - - 带宽:"10Mbps","100Mbps","1000Mbps","1Gbps","2.5Gbps","5Gbps","10Gbps","40Gbps","100Gbps","Sauto" "1Gbps" mode integer - - 双工模式, 0:"half", 1:"full", 2:"auto" "1" opticalModuleInfo REFERENCE 详细请参见表4。 - - 表4 OpticalModuleInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 partNumber string - - 部件编码。 "FTLF8519P2BNL-HW" serialNumber string - - 序列号。 "PHN1WE3" manufacturer string - - 厂商名。 "FINISAR CORP." status integer - - 光模块状态，0正常，1异常。 "0" 返回状态码为400：Invalid parameters 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/device/queryDeviceInterface/af348227-0b07-4468-900c-d1b1637a8e97 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：接口调用成功，响应体参考QueryOverlayTunnelResponse。 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" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "mss" : 2048 } ] } 返回状态码为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