You can call this operation to query the execution results of one or more Cloud Assistant commands on ECS instances.

Description

  • After you run a command, it may not succeed. You can call this operation to query the actual execution results.
  • You can query the execution information within the last two weeks. A maximum of 100,000 pieces of execution information can be retained.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInvocationResults

The operation that you want to perform. Set the value to DescribeInvocationResults.

RegionId String Yes cn-hangzhou

The region ID of the command. You can call the DescribeRegions operation to query the most recent region list.

InvokeId String No t-hz0jdfwd9f****

The ID of the execution. You can call the DescribeInvocations operation to query the execution IDs.

InstanceId String No i-bp1i7gg30r52z2em****

The ID of the instance.

CommandId String No c-hz0jdfwcsr****

The ID of the command.

InvokeRecordStatus String No Running

The execution status of the command. Valid values:

  • Running
  • Finished
  • Failed
  • Stopped
IncludeHistory Boolean No false

Specifies whether to return the historical records of scheduled invocations. Valid values:

  • true: The execution results of scheduled invocations are returned. When this parameter is set to true, the InvokeId parameter must be set to the ID of the scheduled invocation.
  • false: No execution results of scheduled invocations are returned.

Default value: false.

ContentEncoding String No PlainText

Specifies the encoding method of the Output response parameter. Valid values:

  • PlainText: returns the original command content and command output.
  • Base64: returns Base64-encoded command content and command output.

Default value: Base64.

PageNumber Long No 1

The number of the page to return. Pages start from page 1.

Default value: 1.

PageSize Long No 1

The number of entries to return on each page.

Maximum value: 50.

Default value: 10.

Response parameters

Parameter Type Example Description
Invocation Struct

The collection of command execution results.

InvocationResults Array

Details about the command execution results.

InvocationResult
CommandId String c-hz0jdfwcsr****

The ID of the command.

Dropped Integer 0

The size of truncated and discarded text when the size of text in the Output field is larger than 24 KB.

ErrorCode String InstanceNotExists

The code for the cause why the command fails to be sent or executed. Valid values:

  • Null: The command runs normally.
  • InstanceNotExists: The instance does not exist or is released.
  • InstanceReleased: The instance is released while the task is being executed.
  • InstanceNotRunning: The instance is not running when the task is being created.
  • CommandNotApplicable: The command is not applicable to the specified instance.
  • AccountNotExists: The specified account does not exist.
  • DirectoryNotExists: The specified directory does not exist.
  • BadCronExpression: The specified cron expression for the execution cycle is invalid.
  • ClientNotRunning: The Cloud Assistant client is not running.
  • ClientNotResponse: The Cloud Assistant client is not responding.
  • ClientIsUpgrading: The Cloud Assistant client is being upgraded.
  • ClientNeedUpgrade: The Cloud Assistant client needs to be upgraded.
  • DeliveryTimeout: The request times out.
  • ExecutionTimeout: The execution times out.
  • ExecutionException: An exception occurs when the command is running.
  • ExecutionInterrupted: The execution is interrupted.
  • ExitCodeNonzero: The execution is complete but the exit code is not 0.
ErrorInfo String the specified instance does not exists

The detailed cause why a command fails to be sent or executed . Valid values:

  • Null: The command runs normally
  • 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
ExitCode Long 0

The exit code of the command execution.

  • For Linux instances, the exit code is the exit code of the shell process.
  • For Windows instances, the exit code is the exit code of the batch or PowerShell process.
FinishedTime String 2019-12-20T06:15:56Z

The time when the command execution was complete. If an execution times out, the completion time of the execution is subject to the value of the TimedOut parameter specified in the CreateCommand operation.

InstanceId String i-bp1i7gg30r52z2em****

The ID of the instance.

InvocationStatus String Success

The command execution status on a single instance. Valid values:

  • Pending: The system is verifying or sending the command.
  • Invalid: The specified command type or parameter is invalid.
  • Aborted: The command fails to be sent. The instance must be in the Running state and the command can be sent within one minute.
  • Running: The command is running on the instance.
  • Success:
    • One-time invocation: The command execution is complete and the exit code is 0.
    • Scheduled invocation: The last execution succeeds, the exit code is 0, and the specified cycle has ended.
  • Failed:
    • One-time invocation: The command execution is complete but the exit code is not 0.
    • Scheduled invocation: The last execution is complete, the exit code is not 0, and the specified cycle is about to end.
  • Error: The execution cannot proceed due to an exception.
  • Timeout: The execution times out.
  • Cancelled: The task has been canceled and the command has not been started.
  • Stopping: The task is being stopped.
  • Terminated: The command is terminated when it is running.
  • Scheduled:
    • One-time invocation: not applicable.
    • Scheduled invocation: The command is waiting to be run.
InvokeId String t-hz0jdfwd9f****

The ID of the command execution.

InvokeRecordStatus String Running

The execution status of the command.

Output String MTU6MzA6MDEK

The output of the command execution.

Repeats Integer 0

The number of executions on this instance.

  • If the execution mode is one-time invocation, the value is 0 or 1.
  • If the execution mode is scheduled invocation, the value is the number of executions that have occurred.
StartTime String 2019-12-20T06:15:55Z

The time when the command started to be executed in the instance.

StopTime String 2020-01-19T09:15:47Z

The time when you called the StopInvocation operation to manually stop the command execution.

PageNumber Long 1

The page number of the returned page.

PageSize Long 1

The number of entries returned per page.

TotalCount Long 1

The total number of commands.

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

The ID of the request.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeInvocationResults
&RegionId=cn-hangzhou
&InstanceId=i-bp1i7gg30r52z2em****
&PageNumber=1
&PageSize=1
&<Common request parameters>

Sample success responses

XML format

<DescribeInvocationResultsResponse>
      <RequestId>F416C43A-6581-4138-9503-4FBBC4EA1BB7</RequestId>
      <Invocation>
            <InvocationResults>
                  <InvocationResult>
                        <Dropped>0</Dropped>
                        <InvocationStatus>Failed</InvocationStatus>
                        <InstanceId>i-bp1i7gg30r52z2em****</InstanceId>
                        <ExitCode>1</ExitCode>
                        <ErrorInfo>the command execution exit code is not zero. </ErrorInfo>
                        <StartTime>2020-05-11T09:01:40Z</StartTime>
                        <Repeats>1</Repeats>
                        <InvokeRecordStatus>Finished</InvokeRecordStatus>
                        <FinishedTime>2020-05-11T09:01:41Z</FinishedTime>
                        <Output></Output>
                        <CommandId>c-hz0jdfwcsr****</CommandId>
                        <ErrorCode>ExitCodeNonzero</ErrorCode>
                        <InvokeId>t-hz0jdfwd9f****</InvokeId>
                        <StopTime></StopTime>
                  </InvocationResult>
            </InvocationResults>
            <TotalCount>5</TotalCount>
            <PageSize>1</PageSize>
            <PageNumber>1</PageNumber>
      </Invocation>
</DescribeInvocationResultsResponse>

JSON format

{
    "RequestId": "F416C43A-6581-4138-9503-4FBBC4EA1BB7",
    "Invocation": {
        "InvocationResults": {
            "InvocationResult": [
                {
                    "Dropped": 0,
                    "InvocationStatus": "Failed",
                    "InstanceId": "i-bp1i7gg30r52z2em****",
                    "ExitCode": 1,
                    "ErrorInfo": "the command execution exit code is not zero.",
                    "StartTime": "2020-05-11T09:01:40Z",
                    "Repeats": 1,
                    "InvokeRecordStatus": "Finished",
                    "FinishedTime": "2020-05-11T09:01:41Z",
                    "Output": "",
                    "CommandId": "c-hz0jdfwcsr****",
                    "ErrorCode": "ExitCodeNonzero",
                    "InvokeId": "t-hz0jdfwd9f****",
                    "StopTime": ""
                }
            ]
        },
        "TotalCount": 5,
        "PageSize": 1,
        "PageNumber": 1
    }
}

Error codes

HTTP status code Error code Error message Description
500 InternalError.Dispatch An error occurred when you dispatched the request. The error message returned because an error occurred when the request was being sent. Try again later.
403 InvalidParam.PageNumber The specified parameter is invalid. The error message returned because the specified PageNumber parameter is invalid.
403 InvalidParam.PageSize The specified parameter is invalid. The error message returned because the specified PageSize parameter is invalid.

For a list of error codes, visit the API Error Center.