阅读633 返回首页    go 阿里云 go 技术社区[云栖]

提交截图作业__截图接口_API使用手册_媒体转码-阿里云

描述

提交截图作业接口，目前支持生成jpg格式图片。

  • 同步模式：接口同步返回截图结果，截图在接口返回时就已经生成到对应的Bucket。
  • 异步模式：不保证接口返回时截图已经生成，截图任务将进入后台排队，异步执行截图。只要设置了Interval和Num中的任何一个参数，就表示异步模式。
  • 消息通知：提交截图作业时，只要指定了PipelineId参数，完成后将发送异步消息。

请求参数

名称 类型 必填项 描述
Action String 是 操作接口名，系统规定参数，取值： SubmitSnapshotJob
Input String 是 作业输入，JSON对象，Input定义详见术语表。例如：
{
"Bucket":"example-bucket",
"Location":"oss-cn-hangzhou",
"Object":"example.flv"
}
需在控制台中授予此Bucket权限给媒体转码服务。
SnapshotConfig String 是 截图配置，Json对象，详细见附录参数详情，截图配置参数详情。例如，
同步模式：
{
"OutputFile": {
"Bucket": "example-001",
"Location": "oss-cn-hangzhou",
"Object": "example.jpg"
},
"Time": "5"
}
异步模式(5毫秒开始，每间隔20秒截一张，共截10张)：
{
"OutputFile": {
"Bucket": "example-001",
"Location": "oss-cn-hangzhou",
"Object": "{Count}.jpg"
},
"Time": "5",
"Num":"10",
"Interval":"20"
}
PipelineId String 否 管道ID，须保证此管道绑定了可用的消息主题，否则消息无法正确发送。
UserData String 否 用户自定义数据，最大长度1024个字节。

返回参数

名称 类型 描述
SnapshotJob AliyunSnapshotJob 截图作业

示例

请求示例

  1.     https://mts.aliyuncs.com?Time=10&Action=SubmitSnapshotJob&Input=%7b%22Bucket%22%3a%22example-bucket%22%2c%22Location%22%3a%22oss-cn-hangzhou%22%2c%22Object%22%3a%22example.flv%22%7d&SnapshotConfig=%7B%22OutputFile%22%3A%7B%22Bucket%22%3A%22example-001%22%2C%22Location%22%3A%22oss-cn-hangzhou%22%2C%22Object%22%3A%22example.jpg%22%7D%2C%22Time%22%3A%225%22%7D&PipelineId=88c6ca184c0e47098a5b665e2a126797<公共参数>

返回示例

XML格式:

  1.     <SubmitSnapshotJobResponse>
  2.         <RequestId>
  3.             25818875-5F78-4A13-BEF6-D7393642CA58
  4.         </RequestId>
  5.         <SnapshotJob>
  6.             <Id>88c6ca184c0e47098a5b665e2a126797</Id>
  7.             <State>Success</State>
  8.             <Code> </Code>
  9.             <Message> </Message>
  10.             <SnapshotConfig>
  11.                <OutputFile>
  12.                   <Bucket>example-001</Bucket>
  13.                   <Location>oss-cn-hangzhou</Location>
  14.                   <Object>example.png</Object>
  15.                </OutputFile>
  16.                <Time>4</Time>
  17.             </SnapshotConfig>
  18.             <PipelineId>88c6ca184c0e47098a5b665e2a126797</PipelineId>
  19.             <UserData>testid-001</UserData>
  20.             <CreationTime>2014-01-10T12:00:00Z</CreationTime>
  21.         </SnapshotJob>
  22.     </SubmitSnapshotJobResponse>

Json:

  1.     {
  2.         "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3.         "SnapshotJob": {
  4.             "Id": "88c6ca184c0e47098a5b665e2a126797",
  5.             "State": "Success",
  6.              "Code": "",
  7.             "Message": "",
  8.             “SnapshotConfig”:{
  9.                "OutputFile": {
  10.                    "Bucket": "example-001",
  11.                    "Location": "oss-cn-hangzhou",
  12.                    "Object": "example.png"
  13.                },
  14.                “Time”:”5”
  15.              },
  16.              "PipelineId": "88c6ca184c0e47098a5b665e2a126797",
  17.              "UserData": "testid-001",
  18.              "CreationTime": "2014-01-10T12:00:00Z"
  19.        }
  20.     }

最后更新：2016-11-23 16:04:03

  上一篇：go 列出转码作业__转码接口_API使用手册_媒体转码-阿里云
  下一篇：go 查询截图作业__截图接口_API使用手册_媒体转码-阿里云