Backs up specified applications on a cloud phone instance. The backup includes the application and its cache.
Operation description
Shut down the cloud phone instance before you back up data to ensure that the operation succeeds. Using the cloud phone during a backup may cause the operation to fail.
Ensure that the backup file can be used to restore the instance successfully. After you restore from a backup, verify that your data is complete and that all features are working correctly. Do not delete the original backup file or reset the source instance until you complete this verification. Failure to do so may result in data loss.
Backup and restore operations are not suppported across different image versions, between custom images and public images, or across different architectures, such as cpm.gx7.10xlarge and cpm.gx8.16xlarge.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1Request parameters
Parameter | Type | Required | Description | Example |
| AndroidInstanceIdList | array | Yes | A list of instance IDs. | |
string | No | An instance ID. | acp-34pqe4r0kd9kn**** | |
Description | string | No | The description of the application backup. | this is a backup app |
UploadEndpoint | string | Yes | Specifies the region where the backup is created. | oss-cn-shanghai-internal.aliyuncs.com |
BackupFilePath | string | Yes | The URL of the backup file. | oss://cloudphone-saved-bucket-****/backupDir/ |
BackupFileName | string | No | The name of the backup file. | MyBackup |
| SourceAppList | array | Yes | A list of package names for the applications to back up. | |
string | No | The package name of an application to back up. | com.example.xhs |
Response elements
Element | Type | Description | Example |
object | PlainResult | ||
| Data | array<object> | The response elements. | |
object | The response elements. | ||
BackupFileId | string | The ID of the backup file. | bf-b0qbg3pbpjkn7**** |
BackupFileName | string | The name of the backup file. | MyBackup |
AndroidInstanceId | string | The ID of the cloud phone instance. | acp-34pqe4r0kd9kn**** |
TaskId | string | The ID of the task. | t-4ks224ujixw**** |
RequestId | string | The ID of the request. | 425F351C-3F8E-5218-A520-B6311D0D**** |
Count | integer | The number of instances that are backed up. | 1 |
TaskId | string | The ID of the batch task. | t-14xwibw7pyrjd**** |
Examples
Success response
JSON format
{
"Data": [
{
"BackupFileId": "bf-b0qbg3pbpjkn7****",
"BackupFileName": "MyBackup",
"AndroidInstanceId": "acp-34pqe4r0kd9kn****",
"TaskId": "t-4ks224ujixw****"
}
],
"RequestId": "425F351C-3F8E-5218-A520-B6311D0D****",
"Count": 1,
"TaskId": "t-14xwibw7pyrjd****"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.