GetRecords

Получает сообщения из сегмента потока данных.

Значение ShardIterator определяет позицию в сегменте, с которой будет начато последовательное чтение сообщений. Если в сегменте нет новых сообщений, GetRecords возвращает пустой список. В этом случае повторите вызов GetRecords.

При циклическом чтении сообщений из потока нужно использовать GetShardIterator, чтобы получить итератор сегмента для использования в первом запросе GetRecords. Для последующих чтений можно использовать значение NextShardIterator, которое возвращается в ответе GetRecords. Если сегмент был закрыт, GetRecords возвращает null в значении NextShardIterator.

Размер данных, которые возвращаются GetRecords ограничен 2 МБ/с, метод можно вызывать не чаще, чем 5 раз в секунду. Если в результате вызова GetRecords возвращается большее количество данных, то последующие вызовы будут завершаться с ошибкой ProvisionedThroughputExceededException, пока пропускная способность не вернется к значению 2 МБ/с. Например, если в результате запроса вернулось 10 МБ/с, последующие запросы в течение 5 секунд будут завершаться с ошибкой.

Чтобы определить, успевает ли ваше приложение обрабатывать все поступающие в сегмент данные, можно использовать значение MillisBehindLatest в ответе.

Запрос

Запрос содержит данные в формате JSON.

{
  "Limit": number,
  "ShardIterator": "string"
}

Параметры запроса

Ответ

В случае успеха возвращаются HTTP-ответ с кодом 200 и данные в формате JSON.

{
  "ChildShards": [{
    "HashKeyRange": {
      "EndingHashKey": "string",
      "StartingHashKey": "string"
    },
    "ParentShards": ["string"],
    "ShardId": "string"
  }],
  "MillisBehindLatest": number,
  "NextShardIterator": "string",
  "Records": [{
    "ApproximateArrivalTimestamp": number,
    "Data": blob,
    "EncryptionType": "string",
    "PartitionKey": "string",
    "SequenceNumber": "string"
  }]
}

Параметры ответа

Ошибки

Могут возникать ошибки, общие для всех методов.