UpdateShardCount
Статья создана
Обновлена 23 сентября 2021 г.
Обновляет количество сегментов указанного потока данных. Доступно только увеличение числа сегментов.
При успехе метод переводит поток в статус UPDATING и возвращает HTTP-ответ с кодом 200 и данные в формате JSON. После завершения обновления поток будет переведен в статус ACTIVE. Время масштабирования зависит от размера потока и может занять несколько минут. Можно продолжать читать данные из потока и записывать данные в поток в статусе UPDATING.
Запрос
Запрос содержит данные в формате JSON.
{
"ScalingType": "string",
"StreamName": "string",
"TargetShardCount": number
}
Параметры запроса
| Параметр | Описание |
|---|---|
ScalingType |
Тип масштабирования. Масштабирование UNIFORM_SCALING создает сегменты одинакового размера.Тип: Строка Возможные значения: UNIFORM_SCALINGОбязательный: Да |
StreamName |
Имя потока данных. Тип: Строка Размер: 1-128 символов.Возможные значения: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$Обязательный: Да |
TargetShardCount |
Целевое количество сегментов. Тип: Целое число Минимальное значение: 1Обязательный: Да |
Ответ
В случае успеха возвращаются HTTP-ответ с кодом 200 и данные в формате JSON.
{
"CurrentShardCount": number,
"StreamName": "string",
"TargetShardCount": number
}
Параметры ответа
| Параметр | Описание |
|---|---|
CurrentShardCount |
Текущее количество сегментов. Тип: Целое число Минимальное значение: 1Обязательный: Да |
StreamName |
Имя потока данных. Тип: Строка Размер: 1-128 символов.Возможные значения: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$Обязательный: Да |
TargetShardCount |
Целевое количество сегментов. Тип: Целое число Минимальное значение: 1Обязательный: Да |
Ошибки
| Параметр | Описание | Код HTTP |
|---|---|---|
InvalidArgumentException |
Недопустимый аргумент. Дополнительные сведения смотрите в сообщении об ошибке. | 400 |
LimitExceededException |
Превышено максимальное число запросов. | 400 |
ResourceInUseException |
Ресурс используется другой операцией. | 400 |
ResourceNotFoundException |
Запрошенный ресурс не найден. | 400 |
Могут возникать ошибки, общие для всех методов.