Spec-Zone.ru › AWS CLI v2

[ aws . opsworks ]

describe-ecs-clusters

Описание

Описывает зарегистрированные кластеры Amazon ECS со стеком. Если вы указываете только идентификатор стека, вы можете использовать параметры MaxResults и NextToken для постраничной обработки ответа. Однако OpsWorks Stacks в настоящее время поддерживает только один кластер на слой, поэтому результат содержит максимум один элемент.

Требуемые разрешения: Для использования этого действия пользователь IAM должен иметь уровень разрешений «Показать», «Развернуть» или «Управлять» для стека или прикреплённого политики, явно предоставляющей разрешение. Дополнительную информацию о разрешениях пользователей см. в разделе Управление разрешениями пользователей .

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

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

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

Синтаксис

  describe-ecs-clusters
[--ecs-cluster-arns <value>]
[--stack-id <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]

Параметры

--ecs-cluster-arns (список)

Список ARNs, по одному для каждого кластера, который требуется описать.

(строка)

Синтаксис:

"string" "string" ...

--stack-id (строка)

Идентификатор стека. DescribeEcsClusters возвращает описание кластера, зарегистрированного в стеке.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные данные с помощью предоставленного JSON-значения, поскольку строка будет воспринята буквально. Это нельзя указать вместе с --cli-input-yaml.

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

Маркер для указания, где начать постраничную обработку. Это NextToken из ранее урезанного ответа.

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

--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
  • текст
  • таблица
  • 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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

EcsClusters -> (список)

Список EcsCluster объектов, содержащих описания кластеров.

(структура)

Описание зарегистрированного кластера Amazon ECS.

EcsClusterArn -> (строка)

ARN кластера.

EcsClusterName -> (строка)

Имя кластера.

StackId -> (строка)

Идентификатор стека.

RegisteredAt -> (строка)

Время и дата регистрации кластера в стеке.

NextToken -> (строка)

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

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

Spec-Zone.ru

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