文档首页/云运维中心 COC/API参考/API/故障管理/告警管理/查询告警详情 - ShowAlarm
更新时间：2025-12-04 GMT+08:00
查看PDF
分享

查询告警详情 - ShowAlarm

功能介绍

根据告警ID查询单条告警详情。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    coc:alarm:get

    Read

    -

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

alarm_id

是

String

参数解释：

告警ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

data

AlarmInfoDTO object

一条告警详情信息。

表3 AlarmInfoDTO

参数

参数类型

描述

id

String

参数解释：

告警ID，作为一条告警的唯一标识，可从COC控制台告警管理->汇聚告警获取告警ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

告警名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

importance

String

参数解释：

告警等级。

约束限制：

不涉及

取值范围：

  • urgent：紧急。

  • major：重要。

  • minor：次要。

  • warn：提示。

默认取值：

不涉及

come_from

String

参数解释：

告警来源，告警来源可从COC页面集成管理模块获取，取值为各个云服务名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

come_from_en

String

参数解释：

数据源，告警来源可从COC页面集成管理模块获取，取值为各个云服务名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

transfer_rule

String

参数解释：

流转规则ID，流转规则的唯一标识，可从COC控制台告警管理->流转规则获取流转规则ID，告警由流转规则创建。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

transfer_rule_name

String

参数解释：

流转规则名称，可从COC控制台告警管理->流转规则获取流转规则名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

app

String

参数解释：

应用名称，创建流转规则时需要填写应用名称，可从流转规则获取应用名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

status

String

参数解释：

告警状态。告警状态为两个，分别为告警中与已解决。当用户点击清除告警，告警状态可转变为已解决。

约束限制：

不涉及

取值范围：

  • alarming：告警中。

  • resolved：告警已清除。

默认取值：

alarming

owner

String

参数解释：

责任人ID。创建流转规则时，需要指定责任人，可在人员管理模块获取责任人ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

owner_name

String

参数解释：

责任人名称。创建流转规则时，需要指定责任人，可在人员管理模块获取责任人名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

owner_alias

String

参数解释：

责任人别名。COC支持人员设置别名，可在人员管理模块获取责任人别名。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

converge_count

Integer

参数解释：

收敛量，该字段为一段时间内累计满足流转规则条件的告警数量。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

associate_event_id

String

参数解释：

关联事件ID，事件唯一标识，可从COC控制台事件管理->获取事件ID。告警转事件后，可关联一条事件。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

domain_id

String

参数解释：

租户ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

creator

String

参数解释：

创建人ID，创建流转规则的用户ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

creator_name

String

参数解释：

创建人名称，创建流转规则的用户名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_time

Long

参数解释：

告警创建时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

update_time

Long

参数解释：

告警更新时间，当用户对告警进行操作时，则更新该字段。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

remarks

String

参数解释：

备注，用户清除告警时，可填写备注信息。

取值范围：

不涉及

默认取值：

不涉及

region

String

参数解释：

区域ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

task_type

String

参数解释：

任务类型，处理告警需执行特定的任务，详见取值范围。

约束限制：

不涉及

取值范围：

  • SCRIPT：脚本。

  • RUNBOOK：作业。

  • PLAN：应急预案。

默认取值：

不涉及

associated_task_type

String

参数解释：

任务类型分类。每个任务有两种分类，分别为自定义任务、公共任务。自定义任务为用户创建的任务，公共任务为COC提供的任务。

约束限制：

不涉及

取值范围：

  • CUSTOMIZATION：自定义。

  • COMMUNAL：公共。

默认取值：

不涉及

associated_task_id

String

参数解释：

任务ID，任务的唯一标识。可从COC控制台资源运维->自动化运维获取任务ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

associated_task_name

String

参数解释：

任务名称。可从COC控制台资源运维->自动化运维获取任务名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询告警id为‘ALM2025071216523205dS85AL9’的告警信息。

GET https://{Endpoint}/v1/alarm-mgmt/alarm/ALM2025071216523205dS85AL9

响应示例

状态码：200

查询单条告警详情成功。

{
  "data": {
    app: "67878512ed22d8546b44fce4",
    associated_task_id: "SC20250422142607018c62b2d",
    associated_task_name: "演示样例",
    associated_task_type: "CUSTOMIZATION",
    come_from: "云监控服务",
    come_from_en: "Cloud Monitoring Service",
    converge_count: 1,
    create_time: 1752310352673,
    id: "ALM2025071216523205dS85AL9",
    importance: "minor",
    name: "演示样例",
    owner: "****",
    owner_name: "****",
    region: "cn-north-4",
    status: "alarming",
    task_type: "SCRIPT",
    transfer_rule: "993568f199d7eb5d7cf297902250fdc8",
    transfer_rule_name: "演示样例"
  }
}

状态码

状态码

描述

200

查询单条告警详情成功。

400

客户端请求错误响应。

错误码

请参见错误码。

父主题：告警管理

相关文档