DescribeInvocations - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the execution list and states of Cloud Assistant commands.

Operation description

Usage notes

After you run a command, the command may not succeed or return the expected results. You can call this operation to query the execution results.
You can query information about command executions within the last four weeks. Up to 100,000 pieces of execution information can be retained.
You can use one of the following methods to check the responses:
- Method 1: During a paged query, when you call the DescribeInvocations operation to retrieve the first page of results, use MaxResults to specify the maximum number of entries to return in the call. The return value of NextToken is a pagination token, which you can use in the next request to retrieve a new page of results. When you call the DescribeInvocations operation to retrieve a new page of results, set NextToken to the NextToken value returned in the previous call and set MaxResults to specify the maximum number of entries to return in this call.
- Method 2: Use PageSize to specify the number of entries to return on each page, and then use PageNumber to specify the number of the page to return. You can use only one of the preceding methods. If you specify MaxResults or NextToken, the PageSize and PageNumber request parameters do not take effect and the TotalCount response parameter is invalid.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent list of regions.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group. After you set this parameter, command execution results in the specified resource group are queried.	rg-bp67acfmxazb4p****
InvokeId	string	No	The command task ID.	t-hz0jdfwd9f****
CommandId	string	No	The command ID. You can call the DescribeCommands operation to query all available command IDs.	c-hz0jdfwcsr****
CommandName	string	No	The command name. If you specify both this parameter and `InstanceId`, this parameter does not take effect.	CommandTestName
CommandType	string	No	The command type. Valid values: RunBatScript: batch command, applicable to Windows instances. RunPowerShellScript: PowerShell command, applicable to Windows instances. RunShellScript: shell command, applicable to Linux instances.	RunShellScript
Timed	boolean	No	Specifies whether the command is to be automatically run. Valid values: true: The command is run by calling the `RunCommand` or `InvokeCommand` operation with `RepeatMode` set to `Period`, `NextRebootOnly`, or `EveryReboot`. false: The command meets one of the following requirements: The command is run by calling the `RunCommand` or `InvokeCommand` operation with `RepeatMode` set to `Once`. The command task is canceled, stopped, or completed. Default value: false.	true
InvokeStatus	string	No	The overall execution status of the command task. The value of this parameter depends on the execution states of the command task on all involved instances. Valid values: Running: Scheduled task: Before you stop the scheduled execution of the command, the overall execution state is always Running. One-time task: If the command is being run on instances, the overall execution state is Running. Finished: Scheduled task: The overall execution state can never be Finished. One-time task: The execution is complete on all instances, or the execution is stopped on some instances and is complete on the other instances. Success: If the execution state on at least one instance is Success and the execution state on the other instances is Stopped or Success, the overall execution state is Success. One-time task: The execution is complete, and the exit code is 0. Scheduled task: The last execution is complete, the exit code is 0, and the specified period ends. Failed: Scheduled task: The overall execution state can never be Failed. One-time task: The execution fails on all instances. Stopped: The task is stopped. Stopping: The task is being stopped. PartialFailed: The task fails on some instances. If you specify both this parameter and `InstanceId`, this parameter does not take effect.	Finished
InstanceId	string	No	The ID of instance N. When you specify this parameter, the system queries all the execution records of all the commands that run on the instance.	i-bp1i7gg30r52z2em****
ContentEncoding	string	No	The encoding mode of the `CommandContent` and `Output` response parameters. Valid values: PlainText: returns the original command content and command outputs. Base64: returns the Base64-encoded command content and command outputs. Default value: Base64.	PlainText
IncludeOutput	boolean	No	Specifies whether to return the command outputs in the response. true: The command outputs are returned. When this parameter is set to true, you must specify `InvokeId`, `InstanceId`, or both. false: The command outputs are not returned. Default value: false	false
PageNumber	long	No	The page number of the page to return. Page numbers start from 1. Default value: 1.	1
PageSize	long	No	The number of entries to return per page. Maximum value: 50. Default value: 10.	10
MaxResults	integer	No	The maximum number of entries per page. Valid values: 1 to 50. Default value: 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken.	AAAAAdDWBF2
RepeatMode	string	No	The execution mode of the command. If you specify both this parameter and `InstanceId`, this parameter does not take effect. Valid values: Once: The command is immediately run. Period: The command is run on a schedule. NextRebootOnly: The command is run the next time the instances start. EveryReboot: The command is run every time the instances start. This parameter is empty by default, which indicates that commands run in all modes are queried.	Once
Tag	object []	No	The tags that are added to the command.
Key	string	No	The key of tag N of the command. You can specify up to 20 tag keys for the command. 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 contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun`.	TestKey
Value	string	No	The value of tag N of the command. You can specify up to 20 tag values for the command. The tag value can be an empty string. It can be up to 128 characters in length and cannot contain `http://` or `https://`.	TestValue

Response parameters

Parameter	Type	Description	Example
	object
PageSize	long	The number of entries returned on each page.	10
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	long	The page number of the returned page.	1
TotalCount	long	The total number of the commands.	1
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	AAAAAdDWBF2
Invocations	object []	Details about the command executions.
CreationTime	string	The time when the command task was created.	2020-01-19T09:15:46Z
Frequency	string	The schedule on which the command was run.	0 /20 * * *
InvocationStatus	string	The overall execution state of the command task. The value of this parameter depends on the execution states of the command task on all the involved instances. Valid values: Pending: The command was being verified or sent. When the execution state on at least one instance is Pending, the overall execution state is Pending. Scheduled: The command that is set to run on a schedule was sent and waiting to be run. When the execution state on at least one instance is Scheduled, the overall execution state is Scheduled. Running: The command was being run on the instances. When the execution state on at least one instance is Running, the overall execution state is Running. Success: When the execution state on at least one instance is Success and the execution state on the other instances is Stopped or Success, the overall execution state is 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: When the execution state on all instances is Stopped or Failed, the overall execution state is Failed. When the execution state on an instance is one of the following values, Failed is returned as the overall execution state: Invalid: The command was invalid. Aborted: The command failed to be sent. Failed: The execution was complete, but the exit code was not 0. Timeout: The execution timed out. Error: An error occurred while the command was being run. Stopping: The command task was being stopped. When the execution state on at least one instance is Stopping, the overall execution state is Stopping. Stopped: The task was stopped. When the execution state on all instances is Stopped, the overall execution state is Stopped. When the execution state on an instance is one of the following values, Stopped is returned as the overall execution state: Cancelled: The task was canceled. Terminated: The task was terminated. PartialFailed: The execution was complete on some instances and failed on other instances. When the execution state is Success on some instances and is Failed or Stopped on the other instances, the overall execution state is PartialFailed. Note `InvokeStatus` in the response functions similarly to this parameter. We recommend that you check the value of this parameter.	Running
RepeatMode	string	The execution mode of the command. Valid values: Once: The command is immediately run. Period: The command is run on a schedule. NextRebootOnly: The command is run the next time the instances start. EveryReboot: The command is run every time the instances start.	Once
CommandId	string	The command ID.	c-hz0jdfwcsr****
CommandType	string	The command type.	RunShellScript
InvokeStatus	string	The overall execution state of the command task. Note We recommend that you ignore this parameter and check the value of `InvocationStatus` in the response to obtain the overall execution state.	Finished
Parameters	string	The custom parameters in the command.	{}
Timed	boolean	Indicates whether the command is to be automatically run.	false
CommandContent	string	The command content. If ContentEncoding is set to PlainText in the request, the original command content is returned. If ContentEncoding is set to Base64 in the request, the Base64-encoded command content is returned.	cnBtIC1xYSB8IGdyZXAgdnNm****
CommandName	string	The command name.	CommandTestName
CommandDescription	string	The command description.	testDescription
InvokeId	string	The ID of the command task.	t-hz0jdfwd9f****
Username	string	The username used to run the command on the instances.	root
WorkingDir	string	The execution path of the command.	/home/
Timeout	long	The maximum timeout period for the command execution. Unit: seconds. When a command cannot be run, the command execution times out. When a command execution times out, Cloud Assistant Agent forcefully terminates the command process by canceling the process ID (PID) of the command.	60
ContainerId	string	The container ID.	ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
ContainerName	string	The container name.	test-container
TerminationMode	string	Indicates how the task was stopped. Valid values: Process: The process of the command was stopped. ProcessTree: The process tree was stopped. In this case, the process of the command and all subprocesses of the process were stopped.	ProcessTree
InvokeInstances	object []	The instances on which the command was run.
CreationTime	string	The time when the command task was created.	2019-12-20T06:15:54Z
UpdateTime	string	The time when the execution status was updated.	2020-01-19T09:15:47Z
FinishTime	string	The time when the execution ended.	2019-12-20T06:15:56Z
InvocationStatus	string	The execution state on a single instance. Valid values: Pending: The command was being verified or sent. Invalid: The specified command type or parameter was 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 was 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 is about to end. Error: The execution cannot proceed due to an exception. Timeout: The execution timed out. Cancelled: The execution was canceled, and the command was not run. Stopping: The command task was being stopped. Terminated: The execution was terminated before completion. Scheduled: One-time task: The execution state can never be Scheduled. Scheduled task: The command was waiting to be run.	Success
Repeats	integer	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.	0
InstanceId	string	The instance ID.	i-bp1i7gg30r52z2em****
Output	string	The command output. If ContentEncoding is set to PlainText in the request, the original command output is returned. If ContentEncoding is set to Base64 in the request, the Base64-encoded command output is returned.	OutPutTestmsg
Dropped	integer	The size of the Output text that was truncated and discarded because the Output value exceeded 24 KB in size.	0
StopTime	string	The time when the command task was stopped. If you call the `StopInvocation` operation to stop the command task, the value of this parameter is the time when the operation is called.	2020-01-19T09:15:47Z
ExitCode	long	The exit code of the execution. Valid values: For Linux instances, the value is the exit code of the shell process. For Windows instances, the value is the exit code of the batch or PowerShell process.	0
StartTime	string	The time when the command started to be run on the instance.	2019-12-20T06:15:55Z
ErrorInfo	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 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 the specified instance has been released	the specified instance does not exists
Timed	boolean	Indicates whether the command is to be automatically run.	false
ErrorCode	string	The error code for the failure to send or run the command. Valid values: If this parameter is empty, the command was run as expected. InstanceNotExists: The specified instance did not exist or was released. InstanceReleased: The instance was released while the command was being run. InstanceNotRunning: The instance was not running when the command started to be run. CommandNotApplicable: The command was not applicable to the specified instance. AccountNotExists: The specified account did not exist. DirectoryNotExists: The specified directory did not exist. BadCronExpression: The specified cron expression for the execution schedule was invalid. ClientNotRunning: Cloud Assistant Agent was not running. ClientNotResponse: Cloud Assistant Agent did not respond. ClientIsUpgrading: Cloud Assistant Agent was being upgraded. ClientNeedUpgrade: Cloud Assistant Agent needed 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 command task was interrupted. ExitCodeNonzero: The execution was complete, but the exit code was not 0.	InstanceNotExists
InstanceInvokeStatus	string	The execution state on a single instance. Note We recommend that you ignore this parameter and check the value of `InvocationStatus` in the response to obtain the execution state.	Finished
Tags	object []	The tags of the command task.
TagKey	string	The tag key of the command task.	owner
TagValue	string	The tag value of the command task.	zhangsan

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "TotalCount": 1,
  "NextToken": "AAAAAdDWBF2",
  "Invocations": {
    "Invocation": [
      {
        "CreationTime": "2020-01-19T09:15:46Z",
        "Frequency": "0 */20 * * * *",
        "InvocationStatus": "Running",
        "RepeatMode": "Once",
        "CommandId": "c-hz0jdfwcsr****",
        "CommandType": "RunShellScript",
        "InvokeStatus": "Finished",
        "Parameters": "{}",
        "Timed": false,
        "CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
        "CommandName": "CommandTestName",
        "CommandDescription": "testDescription",
        "InvokeId": "t-hz0jdfwd9f****",
        "Username": "root",
        "WorkingDir": "/home/",
        "Timeout": 60,
        "ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
        "ContainerName": "test-container",
        "TerminationMode": "ProcessTree",
        "InvokeInstances": {
          "InvokeInstance": [
            {
              "CreationTime": "2019-12-20T06:15:54Z",
              "UpdateTime": "2020-01-19T09:15:47Z",
              "FinishTime": "2019-12-20T06:15:56Z",
              "InvocationStatus": "Success",
              "Repeats": 0,
              "InstanceId": "i-bp1i7gg30r52z2em****",
              "Output": "OutPutTestmsg",
              "Dropped": 0,
              "StopTime": "2020-01-19T09:15:47Z",
              "ExitCode": 0,
              "StartTime": "2019-12-20T06:15:55Z",
              "ErrorInfo": "the specified instance does not exists",
              "Timed": false,
              "ErrorCode": "InstanceNotExists",
              "InstanceInvokeStatus": "Finished"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "zhangsan"
            }
          ]
        }
      }
    ]
  }
}

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.	The specified PageNumber parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.	The specified PageSize 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.
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.	The RegionId provided does not exist
500	InternalError.Dispatch	An error occurred when you dispatched the request.	An error occurred while the request is being sent. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-12-21

The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: MaxResults
	Added Input Parameters: NextToken
Output Parameters	The response structure of the API has changed.

2023-05-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	Error Codes 403 change
	delete Error Codes: 404
	delete Error Codes: 500

2022-07-07

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2022-06-22

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2021-05-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 403 change
	Error Codes 404 change
	delete Error Codes: 400
	delete Error Codes: 500