跳转到主要内容
告警与响应相关接口/告警事件

获取告警事件详情

获取详细信息特定告警事件包含时间线。

GET/api/v1/alerting/events/{eventId}

操作 ID

GetAlertEventDetail

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • eventId
    String必填

    事件标识符获取详情。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • alert
    Object

    告警事件。

    • uuid
      String

      资源的UUID,唯一标识该资源。

      示例: event-001

    • ruleUuid
      String

      规则UUID。

      示例: rule-abc123

    • resourceType
      String

      资源类型。

      示例: vm

    • resourceUuid
      String

      资源UUID。若指定,资源会使用该字段值作为UUID。

      示例: res-abc123

    • metricName
      String

      监控项名称。

      示例: cpu_usage_percent

    • currentValue
      Long

      当前值。

      示例: 95.3

    • threshold
      Long

      阈值。

      示例: 90

    • operator
      String

      比较运算符。

      示例: >

    • severity
      String

      告警级别。

      示例: critical

    • state
      String

      当前状态。

      示例: firing

    • message
      String

      错误返回消息。

      示例: CPU usage is 95.3%

    • fingerprint
      String

      指纹标识。

      示例: fp-abc123

    • source
      String

      来源信息。

      示例: prometheus

    • notifiedAt
      String

      已通知时间。

      示例: 2026-01-15T08:00:00Z

    • resolvedAt
      String

      已解析时间。

      示例: 2026-01-15T08:00:00Z

    • acknowledgedBy
      String

      用户由已确认事件。

      示例: admin

    • acknowledgedAt
      String

      已确认时间。

      示例: 2026-01-15T08:00:00Z

    • firstOccurrence
      String

      时间戳告警实例首次发生。

      示例: 2026-01-15T08:00:00Z

    • alertInstanceUuid
      String

      资源。

      示例: value

    • lifecycleState
      String

      资源。

      示例: value

    • ackState
      String

      资源。

      示例: value

    • silenceState
      String

      资源。

      示例: value

    • productType
      String

      产品类型。

      示例: value

    • sourceSystem
      String

      资源。

      示例: value

    • regionId
      String

      资源。

      示例: value

    • repeatCount
      Integer

      重试次数。

      示例: 10

    • silencedAt
      String

      已静默时间。

      示例: 2026-01-15T08:00:00Z

    • silencedUntil
      String

      资源。

      示例: 2026-01-15T08:00:00Z

    • silencePolicyIds
      List

      资源。

      示例: item1,item2

    • platformUuid
      String

      平台UUID。

      示例: value

    • ruleId
      String

      规则ID。

      示例: value

    • inhibitionState
      String

      当前抑制投影状态:`Active` 或 `Inhibited`。

      示例: Inhibited

    • inhibitedAt
      String

      本次抑制开始的时间戳。

      示例: 2026-01-15T08:00:00Z

    • inhibitionRuleIds
      List

      抑制规则ID。

      示例: item1,item2

    • name
      String

      资源名称。

      示例: my-resource

    • impactScope
      String

      影响范围。

      示例: value

    • description
      String

      资源的详细描述。

      示例: A brief description

    • summary
      String

      汇总数据。

      示例: value

    • cause
      String

      本地化的告警原因;当前允许为空。

      示例: value

    • solution
      String

      本地化的告警解决方案;当前允许为空。

      示例: value

    • resourceTypeDisplayName
      String

      资源类型显示名称。

      示例: 组件实例

    • thresholdUnit
      String

      阈值单位。

      示例: value

    • resourceName
      String

      告警事件的资源名称。对于已验证的 ZCF 组件实例,若名称为空或为 UUID,则回退使用已保存的组件元数据;`resourceUuid` 保持不变。

      示例: zcf-ziam

  • timeline
    List

    动作告警事件。

    示例: (nested array)

    • uuid
      String

      资源的UUID,唯一标识该资源。

      示例: timeline-001

    • alertUuid
      String

      告警事件UUID条目所属。

      示例: event-001

    • action
      String

      动作名称。

      示例: acknowledged

    • actor
      String

      操作人。

      示例: admin

    • createDate
      String

      创建时间。

      示例: 2026-01-15T08:00:00Z

    • summary
      String

      汇总数据。

      示例: ZStack 云平台 云主机 vm-1 的 CPU 平均使用率为 91.50%

    • actionDisplayName
      String

      动作显示名称。

      示例: 已确认

    • actorDisplayName
      String

      执行者显示名称。

      示例: admin

  • deliveryRecords
    List

    通知投递记录告警事件。

    示例: (nested array)

    • uuid
      String

      资源的UUID,唯一标识该资源。

      示例: value

    • notificationGroupId
      String

      资源。

      示例: value

    • alertInstanceIds
      List

      资源。

      示例: item1,item2

    • alertInstanceUuid
      String

      资源。

      示例: value

    • policyUuid
      String

      资源。

      示例: value

    • channelUuid
      String

      资源。

      示例: value

    • channelType
      String

      资源。

      示例: value

    • templateUuid
      String

      资源。

      示例: value

    • targetMasked
      String

      资源。

      示例: value

    • status
      String

      状态信息。

      示例: value

    • attempt
      Integer

      资源。

      示例: 10

    • maxAttempts
      Integer

      资源。

      示例: 10

    • errorCode
      String

      LDAP错误分类编码。

      示例: value

    • errorMessage
      String

      错误返回消息。

      示例: value

    • durationMs
      Integer

      资源。

      示例: 10

    • createdAt
      String

      创建时间。

      示例: 2026-01-15T08:00:00Z

    • lastAttemptAt
      String

      最近一次尝试时间。

      示例: 2026-01-15T08:00:00Z

    • nextRetryAt
      String

      下次重试时间。

      示例: 2026-01-15T08:00:00Z

    • sentAt
      String

      已发送时间。

      示例: 2026-01-15T08:00:00Z

    • providerMessageId
      String

      资源。

      示例: value

    • suppressionType
      String

      资源。

      示例: value

    • suppressionPolicyId
      String

      资源。

      示例: value

    • suppressionReason
      String

      资源。

      示例: value

    • suppressedAt
      String

      已抑制时间。

      示例: 2026-01-15T08:00:00Z

    • deliveryKind
      String

      资源。

      示例: value

    • contentTruncated
      Boolean

      资源。

      示例: true

    • originalAlertCount
      Integer

      原始告警数量。

      示例: 10

    • renderedAlertCount
      Integer

      已渲染告警数量。

      示例: 10

    • providerRequestId
      String

      资源。

      示例: value

    • providerDeliveryId
      String

      资源。

      示例: value

    • providerAcceptedAt
      String

      提供方已接受时间。

      示例: 2026-01-15T08:00:00Z

    • providerConfirmationStatus
      String

      资源。

      示例: value

    • providerErrorCode
      String

      资源。

      示例: value

    • confirmedAt
      String

      确认时间。

      示例: 2026-01-15T08:00:00Z

    • eventRecordUuid
      String

      事件记录UUID。

      示例: value

  • 变更时间

    新增响应字段 eventRecordUuid
    查看 API
  • 变更时间

    新增请求参数 Accept-Language新增响应字段 actionDisplayName, actorDisplayName, cause...已删除响应字段 author, comments, content...
    查看 API
  • 变更时间

    新增响应字段 ackState, alertInstanceIds, alertInstanceUuid...
    查看 API