Use DescribeInvocationResults to query Cloud Assistant command execution results - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the execution results of one or more Cloud Assistant commands, that is, the actual execution results on ECS instances.

Operation description

After you execute a command, the command is not guaranteed to succeed or produce the expected results. Call this operation to view the actual execution results, which are based on the actual output.
You can query execution information from the last 30 days. A maximum of 10,000 records of execution information can be retained.
You can subscribe to Cloud Assistant task status events to obtain task results through events, avoiding frequent polling and improving efficiency.
When querying the first page of a paging query, set only MaxResults to limit the number of entries returned. The NextToken value returned in the result serves as the credential for querying subsequent pages. When querying subsequent pages, set NextToken to the value obtained from the previous response and set MaxResults to limit the number of entries returned.
Differences between DescribeInvocations and DescribeInvocationResults:
- When a single RunCommand/InvokeCommand call specifies multiple instances:
  - DescribeInvocations returns the execution status on each instance and the aggregation status across multiple instances.
  - DescribeInvocationResults returns only the individual execution status on each instance, without the aggregation status across multiple instances.
- When a single RunCommand/InvokeCommand call specifies one instance:
  - DescribeInvocations and DescribeInvocationResults are largely interchangeable. You can replace one with the other.
- When you need to view the execution details of scheduled (periodic) tasks or tasks that execute at each system startup (RepeatMode=Period, EveryReboot), only DescribeInvocationResults can return the history of past execution records (you must specify IncludeHistory=true). DescribeInvocations returns only the latest task status.
- When you need to view the command content or parameters, only DescribeInvocations returns CommandContent.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeInvocationResults

get

Command

acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group to which the command execution belongs. After you specify this parameter, you must also specify ResourceGroupId when running the command. This parameter filters the corresponding command execution results.	rg-bp67acfmxazb4p****
RegionId	string	Yes	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
InvokeId	string	No	The command execution ID. You can call DescribeInvocations to query the InvokeId.	t-hz0jdfwd9f****
InstanceId	string	No	The instance ID.	i-bp1i7gg30r52z2em****
CommandId	string	No	The command ID.	c-hz0jdfwcsr****
InvokeRecordStatus	string	No	The execution status of the command. Valid values: Running: The command is running. Scheduled execution: The execution status remains running until you manually stop the scheduled command. One-time execution: The overall execution status is running as long as any command process is running. Finished: The command execution is complete. Scheduled execution: The command process cannot have a status of finished. One-time execution: All instances have completed execution, or you manually stopped the command process on some instances and the remaining instances have completed execution. Success: One-time execution: The command execution is complete and the exit code is 0. Scheduled execution: The last execution succeeded with an exit code of 0, and the specified execution time has ended. Failed: The command execution failed. Scheduled execution: The command process cannot have a status of failed. One-time execution: All instances failed to execute the command. PartialFailed: The command execution partially failed. Scheduled execution: The command process cannot have a status of partially failed. One-time execution: Some instances have failed command processes, so the overall execution status is partially failed. Stopped: The command execution has been stopped. Stopping: The command execution is being stopped.	Running
IncludeHistory	boolean	No	Specifies whether to return the history records of scheduled command executions. Valid values: true: Returns the results of scheduled command executions. When this parameter is set to true, InvokeId cannot be empty and must be the execution ID of a scheduled command (RepeatMode is Period) or a command that executes at each system startup (RepeatMode is EveryReboot). false: Does not return the history. Default value: false.	false
ContentEncoding	string	No	The encoding type of the CommandContent and Output fields in the response. Valid values: PlainText: Returns the original command content and output. Base64: Returns Base64-encoded command content and output. Default value: Base64.	PlainText
PageNumber	integer	No	Note This parameter is about to be deprecated. Use NextToken and MaxResults to complete paging query operations.	1
PageSize	integer	No	Note This parameter is about to be deprecated. Use NextToken and MaxResults to complete paging query operations.	1
MaxResults	integer	No	The maximum number of entries per page for a paging query. Maximum value: 50. Default value: 10.	10
NextToken	string	No	The pagination token. Set this parameter to the NextToken value returned in the previous API call.	AAAAAdDWBF2
Tag	array<object>	No	The tags.
	object	No	The tags.
Value	string	No	The tag value of the command execution. 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://`.	TestValue
Key	string	No	The tag key of the command execution. Valid values of N: 1 to 20. The tag key cannot be an empty string. If you use a single tag to filter resources, the resource count with this tag cannot exceed 1,000. If you use multiple tags to filter resources, the resource count with all specified tags attached cannot exceed 1,000. If the resource count exceeds 1,000, call ListTagResources to execute the query. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	TestKey

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE*****
Invocation	object	The collection of command execution results.
PageSize	integer	The number of entries per page in the paging query.	1
PageNumber	integer	The current page number.	1
TotalCount	integer	The total number of commands.	1
NextToken	string	The pagination token returned in this call.	AAAAAdDWBF2
InvocationResults	object
InvocationResult	array<object>	The maximum number of entries per page. Valid values: 1 to 50. Default value: 10.
	array<object>
Dropped	integer	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	0
OssOutputDelivery	string	The tags of the command task.	oss://testBucket/testPrefix
InvocationStatus	string	The tag of the command task.	Success
InstanceId	string	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://`.	i-bp1i7gg30r52z2em****
ExitCode	integer	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://`.	0
ErrorInfo	string	The ID of the request.	the specified instance does not exists
StartTime	string	Details about the execution results.	2019-12-20T06:15:55Z
Repeats	integer	The number of entries per page.	0
InvokeRecordStatus	string	The page number.	Running
FinishedTime	string	The total number of the commands.	2019-12-20T06:15:56Z
OssOutputUri	string	A pagination token. It can be used in the next request to retrieve a new page of results.	oss://testBucket/testPrefix/output.txt
OssOutputStatus	string	The execution results.	Finished
OssOutputErrorCode	string	The error code when delivery fails. This field is returned only when OssOutputStatus is Failed. Valid values: CloudAssistant.UnsupportedInvocationStatus: The job status does not support delivery. CloudAssistant.ClientNeedUpgrade: The Cloud Assistant version does not support delivery. For Linux instances, the Cloud Assistant version must be later than 2.2.4.1007. For Windows instances, the Cloud Assistant version must be later than 2.1.4.1007. OSS.AccessDenied: The user does not have access permissions to the specified bucket. OSS.NoSuchBucket: The specified bucket does not exist. OSS.FileImmutable: The data in the bucket is in a protection status. OSS.InvalidObjectName: The object name is invalid. This includes cases where no object name is specified, the object name exceeds the length limit, or the specified object name is invalid.	CloudAssistant.UnsupportedInvocationStatus
OssOutputErrorInfo	string	The error details when delivery fails. This field is returned only when OssOutputStatus is Failed.	The invocation status does not support output delivery.
Username	string	The size of the Output text that was truncated and discarded because the `Output` value exceeded 24 KB in size.	test
ContainerId	string	Command to execute the Output OSS delivery configuration.	ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
ContainerName	string	The execution status 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 the instance. To send a command to an instance, make sure that the instance is in the Running state and the command can be sent to the instance within 1 minute. Running: The command is being run on the instance. Success: One-time task: The execution was complete, and the exit code was 0. Scheduled task: The last execution was complete, the exit code was 0, and the specified period ended. Failed: One-time task: The execution was complete, but the exit code was not 0. Scheduled task: The last execution was complete, but the exit code was not 0. The specified period was about to end. Error: The execution cannot proceed due to an exception. Timeout: The execution timed out. Cancelled: The execution was canceled before it started. Stopping: The command task is being stopped. Terminated: The execution was terminated before completion. Scheduled: One-time task: The execution state can never be Scheduled. Scheduled task: The command is waiting to be run.	test-container
Output	string	The instance ID.	MTU6MzA6MDEK
Launcher	string	The exit code of the command task. 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.	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}
CommandId	string	The error message returned when the command failed to be sent or run. Valid values: If this parameter is empty, the command was run as expected. The security group rules denied access to the aliyun service. The specified instance does not exist. The specified instance was released during task execution. The specified instance was not running during task execution. The OS type of the instance does not support the specified command type. The specified account does not exist. The specified directory does not exist. The cron 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 during task execution. The aliyun service in the instance need to be upgraded to at least version to support the feature. indicates the earliest version that supports the feature. indicates the name of the feature. The command delivery has been timeout. The command execution has been timeout. The command execution got an exception. The command execution exit code is not zero. The specified instance was released during task execution.	c-hz0jdfwcsr****
ErrorCode	string	The time when the command started to be run on the instance.	InstanceNotExists
InvokeId	string	The number of times that the command was run on the instance. If the command is set to run only once, the value is 0 or 1. If the command is set to run on a schedule, the value is the number of times that the command has been run on the instance.	t-hz0jdfwd9f****
TerminationMode	string	The execution status of the command. Valid values: Running: Scheduled task: Before you stop the scheduled execution of the command, the execution state is always Running. One-time task: If the command is being run on instances, the execution state is Running. Finished: Scheduled task: The execution state can never be Finished. One-time task: The execution was complete on all instances, or the execution was stopped on some instances and was complete on the other instances. Failed: Scheduled task: The execution state can never be Failed. One-time task: The execution failed on all instances. PartialFailed: Scheduled task: The execution state can never be PartialFailed. One-time task: The execution failed on some instances. Stopped: The task was stopped. Stopping: The task is being stopped.	ProcessTree
Tags	object
Tag	array<object>	The time when the command task was completed. If the command task times out, the end time is equal to the start time of the command task specified by `StartTime` plus the timeout period specified by `Timeout`.
	object	The command execution Output delivers the object URI to OSS. This field is an empty string when the delivery fails or is in progress.
TagKey	string	The output delivery status of the command execution. Valid values: InProgress: The delivery is in progress. Finished: The delivery is complete. Failed: The delivery failed.	owner
TagValue	string	The username used to run the command on the instance.	zhangsan
StopTime	string	root	2020-01-19T09:15:47Z

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "Invocation": {
    "PageSize": 1,
    "PageNumber": 1,
    "TotalCount": 1,
    "NextToken": "AAAAAdDWBF2",
    "InvocationResults": {
      "InvocationResult": [
        {
          "Dropped": 0,
          "OssOutputDelivery": "oss://testBucket/testPrefix",
          "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",
          "OssOutputUri": "oss://testBucket/testPrefix/output.txt",
          "OssOutputStatus": "Finished",
          "OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
          "OssOutputErrorInfo": "The invocation status does not support output delivery.",
          "Username": "test",
          "ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
          "ContainerName": "test-container",
          "Output": "MTU6MzA6MDEK",
          "Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
          "CommandId": "c-hz0jdfwcsr****",
          "ErrorCode": "InstanceNotExists",
          "InvokeId": "t-hz0jdfwd9f****",
          "TerminationMode": "ProcessTree",
          "Tags": {
            "Tag": [
              {
                "TagKey": "owner",
                "TagValue": "zhangsan"
              }
            ]
          },
          "StopTime": "2020-01-19T09:15:47Z"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	RegionId.ApiNotSupported	The api is not supported in this region.	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.	The number of tags exceeds the maximum limit.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	The specified tag key already exists. Tag keys must be unique.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	The specified Tag.N.Key parameter is invalid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	The specified tag value is invalid.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	The tag key is not specified.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.	The specified parameter NextToken is illegal.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	The specified parameter MaxResults is illegal.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	An error occurred while the request is being sent. Try again later.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
500	InternalError	The request processing has failed due to some unknown error.
403	Operation.Forbidden	The operation is not permitted.	The operation is not supported.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.