ListFragments - Amazon Kinesis Video Streams
请求语法URI 请求参数请求体响应语法响应元素错误另请参阅
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

ListFragments

返回存档数据中指定流和时间戳范围内的Fragment对象列表。

列出片段最终是一致的。这意味着，即使生产者收到确认片段已保存，也可能不会立即从对的请求中返回结果。ListFragments但是，通常在不到一秒钟的时间内即可获得结果。

注意

您必须先调用 GetDataEndpoint API 才能获取终端节点。然后使用 --endpoint-url 参数将ListFragments请求发送到此端点。

重要

如果在调用 Kinesis Video Streams 存档媒体 API 后出现错误，则除了 HTTP 状态代码和响应正文外，还会包含以下信息：

  • x-amz-ErrorTypeHTTP 标头 — 除了 HTTP 状态码提供的错误类型外，还包含更具体的错误类型。

  • x-amz-RequestIdHTTP 标头 — 如果你想向报告问题Amazon，如果给出请求编号，支持团队可以更好地诊断问题。

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

描述要返回的片段范围的时间戳范围和时间戳来源。

注意

只有在 API 中NextToken未传递时，才需要这样做。

类型：FragmentSelector 对象

必需：否

MaxResults

要返回的片段总数。如果可用片段的总数大于中指定的值max-results，则输出中会提供ListFragments:NextToken，您可以使用它来恢复分页。

默认值是 100。

类型：长整型

有效范围：最小值为 1。最大值为 1000。

必需：否

NextToken

指定从何处开始分页的令牌。这是ListFragments:NextToken来自之前截断的响应。

类型：字符串

长度限制：长度下限为 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 状态代码：400

InvalidArgumentException

指定参数超出其限制、不受支持或无法使用。

HTTP 状态代码：400

NotAuthorizedException

状态码：403，调用者无权对给定直播执行操作，或者令牌已过期。

HTTP 状态代码：401

ResourceNotFoundException

GetImages当 Kinesis Video Streams 找不到你指定的直播时，将引发此错误。

GetHLSStreamingSessionURL如果请求PlaybackMode的会话在请求的时间范围内LIVE_REPLAY没有片段，ON_DEMAND或者在过去 30 秒内没有片段的流请求PlaybackMode的LIVE会话为或时，则会GetDASHStreamingSessionURL抛出此错误。

HTTP 状态代码：404

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息，请参阅以下内容：