3 Star 6 Fork 2

ThingsKit / ThingsKit物联网平台文档

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
index.md 16.49 KB
一键复制 编辑 原始数据 按行查看 历史
TrueVoid 提交于 2023-01-18 20:20 . docs: release1.0.1

异常日志列表

接口地址:/api/yt/log/exception{?actionType,endTime,orderFiled,orderType,page,pageSize,startTime}

请求方式:GET

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

响应数据类型:*/*

请求参数

参数名称 参数说明 是否必须 数据类型
page page true int
pageSize pageSize true int

响应参数:

参数名称 参数说明 类型
items array
  actionData 操作数据 JsonNode
  actionFailureDetails 失败信息 string
  actionStatus 操作状态,可用值:FAILURE,SUCCESS string
  actionType 操作类型,可用值:ACTIVATED,ADDED,ALARM_ACK,ALARM_CLEAR,ALARM_DELETE,ASSIGNED_FROM_TENANT,ASSIGNED_TO_CUSTOMER,ASSIGNED_TO_EDGE,ASSIGNED_TO_TENANT,ATTRIBUTES_DELETED,ATTRIBUTES_READ,ATTRIBUTES_UPDATED,CREDENTIALS_READ,CREDENTIALS_UPDATED,DELETED,LOCKOUT,LOGIN,LOGOUT,LOG_EXCEPTION,PROVISION_FAILURE,PROVISION_SUCCESS,RELATIONS_DELETED,RELATION_ADD_OR_UPDATE,RELATION_DELETED,RPC_CALL,SUSPENDED,TIMESERIES_DELETED,TIMESERIES_UPDATED,UNASSIGNED_FROM_CUSTOMER,UNASSIGNED_FROM_EDGE,UPDATED string
  createTime 创建时间 string(date-time)
  createdTime 操作时间 integer(int64)
  creator 创建用户 string
  customerId string(uuid)
  customerName 客户名称 string
  entityId string(uuid)
  entityName 资源名称 string
  entityType 资源类型,可用值:ALARM,API_USAGE_STATE,ASSET,CUSTOMER,DASHBOARD,DEVICE,DEVICE_PROFILE,EDGE,ENTITY_VIEW,OTA_PACKAGE,RPC,RULE_CHAIN,RULE_NODE,RUNNING_EXCEPTION,SCENE_ACT,TB_RESOURCE,TENANT,TENANT_PROFILE,USER,WIDGETS_BUNDLE,WIDGET_TYPE string
  id ID string
  tenantId string(uuid)
  tenantName 租户名称 string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
  userId string(uuid)
  userName 操作人员 string
total integer(int32)

响应示例:

{
	"items": [
		{
			"actionData": {},
			"actionFailureDetails": "",
			"actionStatus": "",
			"actionType": "",
			"createTime": "",
			"createdTime": 0,
			"creator": "",
			"customerId": "",
			"customerName": "",
			"entityId": "",
			"entityName": "",
			"entityType": "",
			"id": "",
			"tenantId": "",
			"tenantName": "",
			"updateTime": "",
			"updater": "",
			"userId": "",
			"userName": ""
		}
	],
	"total": 0
}

操作日志列表

接口地址:/api/yt/log/operate{?actionType,endTime,entityType,orderFiled,orderType,page,pageSize,startTime}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称 参数说明 是否必须 数据类型
page page true int
pageSize pageSize true int

响应参数:

参数名称 参数说明 类型
items array
  actionData 操作数据 JsonNode
  actionFailureDetails 失败信息 string
  actionStatus 操作状态,可用值:FAILURE,SUCCESS string
  actionType 操作类型,可用值:ACTIVATED,ADDED,ALARM_ACK,ALARM_CLEAR,ALARM_DELETE,ASSIGNED_FROM_TENANT,ASSIGNED_TO_CUSTOMER,ASSIGNED_TO_EDGE,ASSIGNED_TO_TENANT,ATTRIBUTES_DELETED,ATTRIBUTES_READ,ATTRIBUTES_UPDATED,CREDENTIALS_READ,CREDENTIALS_UPDATED,DELETED,LOCKOUT,LOGIN,LOGOUT,LOG_EXCEPTION,PROVISION_FAILURE,PROVISION_SUCCESS,RELATIONS_DELETED,RELATION_ADD_OR_UPDATE,RELATION_DELETED,RPC_CALL,SUSPENDED,TIMESERIES_DELETED,TIMESERIES_UPDATED,UNASSIGNED_FROM_CUSTOMER,UNASSIGNED_FROM_EDGE,UPDATED string
  createTime 创建时间 string(date-time)
  createdTime 操作时间 integer(int64)
  creator 创建用户 string
  customerId string(uuid)
  customerName 客户名称 string
  entityId string(uuid)
  entityName 资源名称 string
  entityType 资源类型,可用值:ALARM,API_USAGE_STATE,ASSET,CUSTOMER,DASHBOARD,DEVICE,DEVICE_PROFILE,EDGE,ENTITY_VIEW,OTA_PACKAGE,RPC,RULE_CHAIN,RULE_NODE,RUNNING_EXCEPTION,SCENE_ACT,TB_RESOURCE,TENANT,TENANT_PROFILE,USER,WIDGETS_BUNDLE,WIDGET_TYPE string
  id ID string
  tenantId string(uuid)
  tenantName 租户名称 string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
  userId string(uuid)
  userName 操作人员 string
total integer(int32)

响应示例:

{
	"items": [
		{
			"actionData": {},
			"actionFailureDetails": "",
			"actionStatus": "",
			"actionType": "",
			"createTime": "",
			"createdTime": 0,
			"creator": "",
			"customerId": "",
			"customerName": "",
			"entityId": "",
			"entityName": "",
			"entityType": "",
			"id": "",
			"tenantId": "",
			"tenantName": "",
			"updateTime": "",
			"updater": "",
			"userId": "",
			"userName": ""
		}
	],
	"total": 0
}

登录登出列表

接口地址:/api/yt/log/user{?actionType,endTime,orderFiled,orderType,page,pageSize,startTime}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称 参数说明 是否必须 数据类型
page page true int
pageSize pageSize true int

响应参数:

参数名称 参数说明 类型
items array
  actionData 操作数据 JsonNode
  actionFailureDetails 失败信息 string
  actionStatus 操作状态,可用值:FAILURE,SUCCESS string
  actionType 操作类型,可用值:ACTIVATED,ADDED,ALARM_ACK,ALARM_CLEAR,ALARM_DELETE,ASSIGNED_FROM_TENANT,ASSIGNED_TO_CUSTOMER,ASSIGNED_TO_EDGE,ASSIGNED_TO_TENANT,ATTRIBUTES_DELETED,ATTRIBUTES_READ,ATTRIBUTES_UPDATED,CREDENTIALS_READ,CREDENTIALS_UPDATED,DELETED,LOCKOUT,LOGIN,LOGOUT,LOG_EXCEPTION,PROVISION_FAILURE,PROVISION_SUCCESS,RELATIONS_DELETED,RELATION_ADD_OR_UPDATE,RELATION_DELETED,RPC_CALL,SUSPENDED,TIMESERIES_DELETED,TIMESERIES_UPDATED,UNASSIGNED_FROM_CUSTOMER,UNASSIGNED_FROM_EDGE,UPDATED string
  createTime 创建时间 string(date-time)
  createdTime 操作时间 integer(int64)
  creator 创建用户 string
  customerId string(uuid)
  customerName 客户名称 string
  entityId string(uuid)
  entityName 资源名称 string
  entityType 资源类型,可用值:ALARM,API_USAGE_STATE,ASSET,CUSTOMER,DASHBOARD,DEVICE,DEVICE_PROFILE,EDGE,ENTITY_VIEW,OTA_PACKAGE,RPC,RULE_CHAIN,RULE_NODE,RUNNING_EXCEPTION,SCENE_ACT,TB_RESOURCE,TENANT,TENANT_PROFILE,USER,WIDGETS_BUNDLE,WIDGET_TYPE string
  id ID string
  tenantId string(uuid)
  tenantName 租户名称 string
  updateTime 更新时间 string(date-time)
  updater 更新用户 string
  userId string(uuid)
  userName 操作人员 string
total integer(int32)

响应示例:

{
	"items": [
		{
			"actionData": {},
			"actionFailureDetails": "",
			"actionStatus": "",
			"actionType": "",
			"createTime": "",
			"createdTime": 0,
			"creator": "",
			"customerId": "",
			"customerName": "",
			"entityId": "",
			"entityName": "",
			"entityType": "",
			"id": "",
			"tenantId": "",
			"tenantName": "",
			"updateTime": "",
			"updater": "",
			"userId": "",
			"userName": ""
		}
	],
	"total": 0
}

详情

接口地址:/api/yt/log/{entityId}

请求方式:GET

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

响应数据类型:*/*

参数名称 参数说明 请求类型 是否必须 数据类型
entityId entityId path true string

响应参数:

参数名称 参数说明 类型
actionData 操作数据 JsonNode
actionFailureDetails 失败信息 string
actionStatus 操作状态,可用值:FAILURE,SUCCESS string
actionType 操作类型,可用值:ACTIVATED,ADDED,ALARM_ACK,ALARM_CLEAR,ALARM_DELETE,ASSIGNED_FROM_TENANT,ASSIGNED_TO_CUSTOMER,ASSIGNED_TO_EDGE,ASSIGNED_TO_TENANT,ATTRIBUTES_DELETED,ATTRIBUTES_READ,ATTRIBUTES_UPDATED,CREDENTIALS_READ,CREDENTIALS_UPDATED,DELETED,LOCKOUT,LOGIN,LOGOUT,LOG_EXCEPTION,PROVISION_FAILURE,PROVISION_SUCCESS,RELATIONS_DELETED,RELATION_ADD_OR_UPDATE,RELATION_DELETED,RPC_CALL,SUSPENDED,TIMESERIES_DELETED,TIMESERIES_UPDATED,UNASSIGNED_FROM_CUSTOMER,UNASSIGNED_FROM_EDGE,UPDATED string
createTime 创建时间 string(date-time)
createdTime 操作时间 integer(int64)
creator 创建用户 string
customerId string(uuid)
customerName 客户名称 string
entityId string(uuid)
entityName 资源名称 string
entityType 资源类型,可用值:ALARM,API_USAGE_STATE,ASSET,CUSTOMER,DASHBOARD,DEVICE,DEVICE_PROFILE,EDGE,ENTITY_VIEW,OTA_PACKAGE,RPC,RULE_CHAIN,RULE_NODE,RUNNING_EXCEPTION,SCENE_ACT,TB_RESOURCE,TENANT,TENANT_PROFILE,USER,WIDGETS_BUNDLE,WIDGET_TYPE string
id ID string
tenantId string(uuid)
tenantName 租户名称 string
updateTime 更新时间 string(date-time)
updater 更新用户 string
userId string(uuid)
userName 操作人员 string

响应示例:

{
	"actionData": {},
	"actionFailureDetails": "",
	"actionStatus": "",
	"actionType": "",
	"createTime": "",
	"createdTime": 0,
	"creator": "",
	"customerId": "",
	"customerName": "",
	"entityId": "",
	"entityName": "",
	"entityType": "",
	"id": "",
	"tenantId": "",
	"tenantName": "",
	"updateTime": "",
	"updater": "",
	"userId": "",
	"userName": ""
}

1
https://gitee.com/thingskit/thingskit-docs.git
git@gitee.com:thingskit/thingskit-docs.git
thingskit
thingskit-docs
ThingsKit物联网平台文档
master

搜索帮助