华为云用户手册

配置Loopback接口缺省模板（仅V300版本AR设备） 表1 ConfigLoopBackPort模板参数解释 参数名称 类型 取值范围 参数解释 ipPrefix Int 0～32 IP地址的掩码。 ipAddress String - 在LoopBack接口下配置的IP地址。 portName String - LoopBack接口名称，格式为LoopBack+接口编号，例如LoopBack10。 下发到设备的命令行： interface portName ip addrss ipAddress ipPrefix 父主题： iMaster NCE-Campus内置缺省模板参数介绍

响应示例 返回状态码为200：切换注册WAN链路成功，响应体参考SiteManagerLinkChangeResponse。 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" : { "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347aa", "wanLinkId" : "a99f794e-b510-438c-a75d-de59f02347bb", "protocol" : "IPv4", "southAccessRole" : 1, "accessIpMode" : 0 } } 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteManagerLinkUpdateRequest 是 REFERENCE 详细请参见表2。 入参 - 表2 SiteManagerLinkChange对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 UUID - - 站点ID，格式为uuid，更新时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 UUID - - 设备ID，格式为uuid，更新时必填。 "a99f794e-b510-438c-a75d-de59f02347aa" wanLinkId 否 string 0~64个字符。 - 链路ID，格式为uuid，更新时必填。 "a99f794e-b510-438c-a75d-de59f02347bb" protocol 否 string 0~32个字符。 - 注册AC链路的协议：IPv4、IPv6，默认值IPv4。 "IPv4" southAccessRole 否 integer [1-2] 1 南向接入服务，1表示南向接入服务1、2表示南向接入服务2，默认值为1。IPv6不支持使用南向接入服务2。 1 accessIpMode 否 integer [0-1] 0 南向接入IP模式，0表示主用南向IP、1表示备用南向IP，默认值为0。 0

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/site-manage-link 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 { "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347aa", "wanLinkId" : "a99f794e-b510-438c-a75d-de59f02347bb", "protocol" : "IPv4", "southAccessRole" : 1, "accessIpMode" : 0 }

响应参数 返回状态码为200：切换注册WAN链路成功，响应体参考SiteManagerLinkChangeResponse。 表3 SiteManagerLinkChangeResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表4。 调用设备切换当前注册AC的WAN链路返回结果。 - 表4 SiteManagerLinkChange对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId UUID - - 站点ID，格式为uuid，更新时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId UUID - - 设备ID，格式为uuid，更新时必填。 "a99f794e-b510-438c-a75d-de59f02347aa" wanLinkId string 0~64个字符。 - 链路ID，格式为uuid，更新时必填。 "a99f794e-b510-438c-a75d-de59f02347bb" protocol string 0~32个字符。 - 注册AC链路的协议：IPv4、IPv6，默认值IPv4。 "IPv4" southAccessRole integer [1-2] 1 南向接入服务，1表示南向接入服务1、2表示南向接入服务2，默认值为1。IPv6不支持使用南向接入服务2。 1 accessIpMode integer [0-1] 0 南向接入IP模式，0表示主用南向IP、1表示备用南向IP，默认值为0。 0 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

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

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 站点模板AP隧道全局配置参数体 - 表3 ApTunnelGlobalDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 networkOffPeriod 否 int64 [0-120] 0 主备隧道倒换用户接入间隔时间(单位：秒) 100

请求示例 HTTP的示例 PUT /controller/campus/v3/networkconfig/site-templates/fbb684c8-0d37-496f-bafa-4b06d5151e2e/aptunnel-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 { "networkOffPeriod" : 100 }

URI /controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/aptunnel-config 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为200：配置成功，响应体参考SimpleResponse。 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" : "", "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考SimpleResponse。 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 返回状态码为207：部分失败，响应体参考BindSyslogRsp。 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 { "successList" : [ { "errmsg" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "sourceIp" : "192.168.0.1", "sourceInterface" : "loopback601" } ], "failList" : [ { "errmsg" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "sourceIp" : "192.168.0.1", "sourceInterface" : "loopback601" } ] } 返回状态码为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 /controller/campus/v2/sdwansyslog/syslog/00000000-0000-0000-0000-000000000000/site 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 { "bindSites" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "devices" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "linkId" : "00000000-0000-0000-0000-000000000000", "sourceIp" : "192.168.0.1", "sourcePort" : 10245, "sourceInterface" : "601" } ] } ], "unbindSites" : [ "00000000-0000-0000-0000-000000000000" ] }

响应参数 返回状态码为200：配置成功，响应体参考SimpleResponse。 SimpleResponse对象的参数列表，详细请参见表3。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考SimpleResponse。 返回状态码为207：部分失败，响应体参考BindSyslogRsp。 表6 BindSyslogRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 详细请参见表7。 成功列表。 - failList ARRAY_REFERENCE 详细请参见表7。 失败列表。 - 表7 SuccessFailData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string - - 失败原因，成功时则为空。 "" siteId string - - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "site1" deviceId string - - 设备ID。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "device1" linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" linkName string - - 链路名称。 "link1" vpnId string - - VPN ID。 "00000000-0000-0000-0000-000000000000" vpnName string - - VPN名称。 "vpn1" sourceIp string - - 设备日志源Ip。 "192.168.0.1" sourceInterface string - - 设备日志源接口。 "loopback601" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/sites/00000000-0000-0000-0000-000000000000/qos-policy?qosPolicyId=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

URI /controller/campus/v1/sdwan/policy/traffic/sites/{siteId}/qos-policy 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 qosPolicyId 否 uuid - - 策略ID。 "00000000-0000-0000-0000-000000000000"

响应参数 返回状态码为200：查询成功，响应体参考QuerySiteQosPolicyResponse。 表3 QuerySiteQosPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 QoS策略信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QuerySiteQosPolicyResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "name" : "qos1", "direction" : "", "qosRules" : [ { "qosRuleId" : "00000000-0000-0000-0000-000000000000", "qosClassificationId" : "00000000-0000-0000-0000-000000000000", "qosClassificationName" : "qosClassificationName", "qosProfileId" : "00000000-0000-0000-0000-000000000000", "qosProfileName" : "templateName", "lanQosProfileId" : "00000000-0000-0000-0000-000000000000", "lanQosProfileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "qosPriority" : 1 } ], "status" : 1, "isActive" : true, "bindMode" : "siteMode" } ] } 返回状态码为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

响应示例 返回状态码为201：创建成功返回。 HTTP/1.1 201 Created 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" : { "name" : "vn1", "vpnInstanceName" : "vpn1", "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ], "ipsecEncryption" : true, "overlayHeadLength" : 36, "enableIPv6" : true, "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" } } 返回状态码为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/v1/lanwan/vn 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" : "vn1", "ipsecEncryption" : true, "vpnInstanceName" : "vpn1", "overlayHeadLength" : 36, "enableIPv6" : true, "ipType" : "IPv4", "description" : "vn" }

响应参数 返回状态码为201：创建成功返回。 表3 VnResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表4。 VN详细信息。 - 表4 VnInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 0~32个字符。 - VN名称。 "vn1" vpnInstanceName string 0~31个字符。 - 下发到设备的VPN实例名称，无需填充，查询返回。 "vpn1" siteInfos ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 站点ID列表，最大100个。 - ipsecEncryption boolean true false true 当链路未开启IPSEC加密功能时，可基于VPN配置是否开启IPSEC加密。 true overlayHeadLength int32 [1-512] - VPN隧道长度扣除字节数。当VPN隧道长度扣除字节数为空时，表示不配置VPN隧道长度扣除字节数。tunnel建议的扣除长度为36；开启Ipsec时，建议扣除94;开启Ipsec、NAT时，建议扣除102，V600版本设备从V600R022C00版本开始支持此功能，AR6700V-LITE从V600R023C00版本开始支持此功能。 36 enableIPv6 boolean true false false 是否使能IPv6能力 true description string 0~200个字符。 - VN业务描述。 "vn" id string 0~36个字符。 - VN标识。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" 表5 SiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 36个字符。 - 站点标识，uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" siteName string 0~64个字符。 - 站点名称，不需要填充。 "site" isWanServiceNeeded boolean true false true 该参数已经废弃，无需设置。 true routeDistinguisher string 0~21个字符。 - 路由标识RD，填写后不支持修改。支持的格式如下：2字节自治系统号:4字节用户自定义数，其中自治系统号的取值范围是0～65535，用户自定义数的取值范围是0～4294967295，例如101:3。自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；整数形式4字节自治系统号:2字节用户自定义数，自治系统号的取值范围是65536～4294967295，用户自定义数的取值范围是0～65535，例如0:3或者65537:3。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；点分形式4字节自治系统号:2字节用户自定义数，点分形式自治系统号通常写成x.y的形式，x和y的取值范围都是0～65535，用户自定义数的取值范围是0～65535，例如0.0:3或者0.1:0。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0.0:0；IPv4地址:2字节用户自定义数，例如：192.168.122.15:1。IP地址的取值范围是0.0.0.0～255.255.255.255；用户自定义数的取值范围是0～65535。不可配置5500:5500因预留给增强模式下的vlanif使用。 "101:3" status string SUCCESS CONFIGURING FAIL - 下发状态，不需要填充。 "SUCCESS" errMsg string 0~256个字符。 - 错误信息，不需要填充。 "" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnBaseInfo 是 REFERENCE 详细请参见表2。 VN信息。 - 表2 CreateVnInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~32个字符。 - VN名称。 "vn1" ipsecEncryption 否 boolean true false false 当链路未开启IPSEC加密功能时，可基于VPN配置是否开启IPSEC加密。 true vpnInstanceName 否 string 0~31个字符。 - 自定义下发到设备的VPN实例名称，可不填。如不填充，由系统自动生成。 "vpn1" overlayHeadLength 否 int32 [1-255] - VPN隧道长度扣除字节数。当VPN隧道长度扣除字节数为空时，表示不配置VPN隧道长度扣除字节数。tunnel建议的扣除长度为36；开启Ipsec时，建议扣除94;开启Ipsec、NAT时，建议扣除102，V600版本设备从V600R022C00版本开始支持此功能，AR6700V-L从V600R023C00版本开始支持此功能。 36 enableIPv6 否 boolean true false false 是否使能IPv6能力，兼容字段，后续使用ipType字段，enableIPv6为false时，相当于ipType取值IPv4，enableIPv6为true时，相当于ipType取值IPv4IPv6。V300版本的设备当前IPv6只支持本地开局，不支持站点间互访、overlay Qos、智能选路，集中上网功能。V600版本的设备需要升级到R022C10及后续版本才能支持以上功能，AR6700V-L从V600R023C10版本开始支持此功能。 true ipType 否 string 0~200个字符。 - IP类型。GRE隧道模式支持的字段：IPv4、IPv4IPv6。enableIPv6与ipType都配置的情况下，优先使用ipType。 "IPv4" description 否 string 0~200个字符。 - VN业务描述。 "vn"

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/profile/apvpn/encryptionpolicy?pageIndex=1&pageSize=20 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 QueryEncryptitonPolicyResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息 "" pageIndex int32 [1-100] - 第几页的数据。 1 pageSize int32 [1-20] - 一页多少条数据。 1 totalRecords int32 [0-21] - 总数。 1 data ARRAY_REFERENCE 0-21个列表项，详细请参见表4。 VPN配置数据 -

响应示例 返回状态码为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" : "", "pageIndex" : 1, "pageSize" : 1, "totalRecords" : 1, "data" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e", "name" : "TEST", "ikeVersion" : "v1", "ikeEncryptAlgorithm" : "aes-256", "ikeNegotiationMode" : "main", "ikeAuthAlgorithm" : "sha2-256", "ikeIntegrityAlgorithm" : "sha2-256", "ikePrf" : "sha2-256", "ipsecTransformProtocol" : "ah", "ipsecEncapsulationMode" : "tunnel", "ipsecAhAuthAlgorithm" : "sha2-256", "ipsecAuthAlgorithm" : "sha2-256", "ipsecEncryptAlgorithm" : "aes-256", "ipsecPfs" : "group1", "ipsecLifetimeSeconds" : "30", "ipsecLifetimeKilobytes" : "256", "ipsecDpdType" : "periodic", "ipsecDpdMsg" : "seq-hash-notify", "ipsecDpdInterval" : "30", "ipsecDpdTimeout" : "15", "ikeDh" : "group1", "ikeLifeTime" : "60" } ] }

响应示例 返回状态码为200：删除成功，响应体参考TrafficFilterPolicyResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpnName", "name" : "app", "classificationProfileId" : "00000000-0000-0000-0000-000000000000", "classificationProfileName" : "classificationProfileName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "priority" : 1, "direction" : "inbound", "action" : "permit", "status" : 1, "isActive" : true, "bindMode" : "siteMode", "templateMode" : "classifier" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpnName", "name" : "app", "classificationProfileId" : "00000000-0000-0000-0000-000000000000", "classificationProfileName" : "classificationProfileName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "priority" : 1, "direction" : "inbound", "action" : "permit", "status" : 1, "isActive" : true, "bindMode" : "siteMode", "templateMode" : "classifier" } } ] } 返回状态码为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/v1/sdwan/policy/traffic/traffic-filter-policies/action/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 { "effectImmediate" : true, "trafficFilterPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpnName", "name" : "app", "classificationProfileId" : "00000000-0000-0000-0000-000000000000", "classificationProfileName" : "classificationProfileName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "priority" : 1, "direction" : "inbound", "action" : "permit", "status" : 1, "isActive" : true, "bindMode" : "siteMode", "templateMode" : "classifier" } ] }

响应示例 返回状态码为200：接口调用成功，响应体参考IPSubnetResponse。 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } } ] } 返回状态码为204：执行成功，没有数据。 HTTP/1.1 204 No Content 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

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/ip-subnets 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 { "IPSubnets" : [ { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "interfaceType" : "interface", "interfaceName" : "vlanif20", "portLagFlag" : false, "portId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vlanId" : 1, "subInterfaceName" : "GE0/0/0.1", "trustEnable" : false, "trust" : "dscp", "ipAddress" : "192.168.1.1", "prefixLength" : 24, "secondaryIP" : ["10.10.10.2/24","10.10.11.2/24"], "siteName" : "site", "deviceName" : "device", "vrrp" : { "enable" : true, "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrpList" : [ { "vrrpId" : 1, "virtualIpAddress" : "10.1.1.1;10.1.2.1", "defaultRole" : "master", "preemptDelay" : 0, "priority" : 1, "authMode" : 0, "authKey" : "", "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ] } ] }, "dhcp" : { "enable" : false, "dhcpServiceType" : "server", "dhcpServer" : { "excludeIpGroups" : [ { "startAddress" : "192.168.1.2", "endAddress" : "192.168.1.3" } ], "leaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "voiceOption" : { "asIp" : "192.168.1.10", "ncpIp" : "192.168.1.10", "voiceVlan" : 3, "failOver" : { "ipAddress" : "192.168.1.10", "dialerString" : "12345678" }, "description" : "description" }, "dhcpOption" : [ { "code" : 44, "type" : "ascii", "description" : "Wins/Netbios server", "value" : "192.168.1.1" } ], "dhcpStatic" : [ { "ipAddress" : "192.168.1.10", "macAddress" : "xxxx-xxxx-xxxx" } ], "dns" : ["8.8.8.8","114.114.114.114"], "domainName" : "example.com", "useSecondaryIP" : false }, "dhcpRelay" : { "serverIps" : ["192.168.1.1"], "sourceAddress" : "10.10.10.2", "gatewayAddress" : "10.10.10.3", "dhcpRelayOption82" : { "function" : 0, "vlanId" : 1, "subOption" : [ { "subOptionCode" : 0, "isUserDefined" : true, "value" : "\"ZID023301\"" } ] }, "linkSelectionEnable" : true, "linkSelectionAddress" : "10.10.10.1" } }, "securityZone" : "trust", "proxyArp" : false, "innerProxyArp" : false, "attributes" : { "mtu" : 1500, "TCPmss" : 1200 }, "description" : "description", "toVasEnable" : false, "enableIpv4" : true, "enableIpv6" : false, "ipv6Info" : { "ipv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "dhcpV6Enable" : true, "dhcpV6" : { "dhcpv6ServiceType" : "server", "dhcpv6Server" : { "addressPrefix" : "fc00:3::/64", "addressPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "delegationPrefix" : "fc00:3::/64", "delegationPrefixAssignLength" : 64, "delegationPrefixLeaseTime" : { "day" : 0, "hour" : 0, "minute" : 0 }, "excludeIpGroups" : [ { "startAddress" : "fc00:1::1", "endAddress" : "fc00:1::10" } ], "firstDnsServer" : "fc00:3::1", "secondDnsServer" : "fc00:3::2", "domainName" : "0" }, "dhcpv6Relay" : { "serverIps" : ["fc00::1"] } }, "vrrp6Enable" : true, "vrrp6" : { "vrrp6Id" : 1, "virtualIpv6AddressLinkLocal" : "fe80::7", "virtualIpv6Address" : "fc00:3::10;fc00:3::11", "preemptDelay" : 0, "priority" : 1, "trackEnable" : true, "track" : [ { "bfdSession" : { "localDiscriminator" : 1, "remoteDiscriminator" : 1, "sourceIp" : "192.168.1.1", "peerIp" : "192.168.1.1", "interval" : 10 }, "interfaceName" : "GE0/0/1", "addOrReduce" : "reduce", "value" : 1, "type" : "ipv4" } ], "vrrp6Role" : "" }, "ipv6NtpDisable" : false, "raHaltEnable" : false, "managedAddressFlagEnable" : false }, "configSource" : "Wan", "ntpDisable" : false, "unrHostRouteAdvertiseEnable" : false, "dhcpTriggerEnable" : false, "unrRoutesLimitEnable" : false, "unrRoutesLimit" : 24 } ] }

响应示例 返回状态码为200：查询成功，响应体参考QueryApplicationGroupResponse。 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" : "", "totalRecords" : 10, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "groupName" : "officeApp", "description" : "", "predefinedApps" : [ { "applicationId" : "2601", "applicationType" : "DPI", "applicationName" : "", "categoryName" : "", "categoryId" : "" } ], "customApps" : [ "00000000-0000-0000-0000-000000000000" ], "customApplications" : [ { "applicationName" : "", "applicationId" : "" } ], "saType" : "SA_H30071002", "shortId" : "", "experienceLevel" : "", "configId" : "00000000-0000-0000-0000-000000000000" } ] } 返回状态码为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

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

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/application/application-groups 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