ListEvents - 获取事件列表

获取事件列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cmn:ListEvents
  • 全部资源
    *

请求参数

名称类型必填描述示例值
NextTokenstring

标记当前开始读取的位置,置空表示从头开始

1
MaxResultsinteger

本次读取的最大数据记录数量

10
InstanceIdstring

实例 ID

cmn-cn-xxxxx
DeviceIdstring

设备 ID

device-23ecvcvf0
PhysicalSpaceIdstring

物理空间 ID

space-dcfv9cof4e
EventTypestring

事件类型

SYSLOG_EVENT
AlarmStatusstring

告警状态

WARNING

返回参数

名称类型描述示例值
object

Schema of Response

TotalCountinteger

TotalCount 本次请求条件下的数据总量,此参数为可选参数,默认可不返回

10
RequestIdstring

Id of the request

403CDD53-2A04-55C9-822A-6EE4931C3332
NextTokenstring

表示当前调用返回读取到的位置,空代表数据已经读取完毕

1
MaxResultsinteger

MaxResults 本次请求所返回的最大记录条数

10
Eventsarray

事件列表

Event

事件对象列表。

Statisticsarray<object>

事件统计

object

统计信息

Statusstring

事件告警状态

WARNING
Countinteger

总量

10

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "RequestId": "403CDD53-2A04-55C9-822A-6EE4931C3332",
  "NextToken": "1",
  "MaxResults": 10,
  "Events": [
    {
      "Message": "xxx事件发生,请关注",
      "EventType": "AGENT_EVENT",
      "CreateTime": "2021-10-01 01:00:00",
      "UpdateTime": "2021-10-01 01:00:00",
      "AlarmStatus": "WARNING",
      "EventObjectId": "device-12345",
      "Count": 10,
      "EventName": "探针掉线事件",
      "EventObject": "xxx设备",
      "DeviceId": "device-dcfv2fob0g",
      "TemplateId": "temp-1dcvf2911wdc",
      "ResourceDevice": {
        "PhysicalSpace": "杭州X空间",
        "HostName": "ASW-1"
      }
    }
  ],
  "Statistics": [
    {
      "Status": "WARNING",
      "Count": 10
    }
  ]
}

错误码

HTTP status code错误码错误信息
400SignatureDoesNotMatch签名不通过
403NoPermission没有权限
404ServiceNotFound后端服务未找到
500InternalError服务器内部错误
503ServiceUnavailable服务不可用

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史