华为云用户手册

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bgpRouteInfos 是 REFERENCE 详细请参见表2。 至多支持同一站点两个设备同时创建。 - 表2 BgpPeerInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 peerInfos 否 ARRAY_REFERENCE 0-11个列表项，详细请参见表3。 BGP路由peer信息。 - 表3 BgpPeerInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID，UUID格式，创建、更新、删除必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 否 uuid - - 设备ID，UUID格式，创建、更新、删除必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId 否 uuid - - tnpID，UUID格式，tnpId和vpnId不可同时为空或同时赋值。tnpId对应物理口类型不可是LoopBack。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 uuid - - vpnID，UUID格式，tnpId和vpnId不可同时为空或同时赋值。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" peers 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 peer信息。 -

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/bgp-peer-info 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 { "peerInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "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 } } ] }, "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 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ] } ] }

请求示例 HTTP的示例 POST /v1/devicemgr/devices/dfs-groups/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 { "params" : [ { "name" : "dfs-group-name-1", "deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"], "siteId" : "9a79a511-94d0-4288-84ed-ab9710d2396c" } ] }

响应示例 返回状态码为200：创建全部成功，批量创建DfsGroup结果 { "successList" : [ { "id" : "d25de9be-1d9a-4d06-a519-09ff92fee050", "deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"] } ], "failedList" : [] } 返回状态码为207：创建部分成功，批量创建DfsGroup结果 { "successList" : [ { "id" : "d25de9be-1d9a-4d06-a519-09ff92fee050", "deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"] } ], "failedList" : [ { "errorCode" : "errorCode", "errorMsg" : "errorMsg", "name" : "dfs-group-name-1", "deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"] } ] } 返回状态码为400：参数错误或者全部失败 { "successList" : [], "failedList" : [ { "errorCode" : "errorCode", "errorMsg" : "errorMsg", "name" : "dfs-group-name-1", "deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"] } ] } 返回状态码为500：服务内部错误 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：子卡资源查询成功。 HTTP/1.1 200 OK Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "code" : 0, "data" : [ { "nedn" : "a4059c31-7ad3-11e9-b906-000c29b01448", "neName" : "AR1220-56", "framedn" : "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0", "slotdn" : "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0", "slotname" : "SRU Board 0", "subslotdn" : "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0", "frameno" : 0, "slotno" : 0, "subslotindex" : 16397, "subslotno" : 0, "descr" : "FAN Card", "subslotname" : "FAN Card 0/1", "vendortype" : ".1.3.6.1.4.1.2011.20021210.13.0", "physicalclass" : 9, "hardversion" : "VER.0", "firmversion" : "Hex:31 30 39", "softversion" : "0", "adminstatus" : 4, "operstatus" : 3, "modelname" : "--", "serialnum" : "030KSB10B3000060", "mfgname" : "Huawei" } ], "description" : "查询成功。" } 返回状态码为400：参数错误。 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404：rest接口没找到。 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：默认ServiceException异常码，应用内部错误。 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：子卡资源查询成功。 表2 SubSlotResResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - 0 操作返回码。可以是如下值之一： 0：成功 非0：失败 0 data ARRAY_REFERENCE 详细请参见表3。 - - description string - - 描述信息。 "查询成功。" 表3 SubSlotResData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nedn string - - 设备dn。 "a4059c31-7ad3-11e9-b906-000c29b01448" neName string - - 设备名称。 "AR1220-56" framedn string - - 机框dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0" slotdn string - - 单板dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0" slotname string - - 单板名称。 "SRU Board 0" subslotdn string - - 子卡dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0" frameno integer - - 机框序号。 0 slotno integer - - 单板序号。 0 subslotindex integer - - 子卡索引。 16397 subslotno integer - - 子卡序号。 0 descr string - - 子卡描述。 "FAN Card" subslotname string - - 子卡名称。 "FAN Card 0/1" vendortype string - - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.13.0" physicalclass integer - - 设备上实体大类型： 3：框 4：背板 5：子槽 6：电源 7：风扇 9：板 10：端口 9 hardversion string - - 硬件版本。 "VER.0" firmversion string - - firm版本。 "Hex:31 30 39" softversion string - - 软件版本。 "0" adminstatus integer - - 管理状态： 4、11：正常 2、3、12：错误 13：LoopBack 4 operstatus integer - - 操作状态： 3、11、13、15、16：正常 2、12、17：错误 4：离线 其他：未知 3 modelname string - - 模块名称。 "--" serialnum string - - 序列号。 "030KSB10B3000060" mfgname string - - 组件名称，物理固件的制造厂商。 "Huawei" 返回状态码为400：参数错误。 详细信息请参见实际响应消息体。 返回状态码为404：rest接口没找到。 详细信息请参见实际响应消息体。 返回状态码为500：默认ServiceException异常码，应用内部错误。 详细信息请参见实际响应消息体。

请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/rest/openapi/network/subslot?nedn=a4059c31-7ad3-11e9-b906-000c29b01448&nename=AR1220-56&framedn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0&slotdn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0&slotname=SRU Board 0&subslotdn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0&frameno=0&slotno=0&subslotindex=16397&subslotno=0&descr=FAN Card&subslotname=FAN Card 0/1&vendortype=.1.3.6.1.4.1.2011.20021210.13.0&physicalclass=9&hardversion=VER.0&firmversion=Hex:31 30 39&softversion=0&adminstatus=4&operstatus=3&modelname=--&serialnum=030KSB10B3000060&mfgname=Huawei&start=0&size=20&orderby=nedn&desc=true' HTTP的示例 GET /rest/openapi/network/subslot?nedn=a4059c31-7ad3-11e9-b906-000c29b01448&nename=AR1220-56&framedn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0&slotdn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0&slotname=SRU Board 0&subslotdn=a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0&frameno=0&slotno=0&subslotindex=16397&subslotno=0&descr=FAN Card&subslotname=FAN Card 0/1&vendortype=.1.3.6.1.4.1.2011.20021210.13.0&physicalclass=9&hardversion=VER.0&firmversion=Hex:31 30 39&softversion=0&adminstatus=4&operstatus=3&modelname=--&serialnum=030KSB10B3000060&mfgname=Huawei&start=0&size=20&orderby=nedn&desc=true HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88bybuqp7xmlup9htd5gpg4bmmrufvnt4aan

URI /rest/openapi/network/subslot 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nedn 否 string 1~100个字符。 - 设备Dn。 "a4059c31-7ad3-11e9-b906-000c29b01448" nename 否 string 1~100个字符。 - 设备名称。 "AR1220-56" framedn 否 string 1~100个字符。 - 机框Dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0" slotdn 否 string 1~100个字符。 - 单板Dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0" slotname 否 string 1~100个字符。 - 单板名称。 "SRU Board 0" subslotdn 否 string 1~100个字符。 - 子卡Dn。 "a4059c31-7ad3-11e9-b906-000c29b01448,FR=0,S=0,SS=0" frameno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 机框序号。 0 slotno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 单板序号。 0 subslotindex 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 子卡索引。 16397 subslotno 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 子卡序号。 0 descr 否 string 1~100个字符。 - 子卡描述。 "FAN Card" subslotname 否 string 1~100个字符。 - 子卡名称。 "FAN Card 0/1" vendortype 否 string 1~100个字符。 - 厂商类型。 ".1.3.6.1.4.1.2011.20021210.13.0" physicalclass 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 设备上实体大类型： 3：框 4：背板 5：子槽 6：电源 7：风扇 9：板 10：端口 9 hardversion 否 string 1~100个字符。 - 硬件版本。 "VER.0" firmversion 否 string 1~100个字符。 - 固件版本 。 "Hex:31 30 39" softversion 否 string 1~100个字符。 - 软件版本。 "0" adminstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 管理状态： 4、11：正常 2、3、12：错误 13：LoopBack 4 operstatus 否 integer 满足正则表达^([-+]?\d{1,10})$。 - 操作状态： 3、11、13、15、16：正常 2、12、17：错误 4：离线 其他：未知 3 modelname 否 string 1~100个字符。 - 模块名称。 "--" serialnum 否 string 1~100个字符。 - 序列号。 "030KSB10B3000060" mfgname 否 string 1~100个字符。 - 组件名称，物理固件的制造厂商。 "Huawei" start 否 integer - 0 指定从哪个起始记录位置开始返回查询结果集。缺省值是0。说明：如果值小于0，将使用缺省值。 0 size 否 integer - 20 指定返回查询结果集总数。缺省值是20。说明：如果值小于0，将使用缺省值。 20 orderby 否 string - nedn 指定查询结果集采用的排序字段。缺省排序字段是nedn。可指定的排序字段包括：nedn、nename、framedn、slotdn、slotname。说明：指定多个排序字段时字段间用英文半角逗号“,”分隔。 "nedn" desc 否 boolean - false 指定查询结果是否按降序排序。缺省值是false。说明：此请求参数只有指定了“orderby”请求参数后才有效。 true

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/lswstp/sites/fbb684c8-0d37-496f-bafa-4b06db151e2e/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 { "mstpRegions" : [ { "regionId" : "fbb684c8-0d37-496f-bafa-4b06e5151e2e", "mstpRegionInstances" : [ { "instanceId" : 1, "regionInstanceDevices" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e" } ] } ], "regionDeviceList" : [ "" ] } ] }

响应示例 返回状态码为200：删除成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : { "stpMode" : 1, "mstpRegions" : [ { "regionId" : "fbb684c8-0d37-496f-bafa-4b06e5151e2e", "regionName" : "stp_region", "revisionLevel" : 0, "mstpRegionInstances" : [ { "instanceId" : 0, "mapVlan" : "1,3-10", "regionInstanceDevices" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : 15 } ] } ], "regionDeviceList" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "LSW" } ] } ], "rstpConfig" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : 15 } ] } }

典型场景 提供配置参数的接口，删除交换机MSTP配置。 1、若只传入regionId，删除对应的MSTPregion； 2、若只传入regionId和instanceId，则删除指定regionId下的instanceId对应的mstpRegionInstance； 3、若只传入regionId和deviceId，则删除指定regionId下的regionDeviceList中的deviceId，且会删除指定regionID下，所有instance下的deviceId对应的regionInstanceDevice； 4、若传入regionId、instanceId和deviceId，只删除指定regionId下指定instanceId下的regionInstanceDevice，instanceId为0的树无法删除。

URI /controller/campus/v1/networkservice/networkconfig/net/lswstp/sites/{siteId}/action/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06db151e2e"

响应示例 返回状态码为200：当前站点下所有AP设备射频配置信息，返回结构体参见DeviceRadioConfigResponsesDto。 HTTP/1.1 200 OK Date: Sun,16 Feb 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, "data" : [ { "deviceId" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "deviceName" : "21500829352SH1904172", "radio2dot4Enabled" : true, "radio2dot4Power" : "auto", "radio2dot4Channel" : "auto", "radio2Support" : true, "antenna2Dot4Gain" : "6", "radio2Dot4Bandwidth" : "20mhz", "radio5Enabled" : true, "radio5Power" : "auto", "radio5Channel" : "auto", "radio5Channel2" : "auto", "radio5Support" : true, "antenna5Gain" : "6", "radio5Bandwidth" : "20mhz", "globalFlexibleRadio" : 1, "flexibleRadio" : 0, "redundancy" : true, "frequency" : "", "workMode" : "", "radio2th5Enabled" : true, "radio2th5Power" : "", "radio2th5Channel" : "", "antenna2th5Gain" : "0", "radio2th5Bandwidth" : "20mhz", "radio2th5Support" : false, "radio5BandwidthEnable" : false, "radio2BandwidthEnable" : false, "radio2th5BandwidthEnable" : false, "mode" : "default", "radio2th5SupportMode" : "0", "radio2RFType" : 1, "fastpassusers2gEnable" : true, "fastpassusers2gNum" : 5, "fastpassusers2gPeriod" : "20ms", "fastpassusers2gRatio" : 25, "fastpassusers5gEnable" : true, "fastpassusers5gNum" : 5, "fastpassusers5gPeriod" : "20ms", "fastpassusers5gRatio" : 25, "fastpassusers6gEnable" : true, "fastpassusers6gNum" : 5, "fastpassusers6gPeriod" : "20ms", "fastpassusers6gRatio" : 25 } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：当前站点下所有AP设备射频配置信息，返回结构体参见DeviceRadioConfigResponsesDto。 表2 DeviceRadioConfigResponsesDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 设备射频配置数量。 1 data ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 站点下所有AP设备射频配置信息，结构体参见DeviceRadioEntityApiDto。 - 表3 DeviceRadioEntityApiDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string - - 设备ID。 "fbde1c5d-5b94-49e3-a912-48641015e45c" deviceName string 1~64个字符。 - 设备名称。 "21500829352SH1904172" radio2dot4Enabled boolean true false - 2.4G射频使能。 true radio2dot4Power string - - 2.4G射频发射功率，auto，[1,127]。 "auto" radio2dot4Channel string - - 2.4G射频信道，不同国家码，对应不同的射频信道范围。 "auto" radio2Support boolean true false - 是否支持2.4G射频。 true antenna2Dot4Gain string - - 2.4G射频天线增益，0~30。 "6" radio2Dot4Bandwidth string auto 20mhz 40mhz-plus 40mhz-minus - 2.4G射频频宽。 "20mhz" radio5Enabled boolean true false - 5G射频使能。 true radio5Power string - - 5G射频发射功率，auto，[1,127]。 "auto" radio5Channel string - - 5G射频信道，不同国家码，对应不同的射频信道范围。 "auto" radio5Channel2 string - - 5G射频第二信道, 当radio5Bandwidth为80plus80mhz时，为必填项，不同国家码，对应不同的射频信道范围。 "auto" radio5Support boolean true false - 是否支持5G射频。 true antenna5Gain string - - 5G射频天线增益，0~30。 "6" radio5Bandwidth string auto 20mhz 40mhz-plus 40mhz-minus 80mhz 80plus80mhz 160mhz - 5G射频频宽。 "20mhz" globalFlexibleRadio int32 [0-2] - 全局DCA双频调整开关 disable:0/autoSwitch:1/autoOff:2。 1 flexibleRadio int32 [0-1] - 2.4G接口双频调整开关 disable:0/enable:1 0 redundancy boolean true false - 2.4G是否冗余。 true frequency string - - 2.4G经过调整后的工作频率 - workMode string - - 2.4G经过调整后的工作状态 - radio2th5Enabled boolean true false - 2th 5G/6G射频使能。 true radio2th5Power string - - 2th 5G/6G射频发射功率 - radio2th5Channel string - - 2th 5G/6G射频发射信道 - antenna2th5Gain string - - 2th 5G/6G射频天线增益（范围0~30） "0" radio2th5Bandwidth string - - 2th 5G/6G射频频宽，20mhz、40mhz-plus、40mhz-minus、80mhz、80plus80mhz、160mhz "20mhz" radio2th5Support boolean true false - 是否支持2th 5G/6G射频 设备系列分类与国家码来确定2th 5G射频是否支持。 false radio5BandwidthEnable boolean true false - 带宽使能。 false radio2BandwidthEnable boolean true false - 带宽使能,在调优场景2.4G有可能变5G，此时要支持dbs功能。 false radio2th5BandwidthEnable boolean true false - 2th 带宽使能。 false mode string - - 射频模式 "default" radio2th5SupportMode string - - 三射频模式(0:不支持三射频;1:支持三射频且模式切换为三射频时做高低频限制;2:支持三射频都做高低频限制) "0" radio2RFType int32 - 1 wlan-radio 0/0/2接口射频类型 2.4g:0/5g:1/6g:2。默认值为1。 1 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 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 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 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/site/fbde1c5d-5b94-49e3-a912-48641015e45c/apradio/radios 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：删除成功，响应体参考DeleteACLResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errCode" : "0", "errMsg" : "" } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/acl/basic/action/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 { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "aclNum" : 2100, "type" : "IPv4" }

响应参数 返回状态码为200：删除成功，响应体参考DeleteACLResponse。 表3 DeleteACLResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deleteReq 是 REFERENCE 详细请参见表2。 删除基础ACL信息。 - 表2 DeleteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid 0~36个字符。 - 站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid 0~36个字符。 - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" aclNum 是 int32 [2000-2999] - 基础ACL的ACL编号。 2100 type 否 string 0~8个字符。 IPv4 基础ACL类型，该字段可以设置为以下几种： a) IPv4 b) IPv6 默认为IPv4。 "IPv4"

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/application/detection-url 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 { "detectionUrlInfos" : [ { "id" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 1 } ] }

响应示例 返回状态码为200：修改成功，响应体参考DetectionUrlResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 1 } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 1 } } ] } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：查询成功。 { "errcode": "0", "errmsg": "", "data": { "id": "242214f2-8a69-4b48-bf8c-1988e78cb9be", "siteId": "1c5e4554-aee4-4f62-ac3e-1460d6a6e3bf", "tenantId": "120196a60c6e4dde8a024a6f2039869b", "progress": 100, "deviceCreationResult": { "successList": [ { "id": "8015be0e-0e38-4dba-8378-bf7451d62393", "name": "CORE1", "esn": "2102355HUL2023021801", "type": "S16700-4", "deviceRole": "CORE", "description": "", "stackName": null, "stackSlotId": null, "stackPriority": null, "wacEsn": "", "wacName": null, "mlagName": "CORE", "mlagMode": "active-active", "mlagPriority": 150 }, { "id": "e83febb7-6894-4bc9-ad40-85c242a85d59", "name": "CORE2", "esn": "2102355HUN0123451108", "type": "S16700-4", "deviceRole": "CORE", "description": "", "stackName": null, "stackSlotId": null, "stackPriority": null, "wacEsn": "", "wacName": null, "mlagName": "CORE", "mlagMode": "active-active", "mlagPriority": null }, { "id": "6cb43fa7-c79c-4f77-baa7-8b13501365c9", "name": "AGG1_1", "esn": "102225213523", "type": "S6730-H24X6C-V2", "deviceRole": "AGG", "description": "", "stackName": null, "stackSlotId": null, "stackPriority": null, "wacEsn": "", "wacName": null, "mlagName": "AGG1", "mlagMode": "active-active", "mlagPriority": 150 }, { "id": "19556b05-96f4-4ce0-b613-e82d520524f5", "name": "AGG1_2", "esn": "102358054998", "type": "S6730-H48X6CZ-V2", "deviceRole": "AGG", "description": "", "stackName": null, "stackSlotId": null, "stackPriority": null, "wacEsn": "", "wacName": null, "mlagName": "AGG1", "mlagMode": "active-active", "mlagPriority": null } ], "failedList": [] }, "boardCreationResult": { "successList": [ { "devId": "8015be0e-0e38-4dba-8378-bf7451d62393", "deviceName": "CORE1", "slotId": "slot3", "slotType": "LSH7C36HX1E0" }, { "devId": "e83febb7-6894-4bc9-ad40-85c242a85d59", "deviceName": "CORE2", "slotId": "slot3", "slotType": "LSH7C36HX1E0" }, { "devId": "8015be0e-0e38-4dba-8378-bf7451d62393", "deviceName": "CORE1", "slotId": "slot2", "slotType": "LSH7L36QX1E0" }, { "devId": "e83febb7-6894-4bc9-ad40-85c242a85d59", "deviceName": "CORE2", "slotId": "slot2", "slotType": "LSH7L36QX1E0" }, { "devId": "8015be0e-0e38-4dba-8378-bf7451d62393", "deviceName": "CORE1", "slotId": "slot1", "slotType": "LSH7C18HX1E0" }, { "devId": "e83febb7-6894-4bc9-ad40-85c242a85d59", "deviceName": "CORE2", "slotId": "slot4", "slotType": "LSH7X48SX1E0" } ], "failedList": [] }, "linkCreationResult": { "successList": [ { "srcPortName": "100GE3/0/35", "srcDevName": "CORE1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "100GE3/0/34", "dstDevName": "CORE2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "100GE3/0/35", "srcDevName": "CORE1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "100GE3/0/35", "dstDevName": "CORE2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "100GE3/0/35", "srcDevName": "CORE1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "100GE3/0/34", "dstDevName": "CORE2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "100GE3/0/35", "srcDevName": "CORE1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "100GE3/0/35", "dstDevName": "CORE2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "40GE2/0/34", "srcDevName": "CORE1", "srcEthTrunk": "", "srcEthPnpStartSwitchEnable": true, "dstPortName": "40GE2/0/34", "dstDevName": "CORE2", "dstEthTrunk": "", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "dual-active-detect-link", "mlagIpPoolName": "1", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/1", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/2", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/3", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/1", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/2", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/3", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/1", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/2", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "srcEthPnpStartSwitchEnable": false, "dstPortName": "10GE1/0/3", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "peer-link", "mlagIpPoolName": "", "mlagId": null }, { "srcPortName": "10GE1/0/4", "srcDevName": "AGG1_1", "srcEthTrunk": "", "srcEthPnpStartSwitchEnable": true, "dstPortName": "10GE1/0/4", "dstDevName": "AGG1_2", "dstEthTrunk": "", "dstEthPnpStartSwitchEnable": false, "mlagLinkType": "dual-active-detect-link", "mlagIpPoolName": "1", "mlagId": null } ], "failedList": [] }, "stackCreationResult": { "successList": [], "failedList": [] }, "mlagGroupCreationResult": { "successList": [ { "id": "1218fc42-7a6b-451a-a042-cfda7bab81f3", "name": "CORE", "groupId": 1, "mode": null, "mlagMember": [ { "id": "8015be0e-0e38-4dba-8378-bf7451d62393", "name": "CORE1", "esn": "2102355HUL2023021801", "type": "S16700-4", "deviceRole": "CORE", "description": "", "stackName": null, "stackSlotId": null, "stackPriority": null, "wacEsn": "", "wacName": null, "mlagName": "CORE", "mlagMode": "active-active", "mlagPriority": 150 }, { "id": "e83febb7-6894-4bc9-ad40-85c242a85d59", "name": "CORE2", "esn": "2102355HUN0123451108", "type": "S16700-4", "deviceRole": "CORE", "description": "", "stackName": null, "stackSlotId": null, "stackPriority": null, "wacEsn": "", "wacName": null, "mlagName": "CORE", "mlagMode": "active-active", "mlagPriority": null } ] }, { "id": "d12eed03-e7fd-4e0e-b4bb-113da7851514", "name": "AGG1", "groupId": 1, "mode": null, "mlagMember": [ { "id": "6cb43fa7-c79c-4f77-baa7-8b13501365c9", "name": "AGG1_1", "esn": "102225213523", "type": "S6730-H24X6C-V2", "deviceRole": "AGG", "description": "", "stackName": null, "stackSlotId": null, "stackPriority": null, "wacEsn": "", "wacName": null, "mlagName": "AGG1", "mlagMode": "active-active", "mlagPriority": 150 }, { "id": "19556b05-96f4-4ce0-b613-e82d520524f5", "name": "AGG1_2", "esn": "102358054998", "type": "S6730-H48X6CZ-V2", "deviceRole": "AGG", "description": "", "stackName": null, "stackSlotId": null, "stackPriority": null, "wacEsn": "", "wacName": null, "mlagName": "AGG1", "mlagMode": "active-active", "mlagPriority": null } ] } ], "failedList": [] } } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：查询成功。 表2 TopoPlanQueryResDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "参数非法" data REFERENCE 详细请参见表3。 返回数据 - 表3 TopoPlanQueryModelDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 36个字符。 - 网络规划主键ID。 "bc1846c5-2eff-6d4d-2a2d-23dff3d12344" siteId uuid 36个字符。 - 站点ID。 "acc846c5-2fff-694d-2b2d-12dff3d1231a" tenantId string 32个字符。 - 租户ID。 "fbb684c80d37496fbafa4b06d5151e2e" progress integer [0-100] - 网络规划创建进度。取值范围0-100，100表示资源创建完成。 0 deviceCreationResult REFERENCE 详细请参见表4。 - - boardCreationResult REFERENCE 详细请参见表9。 - - linkCreationResult REFERENCE 详细请参见表12。 - - stackCreationResult REFERENCE 详细请参见表15。 - - mlagGroupCreationResult REFERENCE 详细请参见表18。 - - 表4 DeviceCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-500个列表项，详细请参见表5。 创建设备成功列表 - failedList ARRAY_REFERENCE 0-500个列表项，详细请参见表6。 创建设备失败列表 - 表5 TopoPlanDeviceDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 order int32 [0-500] - 设备序号 0 id uuid 36个字符。 - 设备id，UUID格式。 "813a76d4-6eec-4264-ae45-a6f261482b60" name string 1~64个字符。 - 设备名称。最多允许输入64个字符。设备名称不能重复。 "device1" esn string 0~40个字符。 - 设备ESN。10~40个字符，由英文字母和数字组成。如果“ESN”为空，则“设备名称”和“设备型号”为必填字段。如果“ESN”不为空，也推荐填写“设备型号”，否则可能添加失败。 "AA980106121234567893" type string 0~32个字符。 - 设备型号。 "S12704" deviceRole string 0~32个字符。满足正则表达^(CORE|Gateway|Gateway\+CORE|Gateway\+vRR|Firewall|ACC|AGG|WAC|AP|)$。 ACC 设备角色，取值：CORE|Gateway|Gateway+CORE|Gateway+vRR|Firewall|ACC|AGG|WAC|AP "ACC" description string 0~255个字符。 - 描述 "ACC1" stackName string 0~64个字符。 - 堆叠名称。（堆叠设备必填，非堆叠设备无需填写），不能包含“？”'、"?"或制表符TAB "ACC1" stackSlotId int32 [0-9] - （堆叠设备必填，非堆叠设备无需填写）盒式设备范围为0~9，框式设备范围为1~2，并且同一堆叠内的堆叠编号不重复。 1 stackPriority int32 [1-255] 100 堆叠优先级。（非必填）请输入数字，范围为1~255。如果堆叠设备此字段不填写，默认为100 2 wacEsn string 0~40个字符。 - WAC设备ESN。（非必填）由英文字母和数字组成。将Fit Ap设备与所填写的WAC ESN关联。 "AA980106121234567893" wacName string 0~64个字符。 - WAC设备名称。 "device1" mlagName string 0~64个字符。 - M-LAG组名称。(非必填) 1、相同MLAG组名称的设备,自动组成M-LAG设备组 2、DFS Group ID默认为1, 随机生成认证密码, 优先级随机取一台为150 3、成员口为双活模式。最多允许输入64个字符。 "mlag1" mlagMode string 0~20个字符。满足正则表达^(active-active|active-standby|)$。 - M-LAG模式,active-active / active-standby。 "active-active" mlagPriority int32 [1-255] - M-LAG优先级。 2 表6 DeviceCreationFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanDeviceDto REFERENCE 详细请参见表5。 设备创建失败信息 - 表7 Errcode对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 Errcode string 0~36个字符。 - 错误码 - 表8 Errmsg对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 Errmsg string 0~256个字符。 - 错误描述 - 表9 BoardCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-500个列表项，详细请参见表10。 创建单板成功列表 - failedList ARRAY_REFERENCE 0-500个列表项，详细请参见表11。 创建单板失败列表 - 表10 TopoPlanBoardDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 devId string 36个字符。 - 设备id，UUID格式。 "813a76d4-6eec-4264-ae45-a6f261482b60" deviceName string 1~64个字符。 - 设备名称。（必填）堆叠设备支持填写设备名称或堆叠名称。 "21500829352SH1904172" slotId string 0~8个字符。 - 堆叠编号，v5盒式设备为0-8，pnf盒式设备为1-9,框式设备为1-2。 "slot1/4" slotType string 1~12个字符。 - 单板型号。 "LSG7SRUEX500" 表11 BoardCreationFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanBoardDto REFERENCE 详细请参见表10。 创建单板失败信息 - 表12 LinkCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-2000个列表项，详细请参见表13。 创建链路成功列表 - failedList ARRAY_REFERENCE 0-2000个列表项，详细请参见表14。 创建链路失败列表 - 表13 TopoPlanLinkDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 order int32 [0-2000] - 设备链路序号 0 srcPortName string 1~30个字符。 - 上游设备物理端口号。设备真实存在的物理端口 "GigabitEthernet0/0/1" srcDevName string 1~64个字符。 - 上游设备名称。堆叠设备支持填写设备名称或堆叠名称。 "device1" srcEthTrunk string 0~14个字符。 - 上游设备端Eth-Trunk名称。（Eth-Trunk链路必填）Eth-Trunk1~1023之间的整数。当前接口是下行接口，除M-LAG Peer-Link与双主检测链路外，均默认开启Eth-Trunk自协商（单设备的Eth-Trunk不可重复使用） "Eth-Trunk1" srcEthPnpStartSwitchEnable boolean true false false 源EthTrunk PNP启动开关使能。 false dstPortName string 1~30个字符。 - 下游设备物理端口号。设备真实存在的物理端口 "GigabitEthernet1/0/1" dstDevName string 1~64个字符。 - 下游设备名称。（必填）最多允许输入64个字符。堆叠设备支持填写设备名称或堆叠名称。 "device2" dstEthTrunk string 0~14个字符。 - 下游设备端Eth-Trunk名称。（Eth-Trunk链路必填）Eth-Trunk1~1023之间的整数（单设备的Eth-Trunk不可重复使用） "Eth-Trunk2" dstEthPnpStartSwitchEnable boolean true false false 目的EthTrunk PNP启动开关使能。 false mlagLinkType string 0~24个字符。满足正则表达^(peer-link|member-link|dual-active-detect-link|)$。 - M-LAG链路类型。peer-link|member-link|dual-active-detect-link "peer-link" mlagIpPoolName string 0~32个字符。 - 双主检测链路IP资源池。(M-LAG链路类型为双主检测链路时必填)允许输入1~32位英文字母、数字或特殊符号(问号和空格除外) "pool1" mlagId string 0~12个字符。 - 上、下游端口M-LAG ID。(非必填)双归接入端口跨设备定义为相同的ID，M-LAG ID取值范围1-2048。上、下游值需用","分隔，同时指定。上下游端口M-LAG ID输入示例 "1,2"， 指定上游端口M-LAG ID示例 "1" "1,2" 表14 LinkCreationFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanLinkDto REFERENCE 详细请参见表13。 创建链路失败信息 - 表15 StackCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-500个列表项，详细请参见表16。 创建堆叠成功列表 - failedList ARRAY_REFERENCE 0-500个列表项，详细请参见表17。 创建堆叠失败列表 - 表16 TopoPlanStackDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 36个字符。 - 堆叠设备id，UUID格式。 "813a76d4-6eec-4264-ae45-a6f261482b60" name string 1~64个字符。 - 堆叠设备名称。 "stack1" stackRole string 0~32个字符。 - 堆叠角色。 "CORE" stackMember ARRAY_REFERENCE 1-9个列表项，详细请参见表5。 堆叠成员信息。 - 表17 StackCreationFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanStackDto REFERENCE 详细请参见表16。 创建堆叠失败信息 - 表18 MlagGroupCreationResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-500个列表项，详细请参见表19。 创建M-Lag组成功列表 - failedList ARRAY_REFERENCE 0-500个列表项，详细请参见表20。 创建M-Lag组失败列表 - 表19 TopoPlanMlagGroupDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 36个字符。 - M-Lag组id。 "18f461fa-4f1b-3e2b-90e4-f3d29d0dcf9b" name string 0~64个字符。 - M-Lag组名称。 "mlag1" groupId int32 [1-2048] - M-LAG ID 1 mode string 0~20个字符。满足正则表达^(active-active|active-standby|)$。 - M-LAG模式,active-active / active-standby。 "active-active" mlagMember ARRAY_REFERENCE 0-6个列表项，详细请参见表5。 M-LAG成员 - 表20 TopoPlanMlagGroupFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode REFERENCE 详细请参见表7。 错误码 - errmsg REFERENCE 详细请参见表8。 错误描述 - topoPlanMlagGroupDto REFERENCE 详细请参见表19。 创建M-LAG失败信息 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /v1/networkservice/sites/f3a4f7d3-2f1e-4b2a-9f4c-1c2d2a4e5b6c/topo-plans/bc1846c5-2eff-6d4d-2a2d-23dff3d12344 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

URI /v1/networkservice/sites/{siteId}/topo-plans/{id} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid 36个字符。 - 站点id "f3a4f7d3-2f1e-4b2a-9f4c-1c2d2a4e5b6c" id 是 uuid 36个字符。 - 网络规划创建时的id "bc1846c5-2eff-6d4d-2a2d-23dff3d12344"

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-global HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-dhcpv4:dhcpv4-global" : { "enable" : false, "option82" : { "global-formats" : { "global-format" : [ { "sub-option-type" : "remote-id", "option82-format" : "user-defined", "user-defind-text" : "77" } ] }, "encapsulation" : { "suboption" : "circuit-id remote-id subscriber-id vendor-specific-id" } } } }

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 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,16 Feb 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-dhcpv4:dhcpv4-global 是 REFERENCE 详细请参见表4。 全局DHCP配置。 - 表4 dhcpv4-global-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:dhcpv4-global 否 REFERENCE 详细请参见表5。 全局DHCP配置。 - 表5 dhcpv4-global-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能全局DHCP。 false option82 否 REFERENCE 详细请参见表6。 配置DHCP option82特性。AR6700V主设备和AR6700V子设备不支持。 - 表6 option82-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global-formats 否 REFERENCE 详细请参见表7。 Option82全局格式列表。 - encapsulation 否 REFERENCE 详细请参见表9。 配置DHCP Option82域子选项。 - 表7 global-formats-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global-format 否 ARRAY_REFERENCE 详细请参见表8。 配置DHCP Option82全局模式。 - 表8 global-formats-global-format-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sub-option-type 是 string circuit-id remote-id circuit-remote - DHCP option82全局子选项类型，单一主键字段。 "remote-id" option82-format 否 string common extend user-defined default type1 type2 self-define default-extra cn-telecom self-define-extra intracom-vxlan cn-telecom-inherit - DHCP option82子选项格式类型。 "user-defined" user-defind-text 否 string 0~255个字符。满足正则表达([^ ]{0,})。 - 用户定义DHCP Option82格式。关键词包含: sysname, portname, porttype, iftype, mac, slot, subslot, port, sVLAN, cVLAN,和length.可进行如下配置: '%portname:%sVLAN.%cVLAN %sysname/0/0/0/0/0' 或 0 %length %sVLAN %5slot %3subslot %8port 等等。请参考用户操作手册获取更多信息。 "77" 表9 encapsulation-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 suboption 否 string - - 配置DHCP Option82域子选项。 "circuit-id remote-id subscriber-id vendor-specific-id"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:dhcpv4-global 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 DELETE /controller/sdwan/v1/naas/device HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000" }