华为云用户手册

响应示例 返回状态码为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" : "", "totalRecords" : 100, "data" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] } 返回状态码为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/sdwan/v1/naas/virtual/device 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 { "deviceInfos" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 VirtualDevice 是 REFERENCE 详细请参见表2。 子设备信息。 - 表2 VirtualDeviceRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceInfos 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 子设备列表。 - 表3 VirtualDeviceInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parentId 否 string 0~128个字符。 - 父设备ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 string 0~64个字符。 - 子设备ID, 创建时不使用。 "00000000-0000-0000-0000-000000000000" deviceName 否 string 1~63个字符。 - 子设备名称。 "tenant1" isExclusiveResource 否 boolean true false - 是否独占资源。 false vpnNumber 否 int32 [1-1024] - VPN数量。 100 bandWidth 否 int32 [10-10240] - 带宽，废弃，由sdwan带宽，sdwan加密带宽，vxlan带宽替代。 100 siteNumber 否 int32 [1-1024] - 站点数量。 100 sdwanBandwidth 否 int32 [0-10000] - sdwan带宽,Mbit/s。 100 encryptedSdwanBandwidth 否 int32 [0-2000] - sdwan加密带宽,Mbit/s。 100 vxlanBandwidth 否 int32 [0-10000] - VXLAN带宽,Mbit/s。 100 status 否 int32 [0-6] - 子设备状态，非配置字段，查询时返回。0：注册异常，1：上线异常，2：离线异常，3：在线，4：离线。 0 role 否 string 1~32个字符。 - 设备角色。取值范围：Interworking Gateway。不填默认Interworking Gateway。 "Interworking Gateway" siteId 否 string 1~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName 否 string 0~64个字符。 - 站点名称。 "site1"

响应参数 返回状态码为201：创建成功返回。 表4 VirtualDeviceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总数。 100 data ARRAY_REFERENCE 0-32个列表项，详细请参见表5。 子设备列表。 - 表5 VirtualDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 parentId string 0~128个字符。 - 父设备ID。 "00000000-0000-0000-0000-000000000000" deviceId string 0~64个字符。 - 子设备ID, 创建时不使用。 "00000000-0000-0000-0000-000000000000" deviceName string 1~63个字符。 - 子设备名称。 "tenant1" isExclusiveResource boolean true false - 是否独占资源。 false vpnNumber int32 [1-1024] - VPN数量。 100 bandWidth int32 [10-10240] - 带宽，废弃，由sdwan带宽，sdwan加密带宽，vxlan带宽替代。 100 siteNumber int32 [1-1024] - 站点数量。 100 sdwanBandwidth int32 [0-10000] - sdwan带宽,Mbit/s。 100 encryptedSdwanBandwidth int32 [0-2000] - sdwan加密带宽,Mbit/s。 100 vxlanBandwidth int32 [0-10000] - VXLAN带宽,Mbit/s。 100 status int32 [0-6] - 子设备状态，非配置字段，查询时返回。0：注册异常，1：上线异常，2：离线异常，3：在线，4：离线。 0 role string 1~32个字符。 - 设备角色。取值范围：Interworking Gateway。不填默认Interworking Gateway。 "Interworking Gateway" siteId string 1~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName string 0~64个字符。 - 站点名称。 "site1" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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 { "huawei-nce-e-nat-address-group:snat-address-group" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "name", "mode" : "full-cone", "mode-pattern" : { "reverse-enable" : true, "address-zone" : "global" }, "sections" : { "section" : [ { "section-id" : 5, "start-ip" : "192.168.1.2", "end-ip" : "192.168.1.5" } ] }, "vrid" : 6, "port-block" : { "size" : 10, "extended-times" : 1, "start-port" : 1000, "end-port" : 1100 } } ] } 返回状态码为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 snat-address-group-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nat-address-group:snat-address-group ARRAY_REFERENCE 详细请参见表4。 源NAT地址池。 - 表4 nes-ne-snat-address-group对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 config-status string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态，对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态；不支持编辑，仅查询返回。 "configured-database-success" last-committed-time string 0~255个字符。 - 最后提交时间，该特性最后提交时间；不支持编辑，仅查询返回。 "2022-01-01 00:00:00" related-pkg-version string 0~255个字符。 - 包版本，插件包版本；不支持编辑，仅查询返回。 "1.0.1" edit-state string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态，对应运行状态、候选状态、取消部署状态、未部署状态；不支持编辑，仅查询返回。 "RUNNING" name string 1~34个字符。 - 源NAT地址池名称，单一主键字段。 "name" mode string pat no-pat full-cone pat NAT模式。 "full-cone" mode-pattern REFERENCE 详细请参见表5。 NAT模式扩展。AR6700V-L款型不支持。 - sections REFERENCE 详细请参见表6。 地址段。 - vrid int64 [1-255] - VRRP备份组号。AR6700V-L款型不支持。 6 port-block REFERENCE 详细请参见表8。 端口预分配。AR6700V-L款型不支持。 - 表5 mode-pattern对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 reverse-enable boolean true false true Servermap反向。 true address-zone string global local - 安全域。 "global" 表6 sections对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 section ARRAY_REFERENCE 详细请参见表7。 地址段列表。 - 表7 sections-section对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 section-id int32 [0-65535] - 地址段ID，单一主键字段。 5 start-ip string - - 起始IP地址。 "192.168.1.2" end-ip string - - 结束IP地址。 "192.168.1.5" 表8 port-block对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 size int32 [8-16384] - 预分配端口块大小。 10 extended-times int32 [1-3] - 增量分配的次数。 1 start-port int32 [0-65535] - 起始端口。 1000 end-port int32 [0-65535] - 结束端口。 1100 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nat-address-group:snat-address-group 表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的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-address-group:snat-address-group 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"

响应示例 返回状态码为201：接口调用成功，响应体参考GreTunnelResponse。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "fc00:3::1/64", "srcIpAddress" : "192.168.1.1", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "destVpnId" : "00000000-0000-0000-0000-000000000000", "destWanLinkId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "key" : "123456", "checkSum" : "", "enableIpsec" : "", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "enableKeepAlive" : false, "period" : 5, "retryTimes" : 3, "mtu" : 1500 } ] } 返回状态码为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/site/inter/connect/gre/tunnel 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 { "greTunnelInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "fc00:3::1/64", "srcIpAddress" : "192.168.1.1", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "destVpnId" : "00000000-0000-0000-0000-000000000000", "destWanLinkId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "key" : "123456", "checkSum" : "", "enableIpsec" : "", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "enableKeepAlive" : false, "period" : 5, "retryTimes" : 3, "mtu" : 1500 } ] }

响应参数 返回状态码为201：接口调用成功，响应体参考GreTunnelResponse。 表4 GreTunnelResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表5。 成功添加或更新的GRE Tunnel配置。 - 表5 GreTunnelInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string - - 对应站点的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId string - - 对应设备的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" id string - - GRE Tunnel ID,更新,删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" tunnelPortName string - - GRE Tunnel端口名，不能重复。创建时必填。 "Tunnel0/0/400" wanLinkId string - - Wan链路的ID。和业务VPN ID二选一。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId string 0~64个字符。 - 业务VPN ID，和Wan链路的ID二选一。 "00000000-0000-0000-0000-000000000000" ipAddress string - - GRE隧道IP地址。创建时必填。 "fc00:3::1/64" srcIpAddress string - - GRE隧道源IP地址。创建时必填。 "192.168.1.1" srcInterfaceId string 0~64个字符。 - 源接口Id，对应LOOPBACK ID；与GRE隧道源IP地址二选一。 "00000000-0000-0000-0000-000000000000" destVpnId string 0~64个字符。 - 目的VPN ID，非必填。 "00000000-0000-0000-0000-000000000000" destWanLinkId string 0~64个字符。 - 目的WAN链路ID，非必填。 "00000000-0000-0000-0000-000000000000" dstIpAddress string - - GRE隧道目的IP地址。创建时必填。 "192.168.1.2" key string - - GRE Key。 "123456" checkSum boolean true false false GRE 校验和，创建时不填默认为false。 - enableIpsec boolean true false false GRE 是否启动IPSec，创建时不填默认为false。V600版本设备不支持使能IPSec。 - ipsecProfileId string - - IPSec模板ID, 启动IPSec时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" enableKeepAlive boolean true false false 是否使能隧道keepAlive能力。 false period int32 [1-32767] - 指定发送KeepAlive报文的定时器周期,整数形式，取值范围是1～32767，单位是秒。缺省值是5秒。KeepAlive使能后必须配置。 5 retryTimes int32 [1-255] - 指定不可达计数器参数,整数形式，取值范围是1～255。缺省值是3。KeepAlive使能后必须配置。 3 mtu int32 [1280-9000] 1500 MTU，取值范围：1280-9000，默认1500。 1500 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 greTunnelRequest 是 REFERENCE 详细请参见表2。 创建GRE Tunnel配置请求数据。 - 表2 GreTunnelRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 greTunnelInfos 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 GRE Tunnel列表。 - 表3 GreTunnelInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string - - 对应站点的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 否 string - - 对应设备的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" id 否 string - - GRE Tunnel ID,更新,删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" tunnelPortName 否 string - - GRE Tunnel端口名，不能重复。创建时必填。 "Tunnel0/0/400" wanLinkId 否 string - - Wan链路的ID。和业务VPN ID二选一。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 string 0~64个字符。 - 业务VPN ID，和Wan链路的ID二选一。 "00000000-0000-0000-0000-000000000000" ipAddress 否 string - - GRE隧道IP地址。创建时必填。 "fc00:3::1/64" srcIpAddress 否 string - - GRE隧道源IP地址。创建时必填。 "192.168.1.1" srcInterfaceId 否 string 0~64个字符。 - 源接口Id，对应LOOPBACK ID；与GRE隧道源IP地址二选一。 "00000000-0000-0000-0000-000000000000" destVpnId 否 string 0~64个字符。 - 目的VPN ID，非必填。 "00000000-0000-0000-0000-000000000000" destWanLinkId 否 string 0~64个字符。 - 目的WAN链路ID，非必填。 "00000000-0000-0000-0000-000000000000" dstIpAddress 否 string - - GRE隧道目的IP地址。创建时必填。 "192.168.1.2" key 否 string - - GRE Key。 "123456" checkSum 否 boolean true false false GRE 校验和，创建时不填默认为false。 - enableIpsec 否 boolean true false false GRE 是否启动IPSec，创建时不填默认为false。V600版本设备不支持使能IPSec。 - ipsecProfileId 否 string - - IPSec模板ID, 启动IPSec时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" enableKeepAlive 否 boolean true false false 是否使能隧道keepAlive能力。 false period 否 int32 [1-32767] - 指定发送KeepAlive报文的定时器周期,整数形式，取值范围是1～32767，单位是秒。缺省值是5秒。KeepAlive使能后必须配置。 5 retryTimes 否 int32 [1-255] - 指定不可达计数器参数,整数形式，取值范围是1～255。缺省值是3。KeepAlive使能后必须配置。 3 mtu 否 int32 [1280-9000] 1500 MTU，取值范围：1280-9000，默认1500。 1500

响应示例 返回状态码为200：使能成功，返回体参考DeviceFreeRuleConfigResponse。 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" : [ { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "aclProfileId" : "50601b1c-c751-4072-9bca-2cf79b63bf70", "aclProfileName" : "acl", "freeRules" : [ { "ruleId" : 0, "sourceType" : "any", "sourceContent" : "192.168.1.1/32", "destType" : "any", "destContent" : "192.168.1.1/32" } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "aclProfileId" : "50601b1c-c751-4072-9bca-2cf79b63bf70", "aclProfileName" : "acl", "freeRules" : [ { "ruleId" : 0, "sourceType" : "any", "sourceContent" : "192.168.1.1/32", "destType" : "any", "destContent" : "192.168.1.1/32" } ] } } ] } 返回状态码为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/nac/free-rule 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-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "aclProfileId" : "50601b1c-c751-4072-9bca-2cf79b63bf70", "aclProfileName" : "acl", "freeRules" : [ { "ruleId" : 0, "sourceType" : "any", "sourceContent" : "192.168.1.1/32", "destType" : "any", "destContent" : "192.168.1.1/32" } ] } ]

响应参数 返回状态码为200：使能成功，返回体参考DeviceFreeRuleConfigResponse。 表5 DeviceFreeRuleConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 成功的信息。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 失败的信息。 - 表6 FailDeviceFreeRuleConfigInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 失败的信息。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 requestBody 是 REFERENCE 详细请参见表2。 默认放行规则配置信息。 - 表2 DeviceFreeRuleConfigInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 DeviceFreeRuleConfigInfos 是 ARRAY_REFERENCE 0-2个列表项，详细请参见表3。 批量默认放行规则结构体。 - 表3 DeviceFreeRuleConfigInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" deviceId 是 string 0~36个字符。 - 设备ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" aclProfileId 否 string 0~36个字符。 - acl模板ID。V600设备不支持。V300设备不支持IPv6 ACL模板，且地址类型为 域名 的IPv4 ACL模板不生效。与freeRules不支持同时配置。 "50601b1c-c751-4072-9bca-2cf79b63bf70" aclProfileName 否 string 0~32个字符。 - acl模板名称，仅供查询显示，配置时无需填写。 "acl" freeRules 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 规则列表，与aclProfileId不支持同时配置。 - 表4 FreeRuleDataInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ruleId 否 int32 [0-511] - Rule ID。 0 sourceType 否 string 0~36个字符。 - 源类型。 "any" sourceContent 否 string 0~128个字符。 - 源内容。 "192.168.1.1/32" destType 否 string 0~36个字符。 - 目的类型。 "any" destContent 否 string 0~128个字符。 - 目的内容。 "192.168.1.1/32"

响应参数 返回状态码为200：修改成功，响应体参考DomainSetResponse。 DomainSetResponse对象的参数列表，详细请参见表4。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考DomainSetResponse。 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：修改成功，响应体参考DomainSetResponse。 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" : "", "success" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "domainNames" : [ "www.test.com" ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "domainNames" : [ "www.test.com" ] } } ] } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考DomainSetResponse。 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/policy/security/domain-set 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 { "domainSetInfo" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "domainNames" : [ "www.test.com" ] } ] }

请求示例 HTTP的示例 PUT /controller/campus/v1/accountservice/usergroups/a91e1696-02a2-4a68-bad4-aa639359c8cf 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" : "family", "description" : "family member group" }

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

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 用户组结构，响应体参考UpdateUsergroupInputDto。 - 表3 UpdateUsergroupInputDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~128个字符。 - 用户组名。 "family" description 否 string 0~256个字符。 - 用户组描述信息。 "family member group"

响应示例 返回状态码为200：添加成功，响应体参考CommonUsergroupOutputDto。 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

请求示例 HTTP的示例 POST /controller/campus/api/v1/lswauth/wired/20ab206c-5f5f-4cb6-9090-05cda5e9727b/batch-delete HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "ids":["64b15bd66c8f44c086994e35b32aac1c"] }

响应示例 返回状态码为200：删除认证模板成功，响应体参考LswAuthConfigDeleteResponse。 HTTPS 200 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "fail": [], "success":["test6666"] } 返回状态码为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：调用查询设备成功，响应体参考QueryDeviceResult。 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", "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 2, "data" : [ { "id" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "name" : "AR1", "esn" : "2102351BTJ0000000666", "deviceModel" : "AR161EW", "deviceType" : "AR", "status" : "0", "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "mac" : "", "ip" : "192.168.0.10", "manageIp" : "192.168.0.10", "neType" : "AR161EW", "version" : "V300R003C00", "vendor" : "HUAWEI", "description" : "HUAWEI", "resourceId" : "HUAWEI", "tenantId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "tenantName" : "XXX@XXX.com", "siteName" : "test1", "createTime" : "2017-12-13 01:37:28", "registerTime" : "2017-12-13 01:37:28", "modifyTime" : "2017-12-13 01:37:28", "startupTime" : "2017-12-13 01:37:28", "tags" : [ "" ], "systemIp" : "192.168.1.1", "patchVersion" : "V200R019SPH", "ztpConfirm" : false, "manageStatus" : "ABNORMAL", "manageStatusDownReason" : ["NEED_ZTP_CONFIRM","DEVICE_HAS_BEEN_ISOLATED"], "role" : ["Gateway"], "performance" : "", "uptime" : "0 天 1 时 10 分" } ] } 返回状态码为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/v4/devices/msp/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 { "tenantIdList" : ["00000000-0000-0000-0000-000000000001"], "keyWord" : "127.0.0.1", "name" : "AA02350", "esn" : "DLR00000", "model" : "P6050", "softwareVersion" : "R020C00", "patchVersion" : "patch001", "manageStatus" : ["NORMAL","DEVICE_ISOLATE"], "sortField" : "name", "status" : ["NORMAL","ALARM"], "roles" : ["Gateway","CORE"], "types" : ["WAC","AP"], "pageIndex" : "4", "pageSize" : "20", "createTimeBegin" : 1616554000, "createTimeEnd" : 1616554000, "registerTimeBegin" : 1616554000, "registerTimeEnd" : 1616554000 }

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/profile/tacacs/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" : [ "fbb684c8-0d37-496f-bafa-4b06db151e2e" ] }

响应示例 返回状态码为200：删除tacacs服务器模板信息返回体数据结构。 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" : [ "fbb684c8-0d37-496f-bafa-4b06db151e2e" ], "fail" : [ { "errcode" : "0x00000000", "errmsg" : "The specified object does not exist", "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2a" } ] }

响应示例 返回状态码为200：删除成功，响应体参考VpnQosGroupInfoResponse。 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" : "00000000-0000-0000-0000-000000000000", "name" : "VPN-Group1", "description" : "**********", "vpnList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN1" } ] } ], "fail" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN-Group1", "description" : "**********", "vpnList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN1" } ] } ], "processInstanceId" : "00000000-0000-0000-0000-000000000000" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考VpnQosGroupInfoResponse。 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 返回状态码为204：执行成功，无响应体。 HTTP/1.1 204 No Content 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