ThingsKit物联网平台API文档-监控运维(设备上下线)

修改设备状态日志信息

接口地址:/api/yt/device/state/log

请求方式:POST

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "deviceName": "",
  "deviceProfileName": "",
  "deviceType": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "name": "",
  "organizationName": "",
  "remark": "",
  "roleIds": [],
  "status": 0,
  "tbDeviceId": "",
  "tenantExpireTime": "",
  "tenantId": "",
  "tenantProfileId": "",
  "tenantStatus": "",
  "updateTime": "",
  "updater": ""
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
tkDeviceStateLogDTOTkDeviceStateLogDTObodytrueTkDeviceStateLogDTO

响应参数:

参数名称参数说明类型
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
deviceName设备名称string
deviceProfileName设备配置名称string
deviceType设备类型,可用值:DIRECT_CONNECTION,GATEWAY,SENSORstring
enabled租户状态:启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
organizationName组织名称string
remark备注string
roleIds租户角色列表array
status设备状态:0离线 1在线integer(int32)
tbDeviceId设备IDstring
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"deviceName": "",
	"deviceProfileName": "",
	"deviceType": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"organizationName": "",
	"remark": "",
	"roleIds": [],
	"status": 0,
	"tbDeviceId": "",
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}

删除设备状态日志信息

接口地址:/api/yt/device/state/log

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded,application/json

响应数据类型:*/*

请求示例:

{
  "ids": [],
  "tenantId": ""
}

请求参数:

参数名称参数说明请求类型是否必须数据类型
deleteDTODeleteDTObodytrueDeleteDTO
ids删除ID列表truearray

响应参数:

参数名称参数说明类型
errorCodePlatform error code:\n2 – General error (HTTP: 500 – Internal Server Error)\n\n10 – Authentication failed (HTTP: 401 – Unauthorized)\n\n11 – JWT token expired (HTTP: 401 – Unauthorized)\n\n15 – Credentials expired (HTTP: 401 – Unauthorized)\n\n20 – Permission denied (HTTP: 403 – Forbidden)\n\n30 – Invalid arguments (HTTP: 400 – Bad Request)\n\n31 – Bad request params (HTTP: 400 – Bad Request)\n\n32 – Item not found (HTTP: 404 – Not Found)\n\n33 – Too many requests (HTTP: 429 – Too Many Requests)\n\n34 – Too many updates (Too many updates over Websocket session)\n\n* 40 – Subscription violation (HTTP: 403 – Forbidden)object
messageError messagestring
statusHTTP Response Status Codeinteger(int32)
timestampTimestampstring(date-time)

响应示例:

{}

设备状态日志信息详情

接口地址:/api/yt/device/state/log/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
ididpathtruestring

响应参数:

参数名称参数说明类型
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
deviceName设备名称string
deviceProfileName设备配置名称string
deviceType设备类型,可用值:DIRECT_CONNECTION,GATEWAY,SENSORstring
enabled租户状态:启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
organizationName组织名称string
remark备注string
roleIds租户角色列表array
status设备状态:0离线 1在线integer(int32)
tbDeviceId设备IDstring
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

{
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"deviceName": "",
	"deviceProfileName": "",
	"deviceType": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"organizationName": "",
	"remark": "",
	"roleIds": [],
	"status": 0,
	"tbDeviceId": "",
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}

查询

接口地址:/api/yt/device/state/log{?deviceName,deviceProfileName,endTime,orderFiled,orderType,organizationName,page,pageSize,startTime,status}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明是否必须数据类型
pagepagetrueint
pageSizepageSizetrueint

响应参数:

参数名称参数说明类型
itemsarray
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
deviceName设备名称string
deviceProfileName设备配置名称string
deviceType设备类型,可用值:DIRECT_CONNECTION,GATEWAY,SENSORstring
enabled租户状态:启用/禁用boolean
icon租户图标string
idIDstring
name租户名称string
organizationName组织名称string
remark备注string
roleIds租户角色列表array
status设备状态:0离线 1在线integer(int32)
tbDeviceId设备IDstring
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string
totalinteger(int32)

响应示例:

{
	"items": [
		{
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"deviceName": "",
			"deviceProfileName": "",
			"deviceType": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"organizationName": "",
			"remark": "",
			"roleIds": [],
			"status": 0,
			"tbDeviceId": "",
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}