华为云用户手册

响应示例 返回状态码为200：查询成功，响应体参考RadioCountryChannelResult。 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 { "pageIndex" : "", "pageSize" : "", "totalRecords" : "", "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "9393e1a6-f9b0-45ae-a454-ea40e73b1339", "countryCode" : "CN", "countryNameKey" : "naas.networksvcmgr.wlan.country.China", "countryName" : "China", "channel2dot4" : "1-13", "channel5HT20Indoor" : "36,40,44,48,52,56,60,64,149,153,157,161,165", "channel5HT20Outdoor" : "149,153,157,161,165", "channel5HT40PlusIndoor" : "36,44,52,60,149,157", "channel5HT40PlusOutdoor" : "149,157", "channel5HT40MinusIndoor" : "40,48,56,64,153,161", "channel5HT40MinusOutdoor" : "153,161", "channel5HT80Indoor" : "36,40,44,48,52,56,60,64,149,153,157,161", "channel5HT80Outdoor" : "149,153,157,161", "channel5HT160Indoor" : "36,40,44,48,52,56,60,64,149,153,157,161", "channel5HT160Outdoor" : "149,153,157,161", "Channel6HT20Indoor" : "149,153,157,161", "Channel6HT20Outdoor" : "149,153,157,161", "Channel6HT40PlusIndoor" : "149,153,157,161", "Channel6HT40PlusOutdoor" : "149,153,157,161", "Channel6HT40MinusIndoor" : "149,153,157,161", "Channel6HT40MinusOutdoor" : "149,153,157,161", "Channel6HT80Indoor" : "149,153,157,161", "Channel6HT80Outdoor" : "149,153,157,161", "Channel6HT160Indoor" : "149,153,157,161", "Channel6HT160Outdoor" : "149,153,157,161", "Channel6HT320Indoor" : "149,153,157,161", "Channel6HT320Outdoor" : "149,153,157,161" } ] }

请求示例 HTTP的示例 GET /controller/campus/v3/configresource/channels 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：查询成功，响应体参考RadioCountryChannelResult。 表1 RadioCountryChannelResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex integer - - 当前字段不支持，返回null。 - pageSize integer [0-100] - 当前字段不支持，返回null。 - totalRecords integer - - 当前字段不支持，返回null。 - errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表2。 国家码信息。 - 表2 RadioCountryChannelDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 国家码ID。 "9393e1a6-f9b0-45ae-a454-ea40e73b1339" countryCode string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 国家码。 "CN" countryNameKey string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 国家名称国际化key。 "naas.networksvcmgr.wlan.country.China" countryName string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 国家名称。 "China" channel2dot4 string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 支持的2.4G信道。 "1-13" channel5HT20Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT20下支持的室内5G信道。 "36,40,44,48,52,56,60,64,149,153,157,161,165" channel5HT20Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT20下支持的室外5G信道。 "149,153,157,161,165" channel5HT40PlusIndoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40+下支持的室内5G信道。 "36,44,52,60,149,157" channel5HT40PlusOutdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40+下支持的室外5G信道。 "149,157" channel5HT40MinusIndoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40-下支持的室内5G信道。 "40,48,56,64,153,161" channel5HT40MinusOutdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40-下支持的室外5G信道。 "153,161" channel5HT80Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT80下支持的室内5G信道。 "36,40,44,48,52,56,60,64,149,153,157,161" channel5HT80Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT80下支持的室外5G信道。 "149,153,157,161" channel5HT160Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT160下支持的室内5G信道。 "36,40,44,48,52,56,60,64,149,153,157,161" channel5HT160Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT160下支持的室外5G信道。 "149,153,157,161" Channel6HT20Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT20下支持的室内6G信道。 "149,153,157,161" Channel6HT20Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT20下支持的室外6G信道。 "149,153,157,161" Channel6HT40PlusIndoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40+下支持的室内6G信道。 "149,153,157,161" Channel6HT40PlusOutdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40+下支持的室外6G信道。 "149,153,157,161" Channel6HT40MinusIndoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40-下支持的室内6G信道。 "149,153,157,161" Channel6HT40MinusOutdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40-下支持的室外6G信道。 "149,153,157,161" Channel6HT80Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT80下支持的室内6G信道。 "149,153,157,161" Channel6HT80Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT80下支持的室外6G信道。 "149,153,157,161" Channel6HT160Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT160下支持的室内6G信道。 "149,153,157,161" Channel6HT160Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT160下支持的室外6G信道。 "149,153,157,161" Channel6HT320Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT320下支持的室外6G信道。 "149,153,157,161" Channel6HT320Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT320下支持的室外6G信道。 "149,153,157,161"

响应示例 返回状态码为201：接口调用成功，响应体参考OverlayWanBgpPolicyTemplateBindSiteResponse。 HTTP/1.1 201 Created Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : "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 返回状态码为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的示例 DELETE /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/vpn 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 { "vpnId" : "310473a6-8006-48a3-9558-543d32ea1757", "templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayWanBgpPolicyTemplateSite 是 REFERENCE 详细请参见表2。 Overlay WAN侧BGP路由信息。 - 表2 OverlayWanBgpPolicyTempBindVpnRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 string - - VPN ID。UUID格式 "310473a6-8006-48a3-9558-543d32ea1757" templateId 是 string - - 模板ID。UUID格式 "fbb684c8-0d37-496f-bafa-4b06d515j7l6"

响应示例 返回状态码为200：拓扑中增加站点成功，响应体参考TopologyResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "topology" : { "areas" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "area_1", "areaType" : "leaf", "topologyType" : "hub-spoke", "enableDynamicTunnel" : "", "gatewayIPv6Enable" : false, "hubWorkMode" : "with-interconnection", "isFullReplaceSite" : "", "siteAttachments" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "siteRoles" : [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}], "accessServiceHubs" : [ { "siteName" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "accessPriority" : 2 } ], "borderRelationShip" : { "activeBorderSiteId" : "00000000-0000-0000-0000-000000000000", "activeBorderSiteName" : "Site Name", "standbyBorderSiteId" : "00000000-0000-0000-0000-000000000000", "standbyBorderSiteName" : "Site Name" }, "enableHubLanConnect" : "" } ] } ] }, "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考TopologyResponse。 HTTP/1.1 202 Accepted Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology/site-attachment HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "areas" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "area_1", "areaType" : "leaf", "topologyType" : "hub-spoke", "enableDynamicTunnel" : "", "gatewayIPv6Enable" : false, "hubWorkMode" : "with-interconnection", "isFullReplaceSite" : "", "siteAttachments" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "siteRoles" : [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}], "accessServiceHubs" : [ { "siteName" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "accessPriority" : 2 } ], "borderRelationShip" : { "activeBorderSiteId" : "00000000-0000-0000-0000-000000000000", "activeBorderSiteName" : "Site Name", "standbyBorderSiteId" : "00000000-0000-0000-0000-000000000000", "standbyBorderSiteName" : "Site Name" }, "enableHubLanConnect" : "" } ] } ] }

响应参数 返回状态码为200：拓扑中增加站点成功，响应体参考TopologyResponse。 TopologyResponse对象的参数列表，详细请参见表9。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考TopologyResponse。 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/sdwan/policy/traffic/bandwidth-management-policies 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-65535] 1 当前页数。 - pageSize 否 int32 [1-1000] 20 总页数，默认是20。 - sort 否 string 0~255个字符。 - 排序字段。 当前仅支持按policyName排序，"policyName"表示升序，"-policyName"表示降序，默认升序。 "policyName" policyId 否 string 0~64个字符。 - 策略ID。 "00000000-0000-0000-0000-00000000000" vpnId 否 string 0~64个字符。 - VPN业务ID。vpnId和vpnGroupId最多只能配置其中一个进行查询。 "00000000-0000-0000-0000-000000000000" vpnGroupId 否 string 0~64个字符。 - Qos VPN Group业务ID。vpnId和vpnGroupId最多只能配置其中一个进行查询。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 策略名称，支持模糊匹配。 "policy" siteId 否 string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000"

响应参数 返回状态码为200：查询成功，响应体参考QueryBandwidthMgrPolicyResponse。 表2 QueryBandwidthMgrPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表6。 带宽管理策略信息。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/bandwidth-management-policies?sort=policyName&policyId=00000000-0000-0000-0000-00000000000&vpnId=00000000-0000-0000-0000-000000000000&vpnGroupId=00000000-0000-0000-0000-000000000000&policyName=policy&siteId=00000000-0000-0000-0000-000000000000 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：查询成功，响应体参考QueryBandwidthMgrPolicyResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 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

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

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ipv4:ipv4/Vbdif1 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-ipv4:ipv4" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "if-name" : "Vbdif1", "address-type" : "address", "access-type" : "Static", "address" : "10.10.1.1", "mask" : 24, "unnumbered-if-name" : "LoopBack1", "mtu" : 1500, "sub-address" : [ { "address" : "10.10.1.2", "mask" : 24 } ] } ] }

响应示例 返回状态码为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-ipv4:ipv4/{if-name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" if-name 是 string 1~63个字符。 - 接口名称，AR6700V仅支持类型为Vbdif、LoopBack的接口，单一主键字段。 "Vbdif1"

请求示例 HTTP的示例 POST /controller/campus/api/v1/organization/path/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" : ["/org1/org2","/org11/org22"], "cascade" : true }

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

响应示例 返回状态码为200：执行成功，响应体参考ResetDeviceResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "error", "data" : { "successList" : [ { "deviceId" : "7836fa7e-0c5b-470d-bce5-10add71ef9ff", "esn" : "2102350LEC10G3000107" } ], "failList" : [ { "deviceId" : "a62ff0f5-d0b4-4c37-8d63-e12f5d851983", "esn" : "AP5008293511111111AA", "errmsg" : "The device does not exist.", "errcode" : "13107260" } ] } }

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/reset/device-configurations 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 { "deviceIds" : ["7836fa7e-0c5b-470d-bce5-10add71ef9ff","a62ff0f5-d0b4-4c37-8d63-e12f5d851983"] }

响应参数 返回状态码为200：执行成功，响应体参考ResetDeviceResponse。 表3 ResetDeviceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "error" data REFERENCE 详细请参见表4。 设备恢复出厂设置和恢复开局配置返回结果。 - 表4 ResetDeviceResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-10000个列表项，详细请参见表5。 成功恢复出厂设置和恢复开局配置的设备ID列表。 - failList ARRAY_REFERENCE 0-10000个列表项，详细请参见表6。 恢复出厂设置和恢复开局配置失败的设备列表。 - 表5 ResetDeviceSuccessDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId uuid 36个字符。 - 设备ID。 "7836fa7e-0c5b-470d-bce5-10add71ef9ff" esn string 0~256个字符。 - 设备ESN号。 "2102350LEC10G3000107" 表6 ResetDeviceFailedDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 36个字符。 - 设备ID。 "a62ff0f5-d0b4-4c37-8d63-e12f5d851983" esn string 0~256个字符。 - 设备ESN号。 "AP5008293511111111AA" errmsg string - - 设备恢复出厂设置和恢复开局配置失败错误信息。 "The device does not exist." errcode string - - 设备恢复出厂设置和恢复开局配置失败错误码。 "13107260"

响应示例 返回状态码为201：接口调用成功，响应体参考LoopbackResponse。 HTTP/1.1 201 Created Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "wanLinkId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "LoopBack601", "ipAddress" : "10.1.1.1", "prefixLength" : 24, "deviceName" : "device1" } ], "fail" : [ { "errcode" : "1", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "wanLinkId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "LoopBack601", "ipAddress" : "10.1.1.1", "prefixLength" : 24, "deviceName" : "device1" } } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/loopbacks 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 { "Loopbacks" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "wanLinkId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "LoopBack601", "ipAddress" : "10.1.1.1", "prefixLength" : 24, "deviceName" : "device1" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 loopbackInfos 是 REFERENCE 详细请参见表2。 创建Loopback请求数据。 - 表2 LoopbackInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 Loopbacks 是 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 - - 表3 LoopbackInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid 0~36个字符。 - LoopbackID,主键字段。创建时无需填写，更新和删除时必填,uuid格式。 "00000000-0000-0000-0000-000000000000" vpnId 否 uuid 0~36个字符。 - VPNID，创建时VPNID、WANLINKID二选一必填，不能修改，UUID格式。 "00000000-0000-0000-0000-000000000000" wanLinkId 否 uuid 0~36个字符。 - WANLINKID，创建时VPNID、WANLINKID二选一必填，不能修改，UUID格式。 "00000000-0000-0000-0000-000000000000" siteId 否 uuid 0~36个字符。 - 站点ID,创建时必填，不能修改,uuid格式。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid 0~36个字符。 - 设备ID。创建时必填，不能修改,uuid格式。 "00000000-0000-0000-0000-000000000000" interfaceName 否 string 0~32个字符。 - interface名称，创建时必填。不能修改,命名规范：loopback开头接数字范围1-99、101-899、 910-1023，大小写敏感。 "LoopBack601" ipAddress 否 string 0~64个字符。 - 接口IP，创建时必填。 "10.1.1.1" prefixLength 否 int32 [1-32] - 掩码，创建时必填。 24 deviceName 否 string 0~256个字符。 - 设备名称。查询时返回。 "device1"

响应参数 返回状态码为201：接口调用成功，响应体参考LoopbackResponse。 表4 LoopbackResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 成功添加或更新的Loopback。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 添加或者更新失败的Loopback。 - 表5 LoopbackInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 0~36个字符。 - LoopbackID,主键字段。创建时无需填写，更新和删除时必填,uuid格式。 "00000000-0000-0000-0000-000000000000" vpnId uuid 0~36个字符。 - VPNID，创建时VPNID、WANLINKID二选一必填，不能修改，UUID格式。 "00000000-0000-0000-0000-000000000000" wanLinkId uuid 0~36个字符。 - WANLINKID，创建时VPNID、WANLINKID二选一必填，不能修改，UUID格式。 "00000000-0000-0000-0000-000000000000" siteId uuid 0~36个字符。 - 站点ID,创建时必填，不能修改,uuid格式。 "00000000-0000-0000-0000-000000000000" deviceId uuid 0~36个字符。 - 设备ID。创建时必填，不能修改,uuid格式。 "00000000-0000-0000-0000-000000000000" interfaceName string 0~32个字符。 - interface名称，创建时必填。不能修改,命名规范：loopback开头接数字范围1-99、101-899、 910-1023，大小写敏感。 "LoopBack601" ipAddress string 0~64个字符。 - 接口IP，创建时必填。 "10.1.1.1" prefixLength int32 [1-32] - 掩码，创建时必填。 24 deviceName string 0~256个字符。 - 设备名称。查询时返回。 "device1" 表6 FailLoopbackInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "1" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 - - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /v1/perfservice/alarms/current-alarms/statistic 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 { "objectIds" : [ "" ], "cleared" : "0" }

响应参数 返回状态码为200：接口调用成功，响应体参考AlarmStatisticOutput。 表3 AlarmStatisticOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "null" errmsg string 0~256个字符。 - 错误信息。 "null" data ARRAY_REFERENCE 0-500个列表项，详细请参见表4。 告警统计结果数据 - 表4 AlarmStatisticData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 objectId string 1~64个字符。 - 统计对象id - criticalAlarmNum string 0~32个字符。 - 紧急告警统计 "10" majorAlarmNum string 0~32个字符。 - 重要告警统计 "15" minorAlarmNum string 0~32个字符。 - 次要告警统计 "30" warningAlarmNum string 0~32个字符。 - 提示告警统计 "40" 返回状态码为400：接口入参非法的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考AlarmStatisticOutput。 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" : "null", "errmsg" : "null", "data" : [ { "objectId" : "", "criticalAlarmNum" : "10", "majorAlarmNum" : "15", "minorAlarmNum" : "30", "warningAlarmNum" : "40" } ] } 返回状态码为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：查询成功。 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" : { "pageIndex" : 1, "pageSize" : 20, "totalPage" : 10, "totalRecords" : 10, "QueryDeviceInfo" : [ { "deviceName" : "AirEngine6760R-51_FBF792C3", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceEsn" : "AA02353VUTFIOJNKGG13", "deviceStatus" : 3, "deviceMeshRole" : "mpp", "meshConfigRole" : "mpp", "meshId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "meshName" : "apmesh" } ] } } 返回状态码为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