CreateScreenshot - Cloud Phone - Alibaba Cloud Documentation Center

This asynchronous API operation generates a screenshot of a cloud phone.

Operation description

This operation creates a screenshot of a cloud phone and uploads it to the default Object Storage Service (OSS) bucket. The operation returns a task ID. You can then call the DescribeTasks operation to retrieve the download link for the screenshot.

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 list of instance IDs. Batch screenshots are supported.
	string	Yes	The instance ID.	acp-ig2bdpk374l12****
OssBucketName	string	No	The custom OSS bucket. The bucket name must start with the cloudphone-saved-bucket- prefix. The cloud phone instance and the OSS bucket must be in the same region. If you leave this parameter empty, a default bucket named cloudphone-saved-bucket-{RegionOfCloudPhone}-{AliUid} is created.	cloudphone-saved-bucket-cn-shanghai-default
SkipCheckPolicyConfig	string	No	Specifies whether to skip the screenshot policy check. The default value is false.	false
ScreenshotId	string	No	The screenshot ID. The generated screenshot is named "ScreenshotId_AndroidInstanceId.png." Important The ScreenshotId must be 2 to 128 characters long, beginning with a letter, but cannot start with http:// or https://. Allowed characters include letters, digits, underscores (_), and hyphens (-).	image

Response elements

Element	Type	Description	Example
	object	PlainResult<integer>
RequestId	string	The unique ID of the request. If you encounter an issue, provide this request ID for troubleshooting.	3AF82CE1-2801-52CE-BF64-B491DD7C****
Tasks	array<object>	The list of tasks.
	object	The task.
AndroidInstanceId	string	The instance ID.	acp-bwhtebzah2fse****
TaskId	string	The task ID. You can use this ID to call the DescribeTasks operation and query the screenshot task. When the task is complete, you can get the download link for the screenshot.	t-imr0fufqd7cle****
ScreenshotId	string	The screenshot ID. The generated screenshot is named "ScreenshotId_AndroidInstanceId.png."	image

Examples

Success response

JSON format

{
  "RequestId": "3AF82CE1-2801-52CE-BF64-B491DD7C****",
  "Tasks": [
    {
      "AndroidInstanceId": "acp-bwhtebzah2fse****",
      "TaskId": "t-imr0fufqd7cle****",
      "ScreenshotId": "image"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.