文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V2）/ 作业开发API/ 查询告警通知记录
更新时间：2025-09-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询告警通知记录

功能介绍

此接口可以查询指定时间段内的告警通知记录。

URI

  • URI格式

    GET /v2/{project_id}/factory/alarm-info

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，获取方法请参见项目ID和账号ID。
    表2 Query参数

    参数

    是否必选

    参数类型

    描述

    start_time

    否

    Long

    告警的开始时间，默认当前时间的前一个小时，13位时间戳。

    end_time

    否

    Long

    告警的最后时间，默认为当前时间，13位时间戳，支持查询最近一周的时间段

    offset

    否

    Integer

    分页的起始页，默认值为0。取值范围大于等于0。

    limit

    否

    Integer

    分页返回结果，指定每页最大记录数。默认值为100，取值范围为[1, 1000]

请求参数

表3 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。
    说明：
    • 多个DataArts Studio实例需要指定工作空间。
    • 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。

X-Auth-Token

否

String

IAM Token

最小长度：0

最大长度：4096

响应参数

表4 参数说明

参数名

是否必选

参数类型

说明

alarm_info

否

List<AlarmInfo>

通知记录信息，请参考表5。

total

否

Integer

通知记录数量。
表5 AlarmInfo数据结构

参数名

是否必选

参数类型

说明

alarm_time

否

Long

告警通知时间。

job_name

否

String

作业名称。

schedule_type

否

Integer

作业实例调度方式。取值范围如下：

0：正常调度

2：手工调度

5：补数据

6：子作业调度

7：单次调度

send_msg

否

String

发送信息。

plan_time

否

Long

计划时间。

remind_type

否

Integer

告警通知类型，取值范围如下：

0：运行成功

1：运行异常/失败

3：未完成

4：资源繁忙

12：周期未完成

13：运行取消

14：失败作业重跑成功

15：作业改动

send_status

否

Integer

发送状态，取值范围如下：

0：发送成功

1：发送失败

job_id

否

Long

作业ID。

请求示例

GET /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/alarm-info?start_time=1702378620000&end_time=1702710169595&limit=3&offset=0

响应示例

  • 成功响应

    HTTP状态码 200

    {
  "alarm_info": [
    {
      "alarm_time": 1702710169460,
      "job_name": "job_0998",
      "schedule_type": 0,
      "send_msg": "success",
      "plan_time": 1702378440000,
      "remind_type": 0,
      "send_status": 0,
      "instance_name": "N_赋值_20250813000100",
      "instance_id": 1193763,
      "job_id": 911925
    },
    {
      "job_name": "job_0998",
      "schedule_type": 0,
      "send_msg": "success",
      "remind_type": 0,
      "send_status": 0,
      "instance_name": "N_赋值_20250813000100",
      "instance_id": 1193763,
      "alarm_time": 1702710169375,
      "plan_time": 1702378260000,
      "job_id": 911925
    }
  ],
  "total": 20
}
  • 失败响应

    HTTP状态码 400

    {
  "error_code": "DLF.0810",
  "error_msg": "Task does not exist."
}
父主题： 作业开发API