触发用户自定义内容和级别的报警消息

路径 /industry/message/alarm/triggerByContent
版本号 1.0.2
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 可选
超时时间 5000

请求参数

名称 类型 是否必选 示例值 描述
level Int 2 报警级别:参数说明:0:提醒 1:故障 2:报警
title String 这是一个自定义的报警消息标题 报警消息的标题
content String 这是一个自定义的报警消息内容 报警消息的显示内容
receiverList List ["62B89CD128B14215B40AA464D14AD87C"] 报警消息的接收范围列表;receiverType参数为organization时,传入组织id列表,receiverType参数为role时,传入角色id列表,receiverType为user时,传入人员的identityId列表
receiverType String user 消息接收者的类型;参数说明:role:角色,organization:组织,user:人员
appId String sass应用的id
employeeId String 调用者身份id,用于多租户sass应用

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.2"
	},
	"params":{
		"level":2,
		"title": "这是一个自定义的报警消息标题",
		"content": "这是一个自定义的报警消息内容",
		"receiverList":[
			"62B89CD128B14215B40AA464D14AD87C"
		],
		"receiverType": "user",
		"appId": "value5",
		"employeeId": "value6"
	}
}

正常返回示例

JSON 格式

{"code":200,"message":null,"localizedMsg":null,"data":null}

异常返回示例

JSON 格式

{"code":107523,"message":"报警级别错误","localizedMsg":"gateway.backend service error","data":null}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
200 107520 alarm id is not exist 报警id不存在
200 107521 alarm title should not be empty 报警title不允许为空
200 107522 alarm content should not be empty 报警内容不允许为空
200 107523 alarm level error 报警级别错误,只能为0,1,2
200 107524 rule bind alarm definition fail 规则关联报警定义失败
200 107525 alarm receiver type error 报警接收范围的类型错误,只能为role/organization/user
200 107520 alarm id is not exist 报警id不存在
200 107521 alarm title should not be empty 报警title不允许为空
200 107522 alarm content should not be empty 报警内容不允许为空
200 107523 alarm level error 报警级别错误,只能为0,1,2
200 107524 rule bind alarm definition fail 规则关联报警定义失败
200 107525 alarm receiver type error 报警接收范围的类型错误,只能为role/organization/user