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

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

使用说明

接口行为

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

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

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

调用接口

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

注意事项

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

请求说明

请求方式：GET
请求地址：https://rtc.volcengineapi.com?Action=GetSnapshotTask&Version=2023-11-01

请求参数

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

Query

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

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数	类型	示例值	描述
SnapshotTask	Object of SnapshotTask	`-`	抽帧截图任务信息

SnapshotTask

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

Streams

参数	类型	示例值	描述
StreamList	Array of Stream	`-`	由`Stream`组成的列表，可以为空。为空时，表示订阅房间内所有流。在一个 `StreamList` 中，`Stream.Index` 不能重复。

VeImageXConfig

参数类型示例值描述

参数	类型	示例值	描述
AccountId	String	`Your_AccountId`	火山引擎平台账号 ID，例如：`200000000`。火山引擎平台账号 ID 查看路径：控制台->账号管理->账号信息此账号 ID 为火山引擎主账号 ID。若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。
Region	Integer	`/`	不同存储平台支持的 Region 不同，具体参看 Region对照表默认值为`0`。
ServiceId	String	`Your_ServiceId`	服务 ID。你可以在 veImageX 控制台服务管理页面，通过创建好的图片服务中获取服务 ID。你也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

AccountId

String

Your_AccountId

火山引擎平台账号 ID，例如：200000000。

火山引擎平台账号 ID 查看路径：控制台->账号管理->账号信息
此账号 ID 为火山引擎主账号 ID。
若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。

Region

Integer

/

不同存储平台支持的 Region 不同，具体参看 Region对照表
默认值为0。

ServiceId

String

Your_ServiceId

服务 ID。

你可以在 veImageX 控制台服务管理页面，通过创建好的图片服务中获取服务 ID。
你也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

StorageConfig

参数	类型	示例值	描述
Type	Integer	`0`	存储平台类型 0：火山引擎对象存储 TOS 1: 火山引擎视频点播 VOD 2: 第三方存储平台(需支持 S3 协议) 3: VeImageX (当前仅支持抽帧截图功能) 默认值为 `0`。
TosConfig	Object of TosConfig	`-`	当 Type = `0` 时，需正确设置 `TosConfig` 的值，否则请求会报错
VodConfig	Object of VodConfig	`-`	当 Type = `1` 时，需正确设置 `VodConfig` 的值，否则请求会报错
CustomConfig	Object of CustomConfig	`-`	当 Type = `2`时，需正确设置 `CustomConfig` 的值，否则请求会报错
VeImageXConfig	Object of VeImageXConfig	`-`	当 Type = `3`时，需正确设置 `VeImageXConfig` 的值，否则请求会报错

Stream

参数	类型	示例值	描述
Index	Integer	`0`	在自定义布局中，使用 `Index` 对流进行标志。后续在 `Layout.regions.StreamIndex` 中，你需要使用 `Index` 指定对应流的布局设置。
UserId	String	`Your_UserId`	用户Id，表示这个流所属的用户。
StreamType	Integer	`0`	流的类型，值可以取`0`或`1`，默认值为`0`。`0`表示普通音视频流，`1`表示屏幕流。

TosConfig

参数类型示例值描述

参数	类型	示例值	描述
AccountId	String	`Your_AccountId`	火山引擎平台账号 ID，例如：`200000000`。火山引擎平台账号 ID 查看路径：控制台->账号管理->账号信息此账号 ID 为火山引擎主账号 ID。若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。
Region	Integer	`0`	不同存储平台支持的 Region 不同，具体参看 Region对照表默认值为`0`。
Bucket	String	`Your_Bucket`	存储桶的名称。

AccountId

String

Your_AccountId

火山引擎平台账号 ID，例如：200000000。

火山引擎平台账号 ID 查看路径：控制台->账号管理->账号信息
此账号 ID 为火山引擎主账号 ID。
若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。

Region

Integer

0

不同存储平台支持的 Region 不同，具体参看 Region对照表
默认值为0。

Bucket String Your_Bucket 存储桶的名称。

VodConfig

参数类型示例值描述

参数	类型	示例值	描述
AccountId	String	`Your_AccountId`	火山引擎平台账号 ID，例如：`200000000`。火山引擎平台账号 ID 查看路径：控制台->账号管理->账号信息此账号 ID 为火山引擎主账号 ID。若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。
Region	Integer	`0`	不同存储平台支持的 Region 不同，具体参看 Region对照表默认值为`0`。
Space	String	`Your_Space`	点播空间名称。

AccountId

String

Your_AccountId

火山引擎平台账号 ID，例如：200000000。

火山引擎平台账号 ID 查看路径：控制台->账号管理->账号信息
此账号 ID 为火山引擎主账号 ID。
若你调用 OpenAPI 鉴权过程中使用的 AK、SK 为子用户 AK、SK，账号 ID 也必须为火山引擎主账号 ID，不能使用子用户账号 ID。

Region

Integer

0

不同存储平台支持的 Region 不同，具体参看 Region对照表
默认值为0。

Space String Your_Space 点播空间名称。

CustomConfig

参数	类型	示例值	描述
Vendor	Integer	`0`	第三方云存储平台。 `0`： Amazon S3 `1`：阿里云 OSS `2`：华为云 OBS `3`：腾讯云 COS `4`：七牛云 Kodo。默认值为 `0`。
Region	Integer	`0`	不同存储平台支持的 Region 不同，具体参看 Region对照表默认值为`0`。
Bucket	String	`Your_Bucket`	存储桶的名称。
AccessKey	String	`Your_AccessKey`	第三方存储平台账号的密钥。需确保此账号对存储桶有写权限。不建议开启读权限
SecretKey	String	`Your_SecretKey`	第三方存储平台账号的密钥

请求示例

GET https://rtc.volcengineapi.com?Action=GetSnapshotTask&Version=2023-11-01&AppId=Your_AppId&RoomId=Your_RoomId&TaskId=Your_TaskId
json

返回示例

{ 
  "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": "2023-11-01",
    "Service": "rtc",
    "Region": "cn-north-1"
  }
}
json

错误码

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