Spec-Zone.ru › AWS CLI v2

[ aws . emr ]

list-clusters

Описание

Предоставляет состояние всех кластеров, видимых для этой учетной записи Amazon Web Services. Позволяет фильтровать список кластеров по определенным критериям; например, по дате и времени создания кластера или по состоянию. Этот вызов возвращает максимум 50 кластеров в произвольном порядке за один вызов, но возвращает маркер для отслеживания постраничной навигации списка кластеров при нескольких вызовах ListClusters.

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

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

Синтаксис

  list-clusters
[--created-after <value>]
[--created-before <value>]
[--cluster-states <value>]
[--active | --terminated | --failed]
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

--created-after (метка времени)

Отобразить только те кластеры, которые были созданы после указанной даты и времени в формате yyyy-mm-ddThh:mm:ss. Например, --created-after 2017-07-04T00:01:30.

--created-before (метка времени)

Отобразить только те кластеры, которые были созданы до указанной даты и времени в формате yyyy-mm-ddThh:mm:ss. Например, --created-before 2017-07-04T00:01:30.

--cluster-states (строка)

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

Принимает следующие значения состояний:

  • STARTING
  • BOOTSTRAPPING
  • RUNNING
  • WAITING
  • TERMINATING
  • TERMINATED
  • TERMINATED_WITH_ERRORS

--active | --terminated | --failed (булево)

Сокращенные параметры для –cluster-states. Можно указать следующие сокращенные параметры:

  • --active - отобразить только кластеры, которые являются STARTING , ``BOOTSTRAPPING`` , RUNNING , WAITING или TERMINATING .
  • --terminated - отобразить только кластеры, которые являются TERMINATED .
  • --failed - отобразить только кластеры, которые являются TERMINATED_WITH_ERRORS .

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

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

Токен для указания начала постраничной навигации. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе «Постраничная навигация» в руководстве пользователя 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого файла, которое отображается в двоичный блок, 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.

Следующая команда перечисляет все активные кластеры EMR в текущем регионе:

aws emr list-clusters --active

Вывод:

{
    "Clusters": [
        {
            "Status": {
                "Timeline": {
                    "ReadyDateTime": 1433200405.353,
                    "CreationDateTime": 1433199926.596
                },
                "State": "WAITING",
                "StateChangeReason": {
                    "Message": "Waiting after step completed"
                }
            },
            "NormalizedInstanceHours": 6,
            "Id": "j-3SD91U2E1L2QX",
            "Name": "my-cluster"
        }
    ]
}

Вывод

Кластеры -> (список)

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

(структура)

Краткое описание кластера.

Id -> (строка)

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

Name -> (строка)

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

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

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

State -> (строка)

Текущее состояние кластера.

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

Причина изменения состояния кластера.

Code -> (строка)

Программный код причины изменения состояния.

Message -> (строка)

Описание причины изменения состояния.

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

Временная шкала, отображающая состояние кластера на протяжении всего его существования.

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

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

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

Дата и время, когда кластер был готов к запуску шагов.

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

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

ErrorDetails -> (список)

Список кортежей, содержащих информацию об ошибках, которые привели к завершению работы кластера. Эта структура может содержать до 10 различных кортежей ErrorDetail.

(структура)

Кортеж, содержащий информацию об ошибке, которая привела к завершению работы кластера.

ErrorCode -> (строка)

Имя или код, связанные с ошибкой.

ErrorData -> (список)

Список пар ключ-значение, предоставляющих контекстную информацию о причине возникновения ошибки.

(массив)

key -> (строка)

value -> (строка)

ErrorMessage -> (строка)

Сообщение, описывающее ошибку.

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

Приблизительная стоимость кластера, выраженная в m1.small/час. Это значение увеличивается один раз за каждый час работы экземпляра m1.small. Большие экземпляры имеют больший вес, поэтому экземпляр Amazon EC2, который примерно в четыре раза дороже, приведет к увеличению нормализованных часов работы на четыре. Этот результат является лишь приблизительным и не отражает фактический тариф за оплату.

ClusterArn -> (строка)

Amazon Resource Name (ARN) кластера.

OutpostArn -> (строка)

Amazon Resource Name (ARN) региона Outpost, где запущен кластер.

Marker -> (строка)

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

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

Spec-Zone.ru

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