調用DescribeLiveStreamSnapshotInfo查詢某一段時間內截圖內容。

使用說明

調用本接口僅支持查詢一年內的截圖數據。

QPS限制

本接口的單用戶QPS限制為100次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeLiveStreamSnapshotInfo

系統規定參數。取值：DescribeLiveStreamSnapshotInfo。

DomainName String 是 example.com

主播流域名。
AppName String 是 liveApp****

播流所屬應用名稱。
StreamName String 是 liveStream****

播流名稱。
StartTime String 是 2017-12-21T08:00:00Z

開始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

EndTime String 是 2017-12-22T08:00:00Z

結束時間。EndTime和StartTime之間的間隔不能超過1天。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

Limit Integer 否 10

一次調用獲取的數量。取值范圍：1~100， 默認值：10。

Order String 否 asc

排序。取值：

  • asc（默認值）：升序。
  • desc：降序。

返回數據

名稱 類型 示例值 描述
NextStartTime String 2015-12-01T17:36:00Z

下一個起始時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

說明 當此時間范圍內的內容超出了Limit的取值范圍，則返回此參數，為下一個文件的創建時間。可以將此時間當做StartTime，重新調用此接口獲取下一段內容，不傳則表示未超出Limit取值范圍。
RequestId String 62136AE6-7793-45ED-B14A-60D19A9486D3

請求ID。
LiveStreamSnapshotInfoList Array of LiveStreamSnapshotInfo

截圖內容列表。
LiveStreamSnapshotInfo
OssObject String {liveApp****}/{liveStream****}.jpg

OSS存儲的文件名。
OssBucket String liveBucket****

OSS存儲Bucket名稱。
CreateTime String 2015-12-01T17:36:00Z

截圖產生時間。格式為：yyyy-MM-ddTHH:mm:ssZ（UTC時間）。

OssEndpoint String cn-oss-****.aliyuncs.com

OSS存儲的Endpoint名稱。
IsOverlay Boolean false

截圖方式。取值：

  • true：覆蓋截圖。
  • false：序列截圖。
CreateTimestamp Long 1653641526637

截圖文件創建的毫秒級時間戳。

示例

請求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamSnapshotInfo
&DomainName=example.com
&AppName=liveApp****
&StreamName=liveStream****
&StartTime=2017-12-21T08:00:00Z
&EndTime=2017-12-22T08:00:00Z
&公共請求參數

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamSnapshotInfoResponse>
    <NextStartTime>2015-12-01T17:36:00Z</NextStartTime>
    <RequestId>62136AE6-7793-45ED-B14A-60D19A9486D3</RequestId>
    <LiveStreamSnapshotInfoList>
        <OssObject>{liveApp****}/{liveStream****}.jpg</OssObject>
        <OssBucket>liveBucket****</OssBucket>
        <CreateTime>2015-12-01T17:36:00Z</CreateTime>
        <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>
        <IsOverlay>false</IsOverlay>
        <CreateTimestamp>1653641526637</CreateTimestamp>
    </LiveStreamSnapshotInfoList>
</DescribeLiveStreamSnapshotInfoResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextStartTime" : "2015-12-01T17:36:00Z",
  "RequestId" : "62136AE6-7793-45ED-B14A-60D19A9486D3",
  "LiveStreamSnapshotInfoList" : [ {
    "OssObject" : "{liveApp****}/{liveStream****}.jpg",
    "OssBucket" : "liveBucket****",
    "CreateTime" : "2015-12-01T17:36:00Z",
    "OssEndpoint" : "cn-oss-****.aliyuncs.com",
    "IsOverlay" : false,
    "CreateTimestamp" : 1653641526637
  } ]
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
400 InvalidStartTime.Malformed Specified parameter StartTime is not valid. StartTime參數錯誤，請您確認該StartTime參數是否正確。
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. 直播流不存在，請您確認直播流是否正確。

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