提交截图作业接口。

说明 目前支持生成jpg格式图片
  • 异步模式：不保证接口返回时截图已经生成，截图任务将进入后台排队，异步执行截图。只要设置了Interval和Num中的任何一个参数，就表示异步模式。
  • 消息通知：提交截图作业时，只要指定了PipelineId参数，完成后将发送异步消息。

请求参数

名称 类型 是否必须 描述
Action String 是 操作接口名，系统规定参数，取值： SubmitSnapshotJob
Input String 是 作业输入。
SnapshotConfig String 是 截图配置。
  • Json对象，详细见附录SnapshotConfig参数详情，截图配置参数详情。
  • 例如：
    • 异步模式：(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 截图作业

示例

请求示例 
http://mts.cn-hangzhou.aliyuncs.com?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<Public parameter>

返回示例

XML 
<SubmitSnapshotJobResponse>
        <RequestId>
            25818875-5F78-4A13-BEF6-D7393642CA58
        </RequestId>
        <SnapshotJob>
            <Id>88c6ca184c0e47098a5b665e2a126797</Id>
            <State>Success</State>
            <Code> </Code>
            <Message> </Message>
            <SnapshotConfig>
               <OutputFile>
                  <Bucket>example-001</Bucket>
                  <Location>oss-cn-hangzhou</Location>
                  <Object>example.png</Object>
               </OutputFile>
               <Time>4</Time>
            </SnapshotConfig>
            <PipelineId>88c6ca184c0e47098a5b665e2a126797</PipelineId>
            <UserData>testid-001</UserData>
            <CreationTime>2014-01-10T12:00:00Z</CreationTime>
        </SnapshotJob>
    </SubmitSnapshotJobResponse>
JSON 
{
        "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
        "SnapshotJob": {
            "Id": "88c6ca184c0e47098a5b665e2a126797",
            "State": "Success",
             "Code": "",
            "Message": "",
            “SnapshotConfig”:{
               "OutputFile": {
                   "Bucket": "example-001",
                   "Location": "oss-cn-hangzhou",
                   "Object": "example.png"
               },
               “Time”:”5”
             },
             "PipelineId": "88c6ca184c0e47098a5b665e2a126797",
             "UserData": "testid-001",
             "CreationTime": "2014-01-10T12:00:00Z"
       }
    }

截图错误码

错误代码 描述 详细信息
InvalidParameter.ResourceNotFound 截图文件没有找到 The resource operated cannot be found.
SnapshotTimeOut 截图超时，如果同步截图超时情况频繁时，建议采用异步方式截图避免超时情况，不建议重试 Snapshot times out.
InvalidParameter.ResourceContentBad 截图文件内容已经损坏，或者不符合规格导致截图失败 The resource operated is broken.
EntityNotExist.Role 角色不存在 The role not exists.
PermissionDenied.ResourceAccess 授权存在问题 MTS not authorized to operate on the specified resource.
InternalError 内部未识别错误 The operation has failed due to some unknown error, exception or failure.
TransientNetWorkError 下载数据时碰到短暂的网络错误，一般可通过重试恢复 Snapshot fail,transient network error occurs, please retry again!