华为云用户手册

响应示例 返回状态码为200：lsw ospf区域信息返回结构体。 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" : { "processId" : "1", "area" : { "areaType" : "stub", "areaId" : "60e2e8a3cdf3470ea4d4f468c8b74095", "areaUUID" : "", "networkList" : ["192.168.0.1/24"], "abrSummaryList" : [ { "ipAddress" : "192.168.0.1/24" } ], "stubNoSummary" : false } }, "errcode" : "0", "errmsg" : "" }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 inheritSwitchInfo 是 REFERENCE 详细请参见表3。 继承LAN侧路由使能开关 - 表3 InheritSwitchInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 inheritSwitchEnable 是 boolean true false false 是否使能继承LAN侧路由。 true

响应参数 返回状态码为201：更改成功。 表4 InheritSwitchResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 - - processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 - 表5 InheritSwitchInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 inheritSwitchEnable boolean true false false 是否使能继承LAN侧路由。 true 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考InheritSwitchResponse。 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/internet/00000000-0000-0000-0000-000000000000/centralized-access/inherit 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 { "inheritSwitchEnable" : true }

接口约束 1：该接口仅支持租户视图，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用； 2：使能此开关后，对于当前VN下的集中网关，不指定网关优先级，统一继承LAN侧默认路由优先级； 3：暂不支持同一VN下部分集中网关配置优先级，部分继承LAN侧优先级； 4：开关默认关闭，已配置集中网关的情况下，使能开关会使原有集中网关统一修改为继承LAN侧默认路由优先级； 5：开关关闭时默认删除已配置的集中上网策略，需要重新配置，请谨慎操作。

响应示例 返回状态码为201：更改成功。 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" : { "inheritSwitchEnable" : true }, "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考InheritSwitchResponse。 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

响应示例 返回状态码为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" } 返回状态码为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 /v1/performanceservice/identify/instances 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 { "name" : "test", "description" : "五元组模板", "fiveTuple" : { "protocol" : "TCP", "srcIp" : "192.168.0.1/32", "dstIp" : "192.168.0.1/32", "srcPortRange" : "100-200", "dstPortRange" : "200", "fiveTupleType" : 0 }, "id" : "9a157da3-9e59-41c9-8312-254a38a3b275" }

响应参数 返回状态码为200：更新识别流模板成功后的状态返回码。 表3 StreamCommonOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" 返回状态码为400：接口更新失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 streamProfilePutInput 否 REFERENCE 详细请参见表2。 设置识别流模板 - 表2 StreamProfilePutInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~256个字符。 - 模板名称 "test" description 否 string 0~512个字符。 - 模板描述 "五元组模板" fiveTuple 否 REFERENCE 详细请参见表3。 五元组信息 - id 否 string 1~36个字符。 - 模板id "9a157da3-9e59-41c9-8312-254a38a3b275"

响应示例 返回状态码为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 { "data" : [ { "deviceId" : "9dffc44b-1824-42a4-ac48-616e3f0eaa2a", "deviceName" : "AP7060", "devGroupId" : "f72e9e58-9b60-4ef0-b677-2002r21c3fad", "deviceStatistics" : [ { "timestamp" : 1697875200, "associatedCount" : 10, "nonAssociatedCount" : 382 } ] } ] }

响应参数 返回状态码为200：查询设备关联的和未关联的终端数量统计数据 表3 StatisticsResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-20个列表项，详细请参见表4。 设备关联的和未关联的终端数量统计数据 - 表4 EndpointStatisticsOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 0~36个字符。 - 设备id "9dffc44b-1824-42a4-ac48-616e3f0eaa2a" deviceName string 0~64个字符。 - 设备名称 "AP7060" devGroupId string 0~36个字符。 - 站点id "f72e9e58-9b60-4ef0-b677-2002r21c3fad" deviceStatistics ARRAY_REFERENCE 0-200个列表项，详细请参见表5。 单设备统计 - 表5 DeviceStatistics对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 timestamp int64 [1672502400-2524579200] - 每个时间段的时间戳，间隔为1小时 1697875200 associatedCount int32 [0-10000] - 关联的终端数 10 nonAssociatedCount int32 [0-10000] - 未关联的终端数 382

请求示例 HTTP的示例 POST /v1/performanceservice/terminal/statistics/associated-count/action/batch-query 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" : ["9dffc44b-1824-42a4-ac48-616e3f0eaa2a","9dffc44b-1824-42a4-ac48-616e3f0eaa2b"], "startTime" : 1697875200, "endTime" : 1697875200 }

URI /controller/cloud/v2/northbound/accessuser/haca/authorizationresult/{terminalid} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 terminalid 是 string - - 终端ID， 长度1-128。 "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nodeIp 否 string - - 授权节点地址，ipv4地址。 "192.168.211.236"

响应示例 返回状态码为200：添加成功。响应体参考CommonAuthorizationOutputDto。 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" : "", "psessionid" : "5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d" } 返回状态码为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的示例 GET /controller/cloud/v2/northbound/accessuser/haca/authorizationresult/5ea660be98a84618fa3d6d03f65f47ab578ba3b4216790186a932f9e8c8c880d?nodeIp=192.168.211.236 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：删除成功，响应体参考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" : "" } 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 delTargetHostInfo 是 REFERENCE 详细请参见表3。 删除SNMP目标主机信息 - 表3 DelTargetHostInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~32个字符。 - 指定SNMP目标主机名。 "hostName"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/snmp/trap/00000000-0000-0000-0000-000000000000/targetHost/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 { "name" : "hostName" }

响应示例 返回状态码为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" : "", "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" : "", "totalRecords" : 10, "pageSize" : 10, "pageIndex" : 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：查询拓扑成功。 表3 TopologyPageResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" topology REFERENCE 详细请参见表10。 拓扑信息。 - processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 - totalRecords int32 - - 总的数据条数。 10 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/sdwan/overlay-network/{vpnId}/topology 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID，UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 areaId 否 uuid - - 指定区域ID，UUID格式。EVPN模式下，如果不填，表明查询指定vpn下的所有area。 "00000000-0000-0000-0000-000000000000" areaType 否 string 0~32个字符。 - 区域类型，支持按区域类型查询，取值范围：leaf、backbone。 "leaf" areaName 否 string 0~32个字符。 - 区 域名 称，支持按区域名称模糊查询。 "leaf" pageIndex 否 int32 - - 当前页数，为空表示查询所有。 - pageSize 否 int32 - - 每页显示数量，为空表示查询所有。 -

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology?areaId=00000000-0000-0000-0000-000000000000&areaType=leaf&areaName=leaf 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：更新成功，响应体参考UpdateSacEngineSettingsResponse。 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" : "", "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

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/application/sac-engine-settings/increment 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 { "feature" : "SAC Engine", "settings" : true, "siteIds" : [ "00000000-0000-0000-0000-000000000000" ] }

响应参数 返回状态码为200：当前站点的射频调优配置信息，返回结构体参见GroupRadioCalibrateResponsesDto。 表2 GroupRadioCalibrateResponsesDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 站点调优结果信息，结构体参见GroupRadioCalibrateResultApiDto。 - 表3 GroupRadioCalibrateResultApiDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 progress int32 [0-100] - 调优进度，单位：%。 100 finishTime int64 - - 调优完成时间戳，单位：毫秒。 1574644243000 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/site/fbde1c5d-5b94-49e3-a912-48641015e45c/apradio/calibratefinish 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：当前站点的射频调优配置信息，返回结构体参见GroupRadioCalibrateResponsesDto。 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" : { "progress" : 100, "finishTime" : 1574644243000 } } 返回状态码为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

响应示例 返回状态码为200：使能成功，响应体参考EnableDot1xConfigResponse。 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" : { "interfaces" : { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "interfaceInfos" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "interfaceIds" : [ "fbb684c8-ddaa-3451-bafa-4b06d5158956" ] } ] }, "dot1xTemplateName" : "dot1xtemplate1" } } 返回状态码为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/rest/sdwan/v1/device/dot1x/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 { "interfaces" : { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "interfaceInfos" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "interfaceIds" : [ "fbb684c8-ddaa-3451-bafa-4b06d5158956" ] } ] }, "dot1xTemplateName" : "dot1xtemplate1" }