Spec-Zone.ru › AWS CLI v2

[ aws . autoscaling-планы ]

describe-scaling-plan-resources

Описание

Описывает масштабируемые ресурсы в указанном плане масштабирования.

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

describe-scaling-plan-resources является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ScalingPlanResources

Синтаксис

  describe-scaling-plan-resources
--scaling-plan-name <value>
--scaling-plan-version <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]

Параметры

--scaling-plan-name (строка)

Имя плана масштабирования.

--scaling-plan-version (целое число)

Номер версии плана масштабирования. В настоящее время единственное допустимое значение — 1.

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры имеют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы описать масштабируемые ресурсы для плана масштабирования

Следующий пример describe-scaling-plan-resources отображает подробности об одном масштабируемом ресурсе (группа Auto Scaling), связанном с указанным планом масштабирования.

aws autoscaling-plans describe-scaling-plan-resources \
    --scaling-plan-name my-scaling-plan \
    --scaling-plan-version 1

Вывод:

{
    "ScalingPlanResources": [
        {
            "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity",
            "ScalingPlanVersion": 1,
            "ResourceId": "autoScalingGroup/my-asg",
            "ScalingStatusCode": "Active",
            "ScalingStatusMessage": "Target tracking scaling policies have been applied to the resource.",
            "ScalingPolicies": [
                {
                    "PolicyName": "AutoScaling-my-asg-b1ab65ae-4be3-4634-bd64-c7471662b251",
                    "PolicyType": "TargetTrackingScaling",
                    "TargetTrackingConfiguration": {
                        "PredefinedScalingMetricSpecification": {
                            "PredefinedScalingMetricType": "ALBRequestCountPerTarget",
                            "ResourceLabel": "app/my-alb/f37c06a68c1748aa/targetgroup/my-target-group/6d4ea56ca2d6a18d"
                        },
                        "TargetValue": 40.0
                    }
                }
            ],
            "ServiceNamespace": "autoscaling",
            "ScalingPlanName": "my-scaling-plan"
        }
    ]
}

Для получения дополнительной информации см. Что такое AWS Auto Scaling? в Руководстве пользователя AWS Auto Scaling.

Вывод

ScalingPlanResources -> (список)

Информация о масштабируемых ресурсах.

(структура)

Представляет масштабируемый ресурс.

ScalingPlanName -> (строка)

Имя плана масштабирования.

ScalingPlanVersion -> (целое число)

Номер версии плана масштабирования.

ServiceNamespace -> (строка)

Пространство имен AWS-сервиса.

ResourceId -> (строка)

Идентификатор ресурса. Эта строка состоит из типа ресурса и уникального идентификатора.

  • Группа Auto Scaling - Тип ресурса autoScalingGroup, а уникальный идентификатор — имя группы Auto Scaling. Пример: autoScalingGroup/my-asg .
  • Сервис ECS - Тип ресурса service, а уникальный идентификатор — имя кластера и имя сервиса. Пример: service/default/sample-webapp .
  • Запрос Spot Fleet - Тип ресурса spot-fleet-request, а уникальный идентификатор — идентификатор запроса Spot Fleet. Пример: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .
  • Таблица DynamoDB - Тип ресурса table, а уникальный идентификатор — идентификатор ресурса. Пример: table/my-table .
  • Глобальный вторичный индекс DynamoDB - Тип ресурса index, а уникальный идентификатор — идентификатор ресурса. Пример: table/my-table/index/my-table-index .
  • Кластер баз данных Aurora - Тип ресурса cluster, а уникальный идентификатор — имя кластера. Пример: cluster:my-db-cluster .

ScalableDimension -> (строка)

Масштабируемое измерение для ресурса.

  • autoscaling:autoScalingGroup:DesiredCapacity - Желаемое количество емкостей группы Auto Scaling.
  • ecs:service:DesiredCount - Желаемое количество задач сервиса ECS.
  • ec2:spot-fleet-request:TargetCapacity - Целевое количество емкостей запроса Spot Fleet.
  • dynamodb:table:ReadCapacityUnits - Зарезервированная пропускная способность чтения для таблицы DynamoDB.
  • dynamodb:table:WriteCapacityUnits - Зарезервированная пропускная способность записи для таблицы DynamoDB.
  • dynamodb:index:ReadCapacityUnits - Зарезервированная пропускная способность чтения для глобального вторичного индекса DynamoDB.
  • dynamodb:index:WriteCapacityUnits - Зарезервированная пропускная способность записи для глобального вторичного индекса DynamoDB.
  • rds:cluster:ReadReplicaCount - Количество реплик Aurora в кластере баз данных Aurora. Доступно для Aurora MySQL-совместимой версии и Aurora PostgreSQL-совместимой версии.

ScalingPolicies -> (список)

Политики масштабирования.

(структура)

Представляет политику масштабирования.

PolicyName -> (строка)

Имя политики масштабирования.

PolicyType -> (строка)

Тип политики масштабирования.

TargetTrackingConfiguration -> (структура)

Политика масштабирования с отслеживанием целевых значений. Поддерживает предварительно определённые или настраиваемые метрики.

PredefinedScalingMetricSpecification -> (структура)

Предварительно определённая метрика. Можно указать либо предварительно определённую, либо настраиваемую метрику.

PredefinedScalingMetricType -> (строка)

Тип метрики. Тип метрики ALBRequestCountPerTarget применяется только к группам Auto Scaling, запросам Spot Fleet и сервисам ECS.

ResourceLabel -> (строка)

Идентифицирует ресурс, связанный с типом метрики. Вы не можете указать метку ресурса, если тип метрики — ALBRequestCountPerTarget , и нет группы целевых значений для Application Load Balancer, присоединённой к группе Auto Scaling, запросу Spot Fleet или сервису ECS.

Вы создаёте метку ресурса, добавляя конечную часть ARN балансировщика нагрузки и конечную часть ARN группы целевых значений в одно значение, разделённые слешем (/). Формат — app/<имя-балансировщика>/<идентификатор-балансировщика>/targetgroup/<имя-группы-целевых-значений>/<идентификатор-группы-целевых-значений>, где:

  • app/<имя-балансировщика>/<идентификатор-балансировщика> — конечная часть ARN балансировщика нагрузки
  • targetgroup/<имя-группы-целевых-значений>/<идентификатор-группы-целевых-значений> — конечная часть ARN группы целевых значений.

Вот пример: app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

Чтобы найти ARN для Application Load Balancer, используйте операцию API DescribeLoadBalancers. Чтобы найти ARN для группы целевых значений, используйте операцию API DescribeTargetGroups.

CustomizedScalingMetricSpecification -> (структура)

Настраиваемая метрика. Можно указать либо предварительно определённую, либо настраиваемую метрику.

MetricName -> (строка)

Имя метрики.

Namespace -> (строка)

Пространство имен метрики.

Dimensions -> (список)

Измерения метрики.

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

(структура)

Представляет измерение для настраиваемой метрики.

Name -> (строка)

Имя измерения.

Value -> (строка)

Значение измерения.

Statistic -> (строка)

Статистика метрики.

Unit -> (строка)

Единица измерения метрики.

TargetValue -> (вещественное число)

Целевое значение для метрики. Несмотря на то, что это свойство принимает числа типа Double, оно не примет значения, которые слишком малы или слишком велики. Значения должны быть в диапазоне от -2^360 до 2^360.

DisableScaleIn -> (булево значение)

Указывает, отключено ли масштабирование в политике масштабирования с отслеживанием целевых значений. Если значение — true, масштабирование в отключено, и политика масштабирования с отслеживанием целевых значений не удаляет емкости из масштабируемого ресурса. В противном случае масштабирование в включено, и политика масштабирования с отслеживанием целевых значений может удалить емкости из масштабируемого ресурса.

Значение по умолчанию — false .

ScaleOutCooldown -> (целое число)

Количество секунд, которое нужно подождать, чтобы предыдущая операция масштабирования в стало действовать. Это свойство не используется, если масштабируемый ресурс — группа Auto Scaling.

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

ScaleInCooldown -> (целое число)

Количество секунд, которое должно пройти после завершения операции масштабирования в, прежде чем может начаться другая операция масштабирования в. Это свойство не используется, если масштабируемый ресурс — группа Auto Scaling.

При использовании периода ожидания масштабирования в цель — обеспечить масштабирование в с осторожностью для защиты доступности приложения, поэтому операции масштабирования в блокируются, пока не закончится период ожидания. Однако, если другой сигнал тревоги запускает операцию масштабирования в течение периода ожидания масштабирования в, Auto Scaling масштабирует цель сразу. В этом случае период ожидания масштабирования в останавливается и не завершается.

EstimatedInstanceWarmup -> (целое число)

Предполагаемое время (в секундах) до того момента, когда недавно запущенная экземпляра сможет внести вклад в метрики CloudWatch. Это значение используется только в том случае, если ресурс — группа Auto Scaling.

ScalingStatusCode -> (строка)

Статус масштабирования ресурса.

  • Active - Настройка масштабирования активна.
  • Inactive - Настройка масштабирования не активна, так как план масштабирования создается или настройка масштабирования не могла быть применена. Для получения дополнительной информации см. сообщение о статусе.
  • PartiallyActive - Настройка масштабирования частично активна, так как план масштабирования создается или удаляется, или настройка масштабирования не могла быть полностью применена. Для получения дополнительной информации см. сообщение о статусе.

ScalingStatusMessage -> (строка)

Простое сообщение о текущем статусе масштабирования ресурса.

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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