ListFragments - Amazon Kinesis Video Streams
請求語法URI請求參數請求主體回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

ListFragments

傳回封存資料內指定串流和時間戳記範圍的Fragment物件清單。

列出片段最終是一致的。這意味著即使生產者收到片段已持續存在的確認，結果也可能不會立即從請求返回。ListFragments但是，通常不到一秒鐘的時間就可以獲得結果。

注意

您必須先呼叫GetDataEndpointAPI以取得端點。然後使用 --end 點 url 參數將ListFragments請求發送到此端點。

重要

如果在叫用 Kinesis Video Streams 封存媒體之後擲回錯誤API，除了HTTP狀態碼和回應本文之外，它還包含下列資訊：

  • x-amz-ErrorTypeHTTPheader — 除了HTTP狀態碼提供的內容之外，還包含更具體的錯誤類型。

  • x-amz-RequestIdHTTP標題 — 如果您想向其報告問題 AWS，則支持團隊可以更好地診斷問題，如果提供請求 ID。

HTTP狀態碼和 ErrorType 標頭都可以用來做出關於錯誤是否可重試以及在什麼情況下是否可重試的程式設計決定，以及提供有關用戶端程式設計人員可能需要採取哪些動作才能成功再試一次的資訊。

如需詳細資訊，請參閱本主題底部的「錯誤」一節，以及常見錯誤。

請求語法

POST /listFragments HTTP/1.1
Content-type: application/json

{
   "FragmentSelector": { 
      "FragmentSelectorType": "string",
      "TimestampRange": { 
         "EndTimestamp": number,
         "StartTimestamp": number
      }
   },
   "MaxResults": number,
   "NextToken": "string",
   "StreamARN": "string",
   "StreamName": "string"
}

URI請求參數

請求不使用任何URI參數。

請求主體

請求接受以下JSON格式的數據。

FragmentSelector

描述要傳回之片段範圍的時間戳記範圍和時間戳記來源。

注意

只有在NextToken未傳入的情況下才需要此選項API。

類型：FragmentSelector 物件

必要：否

MaxResults

要傳回的片段總數。如果可用的片段總數大於中指定的值max-results，則輸出中會NextToken提供ListFragments:，您可以用來繼續分頁。

預設值為 100.

類型：Long

有效範圍：最小值為 1。最大值為 1000。

必要：否

NextToken

用以指定分頁開始位置的字符。這是NextToken來自先前截斷的回應的ListFragments:。

類型：字串

長度限制：長度下限為 1。長度上限為 4096。

模式：[a-zA-Z0-9+/]+={0,2}

必要：否

StreamARN

要從中擷取片段清單的資料流的 Amazon 資源名稱 (ARN)。指定此參數或StreamName參數。

類型：字串

長度限制：長度下限為 1。長度上限為 1024。

模式：arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

必要：否

StreamName

要從中擷取片段清單的資料流名稱。指定此參數或StreamARN參數。

類型：字串

長度限制：長度下限為 1。長度上限為 256。

模式：[a-zA-Z0-9_.-]+

必要：否

回應語法

HTTP/1.1 200
Content-type: application/json

{
   "Fragments": [ 
      { 
         "FragmentLengthInMilliseconds": number,
         "FragmentNumber": "string",
         "FragmentSizeInBytes": number,
         "ProducerTimestamp": number,
         "ServerTimestamp": number
      }
   ],
   "NextToken": "string"
}

回應元素

如果動作成功，服務會傳回 HTTP 200 回應。

服務會以JSON格式傳回下列資料。

Fragments

串流中符合選取器準則的封存Fragment物件清單。結果沒有特定的順序，即使跨頁面也是如此。

如果流中沒有符合選擇條件的片段，則返回一個空列表。

類型：Fragment 物件陣列

NextToken

如果返回的列表被截斷，則操作返回此令牌以用於檢索結果的下一頁。這個值是null當沒有更多的結果要返回時。

類型：字串

長度限制：長度下限為 1。長度上限為 4096。

模式：[a-zA-Z0-9+/]+={0,2}

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

ClientLimitExceededException

Kinesis Video Streams 已限制要求，因為您已超過限制。稍後再嘗試撥打電話。如需限制的相關資訊，請參閱 Kinesis Video Streams 配額。

HTTP狀態碼:

InvalidArgumentException

指定的參數超出其限制、不受支援或無法使用。

HTTP狀態碼:

NotAuthorizedException

狀態碼：403，調用者未授權在給定流上執行操作，或令牌已過期。

HTTP狀態碼:4

ResourceNotFoundException

GetImages當 Kinesis 影片串流找不到您指定的串流時，就會擲回此錯誤。

GetHLSStreamingSessionURL如果在請求的時間範圍內沒有片段PlaybackMode的流請求具有 ON_DEMAND or LIVE_REPLAY 的會話，或者如果在過去 30 秒內沒有片段PlaybackMode的LIVE流請求具有 of 的會話，則GetDASHStreamingSessionURL拋出此錯誤。

HTTP狀態碼:

另請參閱

如需有關API在其中一種特定語言中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：