华为云用户手册

响应参数 返回状态码为200：接口调用成功，响应体参考CommonOut。 表3 CommonOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为400：接口入参非法的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考CommonOut。 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：成功更新的逃生模板信息。 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" : { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "ESCAPETemplate1", "vlanId" : 1, "description" : "ESCAPETemplate1", "securityGroupId" : "4f350825-919c-47b7-b853-f51f15912396", "ipv4RuleList" : [ { "protocol" : "tcp", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "description" : "Rule1" } ], "ipv6RuleList" : [{"protocol":"tcp","dstIp":"FC00::01/7","dstPort":"24","description":"Rule1"}] } } 返回状态码为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

请求示例 HTTP的示例 PUT /controller/campus/v3/profile/escape/fbde1c5d-5b94-49e3-a912-48641015e45c 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 { "name" : "ESCAPETemplate1", "vlanId" : 1, "description" : "ESCAPETemplate1", "securityGroupId" : "4f350825-919c-47b7-b853-f51f15912396", "ipv4RuleList" : [ { "protocol" : "tcp", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "description" : "Rule1" } ], "ipv6RuleList" : [{"protocol":"tcp","dstIp":"FC00::01/7","dstPort":"24","description":"Rule1"}] }

响应示例 返回状态码为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" : "", "data" : { "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 10, "deviceFwStaticRoutePolicys" : [ { "mask" : 22, "destinationPrefixIp" : "10.20.0.0", "nextHopAddress" : "10.20.0.10", "nextInterface" : "GigabitEthernet0/0/4", "trackIplinkId" : "ae5813f8ff1e41f5ba9c324da70b49ca", "preference" : 5, "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } ] } } 返回状态码为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：查询的防火墙设备静态路由配置。 表3 GetFwStaticRouteResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表4。 - - 表4 FwStaticRouteInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex integer [1-65535] - 页面索引。 1 pageSize integer [1-1000] - 每页显示记录数。 20 totalRecords integer [1-65535] - 总记录数。 10 deviceFwStaticRoutePolicys ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 防火墙设备静态路由配置信息。 - 返回状态码为400：校验失败信息。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/fwstaticroute/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/staticroute?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

URI /controller/campus/v1/networkservice/networkconfig/net/fwstaticroute/devices/{deviceId}/staticroute 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备标识，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 integer [1-65535] - 页面索引。 1 pageSize 是 integer [1-1000] - 每页显示记录数。 20

响应示例 返回状态码为200：AP接口配置结果，结构体参见CloudInterfaceConfigResponsesDto。 { "errcode": "0", "errmsg": "", "data": [ { "name": "MultiGE0/0/0", "interfaceStatus": true, "description": "111", "lldpStatus": false, "sence": "accessStrict", "defaultVlanId": 1, "bindingCheck": false, "macMaxNumber": null, "trunkVlan": null, "upLimit": "null", "transmitMode": "bridge", "aclId": null }, { "name": "GigabitEthernet0/0/0", "interfaceStatus": true, "description": null, "lldpStatus": true, "sence": "uppoint", "defaultVlanId": 1, "bindingCheck": null, "macMaxNumber": null, "trunkVlan": "2", "upLimit": "null", "transmitMode": null, "aclId": null } ] } 返回状态码为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

请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/cloudapinterface/fbde1c5d-5b94-49e3-a912-48641015e45c 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：AP接口配置结果，结构体参见CloudInterfaceConfigResponsesDto。 表2 CloudInterfaceConfigResponsesDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-65535个列表项，详细请参见表3。 接口配置信息，结构体参见CloudApInterfaceConfig。 - 表3 CloudApInterfaceConfig对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 0~256个字符。 - 接口名称。 "GigabitEthernet0/0/1" interfaceStatus boolean true false - 接口管理状态。 true description string 0~256个字符。 - 描述。 "描述信息" lldpStatus boolean true false - LLDP开关。 true sence string 0~256个字符。 - 场景。取值root(WAN)、uppoint(上行直连交换机)、endpoint(下行直连交换机)、accessStrict(下行直连PC) "endpoint" defaultVlanId int32 [0-65535] - 缺省VLAN。 "1" bindingCheck boolean true false - 是否启用该网口的动态ARP检测功能、IP报文检查功能和DHCP Snooping功能。 true macMaxNumber int32 [0-65535] - 最大MAC数。 1 trunkVlan string 0~256个字符。 - 允许通过的VLAN。范围：1~4094,如:1,1-5,最多支持10段,每个设备最多可配置64个VLAN。 "1" upLimit string 0~256个字符。 - 终端上行限速(Mbit/s)，取值范围 0.1~10000Mbps。 "1" transmitMode string 0~256个字符。 - 转发模式，取值nat，bridge。 "nat" aclId string 36个字符。 - acl Id。通过接口获取。在接口层面基于目的IP地址、协议和端口控制允许或禁止访问指定资源。 "fbde1c5d-5b94-49e3-a912-48641015e45c" macLimit boolean true false - mac配置使能。 true upLimitEnable boolean true false - 终端流量上行限速使能。 true tcpAdjustMss int32 [128-2048] - TCP Adjust MSS。 128 userSeparation boolean true false - 是否用户隔离。当userSeparation为true时，开启二三层用户隔离。 false separationOption string 0~256个字符。 - 用户隔离状态。取值范围：all---开启二三层隔离，l2---开启二层隔离，disable---不隔离。当userSeparation为true时，separationOption只允许为all 或 l2，默认为all；当userSeparation为false时，separationOption只允许为disable。V200R022C10版本以及之后的设备版本，separationOption生效。 "disable" insertOption82Enable boolean true false false 是否插入Option82选项。默认值为false。 false option82 REFERENCE 详细请参见表4。 当insertOption82Enable为true时，该字段必填；为false时，该字段不生效，结构体参见Option82Dto。 - ndSnoopingTrustEnable boolean true false false 启用或禁用nd信任接口。 false 表4 Option82Dto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 circuitId REFERENCE 详细请参见表5。 链路代理ID，结构体参见OptionParamDto。 - remoteId REFERENCE 详细请参见表5。 远程代理ID，结构体参见OptionParamDto。 - 表5 OptionParamDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 connectorPattern string colon semicolon colon 选项不同类型内容间的连接符。可取值为：colon、semicolon。默认值为colon。 "colon" contentType string ap-mac ap-mac-ifname ap-location ap-location-ifname ap-name ap-name-ifname user-defined ap-mac 选项内容类型。可取值为：ap-mac、ap-mac-ifname、ap-location、ap-location-ifname、ap-name、ap-name-ifname、user-defined。默认值为ap-mac。 "ap-mac" format string ascii normal compact hex colon ascii 选项内容格式。可取值为：ascii、normal、compact、hex、colon。当contentType为ap-mac时，所有选项均可选择；当contentType为ap-mac-ifname，hex不可选择。默认值为ascii。 "ascii" userDefinedText string 0~255个字符。 - 自定义内容，当contentType为user-defined时，此字段为必填字段。 "xxx" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bd:bd 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-bd:bd" : { "bd-id" : 10, "vni" : 10, "vlan-id" : 10, "split-horizon" : "disable" } }

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bd:bd 是 REFERENCE 详细请参见表4。 Bridge Domain配置参数。 - 表4 nes-ne-bd-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bd:bd 否 REFERENCE 详细请参见表5。 Bridge Domain配置参数。 - 表5 bd-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bd-id 否 int64 [1-16777215] - Bridge Domain ID，单一主键字段。 10 vni 否 int64 [1-16777215] - VNI ID。 10 vlan-id 否 int32 [1-4094] - VLAN ID，不支持AR6700V-L款型。 10 split-horizon 否 string enable disable - 成员隔离，不支持AR6700V子设备和AR6700V-L款型。 "disable"

响应示例 返回状态码为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

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bd:bd 表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：删除OSPF进程返回参数。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreDeleteProcess" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN" } ], "gatewayDeleteProcess" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN" } ] }, "fail" : { "coreOspfProcessList" : { "errcode" : "0", "errmsg" : "", "deleteProcess" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN" } ], "deleteFailProcess" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN", "errcode" : "0", "errmsg" : "" } ] }, "gatewayOspfProcessList" : { "errcode" : "0", "errmsg" : "", "deleteProcess" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN" } ], "deleteFailProcess" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN", "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/v1/lanwan/interconnection/route/ospf/process/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 { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreDeleteProcess" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN" } ], "gatewayDeleteProcess" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN" } ] }

响应参数 返回状态码为200：删除OSPF进程返回参数。 表4 DeleteOspfProcessResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success REFERENCE 详细请参见表5。 更新成功互联OSPF进程响应信息。 - fail REFERENCE 详细请参见表6。 更新失败互联OSPF进程响应信息。 - 表5 DeleteProcessInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vnId string 36个字符。 - VN标识, 必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" siteId string 36个字符。 - 设备标识，必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" coreDeleteProcess ARRAY_REFERENCE 0-8个列表项，详细请参见表5。 核心删除进程信息。 - gatewayDeleteProcess ARRAY_REFERENCE 0-8个列表项，详细请参见表5。 网关删除进程信息。 - 表6 DeleteFailProcessInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 coreOspfProcessList REFERENCE 详细请参见表7。 删除失败的互联OSPF信息列表。 - gatewayOspfProcessList REFERENCE 详细请参见表7。 删除失败的互联OSPF信息列表。 - 表7 DeleteFailProcessInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" deleteProcess ARRAY_REFERENCE 0-8个列表项，详细请参见表5。 删除失败的OSPF进程信息。兼容字段，后续废弃 - deleteFailProcess ARRAY_REFERENCE 0-8个列表项，详细请参见表8。 删除失败的OSPF进程信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ospfProcessInfo 是 REFERENCE 详细请参见表2。 删除的LANWAN互联OSPF进程。 - 表2 DeleteProcessInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnId 否 string 36个字符。 - VN标识, 必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" siteId 否 string 36个字符。 - 设备标识，必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" coreDeleteProcess 否 ARRAY_REFERENCE 0-8个列表项，详细请参见表3。 核心删除进程信息。 - gatewayDeleteProcess 否 ARRAY_REFERENCE 0-8个列表项，详细请参见表3。 网关删除进程信息。 - 表3 OspfBaseInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 string 0~64个字符。 - 设备标识。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceName 否 string 0~64个字符。 - 设备名称，无需填充，查询返回。 "device" processId 否 int32 [1-20000] - OSPF进程号。 10 configSource 否 string 0~32个字符。 - 配置源 "LANWAN"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nat-policy:nat-policy-rules 表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：操作成功。 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

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-policy:nat-policy-rules 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-nat-policy:nat-policy-rules" : { "name" : "rules@name", "action" : { "source-nat" : { "address-group-name" : "addressgroupname" } }, "source-zone" : [ "sourcezone" ], "destination-zone" : [ "destinationzonename" ], "egress-interface" : [ "egressinterfacename" ], "source-nat" : { "address-group-name" : "addressgroupname", "easy-ip" : "True" }, "source-address" : { "address-ipv4s" : { "address-ipv4" : [ { "ipv4" : "10.1.1.1", "mask" : "255.255.0.0" } ] }, "address-ipv4-ranges" : { "address-ipv4-range" : [ { "start-ipv4" : "10.1.1.1", "end-ipv4" : "10.1.1.1" } ] } }, "destination-address" : { "address-ipv4s" : { "address-ipv4" : [ { "ipv4" : "10.1.1.1", "mask" : "255.255.0.0" } ] }, "address-ipv4-ranges" : { "address-ipv4-range" : [ { "start-ipv4" : "10.1.1.1", "end-ipv4" : "10.1.1.1" } ] } }, "service" : { "service-items" : { "protocol-and-ports" : { "protocol-and-port" : [ { "protocol" : "tcp", "source-port" : "65501", "dest-port" : "65502" } ] }, "protocol" : { "protocol-id" : [ 199 ] } } } } }

响应示例 返回状态码为200：查询成功终端组信息。响应体参考TerminalGroupMgrResult。 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" : "", "pageIndex" : 1, "pageSize" : 20, "totalNum" : 10000, "data" : [ { "id" : "59946d2b-8207-4ab4-8c1e-88c7df343668", "groupName" : "HUAWEI", "isModify" : true, "bsid" : "00000-00001", "level" : 5, "parentId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "fullpath" : "22fbb5f2-d07e-4710-94ac-7705517ab842/59946d2b-8207-4ab4-8c1e-88c7df343668", "description" : "identify" } ] } 返回状态码为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：查询成功终端组信息。响应体参考TerminalGroupMgrResult。 表3 TerminalGroupMgrResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 - - 页码。 1 pageSize int32 - - 每页数量。 20 totalNum int64 - - 终端总数。 10000 data ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 查询终端的详细信息。 - 表4 TerminalGroupMgrDetail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 终端组ID。UUID格式 "59946d2b-8207-4ab4-8c1e-88c7df343668" groupName string - - 终端组名称。 "HUAWEI" isModify boolean true false - 是否可以修改。 true bsid string - - 终端组bsid。 "00000-00001" level integer - - 终端组层级。 5 parentId string - - 终端组父节点id UUID格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" fullpath string - - 节点全量路径 "22fbb5f2-d07e-4710-94ac-7705517ab842/59946d2b-8207-4ab4-8c1e-88c7df343668" description string - - 终端组的描述。 "identify" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryTerminalParam 是 REFERENCE 详细请参见表2。 待查询的终端组信息。 - 表2 TerminalGroupQueryDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 string - - 终端组ID UUID格式，可为空。 "22fbb5f2-d07e-4710-94ac-7705517ab842" name 否 string - - 终端组名称，支持模糊查询。 "product" pageIndex 否 int32 [1-1000] - 查询的页码。 1 pageSize 否 int32 [1-100] - 每页查询终端的数量。 20 rootGroupId 否 string 0~36个字符。 - 父终端组ID UUID格式，需要根据实际填写，也可为空。 ""

请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/terminalmgr/endpointgroup/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 { "id" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "name" : "product", "pageIndex" : 1, "pageSize" : 20, "rootGroupId" : "" }

URI /controller/campus/v1/sdwan/aaa/authorization 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-1000] - 起始页。 1 pageSize 否 int32 [0-100] - 页行记录数。 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" authorizationSchema 否 string - - 设备授权方案名称。 "name"

响应示例 返回状态码为200：查询成功，响应体参考QueryDeviceAuthorResponse。 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" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authorizationSchema" : "name", "privilegeLevel" : 10, "authorizationModel" : { "primaryModel" : "hwtacacs", "backupModel" : "local" }, "deviceAuthorId" : "00000000-0000-0000-0000-000000000000" } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100 } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/aaa/authorization?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&authorizationSchema=name 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：查询成功，响应体参考QueryDeviceAuthorResponse。 表2 QueryDeviceAuthorResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 - - pageIndex int32 [1-10000] - 当前页，从1开始。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。