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

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

类型：FragmentSelector 对象

必需：否

MaxResults

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

类型：长整型

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

必需：否

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 状态代码：400

InvalidArgumentException

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

HTTP 状态代码：400

NotAuthorizedException

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

HTTP 状态代码：401

ResourceNotFoundException

GetImages当 Kinesis Video Streams 找不到你指定的直播时会抛出这个错误。

GetHLSStreamingSessionURL如果在请求的时间范围内没有片段PlaybackMode的流请求了带有LIVE_REPLAY ofON_DEMAND 或的会话，或者对于在过去 30 秒内没有片段PlaybackMode的LIVE流请求了带有 of 的会话，则会GetDASHStreamingSessionURL引发此错误。

HTTP 状态代码：404

另请参阅

有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：