SubmitSnapshotJob_视频点播_API文档

2017-03-21

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

QPS 限制

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

流控信息

请求速率为30/1(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

vod:SubmitSnapshotJob	Create	全部资源 *	无	无

请求参数

字段名称	字段详情
VideoIdstring	视频 ID。可通过以下方式获取：展开详情示例值:d3e680e618708efbf2cae7cc9312****参考取值来源: UpdateVideoInfos GetVideoList CreateUploadVideo RefreshUploadVideo ListLiveRecordVideo
SpecifiedOffsetTimeinteger<int64>	截图指定时间的起始点。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:0
Widthstring	截图宽，取值范围：`[8,4096]`，默认原片宽，单位：px。示例值:1280
Heightstring	截图高，取值范围：`[8,4096]`，默认原片高，单位：px。示例值:720
Countinteger<int64>	截图的最大数量。默认值：1。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1
Intervalinteger<int64>	截图的间隔时间，必须大于或等于 0。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1
SpriteSnapshotConfigstring	生成雪碧图的配置信息。如果不为空则生成雪碧图。参数结构详情，请参见SpriteSnapshotConfig 。示例值:{'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}
SnapshotTemplateIdstring	截图模板 ID。展开详情示例值:f5b228fe693bf55bd87b789****
UserDatastring	自定义设置。仅支持 JSON 字符串，支持用户自定义数据透传及指定回调地址设置等。参数结构详情，请参见 UserData 。展开详情示例值:{"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
SpecifiedOffsetTimesarray<integer<int64>>	指定视频时间点进行截图，单位：毫秒。一次可指定最多 30 个时间点。

请求说明

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

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:25818875-5F78-5EB0-4AF6-D7393642****
SnapshotJobobject	截图作业信息。

返回示例

变更历史

	变更时间	变更内容概要	操作
	2023-12-15	新增请求参数SpecifiedOffsetTimes

相关示例

截图任务及模板管理

添加截图模板，查询截图模板信息，提交截图转码作业，修改截图模板，删除截图模板

2022-03-09

2024年08月20日