终端组终端管理-华为云

华为乾坤-查询终端组:响应示例

响应示例返回状态码为200：查询成功终端组信息。响应体参考TerminalGroupMgrResult。 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" : 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,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/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-AC CES S-TOKEN: x-yyyyyy { "id" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "name" : "product", "pageIndex" : 1, "pageSize" : 20, "rootGroupId" : "" }

华为乾坤终端组终端管理

华为乾坤-查询终端组:响应参数

响应参数返回状态码为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 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 { "groupName" : "HUAWEI", "parentId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "description" : "product" }

华为乾坤终端组终端管理

华为乾坤-创建终端组:响应示例

响应示例返回状态码为201：创建成功信息。响应体参考TerminalGroupMgrResponseInfo。 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" : { "id" : "", "groupName" : "HUAWEI", "parentId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "description" : "product" } } 返回状态码为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

华为乾坤终端组终端管理

华为乾坤-创建终端组:响应参数

响应参数返回状态码为201：创建成功信息。响应体参考TerminalGroupMgrResponseInfo。表3 TerminalGroupMgrResponseInfo对象的参数列表参数名称类型参数值域默认值参数说明参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表4。 - - 表4 TerminalGroupMgrResponseDto对象的参数列表参数名称类型参数值域默认值参数说明参数示例 id string - - 创建成功的终端组ID。 - groupName string 0~64个字符。 - 终端组名称，1~64个字符，不支持特殊字符。 "HUAWEI" parentId string - - 父终端组ID，可以为空，为空在“自定义”下面，uuid格式。 "22fbb5f2-d07e-4710-94ac-7705517ab842" description string 0~64个字符。 - 终端组描述，不支持特殊字符。 "product" 返回状态码为400：校验异常。详细信息请参见实际响应消息体。

华为乾坤终端组终端管理

华为乾坤-创建终端组:请求参数

请求参数表1 body参数列表参数名称必选类型参数值域默认值参数说明参数示例 createParam 是 REFERENCE 详细请参见表2。待添加的终端组信息。 - 表2 TerminalMgrGroupDto对象的参数列表参数名称必选类型参数值域默认值参数说明参数示例 groupName 是 string 0~64个字符。 - 终端组名称，1~64个字符，不支持特殊字符。 "HUAWEI" parentId 否 string - - 父终端组ID，可以为空，为空在“自定义”下面，uuid格式。 "22fbb5f2-d07e-4710-94ac-7705517ab842" description 否 string 0~64个字符。 - 终端组描述，不支持特殊字符。 "product"

华为乾坤终端组终端管理

华为乾坤-查询终端:响应示例

响应示例返回状态码为200：查询成功的信息。响应体参考TerminalMgrTerminalListDto。 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" : 30, "data" : [ { "id" : "62008e2c-6bf2-48ea-a17c-d278c594d83a", "terminalmac" : "11-11-11-11-11-11", "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "terminalGroupBsId" : "00000-00001", "isBlocked" : true, "isApproved" : 1, "expirationDate" : "2020-02-02", "bindingDeviceMac" : "11-11-11-11-11-11", "bindingDevicePort" : "GigabitEthernet0/0/1", "bindingDeviceName" : "2102351LKB1234567890", "description" : "update", "accessPosition" : "ssid", "status" : "offline", "ecology" : "iConnect/hlink", "createTime" : "1571710215000", "firstLoginTime" : "1571710215000", "loginTime" : "1571710215000", "lastLogoutTime" : "1571710215000", "serialNumber" : "SN10219210", "terminalType" : "normal", "deviceId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "terminalIP" : "192.168.0.1", "syncType" : 1, "selfDefineId" : "22849cf7-c144-4699-929a-9954f227b3e6", "selfDefineName" : "生产区", "deviceTypeId" : "3324", "deviceTypeName" : "手机", "osId" : "17985", "osName" : "Windows 10", "deviceType" : "手机", "vendor" : "华为", "model" : "P40 Pro", "accessSsid" : "FreeWiFi" } ] } 返回状态码为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

华为乾坤终端组终端管理

华为乾坤-查询终端:响应参数

响应参数返回状态码为200：查询成功的信息。响应体参考TerminalMgrTerminalListDto。表3 TerminalMgrTerminalListDto对象的参数列表参数名称类型参数值域默认值参数说明参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex integer - - 位于查询记录第几页。 1 pageSize integer - - 一页里查询记录的数量。 10 totalRecords integer - - 查询记录总条数。 30 data ARRAY_REFERENCE 0-100个列表项，详细请参见表4。终端详细信息列表。 - 表4 TerminalMgrSelectResult对象的参数列表参数名称类型参数值域默认值参数说明参数示例 id string - - 终端id。UUID格式 "62008e2c-6bf2-48ea-a17c-d278c594d83a" terminalmac string - - 终端MAC。 "11-11-11-11-11-11" terminalGroupId string - - 终端组id。UUID格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" terminalGroupBsId string - - 终端组BsId "00000-00001" isBlocked boolean true false - 是否在黑名单。 true isApproved int32 - - 审批状态：0（默认）、1（已审批）、2（待审批）。 1 expirationDate string - - 审批状态过期时间。 "2020-02-02" bindingDeviceMac string - - 终端绑定的设备Mac信息。 "11-11-11-11-11-11" bindingDevicePort string - - 终端绑定的设备端口。 "GigabitEthernet0/0/1" bindingDeviceName string - - 终端绑定的设备名称。 "2102351LKB1234567890" description string - - 对终端的描述。 "update" accessPosition string - - 接入位置。 "ssid" status string initiation online offline - 终端状态：initiation（未上线）、online（在线）、offline（离线） "offline" ecology string - - 生态。 "iConnect/hlink" createTime int64 - - 创建时间。 "1571710215000" firstLoginTime int64 - - 首次登录时间。 "1571710215000" loginTime int64 - - 登录时间。 "1571710215000" lastLogoutTime int64 - - 最后一次离线时间。 "1571710215000" serialNumber string - - 序列号。 "SN10219210" terminalType string normal iConnect - 终端类别：normal-普通传统终端、iConnect-iConnect终端 "normal" deviceId string - - 设备id。UUID格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" terminalIP string - - 终端ip，只支持ipv4地址。 "192.168.0.1" syncType int32 - - 同步类型：0-不同步，1-同步AC-IOT。 1 selfDefineId string 0~36个字符。 - 所属的自定义终端组的id "22849cf7-c144-4699-929a-9954f227b3e6" selfDefineName string 0~64个字符。 - 所属的自定义终端组的名称 "生产区" deviceTypeId string 0~36个字符。 - 所属的设备类型的id "3324" deviceTypeName string 0~64个字符。 - 所属的设备类型的名称 "手机" osId string 0~36个字符。 - 所属的操作系统的id "17985" osName string 0~64个字符。 - 操作系统 "Windows 10" deviceType string 0~64个字符。 - 设备类型 "手机" vendor string 0~64个字符。 - 厂商 "华为" model string 0~64个字符。 - 型号 "P40 Pro" accessSsid string 0~64个字符。 - 终端接入SSID名称 "FreeWiFi" 返回状态码为400：校验异常。详细信息请参见实际响应消息体。

华为乾坤终端组终端管理

华为乾坤-查询终端:请求示例

请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/terminalmgr/endpoint/list 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 { "terminalMac" : "11-11-11-11-11-11", "pageIndex" : 1, "pageSize" : 20, "terminalIP" : "192.168.0.1", "isBlocked" : false, "isApproved" : 0, "isExpired" : false, "deviceIdList" : ["22fbb5f2-d07e-4710-94ac-7705517ab841","22fbb5f2-d07e-4710-94ac-7705517ab842"], "terminalType" : "normal", "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "terminalGroupBsId" : "00000-00001", "status" : "offline", "accessPosition" : "ssid", "loginBeginTime" : 1600401054386, "loginEndTime" : 1600401054386, "syncType" : 1 }

华为乾坤终端组终端管理

华为乾坤-创建终端:响应示例

响应示例返回状态码为201：创建成功信息。响应体参考TerminalMgrTerminalResponse。 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" : "", "successList" : [ { "id" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "mac" : "11-11-11-11-11-11" } ], "failList" : [ { "errcode" : "0x022b0006", "errmsg" : "mac address is already exist", "id" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "mac" : "11-11-11-11-11-11" } ] } 返回状态码为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

华为乾坤终端组终端管理

华为乾坤-创建终端:响应参数

响应参数返回状态码为201：创建成功信息。响应体参考TerminalMgrTerminalResponse。表5 TerminalMgrTerminalResponse对象的参数列表参数名称类型参数值域默认值参数说明参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息 "" successList ARRAY_REFERENCE 0-1000个列表项，详细请参见表6。创建终端成功的列表 - failList ARRAY_REFERENCE 0-1000个列表项，详细请参见表7。创建终端失败的列表 - 表6 TerminalMgrTerminal对象的参数列表参数名称类型参数值域默认值参数说明参数示例 id string - - 终端ID。UUID格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" mac string - - 终端MAC。 "11-11-11-11-11-11" 表7 TerminalMgrFailedTerminal对象的参数列表参数名称类型参数值域默认值参数说明参数示例 errcode string - - 错误码。 "0x022b0006" errmsg string - - 错误信息 "mac address is already exist" id string - - 终端ID。UUID格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" mac string - - 终端MAC。 "11-11-11-11-11-11" 返回状态码为400：校验异常。详细信息请参见实际响应消息体。

华为乾坤终端组终端管理

华为乾坤-创建终端:请求示例

请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/terminalmgr/endpoint 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 { "terminalContents" : [ { "terminalMac" : "11-11-11-11-11-11", "serialNumber" : "SN10219210", "terminalIP" : "192.168.0.1", "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "isBlocked" : false, "isApproved" : 1, "expirationDate" : 60, "bindingDeviceMac" : "11-11-11-11-11-11", "bindingDevicePort" : "GigabitEthernet0/0/1", "source" : 6, "description" : "Huawei phone", "deviceType" : "打印机", "deviceVendor" : "HP", "deviceModel" : "HP-5720", "osVendor" : "Microsoft", "osType" : "Windows", "osVersion" : "18362.1082", "customFields" : [ { "name" : "资产编号", "value" : "HW-00001" } ], "syncType" : 1, "forceOverride" : false } ] }

华为乾坤终端组终端管理

华为乾坤-创建终端:请求参数

请求参数表1 body参数列表参数名称必选类型参数值域默认值参数说明参数示例 createParam 是 REFERENCE 详细请参见表2。待创建的终端信息。 - 表2 TerminalMgrTerminalContent对象的参数列表参数名称必选类型参数值域默认值参数说明参数示例 terminalContents 否 ARRAY_REFERENCE 1-1000个列表项，详细请参见表3。待添加的终端信息列表。 - 表3 TerminalMgrTerminalDto对象的参数列表参数名称必选类型参数值域默认值参数说明参数示例 terminalMac 是 string 0~64个字符。 - 终端Mac，MAC的格式支持xx-xx-xx-xx-xx-xx、xx:xx:xx:xx:xx:xx。 "11-11-11-11-11-11" serialNumber 否 string - - 序列号。 "SN10219210" terminalIP 否 string - - 终端ip，只支持IPv4地址。 "192.168.0.1" terminalGroupId 否 string 32~36个字符。 - 自定义终端组ID。UUID格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" isBlocked 否 boolean true false false 是否加入黑名单，处于黑名单的终端无法认证。 false isApproved 否 integer - 0 审批状态。取值范围：0（默认）、1（已审批）、2（待审批）。 1 expirationDate 否 int32 [0-1440] - 审批状态过期时间，单位：分钟，只有当isApproved为“1”可配置。 60 bindingDeviceMac 否 string 17个字符。 - 绑定设备的MAC，MAC的格式支持xx-xx-xx-xx-xx-xx、xx:xx:xx:xx:xx:xx。 "11-11-11-11-11-11" bindingDevicePort 否 string - - 终端绑定设备端口。 "GigabitEthernet0/0/1" source 否 integer - - 终端来源，三方系统添加的终端来源为固定值 6。 6 description 否 string 0~64个字符。 - 对终端的描述，1~64，不能包含特殊字符。 "Huawei phone" deviceType 否 string 0~64个字符。 - 设备大类，仅允许中英文及_-@ .* "打印机" deviceVendor 否 string 0~64个字符。 - 设备厂商，仅允许中英文及_-@ .*,只有传入deviceType才生效 "HP" deviceModel 否 string 0~64个字符。 - 设备型号，仅允许中英文及_-@ .*,只有传入deviceType,deviceVendor才生效 "HP-5720" osVendor 否 string 0~64个字符。 - 操作系统厂商，仅允许中英文及_-@ .* "Microsoft" osType 否 string 0~64个字符。 - 操作系统类型，仅允许中英文及_-@ .*,只有传入osVendor才生效 "Windows" osVersion 否 string 0~64个字符。 - 操作系统版本，仅允许中英文及_-@ .*,只有传入osVendor,osType才生效 "18362.1082" customFields 否 ARRAY_REFERENCE 0-32个列表项，详细请参见表4。自定义字段 - syncType 否 int32 - - 同步类型：0-不同步，1-同步AC-IOT。 1 forceOverride 否 boolean true false false 强制覆盖相同MAC的终端 false 表4 CustomField对象的参数列表参数名称必选类型参数值域默认值参数说明参数示例 name 是 string 1~64个字符。 - 自定义字段名称，仅允许中英文及_-@ .*。控制器只做数据呈现，敏感信息请自行处理。 "资产编号" value 是 string 1~64个字符。 - 自定义字段值，仅允许中英文及_-@ .*。控制器只做数据呈现，敏感信息请自行处理。 "HW-00001"

华为乾坤终端组终端管理

云服务器内容精选

终端组终端管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线