查询告警历史记录信息
功能介绍
根据告警ID查询告警历史记录信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/alarm-mgmt/alarm/{alarm_id}/handle-histories
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
alarm_id |
是 |
String |
参数解释： 告警ID，作为一条告警的唯一标识，可从COC控制台告警管理->汇聚告警获取告警ID。 约束限制： 不涉及 取值范围： 以“ALM”开头长度26的字符串。 默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
是 |
Integer |
参数解释： 用于分页查询，偏移指针。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
limit |
是 |
Integer |
参数解释： 用于分页查询，结果数量。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Long |
参数解释： 告警历史记录执行工单数量。单条告警可被执行多次，每次执行的记录都会与告警绑定，供用户查询。 约束范围： 不涉及 取值范围： 不涉及 默认值： 不涉及 |
|
alarm_handle_histories |
Array of AlarmHandleHistory objects |
参数解释： 告警历史记录工单执行详情。 约束范围： 不涉及 取值范围： 不涉及 默认值： 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
work_order_id |
String |
参数解释： 任务执行工单ID。用户可在COC控制台的 “任务管理->执行记录”中，切换至对应执行任务类型的工单页签，查询相关工单信息。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
create_name |
String |
参数解释： 工单执行创建人名称。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
create_alias |
String |
参数解释： 工单执行创建人别名。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
task_type |
String |
参数解释： 工单任务类型。 约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
start_time |
Long |
参数解释： 工单执行开始时间。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
end_time |
Long |
参数解释： 工单执行结束时间。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
duration |
Long |
参数解释： 工单执行耗时。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
status |
String |
参数解释： 工单状态。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
请求示例
查询告警ID为‘ALM2025071216523205dS85AL9’的告警历史记录信息。
GET https://{Endpoint}/v1/alarm-mgmt/alarm/ALM2025071216523205dS85AL9/handle-histories?offset=0&limit=10
{ }
响应示例
状态码：200
正确响应
{
"alarm_handle_histories" : {
"associated_task_id" : "SC20250422142607018c62b2d",
"associated_task_name" : "platform拨测自动化",
"create_name" : "COC_TEST",
"duration" : 448,
"end_time" : 1752484954398,
"start_time" : 1752484949914,
"status" : "FINISHED",
"task_type" : "SCRIPT",
"work_order_id" : "SCT20250714172229018ca2ef9"
},
"count" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正确响应 |
错误码
请参见错误码。
