DescribeSendFileResults-Intelligent Computing LINGJUN(LINGJUN)-阿里云帮助中心

Queries the list and status of files sent by O&M Assistant.

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:DescribeSendFileResults

get

*Node

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

None

Request parameters

Parameter	Type	Required	Description	Example
InvokeId	string	Yes	The command execution ID.	t-bj038i0d6r8zoqo
NodeId	string	No	The node ID.	e01-cn-zvp2tgykr08

Response elements

Element	Type	Description	Example
	object
RequestId	string	Id of the request	4FD06DF0-9167-5C6F-A145-F30CA4A15D54
TotalCount	string	The total number of commands.	1
Invocations	object	The file sending records.
Invocation	array<object>	The command execution ID.
	array<object>
FileMode	string	The permissions of the file.	0644
Overwrite	boolean	Specifies whether to overwrite the file if a file with the same name already exists in the target directory. Valid values: true: Overwrite the file. false: Do not overwrite the file. Default value: false.	true
InvocationStatus	string	The overall sending status of the file. The overall status depends on the combined execution status of all instances in this sending operation. Valid values: Pending: The system is validating or sending the file. If the file sending status of at least one instance is Pending, the overall status is Pending. Running: The file is being sent on the instance. If the file sending status of at least one instance is Running, the overall status is Running. Success: If the file sending status on all instances is Success, the overall status is Success. Failed: If the file sending status on all instances is Failed, the overall status is Failed. The return value is Failed when one or more of the following statuses occur on an instance: The specified file parameters are invalid and validation failed (Invalid). Failed to send the file to the instance (Aborted). Failed to create the file on the instance (Failed). File sending timed out (Timeout). An exception occurred during file sending and the operation cannot continue (Error). PartialFailed: File sending succeeded on some instances but failed on others. If the file sending status on all instances is either Success or Failed, the overall status is PartialFailed.	Pending
Description	string	The command description.	Description information
ContentType	string	The file content type. Valid values: PlainText: Plain text. Base64: Base64 encoding. Default value: PlainText.	PlainText
NodeCount	integer	The number of nodes.	3
TargetDir	string	The target path.	/home/user
FileGroup	string	The user group of the file.	root
FileOwner	string	The user of the file.	root
Name	string	The file sending name.	test
Content	string	The output information after command execution. If ContentEncoding is set to PlainText, the original output information is returned. If ContentEncoding is set to Base64, the Base64-encoded output information is returned.	Base64
CreationTime	string	The time when the sending task was created. The time is in ISO 8601 format and includes the time zone offset.	2023-04-10T10:53:46.156+08:00
InvokeNodes	object	The file sending records.
InvokeNode	array<object>	The file sending record of a node.
	object
InvocationStatus	string	The file sending status on a single instance. Valid values: Pending: The system is validating or sending the file. Invalid: The specified file parameters are invalid and validation failed. Running: The file is being sent on the instance. Aborted: Failed to send the file to the instance. Success: File sending completed. Failed: Failed to create the file on the instance. Error: An exception occurred during file sending and the operation cannot continue. Timeout: File sending timed out.	Success
FinishTime	string	The end time, in the format: "2020-05-22T17:04:18".	2023-04-10T10:53:46.156+08:00
NodeId	string	The node ID.	e01-cn-9lb3c15m81j
ErrorInfo	string	The details of the reason why the command failed to be sent or executed. Valid values: Empty: The command was executed normally. the specified instance does not exists: The specified instance does not exist or has been released. the node has released when create task: The instance was released during command execution. the node is not running when create task: The instance was not running when the command was executed. 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 specified execution time expression 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 is not responding. 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: Sending the command timed out. the command execution has been timeout: Command execution timed out. the command execution got an exception: An exception occurred during command execution. the command execution has been interrupted: Command execution was interrupted. the command execution exit code is not zero: Command execution ended with a non-zero exit code. the specified instance has been released: The instance was released during file sending.	the specified instance does not exists
CreationTime	string	The time when the file sending task was created. The time is in ISO 8601 format. Z in the example indicates UTC.	2023-02-06T07:12:50Z
StartTime	string	The start time. The time is in ISO 8601 format. Z in the example indicates UTC.	2023-03-30T16:00:00Z
UpdateTime	string	The update time. The time is in ISO 8601 format. Z in the example indicates UTC.	2023-03-30T16:00:00Z
ErrorCode	string	The error code for the file sending failure. Valid values: Empty: File sending was normal. NodeNotExists: The specified instance does not exist or has been released. NodeReleased: The instance was released during file sending. NodeNotRunning: The instance was not running 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: File sending timed out. FileCreateFail: File creation failed. FileAlreadyExists: A file with the same name already 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 during file sending does not exist.	AccountNotExists

Examples

Success response

JSON format

{
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "TotalCount": "1",
  "Invocations": {
    "Invocation": [
      {
        "FileMode": "0644",
        "Overwrite": true,
        "InvocationStatus": "Pending",
        "Description": "Description.",
        "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.