实例停止截图 StopScreenShot--云手机-火山引擎

文档中心

立即注册

导航

实例停止截图 StopScreenShot

最近更新时间：2025.07.30 16:30:53首次发布时间：2025.07.25 15:42:59

调用 StartScreenShot 接口开启周期性实例截图后，可调用本接口提前终止截图。

使用说明

本接口需配合 2025 年 7 月 25 日及之后发布的镜像版本使用。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

返回参数

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

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

ScreenShotPodResult

参数	类型	示例值	描述
PodId	String	`7294157141458******`	实例 ID。
Width	Integer	`1080`	截图画面宽度。当云手机的屏幕宽高发生变化时，如需获取最新宽度，需重新调用本接口获取。也可配置回调，通过监听 `screen_shot` 事件获取。
Height	Integer	`1920`	截图画面高度。当云手机的屏幕宽高发生变化时，如需获取最新高度，需重新调用本接口获取。也可配置回调，通过监听 `screen_shot` 事件获取。
ErrorCode	Integer	`0`	错误码，0 表示成功，非 0 表示失败。
ErrorMsg	String	`Forbidden`	错误原因说明。
ExpireAt	Long	`1707278000`	`DownloadUrl` 到期时间, unix 秒时间戳。
DownloadUrl	String	`cn-beijing.volces.com/******`	截图文件下载地址。

请求示例

POST https://open.volcengineapi.com?Action=StopScreenShot&Version=2025-05-01
{
    "ProductId": "1608456935646******",
    "PodIdList": [
        "7294157141458******",
        "7294157141459******"
    ]
}

返回示例

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

错误码

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