All Products
Search
Document Center

Elastic Compute Service:DescribeInvocations

Last Updated:Jul 09, 2024

Queries the execution list and states of Cloud Assistant commands.

Operation description

Usage notes

  • After you run a command, the command may fail to run or may return unexpected 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 subscribe to Cloud Assistant task status events to obtain command execution results from the events. This helps you reduce the number of times to poll API operations and improve efficiency.

  • 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 per page, and then use PageNumber to specify the page number. 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.
  • Comparison between the DescribeInvocations and DescribeInvocationResults operations:

    • Scenario in which the RunCommand or InvokeCommand operation is called to run a Cloud Assistant command on multiple instances:

      • The DescribeInvocations operation queries the execution status of the command on each instance and the overall execution status of the command on all instances.
      • The DescribeInvocationResults operation queries only the execution status of the command on each instance.
    • Scenario in which the RunCommand or InvokeCommand operation is called to run a Cloud Assistant command on a single instance:

      • The DescribeInvocations operation is equivalent to the DescribeInvocationResults operation.
    • If you want to query the status of each execution for a scheduled (recurring) task or a task that is automatically executed on instance startup (RepeatMode is set to Period or EveryReboot), you can call only the DescribeInvocationResults operation and must set IncludeHistory to true. The DescribeInvocations operation queries only the most recent execution status of the command.

    • If you want to view the command content and parameters, you can call only the DescribeInvocations operation and check the CommandContent value in the response.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ResourceGroupIdstringNo

The ID of the resource group. After you set this parameter, command execution results in the specified resource group are queried.

rg-bp67acfmxazb4p****
InvokeIdstringNo

The command task ID.

t-hz0jdfwd9f****
CommandIdstringNo

The command ID. You can call the DescribeCommands operation to query all available command IDs.

c-hz0jdfwcsr****
CommandNamestringNo

The command name. If you specify both this parameter and InstanceId, this parameter does not take effect.

CommandTestName
CommandTypestringNo

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
TimedbooleanNo

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
InvokeStatusstringNo

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
InstanceIdstringNo

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****
ContentEncodingstringNo

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
IncludeOutputbooleanNo

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
PageNumberlongNo

The page number of the page to return.

Page numbers start from 1.

Default value: 1.

1
PageSizelongNo

The number of entries to return per page.

Maximum value: 50.

Default value: 10.

10
MaxResultsintegerNo

The maximum number of entries per page.

Valid values: 1 to 50.

Default value: 10.

10
NextTokenstringNo

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
RepeatModestringNo

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
Tagarray<object>No

The tags that are added to the command.

objectNo

The tag that is added to the command.

KeystringNo

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
ValuestringNo

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

ParameterTypeDescriptionExample
object
PageSizelong

The number of entries returned on each page.

10
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberlong

The page number of the returned page.

1
TotalCountlong

The total number of the commands.

1
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

AAAAAdDWBF2
Invocationsarray<object>

Details about the command executions.

object

The time when the command task was created.

CreationTimestring

The time when the command task was created.

2020-01-19T09:15:46Z
Frequencystring

The schedule on which the command is run.

0 */20 * * * *
InvocationStatusstring

The overall execution status of the command task. The value of this parameter depends on the execution status of the command task on all the involved instances. Valid values:

  • Pending: The command is 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 is 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 is 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 is 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
RepeatModestring

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
CommandIdstring

The command ID.

c-hz0jdfwcsr****
CommandTypestring

The command type.

RunShellScript
InvokeStatusstring

The overall execution status of the command task.

Note We recommend that you ignore this parameter and check the value of InvocationStatus in the response to obtain the execution status.
Finished
Parametersstring

The custom parameters in the command.

{}
Timedboolean

Indicates whether the command is to be automatically run.

false
CommandContentstring

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****
CommandNamestring

The command name.

CommandTestName
CommandDescriptionstring

The command description.

testDescription
InvokeIdstring

The command task ID.

t-hz0jdfwd9f****
Usernamestring

The username used to run the command on the instances.

root
WorkingDirstring

The execution path of the command.

/home/
Timeoutlong

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
ContainerIdstring

The container ID.

ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****
ContainerNamestring

The container name.

test-container
TerminationModestring

Indicates how the command task is stopped when a command execution is manually stopped or times out. Valid values:

  • Process: The process of the command is stopped.
  • ProcessTree: The process tree of the command is stopped. In this case, the process of the command and all subprocesses are stopped.
ProcessTree
InvokeInstancesarray<object>

The instances on which the command was run.

object

The execution states of the command.

CreationTimestring

The time when the command task was created.

2019-12-20T06:15:54Z
UpdateTimestring

The time when the execution status was updated.

2020-01-19T09:15:47Z
FinishTimestring

The time when the command process ended.

2019-12-20T06:15:56Z
InvocationStatusstring

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 is 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.
Success
Repeatsinteger

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
InstanceIdstring

The instance ID.

i-bp1i7gg30r52z2em****
Outputstring

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
Droppedinteger

The size of the Output text that was truncated and discarded because the Output value exceeded 24 KB in size.

0
StopTimestring

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
ExitCodelong

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
StartTimestring

The time when the command started to be run on the instance.

2019-12-20T06:15:55Z
ErrorInfostring

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
Timedboolean

Indicates whether the command is to be automatically run.

false
ErrorCodestring

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 inapplicable to the specified instance.
  • AccountNotExists: The username specified to run the command 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 executed.
  • ExecutionInterrupted: The command task was interrupted.
  • ExitCodeNonzero: The execution was complete, but the exit code was not 0.
  • SecurityGroupRuleDenied: Access to Cloud Assistant was denied by security group rules.
InstanceNotExists
InstanceInvokeStatusstring

The execution status of the command 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 status.
Finished
Tagsarray<object>

The tags of the command task.

object

The tag of the command task.

TagKeystring

The tag key of the command task.

owner
TagValuestring

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 codeError codeError messageDescription
400RegionId.ApiNotSupportedThe 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.
400NumberExceed.TagsThe Tags parameter number is exceed.The number of tags exceeds the maximum limit.
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.The specified tag key already exists. Tag keys must be unique.
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.The specified Tag.N.Key parameter is invalid.
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.The specified tag value is invalid.
400MissingParameter.TagKeyYou must specify Tag.N.Key.The tag key is not specified.
400InvalidParam.PageNumberThe specified parameter is invalid.The specified PageNumber parameter is invalid.
400InvalidParam.PageSizeThe specified parameter is invalid.The specified PageSize parameter is invalid.
400InvalidParameter.NextTokenThe specified parameter NextToken is not valid.The specified parameter NextToken is illegal.
400InvalidParameter.MaxResultsThe specified parameter MaxResults is not valid.The specified parameter MaxResults is illegal.
403Operation.ForbiddenThe operation is not permitted.The operation is not supported.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId provided does not exist
500InternalError.DispatchAn 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 timeSummary of changesOperation
2024-05-14The Error code has changed. The response structure of the API has changedView Change Details
2023-12-21The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-05-12The Error code has changedView Change Details
2022-07-07The Error code has changed. The response structure of the API has changedView Change Details
2022-06-22The Error code has changed. The response structure of the API has changedView Change Details
2021-05-12The Error code has changedView Change Details