华为云用户手册

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:relay 是 REFERENCE 详细请参见表4。 配置DHCP relay。 - 表4 relay-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:relay 否 REFERENCE 详细请参见表5。 配置DHCP relay。 - 表5 relay-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global 否 REFERENCE 详细请参见表6。 中继全局配置。 - 表6 global-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 trust-option82 否 boolean true false - DHCP relay agent使能Option 82开关。AR6700V主设备和AR6700V子设备不支持。 true reply-forward-all 否 boolean true false - DHCP relay agent使能转发所有DHCP ACK消息。AR6700V主设备和AR6700V子设备不支持。 true

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

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-syslog:syslog-config/global-parameter 表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的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-syslog:syslog-config/global-parameter 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-syslog:global-parameter" : { "interface-name" : "1", "buffer-size" : 1, "log-timestamp" : "date-boot", "log-timezone" : true, "debug-timestamp" : "date-boot", "debug-timezone" : true, "trap-timestamp" : "date-boot", "trap-timezone" : true, "statistic-suppress" : true } }

响应示例 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 global-parameter 是 REFERENCE 详细请参见表4。 全局配置 - 表4 global-parameter-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-syslog:global-parameter 否 REFERENCE 详细请参见表6。 全局配置 -

响应示例 返回状态码为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" : [ { "id" : "b0ce6863-cf72-4a9a-aad2-04b1131f18ef", "name" : "example", "description" : "test" } ], "fail" : { "errcode" : "0x00c80014", "errmsg" : "The id does not exist.", "data" : [ { "id" : "b0ce6863-cf72-4a9a-aad2-04b1131f18ef", "name" : "example", "description" : "test" } ] } } 返回状态码为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：删除成功。 表4 ApmeshDeleteResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success ARRAY_REFERENCE 0-64个列表项，详细请参见表5。 删除成功的Apmesh配置。 - fail REFERENCE 详细请参见表6。 删除失败的Apmesh配置 - 表5 DeleteApmeshInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 36个字符。 - Apmesh id。 "b0ce6863-cf72-4a9a-aad2-04b1131f18ef" name string 0~128个字符。 - 名称。 "example" description string 0~128个字符。 - 描述。 "test" 表6 ApmeshDeleteResponseFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0x00c80014" errmsg string 0~256个字符。 - 错误信息。 "The id does not exist." data ARRAY_REFERENCE 0-64个列表项，详细请参见表5。 删除apmesh返回体 - 返回状态码为400：校验失败。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/api/v1/networkconfig/apmesh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/meshs/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 { "ids" : [ "b0ce6863-cf72-4a9a-aad2-04b1131f18ef" ] }

URI /controller/campus/api/v1/networkconfig/apmesh/sites/{siteId}/meshs/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点标识，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为200：配置成功，响应体参考ImportCmdResponse。 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" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "errorMsg" : "The esn does not exist." } ], "fail" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "errorMsg" : "The esn does not exist." } ], "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考ImportCmdResponse。 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：配置成功，响应体参考ImportCmdResponse。 表5 ImportCmdResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码，0表示成功，非0表示失败。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-3200个列表项，详细请参见表6。 成功列表。 - fail ARRAY_REFERENCE 0-3200个列表项，详细请参见表6。 失败列表。 - processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 - 表6 ImportCmdResultVo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string - - 设备ID，格式UUID。 "00000000-0000-0000-0000-000000000000" errorMsg string - - 错误信息。如果没有错误信息，该字段返回空。 "The esn does not exist." 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考ImportCmdResponse。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：系统内部错误。 详细信息请参见实际响应消息体。

接口约束 1、该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、接口不返回配置结果。 3、同一设备下发两次配置，新的配置会覆盖旧的配置。 4、CLI序列不支持事务，如果识别，需要人工修订配置。 5、不允许下发与iMaster NCE-Campus编排冲突的配置。 6、该接口请在华为工程师的指导下使用。 7、V600系列版本的设备不支持CLI下发配置。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 importCmdListVo 是 REFERENCE 详细请参见表2。 下发的命令。 设备ID不能重复； 每个命令之前用\n分开； 每条配置最多支持4096个字符，其中\n算一个字符。 - 表2 ImportCmdListVo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 cmdList 否 ARRAY_REFERENCE 0-3200个列表项，详细请参见表3。 下发的命令列表。 - 表3 ImportCmdVo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 1~64个字符。 - 设备ID。 在列表中不允许重复。 "00000000-0000-0000-0000-000000000000" cmds 是 ARRAY_REFERENCE 1-3个列表项，详细请参见表4。 待执行的所有命令。 - 表4 CmdVo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 buildRun 否 password 0~4096个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 全量执行配置。 不能超过4096个字符。 "returnsyssysname spoke" executeCli 否 password 0~4096个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 实时执行配置。 不能超过4096个字符。 "returnsyssysname spoke" index 否 integer [0-2] - 执行顺序标记位。 取值范围[0，2]。 0

请求示例 HTTP的示例 POST /controller/campus/ui/v1/sdwan/openapi/maintenance/cli/inject 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 { "cmdList" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "cmds" : [ { "buildRun" : "return\nsys\nsysname spoke", "executeCli" : "return\nsys\nsysname spoke", "index" : 0 } ] } ] }

响应示例 返回状态码为200：查询成功，响应体参考StatisticsRsp。 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" : "", "total" : 10, "data" : [ { "key" : "link1", "value" : "35" } ] } 返回状态码为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/performance/spr-statistics/query-topn-dist 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "metrics" : "site", "startTime" : 1616824800000, "endTime" : 1616828400000 }

响应参数 返回状态码为200：查询成功，响应体参考StatisticsRsp。 表3 StatisticsRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码，成功返回0 "0" errmsg string 0~256个字符。 - 错误信息 "" total int64 - 0 总数 10 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 分布图，柱状图，折线图统计接口数据项 - 表4 StatisticsInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 key string - - 具体指标项值 "link1" value int32 - - 指标值 "35" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 TopnDistReq 是 REFERENCE 详细请参见表2。 查询条件 - 表2 TopnDistReq对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 0~36个字符。 - 站点ID。 为空则查询租户所有站点。 为空时metrics不能为link和policy，不为空时metrics不能为site "fbb684c8-0d37-496f-bafa-4b06d515j7l6" metrics 是 string site link policy - 指标标识，该字段可以设置为以下几种： a) site：TopN站点 b) link：TopN链路 c) policy：TopN切换策略 "site" startTime 是 int64 - - 查询的开始时间，格林威治时间戳，格式为UNIX时间戳，即从1970年1月1日（UTC/GMT的午夜）开始所经过的毫秒数，不考虑闰秒 1616824800000 endTime 是 int64 - - 查询的结束时间，格林威治时间戳，格式为UNIX时间戳，即从1970年1月1日（UTC/GMT的午夜）开始所经过的毫秒数，不考虑闰秒 1616828400000

响应示例 返回状态码为200：配置成功，响应体参考NetstreamResponse。 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" : { "config-status" : "", "errorInfo" : "", "flowInsts" : { "flowInst" : [ { "flowType" : "IPv4", "sourceIpv4Address" : "192.168.1.1", "sourceIpv4Port" : 2000, "exportVersion" : 5, "indexSwitch" : 32, "tcpSessionTimeout" : false, "preClassify" : false, "sysMacEnable" : false, "originActiveAgeSeconds" : 1800, "originInactiveSeconds" : 15, "templateTimeoutRate" : 1, "exportIpV4Hosts" : [ { "address" : "192.168.2.1", "port" : 2000, "vpnName" : "underlay_1", "dscpValue" : 15 } ] } ] }, "flexFlowRecords" : { "flexFlowRecord" : [ { "flowType" : "IPv4", "recordName" : "record1", "protocol" : true, "tos" : true, "sourceAddress" : true, "destinationAddress" : true, "sourcePort" : true, "destinationPort" : true, "bytesValue" : true, "packetsValue" : false, "inputInterface" : false, "outputInterface" : false, "sdWanConnection" : false, "applicationName" : false, "sysMacEnable" : false } ] }, "tmAfterEnable" : false, "sourceIdExtendEnable" : false } } 返回状态码为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：配置成功，响应体参考NetstreamResponse。 表9 NetstreamResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表10。 NetStream info。 - 表10 netstreamInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 config-status string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 1：配置状态； 2：查询接口返回业务数据配置状态结果； 3：创建、修改、删除不返回状态； 4：入参设置此字段无效； 5：取值范围： reserved：保留未用， initial：初始状态， configuring-database：数据库存储中， configured-database-success：预配置， configured-database-failed：数据库存储失败， configuring-device：部署中， configured-device-success：成功， configured-device-failed：失败。 - errorInfo string 0~1000个字符。 - 配置下发结果错误描述。 "" flowInsts REFERENCE 详细请参见表11。 全局参数流实例列表。 - flexFlowRecords REFERENCE 详细请参见表14。 灵活流模板列表，仅V600系列设备支持。 - tmAfterEnable boolean true false false 配置设备在队列调度后进行采样。 false sourceIdExtendEnable boolean true false false 启用源id扩展模式，仅V600系列设备支持。 false 表11 flowInsts对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 flowInst ARRAY_REFERENCE 1个列表项，详细请参见表12。 配置全局流实例。当前只支持配置一个流实例，即IPV4类型的流实例。 - 表12 flowInst对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 flowType string IPv4 - 流类型，取值范围：当前仅支持IPv4，主键字段。 "IPv4" sourceIpv4Address string 0~15个字符。 - 源IP地址，当前仅支持IPv4地址，修改场景支持填null，表示不修改，维持原有值。 "192.168.1.1" sourceIpv4Port int32 [1-65535] - 源端口。仅V300系列设备支持该参数。 2000 exportVersion int32 5 9 10 - V300系列设备支持版本号：5, 9, 10。V600系列设备支持5, 9。 5 indexSwitch int32 16 32 32 接口索引。 32 tcpSessionTimeout boolean true false false 当tcp会话结束时，老化流。 false preClassify boolean true false false 使能预提取功能。仅V300系列设备支持该参数。 false sysMacEnable boolean true false false 使能sysmac采样。只有V300系列设备支持该参数。 false originActiveAgeSeconds int32 [60-3600] 1800 活跃流老化时间，单位秒。默认值1800秒。 1800 originInactiveSeconds int32 [5-600] - 非活跃流老化时间，单位秒。 V300系列设备范围10到600, 默认值为30。 V600系列设备范围5到600, 默认值15。 15 templateTimeoutRate int32 [1-3600] 1 模板刷新率。V600系列设备默认值为1。V300系列设备默认值为30。单位为分钟。 1 exportIpV4Hosts ARRAY_REFERENCE 0-2个列表项，详细请参见表13。 目的主机列表。 - 表13 exportIpV4Host对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 address string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 目的地址，目标主机的IP地址不能相同。 "192.168.2.1" port int32 [1-65535] - 目的端口号。 2000 vpnName string 0~31个字符。 - Vpn实例名。 "underlay_1" dscpValue int32 [0-63] - DSCP值。只有V600系列设备支持该参数，默认值为0。 15 表14 flexFlowRecords对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 flexFlowRecord ARRAY_REFERENCE 1-16个列表项，详细请参见表15。 灵活流模板，仅V600系列设备支持，支持增量修改。 - 表15 flexFlowRecord对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 flowType string IPv4 - 流类型，取值范围：当前仅支持IPv4，联合主键字段。 "IPv4" recordName string 1~32个字符。满足正则表达([^?"']{1,32})|("[^?"']{1,30}")|('[^?"']{1,30}')。 - 灵活流模板名，联合主键字段。 "record1" protocol boolean true false false 采集协议。 true tos boolean true false false 采集服务类型。 true sourceAddress boolean true false false 采集源地址。 true destinationAddress boolean true false false 采集目的地址。 true sourcePort boolean true false false 采集源端口。 true destinationPort boolean true false false 采集目的端口。 true bytesValue boolean true false false 采集字节数。 true packetsValue boolean true false false 采集报文个数。 false inputInterface boolean true false false 采集入接口索引。 false outputInterface boolean true false false 采集出接口索引。 false sdWanConnection boolean true false false 采集隧道信息。 false applicationName boolean true false false 采集应用信息。 false sysMacEnable boolean true false false sysmac使能。 false 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/netstream/global/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 { "config-status" : "", "errorInfo" : "", "flowInsts" : { "flowInst" : [ { "flowType" : "IPv4", "sourceIpv4Address" : "192.168.1.1", "sourceIpv4Port" : 2000, "exportVersion" : 5, "indexSwitch" : 32, "tcpSessionTimeout" : false, "preClassify" : false, "sysMacEnable" : false, "originActiveAgeSeconds" : 1800, "originInactiveSeconds" : 15, "templateTimeoutRate" : 1, "exportIpV4Hosts" : [ { "address" : "192.168.2.1", "port" : 2000, "vpnName" : "underlay_1", "dscpValue" : 15 } ] } ] }, "flexFlowRecords" : { "flexFlowRecord" : [ { "flowType" : "IPv4", "recordName" : "record1", "protocol" : true, "tos" : true, "sourceAddress" : true, "destinationAddress" : true, "sourcePort" : true, "destinationPort" : true, "bytesValue" : true, "packetsValue" : false, "inputInterface" : false, "outputInterface" : false, "sdWanConnection" : false, "applicationName" : false, "sysMacEnable" : false } ] }, "tmAfterEnable" : false, "sourceIdExtendEnable" : false }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 netstream 是 REFERENCE 详细请参见表3。 设备NetStream全局配置。 - 表3 netstreamInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 config-status 否 string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 1：配置状态； 2：查询接口返回业务数据配置状态结果； 3：创建、修改、删除不返回状态； 4：入参设置此字段无效； 5：取值范围： reserved：保留未用， initial：初始状态， configuring-database：数据库存储中， configured-database-success：预配置， configured-database-failed：数据库存储失败， configuring-device：部署中， configured-device-success：成功， configured-device-failed：失败。 - errorInfo 否 string 0~1000个字符。 - 配置下发结果错误描述。 "" flowInsts 否 REFERENCE 详细请参见表4。 全局参数流实例列表。 - flexFlowRecords 否 REFERENCE 详细请参见表7。 灵活流模板列表，仅V600系列设备支持。 - tmAfterEnable 否 boolean true false false 配置设备在队列调度后进行采样。 false sourceIdExtendEnable 否 boolean true false false 启用源id扩展模式，仅V600系列设备支持。 false 表4 flowInsts对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 flowInst 否 ARRAY_REFERENCE 1个列表项，详细请参见表5。 配置全局流实例。当前只支持配置一个流实例，即IPV4类型的流实例。 - 表5 flowInst对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 flowType 是 string IPv4 - 流类型，取值范围：当前仅支持IPv4，主键字段。 "IPv4" sourceIpv4Address 否 string 0~15个字符。 - 源IP地址，当前仅支持IPv4地址，修改场景支持填null，表示不修改，维持原有值。 "192.168.1.1" sourceIpv4Port 否 int32 [1-65535] - 源端口。仅V300系列设备支持该参数。 2000 exportVersion 否 int32 5 9 10 - V300系列设备支持版本号：5, 9, 10。V600系列设备支持5, 9。 5 indexSwitch 否 int32 16 32 32 接口索引。 32 tcpSessionTimeout 否 boolean true false false 当tcp会话结束时，老化流。 false preClassify 否 boolean true false false 使能预提取功能。仅V300系列设备支持该参数。 false sysMacEnable 否 boolean true false false 使能sysmac采样。只有V300系列设备支持该参数。 false originActiveAgeSeconds 否 int32 [60-3600] 1800 活跃流老化时间，单位秒。默认值1800秒。 1800 originInactiveSeconds 否 int32 [5-600] - 非活跃流老化时间，单位秒。 V300系列设备范围10到600, 默认值为30。 V600系列设备范围5到600, 默认值15。 15 templateTimeoutRate 否 int32 [1-3600] 1 模板刷新率。V600系列设备默认值为1。V300系列设备默认值为30。单位为分钟。 1 exportIpV4Hosts 否 ARRAY_REFERENCE 0-2个列表项，详细请参见表6。 目的主机列表。 - 表6 exportIpV4Host对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 是 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 目的地址，目标主机的IP地址不能相同。 "192.168.2.1" port 是 int32 [1-65535] - 目的端口号。 2000 vpnName 否 string 0~31个字符。 - Vpn实例名。 "underlay_1" dscpValue 否 int32 [0-63] - DSCP值。只有V600系列设备支持该参数，默认值为0。 15 表7 flexFlowRecords对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 flexFlowRecord 否 ARRAY_REFERENCE 1-16个列表项，详细请参见表8。 灵活流模板，仅V600系列设备支持，支持增量修改。 - 表8 flexFlowRecord对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 flowType 是 string IPv4 - 流类型，取值范围：当前仅支持IPv4，联合主键字段。 "IPv4" recordName 是 string 1~32个字符。满足正则表达([^?"']{1,32})|("[^?"']{1,30}")|('[^?"']{1,30}')。 - 灵活流模板名，联合主键字段。 "record1" protocol 否 boolean true false false 采集协议。 true tos 否 boolean true false false 采集服务类型。 true sourceAddress 否 boolean true false false 采集源地址。 true destinationAddress 否 boolean true false false 采集目的地址。 true sourcePort 否 boolean true false false 采集源端口。 true destinationPort 否 boolean true false false 采集目的端口。 true bytesValue 否 boolean true false false 采集字节数。 true packetsValue 否 boolean true false false 采集报文个数。 false inputInterface 否 boolean true false false 采集入接口索引。 false outputInterface 否 boolean true false false 采集出接口索引。 false sdWanConnection 否 boolean true false false 采集隧道信息。 false applicationName 否 boolean true false false 采集应用信息。 false sysMacEnable 否 boolean true false false sysmac使能。 false

请求示例 HTTP的示例 POST /controller/campus/v3/devices/replace 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 { "originalDeviceId" : "00000000-0000-0000-0000-000000000001", "replaceDeviceId" : "00000000-0000-0000-0000-000000000002" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 replaceDeviceDto 是 REFERENCE 详细请参见表2。 设备替换入参模型。 - 表2 ReplaceDeviceDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 originalDeviceId 是 UUID 0~64个字符。 - 待替换设备的ID。 "00000000-0000-0000-0000-000000000001" replaceDeviceId 是 UUID 0~64个字符。 - 替换设备的ID。 "00000000-0000-0000-0000-000000000002"

响应参数 返回状态码为200：设备替换成功，响应体参考CommonResponseBean。 表3 CommonResponseBean对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "" 返回状态码为400：参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：服务内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：设备替换成功，响应体参考CommonResponseBean。 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

响应示例 返回状态码为200：AP设备射频配置信息。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "deviceId" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "deviceName" : "21500829352SH1904172", "radio2dot4Enabled" : true, "radio2dot4Power" : "auto", "radio2dot4Channel" : "auto", "radio2dot4Bandwidth" : "auto", "antenna2Dot4Gain" : "6", "radio2BandwidthEnable" : true, "radio5Enabled" : true, "radio5Power" : "auto", "radio5Channel" : "auto", "radio5Channel2" : "auto", "antenna5Gain" : "6", "radio5Bandwidth" : "auto", "radio5BandwidthEnable" : true, "radio2th5Enabled" : true, "radio2th5Power" : "auto", "radio2th5Channel" : "auto", "antenna2th5Gain" : "0", "radio2th5Bandwidth" : "auto", "radio2th5BandwidthEnable" : true, "flexibleRadio" : 1, "radio2RFType" : 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

响应参数 返回状态码为200：AP设备射频配置信息。 表2 ApDeviceRadioResponsesDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 AP设备射频配置。 - 表3 ApDeviceRadioResultApiDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId UUID - - 设备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" radio2dot4Bandwidth string auto 20mhz 40mhz-plus 40mhz-minus - 2.4G调优频宽，调优带宽时选择auto，此时2.4G信道也应该为auto。 "auto" antenna2Dot4Gain string - - 2.4G射频天线增益，0~30，室内AP天线增益不支持修改。 "6" radio2BandwidthEnable boolean true false - 带宽使能，在调优场景2.4g有可能变5g，此时要支持dbs功能。 true radio5Enabled boolean true false - 5G射频使能状态。 true radio5Power string - - 5G射频发射功率，auto，[1,127]。 "auto" radio5Channel string - - 5G射频信道，不同国家码，对应不同的射频信道范围。 "auto" radio5Channel2 string - - 5G射频第二信道/6G信道, 当radio5Bandwidth为80plus80mhz时，为必填项，不同国家码，对应不同的射频信道范围。 "auto" antenna5Gain string - - 5G射频天线增益，0~30，室内AP天线增益不支持修改。 "6" radio5Bandwidth string auto 20mhz 40mhz-plus 40mhz-minus 80mhz 80plus80mhz 160mhz - 5G射频频宽，调优带宽时选择auto，此时5G信道也应该为auto。 "auto" radio5BandwidthEnable boolean true false - 5G射频的带宽使能。 true radio2th5Enabled boolean true false - 第二个5G/6G射频使能。 true radio2th5Power string 1~4个字符。 - 第二个5G/6G射频发射功率，（范围auto或者1~127）。 "auto" radio2th5Channel string 1~4个字符。 - 第二个5G/6G射频发射信道，请参照各国家的信道码要求填写。 "auto" antenna2th5Gain string 1~2个字符。 - 第二个5G/6G射频天线增益（范围0~30）。 "0" radio2th5Bandwidth string auto 20mhz 40mhz-plus 40mhz-minus 80plus80mhz 80mhz 160mhz 320mhz - 第二个5G/6G射频频宽。 "auto" radio2th5BandwidthEnable boolean true false - 第二个5G/6G射频的带宽使能。 true flexibleRadio int32 - - DCA双频调优开关:disable 0，enable:1。 1 radio2RFType int32 - 1 wlan-radio 0/0/2接口射频类型 2.4g:0/5g:1/6g:2。默认值为1。 1 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/device/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