Querying Historical Alarms

Function

This API is used to query historical alarms by alarm ID.

URI

GET /v1/alarm-mgmt/alarm/{alarm_id}/handle-histories

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
alarm_id	Yes	String	Definition: Alarm ID, which uniquely identifies an alarm. You can obtain the alarm ID from the aggregated alarms page of the alarm management module on COC. Constraints: N/A Value range: 0–26 characters, starting with ALM. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Definition: Offset pointers queried by page. Constraints: N/A Value range: N/A Default value: N/A
limit	Yes	Integer	Description: Number of queried records in a pagination query. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
count	Long	Definition: Number of service tickets executed for the historical alarms. An alarm ticket can be executed multiple times. Each execution record is bound to the alarm ticket for users to query. Constraints: N/A Value range: N/A Default value: N/A
alarm_handle_histories	Array of AlarmHandleHistory objects	Definition: Execution details of the service tickets of the historical alarms. Constraints: N/A Value range: N/A Default value: N/A
resolved_record	ResolvedRecordDTO object	Description: Alarm clearance record. Constraints: N/A Value range: N/A Default value: N/A

**Table 4** AlarmHandleHistory
Parameter	Type	Description
work_order_id	String	Definition: ID of the task execution service ticket. You can switch to the service ticket tab page to query the service ticket information of the corresponding task type on the Task Management > Execution Records page of COC. Constraints: N/A Value range: N/A Default value: N/A
create_name	String	Definition: Name of the service ticket creator. Constraints: N/A Value range: N/A Default value: N/A
create_alias	String	Definition: Alias of the service ticket creator. Constraints: N/A Value range: N/A Default value: N/A
task_type	String	Definition: Service ticket task type. Constraints: N/A Value range: SCRIPT: script RUNBOOK: job Default value: N/A
start_time	Long	Definition: Start time of service ticket execution. Constraints: N/A Value range: N/A Default value: N/A
end_time	Long	Definition: End time of service ticket execution. Constraints: N/A Value range: N/A Default value: N/A
duration	Long	Definition: Time required for executing a service ticket. Constraints: N/A Value range: N/A Default value: N/A
status	String	Definition: Service ticket status. Constraints: N/A Value range: N/A Default value: N/A
associated_task_name	String	Definition: Script or job ID. Constraints: N/A Value range: N/A Default value: N/A
associated_task_id	String	Definition: Script or job ID. Constraints: N/A Value range: N/A Default value: N/A

**Table 5** ResolvedRecordDTO
Parameter	Type	Description
resolved_time	Integer	Definition: Time when an aggregated alarm is cleared. Constraints: N/A Value range: N/A Default value: N/A
create_name	String	Definition: Executor. Constraints: N/A Value range: N/A Default value: N/A
remarks	String	Definition: Remarks entered during alarm clearance. Constraints: N/A Value range: N/A Default value: N/A

Example Requests

Query the historical alarm whose ID is ALM2025071216523205dS85AL9.

GET https://{Endpoint}/v1/alarm-mgmt/alarm/ALM2025071216523205dS85AL9/handle-histories?offset=0&limit=10

{ }

Example Responses

Status code: 200

Response is returned correctly.

{
  "alarm_handle_histories": {
    "associated_task_id": "SC20250422142607018c62b2d",
    "associated_task_name": "platform dialing test automation",
    "create_name": "COC_TEST",
    "duration": 448,
    "end_time": 1752484954398,
    "start_time": 1752484949914,
    "status": "FINISHED",
    "task_type": "SCRIPT",
    "work_order_id": "SCT20250714172229018ca2ef9"
  },
  "count": 1,
  "resolved_record": {
    create_name: "zx",
    remarks: "",
    resolved_time: 1748399160760
  },
  "sub_task_info": {
    "sub_associated_task_id": "RB20250312115143012ad8749",
    "sub_associated_task_name": "",
    "sub_associated_task_type": "CUSTOMIZATION",
    "sub_task_type": "SCRIPT",
  }
}