提交截圖作業介面。

说明 目前支援產生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對象，詳細見附錄SnapshotConfig參數詳情，截圖配置參數詳情。
  • 例如：
    • 同步模式：
      {"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 截圖作業

樣本

請求樣本 
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!