BrowseFiles - Cloud Backup - Alibaba Cloud Documentation Center

Browses the list of backup files in a specified backup snapshot.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Token	string	No	Deprecated. Do not use.	***
VaultId	string	No	The backup vault ID.	v-000***jtz
ClientId	string	No	The backup client ID.	c-000***o48
SnapshotHash	string	No	The hash value of the backup snapshot.	971***e9d
Path	string	No	The hash value of the directory. If this parameter is not specified, the root directory of the backup is browsed.	ef6***46a
AbsolutePath	string	No	The absolute path of the directory. Specify `/` to browse the root directory of the backup.	/data/
PageNumber	integer	No	Deprecated. Use MaxResults and NextToken for pagination instead.	1
PageSize	integer	No	Deprecated. Use MaxResults and NextToken for pagination instead.	10
RestoreId	string	No	Deprecated.	r-000***oy9
NextToken	string	No	The token that is required to retrieve the next page of results. If this parameter is not specified, the first page of results is returned.	eyJ***Q==
MaxResults	integer	No	The maximum number of results to return per request. Valid values: 10 to 100. Default value: 10.	10
StorageClass	string	No	The storage class of the backup data. Valid values: STANDARD: Standard. ARCHIVE: Archive.	STANDARD
Edition	string	No	The Cloud Backup edition. Valid values: STANDARD: Standard Edition. This is the default value. BASIC: Basic Edition. Only ECS file backup is supported in Basic Edition. Valid values: STANDARD : Standard Edition BASIC : ECS file backup Basic Edition	STANDARD

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token for the next page of results. An empty value indicates that no more pages are available.	eyJ***Q==
RequestId	string	The request ID.	843F7A45-8B***35-ECECBE5E5F78
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	True
Code	string	The HTTP status code. A value of 200 indicates that the request was successful.	200
Message	string	The response message. The value `successful` is returned if the request was successful. An error message is returned if the request failed.	successful
PageNumber	integer	The page number. Pages start from 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	11
MaxResults	integer	The maximum number of entries returned per page.	10
Nodes	object
Node	array<object>	The file system objects.
	object	The properties of a file system object.
Type	string	The object type. Valid values: file : File symlink : Symbolic link dir : Directory	file
Name	string	The name of the file or directory.	fileName
Subtree	string	The hash value of the subdirectory. Use this value in the Path parameter to browse the contents of this subdirectory.	ef6***46a
Size	integer	The file size, in bytes.	58727654

Examples

Success response

JSON format

{
  "NextToken": "eyJ***Q==\n",
  "RequestId": "843F7A45-8B***35-ECECBE5E5F78",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 11,
  "MaxResults": 10,
  "Nodes": {
    "Node": [
      {
        "Type": "file",
        "Name": "fileName",
        "Subtree": "ef6***46a",
        "Size": 58727654
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.