調(diào)用ListSnapshots可以查詢通過(guò)視頻截圖作業(yè)生成的截圖，以及視頻上傳時(shí)系統(tǒng)生成的封面截圖。
接口說(shuō)明
若一個(gè)視頻發(fā)起過(guò)多次視頻截圖，則本接口僅返回最近一次成功的截圖數(shù)據(jù)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀?。≧ead）或列出（List）。
- 資源類(lèi)型：是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下：
- 對(duì)于必選的資源類(lèi)型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| vod:ListSnapshots | List |
|
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類(lèi)型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| VideoId | string | 是 | 視頻 ID?？赏ㄟ^(guò)以下方式獲取：
| d3e680e618708fbf2cae7cc931**** |
| SnapshotType | string | 否 | 返回的截圖類(lèi)型。取值：
| CoverSnapshot |
| AuthTimeout | string | 否 | 截圖訪問(wèn)地址的過(guò)期時(shí)間。默認(rèn)值：3600，最小值：3600，單位：秒。
| 3600 |
| PageSize | string | 否 | 翻頁(yè)大小，每頁(yè)顯示條數(shù)。默認(rèn)值：20，最大值：100。 | 20 |
| PageNo | string | 否 | 翻頁(yè)頁(yè)號(hào)。默認(rèn)值：1。 | 1 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****",
"MediaSnapshot": {
"CreationTime": "2017-12-20T12:23:45Z",
"Regular": "http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg",
"Total": 100,
"JobId": "ad90a501b1b9472374ad005046****",
"Snapshots": {
"Snapshot": [
{
"Index": 1,
"Url": "http://example.aliyundoc.com/snapshot/sample00001****.jpg"
}
]
}
}
}錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
接口錯(cuò)誤碼
下表列舉了本接口特有的錯(cuò)誤碼。
| 錯(cuò)誤代碼 | 錯(cuò)誤信息 | HTTP 狀態(tài)碼 | 說(shuō)明 |
|---|---|---|---|
| InvalidVideo.NotFound | The video does not exist. | 404 | 視頻不存在。 |
| NoSuchResource | The specified resource %s does not exist. | 404 | 指定資源不存在。 |
| Forbidden.IllegalStatus | Status of the video is illegal. | 400 | 視頻狀態(tài)無(wú)效。只有狀態(tài)為上傳完成、正常、審核中以及屏蔽的視頻才能查詢截圖數(shù)據(jù)。 |