背景

事件通知旨在传递资源变化信息。通过设置事件通知,您还可以为事件配置消息处理中间件,实现事件驱动的自动化运维,取代SDK轮询的方式。运维编排服务(OOS)已经支持事件通知,包括模板执行状态通知和任务执行状态通知。系统事件的使用方式与功能介绍请查看查看云产品事件使用云产品事件报警功能

模板执行状态通知

运维编排系统在模板执行状态发生变化时发出通知:

  1. 当前仅支持在执行状态变为Failed时发出事件通知
  2. 云产品动作创建的子执行不发出事件通知

通知格式

{
	"ver": "1.0",
	"id": "2256A988-0B26-4E2B-820A-8A0580D0B8E5",
	"product": "OOS",
	"resourceId": "acs:ecs:cn-hangzhou:169070********30:execution/exec-abc1792gcdoonr9an2uk",
	"level": "INFO",
	"name": "Execution:ExecutionStatusChange",
	"userId": "169070********30",
	"eventTime": "20190409T121826.922+0800",
	"regionId": "cn-hangzhou",
	"content": {
    		"executionId" : "exec-abc1792gcdoonr9an2uk",
    		"status" : "Success",
    		"templateId" : "t-89fb84c218e84fd58e14",
    	 	"templateVersion" : "v8",
    		"templateName" : "templateName",
    		"executedBy" : "admin(1234567)",
    		"startTime" : "2019-11-11T12:00Z",
    		"endTime" : "2019-11-11T13:00Z",
    		"duration" : 360,
    		"parentExecutionId" : "exec-3816c2a99c9146979da6"
	}
}

事件属性

事件通知的顶层字段包含以下固定字段:

字段 说明 示例值
id 事件ID。 9435EAD6-3CF6-4494-8F7A-3A********77
eventTime 事件发生时间,采用UTC+8时区。 20181226T220114.058+0800
level 事件级别。 INFO
name 事件名称。 Execution:StatusChange
product 产品名称。取值范围:OOS。 OOS
regionId 阿里云地域ID。取值请参见地域和可用区 cn-hangzhou
resourceId 资源的ARN值(Aliyun Resource Name,阿里云全局资源描述符)。 acs:ecs:cn-hangzhou:1169070********30:execution/exec-abc1792gcdoonr9an2uk
userId 云账号ID。 169070********30
content 事件详情,包含一个或多个下级参数。详情见content字段解释。

content字段解释:

字段 说明 示例值
executionId 模板执行ID。 exec-abc1792gcdoonr9an2uk
status 执行状态。 Success
templateId 模板ID。 t-89fb84c218e84fd58e14
templateVersion 模板版本。 v8
templateName 模板名称。 templateName
executedBy 执行人。 admin(1234567)
startTime 执行开始事件。 2019-11-11T11:00:00Z
endTime 执行结束时间。 2019-11-11T11:00:02Z
duration 执行耗时,单位为秒。
parentExecutionId 父执行ID。 exec-3816c2a99c9146979da6

任务执行状态通知

运维编排系统在模板任务执行状态发生变化时发出通知:

  1. 当前仅支持在任务执行状态变为Failed时发出事件通知
  2. 云产品动作创建的任务不发出事件通知

通知格式

{
	"ver": "1.0",
	"id": "2256A988-0B26-4E2B-820A-8A0580D0B8E5",
	"product": "OOS",
	"resourceId": "acs:ecs:cn-hangzhou:169070********30:taskexecution/task-exec-abc1792gcdoonr9an2uk",
	"level": "INFO",
	"name": "TaskExecution:StatusChange",
	"userId": "169070********30",
	"eventTime": "20190409T121826.922+0800",
	"regionId": "cn-hangzhou",
	"content": {
    		"taskExecutionId" : "task-exec-abc",
    		"taskAction" : "ACS::ExecuteApi",
    		"taskName" : "taskName",
    		"executionId" : "exec-18864d6b80a448dcbe62",
    		"status" : "Success",
    		"templateId" : "t-89fb84c218e84fd58e14",
    		"templateVersion" : "v8",
    		"templateName" : "templateName",
    		"startTime" : "2019-11-11T12:00Z",
    		"endTime" : "2019-11-11T12:01Z",
    		"duration" : 60
	}
}

事件属性

事件通知的顶层字段包含以下固定字段:

字段 说明 示例值
id 事件ID。 9435EAD6-3CF6-4494-8F7A-3A********77
eventTime 事件发生时间,采用UTC+8时区。 20181226T220114.058+0800
level 事件级别。 INFO
name 事件名称。 TaskExecution:StatusChange
product 产品名称。取值范围:OOS。 OOS
regionId 阿里云地域ID。取值请参见地域和可用区 cn-hangzhou
resourceId 资源的ARN值(Aliyun Resource Name,阿里云全局资源描述符)。 acs:ecs:cn-hangzhou:169070********30:taskexecution/task-exec-abc1792gcdoonr9an2uk
userId 云账号ID。 169070********30
content 事件详情,包含一个或多个下级参数。详情见content字段解释。

content字段解释:

字段 说明 示例值
taskExecutionId 任务执行ID task-exec-abc1792gcdoonr9an2uk
status 任务执行状态。 Success
taskAction 任务动作 ACS::ExecuteApi
taskName 任务名称 taskName
executionId 执行ID exec-18864d6b80a448dcbe62
templateId 模板ID。 t-89fb84c218e84fd58e14
templateVersion 模板版本。 v8
templateName 模板名称。 templateName
executedBy 执行人。 admin(1234567)
startTime 任务执行开始时间。 2019-11-11T11:00:00Z
endTime 任务执行结束时间。 2019-11-11T11:00:01Z
duration 任务执行耗时,单位为秒。 60