Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

register-instance

Описание

Создаёт или обновляет один или несколько записей и, необязательно, создаёт проверку работоспособности на основе настроек в указанной службе. При отправке запроса RegisterInstance происходит следующее:

  • Для каждой записи DNS, которую вы определяете в службе, указанной в ServiceId, создаётся или обновляется запись в зоне размещения, связанной с соответствующим пространством имён.
  • Если служба включает HealthCheckConfig, создаётся проверка работоспособности на основе настроек конфигурации проверки работоспособности.
  • Проверка работоспособности, если она есть, ассоциируется с каждой из новых или обновлённых записей.

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

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

Для получения дополнительной информации см. CreateService.

Когда Cloud Map получает запрос DNS для указанного имени DNS, он возвращает соответствующее значение:

  • Если проверка работоспособности работоспособна: возвращает все записи
  • Если проверка работоспособности не работоспособна: возвращает соответствующее значение для последнего работоспособного экземпляра
  • Если вы не указали конфигурацию проверки работоспособности: возвращает все записи

О текущем лимите на количество экземпляров, которые можно зарегистрировать, используя одно и то же пространство имён и ту же службу, см. Квоты Cloud Map в руководстве для разработчиков Cloud Map.

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

Синтаксис

  register-instance
--service-id <value>
--instance-id <value>
[--creator-request-id <value>]
--attributes <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 (строка)

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

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

Примечание

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

Примечание

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

--creator-request-id (строка)

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

--attributes (карта)

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

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

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

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

Ниже приведены поддерживаемые ключи атрибутов.

AWS_ALIAS_DNS_NAME

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

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

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

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

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

  • Cloud Map в настоящее время не поддерживает создание записей алиасов, которые перенаправляют трафик на ресурсы Amazon Web Services, кроме балансировщиков нагрузки Elastic Load Balancing.

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

  • AWS_ALIAS_DNS_NAME не поддерживается в регионах GovCloud (US).

    AWS_EC2_INSTANCE_ID

Только пространства имён HTTP. Идентификатор экземпляра Amazon EC2 для экземпляра. Если атрибут AWS_EC2_INSTANCE_ID указан, то единственный другой атрибут, который можно указать, это AWS_INIT_HEALTH_STATUS. Когда атрибут 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).

Это значение обязательно, если служба, указанная в 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 при создании службы.

Пользовательские атрибуты

Вы можете добавить до 30 пользовательских атрибутов. Для каждой пары ключ-значение максимальная длина имени атрибута составляет 255 символов, а максимальная длина значения атрибута составляет 1024 символа. Общий размер всех предоставленных атрибутов (сумма всех ключей и значений) не должен превышать 5000 символов.

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

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

Упрощённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

Для регистрации экземпляра службы

Следующий register-instance пример регистрирует экземпляр службы.

aws servicediscovery register-instance \
    --service-id srv-p5zdwlg5uvvzjita \
    --instance-id myservice-53 \
    --attributes=AWS_INSTANCE_IPV4=172.2.1.3,AWS_INSTANCE_PORT=808

Вывод:

{
    "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7"
}

Для подтверждения успешности операции можно выполнить get-operation. Дополнительную информацию см. в get-operation.

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

Вывод

OperationId -> (строка)

Значение, которое можно использовать для определения того, успешно ли завершился запрос. Чтобы узнать статус операции, см. GetOperation.

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

Spec-Zone.ru

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