提交截圖作業(yè)。調用本接口之后媒體處理MPS會對輸入文件進行截圖和拼圖。
接口說明
-
輸入單個文件大小最大支持 100 GB，超過可能導致執(zhí)行失敗。
-
請確認文件已成功上傳至 OSS 后再提交截圖作業(yè)，否則會導致執(zhí)行失敗。您可通過配置 OSS 回調消息確認文件上傳狀態(tài)。
-
截圖作業(yè)分為同步和異步模式。
- 同步模式僅支持單張截圖，會在接口返回時生成圖片。
- 異步模式不保證時效性，在提交截圖作業(yè)后，任務會添加到管道中排隊，被調度執(zhí)行。所以在接口返回時，不保證截圖已經生成。執(zhí)行完成后需要調用查詢截圖作業(yè)結果接口輪詢執(zhí)行結果，或通過為管道綁定 MNS 消息接收執(zhí)行結果，具體請參見接收消息通知。
- 只要設置了 Interval 和 Num 中的任何一個參數，就表示使用異步模式。
-
目前僅支持生成 JPG 格式圖片。
-
更多截圖常見問題，請參見截圖常見問題。
QPS 限制
本接口的單用戶 QPS 限制為 50 次/秒。超過限制，API 調用會被限流，這可能會影響您的業(yè)務，請合理調用。更多信息，請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| mts:SubmitSnapshotJob | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Input | string | 是 | 作業(yè)輸入。詳細說明請參見 Input 詳情。 說明
| {"Bucket":"example-bucket","Location":"example-location","Object":"example%2Ftest.flv"} |
| SnapshotConfig | string | 是 | 截圖配置。詳細說明，請參見 SnapshotConfig 參數詳情。 | {"OutputFile":{"Bucket":"example-001","Location":"example-location","Object":"{Count}.jpg"},"Time":"5","Num":"10","Interval":"20"} |
| UserData | string | 否 | 用戶自定義數據。支持中英文、數字、短劃線（-），不能以特殊字符開頭，最大長度 1024 個字節(jié)。 | testid-001 |
| PipelineId | string | 否 | dd3dae411e704030b921e52698e5**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "19B6D8C5-A5DD-467A-B435-29D393C71E2D",
"SnapshotJob": {
"CreationTime": "2021-05-19T03:11:48Z",
"SnapshotConfig": {
"Time": "5",
"TileOut": {
"Padding": "0",
"Color": "black",
"CellSelStep": "3",
"CellHeight": "100",
"CellWidth": "100",
"Margin": "5",
"Columns": "10",
"IsKeepCellPic": "false",
"Lines": "10"
},
"Interval": "20",
"FrameType": "intra",
"Width": "8",
"Height": "8",
"OutputFile": {
"RoleArn": "acs:ram::1:role/testrole",
"Object": "test.png",
"Location": "example-location",
"Bucket": "example"
},
"Num": "10",
"TileOutputFile": {
"RoleArn": "acs:ram::1:role/testrole",
"Object": "example.png",
"Location": "example-location",
"Bucket": "example"
},
"TimeArray": {
"TimePointList": [
0
]
}
},
"State": "Snapshoting",
"Message": "The resource operated InputFile is bad",
"MNSMessageResult": {
"MessageId": "799454621135656C7F815F198A76****",
"ErrorMessage": "The resource operated InputFile is bad",
"ErrorCode": "InvalidParameter"
},
"Input": {
"RoleArn": "acs:ram::1:role/testrole",
"Object": "example.flv",
"Location": "example-location'",
"Bucket": "example"
},
"Count": "1",
"TileCount": "5",
"UserData": "testid-001",
"Code": "ResourceContentBad",
"PipelineId": "dd3dae411e704030b921e52698e5****",
"Id": "f4e3b9ba9f3840c39d6e288056f0****"
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-04-24 | OpenAPI 返回結構發(fā)生變更 | 查看變更詳情 |
| 2024-04-10 | API 內部配置變更，不影響調用 | 查看變更詳情 |