Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-instance-status

Описание

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

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

  • Проверки состояния - Amazon EC2 выполняет проверки состояния запущенных экземпляров EC2 для выявления проблем с аппаратным и программным обеспечением. Дополнительную информацию см. в разделах «Проверки состояния ваших экземпляров» и «Устранение неполадок экземпляров с не пройденными проверками состояния» в руководстве пользователя Amazon EC2.
  • Запланированные события - Amazon EC2 может планировать события (такие как перезагрузка, остановка или завершение работы) для ваших экземпляров, связанных с проблемами аппаратного обеспечения, обновлениями программного обеспечения или техническим обслуживанием системы. Дополнительную информацию см. в разделе «Запланированные события для ваших экземпляров» в руководстве пользователя Amazon EC2.
  • Состояние экземпляра - Вы можете управлять своими экземплярами с момента запуска до завершения их работы. Дополнительную информацию см. в разделе «Жизненный цикл экземпляра» в руководстве пользователя Amazon EC2.

Amazon EC2 API использует модель конечной согласованности. Это означает, что результат API-команды, которую вы выполняете для создания или изменения ресурсов, может не быть сразу доступен для всех последующих команд, которые вы выполняете. Инструкции по управлению конечной согласованностью см. в разделе «Конечная согласованность в API Amazon EC2» в руководстве разработчика Amazon EC2.

Примечание

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

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

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

Синтаксис

  describe-instance-status
[--instance-ids <value>]
[--dry-run | --no-dry-run]
[--filters <value>]
[--include-all-instances | --no-include-all-instances]
[--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]

Параметры

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

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

По умолчанию: описывает все ваши экземпляры.

Ограничения: Максимально 100 явно указанных идентификаторов экземпляров.

(строка)

Синтаксис:

"string" "string" ...

--dry-run | --no-dry-run (логическое значение)

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

--filters (список)

Фильтры.

  • availability-zone - Доступная зона экземпляра.
  • event.code - Код запланированного события (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
  • event.description - Описание события.
  • event.instance-event-id - Идентификатор события, дату и время которого вы изменяете.
  • event.not-after - Наименьшее время окончания запланированного события (например, 2014-09-15T17:15:20.000Z).
  • event.not-before - Наименьшее время начала запланированного события (например, 2014-09-15T17:15:20.000Z).
  • event.not-before-deadline - Срок для начала события (например, 2014-09-15T17:15:20.000Z).
  • instance-state-code - Код состояния экземпляра, как 16-битное беззнаковое целое число. Старший байт используется для внутренних целей и должен быть проигнорирован. Младший байт устанавливается в зависимости от представленного состояния. Действительные значения: 0 (ожидание), 16 (запущен), 32 (остановка), 48 (завершён), 64 (остановка), и 80 (остановлен).
  • instance-state-name - Состояние экземпляра (pending | running | shutting-down | terminated | stopping | stopped).
  • instance-status.reachability - Фильтры состояния экземпляра, где имя равно reachability (passed | failed | initializing | insufficient-data).
  • instance-status.status - Состояние экземпляра (ok | impaired | initializing | insufficient-data | not-applicable).
  • operator.managed - Логическое значение, указывающее, является ли это управляемым экземпляром.
  • operator.principal - Субъект, управляющий экземпляром. Действительно только для управляемых экземпляров, где managed равно true.
  • system-status.reachability - Фильтры состояния системы, где имя равно reachability (passed | failed | initializing | insufficient-data).
  • system-status.status - Состояние системы экземпляра (ok | impaired | initializing | insufficient-data | not-applicable).
  • attached-ebs-status.status - Состояние присоединённого тома EBS для экземпляра (ok | impaired | initializing | insufficient-data | not-applicable).

(структура)

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

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

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

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

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

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

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

(строка)

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

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

Синтаксис JSON:

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

--include-all-instances | --no-include-all-instances (логическое значение)

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

По умолчанию: false

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

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

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для продолжения постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки API-запроса. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Переопределить значение URL по умолчанию команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого подключения SSL AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для бинарных блоков. Формат по умолчанию — 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 (boolean)

Отключить вывод пагинатора CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Для описания состояния экземпляра

Следующий describe-instance-status пример описывает текущее состояние указанного экземпляра.

aws ec2 describe-instance-status \
    --instance-ids i-1234567890abcdef0

Вывод:

{
    "InstanceStatuses": [
        {
            "InstanceId": "i-1234567890abcdef0",
            "InstanceState": {
                "Code": 16,
                "Name": "running"
            },
            "AvailabilityZone": "us-east-1d",
            "SystemStatus": {
                "Status": "ok",
                "Details": [
                    {
                        "Status": "passed",
                        "Name": "reachability"
                    }
                ]
            },
            "InstanceStatus": {
                "Status": "ok",
                "Details": [
                    {
                        "Status": "passed",
                        "Name": "reachability"
                    }
                ]
            }
        }
    ]
}

Дополнительную информацию см. в разделе Отслеживание состояния ваших экземпляров в Руководстве пользователя Amazon EC2.

Вывод

InstanceStatuses -> (список)

Информация о состоянии экземпляров.

(структура)

Описание состояния экземпляра.

AvailabilityZone -> (строка)

Зона доступности экземпляра.

OutpostArn -> (строка)

Amazon Resource Name (ARN) сервиса Outpost.

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

Поставщик услуг, управляющий экземпляром.

Managed -> (boolean)

Если true , ресурс управляется поставщиком услуг.

Principal -> (строка)

Если managed равен true , возвращается управляющий ресурсом поставщик услуг.

Events -> (список)

Любые запланированные события, связанные с экземпляром.

(структура)

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

InstanceEventId -> (строка)

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

Code -> (строка)

Код события.

Description -> (строка)

Описание события.

После завершения запланированного события его можно описать в течение недели. Если событие завершено, это описание начинается со следующих слов: [Завершено].

NotAfter -> (временная метка)

Самое позднее запланированное время завершения события.

NotBefore -> (временная метка)

Самое раннее запланированное время начала события.

NotBeforeDeadline -> (временная метка)

Дедлайн для начала события.

InstanceId -> (строка)

Идентификатор экземпляра.

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

Предполагаемое состояние экземпляра. Для DescribeInstanceStatus экземпляр должен находиться в состоянии running.

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

Состояние экземпляра как 16-битное беззнаковое целое число.

Высший байт — все биты между 2^8 и (2^16)-1, что равно десятичным значениям от 256 до 65 535. Эти числовые значения используются во внутренних целях и должны быть проигнорированы.

Нижний байт — все биты между 2^0 и (2^8)-1, что равно десятичным значениям от 0 до 255.

Допустимые значения для instance-state-code будут находиться в диапазоне нижнего байта, и они:

  • 0 : pending
  • 16 : running
  • 32 : shutting-down
  • 48 : terminated
  • 64 : stopping
  • 80 : stopped

Вы можете проигнорировать значение старшего байта, обнулив все биты выше 2^8 или 256 в десятичном формате.

Name -> (строка)

Текущее состояние экземпляра.

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

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

Details -> (список)

Здоровье системного или прикладного экземпляра.

(структура)

Описание состояния экземпляра.

ImpairedSince -> (временная метка)

Время, когда проверка статуса завершилась неудачно. Для экземпляра, который был запущен и имеет состояние нарушения, это время запуска экземпляра.

Name -> (строка)

Тип состояния экземпляра.

Status -> (строка)

Состояние.

Status -> (строка)

Состояние.

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

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

Details -> (список)

Здоровье системного или прикладного экземпляра.

(структура)

Описание состояния экземпляра.

ImpairedSince -> (временная метка)

Время, когда проверка статуса завершилась неудачно. Для экземпляра, который был запущен и имеет состояние нарушения, это время запуска экземпляра.

Name -> (строка)

Тип состояния экземпляра.

Status -> (строка)

Состояние.

Status -> (строка)

Состояние.

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

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

Details -> (список)

Подробности о проверке состояния подключенного тома EBS для экземпляра.

(структура)

Описание проверки состояния подключенного тома EBS для экземпляра.

ImpairedSince -> (временная метка)

Дата и время, когда проверка состояния подключенного тома EBS завершилась неудачно.

Name -> (строка)

Имя проверки состояния подключенного тома EBS.

Status -> (строка)

Результат проверки состояния подключенного тома EBS.

Status -> (строка)

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

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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