Restores backup files.
Operation description
Currently, this operation allows you to restore only backup files generated by cloud phones that are stored in Object Storage Service (OSS) buckets.
Try it now
Test
RAM authorization
Request parameters
Parameter | Type | Required | Description | Example |
BackupFileId | string | No | The ID of the backup file. | bf-azhps4rdyi2th**** |
| AndroidInstanceIdList | array | Yes | The IDs of the instances. | |
string | No | The ID of the cloud phone. | acp-ig2bdpk374l12**** | |
UploadType | string | No | The type of the backup. Valid values:
| OSS |
UploadEndpoint | string | No | The endpoint of the OSS bucket that stores the backup file. Note : When calling the DescribeBuckets operation to query buckets, retrieve the IntranetEndpoint value if the cloud phone and the OSS bucket are in the same region. If they are in different regions, retrieve the ExtranetEndpoint value instead. | oss-cn-hangzhou-internal.aliyuncs.com |
BackupFilePath | string | No | The OSS path to which the backup file is uploaded. Note When calling the describeBuckets operation to retrieve a bucket name, you must also call the ossObjectList operation to obtain the object key. Combine these to form the full path: oss://${bucketName}/${key}. | oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab |
BackupAll | boolean | No | Specifies whether to back up the whole instance. | false |
Response elements
Element | Type | Description | Example |
object | The response parameters. | ||
| Data | array<object> | The backup file that is restored. | 6AD56E39-430B-5401-AB4A-7B086454**** |
object | |||
AndroidInstanceId | string | The instance ID. | acp-34pqe4r0kd9kn**** |
TaskId | string | The task ID. | t-ehs0yoedsskom**** |
RequestId | string | The ID of the request. | 6AD56E39-430B-5401-AB4A-7B086454**** |
Count | integer | The number of restored instances. | 1 |
TaskId | string | The ID of the batch task. | t-3eourrxaoliqq**** |
Examples
Success response
JSON format
{
"Data": [
{
"AndroidInstanceId": "acp-34pqe4r0kd9kn****",
"TaskId": "t-ehs0yoedsskom****"
}
],
"RequestId": "6AD56E39-430B-5401-AB4A-7B086454****",
"Count": 1,
"TaskId": "t-3eourrxaoliqq****"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.