ListTransferFiles-阿里云帮助中心

Queries the file information of a file transmission task.

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

ecd:ListTransferFiles

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the transmission task.	trt-03tdwg4tcuwdzv****
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
NextToken	string	No	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	caeba0bbb2be03f84eb48b699f0****

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextToken	string	The returned value of `NextToken` is a pagination token, which can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
Files	array<object>	The files.
	object	The information about the file.
Id	string	The file ID.	trf-a213msf****
Name	string	The file name.	测试文件
IconUrl	string	The URL of the file icon. Note For image file types (.png, .jpg, .jpeg, .gif, .webp, and .svg), the URL of the specific image is returned. For other file types, the URL of the default image is returned.	https://app-center-icon-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/tenant****
Type	string	The file type.	txt
Size	string	The file size.	10853079
Status	string	The file status. Valid values: DELETING DELETED UPLOADED Valid values: DELETING : DELETED : UPLOADED :	DELETED
OssFilePath	string	The path of the object in the OSS bucket. Note A value is returned for this parameter only when the object is stored in a custom OSS bucket.	transfer/1244234/****
OssFileName	string	The name of the object stored in OSS. Note A value is returned for this parameter only when the object is stored in a custom OSS bucket.	测试文件_0982836423402342

Examples

Success response

JSON format

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "MaxResults": 20,
  "Files": [
    {
      "Id": "trf-a213msf****",
      "Name": "测试文件",
      "IconUrl": "https://app-center-icon-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/tenant****",
      "Type": "txt",
      "Size": "10853079",
      "Status": "DELETED",
      "OssFilePath": "transfer/1244234/****",
      "OssFileName": "测试文件_0982836423402342"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.