Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

discover-instances

Описание

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

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

Синтаксис

  discover-instances
--namespace-name <value>
--service-name <value>
[--max-results <value>]
[--query-parameters <value>]
[--optional-parameters <value>]
[--health-status <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]

Параметры

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

Имя пространства имен. Оно находится в члене HttpProperties члена Properties пространства имен. В большинстве случаев, Name и HttpName совпадают. Однако, если вы повторно используете Name для создания пространства имен, сгенерированный хэш добавляется к HttpName для различения двух пространств имен.

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

Имя службы, которое вы указали при регистрации экземпляра.

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

Максимальное количество экземпляров, которое Cloud Map должен вернуть в ответе на запрос DiscoverInstances. Если вы не укажете значение для MaxResults, Cloud Map вернет до 100 экземпляров.

--query-parameters (словарь)

Фильтры для ограничения результатов на основе пользовательских атрибутов экземпляра (например, {version=v1, az=1a}). Возвращаются только экземпляры, которые соответствуют всем указанным парам ключ-значение.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--optional-parameters (словарь)

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

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--health-status (строка)

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

HEALTHY

Возвращает работоспособные экземпляры.

UNHEALTHY

Возвращает неработоспособные экземпляры.

ALL

Возвращает все экземпляры.

HEALTHY_OR_ELSE_ALL

Возвращает работоспособные экземпляры, если таковые имеются. В противном случае возвращает все экземпляры. Это также называется отказоустойчивостью.

Возможные значения:

  • HEALTHY
  • UNHEALTHY
  • ALL
  • HEALTHY_OR_ELSE_ALL

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

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

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

aws servicediscovery discover-instances \
    --namespace-name example.com \
    --service-name myservice \
    --max-results 10 \
    --health-status ALL

Вывод:

{
    "Instances": [
        {
            "InstanceId": "myservice-53",
            "NamespaceName": "example.com",
            "ServiceName": "myservice",
            "HealthStatus": "UNKNOWN",
            "Attributes": {
                "AWS_INSTANCE_IPV4": "172.2.1.3",
                "AWS_INSTANCE_PORT": "808"
            }
        }
    ]
}

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

Вывод

Instances -> (список)

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

(структура)

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

InstanceId -> (строка)

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

NamespaceName -> (строка)

Имя пространства имен. Оно находится в члене HttpProperties члена Properties пространства имен.

ServiceName -> (строка)

Имя службы, которое вы указали при регистрации экземпляра.

HealthStatus -> (строка)

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

Attributes -> (словарь)

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

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

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

InstancesRevision -> (длинное целое число)

Увеличивающаяся версия, связанная со списком экземпляров в ответе. Если экземпляр зарегистрирован или снят с регистрации, InstancesRevision обновляется. Обновления статуса работоспособности не обновляют InstancesRevision.

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

Spec-Zone.ru

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