Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

get-instance

Описание

Получает информацию об указанном экземпляре.

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

Синтаксис

  get-instance
--service-id <value>
--instance-id <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]

Параметры

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

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

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

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

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

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

Следующий get-instance пример получает атрибуты сервиса.

aws servicediscovery get-instance \
    --service-id srv-e4anhexample0004
    --instance-id i-abcd1234

Вывод:

{
    "Instances": {
        "Id": "arn:aws:servicediscovery:us-west-2:111122223333;:service/srv-e4anhexample0004",
        "Attributes": {
            "AWS_INSTANCE_IPV4": "192.0.2.44",
            "AWS_INSTANCE_PORT": "80",
            "color": "green",
            "region": "us-west-2",
            "stage": "beta"
        }
    }
}

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

Вывод

Экземпляр -> (структура)

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

Id -> (строка)

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

  • Если сервис, указанный в ServiceId, содержит настройки для записи SRV, значение InstanceId автоматически включается в значение записи SRV. Дополнительную информацию см. в разделе DnsRecord > Тип.
  • Вы можете использовать это значение для обновления существующего экземпляра.
  • Для регистрации нового экземпляра необходимо указать уникальное значение среди экземпляров, которые вы регистрируете, используя тот же сервис.
  • Если вы указываете существующий InstanceId и ServiceId, Cloud Map обновляет существующие записи DNS. Если также существует существующая проверка работоспособности, Cloud Map удаляет старую проверку работоспособности и создает новую.

Примечание

Проверка работоспособности не удаляется немедленно, поэтому она по-прежнему будет отображаться некоторое время, если вы отправляете, например, запрос ListHealthChecks.

CreatorRequestId -> (строка)

Уникальная строка, идентифицирующая запрос и позволяющая повторно выполнить не удавшиеся RegisterInstance запросы, не рискуя выполнить операцию дважды. Вы должны использовать уникальную строку CreatorRequestId каждый раз, когда отправляете запрос RegisterInstance, если вы регистрируете дополнительные экземпляры для того же пространства имен и сервиса. CreatorRequestId может быть любой уникальной строкой (например, отметка времени).

Attributes -> (массив)

Массив строк, содержащий следующую информацию для сервиса, который вы указываете в ServiceId:

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

Примечание

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

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

AWS_ALIAS_DNS_NAME

Если вы хотите, чтобы Cloud Map создал запись алиаса Route 53, которая перенаправляет трафик на балансировщик нагрузки Elastic Load Balancing, укажите имя DNS, связанное с балансировщиком нагрузки. Сведения о том, как получить имя DNS, см. в разделе AliasTarget->DNSName в Справочном руководстве по API Route 53.

Обратите внимание на следующее:

  • Настройка сервиса, указанного в ServiceId, должна включать настройки для записи A, записи AAAA или обоих типов.

  • В сервисе, указанном в ServiceId, значение RoutingPolicy должно быть WEIGHTED.

  • Если сервис, указанный в ServiceId, включает настройки HealthCheckConfig, Cloud Map создает проверку работоспособности, но не связывает ее с записью алиаса.

  • Автоматическое именование в настоящее время не поддерживает создание записей алиаса, которые перенаправляют трафик на ресурсы Amazon Web Services, кроме балансировщиков нагрузки ELB.

  • Если вы указываете значение для AWS_ALIAS_DNS_NAME, не указывайте значения для каких-либо атрибутов AWS_INSTANCE.

    AWS_EC2_INSTANCE_ID

Только пространства имен HTTP. Идентификатор экземпляра Amazon EC2 для экземпляра. Атрибут 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).

Это значение обязательно, если сервис, указанный в ServiceId, включает настройки для записи CNAME.

AWS_INSTANCE_IPV4

Если конфигурация сервиса включает запись A, IPv4-адрес, который вы хотите, чтобы Route 53 возвращал в ответ на запросы DNS (например, 192.0.2.44).

Это значение обязательно, если сервис, указанный в ServiceId, включает настройки для записи A. Если сервис включает настройки для записи SRV, вы должны указать значение для AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6 или обоих.

AWS_INSTANCE_IPV6

Если конфигурация сервиса включает запись AAAA, IPv6-адрес, который вы хотите, чтобы Route 53 возвращал в ответ на запросы DNS (например, 2001:0db8:85a3:0000:0000:abcd:0001:2345).

Это значение обязательно, если сервис, указанный в ServiceId, включает настройки для записи AAAA. Если сервис включает настройки для записи SRV, вы должны указать значение для AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6 или обоих.

AWS_INSTANCE_PORT

Если сервис включает запись SRV, значение, которое вы хотите, чтобы Route 53 возвращал для порта.

Если сервис включает HealthCheckConfig, порт на конечной точке, на который Route 53 должен отправлять запросы.

Это значение обязательно, если вы указали настройки для записи SRV или проверки работоспособности Route 53 при создании сервиса.

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

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

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

Spec-Zone.ru

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