DescribeSendFileResults-阿里云帮助中心

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

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 execution ID of the command.	t-bj038i0d6r8zoqo
NodeId	string	No	The node ID.	e01-cn-zvp2tgykr08

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	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 on the file.	0644
Overwrite	boolean	Indicates whether an existing file with the same name in the destination directory was overwritten. true false Default value: false.	true
InvocationStatus	string	The overall sending status of the file. The status depends on the sending status across all destination instances. Valid values: Pending: The file is being verified or sent. If the sending status on at least one instance is Pending, the overall status is Pending. Running: The file is being sent to the instance. If the sending status on at least one instance is Running, the overall status is Running. Success: The file was sent to all instances successfully. Failed: The file failed to be sent to all instances. The overall status is Failed if the status on one or more instances is one of the following values: 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 was sent to some instances but failed on others.	Pending
Description	string	The command description.	Description
ContentType	string	The content type of the file. Valid values: PlainText: The file content is not encoded. Base64: The file content is Base64-encoded. Default value: PlainText.	PlainText
NodeCount	integer	The number of nodes.	3
TargetDir	string	The destination directory.	/home/user
FileGroup	string	The user group of the file.	root
FileOwner	string	The owner of the file.	root
Name	string	The name of the file sending task.	test
Content	string	The command output. If ContentEncoding is set to PlainText in the request, the original content is returned. If ContentEncoding is set to Base64 in the request, the Base64-encoded content is returned.	Base64
CreationTime	string	The time when the file sending task was created.	2023-04-10T10:53:46.156+08:00
InvokeNodes	object	The file sending records.
InvokeNode	array<object>	The file sending records on a node.
	object
InvocationStatus	string	The sending status of the file on a specific 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
FinishTime	string	The time when the file sending task ended, in the format of 2020-05-22T17:04:18.	2023-04-10T10:53:46.156+08:00
NodeId	string	The node ID.	e01-cn-9lb3c15m81j
ErrorInfo	string	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 has been released. the node has released when create task: The instance was released while the command was being run. the node is not running when create task: The instance was not in the Running state when the command was 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 did not respond. the aliyun service in the node is upgrading now: Cloud Assistant Agent was 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 during command execution. 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 was released while the file was being sent.	the specified instance does not exists
CreationTime	string	The time when the file sending task was created.	2023-02-06T07:12:50Z
StartTime	string	The start time.	2023-03-30T16:00:00Z
UpdateTime	string	The update time.	2023-03-30T16:00:00Z
ErrorCode	string	The error code returned when the file failed to be sent. 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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.