生成一张云手机的截屏图片,异步接口。
接口说明
创建一张云手机的截屏图片并上传到默认的 OSS 桶,接口返回 TaskId,可以通过 DescribeTasks 接口查询截图的下载链接。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AndroidInstanceIdList |
array |
是 |
实例 ID 列表,支持批量截图。 |
|
|
string |
是 |
实例 ID。 |
acp-ig2bdpk374l12**** |
|
| OssBucketName |
string |
否 |
自定义 OSS 桶,桶名必须“cloudphone-saved-bucket-”为前缀,云手机实例和 OSS 桶地域需要保持一致。空默认创建桶“cloudphone-saved-bucket-{云手机所在地域}-{AliUid}”。 |
cloudphone-saved-bucket-cn-shanghai-default |
| SkipCheckPolicyConfig |
string |
否 |
是否跳过截图策略控制,默认 false。 |
false |
| ScreenshotId |
string |
否 |
截屏 ID。生成的截屏图片命名为“ ScreenshotId_AndroidInstanceId.png”。 重要 ScreenshotId 长度为 2~128 个字符,以英文字母或中文开头,不能以 http://和 https://开头,可包含数字、下划线(_)和短划线(-)。 |
image |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
PlainResult |
||
| RequestId |
string |
请求唯一 ID,如果遇到问题请提供这个请求 ID,由工作人员为您排查。 |
3AF82CE1-2801-52CE-BF64-B491DD7C**** |
| Tasks |
array<object> |
任务列表。 |
|
|
object |
任务。 |
||
| AndroidInstanceId |
string |
实例 ID。 |
acp-bwhtebzah2fse**** |
| TaskId |
string |
任务 ID。通过 TaskId 可以调用 DescribeTasks 接口查询当前实例的截图任务,当任务完成可以拿到截图的下载链接。 |
t-imr0fufqd7cle**** |
| ScreenshotId |
string |
截屏 ID。生成的截屏图片命名为“ ScreenshotId_AndroidInstanceId.png”。 |
image |
示例
正常返回示例
JSON格式
{
"RequestId": "3AF82CE1-2801-52CE-BF64-B491DD7C****",
"Tasks": [
{
"AndroidInstanceId": "acp-bwhtebzah2fse****",
"TaskId": "t-imr0fufqd7cle****",
"ScreenshotId": "image"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。