describe-clusters

Описание

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

Примеры использования в командной строке см. в файле describe-clusters.rst на GitHub.

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

Синтаксис

  describe-clusters
[--clusters <value>]
[--include <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]

Параметры

--clusters (список)

Список из до 100 имён кластеров или полных записей Amazon Resource Name (ARN) кластера. Если вы не указываете кластер, используется значение по умолчанию.

(строка)

Синтаксис:

"string" "string" ...

--include (список)

Определяет, следует ли включать дополнительную информацию о кластерах в ответ. Если этот параметр опущен, эта информация не включается.

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

Если указан параметр SETTINGS, в ответ включаются настройки кластера.

Если указан параметр CONFIGURATIONS, в ответ включается конфигурация кластера.

Если указан параметр STATISTICS, включается количество задач и служб, разделенных по типу запуска.

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

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  ATTACHMENTS
  CONFIGURATIONS
  SETTINGS
  STATISTICS
  TAGS

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

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

Автоматический запрос параметров CLI.

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

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

Примеры

Примечание

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

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

Пример 1: Описание кластера

Следующий пример describe-clusters получает подробные сведения об указанном кластере.

aws ecs describe-clusters \
    --cluster default

Вывод:

{
    "clusters": [
        {
            "status": "ACTIVE",
            "clusterName": "default",
            "registeredContainerInstancesCount": 0,
            "pendingTasksCount": 0,
            "runningTasksCount": 0,
            "activeServicesCount": 1,
            "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default"
        }
    ],
    "failures": []
}

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

Пример 2: Описание кластера с опцией привязки

Следующий пример describe-clusters указывает параметр ATTACHMENTS. Он получает подробные сведения об указанном кластере и список ресурсов, привязанных к кластеру в виде привязок. При использовании поставщика ресурсов с кластером ресурсы, такие как планы AutoScaling или политики масштабирования, будут представлены как asp или as_policy ATTACHMENTS.

aws ecs describe-clusters \
    --include ATTACHMENTS \
    --clusters sampleCluster

Вывод:

{
    "clusters": [
        {
            "clusterArn": "arn:aws:ecs:af-south-1:123456789222:cluster/sampleCluster",
            "clusterName": "sampleCluster",
            "status": "ACTIVE",
            "registeredContainerInstancesCount": 0,
            "runningTasksCount": 0,
            "pendingTasksCount": 0,
            "activeServicesCount": 0,
            "statistics": [],
            "tags": [],
            "settings": [],
            "capacityProviders": [
                "sampleCapacityProvider"
            ],
            "defaultCapacityProviderStrategy": [],
            "attachments": [
                {
                    "id": "a1b2c3d4-5678-901b-cdef-EXAMPLE22222",
                    "type": "as_policy",
                    "status": "CREATED",
                    "details": [
                        {
                            "name": "capacityProviderName",
                            "value": "sampleCapacityProvider"
                        },
                        {
                            "name": "scalingPolicyName",
                            "value": "ECSManagedAutoScalingPolicy-3048e262-fe39-4eaf-826d-6f975d303188"
                        }
                    ]
                }
            ],
            "attachmentsStatus": "UPDATE_COMPLETE"
        }
    ],
    "failures": []
}

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

Выходные данные

clusters -> (список)

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

(структура)

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

clusterArn -> (строка)

Идентификатор Amazon Resource Name (ARN) кластера. Дополнительную информацию о формате ARN см. в разделе Amazon Resource Name (ARN) в Руководстве разработчика Amazon ECS.

clusterName -> (строка)

Строка, сгенерированная пользователем, которую вы используете для идентификации вашего кластера.

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

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

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

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

kmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для шифрования данных между локальным клиентом и контейнером.

logging -> (строка)

Настройка журнала для перенаправления логов результатов вашей команды выполнения. Доступны следующие настройки журналов.

NONE : Сессия выполнения команды не регистрируется.
DEFAULT : Используется конфигурация awslogs в определении задачи. Если параметр logging не указан, используется это значение по умолчанию. Если драйвер логов awslogs не настроен в определении задачи, вывод не будет записан в лог.
OVERRIDE : Укажите подробности настройки логов как часть logConfiguration . Если выбран параметр OVERRIDE логов, требуется logConfiguration.

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

Конфигурация логов для результатов действий команды выполнения. Логи могут быть отправлены в CloudWatch Logs или в Amazon S3-ведро. При указании logging=OVERRIDE должен быть предоставлен logConfiguration.

cloudWatchLogGroupName -> (строка)

Имя группы логов CloudWatch, в которую отправляются логи.

Примечание

Группа логов CloudWatch должна быть уже создана.

cloudWatchEncryptionEnabled -> (булево)

Определяет, следует ли использовать шифрование для логов CloudWatch. Если не указано, шифрование выключено.

s3BucketName -> (строка)

Имя S3-ведёрa, в которое отправляются логи.

Примечание

S3-ведро должно быть уже создано.

s3EncryptionEnabled -> (булево)

Определяет, следует ли использовать шифрование для логов S3. Если не указано, шифрование не используется.

s3KeyPrefix -> (строка)

Необязательная папка в S3-ведре для размещения логов.

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

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

kmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для шифрования управляемого Amazon ECS хранилища.

При указании kmsKeyId Amazon ECS использует ключ для шифрования томов, управляемых Amazon ECS, которые прикреплены к задачам в кластере. Следующие тома данных управляются Amazon ECS: Amazon EBS. Дополнительную информацию о шифровании томов Amazon EBS, подключенных к задачам Amazon ECS, см. в Руководстве разработчика Amazon Elastic Container Service.

Ключ должен быть ключом одной области.

fargateEphemeralStorageKmsKeyId -> (строка)

Укажите идентификатор ключа Key Management Service для временного хранилища Fargate.

При указании fargateEphemeralStorageKmsKeyId Amazon Web Services Fargate использует ключ для шифрования данных в состоянии покоя во временном хранилище. Дополнительную информацию о шифровании временного хранилища Fargate см. в Руководстве разработчика Amazon Elastic Container Service.

Ключ должен быть ключом одной области.

status -> (строка)

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

ACTIVE

Кластер готов принимать задачи и, применимо, вы можете регистрировать экземпляры контейнеров в кластере.

PROVISIONING

Кластер имеет поставщиков ресурсов, которые связаны с ним, и ресурсы, необходимые для поставщика ресурсов, создаются.

DEPROVISIONING

Кластер имеет поставщиков ресурсов, которые связаны с ним, и ресурсы, необходимые для поставщика ресурсов, удаляются.

FAILED

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

INACTIVE

Кластер был удалён. Кластеры со статусом INACTIVE могут оставаться доступными в вашем аккаунте в течение некоторого времени. Однако это поведение может измениться в будущем. Не рекомендуется полагаться на сохранение кластеров со статусом INACTIVE.

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

Количество зарегистрированных экземпляров контейнеров в кластере. Включает экземпляры контейнеров в статусе ACTIVE и DRAINING.

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

Количество задач в кластере, которые находятся в состоянии RUNNING.

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

Количество задач в кластере, которые находятся в состоянии PENDING.

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

Количество служб, работающих в кластере в состоянии ACTIVE. Эти службы можно просмотреть с помощью PListServices.

statistics -> (список)

Дополнительная информация о ваших кластерах, разделенная по типу запуска.

runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount

(структура)

Объект пар ключ-значение.

name -> (строка)

Имя пары ключ-значение. Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары ключ-значение. Для переменных среды это значение переменной среды.

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 -> (строка)

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

settings -> (список)

Настройки кластера. Этот параметр указывает, включена или выключена CloudWatch Container Insights для кластера.

(структура)

Настройки для создания кластера. Этот параметр используется для включения CloudWatch Container Insights с расширенной наблюдаемостью или CloudWatch Container Insights для кластера.

CloudWatch Container Insights с расширенной наблюдаемостью предоставляет все метрики Container Insights, а также дополнительные метрики задач и контейнеров. Этот вариант поддерживает расширенную наблюдаемость для кластеров Amazon ECS, использующих типы запуска Amazon EC2 и Fargate. После настройки Container Insights с расширенной наблюдаемостью в Amazon ECS Container Insights автоматически собирает подробную телеметрию инфраструктуры с уровня кластера до уровня контейнера в вашей среде и отображает эти критически важные данные производительности на настроенных панелях управления, устраняя необходимость сложной настройки наблюдаемости.

Дополнительную информацию см. в Руководстве разработчика Amazon Elastic Container Service.

name -> (строка)

Имя настройки кластера. Значение - containerInsights.

value -> (строка)

Значение для настройки кластера. Поддерживаемые значения - enhanced , enabled и disabled.

Для использования Container Insights с расширенной наблюдаемостью установите параметр аккаунта containerInsights на значение enhanced.

Для использования Container Insights установите параметр аккаунта containerInsights на значение enabled.

Если значение для кластера указано, оно переопределит значение containerInsights, установленное с помощью PutAccountSetting или PutAccountSettingDefault.

capacityProviders -> (список)

Поставщики ресурсов, связанные с кластером.

(строка)

defaultCapacityProviderStrategy -> (список)

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

(структура)

Подробности стратегии поставщика ресурсов. Стратегию поставщика ресурсов можно задать при использовании API RunTask или CreateCluster или в качестве стратегии поставщика ресурсов по умолчанию для кластера с помощью API CreateCluster.

В стратегии поставщика ресурсов можно использовать только поставщики ресурсов, которые уже связаны с кластером и имеют статус ACTIVE или UPDATING. API PutClusterCapacityProviders используется для связи поставщика ресурсов с кластером.

Если вы указываете поставщик ресурсов, использующий группу Auto Scaling, этот поставщик ресурсов должен быть уже создан. Новые поставщики ресурсов группы Auto Scaling могут быть созданы с помощью операции API CreateClusterCapacityProvider.

Для использования поставщика ресурсов Fargate укажите либо поставщиков ресурсов FARGATE, либо FARGATE_SPOT. Поставщики ресурсов Fargate доступны всем аккаунтам и требуют только связи с кластером для использования в стратегии поставщика ресурсов.

С помощью FARGATE_SPOT вы можете запускать задачи, устойчивые к прерываниям, со скидкой по сравнению с ценой FARGATE. FARGATE_SPOT запускает задачи на свободных вычислительных ресурсах. Когда Amazon Web Services нуждается в этих ресурсах обратно, ваши задачи прерываются с двухминутным предупреждением. FARGATE_SPOT поддерживает задачи Linux с архитектурой X86_64 на версии платформы 1.3.0 или более поздней. FARGATE_SPOT поддерживает задачи Linux с архитектурой ARM64 на версии платформы 1.4.0 или более поздней.

Стратегия поставщика ресурсов может содержать не более 20 поставщиков ресурсов.

capacityProvider -> (строка)

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

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

Значение weight определяет относительный процент от общего числа запушенных задач, которые должны использовать указанный поставщик ресурсов. Значение weight учитывается после значения base, если оно определено.

Если значение weight не указано, используется значение по умолчанию 0. Если в стратегии поставщика ресурсов указано несколько поставщиков ресурсов, по крайней мере один из поставщиков ресурсов должен иметь значение weight, большее нуля, а любые поставщики ресурсов с весом 0 не могут использоваться для размещения задач. Если вы указываете в стратегии несколько поставщиков ресурсов, у которых все имеют вес 0, любые действия RunTask или CreateService, использующие стратегию поставщика ресурсов, завершатся ошибкой.

Пример сценария использования весов: определение стратегии, содержащей двух поставщиков ресурсов, у которых оба имеют вес 1, затем, когда значение base выполнено, задачи будут разделены равномерно между двумя поставщиками ресурсов. Используя ту же логику, если вы указываете вес 1 для capacityProviderA и вес 4 для capacityProviderB, то на каждую задачу, запущенную с помощью capacityProviderA, четыре задачи будут использовать capacityProviderB.

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

Значение base определяет минимальное количество задач, которые необходимо запустить на указанном поставщике ресурсов. Только один поставщик ресурсов в стратегии поставщика ресурсов может иметь заданное base. Если значение не указано, используется значение по умолчанию 0.

attachments -> (список)

Ресурсы, прикрепленные к кластеру. При использовании поставщика ресурсов с кластером поставщик ресурсов и связанные с ним ресурсы возвращаются в виде прикреплений к кластеру.

(структура)

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

id -> (строка)

Уникальный идентификатор прикрепления.

type -> (строка)

Тип прикрепления, например ElasticNetworkInterface, Service Connect и AmazonElasticBlockStorage.

status -> (строка)

Статус прикрепления. Допустимые значения: PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED и FAILED.

details -> (список)

Подробности прикрепления.

Для интерфейсов эластичной сети это включает идентификатор интерфейса сети, MAC-адрес, идентификатор подсети и частный IPv4-адрес.

Для служб Service Connect это включает portName, clientAliases, discoveryName и ingressPortOverride.

Для Elastic Block Storage это включает roleArn, deleteOnTermination, volumeName, volumeId и statusReason (только в случае, если прикрепление не удалось создать или прикрепить).

(структура)

Объект пар ключ-значение.

name -> (строка)

Имя пары ключ-значение. Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары ключ-значение. Для переменных среды это значение переменной среды.

attachmentsStatus -> (строка)

Статус поставщиков ресурсов, связанных с кластером. Ниже приведены состояния, которые возвращаются.

UPDATE_IN_PROGRESS

Доступные поставщики ресурсов для кластера обновляются.

UPDATE_COMPLETE

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

UPDATE_FAILED

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

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

Используйте этот параметр для установки пространства имен Service Connect по умолчанию. После установки пространства имен Service Connect по умолчанию все новые службы с включенным Service Connect, созданные в кластере, добавляются как клиентские службы в этом пространстве имен. Это условие относится только к новым службам, которые устанавливают параметр enabled в значение true в ServiceConnectConfiguration. Вы можете установить пространство имен каждой службы индивидуально в ServiceConnectConfiguration, чтобы переопределить этот параметр по умолчанию.

Задачи, выполняемые в пространстве имен, могут использовать короткие имена для подключения к службам в этом пространстве имен. Задачи могут подключаться к службам через все кластеры в пространстве имен. Задачи подключаются через управляемый контейнер-прокси, который собирает журналы и метрики для повышения видимости. Поддерживаются только те задачи, которые создаются службами Amazon ECS. Дополнительную информацию см. в разделе Service Connect в руководстве разработчика Amazon Elastic Container Service.

namespace -> (строка)

Имя пространства имен или полный Amazon Resource Name (ARN) пространства имен Cloud Map. При создании службы и отсутствии указания конфигурации Service Connect используется это пространство имен.

failures -> (список)

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

(структура)

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

arn -> (строка)

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

reason -> (строка)

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

detail -> (строка)

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

END_OF_DOCUMENT_MARKER