调用ListAlarmEvent获取任务报警事件-微服务引擎-阿里云-微服务引擎(MSE)-阿里云帮助中心

获取报警事件。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	xxljob-b6ec1xxxx
AppName	string	否	应用名称。	test-app
JobName	string	否	任务名称。	test-job
StartTime	integer	否	检索到事件的开始时间，使用 Unix 毫秒时间戳，使用 Unix 毫秒时间戳，使用 Unix 毫秒时间戳，使用 Unix 毫秒时间戳。	1690419316000
EndTime	integer	否	检索到事件的结束时间，使用 Unix 毫秒时间戳，使用 Unix 毫秒时间戳，使用 Unix 毫秒时间戳，使用 Unix 毫秒时间戳。	1731636011558
AlarmType	string	否	报警类型。具体说明如下： `schedulerx3_no_designate_machine_alarm`（指定机器不可用报警）。 `schedulerx3_all_busy_alarm`（所有机器繁忙报警）。 `schedulerx3_no_machine_alarm`（无可用机器报警）。 `schedulerx3_timeout_alarm`（任务超时报警）。 `schedulerx3_fail_alarm`（任务执行失败报警）。 `schedulerx3_job_success_notice`（任务执行成功）。	schedulerx3_fail_alarm
AlarmChannel	string	否	报警渠道。具体说明如下： `sms` （短信）。 `mail` （邮箱）。 `phone`（电话）。 `webhook`（webhook）。	webhook
AlarmStatus	string	否	报警状态。具体说明如下： `true`：报警信息发送成功。 `false`：报警信息发送失败。	true
PageSize	string	否	分页大小。	10
PageNum	string	否	页码。	1
Reverse	boolean	否	是否降序。	true

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	27B1345D-5F71-5972-8E4C-AABA6C6232F0
Code	integer	响应码。	200
Message	string	错误信息。	Parameter check error
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	object	报警事件分页结果。
Records	array<object>	结果集。
	object	数据列表。
AppName	string	应用名称。	test-app
JobName	string	任务名称。	test-job
AlarmType	string	报警类型。	schedulerx3_fail_alarm
AlarmChannel	string	报警渠道。	webhook
AlarmContacts	string	报警联系人。	zhangsan
AlarmStatus	string	报警状态。	true
AlarmMessage	string	报警信息。	报警类型：任务执行失败报警运行环境：cn-xx 集群：xxljob-b6ec1acfb2c 应用名：testApp 任务ID及名称：8(failedjob) 实例ID：1308 触发时间：2024-11-19 13:57:10 失败次数：187 运行机器：http://192.*.*.5:9999/ 失败原因：java.lang.reflect.InvocationTargetException
Time	string	格式为`yyyy-MM-dd HH:mm:ss`。	2024-10-31 16:43:51
PageNumber	integer	页码。	1
PageSize	integer	分页大小。	20
Total	integer	总条数。	64

示例

正常返回示例

JSON格式

{
  "RequestId": "27B1345D-5F71-5972-8E4C-AABA6C6232F0",
  "Code": 200,
  "Message": "Parameter check error",
  "Success": true,
  "Data": {
    "Records": [
      {
        "AppName": "test-app",
        "JobName": "test-job",
        "AlarmType": "schedulerx3_fail_alarm",
        "AlarmChannel": "webhook",
        "AlarmContacts": "zhangsan",
        "AlarmStatus": "true",
        "AlarmMessage": "报警类型：任务执行失败报警\n运行环境：cn-xx\n集群：xxljob-b6ec1acfb2c\n应用名：testApp\n任务ID及名称：8(failedjob)\n实例ID：1308\n触发时间：2024-11-19 13:57:10\n失败次数：187\n运行机器：http://192.***.***.5:9999/\n失败原因：java.lang.reflect.InvocationTargetException",
        "Time": "2024-10-31 16:43:51\n"
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "Total": 64
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Parameter error: %s.	参数错误: %s
401	IllegalRequest	IllegalRequest: %s.	非法请求：%s
500	InternalError	InternalError: %s.	系统内部错误：%s
403	NoPermission	No permission to perform this operation: %s.	没有权限去执行该操作：%s
404	NotFound	Not found: %s.	资源不存在：%s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。