describe-instances

Описание

Получает информацию об экземплярах EC2 в управляемом флоте Amazon GameLift, включая идентификатор экземпляра, данные подключения и статус. Вы можете использовать эту операцию с многолокационным флотом, чтобы получить информацию об экземплярах в конкретной локации. В качестве альтернативы используйте операции https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute и https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute для получения информации о вычислительных ресурсах, включая флоты EC2 и Anywhere.

Вы можете вызвать эту операцию следующим образом:

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

Используйте параметры постраничной навигации, чтобы получать результаты в виде набора последовательных страниц.

При успешном выполнении эта операция возвращает Instance объекты для каждого запрошенного экземпляра, в произвольном порядке. Если вы вызываете эту операцию для флота Anywhere, вы получите InvalidRequestException.

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

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

Синтаксис

  describe-instances
--fleet-id <value>
[--instance-id <value>]
[--location <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]

Параметры

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

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

--location (строка)

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

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

--page-size (целое число)

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

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

Вывод

Instances -> (список)

NextToken -> (строка)