更新时间:2024-06-06 GMT+08:00
分享

查询告警通知记录

功能介绍

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

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

URI

  • URI格式

    GET /v2/{project_id}/factory/alarm-info?start_time={start_time}&end_time={end_time}&limit={limit}&offset={offset}

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和账号ID

    start_time

    Long

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

    end_time

    Long

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

    offset

    Integer

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

    limit

    Integer

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

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。

X-Auth-Token

String

IAM Token

最小长度:0

最大长度:4096

响应参数

表3 参数说明

参数名

是否必选

参数类型

说明

alarm_info

List<AlarmInfo>

通知记录信息,请参考表4

total

Integer

通知记录数量。

表4 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,
          "job_id": 911925
        },
        {
          "job_name": "job_0998",
          "schedule_type": 0,
          "send_msg": "success",
          "remind_type": 0,
          "send_status": 0,
          "alarm_time": 1702710169375,
          "plan_time": 1702378260000,
          "job_id": 911925
        }
      ],
      "total": 20
    }
  • 失败响应

    HTTP状态码 400

    {
      "error_code": "DLF.0810",
      "error_msg": "Task does not exist."
    }

相关文档