华为云用户手册

URI /controller/campus/api/v1/networkconfig/loopback/device/{deviceId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d6151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 filter 否 string 0~256个字符。 - 过滤条件。 "pageIndex::1|pageSize::20"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nat-policy:nat-policy-rules/{name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" name 是 string 1~63个字符。 - 策略的名称，单一主键字段。 "rules@name"

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

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-policy:nat-policy-rules/rules%40name 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-nat-policy:nat-policy-rules" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "rules@name", "action" : { "source-nat" : { "address-group-name" : "addressgroupname" } }, "source-zone" : [ "sourcezone" ], "destination-zone" : [ "destinationzonename" ], "egress-interface" : [ "egressinterfacename" ], "source-nat" : { "address-group-name" : "addressgroupname", "easy-ip" : "True" }, "source-address" : { "address-ipv4s" : { "address-ipv4" : [ { "ipv4" : "10.1.1.1", "mask" : "255.255.0.0" } ] }, "address-ipv4-ranges" : { "address-ipv4-range" : [ { "start-ipv4" : "10.1.1.1", "end-ipv4" : "10.1.1.1" } ] } }, "destination-address" : { "address-ipv4s" : { "address-ipv4" : [ { "ipv4" : "10.1.1.1", "mask" : "255.255.0.0" } ] }, "address-ipv4-ranges" : { "address-ipv4-range" : [ { "start-ipv4" : "10.1.1.1", "end-ipv4" : "10.1.1.1" } ] } }, "service" : { "service-items" : { "protocol-and-ports" : { "protocol-and-port" : [ { "protocol" : "tcp", "source-port" : "65501", "dest-port" : "65502" } ] }, "protocol" : { "protocol-id" : [ 199 ] } } } } ] }

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls-if:mpls-if 是 REFERENCE 详细请参见表4。 接口MPLS配置参数。 - 表4 nes-ne-mpls-if-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls-if:mpls-if 否 REFERENCE 详细请参见表5。 接口MPLS配置参数。 - 表5 mpls-if-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 if-name 否 string 1~63个字符。 - 接口名称，单一主键字段。 "GE0/0/1"

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-mpls-if:mpls-if 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-mpls-if:mpls-if" : { "if-name" : "GE0/0/1" } }

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-mpls-if:mpls-if 表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/v2/banner/banner/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 { "bannerIds" : ["be6e6d19-815a-4959-93ea-0e369ce3be0f"] }

响应示例 返回状态码为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" : "" }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:ext-community-filter/{name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" name 是 string - - 名称，整数形式时范围1-199，字符串形式时1-51个字符且不能都是数字，单一主键字段。 "filter1"

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:ext-community-filter/filter1 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "huawei-nce-e-route-policy:ext-community-filter" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "filter1", "filter-type" : "basic", "basic-node" : [ { "sequence" : 1, "match-mode" : "permit", "ext-community-member" : [ { "value" : "1:1" } ] } ] } ] } 返回状态码为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：批量删除组织成功，响应体参考BatchOperOrgOut。 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" : "", "successList" : ["/org1/org2","/org11/org22"], "failList" : [ { "org" : "/org1/org2", "errcode" : "0", "errmsg" : "" } ] }

请求示例 HTTP的示例 POST /controller/campus/api/v1/organization/id/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 { "orgs" : ["b473118d-17ff-4f4f-9fa9-a4c0e1e87e42","5f051024-f9bb-49f4-9cd5-2c08d7965f69"], "cascade" : true }

响应参数 返回状态码为200：使能成功。 表10 NacConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表3。 Nac配置信息 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /controller/campus/rest/sdwan/v1/device/nac/config HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "nacInterface" : { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceInfo" : [ { "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "interfaceIds" : [ "fbb684c8-ddaa-3451-bafa-4b06d5158956" ] } ] }, "nacProfile" : { "nacProfileName" : "d1", "authenDomainName" : "isp1", "nacType" : "portal" }, "radiusServerInfo" : { "id" : "6f6b816e-f130-46e2-be42-dd4d92db4c3e", "serverName" : "RadiusServer1", "desc" : "RADIUS服务器", "sharedKey" : "", "isContainDomainName" : true, "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" } }, "portalInfo" : { "portalMode" : "direct", "enableBackupServer" : false, "escapeMode" : "none,all,custom", "escapeProfileId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "escapeProfileName" : "none", "primaryPortalServerInfo" : { "portalServerProfileId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "portalServerProfileName" : "portalProfile", "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "urlTempDevIpAddress" : "10.134.6.5" }, "secondPortalServerInfo" : { "portalServerProfileId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "portalServerProfileName" : "portalProfile", "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "urlTempDevIpAddress" : "10.134.6.5" } } }

响应示例 返回状态码为200：使能成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "nacInterface" : { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceInfo" : [ { "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "interfaceIds" : [ "fbb684c8-ddaa-3451-bafa-4b06d5158956" ] } ] }, "nacProfile" : { "nacProfileName" : "d1", "authenDomainName" : "isp1", "nacType" : "portal" }, "radiusServerInfo" : { "id" : "6f6b816e-f130-46e2-be42-dd4d92db4c3e", "serverName" : "RadiusServer1", "desc" : "RADIUS服务器", "sharedKey" : "", "isContainDomainName" : true, "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "10.134.6.5", "loopbackInterface" : "601" } }, "portalInfo" : { "portalMode" : "direct", "enableBackupServer" : false, "escapeMode" : "none,all,custom", "escapeProfileId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "escapeProfileName" : "none", "primaryPortalServerInfo" : { "portalServerProfileId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "portalServerProfileName" : "portalProfile", "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "urlTempDevIpAddress" : "10.134.6.5" }, "secondPortalServerInfo" : { "portalServerProfileId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "portalServerProfileName" : "portalProfile", "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "urlTempDevIpAddress" : "10.134.6.5" } } } } 返回状态码为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：查询认证设备成功，响应体参考DeviceListApiDto。 HTTP/1.1 200 OK Date: Tue,16 Aug 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "pageIndex" : "1", "pageSize" : "40", "totalRecords" : 1000, "data" : [ { "name" : "device", "description" : "this is device", "ip" : "10.254.254.254", "backupIp" : "10.254.254.253", "deviceGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "series" : "Cisco Catalyst", "enableRadius" : true, "radiusParam" : { "accountingKey" : "******", "authenKey" : "******", "coaPort" : 1700, "accountingPeriod" : 5, "macPwdEnable" : false, "macAuthPwd" : "******", "radiusServiceTypeEnable" : false, "radiusServiceTypeDevice" : 8, "radiusServiceTypeTerminal" : 4 }, "enablePortal" : true, "portalParam" : { "protol" : "CMCC Portal", "portalKey" : "******", "urlKey" : "******", "stations" : ["10.254.254.254"], "enableUserSync" : false, "port" : 80, "portalServiceTypeEnable" : true, "portalServiceTypeTerminal" : 4 }, "enableTacacs" : true, "tacacsParam" : { "key" : "******" }, "id" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" } ] } 返回状态码为400：校验异常 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/accesscfg/device/authdevice/list HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "pageIndex" : "1", "pageSize" : "40", "deviceGroupId" : "51cdcbe3-5e14-492b-ab27-86950b661d19", "name" : "devname" }

响应参数 返回状态码为200：查询认证设备成功，响应体参考DeviceListApiDto。 表3 DeviceListApiDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 [0-2147483647] - 页面索引。 "1" pageSize int32 [0-1000] - 页面大小。 "40" totalRecords int32 - - 总数。 1000 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表8。 认证设备列表。 - 返回状态码为400：校验异常 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryInputDto 是 REFERENCE 详细请参见表2。 查询认证设备参数。 - 表2 ApiQueryInputDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [0-2147483647] - 页面索引。 "1" pageSize 是 int32 [0-1000] - 页面大小。 "40" deviceGroupId 否 string - - 准入设备组ID，uuid格式。 "51cdcbe3-5e14-492b-ab27-86950b661d19" name 否 string 0~64个字符。 - 设备名称，支持模糊查询。 "devname"

请求示例 HTTP的示例 { "deviceList": [ { "esn": "2102355HUL2023021801", "name": "CORE1", "type": "S16700-4", "description": "", "stackName": "", "stackSlotId": "", "stackPriority": "", "wacEsn": "", "mlagName": "CORE", "deviceRole": "CORE" }, { "esn": "2102355HUN0123451108", "name": "CORE2", "type": "S16700-4", "description": "", "stackName": "", "stackSlotId": "", "stackPriority": "", "wacEsn": "", "mlagName": "CORE", "deviceRole": "CORE" }, { "esn": "102225213523", "name": "AGG1_1", "type": "S6730-H24X6C-V2", "description": "", "stackName": "", "stackSlotId": "", "stackPriority": "", "wacEsn": "", "mlagName": "AGG1", "deviceRole": "AGG" }, { "esn": "102358054998", "name": "AGG1_2", "type": "S6730-H48X6CZ-V2", "description": "", "stackName": "", "stackSlotId": "", "stackPriority": "", "wacEsn": "", "mlagName": "AGG1", "deviceRole": "AGG" } ], "slotList": [ { "deviceName": "CORE1", "slotId": "slot3", "slotType": "LSH7C36HX1E0" }, { "deviceName": "CORE2", "slotId": "slot3", "slotType": "LSH7C36HX1E0" }, { "deviceName": "CORE1", "slotId": "slot2", "slotType": "LSH7L36QX1E0" }, { "deviceName": "CORE2", "slotId": "slot2", "slotType": "LSH7L36QX1E0" }, { "deviceName": "CORE1", "slotId": "slot1", "slotType": "LSH7C18HX1E0" }, { "deviceName": "CORE2", "slotId": "slot4", "slotType": "LSH7X48SX1E0" } ], "linkList": [ { "srcPortName": "100GE3/0/34", "srcDevName": "CORE1", "srcEthTrunk": "Eth-Trunk1", "dstPortName": "100GE3/0/34", "dstDevName": "CORE2", "dstEthTrunk": "Eth-Trunk1", "mlagLinkType": "peer-link", "mlagId": "", "mlagIpPoolName": "" }, { "srcPortName": "100GE3/0/35", "srcDevName": "CORE1", "srcEthTrunk": "Eth-Trunk1", "dstPortName": "100GE3/0/35", "dstDevName": "CORE2", "dstEthTrunk": "Eth-Trunk1", "mlagLinkType": "peer-link", "mlagId": "", "mlagIpPoolName": "" }, { "srcPortName": "40GE2/0/34", "srcDevName": "CORE1", "srcEthTrunk": "", "dstPortName": "40GE2/0/34", "dstDevName": "CORE2", "dstEthTrunk": "", "mlagLinkType": "dual-active-detect-link", "mlagId": "", "mlagIpPoolName": "ipPoolName" }, { "srcPortName": "10GE1/0/1", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "dstPortName": "10GE1/0/1", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "mlagLinkType": "peer-link", "mlagId": "", "mlagIpPoolName": "" }, { "srcPortName": "10GE1/0/2", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "dstPortName": "10GE1/0/2", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "mlagLinkType": "peer-link", "mlagId": "", "mlagIpPoolName": "" }, { "srcPortName": "10GE1/0/3", "srcDevName": "AGG1_1", "srcEthTrunk": "Eth-Trunk1", "dstPortName": "10GE1/0/3", "dstDevName": "AGG1_2", "dstEthTrunk": "Eth-Trunk1", "mlagLinkType": "peer-link", "mlagId": "", "mlagIpPoolName": "" }, { "srcPortName": "10GE1/0/4", "srcDevName": "AGG1_1", "srcEthTrunk": "", "dstPortName": "10GE1/0/4", "dstDevName": "AGG1_2", "dstEthTrunk": "", "mlagLinkType": "dual-active-detect-link", "mlagId": "", "mlagIpPoolName": "ipPoolName" } ] }

响应参数 返回状态码为201：操作成功。 表7 TopoPlanCreationResDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "参数非法" data REFERENCE 详细请参见表8。 返回数据 - 表8 TopoPlanCreationModelDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 36个字符。 - 网络规划主键ID。 "bc1846c5-2eff-6d4d-2a2d-23dff3d12344" siteId uuid 36个字符。 - 站点ID。 "acc846c5-2fff-694d-2b2d-12dff3d1231a" tenantId string 32个字符。 - 租户ID。 "fbb684c80d37496fbafa4b06d5151e2e" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为201：操作成功。 { "errcode": "0", "errmsg": "", "data": { "id": "48f1f2c7-f01c-4fc6-87fd-47607897b50e", "siteId": "e42ee2d7-d083-4faa-bff0-1970b3c4eb08", "tenantId": "df8efdaebc9f4b019667b62775dd2c3b" } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 input 是 REFERENCE 详细请参见表3。 网络规划创建接口入参 - 表3 CreateTopoPlanDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceList 否 ARRAY_REFERENCE 1-500个列表项，详细请参见表4。 网络规划设备信息 - slotList 否 ARRAY_REFERENCE 0-500个列表项，详细请参见表5。 网络规划单板信息 - linkList 否 ARRAY_REFERENCE 0-2000个列表项，详细请参见表6。 网络规划链路信息 - 表4 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 表5 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" 表6 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"

响应示例 返回状态码为200：查询成功。 HTTPS 200 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "pageIndex": 1, "pageSize": 100, "totalRecord": 1, "errcode": "0", "errmsg": "", "data": [ { "id": "5c37d9e8-cdf6-11e8-a4fc-286ed488d001", "serialNumber": "IC1-Huawei-AR502H-GW-0001", "aliasName": "CPE101", "mac": "xx-xx-xx-xx-xx-xx", "configTime": '2022-05-12 15:30:00', "status": 0, "failReason": "" } ] } 返回状态码为400：查询失败。 HTTPS 400 Bad Requests Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0x00c8000d", "errmsg": "The parameter pageIndex is null." } 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /controller/campus/api/campusoamservice/v1/cpe/cli/tasks?queryParam=pageSize::10|pageIndex::1|sort::configTime|keyword::test|status::0 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：查询成功。 表2 ConfigResultOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [1-100000] - 页面索引 "1" pageSize int32 [1-100] - 页面大小。 "10" totalRecord int32 [0-10000000] - 总数 "10" errcode string 0~128个字符。 - 错误码。 - errmsg string 0~256个字符。 - 错误信息。 - data ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 CPE命令下发返回结果。 - 表3 ConfigResultDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 1~64个字符。 - 标识。 "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" serialNumber string 0~128个字符。 - 身份标识 - aliasName string 0~128个字符。 - 别名 "CPE101" mac string 0~64个字符。 - cpe mac地址 "xx-xx-xx-xx-xx-xx" configTime string 0~128个字符。 - 下发时间。 "2022-05-12 15:30:00" status int32 [0-8] - 状态 - failReason string 0~2048个字符。 - 失败原因 - 返回状态码为400：查询失败。 CommonErrDto对象的参数列表，详细请参见表5。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。