ThingsKit物联网平台API文档-系统管理(日志管理)

异常日志列表

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

请求方式:GET

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

响应数据类型:*/*

请求参数

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

响应参数:

参数名称参数说明类型
itemsarray
actionData操作数据JsonNode
actionFailureDetails失败信息string
actionStatus操作状态,可用值:FAILURE,SUCCESSstring
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,UPDATEDstring
createTime创建时间string(date-time)
createdTime操作时间integer(int64)
creator创建用户string
customerIdstring(uuid)
customerName客户名称string
entityIdstring(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_TYPEstring
idIDstring
tenantIdstring(uuid)
tenantName租户名称string
updateTime更新时间string(date-time)
updater更新用户string
userIdstring(uuid)
userName操作人员string
totalinteger(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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称参数说明类型
itemsarray
actionData操作数据JsonNode
actionFailureDetails失败信息string
actionStatus操作状态,可用值:FAILURE,SUCCESSstring
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,UPDATEDstring
createTime创建时间string(date-time)
createdTime操作时间integer(int64)
creator创建用户string
customerIdstring(uuid)
customerName客户名称string
entityIdstring(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_TYPEstring
idIDstring
tenantIdstring(uuid)
tenantName租户名称string
updateTime更新时间string(date-time)
updater更新用户string
userIdstring(uuid)
userName操作人员string
totalinteger(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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称参数说明类型
itemsarray
actionData操作数据JsonNode
actionFailureDetails失败信息string
actionStatus操作状态,可用值:FAILURE,SUCCESSstring
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,UPDATEDstring
createTime创建时间string(date-time)
createdTime操作时间integer(int64)
creator创建用户string
customerIdstring(uuid)
customerName客户名称string
entityIdstring(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_TYPEstring
idIDstring
tenantIdstring(uuid)
tenantName租户名称string
updateTime更新时间string(date-time)
updater更新用户string
userIdstring(uuid)
userName操作人员string
totalinteger(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

响应数据类型:*/*

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

响应参数:

参数名称参数说明类型
actionData操作数据JsonNode
actionFailureDetails失败信息string
actionStatus操作状态,可用值:FAILURE,SUCCESSstring
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,UPDATEDstring
createTime创建时间string(date-time)
createdTime操作时间integer(int64)
creator创建用户string
customerIdstring(uuid)
customerName客户名称string
entityIdstring(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_TYPEstring
idIDstring
tenantIdstring(uuid)
tenantName租户名称string
updateTime更新时间string(date-time)
updater更新用户string
userIdstring(uuid)
userName操作人员string

响应示例:

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