跳转到主要内容
告警与响应相关接口/告警路由与策略

查询平台事件列表

按记录时间降序、唯一标识降序列出已授权的平台事件事实;记录不等同于投递确认

GET/api/v1/alerting/platform-events

操作 ID

ListPlatformEvents

起始版本

1.3.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • platformUuid
    String

    平台UUID。

  • productType
    String

    产品类型。

  • namespace
    String

    命名空间。

  • eventName
    String

    精确事件名称。

  • resourceType
    String

    资源类型。

响应状态

200 OK
200 OK

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

  • items
    List

    条目列表。

    • uuid
      String

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

      示例: record-1

    • platformUuid
      String

      平台UUID。

      示例: platform-1

    • productType
      String

      产品类型。

      示例: cloud

    • sourceSystem
      String

      标识符。

      示例: zstack

    • sourceEventId
      String

      源事件身份空不可用。

      示例: source-event-1

    • namespace
      String

      命名空间。

      示例: ZStack/Host

    • eventName
      String

      源事件名称。

      示例: HostConnected

    • resourceType
      String

      资源类型。

      示例: Host

    • resourceUuid
      String

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

      示例: host-1

    • resourceName
      String

      资源显示名称。

      示例: Host A

    • severity
      String

      告警级别。

      示例: info

    • recordType
      String

      记录分类不同通知投递状态。

      示例: notify

    • recordedAt
      String

      已记录时间。

      示例: 2026-09-17T00:00:00Z

    • occurredAt
      String

      发生时间。

      示例: 2026-09-16T23:59:59Z

    • message
      String

      错误返回消息。

      示例: Host connected

    • parseError
      String

      解析错误。

      示例: event namespace is missing

    • rawPayload
      Object

      原始负载。

      示例: (nested object)

    • deliveryRecords
      List

      投递记录。

      • 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

    • ackState
      String

      确认状态。

      示例: Unack

    • acknowledgedBy
      String

      确认人。

      示例: user-1

    • acknowledgedAt
      String

      已确认时间。

      示例: 2026-09-20T00:00:00Z

    • name
      String

      资源名称。

      示例: Host Connected

    • impactScope
      String

      影响范围。

      示例: value

    • description
      String

      资源的详细描述。

      示例: A brief description

    • summary
      String

      汇总数据。

      示例: value

    • cause
      String

      预留的展示字段;明确返回空字符串。

    • solution
      String

      预留的展示字段;明确返回空字符串。

    • resourceTypeDisplayName
      String

      资源类型显示名称。

      示例: Host

  • total
    String

    返回结果总数。

    示例: 20

  • limit
    Integer

    最大返回条目数。

    示例: 20

  • offset
    Integer

    查询起始偏移量。

    示例: 20

  • 变更时间

    新增请求参数 Accept-Language, search新增响应字段 cause, description, impactScope...
    查看 API