You need to enable JavaScript to run this app.
导航
云手机
  • 文档首页
    • /云手机/服务端 OpenAPI 文档/云手机操控/实例开始截图 StartScreenShot
实例开始截图 StartScreenShot
最近更新时间：2025.07.30 16:30:44首次发布时间：2025.07.25 15:42:59
复制全文
我的收藏
有用
有用
无用
无用

向正在运行中的单个或多个指定云手机实例发送截图指令，请求抓取并返回该实例当前显示画面的图像数据。
调用本接口可进行单次实例图，也可通过配置截图持续时间 DurationLinit 和截图间隔 Interval 启动周期性实例截图。启动周期性截图后，实例会根据 Interval 的设置周期性地自动连续截图，而无需频繁调用本接口手动多次截图。

使用说明

  1. 本接口需配合 2025 年 7 月 25 日及之后发布的镜像版本使用。
  2. 调用本接口成功开启截图后，实例截图会自动上传至通过 DownloadUrl 返回的链接中。
  3. 成功设置周期性截图后，截图会在到达 DurationLimit 设置的时长后停止。如需提前停止截图，可调用 StopScreenShot 接口。
  4. 周期性截图会在发生以下情况时中断，需重新调用本接口再次开启：
    • DownloadUrl 中 url 访问失败；
    • 实例重启。
  5. 本接口可替代 ScreenShot 和 BatchScreenShot 接口使用。

注意事项

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

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=StartScreenShot&Version=2025-05-01

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ProductIdString是1608456935646******业务 ID，用于指定想要截图的实例所在业务。可登录云手机控制台，在已创建的业务卡片中获取。
PodIdListArray of String是[7294157141458******, 7294157141459******]实例 ID 列表，用于指定想要截图的实例 ID 列表。最大长度为100。

DurationLimit

Integer

否

10000

截图操作持续的最大时长，仅在需要启用周期性实例截图时设置本参数。
单位为毫秒，取值范围为 100 到 43,200,000（即 12 小时），默认值为 1,000。

说明

单次截图无需设置本参数。

Interval

Integer

否

100

两次自动截图操作之间的时间间隔，仅在需要启用周期性实例截图时设置本参数。
单位为毫秒，取值范围为100 到 43,200,000（即 12 小时），默认值为 1,000。

说明

单次截图无需设置本参数。

QualityInteger否100截图图片质量，取值范围为 [1, 100]，默认值为 100。
ScaleDouble否0.8截图图片同比缩放的比率，取值范围为 [0.1, 1.0]，默认值为 1.0。

Rotation

Integer

否

0

截图画面是否做旋转处理，包含以下取值：

  • 0：默认值，截图不做旋转处理，即维持原有画面方向；
  • 1：截图画面旋转为竖屏。手机竖屏的截图，不做处理；手机横屏的截图，截图顺时针旋转 90 度。
FileTypeString否jpg截图文件的格式，可选值包括 jpg、jpeg、png，默认值为 jpeg。

UploadType

Integer

否

2

上传截图文件的方式，包含以下取值：

说明

上传至私有存储桶适用于对截图隐私性有要求的业务场景，但需承担对象存储服务费用，请结合实际业务需求选择是否开通。

TosInfoObject of TosInfo否-对象存储服务相关信息，当选择上传截图文件至私有存储桶，即 UploadType 设置为 2 时，本参数必填。

TosInfo

参数类型是否必选示例值描述
BucketString是my-bucket火山引擎对象存储中的存储桶名称。
RegionString是cn-beijing对象存储服务区域。
EndpointString是tos-******.volces.com对象存储服务地址。

返回参数

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

参数类型示例值描述
DetailsArray of ScreenShotPodResult-实例截图任务的详细信息列表。

ScreenShotPodResult

参数类型示例值描述
PodIdString7294157141458******实例 ID。

Width

Integer

1080

截图画面宽度。
当云手机的屏幕宽高发生变化时，如需获取最新宽度，需重新调用本接口获取。也可配置回调，通过监听 screen_shot 事件获取。

Height

Integer

1920

截图画面高度。
当云手机的屏幕宽高发生变化时，如需获取最新高度，需重新调用本接口获取。也可配置回调，通过监听 screen_shot 事件获取。

ErrorCodeInteger0错误码，0 表示成功，非 0 表示失败。
ErrorMsgStringForbidden错误原因说明。
ExpireAtLong1707278000DownloadUrl 到期时间, unix 秒时间戳。
DownloadUrlStringcn-beijing.volces.com/******截图文件下载地址。

请求示例

POST https://open.volcengineapi.com?Action=StartScreenShot&Version=2025-05-01
{
    "ProductId": "1608456935646******",
    "PodIdList": [
        "7294157141458******",
        "7294157141459******"
    ],
    "DurationLimit": 10000,
    "Interval": 100,
    "Quality": 100,
    "Scale": 0.8,
    "Rotation": 0,
    "FileType": "jpg",
    "UploadType": 2,
    "TosInfo": {
        "Bucket": "my-bucket",
        "Region": "cn-beijing",
        "Endpoint": "tos-******.volces.com"
    }
}

返回示例

{
    "ResponseMetadata": {
        "Action": "StartScreenShot",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Details": [
            {
                "PodId": "7294157141458******",
                "Width": 1080,
                "Height": 1920,
                "ErrorMsg": "Forbidden",
                "ExpireAt": 1707278000,
                "ErrorCode": 4,
                "DownloadUrl": "cn-beijing.volces.com/******"
            },
            {
                "PodId": "7294157141459******",
                "Width": 1080,
                "Height": 1920,
                "ErrorMsg": "",
                "ExpireAt": 1707278000,
                "ErrorCode": 0,
                "DownloadUrl": "cn-beijing.volces.com/******"
            }
        ]
    }
}

错误码

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