开始录屏 StartRecording--云手机-火山引擎

文档中心

立即注册

导航

云手机

开始录屏 StartRecording

最近更新时间：2024.05.08 16:20:07首次发布时间：2024.05.08 16:20:07

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=StartRecording&Version=2023-10-30

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`StartRecording`	接口名称。当前 API 的名称为 `StartRecording`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1608456935646xxxxxx`	实例所属业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodId	String	是	`7299381659819xxxxxx`	实例 ID，可通过调用 `ListPod` 接口获取。
DurationLimit	Integer	是	`120`	设置最大录屏时长，单位：秒。支持设置的最大值为 14400，即 4 小时。
RoundId	String	是	`01`	录屏请求的唯一标识。为避免由于网络等原因造成重复请求，同一 `RoundId` 在 5 分钟内只可使用一次。
IsSavedOnPod	Boolean	否	`true`	是否保存录屏文件在云手机实例： true：上传录屏文件到火山引擎对象存储，并保存录屏文件在云手机实例中； false：默认值，上传录屏文件到火山引擎对象存储，上传完成后，删除保存在云手机实例中的文件。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://open.volcengineapi.com?Action=StartRecording&Version=2023-10-30
{
    "ProductId": "1608456935646xxxxxx",
    "PodId": "7299381659819xxxxxx",
    "DurationLimit": 120,
    "RoundId": "01",
    "IsSavedOnPod": true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "StartRecording",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": "success"
}

错误码

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