Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

list-instances

Описание

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

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

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

Синтаксис

  list-instances
--service-id <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]

Параметры

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

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

--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку 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 .

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

Следующий list-instances пример показывает список экземпляров сервисов.

aws servicediscovery list-instances \
    --service-id srv-qzpwvt2tfqcegapy

Вывод:

{
    "Instances": [
        {
            "Id": "i-06bdabbae60f65a4e",
            "Attributes": {
                "AWS_INSTANCE_IPV4": "172.2.1.3",
                "AWS_INSTANCE_PORT": "808"
            }
        }
    ]
}

Дополнительную информацию см. в разделе Просмотр списка экземпляров сервисов в Руководстве разработчика AWS Cloud Map.

Вывод

Примеры -> (список)

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

(структура)

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

Id -> (строка)

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

Атрибуты -> (карта)

Строковая карта, содержащая следующую информацию:

  • Атрибуты, связанные с экземпляром.
  • Для каждого атрибута — соответствующее значение.

Поддерживаемые ключи атрибутов включают следующие:

AWS_ALIAS_DNS_NAME

Для записи алиаса, которая перенаправляет трафик на балансировщик нагрузки Elastic Load Balancing, имя DNS, связанное с балансировщиком.

AWS_EC2_INSTANCE_ID (только для пространств имен HTTP)

Идентификатор экземпляра Amazon EC2 для экземпляра. Если указан атрибут AWS_EC2_INSTANCE_ID, то атрибут AWS_INSTANCE_IPV4 содержит основной частный IPv4-адрес.

AWS_INIT_HEALTH_STATUS

Если в конфигурации службы включена HealthCheckCustomConfig, вы можете использовать AWS_INIT_HEALTH_STATUS для указания начального состояния пользовательской проверки состояния, HEALTHY или UNHEALTHY. Если вы не укажете значение для AWS_INIT_HEALTH_STATUS, начальное состояние будет HEALTHY.

AWS_INSTANCE_CNAME

Для записи CNAME, доменное имя, которое Route 53 возвращает в ответ на запросы DNS (например, example.com).

AWS_INSTANCE_IPV4

Для записи A, IPv4-адрес, который Route 53 возвращает в ответ на запросы DNS (например, 192.0.2.44).

AWS_INSTANCE_IPV6

Для записи AAAA, IPv6-адрес, который Route 53 возвращает в ответ на запросы DNS (например, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

AWS_INSTANCE_PORT

Для записи SRV, значение, которое Route 53 возвращает для порта. Кроме того, если служба включает HealthCheckConfig, порт на конечной точке, к которой Route 53 отправляет запросы.

ключ -> (строка)

значение -> (строка)

NextToken -> (строка)

Если более чем MaxResults экземпляров соответствуют указанным критериям, вы можете отправить еще один запрос ListInstances для получения следующей группы результатов. Укажите значение NextToken из предыдущего ответа в следующем запросе.

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

Spec-Zone.ru

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