调用DescribeInvocationResults查看一条或多条云助手命令的执行结果,即在ECS实例中的实际执行结果。

接口说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInvocationResults

系统规定参数。取值:DescribeInvocationResults

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

InvokeId String t-7d2a745b412b4601b2d47f6a768d3***

命令执行ID。命令进程执行ID。您可以通过接口DescribeInvocations查询InvokeId。

InstanceId String i-bp10ua7jvif75ha81***

实例ID。

CommandId String c-4d34302d02424c5c8e10281e3a315***

命令ID。

InvokeRecordStatus String Finished

命令执行状态。取值范围:

  • Running:运行中
  • Finished:已完成
  • Failed:失败
  • Stopped:已停止
IncludeHistory Boolean false

是否返回周期性任务的历史记录。取值范围:

  • true :表示返回周期性任务的执行结果。当取值为true时,参数InvokeId的取值不能为空,且必须为周期性任务的执行ID。
  • false :表示不返回。

默认值:false。

PageNumber Long 1

当前页码,起始值:1。

默认值:1。

PageSize Long 1

分页查询时设置的每页行数。

最大值:50。

默认值:10。

返回数据

名称 类型 示例值 描述
Invocation Struct

命令执行结果的集合。

InvocationResults Array

命令执行结果集。

InvocationResult
CommandId String c-4d34302d02424c5c8e10281e3a315***

命令ID。

ExitCode Long 0

命令进程的退出码。

  • Linux实例为Shell进程的退出码。
  • Windows实例为Bat或者PowerShell进程的退出码。
FinishedTime String 2018-01-05 15:45:02

命令进程的完成时间。如果命令进程出现超时情况,命令进程的完成时间以CreateCommand中指定的参数TimedOut为准。

InstanceId String i-uf614fhehhzmx***

实例ID。

InvokeId String t-7d2a745b412b4601b2d47f6a768d3***

命令执行ID。

InvokeRecordStatus String Finished

命令执行状态。

Output String MTU6MzA6MDEK

命令进程完成后的实际结果,输出内容以Base64编码的形式传输。

StartTime String hide

开始执行的时间。

PageNumber Long 1

当前页码。

PageSize Long 1

分页查询时设置的每页行数。

TotalCount Long 1

命令总个数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeInvocationResults
&RegionId=cn-hangzhou
&InstanceId=i-bp10ua7jvif75ha81***
&PageNumber=1
&PageSize=1
&<公共请求参数>

正常返回示例

XML 格式

<DescribeInvocationResultsResponse>
      <RequestId>919C8FD6-0BC1-4259-A6EA-5B400365A4AF</RequestId>
      <Invocation>
            <PageNumber>1</PageNumber>
            <TotalCount>1</TotalCount>
            <InvocationResults>
                  <InvocationResult>
                        <InvokeRecordStatus>Running</InvokeRecordStatus>
                        <FinishedTime></FinishedTime>
                        <InstanceId>i-bp10ua7jvif75ha81***</InstanceId>
                        <Output>MTU6NDU6MDEK</Output>
                        <ExitCode>0</ExitCode>
                        <InvokeId>t-c6d11006a9374619838af10a2b095***</InvokeId>
                        <StartTime>2018-08-01T02:36:20Z</StartTime>
                        <CommandId>c-1791e8b850f44949aba6c883ad3e***c</CommandId>
                  </InvocationResult>
            </InvocationResults>
            <PageSize>1</PageSize>
      </Invocation>
</DescribeInvocationResultsResponse>

JSON 格式

{
	"RequestId": "919C8FD6-0BC1-4259-A6EA-5B400365A4AF",
	"Invocation": {
		"PageNumber": 1,
		"TotalCount": 1,
		"InvocationResults": {
			"InvocationResult": [
				{
					"InvokeRecordStatus": "Running",
					"FinishedTime": "",
					"InstanceId": "i-bp10ua7jvif75ha81***",
					"Output": "MTU6NDU6MDEK",
                    "ExitCode": 0,
					"InvokeId": "t-c6d11006a9374619838af10a2b095***",
					"StartTime": "2018-08-01T02:36:20Z",
					"CommandId": "c-1791e8b850f44949aba6c883ad3e5***"
				}
			]
		},
		"PageSize": 1
	}
}

错误码

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. 指定的参数无效。

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