Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

describe-capacity-providers

Описание

Описывает один или несколько ваших поставщиков ресурсов.

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

Синтаксис

  describe-capacity-providers
[--capacity-providers <value>]
[--include <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--capacity-providers (список)

Короткое имя или полное Amazon Resource Name (ARN) одного или нескольких поставщиков ресурсов. В действии можно описать до 100 поставщиков ресурсов.

(строка)

Синтаксис:

"string" "string" ...

--include (список)

Указывает, хотите ли вы видеть теги ресурсов для поставщика ресурсов. Если TAGS указан, теги включаются в ответ. Если этот параметр опущен, теги не включаются в ответ.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  TAGS

--max-results (целое число)

Максимальное количество результатов настроек учетной записи, возвращаемых DescribeCapacityProviders в выходных данных с постраничной навигацией. При использовании этого параметра DescribeCapacityProviders возвращает только maxResults результатов на одной странице вместе с элементом ответа nextToken. Остальные результаты исходного запроса можно увидеть, отправив другой запрос DescribeCapacityProviders со значением возвращенного nextToken. Это значение может быть от 1 до 10. Если этот параметр не используется, тогда DescribeCapacityProviders возвращает до 10 результатов и значение nextToken, если применимо.

--next-token (строка)

Значение nextToken, возвращенное из предыдущего запроса с постраничной навигацией DescribeCapacityProviders, где maxResults использовался, а результаты превысили значение этого параметра. Постраничная навигация продолжается с конца предыдущих результатов, которые вернули значение nextToken.

Примечание

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

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

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

Пример 1: Описание всех поставщиков ресурсов

Следующий describe-capacity-providers пример извлекает подробности обо всех поставщиках ресурсов.

aws ecs describe-capacity-providers

Вывод:

{
    "capacityProviders": [
        {
            "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
            "name": "MyCapacityProvider",
            "status": "ACTIVE",
            "autoScalingGroupProvider": {
                "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
                "managedScaling": {
                    "status": "ENABLED",
                    "targetCapacity": 100,
                    "minimumScalingStepSize": 1,
                    "maximumScalingStepSize": 1000
                },
                "managedTerminationProtection": "ENABLED"
            },
            "tags": []
        },
        {
            "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE",
            "name": "FARGATE",
            "status": "ACTIVE",
            "tags": []
        },
        {
            "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT",
            "name": "FARGATE_SPOT",
            "status": "ACTIVE",
            "tags": []
        }
    ]
}

Дополнительную информацию см. в разделе Поставщики ресурсов кластера в руководстве разработчика Amazon ECS.

Пример 2: Описание конкретного поставщика ресурсов

Следующий describe-capacity-providers пример извлекает подробности о конкретном поставщике ресурсов. Использование параметра --include TAGS добавит теги, связанные с поставщиком ресурсов, в вывод.

aws ecs describe-capacity-providers \
    --capacity-providers MyCapacityProvider \
    --include TAGS

Вывод:

{
    "capacityProviders": [
        {
            "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
            "name": "MyCapacityProvider",
            "status": "ACTIVE",
            "autoScalingGroupProvider": {
                "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
                "managedScaling": {
                    "status": "ENABLED",
                    "targetCapacity": 100,
                    "minimumScalingStepSize": 1,
                    "maximumScalingStepSize": 1000
                },
                "managedTerminationProtection": "ENABLED"
            },
            "tags": [
                {
                    "key": "environment",
                    "value": "production"
                }
            ]
        }
    ]
}

Дополнительную информацию см. в разделе Поставщики ресурсов кластера в руководстве разработчика Amazon ECS.

Вывод

capacityProviders -> (список)

Список поставщиков ресурсов.

(структура)

Подробная информация о поставщике ресурсов.

capacityProviderArn -> (строка)

Идентификатор Amazon Resource Name (ARN) поставщика ресурсов.

name -> (строка)

Имя поставщика ресурсов.

status -> (строка)

Текущий статус поставщика ресурсов. Только поставщики ресурсов в состоянии ACTIVE могут использоваться в кластере. При успешном удалении поставщика ресурсов его статус становится INACTIVE.

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

Настройки группы Auto Scaling для поставщика ресурсов.

autoScalingGroupArn -> (строка)

Идентификатор Amazon Resource Name (ARN) или имя группы Auto Scaling.

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

Настройки управляемого масштабирования для поставщика ресурсов группы Auto Scaling.

status -> (строка)

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

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

Целевое использование ресурсов в процентах для поставщика ресурсов. Указанное значение должно быть больше 0 и меньше или равно 100. Например, если вы хотите, чтобы поставщик ресурсов поддерживал 10% резервного ресурса, то это означает использование на 90%, поэтому используйте значение targetCapacity 90. Значение по умолчанию 100 процентов приводит к полному использованию экземпляров Amazon EC2 в вашей группе Auto Scaling.

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

Минимальное количество экземпляров Amazon EC2, которое Amazon ECS будет масштабировать за один раз. Процесс масштабирования не зависит от этого параметра. Если этот параметр опущен, используется значение по умолчанию 1.

При необходимости дополнительного ресурса Amazon ECS будет масштабировать вверх на минимальный шаг, даже если фактическая потребность меньше этого минимального шага.

Если вы используете поставщик ресурсов с группой Auto Scaling, настроенной более чем на один тип экземпляра Amazon EC2 или зону доступности, Amazon ECS будет масштабировать вверх на точное значение минимального шага и проигнорирует как максимальный шаг масштабирования, так и потребность в ресурсах.

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

Максимальное количество экземпляров Amazon EC2, которое Amazon ECS будет масштабировать за один раз. Если этот параметр опущен, используется значение по умолчанию 10000.

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

Период времени в секундах после запуска нового экземпляра Amazon EC2, когда он может вносить вклад в метрики CloudWatch для группы Auto Scaling. Если этот параметр опущен, используется значение по умолчанию 300 секунд.

managedTerminationProtection -> (строка)

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

Предупреждение

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

При включенной управляемой защите от завершения работы Amazon ECS предотвращает завершение работы экземпляров Amazon EC2 в группе Auto Scaling, содержащих задачи, во время действия масштабирования вниз. Группа Auto Scaling и каждый экземпляр в группе Auto Scaling должны также иметь защиту от масштабирования вниз. Для получения дополнительной информации см. Защита экземпляров в руководстве пользователя Auto Scaling.

При выключенной управляемой защите от завершения работы ваши экземпляры Amazon EC2 не защищены от завершения работы при масштабировании вниз группы Auto Scaling.

managedDraining -> (строка)

Параметр управляемого отключения для поставщика ресурсов группы Auto Scaling. При включении Amazon ECS управляет и плавно отключает экземпляры EC2 контейнеров, которые находятся в поставщике ресурсов группы Auto Scaling.

updateStatus -> (строка)

Статус обновления поставщика ресурсов. Возможные состояния:

DELETE_IN_PROGRESS

Поставщик ресурсов находится в процессе удаления.

DELETE_COMPLETE

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

DELETE_FAILED

Поставщик ресурсов не может быть удален. Причина статуса обновления предоставляет дополнительные сведения о причине неудачи удаления.

updateStatusReason -> (строка)

Причина статуса обновления. Предоставляет дополнительные сведения о статусе обновления поставщика ресурсов.

tags -> (список)

Метаданные, которые вы применяете к поставщику ресурсов, чтобы помочь в его категоризации и организации. Каждая метка состоит из ключа и необязательного значения. Вы определяете оба.

Ниже приведены основные ограничения, относящиеся к меткам:

  • Максимальное количество меток на ресурс - 50
  • Для каждого ресурса каждый ключ метки должен быть уникальным, и каждый ключ метки может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8
  • Максимальная длина значения - 256 символов Юникода в UTF-8
  • Если ваша схема меток используется в нескольких сервисах и ресурсах, помните, что другие сервисы могут иметь ограничения на разрешенные символы. В целом разрешенными символами являются: буквы, цифры и пробелы, представляемые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения меток чувствительны к регистру.
  • Не используйте aws: , AWS: или любое сочетание верхнего и нижнего регистра, например, в качестве префикса для ключей или значений, так как это зарезервировано для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения меток с этим префиксом. Метки с этим префиксом не учитываются при подсчете меток на ресурс.

(структура)

Метаданные, которые вы применяете к ресурсу, чтобы помочь в его категоризации и организации. Каждая метка состоит из ключа и необязательного значения. Вы их определяете.

Ниже приведены основные ограничения, относящиеся к меткам:

  • Максимальное количество меток на ресурс - 50
  • Для каждого ресурса каждый ключ метки должен быть уникальным, и каждый ключ метки может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8
  • Максимальная длина значения - 256 символов Юникода в UTF-8
  • Если ваша схема меток используется в нескольких сервисах и ресурсах, помните, что другие сервисы могут иметь ограничения на разрешенные символы. В целом разрешенными символами являются: буквы, цифры и пробелы, представляемые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения меток чувствительны к регистру.
  • Не используйте aws: , AWS: или любое сочетание верхнего и нижнего регистра, например, в качестве префикса для ключей или значений, так как это зарезервировано для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения меток с этим префиксом. Метки с этим префиксом не учитываются при подсчете меток на ресурс.

key -> (строка)

Одна часть пары ключ-значение, которая образует метку. Ключ - это общее обозначение, которое действует как категория для более специфических значений меток.

value -> (строка)

Необязательная часть пары ключ-значение, которая образует метку. Значение действует как описание в категории меток (ключ).

failures -> (список)

Возможные ошибки, связанные с вызовом.

(структура)

Неуспешный ресурс. Список распространенных причин см. в разделе «Причины ошибок API» в руководстве разработчика Amazon Elastic Container Service.

arn -> (строка)

Amazon Resource Name (ARN) неудачного ресурса.

reason -> (строка)

Причина ошибки.

detail -> (строка)

Подробности ошибки.

nextToken -> (строка)

Значение nextToken для включения в будущем запросе DescribeCapacityProviders. Когда результаты запроса DescribeCapacityProviders превышают maxResults, это значение может быть использовано для получения следующей страницы результатов. Это значение является null, когда больше результатов не возвращается.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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