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

文档中心

立即注册

导航

实例开始录屏 StartRecording

最近更新时间：2025.11.25 14:53:35首次发布时间：2025.11.25 14:53:35

对当前云手机画面发起录屏请求（异步任务）。

使用说明

调用该接口前，您需要参考以下步骤，在云手机控制台配置对象存储服务，用于存储录屏文件。
注意
若未配置对象存储，则调用该接口会返回错误。
1. 前往火山引擎对象存储服务创建存储桶。详情参考对象存储快速入门。
2. 为云手机开通对象存储访问权限。详情参考开通火山引擎对象存储访问权限。
3. 登录云手机控制台，进入实例所在的业务。
4. 在业务左侧导航栏，选择功能配置。
5. 在功能配置页面的对象存储配置区域，单击添加配置。
6. 填写对象存储的存储桶名称、存储服务区域以及存储服务地址，并设置录屏功能使用场景。
  您可以通过验证配置功能，验证对象存储配置是否正确，正确后保存配置即可。
录屏请求结果通过回调返回。当回调结果为录屏成功后，本接口返回的 DownloadUrl 参数可用于下载录屏文件。
- 接入回调的具体操作，参考回调服务接入指南。
- 录屏结果回调事件，参考录屏结果回调。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

返回参数

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

参数	类型	示例值	描述
DownloadUrl	String	cn-beijing.volces.com/xxxxxx	录屏文件下载地址。仅当录屏成功后可通过该地址下载文件。

请求示例

POST https://open.volcengineapi.com?Action=StartRecording&Version=2025-05-01
{
    "ProductId": "163571455047xxxx",
    "PodId": "7294157141458*******",
    "DurationLimit": 3600,
    "RoundId": "19823",
    "IsSavedOnPod": true
}

返回示例

{
    "ResponseMetadata": {
        "Action": "StartRecording",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "DownloadUrl": "cn-beijing.volces.com/xxxxxx"
    }
}

错误码

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