Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

get-instance

Описание

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

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

Синтаксис

  get-instance
--instance-name <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]

Параметры

--instance-name (строка)

Имя экземпляра.

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

Для получения информации об экземпляре

Следующий get-instance пример отображает детали экземпляра MEAN-1.

aws lightsail get-instance \
    --instance-name MEAN-1

Вывод:

{
    "instance": {
        "name": "MEAN-1",
        "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/bd470fc5-a68b-44c5-8dbc-EXAMPLE4bada",
        "supportCode": "6EXAMPLE3362/i-05EXAMPLE407c97d3",
        "createdAt": 1570635023.124,
        "location": {
            "availabilityZone": "us-west-2a",
            "regionName": "us-west-2"
        },
        "resourceType": "Instance",
        "tags": [],
        "blueprintId": "mean",
        "blueprintName": "MEAN",
        "bundleId": "medium_3_0",
        "isStaticIp": false,
        "privateIpAddress": "192.0.2.0",
        "publicIpAddress": "192.0.2.0",
        "hardware": {
            "cpuCount": 2,
            "disks": [
                {
                    "createdAt": 1570635023.124,
                    "sizeInGb": 80,
                    "isSystemDisk": true,
                    "iops": 240,
                    "path": "/dev/xvda",
                    "attachedTo": "MEAN-1",
                    "attachmentState": "attached"
                }
            ],
            "ramSizeInGb": 4.0
        },
        "networking": {
            "monthlyTransfer": {
                "gbPerMonthAllocated": 4096
            },
            "ports": [
                {
                    "fromPort": 80,
                    "toPort": 80,
                    "protocol": "tcp",
                    "accessFrom": "Anywhere (0.0.0.0/0)",
                    "accessType": "public",
                    "commonName": "",
                    "accessDirection": "inbound"
                },
                {
                    "fromPort": 22,
                    "toPort": 22,
                    "protocol": "tcp",
                    "accessFrom": "Anywhere (0.0.0.0/0)",
                    "accessType": "public",
                    "commonName": "",
                    "accessDirection": "inbound"
                },
                {
                    "fromPort": 443,
                    "toPort": 443,
                    "protocol": "tcp",
                    "accessFrom": "Anywhere (0.0.0.0/0)",
                    "accessType": "public",
                    "commonName": "",
                    "accessDirection": "inbound"
                }
            ]
        },
        "state": {
            "code": 16,
            "name": "running"
        },
        "username": "bitnami",
        "sshKeyName": "MyKey"
    }
}

Вывод

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

Массив пар ключ-значение, содержащих информацию о заданном экземпляре.

name -> (строка)

Имя, заданное пользователем для экземпляра (Amazon_Linux_2023-1).

arn -> (строка)

Amazon Resource Name (ARN) экземпляра (arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

supportCode -> (строка)

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

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

Метка времени создания экземпляра (1479734909.17) в формате Unix.

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

Имя региона и зона доступности, где расположен экземпляр.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса (обычно Instance).

tags -> (список)

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

(структура)

Описание ключа тега и необязательного значения, назначенного ресурсу Amazon Lightsail.

Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 букв, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: Значения тегов принимают максимум 256 букв, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

blueprintId -> (строка)

Идентификатор шаблона (amazon_linux_2023).

blueprintName -> (строка)

Дружественное имя шаблона (Amazon Linux 2023).

bundleId -> (строка)

Набор для экземпляра (micro_x_x).

addOns -> (список)

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

(структура)

Описание дополнения, включенного в ресурс Amazon Lightsail.

name -> (строка)

Имя дополнения.

status -> (строка)

Статус дополнения.

snapshotTimeOfDay -> (строка)

Ежедневное время создания автоматической копии.

Время показано в формате HH:00 и в формате Coordinated Universal Time (UTC).

Копия автоматически создается между указанным временем и в течение 45 минут после него.

nextSnapshotTimeOfDay -> (строка)

Следующее ежедневное время создания автоматической копии.

Время показано в формате HH:00 и в формате Coordinated Universal Time (UTC).

Копия автоматически создается между указанным временем и в течение 45 минут после него.

threshold -> (строка)

Пороговое значение триггера действия.

Предупреждение

Это дополнение применяется только к ресурсам Lightsail for Research.

duration -> (строка)

Время простоя в минутах, после которого ваш виртуальный компьютер автоматически остановится.

Предупреждение

Это дополнение применяется только к ресурсам Lightsail for Research.

isStaticIp -> (булево)

Булевое значение, указывающее, назначен ли этому экземпляру статический IP-адрес.

privateIpAddress -> (строка)

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

publicIpAddress -> (строка)

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

ipv6Addresses -> (список)

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

(строка)

ipAddressType -> (строка)

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

Возможные значения — ipv4 для только IPv4, ipv6 для только IPv6 и dualstack для IPv4 и IPv6.

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

Размер vCPU и объем памяти RAM для экземпляра.

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

Количество vCPU экземпляра.

disks -> (список)

Диски, подключенные к экземпляру.

(структура)

Описание диска блочного хранения.

name -> (строка)

Уникальное имя диска.

arn -> (строка)

Amazon Resource Name (ARN) диска.

supportCode -> (строка)

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

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

Дата создания диска.

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

AWS-регион и зона доступности, где находится диск.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail (Disk).

tags -> (список)

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

(структура)

Описание ключа тега и необязательного значения, назначенного ресурсу Amazon Lightsail.

Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail.

key -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 букв, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

value -> (строка)

Значение тега.

Ограничения: Значения тегов принимают максимум 256 букв, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

addOns -> (список)

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

(структура)

Описание дополнения, включенного в ресурс Amazon Lightsail.

name -> (строка)

Имя дополнения.

status -> (строка)

Статус дополнения.

snapshotTimeOfDay -> (строка)

Ежедневное время создания автоматической копии.

Время показано в формате HH:00 и в формате Coordinated Universal Time (UTC).

Копия автоматически создается между указанным временем и в течение 45 минут после него.

nextSnapshotTimeOfDay -> (строка)

Следующее ежедневное время создания автоматической копии.

Время показано в формате HH:00 и в формате Coordinated Universal Time (UTC).

Копия автоматически создается между указанным временем и в течение 45 минут после него.

threshold -> (строка)

Пороговое значение триггера действия.

Предупреждение

Это дополнение применяется только к ресурсам Lightsail for Research.

duration -> (строка)

Время простоя в минутах, после которого ваш виртуальный компьютер автоматически остановится.

Предупреждение

Это дополнение применяется только к ресурсам Lightsail for Research.

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

Размер диска в ГБ.

isSystemDisk -> (булево)

Булевое значение, указывающее, является ли этот диск системным диском (с загруженной на него операционной системой).

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

Количество операций ввода/вывода в секунду (IOPS) диска.

path -> (строка)

Путь к диску.

state -> (строка)

Описывает состояние диска.

attachedTo -> (строка)

Ресурсы, к которым подключен диск.

isAttached -> (булево)

Булевое значение, указывающее, подключен ли диск.

attachmentState -> (строка)

(Устарело) Состояние подключения диска.

Примечание

В версиях до 14 ноября 2017 года этот параметр возвращал attached для системных дисков в ответе API. Он теперь устарел, но все еще включён в ответ. Используйте isAttached вместо этого.

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

(Устарело) Количество используемых ГБ диска.

Примечание

В версиях до 14 ноября 2017 года этот параметр не был включён в ответ API. Он теперь устарел.

autoMountStatus -> (строка)

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

Предупреждение

Этот параметр применим только к ресурсам Lightsail for Research.

ramSizeInGb -> (число с плавающей точкой)

Объем памяти RAM в ГБ на экземпляре (1.0).

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

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

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

Количество данных в ГБ, выделенное для ежемесячной передачи данных.

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

Выделенное количество в месяц (в ГБ).

ports -> (список)

Массив пар ключ-значение, содержащих информацию о портах на экземпляре.

(структура)

Описывает информацию о портах для экземпляра Amazon Lightsail.

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

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

Разрешенные порты:

  • TCP и UDP - 0 до 65535
  • ICMP - Тип ICMP для IPv4-адресов. Например, укажите 8 как fromPort (тип ICMP), и -1 как toPort (код ICMP), чтобы включить ICMP Ping. Дополнительную информацию см. в разделе Управляющие сообщения на Wikipedia .
  • ICMPv6 - Тип ICMP для IPv6-адресов. Например, укажите 128 как fromPort (тип ICMPv6), и 0 как toPort (код ICMPv6). Дополнительную информацию см. в разделе Internet Control Message Protocol for IPv6 .

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

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

Разрешенные порты:

  • TCP и UDP - 0 до 65535
  • ICMP - Код ICMP для IPv4-адресов. Например, укажите 8 как fromPort (тип ICMP), и -1 как toPort (код ICMP), чтобы включить ICMP Ping. Дополнительную информацию см. в разделе Управляющие сообщения на Wikipedia .
  • ICMPv6 - Код ICMP для IPv6-адресов. Например, укажите 128 как fromPort (тип ICMPv6), и 0 как toPort (код ICMPv6). Дополнительную информацию см. в разделе Internet Control Message Protocol for IPv6 .

protocol -> (строка)

Имя IP-протокола.

Имя может быть одним из следующих:

  • tcp - Протокол управления передачей (TCP) обеспечивает надежную, упорядоченную и проверенную на ошибки доставку потоковых данных между приложениями, работающими на хостах, общающихся по IP-сети. Если у вас приложение, которому не требуется надежная служба потоковой передачи данных, используйте UDP вместо этого.
  • all - Все типы протоколов транспортного уровня. Для более общей информации см. Уровень транспорта на Wikipedia .
  • udp - С протоколом пользовательских датаграмм (UDP) компьютерные приложения могут отправлять сообщения (или датаграммы) другим хостам в сети Интернет-протокола (IP). Предыдущие коммуникации не требуются для настройки каналов передачи или маршрутов данных. Приложения, которым не требуется надежная служба потоковой передачи данных, могут использовать UDP, который обеспечивает бессоединительную службу датаграмм, делая упор на снижение задержки в ущерб надежности. Если вам требуется надежная служба потоковой передачи данных, используйте TCP вместо этого.
  • icmp - Протокол управления сообщениями в Интернете (ICMP) используется для отправки сообщений об ошибках и информации об операциях, указывающих на успех или неудачу при общении с экземпляром. Например, ошибка указывается, когда экземпляр не может быть достигнут. Когда вы указываете icmp в качестве protocol, вы должны указать тип ICMP с помощью параметра fromPort и код ICMP с помощью параметра toPort.
  • icmp6 - Протокол управления сообщениями в Интернете (ICMP) для IPv6. Когда вы указываете icmp6 в качестве protocol, вы должны указать тип ICMP с помощью параметра fromPort и код ICMP с помощью параметра toPort.

accessFrom -> (строка)

Местоположение, откуда разрешен доступ. Например, Anywhere (0.0.0.0/0) или Custom, если разрешен конкретный IP-адрес или диапазон IP-адресов.

accessType -> (строка)

Тип доступа (Public или Private).

commonName -> (строка)

Общее имя информации о порте.

accessDirection -> (строка)

Направление доступа (inbound или outbound).

Примечание

Lightsail в настоящее время поддерживает только inbound направление доступа.

cidrs -> (список)

IPv4-адрес или диапазон IPv4-адресов (в нотации CIDR), которым разрешено подключаться к экземпляру через порты и протокол.

Примечание

Параметр ipv6Cidrs перечисляет IPv6-адреса, которым разрешено подключаться к экземпляру.

Дополнительную информацию о нотации блока CIDR см. в разделе Классовая междоменная маршрутизация на Wikipedia .

(строка)

ipv6Cidrs -> (список)

IPv6-адрес или диапазон IPv6-адресов (в нотации CIDR), которым разрешено подключаться к экземпляру через порты и протокол. Только устройства с IPv6-адресом могут подключаться к экземпляру через IPv6; в противном случае следует использовать IPv4.

Примечание

Параметр cidrs перечисляет IPv4-адреса, которым разрешено подключаться к экземпляру.

Дополнительную информацию о нотации блока CIDR см. в разделе Классовая междоменная маршрутизация на Wikipedia .

(строка)

cidrListAliases -> (список)

Псевдоним, определяющий доступ для предварительно сконфигурированного диапазона IP-адресов.

В настоящее время поддерживается только псевдоним lightsail-connect, который позволяет IP-адресам браузерного RDP/SSH-клиента в консоли Lightsail подключаться к вашему экземпляру.

(строка)

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

Код состояния и состояние (running) для экземпляра.

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

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

name -> (строка)

Состояние экземпляра (running или pending).

username -> (строка)

Имя пользователя для подключения к экземпляру (ec2-user).

sshKeyName -> (строка)

Имя SSH-ключа, используемого для подключения к экземпляру (LightsailDefaultKeyPair).

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

Параметры метаданных для экземпляра Amazon Lightsail.

state -> (строка)

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

Возможны следующие состояния:

  • pending - Параметры метаданных обновляются. Экземпляр еще не готов обрабатывать трафик метаданных с новым выбором.
  • applied - Параметры метаданных успешно применены к экземпляру.

httpTokens -> (строка)

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

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

Если состояние required, вы должны отправлять заголовок подписанного токена со всеми запросами получения метаданных экземпляра. В этом состоянии получение учетных данных роли IAM всегда возвращает учетные данные версии 2.0. Учетные данные версии 1.0 недоступны.

Предупреждение

Не все шаблоны экземпляров в Lightsail поддерживают учетные данные версии 2.0. Используйте метрику экземпляра MetadataNoToken для отслеживания количества вызовов службы метаданных экземпляра, использующих учетные данные версии 1.0. Дополнительную информацию см. в разделе Просмотр метрик экземпляров в Amazon Lightsail в руководстве разработчика Amazon Lightsail.

httpEndpoint -> (строка)

Указывает, включен или выключен HTTP-точку входа для метаданных ваших экземпляров.

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

Желаемый предел переходов HTTP-ответа PUT для запросов метаданных экземпляра. Большее значение означает, что запросы метаданных экземпляра могут пройти дальше.

httpProtocolIpv6 -> (строка)

Указывает, включен или выключен IPv6-точку входа для службы метаданных экземпляра.

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

Spec-Zone.ru

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