Spec-Zone.ru › AWS CLI v2

[ aws . apprunner ]

describe-auto-scaling-configuration

Описание

Возвращает полное описание ресурса конфигурации автоматического масштабирования App Runner.

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

Синтаксис

  describe-auto-scaling-configuration
--auto-scaling-configuration-arn <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]

Параметры

--auto-scaling-configuration-arn (строка)

Amazon Resource Name (ARN) конфигурации автоматического масштабирования App Runner, для которой требуется описание.

ARN может быть полным ARN конфигурации автоматического масштабирования или частичным ARN, заканчивающимся либо ``…/имя ``, либо ``…/имя /ревизия ``. Если ревизия не указана, описывается последняя активная ревизия.

--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 (булево)

Включает отладочную запись в журнал.

--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.

Примеры

Примечание

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

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

Пример 1: Описание последней активной ревизии конфигурации автоматического масштабирования

Следующий describe-auto-scaling-configuration пример получает описание последней активной ревизии конфигурации автоматического масштабирования App Runner. Чтобы описать последнюю активную ревизию, укажите ARN, заканчивающийся именем конфигурации, без компонента ревизии.

В примере существуют две ревизии. Следовательно, описывается ревизия 2 (последняя). Результирующий объект показывает "Latest": true.

aws apprunner describe-auto-scaling-configuration \
    --cli-input-json file://input.json

Содержание input.json:

{
    "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability"
}

Вывод:

{
    "AutoScalingConfiguration": {
        "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/2/e76562f50d78042e819fead0f59672e6",
        "AutoScalingConfigurationName": "high-availability",
        "AutoScalingConfigurationRevision": 2,
        "CreatedAt": "2021-02-25T17:42:59Z",
        "Latest": true,
        "Status": "ACTIVE",
        "MaxConcurrency": 30,
        "MaxSize": 90,
        "MinSize": 5
    }
}

Пример 2: Описание конкретной ревизии конфигурации автоматического масштабирования

Следующий describe-auto-scaling-configuration пример получает описание конкретной ревизии конфигурации автоматического масштабирования App Runner. Чтобы описать конкретную ревизию, укажите ARN, содержащий номер ревизии.

В примере существует несколько ревизий, и запрашивается ревизия 1. Результирующий объект показывает "Latest": false.

aws apprunner describe-auto-scaling-configuration \
    --cli-input-json file://input.json

Содержание input.json:

{
    "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1"
}

Вывод:

{
    "AutoScalingConfiguration": {
        "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1/2f50e7656d7819fead0f59672e68042e",
        "AutoScalingConfigurationName": "high-availability",
        "AutoScalingConfigurationRevision": 1,
        "CreatedAt": "2020-11-03T00:29:17Z",
        "Latest": false,
        "Status": "ACTIVE",
        "MaxConcurrency": 100,
        "MaxSize": 50,
        "MinSize": 5
    }
}

Вывод

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

Полное описание конфигурации автоматического масштабирования App Runner, указанной в этом запросе.

AutoScalingConfigurationArn -> (строка)

Amazon Resource Name (ARN) этой конфигурации автоматического масштабирования.

AutoScalingConfigurationName -> (строка)

Указанное клиентом имя конфигурации автоматического масштабирования. Его можно использовать в нескольких ревизиях конфигурации.

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

Ревизия этой конфигурации автоматического масштабирования. Она уникальна среди всех активных конфигураций ("Status": "ACTIVE"), которые используют то же самое AutoScalingConfigurationName.

Latest -> (булево)

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

Status -> (строка)

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

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

Максимальное количество одновременных запросов, обрабатываемых экземпляром. Если количество одновременных запросов превышает этот лимит, App Runner масштабирует сервис вверх.

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

Минимальное количество экземпляров, которые App Runner предоставляет для сервиса. Сервис всегда имеет как минимум MinSize предопределенных экземпляров. Некоторые из них активно обслуживают трафик. Остальные (предопределенные и неактивные экземпляры) — это экономически эффективная резервная вычислительная мощность, готовая к быстрому включению. Вы платите за использование памяти всех предопределенных экземпляров. Вы платите за использование ЦП только активной подвыборки.

App Runner временно удваивает количество предопределенных экземпляров во время развертываний, чтобы поддерживать тот же объем емкости для как старого, так и нового кода.

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

Максимальное количество экземпляров, до которого масштабируется сервис вверх. Максимум MaxSize экземпляров активно обслуживают трафик для вашего сервиса.

CreatedAt -> (метка времени)

Время создания конфигурации автоматического масштабирования. Формат — метка времени Unix.

DeletedAt -> (метка времени)

Время удаления конфигурации автоматического масштабирования. Формат — метка времени Unix.

HasAssociatedService -> (булево)

Указывает, связана ли с этой конфигурацией автоматического масштабирования служба App Runner. Значение true указывает на то, что связана одна или несколько служб. Значение false указывает на то, что не связана ни одна служба.

IsDefault -> (булево)

Указывает, должна ли эта конфигурация автоматического масштабирования использоваться в качестве значения по умолчанию для новой службы App Runner, у которой нет указанного ARN конфигурации автоматического масштабирования во время создания. Каждый аккаунт может иметь только одну конфигурацию AutoScalingConfiguration на регион. Установленная по умолчанию AutoScalingConfiguration может быть любой ревизией в рамках того же AutoScalingConfigurationName.

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

Spec-Zone.ru

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