你可以使用此接口查询指定抽帧截图任务的相关信息。

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

接口行为

你可以调用GetSnapshotTask接口，指定你所属的 AppId，查询指定 RoomId 下的抽帧截图任务。

自动抽帧截图任务也支持查询。

通过此接口仅能查询距今 72 小时内开始的抽帧截图任务。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

接口限制

QPS 不得超过 60。

请求方式

使用 Get 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数，参看请求参数。

Query

参数名	类型	必填	示例值	描述
Action	String	是	`GetSnapshotTask`	接口名称，本接口取值：`GetSnapshotTask`
Version	String	是	`2022-06-01`	接口版本，本接口取值：`2022-06-01`
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志
RoomId	String	是	`Your_RoomId`	房间的 ID，是房间的唯一标志
TaskId	String	否	`Your_TaskId`	要查询的抽帧截图任务 ID。自动抽帧任务下，该字段可传入用户 UserId。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=GetSnapshotTask&Version=2022-06-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId

返回调用结果

返回结果参看 BaseResponse。
其中 Result 的结构如下：

参数名	类型	描述
SnapshotTask	SnapshotTask	抽帧截图任务信息

SnapshotTask

参数名	类型	描述
StartTime	Uint64	任务开始时间戳，Unix 时间，单位为毫秒
EndTime	Uint64	任务结束时间戳，Unix 时间，单位为毫秒。`0` 表示任务未结束
Status	Uint64	任务状态。 `0`: 未知异常状态 `1`: 未开始 `2`: 运行中 `3`: 已结束 `4`: 任务运行失败
StopReason	String	任务停止的原因返回为空：表示任务未结束 `UnknownStopReason`：未知停止原因 `StopByAPI`：用户主动调用服务端 OpenAPI 停止 `StartTaskFailed`：任务启动失败 `IdleTimeOut`：任务超过最大空闲时间 `UserDisconnect`：自动截图任务中，截图任务对应的客户端用户主动退房。
TargetStreams	Streams	需要截图的视频流。
MaxIdleTime	Uint32	任务最大的空闲超时时间。
ImageConfig	ImageConfig	图片的相关配置：图片格式，尺寸和截图间隔时间。
StorageConfig	StorageConfig	存储平台设置。其中 AK、SK 字段不返回。

正常返回示例

{
    "Result": {
        "SnapshotTask": {
            "StartTime": 1677227309000,
            "EndTime": 1677227511000,
            "Status": 3,
            "StopReason": "IdleTimeOut",
            "TargetStreams": {
                "StreamList": [
                    {
                        "Index": 0,
                        "UserId": "user0",
                        "StreamType": 1
                    },
                    {
                        "Index": 1,
                        "UserId": "user1",
                        "StreamType": 1
                    }
                ]
            },
            "MaxIdleTime": 200,
            "ImageConfig": {
                "Format": 0,
                "Width": 800,
                "Height": 800,
                "Interval": 2
            },
            "StorageConfig": {
                "Type": 0,
                "TosConfig": {
                    "Region": 0
                },
                "VodConfig": {
                    "Region": 0
                },
                "VeImageXConfig": {
                    "Region": 0
                },
                "CustomConfig": {
                    "Vendor": 0,
                    "Region": 0
                }
            }
        }
    },
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetSnapshotTask",
        "Version": "2022-06-01"，
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}
json