Queries backup files that you can restore.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeBackupFiles |
The operation that you want to perform. Set the value to DescribeBackupFiles. |
Uuid | String | Yes | 6d5b361f-958d-48a8-a9d2-d6e82c1a**** |
The UUID of the server to which an anti-ransomware policy is applied. |
Path | String | No | "" |
The path to the backup file. |
SnapshotHash | String | Yes | a7f26223ef3974c6fac324cd37713ab65ab618859d20b4039192a5da44d77b63 |
The hash value of the backup file. |
CurrentPage | String | Yes | 1 |
The number of the page to return. Default value: 1. |
PageSize | String | Yes | 10 |
The number of entries to return on each page. Default value: 10. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148 |
The ID of the request, which is used to locate and troubleshoot issues. |
PageInfo | Object |
The pagination information. |
|
CurrentPage | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 10 |
The number of entries returned per page. Default value: 10. |
TotalCount | Integer | 69 |
The total number of backup files. |
Count | Integer | 10 |
The number of backup files returned on the current page. |
BackupFiles | Array of BrowseFile |
The details about the backup file. |
|
Type | String | dir |
The type of the protected file. Valid values:
|
Name | String | Group 1 |
The name of the policy. |
Subtree | String | Python27\ |
The path to the subdirectory of the backup file. |
Size | Long | 100 |
The size of the backup file. Unit: bytes. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeBackupFiles
&Uuid=6d5b361f-958d-48a8-a9d2-d6e82c1a****
&Path=“”
&SnapshotHash=a7f26223ef3974c6fac324cd37713ab65ab618859d20b4039192a5da44d77b63
&CurrentPage=1
&PageSize=10
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeBackupFilesResponse>
<RequestId>00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148</RequestId>
<PageInfo>
<CurrentPage>1</CurrentPage>
<PageSize>10</PageSize>
<TotalCount>69</TotalCount>
<Count>10</Count>
</PageInfo>
<BackupFiles>
<Type>dir</Type>
<Name>Group 1</Name>
<Subtree>Python27\</Subtree>
<Size>100</Size>
</BackupFiles>
</DescribeBackupFilesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148",
"PageInfo" : {
"CurrentPage" : 1,
"PageSize" : 10,
"TotalCount" : 69,
"Count" : 10
},
"BackupFiles" : [ {
"Type" : "dir",
"Name" : "Group 1",
"Subtree" : "Python27\\",
"Size" : 100
} ]
}
Error codes
For a list of error codes, visit the API Error Center.