【旧版】截图--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】截图

最近更新时间：2024.06.17 19:36:15首次发布时间：2022.09.09 09:13:30

对当前云手机画面发起截图请求（异步任务）。截图请求结果通过回调返回，详细信息，参考回调服务接入指南。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ScreenShot
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-08-01

Body 参数

字段	类型	必填	说明
product_id	String	是	实例所属业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
pod_id	String	是	实例 ID，可通过调用 ListPod 接口获取
round_id	String	是	截图请求的唯一标识，防止由于网络等原因造成重复请求，同一 round_id 在5分钟内只可使用一次
is_saved_on_pod	Boolean	否	是否保存截图文件在云手机实例： true：上传截图文件到火山引擎对象存储，并保存截图文件在云手机实例中 false：上传截图文件到火山引擎对象存储，上传完成后，删除保存在云手机实例中的文件，默认说明：当云手机存储空间小于600MB时，如指定 `is_saved_on_pod=true`，则不可执行截图操作；如指定 `is_saved_on_pod=false`，可执行截图操作
rotation	Int	否	截图画面横竖屏旋转： 0：截图方向不做处理，默认 1：截图画面旋转为竖屏：手机竖屏的截图，不做处理手机横屏的截图，截图顺时针旋转90度
is_broadcasted	Boolean	否	截图事件是否广播： true：广播，默认 false：非广播
interval	Int	否	设置截图地址回调触发频次。取值如下： 0 或者 1 或者不传：当前行为和默认行为。每次都刷新 URL，触发新的截图地址回调。其他数值：截图累计 xx 次后，再刷新 URL，刷新 URL 再触发截图地址回调。如果 URL 不变，则不触发新的回调。 -1：URL 固定不刷新，直到 7 天刷新一次 URL，触发新的截图地址回调。

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
Result	String	截图成功，返回 success

示例

请求示例

POST https://open.volcengineapi.com?Action=ScreenShot
&Version=2022-08-01
&<通过header传入的公共请求参数>

{
    "product_id":"1608456935646xxxxxx",
    "pod_id":"7299381659819xxxxxx",
    "round_id":"01",
    "is_saved_on_pod":true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ScreenShot",
        "Region": "cn-north-1",
        "RequestId": "20231114172200C89A62FCE5BDC21FA685",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}