ThingsKit物联网平台API文档-监控运维（告警管理-告警联系人）

云腾小编

2024年10月28日2024年10月28日

告警联系人分页

接口地址:/api/yt/alarm_contact{?create_time,organizationId,page,pageSize,username}

请求方式:GET

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	是否必须	数据类型
page	page	true	int
pageSize	pageSize	true	int
username	username	false	string
organizationId	organizationId	false	string
create_time	create_time	false	string

响应参数:

参数名称	参数说明	类型
items		array
addPeople	添加人	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
dingtalk	钉钉	string
email	电子邮件	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
organizationDTO	组织对象	OrganizationDTO
children	子集	array
createTime	创建时间	string
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组织名称	string
parentId	组织父ID	string
remark	备注	string
roleIds	租户角色列表	array
sort	排序	integer
tenantExpireTime	租户到期时间	string
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string
updater	更新用户	string
organizationId	组织	string
phone	电话	string
remark	备注	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
username	用户名	string
wechat	微信	string
total		integer(int32)

响应示例:

{
	"items": [
		{
			"addPeople": "",
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"dingtalk": "",
			"email": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"organizationDTO": {
				"children": [
					{
						"children": [
							{}
						],
						"createTime": "",
						"creator": "",
						"defaultConfig": "",
						"description": "",
						"enabled": false,
						"icon": "",
						"id": "",
						"name": "",
						"parentId": "",
						"remark": "",
						"roleIds": [],
						"sort": 0,
						"tenantExpireTime": "",
						"tenantId": "",
						"tenantProfileId": "",
						"tenantStatus": "",
						"updateTime": "",
						"updater": ""
					}
				],
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"icon": "",
				"id": "",
				"name": "",
				"parentId": "",
				"remark": "",
				"roleIds": [],
				"sort": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"updateTime": "",
				"updater": ""
			},
			"organizationId": "",
			"phone": "",
			"remark": "",
			"roleIds": [],
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": "",
			"username": "",
			"wechat": ""
		}
	],
	"total": 0
}

新增告警联系人

接口地址:/api/yt/alarm_contact

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "name": "",
  },
  "organizationId": "",
  "phone": "",
  "username": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
alarmContactDTO	AlarmContactDTO	body	true	AlarmContactDTO
addPeople	添加人		false	string
createTime	创建时间		false	string(date-time)
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
dingtalk	钉钉		false	string
email	电子邮件		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	租户名称		false	string
organizationDTO	组织对象		false	OrganizationDTO
children	子集		false	array
createTime	创建时间		false	string
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	组织名称		false	string
parentId	组织父ID		false	string
remark	备注		false	string
roleIds	租户角色列表		false	array
sort	排序		false	integer
tenantExpireTime	租户到期时间		false	string
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string
updater	更新用户		false	string
organizationId	组织		false	string
phone	电话		true	string
remark	备注		false	string
roleIds	租户角色列表		false	array
tenantExpireTime	租户到期时间		false	string(date-time)
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string(date-time)
updater	更新用户		false	string
username	用户名		true	string
wechat	微信		false	string

响应参数:

参数名称	参数说明	类型
addPeople	添加人	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
dingtalk	钉钉	string
email	电子邮件	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
organizationDTO	组织对象	OrganizationDTO
children	子集	array
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组织名称	string
parentId	组织父ID	string
remark	备注	string
roleIds	租户角色列表	array
sort	排序	integer(int32)
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
organizationId	组织	string
phone	电话	string
remark	备注	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
username	用户名	string
wechat	微信	string

响应示例:

{
	"addPeople": "",
	"createTime": "",
	"creator": "",
	"defaultConfig": "",
	"description": "",
	"dingtalk": "",
	"email": "",
	"enabled": false,
	"icon": "",
	"id": "",
	"name": "",
	"organizationDTO": {
		"children": [
			{
				"children": [
					{}
				],
				"createTime": "",
				"creator": "",
				"defaultConfig": "",
				"description": "",
				"enabled": false,
				"icon": "",
				"id": "",
				"name": "",
				"parentId": "",
				"remark": "",
				"roleIds": [],
				"sort": 0,
				"tenantExpireTime": "",
				"tenantId": "",
				"tenantProfileId": "",
				"tenantStatus": "",
				"updateTime": "",
				"updater": ""
			}
		],
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"name": "",
		"parentId": "",
		"remark": "",
		"roleIds": [],
		"sort": 0,
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": ""
	},
	"organizationId": "",
	"phone": "",
	"remark": "",
	"roleIds": [],
	"tenantExpireTime": "",
	"tenantId": "",
	"tenantProfileId": "",
	"tenantStatus": "",
	"updateTime": "",
	"updater": "",
	"username": "",
	"wechat": ""
}

编辑告警联系人(待翻译)

接口地址:/api/yt/alarm_contact/update

请求方式:POST

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

响应数据类型:*/*

请求示例:

{
  "addPeople": "",
  "name": ""
  },
  "organizationId": "",
  "phone": "",
  "username": ""
}

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
alarmContactDTO	AlarmContactDTO	body	true	AlarmContactDTO
addPeople	添加人		false	string
createTime	创建时间		false	string(date-time)
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
dingtalk	钉钉		false	string
email	电子邮件		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	租户名称		false	string
organizationDTO	组织对象		false	OrganizationDTO
children	子集		false	array
createTime	创建时间		false	string
creator	创建用户		false	string
defaultConfig	租户默认配置		false	string
description	租户描述		false	string
enabled	租户状态：启用/禁用		false	boolean
icon	租户图标		false	string
id	ID		false	string
name	组织名称		false	string
parentId	组织父ID		false	string
remark	备注		false	string
roleIds	租户角色列表		false	array
sort	排序		false	integer
tenantExpireTime	租户到期时间		false	string
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string
updater	更新用户		false	string
organizationId	组织		false	string
phone	电话		true	string
remark	备注		false	string
roleIds	租户角色列表		false	array
tenantExpireTime	租户到期时间		false	string(date-time)
tenantId	租户ID		false	string
tenantProfileId	租户配置		false	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL		false	string
updateTime	更新时间		false	string(date-time)
updater	更新用户		false	string
username	用户名		true	string
wechat	微信		false	string

响应参数:

参数名称	参数说明	类型
errorCode	Platform 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
message	Error message	string
status	HTTP Response Status Code	integer(int32)
timestamp	Timestamp	string(date-time)

删除告警联系人(待翻译)

接口地址:/api/yt/alarm_contact

请求方式:DELETE

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

响应数据类型:*/*

请求参数:

参数名称	参数说明	请求类型	是否必须	数据类型
strings	string	body	true	array

响应参数:

参数名称	参数说明	类型
errorCode	Platform 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
message	Error message	string
status	HTTP Response Status Code	integer(int32)
timestamp	Timestamp	string(date-time)

获取组织下的告警联系人

接口地址:/api/yt/alarm_contact/{organizationId}

请求方式:GET

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

响应数据类型:*/*

请求参数:

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

响应参数:

参数名称	参数说明	类型
addPeople	添加人	string
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
dingtalk	钉钉	string
email	电子邮件	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	租户名称	string
organizationDTO	组织对象	OrganizationDTO
children	子集	array
createTime	创建时间	string(date-time)
creator	创建用户	string
defaultConfig	租户默认配置	string
description	租户描述	string
enabled	租户状态：启用/禁用	boolean
icon	租户图标	string
id	ID	string
name	组织名称	string
parentId	组织父ID	string
remark	备注	string
roleIds	租户角色列表	array
sort	排序	integer(int32)
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
organizationId	组织	string
phone	电话	string
remark	备注	string
roleIds	租户角色列表	array
tenantExpireTime	租户到期时间	string(date-time)
tenantId	租户ID	string
tenantProfileId	租户配置	string
tenantStatus	可用值:DISABLED,EXPIRED,NORMAL	string
updateTime	更新时间	string(date-time)
updater	更新用户	string
username	用户名	string
wechat	微信	string

响应示例:

[
	{
		"addPeople": "",
		"createTime": "",
		"creator": "",
		"defaultConfig": "",
		"description": "",
		"dingtalk": "",
		"email": "",
		"enabled": false,
		"icon": "",
		"id": "",
		"name": "",
		"organizationDTO": {
			"children": [
				{
					"children": [
						{}
					],
					"createTime": "",
					"creator": "",
					"defaultConfig": "",
					"description": "",
					"enabled": false,
					"icon": "",
					"id": "",
					"name": "",
					"parentId": "",
					"remark": "",
					"roleIds": [],
					"sort": 0,
					"tenantExpireTime": "",
					"tenantId": "",
					"tenantProfileId": "",
					"tenantStatus": "",
					"updateTime": "",
					"updater": ""
				}
			],
			"createTime": "",
			"creator": "",
			"defaultConfig": "",
			"description": "",
			"enabled": false,
			"icon": "",
			"id": "",
			"name": "",
			"parentId": "",
			"remark": "",
			"roleIds": [],
			"sort": 0,
			"tenantExpireTime": "",
			"tenantId": "",
			"tenantProfileId": "",
			"tenantStatus": "",
			"updateTime": "",
			"updater": ""
		},
		"organizationId": "",
		"phone": "",
		"remark": "",
		"roleIds": [],
		"tenantExpireTime": "",
		"tenantId": "",
		"tenantProfileId": "",
		"tenantStatus": "",
		"updateTime": "",
		"updater": "",
		"username": "",
		"wechat": ""
	}
]