-
请求示例 HTTP的示例 PUT /controller/campus/v1/accountservice/terminalmgr/endpoint/batch-update-terminal 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
{
"terminalList" : [
{
"mac" : "11-11-11-11-11-11",
"status" : "offline",
"terminalIp" : "192.168.0.1",
"firstLoginTime" : "1571710215000",
"loginTime" : "1571710215000",
"lastLogoutTime" : "1571710215000"
}
]
}
-
响应示例 返回状态码为200:修改成功信息。响应体参考TerminalMgrUpdateResponseInfo。 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" : ["11-11-11-11-11-11"],
"failed" : [
{
"errcode" : "0308001017",
"errmsg" : "The teminalId is not exist",
"data" : "11-11-11-11-11-11"
}
]
} 返回状态码为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
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 modifyParam 是 REFERENCE 详细请参见表2。 待修改的终端信息。 - 表2 TerminalUpdateInputDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 terminalList 否 ARRAY_REFERENCE 1-1000个列表项,详细请参见表3。 自定义字段 - 表3 TerminalUpdateDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mac 是 string 0~64个字符。 - 终端MAC "11-11-11-11-11-11" status 否 string - - 终端状态(只允许同步给AC-IoT系统的终端进行修改):initiation(未上线)、online(在线)、offline(离线) "offline" terminalIp 否 string 0~36个字符。 - 终端Ip(只允许同步给AC-IoT系统的终端进行修改)。 "192.168.0.1" firstLoginTime 否 int64 - - 首次登录时间(只允许同步给AC-IoT系统的终端进行修改)。 "1571710215000" loginTime 否 int64 - - 登录时间(只允许同步给AC-IoT系统的终端进行修改)。 "1571710215000" lastLogoutTime 否 int64 - - 最后一次离线时间(只允许同步给AC-IoT系统的终端进行修改)。 "1571710215000"
-
响应示例 返回状态码为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" : "",
"groupName" : "HUAWEI",
"parentId" : "22fbb5f2-d07e-4710-94ac-7705517ab842",
"description" : "product"
}
} 返回状态码为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/v1/accountservice/terminalmgr/endpointgroup/22fbb5f2-d07e-4710-94ac-7705517ab842 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",
"description" : "product"
}
-
请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 modifyParam 是 REFERENCE 详细请参见表3。 待修改的终端组详细信息。响应体参考TerminalGroupUpdateDto。 - 表3 TerminalGroupUpdateDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 groupName 是 string 0~64个字符。 - 终端组名称,1~64个字符,不支持特殊字符。 "HUAWEI" description 否 string 0~64个字符。 - 终端组描述,不支持特殊字符。 "product"
-
响应参数 返回状态码为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:校验异常。 详细信息请参见实际响应消息体。
-
请求示例 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,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" : "",
"groupName" : "HUAWEI",
"parentId" : "22fbb5f2-d07e-4710-94ac-7705517ab842",
"description" : "product"
}
} 返回状态码为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
-
请求参数 表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"
-
响应示例 返回状态码为201:创建成功信息。响应体参考TerminalMgrTerminalResponse。 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" : "",
"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,11 May 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"
-
请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/terminalmgr/endpoint/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
{
"deleteIds" : ["22fbb5f2-d07e-4710-94ac-7705517ab842"]
}