Batch-Transfer Files to Cloud Phones via SendFile API & OSS - Cloud Phone - Alibaba Cloud - Cloud Phone

Pushes files from Object Storage Service (OSS) or a public download link to one or more cloud phones.

Operation description

Use this operation to send files or folders from Object Storage Service (OSS) to cloud phones.

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 parameters

Parameter	Type	Required	Description	Example
AndroidInstanceIdList	array	Yes	The IDs of one or more cloud phone instances.
	string	No	The instance ID of a cloud phone.	acp-34pqe4r0kd9kn****
SourceFilePath	string	Yes	The destination path on the cloud phone. Note If `UploadType` is `OSS` or `OSS_BRIDGED`, `SourceFilePath` must specify a directory, for example, `/sdcard/Download/`. If `UploadType` is `DOWNLOAD_URL`, `SourceFilePath` must specify a full file path, for example, `/sdcard/Download/MyFile.txt`.	/sdcard/Download
UploadType	string	Yes	The storage type of the source file. Valid values: OSS: The file is stored in Object Storage Service (OSS). DOWNLOAD_URL: The file is accessible via a public download link. OSS_BRIDGED: The service first downloads the file from a public download link to an internal OSS bucket, and then distributes it to the cloud phone instances over the internal network. Valid values: DOWNLOAD_URL : OSS :	OSS
UploadEndpoint	string	No	The service endpoint of Object Storage Service (OSS). This parameter is required if `UploadType` is `OSS` or `OSS_BRIDGED`. Note If the cloud phone instance and the OSS bucket are in the same region, you can specify an internal endpoint to accelerate data transfer and avoid public data transfer costs. For example, the internal endpoint for the China (Hangzhou) region is `oss-cn-hangzhou-internal.aliyuncs.com`. For a complete list of endpoints, see OSS regions and endpoints.	oss-cn-hangzhou-internal.aliyuncs.com
UploadUrl	string	Yes	If `UploadType` is `OSS`, this parameter specifies the URI of the source object in Object Storage Service (OSS). Note The URI must be in the `oss://<bucket-name>/<object-key>` format. The specified OSS bucket name must have the `cloudphone-saved-bucket-` prefix, for example, `cloudphone-saved-bucket-example`. If `UploadType` is `DOWNLOAD_URL` or `OSS_BRIDGED`, this parameter specifies the public download link of the source file.	oss://cloudphone-saved-bucket-example/send/a.txt
TargetFileName	string	No	The name for the destination file on the cloud phone. Note This parameter is optional and takes effect only when `UploadType` is set to `OSS` or `OSS_BRIDGED`. If you specify this parameter, the file is saved with this name in the path specified by `SourceFilePath`. If you leave this parameter empty, the source file name is used. This parameter is ignored when `UploadType` is set to `DOWNLOAD_URL`.	test.txt
AutoInstall	boolean	No	Specifies whether to automatically install the application after the file is uploaded.	true
ClientToken	string	No	A client-generated token that ensures request idempotence and prevents duplicate submissions. The token can contain up to 100 characters.	425F351C-3F8E-5218-A520-B6311D0D****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	array<object>	The details of the created tasks.	425F351C-3F8E-5218-A520-B6311D0D****
	object	The details of a single task.
AndroidInstanceId	string	The instance ID.	acp-34pqe4r0kd9kn****
TaskId	string	The ID of the individual task for a specific cloud phone.	t-4ks224ujixw****
RequestId	string	A unique identifier for the request. If you encounter an issue, provide this request ID to technical support for troubleshooting.	425F351C-3F8E-5218-A520-B6311D0D****
TaskId	string	The batch task ID.	t-ehs0yoedj0xe9****

Examples

Success response

JSON format

{
  "Data": [
    {
      "AndroidInstanceId": "acp-34pqe4r0kd9kn****",
      "TaskId": "t-4ks224ujixw****"
    }
  ],
  "RequestId": "425F351C-3F8E-5218-A520-B6311D0D****",
  "TaskId": "t-ehs0yoedj0xe9****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.