Lists backup files.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Token |
string |
No |
Deprecated. Do not use. |
*** |
| VaultId |
string |
No |
The backup repository ID. |
v-000***jtz |
| ClientId |
string |
No |
The backup client ID. |
c-000***o48 |
| SnapshotHash |
string |
No |
The hash of the backup point. |
971***e9d |
| Path |
string |
No |
The hash of the folder. If not specified, the root directory of the backup is listed. |
ef6***46a |
| AbsolutePath |
string |
No |
The path of the folder. Use / to list 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 required to retrieve the next page of results. |
eyJ***Q== |
| MaxResults |
integer |
No |
The number of results per query. Valid values: 10 to 100. Default value: 10. |
10 |
| StorageClass |
string |
No |
The storage class of the backup data. Valid values:
|
STANDARD |
| Edition |
string |
No |
The Cloud Backup edition. Supported values:
Valid values:
|
STANDARD |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| NextToken |
string |
The token for the next page. An empty NextToken means no more pages. |
eyJ***Q== |
| RequestId |
string |
The request ID. |
843F7A45-8B***35-ECECBE5E5F78 |
| Success |
boolean |
Indicates whether the request succeeded.
|
True |
| Code |
string |
The return code. A value of 200 indicates success. |
200 |
| Message |
string |
The response message. Returns "successful" on success or an error message on failure. |
successful |
| PageNumber |
integer |
The page number for pagination. Starts from 1. Default value: 1. |
1 |
| PageSize |
integer |
The page size for pagination. Minimum value: 1. Maximum value: 99. Default value: 10. |
10 |
| TotalCount |
integer |
Total number of records. |
11 |
| MaxResults |
integer |
The maximum number of data records returned in this response. |
10 |
| Nodes |
object |
||
| Node |
array<object> |
File system objects. |
|
|
object |
Object attributes. |
||
| Type |
string |
The object type. Valid values:
|
file |
| Name |
string |
The file or folder name. |
fileName |
| Subtree |
string |
The hash of the subfolder. |
ef6***46a |
| Size |
integer |
The file size. |
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.