Spec-Zone.ru › AWS CLI v2

[ aws . opsworks ]

describe-instances

Описание

Запрашивает описание набора экземпляров.

Примечание

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

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

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

Синтаксис

  describe-instances
[--stack-id <value>]
[--layer-id <value>]
[--instance-ids <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]

Параметры

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

ID стека. Если вы используете этот параметр, DescribeInstances возвращает описания экземпляров, связанных с указанным стеком.

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

ID слоя. Если вы используете этот параметр, DescribeInstances возвращает описания экземпляров, связанных с указанным слоем.

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

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

(строка)

Синтаксис:

"string" "string" ...

--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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

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

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

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

aws opsworks --region us-east-1 describe-instances --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8

Вывод: Следующий пример вывода предназначен для стека с двумя экземплярами. Первый — зарегистрированный экземпляр EC2, а второй был создан AWS OpsWorks.

{
  "Instances": [
    {
      "StackId": "71c7ca72-55ae-4b6a-8ee1-a8dcded3fa0f",
      "PrivateDns": "ip-10-31-39-66.us-west-2.compute.internal",
      "LayerIds": [
        "26cf1d32-6876-42fa-bbf1-9cadc0bff938"
      ],
      "EbsOptimized": false,
      "ReportedOs": {
        "Version": "14.04",
        "Name": "ubuntu",
        "Family": "debian"
      },
      "Status": "online",
      "InstanceId": "4d6d1710-ded9-42a1-b08e-b043ad7af1e2",
      "SshKeyName": "US-West-2",
      "InfrastructureClass": "ec2",
      "RootDeviceVolumeId": "vol-d08ec6c1",
      "SubnetId": "subnet-b8de0ddd",
      "InstanceType": "t1.micro",
      "CreatedAt": "2015-02-24T20:52:49+00:00",
      "AmiId": "ami-35501205",
      "Hostname": "ip-192-0-2-0",
      "Ec2InstanceId": "i-5cd23551",
      "PublicDns": "ec2-192-0-2-0.us-west-2.compute.amazonaws.com",
      "SecurityGroupIds": [
        "sg-c4d3f0a1"
      ],
      "Architecture": "x86_64",
      "RootDeviceType": "ebs",
      "InstallUpdatesOnBoot": true,
      "Os": "Custom",
      "VirtualizationType": "paravirtual",
      "AvailabilityZone": "us-west-2a",
      "PrivateIp": "10.31.39.66",
      "PublicIp": "192.0.2.06",
      "RegisteredBy": "arn:aws:iam::123456789102:user/AWS/OpsWorks/OpsWorks-EC2Register-i-5cd23551"
    },
    {
      "StackId": "71c7ca72-55ae-4b6a-8ee1-a8dcded3fa0f",
      "PrivateDns": "ip-10-31-39-158.us-west-2.compute.internal",
      "SshHostRsaKeyFingerprint": "69:6b:7b:8b:72:f3:ed:23:01:00:05:bc:9f:a4:60:c1",
      "LayerIds": [
        "26cf1d32-6876-42fa-bbf1-9cadc0bff938"
      ],
      "EbsOptimized": false,
      "ReportedOs": {},
      "Status": "booting",
      "InstanceId": "9b137a0d-2f5d-4cc0-9704-13da4b31fdcb",
      "SshKeyName": "US-West-2",
      "InfrastructureClass": "ec2",
      "RootDeviceVolumeId": "vol-e09dd5f1",
      "SubnetId": "subnet-b8de0ddd",
      "InstanceProfileArn": "arn:aws:iam::123456789102:instance-profile/aws-opsworks-ec2-role",
      "InstanceType": "c3.large",
      "CreatedAt": "2015-02-24T21:29:33+00:00",
      "AmiId": "ami-9fc29baf",
      "SshHostDsaKeyFingerprint": "fc:87:95:c3:f5:e1:3b:9f:d2:06:6e:62:9a:35:27:e8",
      "Ec2InstanceId": "i-8d2dca80",
      "PublicDns": "ec2-192-0-2-1.us-west-2.compute.amazonaws.com",
      "SecurityGroupIds": [
        "sg-b022add5",
        "sg-b122add4"
      ],
      "Architecture": "x86_64",
      "RootDeviceType": "ebs",
      "InstallUpdatesOnBoot": true,
      "Os": "Amazon Linux 2014.09",
      "VirtualizationType": "paravirtual",
      "AvailabilityZone": "us-west-2a",
      "Hostname": "custom11",
      "PrivateIp": "10.31.39.158",
      "PublicIp": "192.0.2.0"
    }
  ]
}

Дополнительная информация

Дополнительную информацию см. в разделе Экземпляры в руководстве пользователя AWS OpsWorks.

Вывод

Экземпляры -> (список)

Массив объектов Instance, описывающих экземпляры.

(структура)

Описывает экземпляр.

AgentVersion -> (строка)

Версия агента. Этот параметр устанавливается в значение INHERIT, если экземпляр наследует настройки стека по умолчанию, или в номер версии для фиксированной версии агента.

AmiId -> (строка)

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

Архитектура -> (строка)

Архитектура экземпляра: “i386” или “x86_64”.

Arn -> (строка)

Amazon Resource Number (ARN) экземпляра.

Тип автоматического масштабирования -> (строка)

Для экземпляров, основанных на нагрузке или времени, тип.

Доступная зона -> (строка)

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

Карты блочных устройств -> (список)

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

(структура)

Описывает отображение блочного устройства. Этот тип данных отображается напрямую на тип данных Amazon EC2 BlockDeviceMapping.

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

Имя устройства, доступное для экземпляра, например, /dev/sdh. Для корневого устройства можно использовать явное имя устройства или установить этот параметр в значение ROOT_DEVICE, и OpsWorks Stacks предоставит правильное имя устройства.

Отсутствует устройство -> (строка)

Запрещает указанное устройство, включенное в отображение блочных устройств AMI.

Виртуальное имя -> (строка)

Имя виртуального устройства. Дополнительную информацию см. в разделе BlockDeviceMapping.

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

Структура, определяющая, как настроить том Amazon EBS при запуске экземпляра.

SnapshotId -> (строка)

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

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

Количество операций ввода-вывода в секунду (IOPS), поддерживаемое томом. Дополнительную информацию см. в разделе EbsBlockDevice.

Размер тома -> (целое число)

Размер тома в ГБ. Дополнительную информацию см. в разделе EbsBlockDevice.

Тип тома -> (строка)

Тип тома. gp2 для томов общего назначения (SSD), io1 для томов с предварительно заданной IOPS (SSD), st1 для жестких дисков с оптимизированной пропускной способностью (HDD), sc1 для жестких дисков Cold HDD и standard для магнитных томов.

Если вы указываете тип тома io1, вы также должны указать значение атрибута Iops. Максимальное соотношение предварительно заданных IOPS к запрошенному размеру тома (в ГБ) составляет 50:1. Amazon Web Services использует размер тома по умолчанию (в ГБ), указанный в атрибутах AMI, для установки IOPS в 50 x (размер тома).

DeleteOnTermination -> (булево)

Удалить том при завершении работы экземпляра.

CreatedAt -> (строка)

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

EbsOptimized -> (булево)

Является ли это экземпляром Amazon EBS-оптимизированного типа.

Ec2InstanceId -> (строка)

Идентификатор связанного экземпляра Amazon EC2.

EcsClusterArn -> (строка)

Для контейнерных экземпляров ARN кластера Amazon ECS.

EcsContainerInstanceArn -> (строка)

Для контейнерных экземпляров ARN экземпляра.

ElasticIp -> (строка)

IP-адрес Elastic экземпляра.

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

Имя хоста экземпляра. Следующие ограничения по длине имени хоста экземпляра:

  • Экземпляры на базе Linux: 63 символа
  • Экземпляры на базе Windows: 15 символов

Класс инфраструктуры -> (строка)

Для зарегистрированных экземпляров класс инфраструктуры: ec2 или on-premises.

Установить обновления при загрузке -> (булево)

Устанавливать обновления операционной системы и пакетов при загрузке экземпляра. Значение по умолчанию — true. Если это значение установлено в false, вы должны обновлять экземпляры вручную, используя CreateDeployment для выполнения команды стека update_dependencies или вручную выполнив yum (Amazon Linux) или apt-get (Ubuntu) на экземплярах.

Примечание

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

Идентификатор экземпляра -> (строка)

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

Arn профиля экземпляра -> (строка)

ARN профиля IAM экземпляра. Дополнительную информацию об IAM ARN см. в разделе Использование идентификаторов.

Тип экземпляра -> (строка)

Тип экземпляра, например, t2.micro.

Идентификатор последней ошибки сервиса -> (строка)

Идентификатор последней ошибки сервиса. Дополнительную информацию см. в разделе DescribeServiceErrors.

Идентификаторы слоев -> (список)

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

(строка)

Os -> (строка)

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

Платформа -> (строка)

Платформа экземпляра.

PrivateDns -> (строка)

Имя частного DNS экземпляра.

PrivateIp -> (строка)

Частный IP-адрес экземпляра.

PublicDns -> (строка)

Имя публичного DNS экземпляра.

PublicIp -> (строка)

Публичный IP-адрес экземпляра.

Зарегистрировано кем -> (строка)

Для зарегистрированных экземпляров, кто выполнил регистрацию.

Отчетная версия агента -> (строка)

Отчетная версия агента OpsWorks Stacks экземпляра.

Отчетная os -> (структура)

Для зарегистрированных экземпляров, отчетная операционная система.

Семейство -> (строка)

Семейство операционных систем.

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

Имя операционной системы.

Версия -> (строка)

Версия операционной системы.

Тип корневого устройства -> (строка)

Тип корневого устройства экземпляра. Дополнительную информацию см. в разделе Хранилище для корневого устройства.

Идентификатор тома корневого устройства -> (строка)

Идентификатор тома корневого устройства.

Идентификаторы групп безопасности -> (список)

Массив, содержащий идентификаторы групп безопасности экземпляра.

(строка)

Отпечаток ключа DSA хоста SSH -> (строка)

Отпечаток ключа DSA (Deep Security Agent) SSH.

Отпечаток ключа RSA хоста SSH -> (строка)

Отпечаток ключа RSA SSH.

Имя пары ключей SSH -> (строка)

Имя пары ключей Amazon EC2 экземпляра.

Идентификатор стека -> (строка)

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

Статус -> (строка)

Статус экземпляра:

  • booting
  • connection_lost
  • online
  • pending
  • rebooting
  • requested
  • running_setup
  • setup_failed
  • shutting_down
  • start_failed
  • stop_failed
  • stopped
  • stopping
  • terminated
  • terminating

Идентификатор подсети -> (строка)

Идентификатор подсети экземпляра; применим только если стек работает в VPC.

Тип аренды -> (строка)

Вариант аренды экземпляра, например, dedicated или host.

Тип виртуализации -> (строка)

Тип виртуализации экземпляра: paravirtual или hvm.

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

Spec-Zone.ru

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