Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

put-scaling-policy

Описание

Создает или обновляет политику масштабирования для флота. Политики масштабирования используются для автоматического масштабирования емкости хостинга флота для удовлетворения спроса игроков. Активная политика масштабирования инструктирует Amazon GameLift отслеживать метрику флота и автоматически изменять емкость флота, когда достигается определенный порог. Существует два типа политик масштабирования: основанные на целевых значениях и основанные на правилах. Используйте политику, основанную на целевых значениях, для быстрого и эффективного управления масштабированием флота; этот вариант наиболее часто используется. Используйте политики, основанные на правилах, когда вам нужно обеспечить точное управление автоматическим масштабированием.

Флоты могут иметь несколько действующих политик масштабирования каждого типа одновременно; вы можете иметь одну политику, основанную на целевых значениях, одну или несколько политик масштабирования, основанных на правилах, или обе. Тем не менее, мы рекомендуем проявлять осторожность, поскольку несколько политик автоматического масштабирования могут иметь непредвиденные последствия.

Узнайте больше о работе с автоматическим масштабированием в разделе Настройка автоматического масштабирования флота.

Политика, основанная на целевых значениях

Политика, основанная на целевых значениях, отслеживает единственную метрику: PercentAvailableGameSessions. Эта метрика показывает, сколько емкости хостинга флота готово к размещению игровых сессий, но в настоящее время не используется. Это буфер флота; он измеряет дополнительный спрос игроков, который флот мог бы обработать при текущей емкости. С помощью политики, основанной на целевых значениях, вы устанавливаете желаемый размер буфера и оставляете Amazon GameLift принять необходимые меры для поддержания этой цели.

Например, вы можете установить поддержание 10%-ного буфера для флота, имеющего возможность размещения 100 одновременных игровых сессий. Эта политика сообщает Amazon GameLift принять меры всякий раз, когда доступная емкость флота падает ниже или поднимается выше 10 игровых сессий. Amazon GameLift запустит новые экземпляры или остановит неиспользуемые экземпляры, чтобы вернуться к 10%-ному буферу.

Для создания или обновления политики, основанной на целевых значениях, укажите идентификатор и имя флота, а также установите тип политики в «TargetBased». Укажите метрику для отслеживания (PercentAvailableGameSessions) и укажите объект TargetConfiguration с желаемым значением буфера. Исключите все другие параметры. В случае успешного запроса возвращается имя политики. Политика масштабирования автоматически вступает в силу сразу после успешного создания. Если действия автоматического масштабирования флота временно приостановлены, новая политика вступит в силу после перезапуска действий флота.

Политика, основанная на правилах

Политика, основанная на правилах, отслеживает указанную метрику флота, устанавливает пороговое значение и указывает тип действия, который необходимо выполнить при срабатывании. С помощью политики, основанной на правилах, вы можете выбрать несколько доступных метрик флота. Каждая политика указывает, следует ли масштабировать вверх или вниз (и на сколько), поэтому вам нужна одна политика для каждого типа действия.

Например, политика может сформулировать следующее утверждение: «Если процент неиспользуемых экземпляров превышает 20% в течение более 15 минут, уменьшите емкость флота на 10%».

Утверждение правила политики имеет следующий структуру:

Если [MetricName] равно [ComparisonOperator] [Threshold] в течение [EvaluationPeriods] минут, то [ScalingAdjustmentType] на/до [ScalingAdjustment].

Для реализации примера утверждение правила будет выглядеть так:

Если [PercentIdleInstances] равно [GreaterThanThreshold] [20] в течение [15] минут, то [PercentChangeInCapacity] на/до [10].

Для создания или обновления политики масштабирования укажите уникальную комбинацию имени и идентификатора флота, а также установите тип политики в «RuleBased». Укажите значения параметров для утверждения правила политики. В случае успешного запроса возвращается имя политики. Политики масштабирования автоматически вступают в силу сразу после успешного создания. Если действия автоматического масштабирования флота временно приостановлены, новая политика вступит в силу после перезапуска действий флота.

См. также: Документация по API AWS

Краткое описание

  put-scaling-policy
--name <value>
--fleet-id <value>
[--scaling-adjustment <value>]
[--scaling-adjustment-type <value>]
[--threshold <value>]
[--comparison-operator <value>]
[--evaluation-periods <value>]
--metric-name <value>
[--policy-type <value>]
[--target-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--name (строка)

Описание метки, которая ассоциируется с политикой масштабирования флота. Имена политик не должны быть уникальными. Флот может иметь только одну политику масштабирования с таким же именем.

--fleet-id (строка)

Уникальный идентификатор флота, к которому следует применить эту политику. Вы можете использовать либо идентификатор флота, либо значение ARN. Флот не может находиться ни в одном из следующих состояний: ОШИБКА или УДАЛЕНИЕ.

--scaling-adjustment (целое число)

Величина корректировки в зависимости от типа корректировки масштабирования.

--scaling-adjustment-type (строка)

Тип корректировки, которую нужно внести в количество экземпляров флота:

  • ChangeInCapacity – добавить (или вычесть) значение корректировки масштабирования из текущего количества экземпляров. Положительные значения масштабируют вверх, а отрицательные — вниз.
  • ExactCapacity – установить количество экземпляров на значение корректировки масштабирования.
  • PercentChangeInCapacity – увеличить или уменьшить текущее количество экземпляров на значение корректировки масштабирования, интерпретируемое как процент. Положительные значения масштабируют вверх, а отрицательные — вниз; например, значение «-10» уменьшает флот на 10%.

Возможные значения:

  • ChangeInCapacity
  • ExactCapacity
  • PercentChangeInCapacity

--threshold (двойное значение)

Значение метрики, используемое для запуска события масштабирования.

--comparison-operator (строка)

Оператор сравнения, который необходимо использовать при сравнении метрики с пороговым значением.

Возможные значения:

  • GreaterThanOrEqualToThreshold
  • GreaterThanThreshold
  • LessThanThreshold
  • LessThanOrEqualToThreshold

--evaluation-periods (целое число)

Продолжительность (в минутах), в течение которой метрика должна находиться на или выше порога, прежде чем будет запущено событие масштабирования.

--metric-name (строка)

Имя метрики, определенной Amazon GameLift, которая используется для запуска корректировки масштабирования. Подробные описания метрик флота см. в разделе Отслеживание Amazon GameLift с помощью Amazon CloudWatch.

  • ActivatingGameSessions – Игровые сессии, которые в процессе создания.
  • ActiveGameSessions – Игровые сессии, которые в данный момент выполняются.
  • ActiveInstances – Экземпляры флота, которые в данный момент выполняются хотя бы в одной игровой сессии.
  • AvailableGameSessions – Дополнительные игровые сессии, которые флот может разместить одновременно, учитывая текущую емкость.
  • AvailablePlayerSessions – Пустые игровые слоты в активных игровых сессиях. Это включает игровые сессии, которые в данный момент не принимают игроков. Зарезервированные игровые слоты не включены.
  • CurrentPlayerSessions – Игровые слоты в активных игровых сессиях, которые используются игроком или зарезервированы для игрока.
  • IdleInstances – Активные экземпляры, которые в данный момент не размещают ни одной игровой сессии.
  • PercentAvailableGameSessions – Неиспользуемый процент от общего количества игровых сессий, которые флот может разместить одновременно, учитывая текущую емкость. Используйте эту метрику для политики масштабирования, основанной на целевых значениях.
  • PercentIdleInstances – Процент от общего количества активных экземпляров, которые не размещают ни одной игровой сессии.
  • QueueDepth – Запросы на размещение ожидающих игровых сессий в любом очереди, где текущий флот является целевым для наивысшего приоритета.
  • WaitTime – Текущее время ожидания для ожидающих запросов на размещение игровых сессий в любом очереди, где текущий флот является целевым для наивысшего приоритета.

Возможные значения:

  • ActivatingGameSessions
  • ActiveGameSessions
  • ActiveInstances
  • AvailableGameSessions
  • AvailablePlayerSessions
  • CurrentPlayerSessions
  • IdleInstances
  • PercentAvailableGameSessions
  • PercentIdleInstances
  • QueueDepth
  • WaitTime
  • ConcurrentActivatableGameSessions

--policy-type (строка)

Тип политики масштабирования, которую необходимо создать. Для политики, основанной на целевых значениях, установите параметр MetricName в ‘PercentAvailableGameSessions’ и укажите TargetConfiguration . Для политики, основанной на правилах, установите следующие параметры: MetricName , ComparisonOperator , Threshold , EvaluationPeriods , ScalingAdjustmentType и ScalingAdjustment .

Возможные значения:

  • RuleBased
  • TargetBased

--target-configuration (структура)

Объект, содержащий настройки для политики масштабирования, основанной на целевых значениях.

TargetValue -> (двойное значение)

Желаемое значение, используемое с политикой масштабирования, основанной на целевых значениях. Значение должно быть релевантным для метрики, используемой политикой масштабирования. Например, в политике, использующей метрику PercentAvailableGameSessions, целевое значение должно быть предпочтительным размером буфера флота (процент емкости, который должен быть неиспользуемым и готовым к новым игровым сессиям).

Сокращенная синтаксическая запись:

TargetValue=double

Синтаксис JSON:

{
  "TargetValue": double
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставляемому --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. При отсутствии значения или при значении input выводит пример входного JSON, который можно использовать как аргумент для --cli-input-json. Аналогично, при значении yaml-input выведет пример входного YAML, который можно использовать с --cli-input-yaml. При значении output проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном каркасе JSON.

Общие параметры

--debug (boolean)

Включить отладку регистрации.

--endpoint-url (string)

Переопределить стандартную URL-адрес команды на указанную URL-адрес.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Данные учетных данных не будут загружаться, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаут. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаут. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для бинарных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что бинарные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и бинарные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует бинарному блоку, fileb:// всегда будет рассматриваться как бинарное и будет использоваться содержимое файла непосредственно независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

Имя -> (string)

Дескриптивное метка, связанная с политикой масштабирования флота. Имена политик не обязательно должны быть уникальными.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API