All Products
Search
Document Center

Cloud Phone:RecoverApp

Last Updated:Jan 15, 2026

Recovers an application from a backup file to another cloud phone instance.

Operation description

  1. A full instance recovery restarts the cloud phone. An application and data recovery does not require a restart. To ensure a successful recovery, make sure your cloud phone is in the active state. Do not perform any operations on the cloud phone during the recovery process. Otherwise, the recovery operation may fail.

  2. If the application being recovered already exists on the target cloud phone, the existing application is uninstalled before the backup version is installed. This prevents version conflicts.

  3. Ensure that your backup file can be used to recover the instance or application properly. After a recovery is complete, verify that your data is complete and all features work correctly. Do not delete the original backup file or reset the source instance until you have verified that the recovery was successful. Otherwise, there is risks that you lose some data.

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 syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

BackupFileId

string

Yes

The ID of the backup file.

bf-azhps4rdyi2th****

AndroidInstanceIdList

array

Yes

The list of instance IDs.

string

No

The instance ID.

acp-34pqe4r0kd9kn****

UploadEndpoint

string

No

The backup region.

oss-cn-shanghai-internal.aliyuncs.com

UploadType

string

Yes

The backup type.

OSS

BackupFilePath

string

Yes

The OSS URL where the backup file is uploaded.

oss://cloudphone-saved-bucket-cn-hangzhou-****/backupDir/acp-ig2bdpk374l12****_2024052014****.ab

Response elements

Element

Type

Description

Example

object

PlainResult

Data

array<object>

The returned result objects.

object

The returned result object.

AndroidInstanceId

string

The instance ID.

acp-34pqe4r0kd9kn****

TaskId

string

The task ID.

t-22ex666a653gq****

RequestId

string

The request ID.

6C8439B9-7DBF-57F4-92AE-55A9B9D3****

Count

integer

The number of recovered instances.

1

TaskId

string

The task ID.

t-1ljew7on6ay0j****

Examples

Success response

JSON format

{
  "Data": [
    {
      "AndroidInstanceId": "acp-34pqe4r0kd9kn****",
      "TaskId": "t-22ex666a653gq****"
    }
  ],
  "RequestId": "6C8439B9-7DBF-57F4-92AE-55A9B9D3****",
  "Count": 1,
  "TaskId": "t-1ljew7on6ay0j****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.