向多个正在运行中的指定云手机实例发送截图指令，请求抓取并返回该批实例当前显示画面的图像数据。

使用说明

调用本接口发送批量截图请求后，会生成异步执行的截图任务。您可以参考云手机回调服务接入指南，通过配置“截图结果回调”，获取截图结果。

截图失败：通过回调查询失败信息。

截图成功：不返回回调信息，查看DownloadUrl返回链接内的图片。

如果您需要上传截图文件至云手机的对象存储桶中（请求参数 UploadType 传值 1），则需要先为云手机业务配置对象存储服务。操作步骤如下：

前往火山引擎对象存储服务创建存储桶。详情参考对象存储快速入门。

为云手机开通对象存储访问权限。详情参考开通火山引擎对象存储访问权限。

登录云手机控制台，进入实例所在的业务。

在业务左侧导航栏，选择功能配置。

在功能配置页面的对象存储配置区域，单击添加配置。

填写对象存储的存储桶名称、存储服务区域以及存储服务地址，并设置截图功能使用场景。

您可以通过验证配置功能，验证对象存储配置是否正确，正确后保存配置即可。

注意事项

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST

请求地址：https://open.volcengineapi.com?Action=BatchScreenShot&Version=2025-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	BatchScreenShot	接口名称。当前 API 的名称为 BatchScreenShot。
Version	String	是	2025-05-01	接口版本。当前 API 的版本为 2025-05-01。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	163571455047***	业务 ID，管理云手机资源、开展云手机业务的标识。您可以登录云手机控制台，在已创建的业务卡片中获取。
PodIdList	Array of String	是	["7294157141458*", "7294157141459*"]	实例 ID 列表，用于指定需要截图的多个云手机实例。批量操作的最大实例数量为 100。
Width	Integer	否	700	自定义截图图片宽度，单位为 px，取值范围为 [200-2560]。本参数与 Height 参数互为依赖，如需自定义截图尺寸，则两个参数均必填。不填写该参数时为云手机默认的宽度。注意本参数需配合 2025 年 3 月 13 日及以后发布的公共镜像使用。
Height	Integer	否	1400	自定义截图图片高度，单位为 px，取值范围为 [200-2560]。本参数与 Width 参数互为依赖，如需自定义截图尺寸，则两个参数均必填。不填写该参数时为云手机默认的高度。注意本参数需配合 2025 年 3 月 13 日及以后发布的公共镜像使用。
Quality	Integer	否	100	截图图片质量，即截图画质相对于原画质的压缩比例。可选范围：[1-100]，默认为 100，即原画质。注意本参数需配合 2025 年 2 月 13 日及以后发布的公共镜像使用。
IsSavedOnPod	Boolean	否	true	是否在云手机实例中保留截图文件。调用接口成功截图后，截图文件将自动上传至火山引擎对象存储（TOS）。通过设置此参数，您可以选择是否在云手机实例中保留该截图文件。 true：是，截图文件将同时保存在云手机实例和 TOS 中。当截图数量超过 1000 张时，系统会按时间顺序自动清理云手机实例中较早的截图文件。若云手机存储空间小于 600MB，将无法完成截图操作。 false：（默认值）否，截图文件仅保存在 TOS 中。云手机实例中的对应文件将在截图文件成功上传至 TOS 后被自动删除。
ResizeMode	Integer	否	1	截图图片的缩放模式。当传入 Width 和 Height 自定义截图尺寸时，可以同时使用本参数控制截图的缩放模式。取值及含义参看缩放模式说明。注意本参数需配合 2025 年 3 月 13 日及以后发布的公共镜像使用。
Rotation	Integer	否	0	截图画面横竖屏旋转，取值： 0：默认值，截图方向不做处理。 1：截图画面旋转为竖屏：手机竖屏的截图，不做处理。手机横屏的截图，截图顺时针旋转 90 度。
UploadType	Integer	否	1	上传截图文件的方式，取值： 1：默认值，上传截图文件至云手机的对象存储桶中。您需要确保已参考本文使用说明，为云手机业务配置了对象存储服务。 2：上传至火山引擎账号下的私有存储桶中。设为该值前，需先自行开通火山引擎对象存储服务，后参考开通火山引擎对象存储访问权限文档，授权云手机访问账号下对象存储的权限。说明上传至私有存储桶适用于对截图隐私性有要求的业务场景，但需承担对象存储服务费用，请结合实际业务需求选择是否开通。
TosInfo	Object of TosInfo	否	-	对象存储服务相关信息，当选择上传截图文件至私有存储桶，即 UploadType 设置为 2 时，本参数必填。
RoundId	String	否	19823	截图请求的唯一标识，为防止由于网络等原因造成重复请求，同一 RoundId 在5分钟内只可使用一次。
IsBroadcasted	Boolean	否	true	截图事件是否广播，取值： true：（默认值）广播。 false：不广播。

TosInfo

参数	类型	是否必选	示例值	描述
Bucket	String	是	my-bucket	火山引擎对象存储中的存储桶名称。
Region	String	是	cn-beijing	对象存储服务区域。
Endpoint	String	是	tos-cn-beijing.volces.com	指定对象存储服务的访问地址，暂仅支持使用公网地址。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Details	Array of BatchScreenShotResultItem		实例截图任务的详细信息列表。

BatchScreenShotResultItem

参数	类型	示例值	描述
PodId	String	7294157141458***	实例 ID。
TosInfo	Object of BatchScreenShotTosInfo	-	截图文件上传至 TOS 后的目标桶及文件位置信息，仅在 UploadType 为 2 时返回。
ErrorMsg	String	Forbidden	错误原因说明。
ErrorCode	Integer	0	错误码，取值。 0：成功。非 0：失败。
DownloadUrl	String	cn-beijing.volces.com/***	截图文件下载地址。

BatchScreenShotTosInfo

参数	类型	示例值	描述
Bucket	String	example-bucket	截图文件实际存储的 TOS 桶名称。
Region	String	cn-beijing	截图文件实际上传到的 TOS 服务区域。
Endpoint	String	tos-cn-beijing.volces.com	截图文件实际上传到的 TOS 访问地址。
TosFilePath	String	account/product/pod/round_***_screenshot.jpeg	存储桶下保存截图文件的完整路径，包括图片名。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

ResizeMode 缩放模式说明

ResizeMode	0（默认值）	1	2	3	4
是否等比例缩放	是	是	是	是	否
缩放方式	缩放图为自定义宽高形成的矩形框内，面积最大的图片。	缩放图为覆盖自定义宽高形成的矩形框，且面积最小的图片。	缩放图为覆盖自定义宽高形成的矩形框，且面积最小的图片。溢出部分将被裁剪。	缩放图为自定义宽高形成的矩形框内，面积最大的图片。未被图片填满部分将以颜色填充。	按照自定义宽高缩放，图片有可能会变形。
图示