Связаться с намиПодключиться

DescribeStream

Статья создана
Обновлена 24 августа 2021 г.

Возвращает информацию о потоке данных.

Вы можете ограничить количество описаний сегментов, возвращаемых каждым вызовом метода, с помощью параметра Limit.

Запрос

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

{
  "ExclusiveStartShardId": "string",
  "Limit": number,
  "StreamName": "string"
}

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

Параметр Описание
ExclusiveStartShardId Идентификатор сегмента. Информация о сегментах потока выводится, начиная с сегмента, который следует за указанным. По умолчанию выводится информация, начиная с первого сегмента в потоке.

Тип: Целое число
Возможные значения: [a-zA-Z0-9_.-]+
Обязательный: Нет
Limit Максимальное количество описаний сегментов, возвращаемых за один вызов. Если вы укажете значение больше 100, то будет возвращено не более 100 описаний.

Тип: Целое число
Возможные значения: 1-10000.
Значение по умолчанию: 100
Обязательный: Нет
StreamName Имя потока данных.

Тип: Строка
Размер: 1-128 символов.
Возможные значения: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$
Обязательный: Да

Ответ

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

{
  "StreamDescription": {
    "EncryptionType": "string",
    "EnhancedMonitoring": [{
      "ShardLevelMetrics": ["string"]
    }],
    "HasMoreShards": boolean,
    "KeyId": "string",
    "RetentionPeriodHours": number,
    "Shards": [{
      "AdjacentParentShardId": "string",
      "HashKeyRange": {
        "EndingHashKey": "string",
        "StartingHashKey": "string"
      },
      "ParentShardId": "string",
      "SequenceNumberRange": {
        "EndingSequenceNumber": "string",
        "StartingSequenceNumber": "string"
      },
      "ShardId": "string"
    }],
    "StreamCreationTimestamp": number,
    "StreamName": "string",
    "StreamStatus": "string"
  }
}

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

Параметр Описание
StreamDescription Состояние потока.

Тип: Объект StreamDescription

Ошибки

Параметр Описание Код HTTP
LimitExceededException Превышено максимальное число запросов. 400
ResourceNotFoundException Запрошенный ресурс не найден. 400

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

Предыдущая
DeleteStream
Следующая
IncreaseStreamRetentionPeriod