GetSnapshotJob API 概覽 - 智能媒體服務

查詢截圖任務詳細資料。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ice:GetSnapshotJob

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
JobId	string	是	截圖任務 ID。	**d80e4e4044975745c14b**

返回參數

名稱	類型	描述	樣本值
	object	PlainResponse
RequestId	string	請求 ID	****11-DB8D-4A9A-875B-275798****
SnapshotJob	object	截圖任務資訊
JobId	string	任務 ID	**d80e4e4044975745c14b**
TriggerSource	string	請求觸發來源枚舉值： Console : 控制台 Workflow : 工作流程 API : API	API
Name	string	任務名稱	測試工作
Type	string	截圖類型枚舉值： WebVtt : WebVTT 截圖 Sprite : 雪碧圖截圖 Normal : 普通靜態截圖	Sprite
Input	object	任務輸入
Type	string	輸入類型，取值： OSS：oss 檔案地址 Media：媒資 ID	OSS
Media	string	輸入媒體。當 Type 為 OSS 時填入 OSS 地址，Type 為 Media 時填入媒資 ID。 OSS 地址規則為： oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中 bucket 為和當前專案處於同一地區的 oss bucket 名稱，object 為檔案路徑。	oss://test-bucket/object.mp4
OssFile	object	OSS 三元組
Bucket	string	OSS Bucket	test-bucket
Location	string	OSS Location	oss-cn-shanghai
Object	string	OSS Object	object.mp4
Output	object	任務輸出
Type	string	輸出類型，取值： OSS：oss 檔案地址 Media：媒資 ID	OSS
Media	string	輸出媒體。當 Type 為 OSS 時填入 OSS 地址，Type 為 Media 時填入媒資 ID。 OSS 地址規則為： oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中，bucket 為和當前專案處於同一地區的 oss bucket 名稱，object 為檔案路徑。截取多張靜態截圖時，object 必須要帶有”{Count}“預留位置；截取雪碧圖時，object 必須要帶有“{TileCount}”預留位置。 WebVTT 截圖 object 的尾碼必須是“.vtt”。	http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg
OssFile	object	OSS 三元組
Bucket	string	OSS Bucket	test-bucket
Location	string	OSS Location	oss-cn-shanghai
Object	string	OSS Object	output-{Count}.jpg
Count	integer	截圖數量	8
Async	boolean	是否非同步截圖。預設：true	true
TemplateId	string	模板 ID	**d80e4e4044975745c14b**
TemplateConfig	string	截圖模板配置	{"Type":"Normal","FrameType":"normal","Time":0,"Count":10}
PipelineId	string	管道 ID	**d80e4e4044975745c14b**
Status	string	任務狀態枚舉值： Init : 已提交 Success : 成功 Fail : 失敗	Success
Code	string	錯誤碼	ResourceNotFound
Message	string	錯誤訊息	The specified resource for "Pipeline" could not be found.
SubmitTime	string	任務提交時間	2022-07-12T16:17:54Z
FinishTime	string	任務完成時間	2022-07-12T16:30:54Z
UserData	string	使用者自訂參數。	{"test parameter": "test value"}
CreateTime	string	建立時間	2022-07-12T16:17:54Z
ModifiedTime	string	最後修改時間	2022-07-12T16:30:54Z

樣本

正常返回樣本

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "SnapshotJob": {
    "JobId": "****d80e4e4044975745c14b****",
    "TriggerSource": "API",
    "Name": "測試工作",
    "Type": "Sprite",
    "Input": {
      "Type": "OSS",
      "Media": "oss://test-bucket/object.mp4",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "object.mp4"
      }
    },
    "Output": {
      "Type": "OSS",
      "Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "output-{Count}.jpg"
      }
    },
    "Count": 8,
    "Async": true,
    "TemplateId": "****d80e4e4044975745c14b****",
    "TemplateConfig": "{\"Type\":\"Normal\",\"FrameType\":\"normal\",\"Time\":0,\"Count\":10}",
    "PipelineId": "****d80e4e4044975745c14b****",
    "Status": "Success",
    "Code": "ResourceNotFound",
    "Message": "The specified resource for \"Pipeline\" could not be found.",
    "SubmitTime": "2022-07-12T16:17:54Z",
    "FinishTime": "2022-07-12T16:30:54Z",
    "UserData": "{\"test parameter\": \"test value\"}",
    "CreateTime": "2022-07-12T16:17:54Z",
    "ModifiedTime": "2022-07-12T16:30:54Z"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。