云助手事件说明

云助手任务状态事件

事件描述

用户所运行的命令/脚本往往执行需要一定时间。云助手的RunCommand/InvokeCommand接口为异步接口，调用之后，需要轮询DescribeInvocations/DescribeInvocationResults接口查询任务完成状态，直至该任务完成。

云助手任务状态事件用于加强对任务完成情况的感知，您可以利用该事件达到以下目的：

在任务失败或任务处于完成状态时，获得通知，以便设置报警、处理任务等。

使用轮询会占用用户的API调用额度，通过事件订阅的方式可以避免该问题。

轮询的过程较长，容易被应用发布所打断。使用事件规避状态打断，可以降低用户的复杂度。

事件触发条件&限制

事件触发条件：用户使用RunCommand/InvokeCommand触发任务执行，云助手内部监听任务完成状态，处于完成态的任务则发出该事件。

事件使用限制：

仅在云助手在实例上的任务执行状态（InvocationStatus）变为以下状态时，才会触发发送事件。

Aborted：任务下发失败

Success：任务执行成功

Failed：任务执行失败

Invalid：任务内容非法

Timeout：任务执行超时

Cancelled：任务执行取消

Terminated：任务执行被终止

在OpenAPI（DescribeInvocations/DescribeInvocationResults）中，事件查询的返回数据格式为array<object>。在本事件中，上报的是一个任务在单个实例上的执行状态，而不是多个任务。

事件字段说明

字段 说明 示例值 

instanceId 实例ID。 i-bp114*************** 

invokeId 命令执行ID。 t-hz045********** 

commandId 命令ID。 c-hz045********** 

commandName 命令名称。 ACS-ECS-ResetPassword-for-linux.sh 

ownerUid 执行命令的实例归属账号。 158************* 

playerUid 角色扮演者账号ID。 256*************** 

repeatMode 命令执行的方式。如果同时设置了InstanceId参数，则不生效。取值范围：Once：立即执行命令。

Period：定时执行命令。

NextRebootOnly：当实例下一次启动时，自动执行命令。

EveryReboot：实例每一次启动都将自动执行命令。

 Once 

repeats 命令在该实例上执行的次数。若执行方式为立即执行，则值为0或1。0：命令下发失败，命令脚本未启动执行。

1：命令下发成功，命令次在此实例上执行。

若执行方式为定时执行，则值为执行过多少次。

 0 

invocationStatus 命令执行的状态。Invalid：指定命令类型或参数错误。

Aborted：向实例发送命令失败。实例必须在运行中，且命令可以在1分钟内发送完成。

Success：单次执行的命令：命令执行完成，且退出码为0。

定时执行的命令：上一次执行成功且退出码为0，且指定的执行时间已结束。

Failed：单次执行的命令：命令执行完成，且退出码非0。

定时执行的命令：上一次执行成功且退出码非0，且指定的执行时间将中止。

Timeout：命令执行超时。

Cancelled：命令的执行动作已经取消，命令未曾启动。

Terminated：命令执行时被终止。

 Success 

exitCode 命令进程的退出码。 0 

startTime 任务开始时间。 2023-12-20T06:15:55Z 

finishTime 任务结束时间。 2023-12-20T06:15:59Z 

errorCode 命令下发失败或执行失败原因code。 0 

errorDesc 命令下发失败或执行失败的原因详情。 - 

云助手心跳事件

事件描述

云助手的心跳是判定GuestOS（实例操作系统）状态的手段之一。其中，心跳可以用来判断GuestOS真正启动的时间，作为实例健康状态、下发云助手命令等场景的参考。

相比通过轮询DescribeCloudAssistantStatus的方式查看心跳是否上报，云助手心跳事件可以规避以下问题：

轮询查询DescribeCloudAssistantStatus状态是否变为true，实现比较复杂。如果间隔不当，可能产生过多请求，造成流控或对系统造成压力。

由于GuestOS真正的启动时间差别较大，部分Windows实例偶尔需要5分钟才能启动完成，轮询不容易控制总时长。

DescribeCloudAssistantStatus对状态的判断有一定的滞后性，从有心跳到无心跳会有2分钟的滞后，所以对于重启实例的场景。

阿里云数据解决方案[39] 阿里云是什么[38] 阿里云产品报价[36] 阿里云产品介绍[35] 阿里云解决方案[35] 阿里公有云介绍[35] 云规划设计与实施服务[34] 阿里公有云产品[34] 云与计算培训服务[30] 阿里云优势[30] 阿里云官网登陆[30] 阿里云服务器配置[30] 阿里私有云搭建方案[30] 云与计算咨询服务[28] 阿里云服务器[28] 阿里云服务器成功案例[28] 公有云私有云混合云[27] 阿里云官网[27] 阿里公有云提供哪些计算服务[27] 阿里弹性云服务器[27] 阿里云智慧教育解决方案[26] 阿里公有云官网[26] 阿里公有云服务[26] 阿里私有云方案[26] 大数据使能服务[25] 阿里云园区解决方案[25] 阿里私有云平台[25] 阿里云服务器试用[24] 云迁移与运营支撑服务[21] 阿里私有云架构[20] 阿里私有云解决方案[20] 阿里云提供的服务[18] 阿里云智慧制造解决方案[18] 阿里云服务总代理[18] 阿里云云主机[17] 阿里云安全[17] 阿里私有云[17] 阿里云服务服务中心[16] 阿里云服务核心分销商[16] 阿里公有云架构解决方案[16] 阿里私有云搭建[16] 阿里云备份[15] 阿里云服务器ECS[15] 阿里云软件开发服务[15] 阿里公有云行业解决方案[15] 阿里私有云服务[15] 阿里私有云的搭建方案[15] 阿里私有云网格结构[15] 阿里私有云部署架构[15] 阿里云智慧校园解决方案[14] 阿里云漏洞扫描[14] 阿里云网站建设服务器[14] 阿里云邮箱[14] 阿里云块存储[13] 阿里云弹性云服务器应用[13] 阿里云数据库[13] 阿里云服务器应用[13] 阿里云桌面系统集成商[13] 阿里云迁移解决方案[13] 云与计算客户支持与运维使能服务[12] 阿里云桌面总代理商[12] 阿里云速建站[12] 阿里云产品服务[11] 智慧教育云平台解决方案[10] 阿里云场景化解决方案[10] 阿里云域名注册[10] 阿里云速智能客服[10] 阿里公有云架构[10] 阿里智慧云课堂解决方案[10] 阿里公有云视讯解决方案[9] 阿里私有云产品有哪些[9] 智慧教育云计算解决方案[8] 阿里公有云平台[8] 阿里公有云解决方案[8] 阿里公有云通用解决方案[8] 阿里私有云服务器[8] 阿里云智慧***解决方案[6] 阿里公有云和私有云区别[6] [5] 云与计算客户支持服务[5] 云盘基础操作[5] 阿里公有云是什么[5] 阿里公有云解决方案服务定制领导者[5] 阿里私有云解决方案服务定制领导者[5] 阿里虚拟私有云vpc[5] 扩容云盘[4] 阿里云HTTPS加密访问[4] 阿里云共建智能世界云底座[4] 阿里云域名解析[4] 阿里云应用镜像(13款)[4] 阿里公有云[4] 大数据使能服务[3] 阿里云园区解决方案[3] 阿里公有云产品[3] 加密云盘[3] 阿里云代理公司有哪些[3] 阿里云官网网站[3] 阿里云手机代理加盟[3] 阿里云经销商[3] 阿里公有云专属云主机DeH服务[3] 阿里云官网[2] 阿里云解决方案[2] 阿里公有云架构[2] 阿里私有云搭建[2] 云规划设计与实施服[2] 阿里云企业邮箱服务[2] 阿里云企业邮箱服务 (SAAS,云邮箱）[2] 阿里云数据解决方案 [2] 智慧教育云计算解决方案[1] 阿里云产品服务[1] 阿里云域名注册[1] 云与计算咨询服务[1] 阿里云云主机[1] 阿里云产品报价[1] 阿里云产品服务[1] 阿里云优势[1] 阿里云智慧制造解决方案[1] 阿里云智慧校园解决方案[1] 阿里云服务器ECS[1] 阿里云服务器应用[1] 阿里云服务器成功案例[1] 阿里云服务器试用[1] 阿里云服务器配置[1] 阿里云服务核心分销商 [1] 阿里云速智能客服[1] 阿里公有云平台[1] 阿里私有云搭建方案[1] HTTPS加密访问（CA证书）[1] 专属块存储集群[1] 专属块存储集群概述[1] 主机新用户使用指南[1] 云盘加密概述[1] 云盘扩容指引[1] 修改云盘标签[1] 加密数据盘[1] 加密系统盘[1] 单实例[1] 卸载或挂载系统盘[1] 卸载数据盘[1] 基础环境配置[1] 如何选购云虚拟主机[1] 快照灵活易用[1] 扩容云盘容量[1] 扩容分区和文件系统（Windows）[1] 提供DDoS防护[1] 撒[1] 最新一代CIPU网络[1] 查看磁盘序列号[1] 网站开通要素[1] 腾讯云园区解决方案[1] 腾讯云数据解决方案[1] 腾讯云解决方案[1] 转换MBR分区为GPT分区[1] 释放云盘[1] 镜像跨地域无缝迁移[1] 阿里云[1] 阿里云主备架构[1] 阿里云产品报价 云规划设计与实施服务[1] 阿里云企业级能力[1] 阿里云原生MySQL生态[1] 阿里云原生数据库 PolarDB[1] 阿里云备份恢复[1] 阿里云官方网站,网络安全隔离[1] 阿里云客户端[1] 阿里云故障切换[1] 阿里云数据传输服务 DTS[1] 阿里云数据库 MongoDB 版[1] 阿里云数据库 RDS MySQL 版[1] 阿里云数据库自治服务 DAS[1] 阿里云数据管理 DMS[1] 阿里云智慧解决方案[1] 阿里云智慧＊＊＊解决方案[1] 阿里云服务器ＥＣＳ[1] 阿里云自动分区[1] 阿里云解决方案 [1] 阿里云速智能客服 阿里私有云 阿里私有云解决方案[1] 阿里公有云架[1] 阿里私有云产品有什么[1] 阿里私有云搭建 [1] 高级环境配置（Linux操作系统）[1] 高级环境配置（Windows操作系统）[1]