All Products
Search

This Product

    Platform For AI:DescribeInvocations

    Document Center

    Platform For AI:DescribeInvocations

    Last Updated:Oct 16, 2025

    Queries the execution history and status of Cloud Assistant commands.

    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

    eflo:DescribeInvocations

    get

    *Node

    acs:eflo:{#regionId}:{#accountId}:node/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InvokeId

    string

    Yes

    The ID of the command execution.

    t-cd03crwys0lrls0
    NodeId

    string

    No

    The ID of the instance.

    e01-cn-zvp2tgykr08
    IncludeOutput

    boolean

    No

    Specifies whether to include the command output in the response.

    • true: Returns the output. You must specify the InvokeId or NodeId parameter.

    • false (default): Does not return the output.

    true
    ContentEncoding

    string

    No

    The encoding mode of the CommandContent and Output fields in the response. Valid values:

    • PlainText: Returns the original command content and output.

    • Base64 (default): Returns the Base64-encoded command content and output.

    PlainText

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    4FD06DF0-9167-5C6F-A145-F30CA4A15D54
    Invocations

    object

    The object that contains the script execution records.

    Invocation

    array<object>

    The command execution records.

    object

    CreationTime

    string

    The time when the task was created.

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

    string

    The cron expression for the scheduled command.

    0 */20 * * * *
    InvocationStatus

    string

    The overall execution status of the command. This status is determined by the execution status on all involved instances. Valid values:

    • Pending: The system is verifying or sending the command. If the command is in the Pending state on at least one instance, the overall status is Pending.

    • Scheduled: The scheduled command is sent and is waiting to run. If the command is in the Scheduled state on at least one instance, the overall status is Scheduled.

    • Running: The command is running on the instances. If the command is in the Running state on at least one instance, the overall status is Running.

    • Success: The command was successfully executed. The command status on each instance is Stopped or Success, and the status on at least one instance is Success.

      • For one-time tasks: The command execution is complete and the exit code is 0.

      • For scheduled tasks: The last execution was successful with an exit code of 0, and all scheduled executions are complete.

    • Failed: The command execution failed. The command status on each instance is Stopped or Failed. The overall status is Failed if the command status on one or more instances is one of the following:

      • The command failed to be verified (Invalid).

      • The command failed to be sent (Aborted).

      • The command execution is complete, but the exit code is not 0 (Failed).

      • The command timed out (Timeout).

      • An error occurred during the command execution (Error).

    • Stopping: The task is being stopped. If the command is in the Stopping state on at least one instance, the overall status is Stopping.

    • Stopped: The task was stopped. The overall status is Stopped if the command is in the Stopped state on all instances. The overall status is Stopped if the command status on the instances is one of the following:

      • The task was canceled (Cancelled).

      • The task was terminated (Terminated).

    • PartialFailed: The command was successfully executed on some instances but failed on others. The overall status is PartialFailed if the command status on the instances is Success, Failed, or Stopped.

    Note

    The InvokeStatus parameter has a similar meaning. However, check the value of this parameter.

    Success
    RepeatMode

    string

    The execution mode of the command. Valid values:

    • Once: The command is immediately executed.

    • Period: The command is executed on a schedule.

    • NextRebootOnly: The command is automatically executed the next time the instance starts.

    • EveryReboot: The command is automatically executed every time the instance starts.

    Once
    InvokeStatus

    string

    The overall execution status of the command. This status is determined by the execution status on one or more instances. Valid values:

    • Running:

      • Scheduled execution: The status is always Running before you manually stop the scheduled command.

      • One-time execution: The overall status is Running if a command process is in progress.

    • Finished:

      • Scheduled execution: A command process cannot be in the Finished state.

      • One-time execution: The execution is complete on all instances. Alternatively, the command process is manually stopped on some instances and the execution is complete on the other instances.

    • Failed:

      • Scheduled execution: A command process cannot be in the Failed state.

      • One-time execution: The execution failed on all instances.

    • Stopped: The command is stopped.

    • Stopping: The command is being stopped.

    • PartialFailed: The execution failed on some instances. This value is not returned if you specify the NodeId parameter.

    Running
    Parameters

    string

    The custom parameters in the command.

    {}
    CommandContent

    string

    The content of the command.

    • If `ContentEncoding` is set to `PlainText`, the original script content is returned.

    • If `ContentEncoding` is set to `Base64`, the Base64-encoded script content is returned.

    cnBtIC1xYSB8IGdyZXAgdnNm****
    CommandName

    string

    The name of the command.

    CommandTestName
    CommandDescription

    string

    The description of the command.

    testDescription
    InvokeId

    string

    The ID of the command execution.

    t-ind3k9ytvvduoe8
    Username

    string

    The name of the user who runs the command.

    root
    WorkingDir

    string

    The directory where the command is run on the instance.

    /home
    Timeout

    integer

    The timeout period for the command execution. Unit: seconds.

    60
    InvokeNodes

    object

    The command execution records.

    InvokeNode

    array<object>

    The command execution records on the nodes.

    object

    CreationTime

    string

    The start time of the command execution.

    2023-02-06T07:12:50Z
    UpdateTime

    string

    The time when the record was updated.

    2023-02-06T07:12:50Z
    FinishTime

    string

    The time when the execution was complete.

    2023-02-06T07:12:50Z
    InvocationStatus

    string

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

    • Pending: The system is verifying or sending the command.

    • Invalid: The specified command type or parameter is incorrect.

    • Aborted: Failed to send the command to the instance. The instance must be in the Running state and the command must be sent within 1 minute.

    • Running: The command is running on the instance.

    • Success:

      • For a one-time command: The execution is complete and the exit code is 0.

      • For a scheduled command: The last execution was successful with an exit code of 0, and the specified period is over.

    • Failed:

      • For a one-time command: The execution is complete, but the exit code is not 0.

      • For a scheduled command: The last execution was successful, but the exit code was not 0. The scheduled execution will be aborted.

    • Error: An exception occurred during the command execution and the execution cannot continue.

    • Timeout: The command execution timed out.

    • Cancelled: The command execution was canceled. The command was not started.

    • Stopping: The task is being stopped.

    • Terminated: The command was terminated during execution.

    • Scheduled:

      • For a one-time command: This status is not applicable and will not occur.

      • For a scheduled command: The command is waiting to run.

    Pending
    Repeats

    integer

    The number of times the command has been executed on the instance.

    • If the command is a one-time execution, the value is 0 or 1.

    • If the command is a scheduled execution, the value is the number of times the command has been executed.

    0
    NodeId

    string

    The ID of the node.

    e01-cn-lbj36wkp70b
    Output

    string

    The output of the command.

    • If `ContentEncoding` is set to `PlainText`, the original output is returned.

    • If `ContentEncoding` is set to `Base64`, the Base64-encoded output is returned.

    OutPutTestmsg
    Dropped

    integer

    The number of characters that are truncated and discarded because the `Output` value exceeds 24 KB in size.

    0
    StopTime

    string

    The time when `StopInvocation` was called to stop the command execution.

    2019-12-20T06:15:55Z

    ExitCode

    integer

    The exit code of the command process. Valid values:

    • On a Linux instance, this is the exit code of the Shell process.

    • On a Windows instance, this is the exit code of the Batch or PowerShell process.

    0
    StartTime

    string

    The start time.

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

    string

    The details about the cause of a command sending or execution failure. Valid values:

    • Empty: The command was executed as expected.

    • the specified node does not exist: The specified instance does not exist or has been released.

    • the instance was released during the command execution: The instance was released during the command execution.

    • the instance is not running when create task: The instance was not in the Running state during the command execution.

    • the command is not applicable: The command is not applicable to the specified instance.

    • the specified account does not exist: The specified account does not exist.

    • the specified directory does not exist: The specified directory does not exist.

    • the cron job expression is invalid: The specified cron expression is invalid.

    • Cloud Assistant Agent is not running: Cloud Assistant Agent is not running.

    • Cloud Assistant Agent is not responding: Cloud Assistant Agent is not responding.

    • Cloud Assistant Agent is being upgraded: Cloud Assistant Agent is being upgraded.

    • Cloud Assistant Agent needs to be upgraded: Cloud Assistant Agent needs to be upgraded.

    • The command failed to be sent due to a timeout: The command failed to be sent due to a timeout.

    • The command execution timed out: The command execution timed out.

    • An exception occurred during the command execution: An exception occurred during the command execution.

    • The command execution was interrupted: The command execution was interrupted.

    • The command execution is complete, but the exit code is not 0: The command execution is complete, but the exit code is not 0.

    • The instance was released while the file was being sent: The instance was released while the file was being sent.

    the specified node does not exists
    Timed

    string

    Indicates whether the command will be automatically run in the future. Valid values:

    • true: The command is a scheduled command. The RepeatMode parameter was set to Period, NextRebootOnly, or EveryReboot when RunCommand or InvokeCommand was called.

    • false (default): The command is a one-time command or has finished.

      • The RepeatMode parameter was set to Once when RunCommand or InvokeCommand was called.

      • The command was canceled, stopped, or has finished running.

    false
    ErrorCode

    string

    The error code for a file sending failure. Valid values:

    • Empty: The file was sent as expected.

    • NodeNotExists: The specified instance does not exist or has been released.

    • NodeReleased: The instance was released while the file was being sent.

    • NodeNotRunning: The instance was not in the Running state when the file sending task was created.

    • AccountNotExists: The specified account does not exist.

    • ClientNotRunning: Cloud Assistant Agent is not running.

    • ClientNotResponse: Cloud Assistant Agent is not responding.

    • ClientIsUpgrading: Cloud Assistant Agent is being upgraded.

    • ClientNeedUpgrade: Cloud Assistant Agent needs to be upgraded.

    • DeliveryTimeout: The file failed to be sent due to a timeout.

    • FileCreateFail: The file failed to be created.

    • FileAlreadyExists: A file with the same name exists in the same path.

    • FileContentInvalid: The file content is invalid.

    • FileNameInvalid: The file name is invalid.

    • FilePathInvalid: The file path is invalid.

    • FileAuthorityInvalid: The file permissions are invalid.

    • UserGroupNotExists: The user group specified for sending the file does not exist.

    NodeNotExists
    NodeInvokeStatus

    string

    The execution status of the command on a single instance.

    Finished

    Examples

    Success response

    JSON format

    {
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "Invocations": {
    "Invocation": [
      {
        "CreationTime": "2020-01-19T09:15:46Z",
        "Frequency": "0 */20 * * * *",
        "InvocationStatus": "Success",
        "RepeatMode": "Once",
        "InvokeStatus": "Running",
        "Parameters": "{}",
        "CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
        "CommandName": "CommandTestName",
        "CommandDescription": "testDescription",
        "InvokeId": "t-ind3k9ytvvduoe8",
        "Username": "root",
        "WorkingDir": "/home",
        "Timeout": 60,
        "InvokeNodes": {
          "InvokeNode": [
            {
              "CreationTime": "2023-02-06T07:12:50Z",
              "UpdateTime": "2023-02-06T07:12:50Z",
              "FinishTime": "2023-02-06T07:12:50Z",
              "InvocationStatus": "Pending",
              "Repeats": 0,
              "NodeId": "e01-cn-lbj36wkp70b",
              "Output": "OutPutTestmsg",
              "Dropped": 0,
              "StopTime": "2019-12-20T06:15:55Z\t\n",
              "ExitCode": 0,
              "StartTime": "2019-12-20T06:15:55Z",
              "ErrorInfo": "the specified node does not exists",
              "Timed": "false",
              "ErrorCode": " NodeNotExists",
              "NodeInvokeStatus": "Finished"
            }
          ]
        }
      }
    ]
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.