describe-scaling-policies
Описание
Получает все политики масштабирования, применённые к флоту.
Чтобы получить политики масштабирования флота, укажите его ID. Вы можете отфильтровать этот запрос по статусу политики, например, для получения только активных политик масштабирования. Используйте параметры пагинации для получения результатов в виде набора последовательных страниц. При успешном выполнении возвращается набор объектов ScalingPolicy для флота.
Флот может иметь все свои политики масштабирования приостановленными. Данная операция не влияет на статус политик масштабирования, который остаётся ACTIVE.
См. также: Документацию AWS API
describe-scaling-policies — это операция с пагинацией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить пагинацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с пагинацией аргумент --query должен извлечь данные из результатов следующих выражений запроса: ScalingPolicies
Синтаксис
describe-scaling-policies
--fleet-id <value>
[--status-filter <value>]
[--location <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--fleet-id (строка)
--status-filter (строка)
Статус политики масштабирования для фильтрации результатов. Политика масштабирования действует только при статусе ACTIVE.
- ACTIVE – Политика масштабирования в настоящее время действует.
- UPDATEREQUESTED – Получен запрос на обновление политики масштабирования.
- UPDATING – Вносится изменение в политику масштабирования.
- DELETEREQUESTED – Получен запрос на удаление политики масштабирования.
- DELETING – Политика масштабирования удаляется.
- DELETED – Политика масштабирования удалена.
- ERROR – При создании политики произошла ошибка. Необходимо удалить и воссоздать её.
Возможные значения:
ACTIVEUPDATE_REQUESTEDUPDATINGDELETE_REQUESTEDDELETINGDELETEDERROR
--location (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, заданному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения перекроют значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер, указывающий, с какой точки начать пагинацию. Это NextToken из ранее усечённого ответа.
Примеры использования см. в разделе «Пагинация» в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы при вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе «Пагинация» в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения пагинации укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Пагинация» в Руководстве пользователя AWS Command Line Interface.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или при значении input выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. При значении output валидирует входные данные команды и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включение отладки логов.
--endpoint-url (строка)
Переопределение стандартного URL команды указанным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (логическое значение)
Отключение автоматической пагинации. Если автоматическая пагинация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование конкретного профиля из вашего файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--no-sign-request (логическое значение)
Отключение подписи запросов. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл CA-сертификатов для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (логическое значение)
Отключение кли-пейджера для вывода.
--cli-auto-prompt (логическое значение)
Автоматическое запрос параметров CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса параметров CLI.
Выходные данные
ScalingPolicies -> (список)
Коллекция объектов, содержащих политики масштабирования, соответствующие запросу.
(структура)
Правило, определяющее, как масштабируется флот. Политики масштабирования уникально идентифицируются по сочетанию имени и идентификатора флота.
FleetId -> (строка)
FleetArn -> (строка)
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .Name -> (строка)
Status -> (строка)
Текущий статус политики масштабирования. Политика масштабирования может быть активна только в статусе ACTIVE . Политики масштабирования могут быть приостановлены для отдельных флотов. Если политика приостановлена для флота, статус политики не меняется.
- ACTIVE – Политика масштабирования может использоваться для автоматического масштабирования флота.
- UPDATE_REQUESTED – Получен запрос на обновление политики масштабирования.
- UPDATING – Вносится изменение в политику масштабирования.
- DELETE_REQUESTED – Получен запрос на удаление политики масштабирования.
- DELETING – Политика масштабирования удаляется.
- DELETED – Политика масштабирования удалена.
- ERROR – При создании политики произошла ошибка. Она должна быть удалена и создана заново.
ScalingAdjustment -> (целое число)
ScalingAdjustmentType -> (строка)
Тип корректировки количества экземпляров флота.
- ChangeInCapacity – добавить (или вычесть) значение корректировки масштабирования из текущего количества экземпляров. Положительные значения увеличивают масштаб, а отрицательные — уменьшают.
- ExactCapacity – установить количество экземпляров на значение корректировки масштабирования.
- PercentChangeInCapacity – увеличить или уменьшить текущее количество экземпляров на значение корректировки, которое читается как процент. Положительные значения увеличивают масштаб, а отрицательные — уменьшают.
ComparisonOperator -> (строка)
Threshold -> (двойное)
EvaluationPeriods -> (целое число)
MetricName -> (строка)
Имя определенной Amazon GameLift метрики, используемой для запуска корректировки масштабирования. Подробные описания метрик флота см. в разделе отслеживать Amazon GameLift с помощью Amazon CloudWatch.
- ActivatingGameSessions – Игровые сессии, которые находятся в процессе создания.
- ActiveGameSessions – Активные игровые сессии.
- ActiveInstances – Экземпляры флота, которые в настоящее время работают хотя бы с одной игровой сессией.
- AvailableGameSessions – Дополнительные игровые сессии, которые флот мог бы одновременно разместить, учитывая текущую емкость.
- AvailablePlayerSessions – Свободные игровые слоты в активных игровых сессиях. Это включает игровые сессии, которые в данный момент не принимают игроков. Не учитываются зарезервированные игровые слоты.
- CurrentPlayerSessions – Игровые слоты в активных игровых сессиях, которые используются игроком или зарезервированы для игрока.
- IdleInstances – Активные экземпляры, которые в настоящее время не работают с никакими игровыми сессиями.
- PercentAvailableGameSessions – Неиспользуемый процент от общего количества игровых сессий, которые флот мог бы одновременно разместить, учитывая текущую емкость. Используйте эту метрику для политики масштабирования на основе цели.
- PercentIdleInstances – Процент от общего количества активных экземпляров, которые не работают с никакими игровыми сессиями.
- QueueDepth – Необработанные запросы на размещение игровых сессий в любой очереди, где текущий флот является первоочередным местоназначением.
- WaitTime – Текущее время ожидания для необработанных запросов на размещение игровых сессий в любой очереди, где текущий флот является первоочередным местоназначением.
PolicyType -> (строка)
TargetConfiguration -> (структура)
Объект, содержащий параметры политики масштабирования на основе цели.
TargetValue -> (двойное)
UpdateStatus -> (строка)
PENDING_UPDATE указывает, что запрос на обновление для флота был сделан, но еще не завершен для расположения.Location -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.