Querying Alarm Notifications

Function

This API is used to query the alarm notifications in a specified period.

URI

• URI format

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

• Parameter description

  Table 1 URI parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Project ID and Account ID.
  start_time	No	Long	Start time of an alarm. The default value is one hour before the current time. The value is a 13-digit timestamp.
  end_time	No	Long	End time of an alarm. The default value is the current time. The value is a 13-digit timestamp. The time range can be the last week.
  offset	No	Integer	Start page of the paging list. The default value is 0. The value must be greater than or equal to 0.
  limit	No	Integer	The maximum number of records on each page. The default value is 100 and the value ranges from 1 to 1000.

Request Parameters

Response Parameters

Example Request

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

Example Response

• Success response

  HTTP status code 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
  }

• Failure response

  HTTP status code 400

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