Skip to main content
ZStack
Alerting & Response/Alert Events

GetAlertEventDetail

Get detailed information about a specific alert event including its timeline

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

Operation ID

GetAlertEventDetail

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • eventId
    StringRequired

    Event identifier to retrieve details for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • alert
    Object

    The alert event

    • uuid
      String

      Unique identifier of the alert event

      Example: event-001

    • ruleUuid
      String

      UUID of the rule that generated this event

      Example: rule-abc123

    • resourceType
      String

      Type of monitored resource

      Example: vm

    • resourceUuid
      String

      UUID of the specific resource

      Example: res-abc123

    • metricName
      String

      Metric name that was evaluated

      Example: cpu_usage_percent

    • currentValue
      Long

      Current metric value at the time of the event

      Example: 95.3

    • threshold
      Long

      Threshold that was exceeded

      Example: 90

    • operator
      String

      Comparison operator used

      Example: >

    • severity
      String

      Severity level of the event

      Example: critical

    • state
      String

      Current state: firing, acknowledged, or resolved

      Example: firing

    • message
      String

      Human-readable event message

      Example: CPU usage is 95.3%

    • fingerprint
      String

      Unique fingerprint for deduplication

      Example: fp-abc123

    • source
      String

      Source system that generated the event

      Example: prometheus

    • notifiedAt
      String

      Timestamp when the notification was sent

      Example: 2026-01-15T08:00:00Z

    • resolvedAt
      String

      Timestamp when the event was resolved

      Example: 2026-01-15T08:00:00Z

    • acknowledgedBy
      String

      User who acknowledged this event

      Example: admin

    • acknowledgedAt
      String

      Timestamp when the event was acknowledged

      Example: 2026-01-15T08:00:00Z

    • firstOccurrence
      String

      Timestamp when this alert instance first occurred

      Example: 2026-01-15T08:00:00Z

    • alertInstanceUuid
      String

      Alert instance uuid for this resource

      Example: value

    • lifecycleState
      String

      Lifecycle state for this resource

      Example: value

    • ackState
      String

      Ack state for this resource

      Example: value

    • silenceState
      String

      Silence state for this resource

      Example: value

    • productType
      String

      Product type for this resource

      Example: value

    • sourceSystem
      String

      Source system for this resource

      Example: value

    • regionId
      String

      Region id for this resource

      Example: value

    • repeatCount
      Integer

      Repeat count for this resource

      Example: 10

    • silencedAt
      String

      Silenced at for this resource

      Example: 2026-01-15T08:00:00Z

    • silencedUntil
      String

      Silenced until for this resource

      Example: 2026-01-15T08:00:00Z

    • silencePolicyIds
      List

      Silence policy ids for this resource

      Example: item1,item2

    • platformUuid
      String

      UUID of the platform that produced the event

      Example: value

    • ruleId
      String

      Rule id for this resource

      Example: value

    • inhibitionState
      String

      Current inhibition projection state: Active or Inhibited

      Example: Inhibited

    • inhibitedAt
      String

      Timestamp when the current inhibition episode started

      Example: 2026-01-15T08:00:00Z

    • inhibitionRuleIds
      List

      Stable sorted identifiers of currently matching inhibition rules

      Example: item1,item2

    • name
      String

      Alert display name; localized for read-only event queries and returned as the stored name for write responses

      Example: my-resource

    • impactScope
      String

      Localized impact scope for read-only event queries

      Example: value

    • description
      String

      Localized alert description for read-only event queries

      Example: A brief description

    • summary
      String

      Localized alert summary for read-only event queries

      Example: value

    • cause
      String

      Localized alert cause; currently allowed to be empty

      Example: value

    • solution
      String

      Localized alert solution; currently allowed to be empty

      Example: value

    • resourceTypeDisplayName
      String

      Localized display label for resourceType; resourceType remains the stable code

      Example: 组件实例

    • thresholdUnit
      String

      Unit of the final alert expression, localized by Accept-Language on read responses; empty for unitless state values

      Example: value

    • resourceName
      String

      Resource name for alert events. Verified ZCF component instances with an empty or UUID name fall back to saved component metadata; resourceUuid remains unchanged.

      Example: zcf-ziam

  • timeline
    List

    Timeline of actions on the alert event

    Example: (nested array)

    • uuid
      String

      Unique identifier of the timeline entry

      Example: timeline-001

    • alertUuid
      String

      Alert event UUID this entry belongs to

      Example: event-001

    • action
      String

      Action performed on the alert lifecycle

      Example: acknowledged

    • actor
      String

      User who performed the action

      Example: admin

    • createDate
      String

      Timestamp of the action

      Example: 2026-01-15T08:00:00Z

    • summary
      String

      Locale-aware summary for a builtin system event, original text for custom or external system events, and empty for manual actions

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

    • actionDisplayName
      String

      Locale-aware display label for action; falls back to the original action code

      Example: 已确认

    • actorDisplayName
      String

      Locale-aware display label for actor; user identities remain unchanged

      Example: admin

  • deliveryRecords
    List

    Notification delivery records for this alert event

    Example: (nested array)

    • uuid
      String

      UUID of the alert delivery record

      Example: value

    • notificationGroupId
      String

      Notification group id for this resource

      Example: value

    • alertInstanceIds
      List

      Alert instance ids for this resource

      Example: item1,item2

    • alertInstanceUuid
      String

      Alert instance uuid for this resource

      Example: value

    • policyUuid
      String

      Policy uuid for this resource

      Example: value

    • channelUuid
      String

      Channel uuid for this resource

      Example: value

    • channelType
      String

      Channel type for this resource

      Example: value

    • templateUuid
      String

      Template uuid for this resource

      Example: value

    • targetMasked
      String

      Target masked for this resource

      Example: value

    • status
      String

      Status for this resource

      Example: value

    • attempt
      Integer

      Attempt for this resource

      Example: 10

    • maxAttempts
      Integer

      Max attempts for this resource

      Example: 10

    • errorCode
      String

      Error code for this resource

      Example: value

    • errorMessage
      String

      Error message for this resource

      Example: value

    • durationMs
      Integer

      Duration ms for this resource

      Example: 10

    • createdAt
      String

      Created at for this resource

      Example: 2026-01-15T08:00:00Z

    • lastAttemptAt
      String

      Last attempt at for this resource

      Example: 2026-01-15T08:00:00Z

    • nextRetryAt
      String

      Next retry at for this resource

      Example: 2026-01-15T08:00:00Z

    • sentAt
      String

      Sent at for this resource

      Example: 2026-01-15T08:00:00Z

    • providerMessageId
      String

      Provider message id for this resource

      Example: value

    • suppressionType
      String

      Suppression type for this resource

      Example: value

    • suppressionPolicyId
      String

      Suppression policy id for this resource

      Example: value

    • suppressionReason
      String

      Suppression reason for this resource

      Example: value

    • suppressedAt
      String

      Suppressed at for this resource

      Example: 2026-01-15T08:00:00Z

    • deliveryKind
      String

      Delivery kind for this resource

      Example: value

    • contentTruncated
      Boolean

      Content truncated for this resource

      Example: true

    • originalAlertCount
      Integer

      Original alert count for this resource

      Example: 10

    • renderedAlertCount
      Integer

      Rendered alert count for this resource

      Example: 10

    • providerRequestId
      String

      Provider request id for this resource

      Example: value

    • providerDeliveryId
      String

      Provider delivery id for this resource

      Example: value

    • providerAcceptedAt
      String

      Provider accepted at for this resource

      Example: 2026-01-15T08:00:00Z

    • providerConfirmationStatus
      String

      Provider confirmation status for this resource

      Example: value

    • providerErrorCode
      String

      Provider error code for this resource

      Example: value

    • confirmedAt
      String

      Confirmed at for this resource

      Example: 2026-01-15T08:00:00Z

    • eventRecordUuid
      String

      Platform event record UUID; empty for resource and test deliveries.

      Example: value

Change History

View all change history

  • Change Time

    AddedResponse fields eventRecordUuid
    View API

  • Change Time

    AddedRequest parameters Accept-LanguageAddedResponse fields actionDisplayName, actorDisplayName, cause...DeletedResponse fields author, comments, content...
    View API

  • Change Time

    AddedResponse fields ackState, alertInstanceIds, alertInstanceUuid...
    View API