Creates a full backup of a Cloud Phone instance. The backup includes installed applications and properties.
Operation description
To ensure that the backup is successful, shut down the instance before you start the data backup. The operation may fail if the cloud phone instance is used during the backup process.
You should test the backup file to ensure that you can restore the instance from it. After the restoration is complete, verify that your data is complete and that all features function correctly. Do not delete the original backup file or reset the source instance until this verification is complete. Otherwise, you may lose your data.
You cannot back up and restore data between 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 | The instance ID. | aic-ig2bdpk374l12**** | |
Description | string | No | The description of the full instance backup. | this is a backup android instance |
UploadEndpoint | string | Yes | The region where the backup is stored. | oss-cn-hangzhou-internal.aliyuncs.com |
BackupFilePath | string | Yes | The upload URL for the backup file. | oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab |
BackupFileName | string | No | The name of the backup file. | abc |
Response elements
Element | Type | Description | Example |
object | PlainResult | ||
| Data | array<object> | The returned result objects. | |
object | The returned result object. | ||
BackupFileId | string | The ID of the backup file. | bf-b0qbg3pbpjkn7**** |
BackupFileName | string | The name of the backup file. | a-58ftsoo90p0qa****.ab |
AndroidInstanceId | string | The cloud phone instance ID. | acp-34pqe4r0kd9kn**** |
TaskId | string | The ID of the task. | t-bp67acfmxazb4p**** |
RequestId | string | The ID of the request. | 440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1 |
Count | integer | The number of instances that were backed up. | 1 |
TaskId | string | The ID of the task. | t-14xwibw7pyrjd**** |
Examples
Success response
JSON format
{
"Data": [
{
"BackupFileId": "bf-b0qbg3pbpjkn7****",
"BackupFileName": "a-58ftsoo90p0qa****.ab",
"AndroidInstanceId": "acp-34pqe4r0kd9kn****",
"TaskId": "t-bp67acfmxazb4p****"
}
],
"RequestId": "440D7342-5FC2-5E7C-B2DB-D0B4EAC2BDF1",
"Count": 1,
"TaskId": "t-14xwibw7pyrjd****"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.