Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-hosts

Описание

Описывает указанные выделенные хосты или все выделенные хосты.

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

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

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

Синтаксис

  describe-hosts
[--host-ids <value>]
[--filter <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]

Параметры

--host-ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

--filter (список)

Фильтры.

  • auto-placement - Включена или выключена автоматическая расстановка (on | off ).
  • availability-zone - Доступная зона хоста.
  • client-token - Маркер идемпотентности, который вы предоставили при выделении хоста.
  • host-reservation-id - Идентификатор резервации, назначенной этому хосту.
  • instance-type - Размер типа экземпляра, который выделенный хост настроен поддерживать.
  • state - Состояние выделения выделенного хоста (available | under-assessment | permanent-failure | released | released-permanent-failure ).
  • tag-key - Ключ тега, назначенного ресурсу. Используйте этот фильтр для поиска всех ресурсов, которым назначен тег с определенным ключом, независимо от значения тега.

(структура)

Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

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

Дополнительная информация: Список и фильтрация с помощью командной строки и API в Руководстве пользователя Amazon EC2.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

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

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

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

Маркер, указывающий, с какой позиции начать постраничную выборку. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

--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
  • text
  • таблица
  • 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.

Примеры

Примечание

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

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

Для просмотра сведений о выделенных хостах

Следующий describe-hosts пример отображает сведения о available выделенных хостах в вашей учетной записи AWS.

aws ec2 describe-hosts --filter "Name=state,Values=available"

Вывод:

{
    "Hosts": [
        {
            "HostId": "h-07879acf49EXAMPLE",
            "Tags": [
                {
                    "Value": "production",
                    "Key": "purpose"
                }
            ],
            "HostProperties": {
                "Cores": 48,
                "TotalVCpus": 96,
                "InstanceType": "m5.large",
                "Sockets": 2
            },
            "Instances": [],
            "State": "available",
            "AvailabilityZone": "eu-west-1a",
            "AvailableCapacity": {
                "AvailableInstanceCapacity": [
                    {
                        "AvailableCapacity": 48,
                        "InstanceType": "m5.large",
                        "TotalCapacity": 48
                    }
                ],
                "AvailableVCpus": 96
            },
            "HostRecovery": "on",
            "AllocationTime": "2019-08-19T08:57:44.000Z",
            "AutoPlacement": "off"
        }
    ]
}

Дополнительную информацию см. в разделе Просмотр выделенных хостов в Руководстве пользователя Amazon Elastic Compute Cloud для Linux-экземпляров.

Вывод

Хосты -> (список)

Информация о выделенных хостах.

(структура)

Описание свойств выделенного хоста.

AutoPlacement -> (строка)

Включено или выключено автоматическое размещение.

AvailabilityZone -> (строка)

Доступная зона выделенного хоста.

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

Информация об экземплярах, запущенных на выделенном хосте.

AvailableInstanceCapacity -> (список)

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

(структура)

Информация о количестве экземпляров, которые можно запустить на выделенном хосте.

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

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

InstanceType -> (строка)

Тип экземпляра, поддерживаемый выделенным хостом.

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

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

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

Количество виртуальных процессоров (vCPU), доступных для запуска экземпляров на выделенном хосте.

ClientToken -> (строка)

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

HostId -> (строка)

Идентификатор выделенного хоста.

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

Технические характеристики выделенного хоста.

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

Количество ядер на выделенном хосте.

InstanceType -> (строка)

Тип экземпляра, поддерживаемый выделенным хостом. Например, m5.large. Если хост поддерживает несколько типов экземпляров, instanceType не возвращается.

InstanceFamily -> (строка)

Семейство экземпляров, поддерживаемое выделенным хостом. Например, m5.

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

Количество сокетов на выделенном хосте.

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

Общее количество виртуальных процессоров (vCPU) на выделенном хосте.

HostReservationId -> (строка)

Идентификатор резервирования выделенного хоста. В случае отсутствия связанного резервирования, возвращается ответ null.

Instances -> (список)

Идентификаторы и типы экземпляров, которые в настоящее время запущены на выделенном хосте.

(структура)

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

InstanceId -> (строка)

Идентификатор экземпляра, работающего на выделенном хосте.

InstanceType -> (строка)

Тип экземпляра (например, m3.medium) запущенного экземпляра.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services, являющейся владельцем экземпляра.

State -> (строка)

Состояние выделенного хоста.

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

Время выделения выделенного хоста.

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

Время освобождения выделенного хоста.

Tags -> (список)

Любые метки, назначенные выделенному хосту.

(структура)

Описание метки.

Key -> (строка)

Ключ метки.

Ограничения: Ключи меток чувствительны к регистру и принимают максимум 127 символов Юникода. Не должны начинаться с aws: .

Value -> (строка)

Значение метки.

Ограничения: Значения меток чувствительны к регистру и принимают максимум 256 символов Юникода.

HostRecovery -> (строка)

Указывает, включено или выключено восстановление хоста для выделенного хоста.

AllowsMultipleInstanceTypes -> (строка)

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

OwnerId -> (строка)

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

AvailabilityZoneId -> (строка)

Идентификатор доступной зоны, в которой выделен хост.

MemberOfServiceLinkedResourceGroup -> (булево)

Указывает, находится ли выделенный хост в группе ресурсов хостов. Если memberOfServiceLinkedResourceGroup равно true, хост находится в группе ресурсов хостов; в противном случае - нет.

OutpostArn -> (строка)

Amazon Resource Name (ARN) Amazon Web Services Outpost, на котором размещен выделенный хост.

HostMaintenance -> (строка)

Указывает, включено или выключено техническое обслуживание хоста для выделенного хоста.

AssetId -> (строка)

Идентификатор ресурса оборудования Outpost, на котором размещен выделенный хост.

NextToken -> (строка)

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

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

Spec-Zone.ru

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