Generates a backup file and uploads it to remote storage. You can use this operation for regular data backups. You can also back up files from one instance and restore them to multiple instances, a process similar to data replication or migration.
Operation description
You can save backup files generated by cloud phones only to Object Storage Service (OSS).
Try it now
Test
RAM authorization
Request 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 backup file. |
这是一个备份/data的请求。 |
| SourceFilePathList |
array |
No |
A list of file paths to back up. |
|
|
string |
No |
The absolute path of the source folder in the Android system. |
/data |
|
| SourceAppList |
array |
No |
A list of application package names to back up. |
|
|
string |
No |
The application package name to back up. |
com.example.xhs |
|
| UploadType |
string |
No |
The backup type. Valid values:
|
OSS |
| UploadEndpoint |
string |
No |
The domain name of the upload URL. Note
If you upload the file to an OSS bucket, call the DescribeBuckets operation to obtain the bucket information. If the cloud phone and the bucket are in the same region, use the value of the intranetEndpoint field. If they are in different regions, use the value of the extranetEndpoint field. |
oss-cn-shanghai-internal.aliyuncs.com |
| BackupFilePath |
string |
Yes |
The upload URL for the backup file. Note
If you upload the file to an OSS bucket, call the DescribeBuckets operation to get the bucketName. Then, select a key from ossObjectList. The key represents the folder path in the OSS bucket. Combine these values into the format |
oss://cloudphone-saved-bucket-****/backupDir/ |
| BackupFileName |
string |
No |
The name of the backup file. |
MyBackup |
| BackupAll |
boolean |
No |
Specifies whether to back up the entire instance. |
false |
| ExcludeSourceFilePathList |
array |
No |
||
|
string |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| Data |
array<object> |
The result object. |
6C8439B9-7DBF-57F4-92AE-55A9B9D3**** |
|
object |
|||
| 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 task ID. |
t-22ex666a653gq**** |
| RequestId |
string |
The request ID. |
6C8439B9-7DBF-57F4-92AE-55A9B9D3**** |
| Count |
integer |
The number of instances that are backed up. |
1 |
| TaskId |
string |
The batch task ID. |
t-14xwibw7pyrjd**** |
Examples
Success response
JSON format
{
"Data": [
{
"BackupFileId": "bf-b0qbg3pbpjkn7****",
"BackupFileName": "MyBackup",
"AndroidInstanceId": "acp-34pqe4r0kd9kn****",
"TaskId": "t-22ex666a653gq****"
}
],
"RequestId": "6C8439B9-7DBF-57F4-92AE-55A9B9D3****",
"Count": 1,
"TaskId": "t-14xwibw7pyrjd****"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.