查詢某一段時間內截圖內容。
介面說明
調用本介面僅支援查詢一年內的截圖資料。
QPS 限制
本介面的單使用者 QPS 限制為 100 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:DescribeLiveStreamSnapshotInfo |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DomainName |
string |
是 |
主播流網域名稱。 |
example.com |
| AppName |
string |
是 |
播流所屬應用程式名稱。 |
liveApp**** |
| StreamName |
string |
是 |
播流名稱。 |
liveStream**** |
| StartTime |
string |
是 |
開始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2017-12-21T08:00:00Z |
| EndTime |
string |
是 |
結束時間。EndTime 和 StartTime 之間的間隔不能超過 1 天。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2017-12-22T08:00:00Z |
| Limit |
integer |
否 |
一次調用擷取的數量。取值範圍:1~100, 預設值:10。 |
10 |
| Order |
string |
否 |
排序。取值:
|
asc |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| NextStartTime |
string |
下一個起始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 說明
當此時間範圍內的內容超出了 Limit 的取值範圍,則返回此參數,為下一個檔案的建立時間。可以將此時間當做 StartTime,重新調用此介面擷取下一段內容,不傳則表示未超出 Limit 取值範圍。 |
2015-12-01T17:36:00Z |
| RequestId |
string |
請求 ID。 |
62136AE6-7793-45ED-B14A-60D19A9486D3 |
| LiveStreamSnapshotInfoList |
object |
||
| LiveStreamSnapshotInfo |
array<object> |
截圖內容列表。 |
|
|
object |
|||
| OssObject |
string |
OSS 儲存的檔案名稱。 |
{liveApp****}/{liveStream****}.jpg |
| OssBucket |
string |
OSS 儲存 Bucket 名稱。 |
liveBucket**** |
| CreateTime |
string |
截圖產生時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC 時間)。 |
2015-12-01T17:36:00Z |
| OssEndpoint |
string |
OSS 儲存的 Endpoint 名稱。 |
cn-oss-****.aliyuncs.com |
| IsOverlay |
boolean |
截圖方式。取值:
|
false |
| CreateTimestamp |
integer |
截圖檔案建立的毫秒級時間戳記。 |
1653641526637 |
樣本
正常返回樣本
JSON格式
{
"NextStartTime": "2015-12-01T17:36:00Z",
"RequestId": "62136AE6-7793-45ED-B14A-60D19A9486D3",
"LiveStreamSnapshotInfoList": {
"LiveStreamSnapshotInfo": [
{
"OssObject": "{liveApp****}/{liveStream****}.jpg",
"OssBucket": "liveBucket****",
"CreateTime": "2015-12-01T17:36:00Z",
"OssEndpoint": "cn-oss-****.aliyuncs.com",
"IsOverlay": false,
"CreateTimestamp": 1653641526637
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | |
| 400 | InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | |
| 400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | 結束時間與開始時間不匹配,請您確認時間的匹配度。 |
| 400 | InvalidStream.NotFound | Speicified stream does not exist. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。