DescribeBackupFiles - Cloud Phone - Alibaba Cloud Documentation Center

Queries a list of backup files.

Operation description

Currently, only backup files generated by cloud phones can be saved to Object Storage Service (OSS).

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
BackupFileId	string	No	The ID of the backup file.	bf-dxrh5jrv0zpb8****
BackupFileName	string	No	The name of the backup file. Fuzzy query is supported.	abc
InstanceGroupId	string	No	The ID of the instance group.	ag-fxdx91jsfyiy3****
AndroidInstanceId	string	No	The ID of the instance.	acp-34pqe4r0kd9kn****
AndroidInstanceName	string	No	The name of the instance. Fuzzy query is supported.	acp-34pqe4r0kd9kn****
Description	string	No	The description. Fuzzy query is supported.	desc
StatusList	array	No	The list of backup file statuses.
	string	No	The status of the backup file. Valid values: AVAILABLE : Available BACKUPING : Backing up RECOVERING : Restoring DELETING : Deleting BACKUP_FAILED : Backup failed RECOVERY_FAILED : Restoration failed PART_BACKUP_FINISHED : Partially backed up	AVAILABLE
StartTime	string	No	The start of the time range to query. The system returns backup files created after this time.	2024-05-23 10:00:00
EndTime	string	No	The end of the time range to query. The system returns backup files created before this time.	2024-05-20 10:00:00
EndUserId	string	No	The owner of the backup file.	test1
BackupAll	boolean	No	Indicates whether to back up the entire instance. Valid values: true : true false : false	false
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. The default value is 10.	10
NextToken	string	No	The token that is used to start the next query. If this parameter is left empty, the query starts 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 time when the backup file was created.	2024-05-15 17:33:59
GmtModified	string	The time when the backup file was last updated.	2024-05-15 17:33:59
BackupFileId	string	The ID of the backup file.	bf-b0qbg3pbpjkn7****
BackupFileName	string	The name of the backup file.	a-58ftsoo90p0qa****.ab
InstanceGroupId	string	The ID of the instance group.	ag-58ftsoo90p0qi****
AndroidInstanceId	string	The ID of the instance.	acp-34pqe4r0kd9kn****
AndroidInstanceName	string	The name of the instance.	测试云手机
TaskId	string	The ID of the task.	t-bp67acfmxazb4p****
EndUserId	string	The owner of the backup file.	test
Status	string	The status of the backup file. Valid values: AVAILABLE : Available RECOVERING : Restoring	AVAILABLE
SourceFilePathList	array	The list of source directories of the backup file.
	string	The source directory of the backup file.	/data/media
SourceAppInfoList	array	The list of package names of the backed-up applications.
	string	The package name of the backed-up application.	com.example.xhs
RegionId	string	The region ID.	cn-hangzhou
FileSize	integer	The total size of the source backup file.	10227168
UploadType	string	The backup type. Valid values: OSS : The backup file is saved in an OSS bucket.	OSS
UploadEndpoint	string	The domain name of the upload URL.	oss-cn-hangzhou.aliyuncs.com
BackupFilePath	string	The directory where the backup file is saved.	oss://cloudphone-saved-bucket-cn-shanghai/backup/aic-58ftsoo90p0qa****.ab
Description	string	The description of the backup file.	这是备份/data/media目录的备份文件。
BackupAll	boolean	Indicates whether the entire instance was backed up.	false
SystemVersion	string
RequestId	string	The unique ID of the request. If you encounter an issue, provide this ID for troubleshooting.	425F351C-3F8E-5218-A520-B6311D0D****
NextToken	string	The token to retrieve the next page of results. An empty value indicates that all results have been returned.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****
MaxResults	string	The maximum number of entries returned for the current request.	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": "测试云手机",
      "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": "这是备份/data/media目录的备份文件。",
      "BackupAll": false,
      "SystemVersion": ""
    }
  ],
  "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.