调用SubmitSnapshotJob提交媒体截图作业_视频点播(VOD)-阿里云帮助中心

调用本接口提交视频截图作业，开始异步截图处理。

接口说明

暂时只支持生成 JPG 格式的图片。
截图完成会产生 EventType=SnapshotComplete,SubType=SpecifiedTime 的视频截图完成的事件通知。

QPS 限制

本接口的单用户 QPS 限制为 30 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vod:SubmitSnapshotJob		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
VideoId	string	是	视频 ID。可通过以下方式获取：通过控制台上传的视频，可登录点播控制台，选择媒资库 > 音/视频查看视频 ID。通过获取视频上传地址和凭证接口获取上传地址和凭证时，视频 ID 为返回参数 VideoId 的值。视频上传后，可通过搜索媒体信息接口查询视频 ID，为请求后返回参数 VideoId 的值。	d3e680e618708efbf2cae7cc9312****
SpecifiedOffsetTime	long	否	截图指定时间的起始点。单位：毫秒。默认值：0。	0
Width	string	否	截图宽，取值范围：`[8,4096]`，默认原片宽，单位：px。	1280
Height	string	否	截图高，取值范围：`[8,4096]`，默认原片高，单位：px。	720
Count	long	否	截图的最大数量。默认值：1。	1
Interval	long	否	截图的间隔时间，必须大于或等于 0。单位：秒。默认值：1。 Interval 为 0 时，表示按照 Count 数根据视频时长平均截图。	1
SpriteSnapshotConfig	string	否	生成雪碧图的配置信息。如果不为空则生成雪碧图。参数结构详情，请参见SpriteSnapshotConfig 。	{'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}
SnapshotTemplateId	string	否	截图模板 ID。推荐先创建截图模板，再传递截图模板 ID。截图模板创建详情，请参见添加截图模板。如果传递截图模板 ID，会忽略除 Action、VideoId 之外的请求参数。	f5b228fe693bf55bd87b789****
UserData	string	否	自定义设置。仅支持 JSON 字符串，支持用户自定义数据透传及指定回调地址设置等。参数结构详情，请参见 UserData 。说明此参数中消息回调的使用前提是需要在控制台配置 HTTP 回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。	{"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
SpecifiedOffsetTimes	array	否	指定视频时间点进行截图，单位：毫秒。一次可指定最多 30 个时间点。
	long	否	自定义时间点，毫秒	1000

说明 Count 和 Interval 至少指定一个，若同时指定，截图数目以少者为准。

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	25818875-5F78-5EB0-4AF6-D7393642****
SnapshotJob	object	截图作业信息。
JobId	string	截图作业 ID。	ad90a501b1b94b72374ad0050464****

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-5EB0-4AF6-D7393642****",
  "SnapshotJob": {
    "JobId": "ad90a501b1b94b72374ad0050464****"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-12-15	OpenAPI 入参发生变更	查看变更详情

接口错误码

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

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