Queries a list of backup files.
Operation description
Currently, only backup files generated by cloud phones can be stored in Object Storage Service (OSS).
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| BackupFileId |
string |
No |
The backup file ID. |
bf-dxrh5jrv0zpb8**** |
| BackupFileName |
string |
No |
The backup file name. Fuzzy match is supported. |
abc |
| InstanceGroupId |
string |
No |
The instance group ID. |
ag-fxdx91jsfyiy3**** |
| AndroidInstanceId |
string |
No |
The instance ID. |
acp-34pqe4r0kd9kn**** |
| AndroidInstanceName |
string |
No |
The instance name. Fuzzy match is supported. |
acp-34pqe4r0kd9kn**** |
| Description |
string |
No |
The description. Fuzzy match is supported. |
desc |
| StatusList |
array |
No |
The list of backup file statuses. |
|
|
string |
No |
The backup file status. Valid values:
|
AVAILABLE |
|
| StartTime |
string |
No |
Queries backup files created after the specified time. |
2024-05-23 10:00:00 |
| EndTime |
string |
No |
Queries backup files created before the specified time. |
2024-05-20 10:00:00 |
| EndUserId |
string |
No |
The owner of the backup file. |
test1 |
| BackupAll |
boolean |
No |
Specifies whether to perform a full device backup. Valid values:
|
false |
| MaxResults |
integer |
No |
The maximum number of entries per page for a paged query. Valid values: 1 to 100. Default value: 10. |
10 |
| NextToken |
string |
No |
The pagination token that indicates the position from which to start reading. Leave this parameter empty to start reading from the beginning. |
AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON**** |
| SaleMode |
string |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| Data |
array<object> |
The list of returned result objects. |
|
|
object |
The returned result object. |
||
| GmtCreated |
string |
The creation time. |
2024-05-15 17:33:59 |
| GmtModified |
string |
The modification time. |
2024-05-15 17:33:59 |
| BackupFileId |
string |
The backup file ID. |
bf-b0qbg3pbpjkn7**** |
| BackupFileName |
string |
The backup file name. |
a-58ftsoo90p0qa****.ab |
| InstanceGroupId |
string |
The instance ID. |
ag-58ftsoo90p0qi**** |
| AndroidInstanceId |
string |
The instance ID. |
acp-34pqe4r0kd9kn**** |
| AndroidInstanceName |
string |
The instance name. |
Test cloud phone |
| TaskId |
string |
The task ID. |
t-bp67acfmxazb4p**** |
| EndUserId |
string |
The owner of the backup file. |
test |
| Status |
string |
The backup file status. Valid values:
|
AVAILABLE |
| SourceFilePathList |
array |
The list of source backup file directories. |
|
|
string |
The source backup file directory. |
/data/media |
|
| SourceAppInfoList |
array |
The list of backed-up application package names. |
|
|
string |
The backed-up application package name. |
com.example.xhs |
|
| RegionId |
string |
The region ID. |
cn-hangzhou |
| FileSize |
integer |
The total size of the source backup files. |
10227168 |
| UploadType |
string |
The backup type. Valid values:
|
OSS |
| UploadEndpoint |
string |
The domain name of the upload endpoint. |
oss-cn-hangzhou.aliyuncs.com |
| BackupFilePath |
string |
The directory where the backup file is stored. |
oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab |
| Description |
string |
The description of the backup file. |
Backup file for /data/media directory. |
| BackupAll |
boolean |
Specifies whether to perform a full device backup. |
false |
| SystemVersion |
string |
||
| Channel |
string |
||
| RequestId |
string |
The request ID. If you encounter an issue, provide this request ID for troubleshooting. |
425F351C-3F8E-5218-A520-B6311D0D**** |
| NextToken |
string |
The pagination token that indicates the position up to which data has been read in the current call. An empty value indicates that all data has been read. |
AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON**** |
| MaxResults |
string |
The maximum number of entries returned in this call. |
10 |
| TotalCount |
integer |
The total number of entries. |
91 |
Examples
Success response
JSON format
{
"Data": [
{
"GmtCreated": "2024-05-15 17:33:59",
"GmtModified": "2024-05-15 17:33:59",
"BackupFileId": "bf-b0qbg3pbpjkn7****",
"BackupFileName": "a-58ftsoo90p0qa****.ab",
"InstanceGroupId": "ag-58ftsoo90p0qi****",
"AndroidInstanceId": "acp-34pqe4r0kd9kn****",
"AndroidInstanceName": "Test cloud phone",
"TaskId": "t-bp67acfmxazb4p****",
"EndUserId": "test",
"Status": "AVAILABLE",
"SourceFilePathList": [
"/data/media"
],
"SourceAppInfoList": [
"com.example.xhs"
],
"RegionId": "cn-hangzhou",
"FileSize": 10227168,
"UploadType": "OSS",
"UploadEndpoint": "oss-cn-hangzhou.aliyuncs.com",
"BackupFilePath": "oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab",
"Description": "Backup file for /data/media directory.",
"BackupAll": false,
"SystemVersion": "",
"Channel": ""
}
],
"RequestId": "425F351C-3F8E-5218-A520-B6311D0D****",
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****",
"MaxResults": "10",
"TotalCount": 91
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.