ListSnapshots - 查询视频截图数据

调用本接口可以查询通过视频截图作业生成的截图,以及视频上传时系统生成的封面截图。

接口说明

若一个视频发起过多次视频截图,则本接口仅返回最近一次成功的截图数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:ListSnapshotslist
*全部资源
*

请求参数

名称类型必填描述示例值
VideoIdstring

视频 ID。可通过以下方式获取:

d3e680e618708fbf2cae7cc931****
SnapshotTypestring

返回的截图类型。取值:

  • CoverSnapshot(默认值):封面截图。
  • NormalSnapshot:普通截图。
  • SpriteSnapshot:雪碧截图。
  • SpriteOriginSnapshot:雪碧图原始图。
  • WebVttSnapshot:WebVtt 截图。
CoverSnapshot
AuthTimeoutstring

截图访问地址的过期时间。默认值:3600,最小值:3600,单位:秒。

  • 该参数只有开启了 URL 鉴权才会生效。
  • 当设置的时间小于 3600 秒时,默认为3600 秒
  • 如果返回的是 OSS 地址,为降低源站安全风险,最大值为 2592000(即 30 天)。
3600
PageSizestring

翻页大小,每页显示条数。默认值:20,最大值:100

20
PageNostring

翻页页号。默认值:1

1

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

25818875-5F78-4AF6-D7393642CA58****
MediaSnapshotobject

视频截图数据。

CreationTimestring

截图作业创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2017-12-20T12:23:45Z
Regularstring

截图地址生成规则。

http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg
Totallong

截图总数。

100
JobIdstring

截图作业 ID。

ad90a501b1b9472374ad005046****
Snapshotsarray<object>

截图详情。

Snapshotobject
Indexlong

截图索引值。

1
Urlstring

截图访问地址。

http://example.aliyundoc.com/snapshot/sample00001****.jpg

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "MediaSnapshot": {
    "CreationTime": "2017-12-20T12:23:45Z",
    "Regular": "http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg",
    "Total": 100,
    "JobId": "ad90a501b1b9472374ad005046****",
    "Snapshots": {
      "Snapshot": [
        {
          "Index": 1,
          "Url": "http://example.aliyundoc.com/snapshot/sample00001****.jpg"
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
InvalidVideo.NotFoundThe video does not exist.404视频不存在。
NoSuchResourceThe specified resource %s does not exist.404指定资源不存在。
Forbidden.IllegalStatusStatus of the video is illegal.400视频状态无效。只有状态为上传完成正常审核中以及屏蔽的视频才能查询截图数据。