All Products
Search

This Product

    Platform For AI:DescribeSendFileResults

    Document Center

    Platform For AI:DescribeSendFileResults

    Last Updated:Jul 25, 2025
    This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

    Queries the files that are sent by an O\\\&M assistant and the status of the files.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    eflo:DescribeSendFileResultsget
    *Node
    acs:eflo:{#regionId}:{#accountId}:node/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InvokeIdstringYes

    The command execution ID.

    		t-bj038i0d6r8zoqo
    NodeIdstringNo

    The node ID.

    		e01-cn-zvp2tgykr08

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

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

    The total number of the commands.

    		1
    Invocationsobject

    The file sending records.

    Invocationarray<object>

    The command execution ID.

    Invocationobject
    FileModestring

    The permissions on the file.

    		0644
    Overwriteboolean

    Indicates whether a file was overwritten in the destination directory if the file has the same name as the sent file.

    • true
    • false

    Default value: false.

    		true
    InvocationStatusstring

    The overall sending status of the file. The overall sending status of the file varies based on the sending status of the file on all destination instances. Valid values:

    • Pending: The file is being verified or sent. If the sending state of the file on at least one instance is Pending, the overall sending state of the file is Pending.

    • Running: The file is being sent to the instance. If the sending state of the file on at least one instance is Running, the overall sending state of the file is Running.

    • Success: If the sending state of the file on all instances is Success, the overall sending state of the file is Success.

    • Failed: If the sending state of the file on all instances is Failed, the overall sending state of the file is Failed. If the sending state of the file on one or more instances is one of the following values, the overall sending state of the file is Failed:

      • Invalid: The file is invalid.
      • Aborted: The file failed to be sent to the instances.
      • Failed: The file failed to be created on the instances.
      • Timeout: The file sending task timed out.
      • Error: An error occurred and interrupted the file sending task.

    • PartialFailed: The file sending task was completed on some instances but failed on other instances. If the sending state of the file is Success on some instances and is Failed on other instances, the overall sending state of the file is PartialFailed.

    		Pending
    Descriptionstring

    The command description.

    		Description
    ContentTypestring

    The content type of the file.

    PlainText: The file content is not encoded. Base64: The file content is encoded in Base64. Default value: PlainText.

    		PlainText
    NodeCountinteger

    The number of nodes.

    		3
    TargetDirstring

    The destination directory.

    		 /home/user
    FileGroupstring

    The user group of the file.

    		root
    FileOwnerstring

    The owner of the file.

    		root
    Namestring

    The name of the file sending task.

    		test
    Contentstring

    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.

    		Base64
    CreationTimestring

    The time when the file sending task was created.

    		2023-04-10T10:53:46.156+08:00
    InvokeNodesobject

    The file sending records.

    InvokeNodearray<object>

    The file sending records on a node.

    InvokeNodeobject
    InvocationStatusstring

    The status of the file sending task on an instance. Valid values:

    • Pending: The file is being verified or sent.
    • Invalid: The file is invalid.
    • Running: The file is being sent to the instance.
    • Aborted: The file failed to be sent to the instance.
    • Success: The file is sent.
    • Failed: The file failed to be created on the instance.
    • Error: An error occurred and interrupted the file sending task.
    • Timeout: The file sending task timed out.
    		Success
    FinishTimestring

    The time when the file sending task ends. The time is in the 2020-05-22T17:04:18 format.

    		2023-04-10T10:53:46.156+08:00
    NodeIdstring

    The node ID.

    		e01-cn-9lb3c15m81j
    ErrorInfostring

    The error message returned if the command failed to be sent or run. Valid values:

    • null: The command is run as expected.
    • the specified instance does not exists: The specified instance does not exist or is released.
    • the node has released when create task: The instance is released when the command is being run.
    • the node is not running when create task: The instance is not in the Running state while the command is being run.
    • the command is not applicable: The command is not applicable to the specified instance.
    • the specified account does not exists: The specified account does not exist.
    • the specified directory does not exists: The specified directory does not exist.
    • the cron job expression is invalid: The cron expression that specifies the execution time is invalid.
    • the aliyun service is not running on the instance: Cloud Assistant Agent is not running.
    • the aliyun service in the instance does not response: Cloud Assistant Agent does not respond.
    • the aliyun service in the node is upgrading now: Cloud Assistant Agent is being upgraded.
    • the aliyun service in the node need upgrade: Cloud Assistant Agent needs to be upgraded.
    • the command delivery has been timeout: The request to send the command timed out.
    • the command execution has been timeout: The command execution timed out.
    • the command execution got an exception: An exception occurred when the command is being run.
    • the command execution has been interrupted: The command execution is interrupted.
    • the command execution exit code is not zero: The command execution completes, but the exit code is not 0.
    • the specified instance has been released: The instance is released while the file is being sent.
    		the specified instance does not exists
    CreationTimestring

    The time when the file sending task was created.

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

    The start time.

    		2023-03-30T16:00:00Z
    UpdateTimestring

    The update time.

    		2023-03-30T16:00:00Z
    ErrorCodestring

    The error code returned when the file failed to be sent to the instance. Valid values:

    Null: The file is sent to the instance. 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 running while the file sending task was being created. AccountNotExists: The specified account does not exist. ClientNotRunning: Cloud Assistant Agent is not running. ClientNotResponse: Cloud Assistant Agent did not respond. ClientIsUpgrading: Cloud Assistant Agent was being upgraded. ClientNeedUpgrade: Cloud Assistant Agent needs to be upgraded. DeliveryTimeout: The file sending task timed out. FileCreateFail: The file failed to be created. FileAlreadyExists: A file with the same name exists in the specified directory. FileContentInvalid: The file content is invalid. FileNameInvalid: The file name is invalid. FilePathInvalid: The specified directory is invalid. FileAuthorityInvalid: The specified permissions on the file are invalid. UserGroupNotExists: The specified user group does not exist.

    		AccountNotExists

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "TotalCount": 1,
  "Invocations": {
    "Invocation": [
      {
        "FileMode": "0644",
        "Overwrite": true,
        "InvocationStatus": "Pending",
        "Description": "Description\n",
        "ContentType": "PlainText",
        "NodeCount": 3,
        "TargetDir": "\t/home/user",
        "FileGroup": "root",
        "FileOwner": "root",
        "Name": "test",
        "Content": "Base64",
        "CreationTime": "2023-04-10T10:53:46.156+08:00\n",
        "InvokeNodes": {
          "InvokeNode": [
            {
              "InvocationStatus": "Success",
              "FinishTime": "2023-04-10T10:53:46.156+08:00",
              "NodeId": "e01-cn-9lb3c15m81j",
              "ErrorInfo": "the specified instance does not exists",
              "CreationTime": "2023-02-06T07:12:50Z",
              "StartTime": "2023-03-30T16:00:00Z",
              "UpdateTime": "2023-03-30T16:00:00Z",
              "ErrorCode": "AccountNotExists"
            }
          ]
        }
      }
    ]
  }
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history