如何调用ListEventDefinitions_云网管(CMN)-阿里云帮助中心

获取事件定义列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cmn:ListEventDefinitions		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	标记当前开始读取的位置，置空表示从头开始	1
MaxResults	integer	是	本次读取的最大数据记录数量	10
EventId	string	否	事件项 ID	e-l22277akor7iajno
EventName	string	否	事件项名称	端口状态异常
InstanceId	string	否	实例 ID	cmn-cn-xxx
EventType	string	否	事件类型	SYSLOG_EVENT

返回参数

名称	类型	描述	示例值
	object	Schema of Response
TotalCount	integer	TotalCount 本次请求条件下的数据总量，此参数为可选参数，默认可不返回	10
RequestId	string	Id of the request	BC004409-9E71-57FC-8E9A-7929665BF39B
NextToken	string	表示当前调用返回读取到的位置，空代表数据已经读取完毕	21
MaxResults	integer	MaxResults 本次请求所返回的最大记录条数	10
EventDefinitions	array	事件项列表
	EventDefinition	事件 definitions

示例

正常返回示例

JSON格式

{
  "TotalCount": 10,
  "RequestId": "BC004409-9E71-57FC-8E9A-7929665BF39B",
  "NextToken": "21",
  "MaxResults": 10,
  "EventDefinitions": [
    {
      "EventId": "e-12dc0qfv13df0",
      "EventName": "探针掉线事件",
      "CreateTime": "2021-10-01 00:00:00",
      "UpdateTime": "2021-10-01 00:00:00",
      "EventType": "AGENT_TYPE",
      "TemplateId": "temp-12dc0qfv13df0"
    }
  ]
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史