DescribeInvocations_云助手_API参考_云服务器 ECS-阿里云

接口说明

当您执行命令后，不代表命令一定成功运行，并且一定有预期的命令效果。您需要通过接口返回值查看实际执行结果，以实际输出结果为准。
您可以查询最近2周的执行信息，执行信息的保留上限为10万条。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	否	DescribeInvocations	系统规定参数。取值：DescribeInvocations
RegionId	String	是	cn-hangzhou	地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
InvokeId	String	否	t-7d2a745b412b4601b2d47f6a76******	脚本进程执行ID。
CommandId	String	否	c-4d34302d02424c5c8e10281e3a******	脚本ID。您可以通过接口DescribeCommands查询所有可用的CommandId。
CommandName	String	否	Test1	脚本名称。
CommandType	String	否	RunShellScript	脚本类型。
Timed	Boolean	否	true	脚本是否为周期执行。默认值：false。
InvokeStatus	String	否	Finished	脚本执行的总执行状态。总执行状态取决于创建执行中的一台或多台实例的共同执行状态（`InstanceInvokeStatus`）。取值范围： Running：周期执行：未手动停止周期执行脚本前，执行状态一直为进行中单次执行：一旦有进行中的脚本进程，总的执行状态就为进行中 Finished：周期执行：脚本进程不可能为执行完成单次执行：所有实例全部完成执行。或者手动停止部分实例的脚本进程，其余实例全部执行完成 Failed：周期执行：脚本进程不可能为执行失败单次执行：所有实例全部执行失败 PartialFailed：周期执行：脚本进程不可能为部分失败单次执行：部分实例有执行失败的脚本进程，则总执行状态为部分失败 Stopped：停止脚本默认值：Running。
InstanceId	String	否	i-uf614fhehhz**	实例ID。当您传入了该参数，将查询该实例所有的脚本执行记录。
ContentEncoding	String	否	PlainText	设置返回数据中`CommandContent`字段和`Output`字段的编码方式。取值范围： PlainText：返回原始脚本内容和输出信息 Base64：返回Base64编码后的脚本内容和输出信息默认值：Base64。
IncludeOutput	Boolean	否	false	是否在结果中返回脚本运行的输出信息。 true：返回。此时，您至少指定参数`InvokeId`或`InstanceId` false：不返回默认值：false。
PageNumber	Long	否	1	当前页码。起始值：1。默认值：1。
PageSize	Long	否	10	分页查询时设置的每页行数。最大值：50。默认值：10。

返回数据


名称	类型	示例值	描述
Invocations	Array		脚本执行记录集类型。
Invocation
CommandContent	String	ZWNobyAiaGVsbG8gd29ybGQiID4vcm9vdC90ZXN0******==	脚本内容，以Base64编码后传输。
CommandId	String	c-4d34302d02424c5c8e10281e3a315***	脚本ID。
CommandName	String	Test1	脚本名称。
CommandType	String	RunShellScript	脚本类型。
CreationTime	String	2020-01-19T09:15:46Z	任务的创建时间。
Frequency	String	0 /20 * * *	周期任务的执行周期。该参数值结构以Cron表达式为准。
InvokeId	String	t-7d2a745b412b4601b2d47f6a768d3***	执行ID。
InvokeInstances	Array		执行目标实例集类型。
InvokeInstance
CreationTime	String	2019-12-20T06:15:54Z	脚本进程的创建时间。
Dropped	Integer	0	Output字段中文字长度超出24KB后，截断丢弃的文字长度。
ErrorCode	String	InstanceNotExists	命令的下发失败或执行失败原因的代码，可能值：空：命令运行正常 InstanceNotExists：指定的实例不存在或已释放 InstanceReleased：执行任务期间，该实例被释放 InstanceNotRunning：创建任务时，该实例不在运行中 CommandNotApplicable：命令不适用于指定的实例 AccountNotExists：指定的帐号不存在 DirectoryNotExists：指定的目录不存在 BadCronExpression：指定的周期表达式不合法 ClientNotRunning：云助手客户端未运行 ClientNotResponse：云助手客户端无响应 ClientIsUpgrading：云助手客户端正在升级中 ClientNeedUpgrade：云助手客户端需要升级 DeliveryTimeout：发送命令超时 ExecutionTimeout：命令运行超时 ExecutionException：命令运行发生异常 ExecutionInterrupted：命令运行任务中断 ExitCodeNonzero：命令执行结束，退出码非0
ErrorInfo	String	the specified instance does not exists	命令的下发失败或执行失败原因的详情，可能值：空：命令运行正常 the specified instance does not exists：指定的实例不存在或已释放 the instance has released when create task：执行任务期间，该实例被释放 the instance is not running when create task：创建任务时，该实例不在运行中 the command is not applicable：命令不适用于指定的实例 the specified account does not exists：指定的帐号不存在 the specified directory does not exists：指定的目录不存在 the cron job expression is invalid：指定的周期表达式不合法 the aliyun service is not running on the instance：云助手客户端未运行 the aliyun service in the instance does not response：云助手客户端无响应 the aliyun service in the instance is upgrading now：云助手客户端正在升级中 the aliyun service in the instance need upgrade：云助手客户端需要升级 the command delivery has been timeout：发送命令超时 the command execution has been timeout：命令运行超时 the command execution got an exception：命令运行发生异常 the command execution has been interrupted：命令运行任务中断 the command execution exit code is not zero：命令执行结束，退出码非0
ExitCode	Long	0	脚本进程的退出代码。可能值： Linux实例为Shell进程的退出码 Windows实例为Bat或者PowerShell进程的退出码
FinishTime	String	2019-12-20T06:15:56Z	脚本进程的结束时间。
InstanceId	String	i-uf614fhehhz***	实例ID。
InstanceInvokeStatus	String	Finished	单台实例的脚本进程状态。可能值： Running：周期执行：未手动停止周期执行脚本前，脚本进程一直为进行中单次执行：进行中 Finished：周期执行：不可能为执行完成单次执行：执行完成 Failed：周期执行：不可能为执行失败单次执行：执行失败 Stopped：停止脚本执行 PartialFailed：周期执行：不可能为部分失败单次执行：部分实例有执行失败的脚本进程，则总执行状态为部分失败
InvocationStatus	String	Success	单台实例的脚本进度状态，可能值： Pending：系统正在校验或发送命令 Invalid：指定命令类型或参数有误 Aborted：向实例发送命令失败。实例必须在运行中，且命令可以1分钟内发送完成 Running：命令正在实例上运行 Success：立即运行的任务：命令执行完成，且退出码为0 周期运行的任务：上一次运行成功且退出码为0，且指定的周期已结束 Failed：立即运行的任务：命令执行完成，且退出码非0 周期运行的任务：上一次运行成功且退出码非0，且指定的周期将中止 Error：命令执行时发生异常无法继续 Timeout：命令执行超时 Cancelled：任务已经取消，命令未曾启动 Stopping：正在停止任务 Terminated：命令运行时被终止 Scheduled：立即运行的任务：不适用，不会出现周期运行的任务：等待运行
Output	String	hello world!	脚本进程的输出信息。
Repeats	Integer	0	命令在该实例上执行的次数。若执行方式为立即执行，则值为0或1 若执行方式为周期执行，则值为执行过多少次
StartTime	String	2019-12-20T06:15:55Z	脚本进程在实例中开始执行的时间。
StopTime	String	2020-01-19T09:15:47Z	若调用了`StopInvocation`，表示调用的时间。
UpdateTime	String	2020-01-19T09:15:47Z	任务状态的更新时间。
InvokeStatus	String	Finished	脚本总的执行状态。
Parameters	String	AccessKeyID	脚本中的自定义参数。
Timed	Boolean	false	是否为周期执行。
PageNumber	Long	1	查询结果的页码。
PageSize	Long	10	每页行数。
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	请求ID。
TotalCount	Long	2	脚本总个数。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeInvocations
&RegionId=cn-hangzhou
&InvokeId=t-7d2a745b412b4601b2d47f6a76******
&CommandId=c-4d34302d02424c5c8e10281e3a******
&CommandName=Test1
&CommandType=RunShellScrip
&Timed=true
&InvokeStatus=Finished
&InstanceId=i-uf614fhehhz***
&PageNumber=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML 格式

<DescribeInvocationsResponse>
      <PageNumber>1</PageNumber>
      <Invocations>
            <Invocation>
                  <CreationTime>2020-01-19T09:15:46Z</CreationTime>
                  <Parameters>{}</Parameters>
                  <CommandContent>ZWNobyAiaGVsbG8gd29ybGQiID4vcm9vdC90ZXN0Ln****==</CommandContent>
                  <CommandName>exec-2dbb68f9584c4aa6****.t0004</CommandName>
                  <CommandType>RunShellScript</CommandType>
                  <InvokeStatus>Finished</InvokeStatus>
                  <InvokeId>t-hz0869nmkt****</InvokeId>
                  <InvokeInstances>
                        <InvokeInstance>
                              <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
                              <InvocationStatus>Success</InvocationStatus>
                              <ExitCode>0</ExitCode>
                              <Dropped>0</Dropped>
                              <InstanceId>i-bp10ig21389wok8e****</InstanceId>
                              <UpdateTime>2020-01-19T09:15:47Z</UpdateTime>
                              <Output></Output>
                              <Repeats>1</Repeats>
                              <ErrorInfo></ErrorInfo>
                              <CreationTime>2020-01-19T09:15:46Z</CreationTime>
                              <FinishTime>2020-01-19T09:15:47Z</FinishTime>
                              <StopTime></StopTime>
                              <StartTime>2020-01-19T09:15:47Z</StartTime>
                              <ErrorCode></ErrorCode>
                        </InvokeInstance>
                  </InvokeInstances>
                  <Timed>false</Timed>
                  <Frequency></Frequency>
                  <CommandId>c-hz0869nmkl****</CommandId>
            </Invocation>
      </Invocations>
      <TotalCount>1</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>6CABE05A-68F7-418F-B27C-710929A64F33</RequestId>
</DescribeInvocationsResponse>

JSON 格式

{
	"PageNumber": 1,
	"Invocations": {
		"Invocation": [
			{
				"CreationTime": "2020-01-19T09:15:46Z",
				"Parameters": "{}",
				"CommandContent": "ZWNobyAiaGVsbG8gd29ybGQiID4vcm9vdC90ZXN0Ln****==",
				"CommandName": "exec-2dbb68f9584c4aa6****.t0004",
				"CommandType": "RunShellScript",
				"InvokeStatus": "Finished",
				"InvokeId": "t-hz0869nmkt****",
				"InvokeInstances": {
					"InvokeInstance": [
						{
							"InstanceInvokeStatus": "Finished",
							"InvocationStatus": "Success",
							"ExitCode": 0,
							"Dropped": 0,
							"InstanceId": "i-bp10ig21389wok8e****",
							"UpdateTime": "2020-01-19T09:15:47Z",
							"Output": "",
							"Repeats": 1,
							"ErrorInfo": "",
							"CreationTime": "2020-01-19T09:15:46Z",
							"FinishTime": "2020-01-19T09:15:47Z",
							"StopTime": "",
							"StartTime": "2020-01-19T09:15:47Z",
							"ErrorCode": ""
						}
					]
				},
				"Timed": false,
				"Frequency": "",
				"CommandId": "c-hz0869nmkl****"
			}
		]
	},
	"TotalCount": 1,
	"PageSize": 10,
	"RequestId": "6CABE05A-68F7-418F-B27C-710929A64F33"
}

错误码


HttpCode	错误码	错误信息	描述
500	InternalError.Dispatch	An error occurred when you dispatched the request.	发送请求时发生错误，请稍后重试。
403	InvalidParam.PageNumber	The specified parameter is invalid.	指定的参数无效。
403	InvalidParam.PageSize	The specified parameter is invalid.	指定的参数无效。

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