ListStreams

Статья создана

Запрос
- Параметры запроса
Ответ
- Параметры ответа
Ошибки

Параметр ответа 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`	Превышено максимальное число запросов.

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