华为云用户手册

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/overlay-network/external-ports/action/batch-delete 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 { "externalPorts" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "name" : "Connect to PE", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "portId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6", "isSubInterface" : true, "vlanId" : 2, "isEnableMpls" : true, "ipConnection" : { "ipv4" : { "ipMode" : "Static", "customerAddress" : "192.168.0.1", "prefixLength" : 24 } }, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "" } ] }

响应示例 返回状态码为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 { "errmsg" : "", "errcode" : "", "successList" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ], "failList" : [ { "errmsg" : "", "errcode" : "0", "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ] } 返回状态码为207：部分成功。 HTTP/1.1 207 Multi-Status 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 { "errmsg" : "", "errcode" : "", "successList" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ], "failList" : [ { "errmsg" : "", "errcode" : "0", "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ] } 返回状态码为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 { "errmsg" : "", "errcode" : "", "successList" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ], "failList" : [ { "errmsg" : "", "errcode" : "0", "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ] } 返回状态码为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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 删除条件。 - 表2 DelAuthFreeMacDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 authType 否 int32 [0-1] - 认证类型： 0:haca 1:portal2.0 0 authFreeMacs 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 免认证MAC表项。 - 表3 DelAuthFreeMac对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 userName 否 string 1~256个字符。 - 用户名，不支持模糊匹配。 "user1" terminalMac 否 string 12~17个字符。 - 终端MAC，大小写不敏感，支持的格式：xx-xx-xx-xx-xx-xx/xx:xx:xx:xx:xx:xx/xxxxxxxxxxxx。 "aa-bb-cc-11-22-33"

响应参数 返回状态码为200：操作成功。 表4 DelResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string 0~256个字符。 错误信息。 - errcode string 0~64个字符。 0 错误码。 - successList ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 删除成功列表。 - failList ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 删除失败列表。 - 表5 DelAuthFreeMac对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 userName string 1~256个字符。 - 用户名，不支持模糊匹配。 "user1" terminalMac string 12~17个字符。 - 终端MAC，大小写不敏感，支持的格式：xx-xx-xx-xx-xx-xx/xx:xx:xx:xx:xx:xx/xxxxxxxxxxxx。 "aa-bb-cc-11-22-33" 表6 DeleteFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string 0~256个字符。 错误信息。 "" errcode string 0~64个字符。 0 错误码。 "0" userName string 0~256个字符。 - 用户名 "user1" terminalMac string 12~17个字符。 - 终端MAC "aa-bb-cc-11-22-33" 返回状态码为207：部分成功。 DelResponseDto对象的参数列表，详细请参见表4。 返回状态码为400：校验异常或全部失败。 DelResponseDto对象的参数列表，详细请参见表4。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /v1/portal/authfree-macs/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 { "authType" : 0, "authFreeMacs" : [ { "userName" : "user1", "terminalMac" : "aa-bb-cc-11-22-33" } ] }

响应示例 返回状态码为200：正常响应,返回体参考InterlinkRouteResponse。 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" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "interlinkRoutes" : [ { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "helloTimer" : 5, "timerDead" : 15, "enableImportDefaultRoute" : false } ] } } 返回状态码为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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interlinkRoute 是 REFERENCE 详细请参见表2。 修改双网关互联链路路由配置。 - 表2 InterlinkRouteInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid 0~36个字符。 - VPN ID，uuid格式。 "00000000-0000-0000-0000-000000000000" interlinkRoutes 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 双网关互联链路路由信息。 - 表3 InterlinkRouteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid 0~36个字符。 - ID，uuid格式。 "00000000-0000-0000-0000-000000000000" siteId 否 uuid 0~36个字符。 - 站点ID，uuid格式。 "00000000-0000-0000-0000-000000000000" helloTimer 否 int32 [1-65535] 5 Hello报文时间间隔。建议Hello报文时间间隔取值不小于5，否则可能会造成邻接关系的中断。缺省情况下，P2P、Broadcast类型接口发送Hello报文的时间间隔的值为10秒；P2MP、NBMA类型接口发送Hello报文的时间间隔的值为30秒 5 timerDead 否 int32 [1-65535] - OSPF的邻居失效时间，必须大于Hello报文的时间间隔。 15 enableImportDefaultRoute 否 boolean true false - 是否引入双网关默认路由。 false

响应参数 返回状态码为200：正常响应,返回体参考InterlinkRouteResponse。 表4 InterlinkRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success REFERENCE 详细请参见表3。 - - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/interlink-route 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" : "00000000-0000-0000-0000-000000000000", "interlinkRoutes" : [ { "id" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "helloTimer" : 5, "timerDead" : 15, "enableImportDefaultRoute" : false } ] }

响应示例 返回状态码为200：站点解绑AP VLAN POOL成功，响应体参考ApVlanPoolResponse。 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" : "", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "data" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "VLANPOOLTemplate1", "range" : "3001", "type" : "even" } ] } 返回状态码为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的示例 PUT /v1/networkconfig/wlan/ap/vlanpools/unbind 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-0000000", "templateIds" : ["00000000-0000-0000-0000-0000000"] }

响应示例 返回状态码为200：查询关联spoke站点成功 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" : "", "isHub" : true, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "Site Name", "role" : 2, "siteGateType" : 1, "address" : "", "floor" : "" } ], "totalRecords" : 10, "pageSize" : 10, "pageIndex" : 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

URI /controller/campus/v1/sdwan/overlay-network/topology/get-related-spoke-sites 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID，uuid格式。 "00000000-0000-0000-0000-000000000000" keyWord 否 string 0~64个字符。 - 关键字。 "site1" pageIndex 否 int32 - - 当前页数，为空表示查询所有页。 - pageSize 否 int32 - - 每页显示数量，为空表示查询所有页 -

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/topology/get-related-spoke-sites?siteId=00000000-0000-0000-0000-000000000000&keyWord=site1 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：查询关联spoke站点成功 表2 SpokeSitesPageResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码，0表示成功，非0表示失败。 "0" errmsg string 0~256个字符。 - 错误信息 - isHub boolean true false false 是否是hub站点 true data ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 关联的spoke站点列表。 - totalRecords int32 - - 总的数据条数。 10 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 表3 TopoSiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 站点ID，uuid格式。 "00000000-0000-0000-0000-000000000000" name string - - 站点名称。 "Site Name" role int32 - - 站点角色。 2 siteGateType int32 [1-2] - 站点单双关，1代表单网关，2代表双网关。 1 address string 0~256个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 地址 - floor string 0~256个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 楼层 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应参数 返回状态码为200：删除成功，响应体参考CommonDomainResponse。 CommonDomainResponse对象的参数列表，详细请参见表4。 返回状态码为400：请求参数错误，响应体参考DeleteDomainResult。 表2 DeleteDomainResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string - 0 删除失败错误码，如果成功，错误码默认为0。 "0x587679" errorMsg string 0~255个字符。 - 删除失败的错误异常信息。 "" 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除成功，响应体参考CommonDomainResponse。 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：请求参数错误，响应体参考DeleteDomainResult。 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 { "errorCode" : "0x587679", "errorMsg" : "" } 返回状态码为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的示例 DELETE /controller/campus/v1/sdwan/aaa/domain/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：操作成功。 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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 info-center-source 是 REFERENCE 详细请参见表4。 信息通道 - 表4 syslog-config-exactProperties-info-center-source-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-syslog:info-center-source 否 ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 信息通道 - 表5 syslog-config-exactProperties-info-center-source-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 module-name 是 string 1~31个字符。满足正则表达[^A-Z]*。 - 模块名称."1-31位小写字母或数字，如a-z或0-9，例如：default,其他特性在设备产品文档"日志参考"中可以查到设备当前支持的所有模块名称，如aaa、am，具体以设备产品文档为准。" "default" channel-id 是 int64 [0-9] - 通道ID 5 enable-log 否 boolean true false - 使能日志 - enable-log-level 否 string emergencies alert critical error warning notification informational debugging - 使能日志级别 - enable-trap 否 boolean true false - 使能Trap - enable-trap-level 否 string emergencies alert critical error warning notification informational debugging - 使能Trap级别 -

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-syslog:syslog-config/info-center-source 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-syslog:info-center-source" : [ { "module-name" : "default", "channel-id" : 5, "enable-log" : "", "enable-log-level" : "", "enable-trap" : "", "enable-trap-level" : "" } ] }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-syslog:syslog-config/info-center-source 表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"

响应示例 返回状态码为200：创建Loopback配置成功，响应体参考，返回结构体参见LoopbackResponseDtoLoopbackResponseDto。 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" : { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "id" : "fbb684c80d37496fbafa4b06d5151e2e", "deviceName" : "device1", "esn" : "1019A063325", "nameAllocMode" : "manual", "loopBackName" : "LoopBack1", "ipAddress" : "192.168.0.1", "mask" : 24, "description" : "description" } } 返回状态码为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/api/v1/networkconfig/loopback/device/fbb684c8-0d37-496f-bafa-4b06d5151e2e 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 { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "id" : "fbb684c80d37496fbafa4b06d5151e2e", "deviceName" : "device1", "esn" : "1019A063325", "nameAllocMode" : "manual", "loopBackName" : "LoopBack1", "ipAddress" : "192.168.0.1", "mask" : 24, "description" : "description" }

响应参数 返回状态码为200：创建Loopback配置成功，响应体参考，返回结构体参见LoopbackResponseDtoLoopbackResponseDto。 表4 LoopbackResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 描述，一个中文占三个字符，结构体参见LoopbackDto。 - 表5 LoopbackDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" id string 32~36个字符。 - Loopback的id。创建时无需填写自动生成，创建成功后会返回id。修改时该id标识为需要修改的Loopback。 "fbb684c80d37496fbafa4b06d5151e2e" deviceName string 0~64个字符。 - 设备名称。 "device1" esn string 10~40个字符。 - 设备ESN。 "1019A063325" nameAllocMode string auto manual - 名称配置方式。auto表示自动分配，manual表示手动分配。 "manual" loopBackName string 9~10个字符。 - loopback名称，云杉AP最大限制8，其他设备类型15，不允许修改，另当nameAllocMode为auto的时候loopBackName不生效。 "LoopBack1" ipAddress string 0~64个字符。 - ip地址。 "192.168.0.1" mask int32 [1-32] - 掩码。 24 description string 0~242个字符。 - 描述，一个中文占三个字符。 "description" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 创建Loopback配置信息，结构体参见LoopbackDto。 - 表3 LoopbackDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" id 否 string 32~36个字符。 - Loopback的id。创建时无需填写自动生成，创建成功后会返回id。修改时该id标识为需要修改的Loopback。 "fbb684c80d37496fbafa4b06d5151e2e" deviceName 否 string 0~64个字符。 - 设备名称。 "device1" esn 否 string 10~40个字符。 - 设备ESN。 "1019A063325" nameAllocMode 否 string auto manual - 名称配置方式。auto表示自动分配，manual表示手动分配。 "manual" loopBackName 否 string 9~10个字符。 - loopback名称，云杉AP最大限制8，其他设备类型15，不允许修改，另当nameAllocMode为auto的时候loopBackName不生效。 "LoopBack1" ipAddress 否 string 0~64个字符。 - ip地址。 "192.168.0.1" mask 否 int32 [1-32] - 掩码。 24 description 否 string 0~242个字符。 - 描述，一个中文占三个字符。 "description"

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/monitor/netstream/switch?pageIndex=1&pageSize=10 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：查询成功，响应体参考MonitorCfgResponse。 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" : "", "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100, "data" : [ "fbb684c8-0d37-496f-bafa-4b06d515j7l6" ], "fixPacketsNums" : [ 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 返回状态码为403：接口无权限。 HTTP/1.1 403 Forbidden 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

URI /controller/campus/v1/sdwan/monitor/{metric}/switch 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 metric 是 string 0~64个字符。 - 采集项，该字段可以设置为以下几种： a) netstream：应用流量 b) tcpfpm：应用质量 c) wanlink：WAN链路流量 d) linkqualityEnhance：WAN链路质量增强 e) sourceip：LAN IP采集（源IP） f) wanSourceIp：WAN IP采集（源IP） g) wanDestIp：WAN IP采集（目的IP） h) wanSession：WAN IP采集（会话） i) thirdPartyNetstream：第三方Netstream "netstream" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-10000] - 当前页，从1开始。 1 pageSize 否 int32 [1-10000] - 页大小。 10

响应示例 返回状态码为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" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] } } 返回状态码为202：请求正在处理中，请求处理详情请通过查询业务编排结果，确认是否处理成功。响应体参考VnSiteAsyncResponse。 HTTP/1.1 202 Accepted 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" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] }, "processInstanceId" : "" } 返回状态码为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