跳转到主要内容
API Explorer|API Explorer
平台运维/云平台监控相关接口/监控报警/通知服务/监控报警相关接口/事件（Event）
GETEvent Operations起始版本 2.3同步需要认证

获取事件

获取事件

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • startTimeLong

    起始时间

  • endTimeLong

    结束时间

  • limitInteger

    最大返回条数

  • offsetAheadOfCurrentTimeLong

    早于当前时间的毫秒数，例如：查询最近一小时的消息，则传入3600000

  • conditionsList

    查询条件

响应状态

200 OK

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

  • totalLong必填

    事件数目

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • eventsList必填

    详情参考events

    • namespaceString必填

      名字空间

    • nameString必填

      事件名

    • labelsMap必填

      标签

    • resourceIdString必填

      产生事件资源的ID（如果为ZStack Cloud资源则为资源UUID）

    • resourceNameString必填

      资源名称

    • errorString必填

      如果事件代表错误，该字段为错误详情

      • codeString必填

        错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

      • descriptionString必填

        错误的概要描述

      • detailsString必填

        错误的详细信息

      • elaborationString必填

        保留字段，默认为null

      • opaqueLinkedHashMap必填

        保留字段，默认为null

      • causeErrorCode必填

        根错误，引发当前错误的源错误，若无原错误，该字段为null

    • timelong必填

      事件产生时间

    • dataUuidString必填

      消息UUID

    • accountUuidString必填

      账户UUID

    • emergencyLevelEmergencyLevel必填

      详情参考emergencyLevel

      • nameString必填

        资源名称

      • ordinalint必填

        暂无描述。

请求地址

GET/zstack/v1/zwatch/events

/zstack/v1/zwatch/events

操作 ID

GetEventData

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/zwatch/events?startTime=1&endTime=1&limit=1&offsetAheadOfCurrentTime=1&conditions=<conditions>&count=True&endpointUuid=<endpointUuid>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "events": [ { "namespace": "ZStack/VM", "name": "org.zstack.zwatch.datatype.EventFamily@2c24d960", "labels": {}, "emergencyLevel": "Normal", "resourceId": "b7bbe5fb9ab049c5a36bf8a646471cff", "resourceName": "VmInstanceVO", "time": 1.596444516324E12 } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史