【旧版】录屏 StartRecording--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】录屏 StartRecording

最近更新时间：2024.06.17 19:36:20首次发布时间：2023.06.14 12:45:18

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

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	String	是	实例所属业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
pod_id	String	是	实例 ID，可通过调用 ListPod 接口获取
duration_limit	Int	是	设置最大录屏时长，单位：秒，支持设置的最大值为14400，即4小时
round_id	String	是	录屏请求的唯一标识，防止由于网络等原因造成重复请求，同一 round_id 在5分钟内只可使用一次
is_saved_on_pod	Boolean	否	是否保存录屏文件在云手机实例： true：上传录屏文件到火山引擎对象存储，并保存录屏文件在云手机实例中 false：上传录屏文件到火山引擎对象存储，上传完成后，删除保存在云手机实例中的文件，默认

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
Result	null	录屏成功，返回 success

示例

请求示例

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

{
    "product_id":"1608456935646xxxxxx",
    "pod_id":"7299381659819xxxxxx",
    "duration_limit":120,
    "round_id":"02",
    "is_saved_on_pod":true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "StartRecording",
        "Region": "cn-north-1",
        "RequestId": "202311141745192B0FA55C526F5B6D79F8",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}