Yandex Cloud
  • Сервисы
  • Решения
  • Почему Yandex Cloud
  • Сообщество
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Language / Region
© 2022 ООО «Яндекс.Облако»
Yandex Data Streams
  • Начало работы
    • Подготовка окружения
    • Создание потока данных
    • Сбор и поставка данных
      • Fluentd
      • Logstash
      • AWS CLI
    • Сохранение данных в ClickHouse
    • Обработка потока изменений из Debezium
  • Пошаговые инструкции
    • Все инструкции
    • Управление потоками данных
    • Работа с AWS CLI
      • Создание потока данных
      • Получение информации о потоке
      • Отправка данных в поток
      • Чтение данных из потока
      • Удаление потока данных
    • Работа с AWS SDK
      • Подготовка окружения
      • Создание потока данных
      • Отправка данных в поток
      • Чтение данных из потока
      • Удаление потока данных
  • Концепции
    • Обзор
    • Термины и определения
    • Cегменты и ключи сегментов
    • Квоты и лимиты
    • Сравнение с Yandex Message Queue
  • Практические руководства
    • Ввод данных в системы хранения
    • Умная обработка логов
    • Передача данных в микросервисных архитектурах
  • Управление доступом
  • Правила тарификации
  • HTTP API, совместимый с Amazon Kinesis Data Streams
    • Обзор
    • Методы
      • CreateStream
      • DecreaseStreamRetentionPeriod
      • DeleteStream
      • DescribeStream
      • IncreaseStreamRetentionPeriod
      • GetRecords
      • GetShardIterator
      • ListStreams
      • PutRecord
      • PutRecords
      • UpdateShardCount
    • Общие ошибки
    • Примеры
  • Вопросы и ответы
  1. HTTP API, совместимый с Amazon Kinesis Data Streams
  2. Методы
  3. ListStreams

ListStreams

Статья создана
Yandex Cloud
  • Запрос
    • Параметры запроса
  • Ответ
    • Параметры ответа
  • Ошибки

Выводит список потоков данных.

Параметр ответа HasMoreStreams указывает, что остались невыведенные потоки. Чтобы запросить их, укажите имя последнего возвращенного потока в качестве значения ExclusiveStartStreamName следующего запроса.

Запрос

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

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

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

Параметр Описание
ExclusiveStartStreamName Имя потока, с которого начнется вывод.

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

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

Ответ

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

{
  "HasMoreStreams": boolean,
  "StreamNames": ["string"]
}

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

Параметр Описание
HasMoreStreams Если значение true, в списке остались невыведенные потоки.

Тип: Булев
StreamNames Имя потока данных.

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

Ошибки

Параметр Описание
LimitExceededException Превышено максимальное число запросов.

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

Была ли статья полезна?

Language / Region
© 2022 ООО «Яндекс.Облако»
В этой статье:
  • Запрос
  • Параметры запроса
  • Ответ
  • Параметры ответа
  • Ошибки