ThingsKit

Appearance

Return to top
本页目录

 

ThingsKit物联网平台

开箱即用的物联网低代码平台

告警配置分页

接口地址:/api/yt/alarm/profile{?name,orderFiled,orderType,organizationId,page,pageSize,status}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称参数说明是否必须数据类型
pagepagetrueint
pageSizepageSizetrueint
statusstatusfalseinteger(int32)
namenamefalsestring
organizationIdorganizationIdfalsestring
orderFiledorderFiledfalsestring
orderTypeorderType,可用值:ASC,DESCfalsestring

响应参数:

参数名称参数说明类型
itemsarray
  alarmContactId告警联系人 通知多人“,”号分隔string
  createTime创建时间string(date-time)
  creator创建用户string
  defaultConfig租户默认配置string
  description租户描述string
  enabled租户状态：启用/禁用boolean
  icon租户图标string
  idIDstring
  messageMode消息通知方式：多种方式“,”号分隔 MessageTypeEnumstring
  name告警配置名称string
  organizationId组织IDstring
  organizationName组织名称string
  remark告警配置备注string
  roleIds租户角色列表array
  status状态：0禁用 1启用integer(int32)
  tenantExpireTime租户到期时间string(date-time)
  tenantId租户IDstring
  tenantProfileId租户配置string
  tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
  updateTime更新时间string(date-time)
  updater更新用户string
totalinteger(int32)

响应示例:

javascript
{
	"items": [
		{
			"alarmContactId": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"messageMode": "",
			"name": "",
			"organizationId": "",
			"organizationName": "",
			"remark": "",
			"roleIds": [],
			"status": 0,
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		}
	],
	"total": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

新增和编辑告警配置

接口地址:/api/yt/alarm/profile

请求方式:POST

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

响应数据类型:*/*

请求示例:

javascript
{
  "alarmContactId": "",
  "createTime": "",
  "creator": "",
  "defaultConfig": "",
  "description": "",
  "enabled": false,
  "icon": "",
  "id": "",
  "messageMode": "",
  "name": "",
  "organizationId": "",
  "organizationName": "",
  "remark": "",
  "roleIds": [],
  "status": 0,
  "tenantExpireTime": "",
  "tenantId": "",
  "tenantProfileId": "",
  "tenantStatus": "",
  "updateTime": "",
  "updater": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

请求参数:

参数名称参数说明请求类型是否必须数据类型
alarmProfileDTOAlarmProfileDTObodytrueAlarmProfileDTO
  alarmContactId告警联系人 通知多人“,”号分隔truestring
  createTime创建时间falsestring(date-time)
  creator创建用户falsestring
  defaultConfig租户默认配置falsestring
  description租户描述falsestring
  enabled租户状态：启用/禁用falseboolean
  icon租户图标falsestring
  idIDfalsestring
  messageMode消息通知方式：多种方式“,”号分隔 MessageTypeEnumtruestring
  name告警配置名称truestring
  organizationId组织IDtruestring
  organizationName组织名称falsestring
  remark告警配置备注falsestring
  roleIds租户角色列表falsearray
  status状态：0禁用 1启用falseinteger(int32)
  tenantExpireTime租户到期时间falsestring(date-time)
  tenantId租户IDfalsestring
  tenantProfileId租户配置falsestring
  tenantStatus可用值:DISABLED,EXPIRED,NORMALfalsestring
  updateTime更新时间falsestring(date-time)
  updater更新用户falsestring

响应参数:

参数名称参数说明类型
alarmContactId告警联系人 通知多人“,”号分隔string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态：启用/禁用boolean
icon租户图标string
idIDstring
messageMode消息通知方式：多种方式“,”号分隔 MessageTypeEnumstring
name告警配置名称string
organizationId组织IDstring
organizationName组织名称string
remark告警配置备注string
roleIds租户角色列表array
status状态：0禁用 1启用integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

javascript
{
	"alarmContactId": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"messageMode": "",
	"name": "",
	"organizationId": "",
	"organizationName": "",
	"remark": "",
	"roleIds": [],
	"status": 0,
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

删除告警配置(待翻译)

接口地址:/api/yt/alarm/profile

请求方式:DELETE

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

响应数据类型:*/*

请求示例:

javascript
{
  "ids": [],
  "tenantId": ""
}
1
2
3
4

请求参数:

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

响应参数:

参数名称参数说明类型
errorCodePlatform error code:\n* 2 - General error (HTTP: 500 - Internal Server Error)\n\n* 10 - Authentication failed (HTTP: 401 - Unauthorized)\n\n* 11 - JWT token expired (HTTP: 401 - Unauthorized)\n\n* 15 - Credentials expired (HTTP: 401 - Unauthorized)\n\n* 20 - Permission denied (HTTP: 403 - Forbidden)\n\n* 30 - Invalid arguments (HTTP: 400 - Bad Request)\n\n* 31 - Bad request params (HTTP: 400 - Bad Request)\n\n* 32 - Item not found (HTTP: 404 - Not Found)\n\n* 33 - Too many requests (HTTP: 429 - Too Many Requests)\n\n* 34 - 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/alarm/profile/{alarmProfileId}/{status}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
alarmProfileIdalarmProfileIdpathtruestring
statusstatuspathtrueinteger(int32)

响应参数:

参数名称参数说明类型
alarmContactId告警联系人 通知多人“,”号分隔string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态：启用/禁用boolean
icon租户图标string
idIDstring
messageMode消息通知方式：多种方式“,”号分隔 MessageTypeEnumstring
name告警配置名称string
organizationId组织IDstring
organizationName组织名称string
remark告警配置备注string
roleIds租户角色列表array
status状态：0禁用 1启用integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

javascript
{
	"alarmContactId": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"messageMode": "",
	"name": "",
	"organizationId": "",
	"organizationName": "",
	"remark": "",
	"roleIds": [],
	"status": 0,
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": ""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

获取组织下的告警配置

接口地址:/api/yt/alarm/profile/{organizationId}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称参数说明类型
alarmContactId告警联系人 通知多人“,”号分隔string
createTime创建时间string(date-time)
creator创建用户string
defaultConfig租户默认配置string
description租户描述string
enabled租户状态：启用/禁用boolean
icon租户图标string
idIDstring
messageMode消息通知方式：多种方式“,”号分隔 MessageTypeEnumstring
name告警配置名称string
organizationId组织IDstring
organizationName组织名称string
remark告警配置备注string
roleIds租户角色列表array
status状态：0禁用 1启用integer(int32)
tenantExpireTime租户到期时间string(date-time)
tenantId租户IDstring
tenantProfileId租户配置string
tenantStatus可用值:DISABLED,EXPIRED,NORMALstring
updateTime更新时间string(date-time)
updater更新用户string

响应示例:

javascript
[
	{
		"alarmContactId": "",
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"messageMode": "",
		"name": "",
		"organizationId": "",
		"organizationName": "",
		"remark": "",
		"roleIds": [],
		"status": 0,
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": ""
	}
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

@ 2023 云腾五洲 蜀ICP备2020033344号