DescribeInvocationResults - Elastic Compute Service - Alibaba Cloud Documentation Center

Description

After you run a command, the command may not succeed or return the expected results. You can call this operation to query the actual execution results.
You can query information about command executions within the last four 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.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	The ID of the resource group. After you set this parameter, command execution results in the specified resource group are queried.
InvokeId	String	No	t-hz0jdfwd9f****	The ID of the command task. You can call the DescribeInvocations operation to query the command task 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 state of the command. Valid values: Running Finished Failed Stopped Note We recommend that you use the `InvocationStatus` parameter instead of the InvokeRecordStatus parameter to ensure compatibility.
IncludeHistory	Boolean	No	false	Specifies whether to return the results of historical scheduled executions. Valid values: true: returns the results of historical scheduled executions. When this parameter is set to true, the `InvokeId` parameter must be set to the ID of a scheduled task. false: does not return the results of historical scheduled executions. Default value: false.
ContentEncoding	String	No	PlainText	The encoding method of the `Output` response parameter. Valid values: PlainText: returns the original command content and command output. Base64: returns the 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.
Tag.N.Key	String	No	TestKey	The key of tag N of the command task. Valid values of N: 1 to 20. The tag key cannot be an empty string. If a single tag is specified to query resources, up to 1,000 resources that have this tag added can be displayed in the response. If multiple tags are specified to query resources, up to 1,000 resources that have all these tags added can be displayed in the response. To query more than 1,000 resources that have specified tags added, call the ListTagResources operation. The tag key can be up to 64 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.
Tag.N.Value	String	No	TestValue	The value of tag N of the command task. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.

Response parameters


Parameter	Type	Example	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE*****	The ID of the request.
Invocation	Object		Details of the execution results.
PageSize	Long	1	The number of entries returned per page.
PageNumber	Long	1	The page number of the returned page.
TotalCount	Long	1	The total number of the commands.
InvocationResults	Array of InvocationResult		The execution results.
InvocationResult
InvocationStatus	String	Success	The execution state on a single instance. Valid values: Pending: The command is being verified or sent. Invalid: The specified command type or parameter is invalid. Aborted: The command failed to be sent. To send a command to an instance, make sure that the instance is in the Running state and the command is sent to the instance within 1 minute. Running: The command is being run on the instance. Success: Command that is set to run only once: The execution is complete, and the exit code is 0. Command that is set to run on a schedule: The last execution succeeds, the exit code is 0, and the specified cycle ends. Failed: Command that is set to run only once: The execution is complete, but the exit code is not 0. Command that is set to run on a schedule: 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 execution is canceled, and the command is not run. Stopping: The running command is being stopped. Terminated: The command is terminated while it is being run. Scheduled: Command that is set to run only once: The command is not applicable. Command that is set to run on a schedule: The command is waiting to be run.
Repeats	Integer	0	The number of times that the command is run on the instance. If the command is set to run only once on the instance, the value is 0 or 1. If the command is set to run on a schedule on the instance, the value is the number of times that the command is run.
CommandId	String	c-hz0jdfwcsr****	The ID of the command.
InstanceId	String	i-bp1i7gg30r52z2em****	The ID of the instance.
Output	String	MTU6MzA6MDEK	The command output.
Dropped	Integer	0	The size of the text that is truncated and discarded when the `Output` value exceeds 24 KB in size.
StopTime	String	2020-01-19T09:15:47Z	The time when the command stopped being run on the instance. If you call the `StopInvocation` operation to manually stop the execution, the value is the time when you called the operation.
ExitCode	Long	0	The exit code of the command execution. For Linux instances, the value is the exit code of the shell command. For Windows instances, the value is the exit code of the batch or PowerShell command.
StartTime	String	2019-12-20T06:15:55Z	The time when the command started to be run on the instance.
ErrorInfo	String	the specified instance does not exists	The error message returned when the command cannot be sent or run. Valid values: If this parameter is empty, the command is run 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
ErrorCode	String	InstanceNotExists	The error code returned when the command cannot be sent or run. Valid values: If this parameter is empty, the command is run normally. InstanceNotExists: The instance does not exist or has been released. InstanceReleased: The instance was released while the command was being run. InstanceNotRunning: The instance was not running while the command was being run. 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 cron expression used to specify a schedule is invalid. ClientNotRunning: The Cloud Assistant client is not running. ClientNotResponse: The Cloud Assistant client does not respond. ClientIsUpgrading: The Cloud Assistant client is being upgraded. ClientNeedUpgrade: The Cloud Assistant client needs to be upgraded. DeliveryTimeout: The request to send the command timed out. ExecutionTimeout: The execution timed out. ExecutionException: An exception occurred while the command was being run. ExecutionInterrupted: The execution was interrupted. ExitCodeNonzero: The execution is complete, but the exit code is not 0.
FinishedTime	String	2019-12-20T06:15:56Z	The end time of the execution. If an execution times out, the end time of the execution is subject to the value of the TimedOut parameter specified in the CreateCommand operation.
InvokeId	String	t-hz0jdfwd9f****	The ID of the command task.
InvokeRecordStatus	String	Running	The execution state of the command.
Username	String	root	The username that was used to run the command on the instance.
ContainerId	String	ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****	The ID of the container.
ContainerName	String	test-container	The name of the container.
Tags	Array of Tag		The tags of the command task.
Tag
TagKey	String	owner	The tag key of the command task.
TagValue	String	zhangsan	The tag value of the command task.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=DescribeInvocationResults
&RegionId=cn-hangzhou
&InstanceId=i-bp1i7gg30r52z2em****
&PageNumber=1
&PageSize=1
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInvocationResultsResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE*****</RequestId>
    <Invocation>
        <InvocationResults>
            <InvocationResult>
                <Dropped>0</Dropped>
                <InvocationStatus>Success</InvocationStatus>
                <InstanceId>i-bp1i7gg30r52z2em****</InstanceId>
                <ExitCode>0</ExitCode>
                <ErrorInfo>the specified instance does not exists</ErrorInfo>
                <StartTime>2019-12-20T06:15:55Z</StartTime>
                <Repeats>0</Repeats>
                <InvokeRecordStatus>Running</InvokeRecordStatus>
                <FinishedTime>2019-12-20T06:15:56Z</FinishedTime>
                <Output>MTU6MzA6MDEK</Output>
                <CommandId>c-hz0jdfwcsr****</CommandId>
                <ErrorCode>InstanceNotExists</ErrorCode>
                <InvokeId>t-hz0jdfwd9f****</InvokeId>
                <StopTime>2020-01-19T09:15:47Z</StopTime>
                <ContainerId>ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****</ContainerId>
                <ContainerName>test-container</ContainerName>
                <Tags>
                    <TagKey>owner</TagKey>
                    <TagValue>zhangsan</TagValue>
                </Tags>
            </InvocationResult>
        </InvocationResults>
        <TotalCount>1</TotalCount>
        <PageSize>1</PageSize>
        <PageNumber>1</PageNumber>
    </Invocation>
</DescribeInvocationResultsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "Invocation" : {
    "InvocationResults" : {
      "InvocationResult" : [ {
        "Dropped" : 0,
        "InvocationStatus" : "Success",
        "InstanceId" : "i-bp1i7gg30r52z2em****",
        "ExitCode" : 0,
        "ErrorInfo" : "the specified instance does not exists",
        "StartTime" : "2019-12-20T06:15:55Z",
        "Repeats" : 0,
        "InvokeRecordStatus" : "Running",
        "FinishedTime" : "2019-12-20T06:15:56Z",
        "Output" : "MTU6MzA6MDEK",
        "CommandId" : "c-hz0jdfwcsr****",
        "ErrorCode" : "InstanceNotExists",
        "InvokeId" : "t-hz0jdfwd9f****",
        "StopTime" : "2020-01-19T09:15:47Z",
        "ContainerId" : "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
        "ContainerName" : "test-container",
        "Tags" : [ {
          "TagKey" : "owner",
          "TagValue" : "zhangsan"
        } ]
      } ]
    },
    "TotalCount" : 1,
    "PageSize" : 1,
    "PageNumber" : 1
  }
}

Error codes


HTTP status code	Error code	Error message	Description
400	RegionId.ApiNotSupported	The api is not supported in this region.	The error message returned because the API operation cannot be called in the specified region. Check whether the specified RegionId parameter is valid.
400	NumberExceed.Tags	The Tags parameter number is exceed , Valid : 20	The error message returned because more than 20 tags are specified.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	The error message returned because the specified tag key already exists. Tag keys must be unique.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	The error message returned because the specified Tag.N.Key parameter is invalid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	The error message returned because the specified Tag.N.Value parameter is invalid.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	The error message returned because the Tag.N.Key parameter is not specified.
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.
403	Operation.Forbidden	The operation is not permitted.	The error message returned because the operation is not supported.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	The error message returned because an error occurred while the request was being sent. Try again later.

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