本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

开启抽帧截图后，你可以使用 StopSnapshot 关闭抽帧截图。

使用说明
接口行为

你可以调用 StopSnapshot接口，关闭已启动的抽帧截图任务。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

请求频率：QPS 不得超过 150。

请求说明
请求参数

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

Query
参数名称
数据类型
是否必选
示例值
描述
Action
String
是
StopSnapshot
接口名称。当前 API 的名称为 StopSnapshot。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
Body
参数
类型
是否必选
示例值
描述
AppId
String
是
Your_AppId
应用的唯一标志
BusinessId
String
否
Your_BusinessId
业务标识
RoomId
String
是
Your_RoomId
房间 ID，是房间的唯一标志
TaskId
String
是
Your_TaskId

你需要关闭的抽帧截图任务的 ID。

TaskId 是任务的标识，在一个 AppId 的 RoomId 下 taskId 是唯一的，不同 AppId 或者不同 RoomId 下 TaskId 可以重复，因此 AppId + RoomId + TaskId 是任务的唯一标识，可以用来标识指定 AppId 下某个房间内正在运行的任务，从而能在此任务运行中进行更新或者停止此任务。

关于 TaskId 及以上 Id 字段的命名规则符合正则表达式：[a-zA-Z0-9_@\-\.]{1,128}
返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例 
POST https://rtc.volcengineapi.com?Action=StopSnapshot&Version=2023-11-01
{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId"
}

json
返回示例 
{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StopSnapshot",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

json
错误码

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