Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

update-service

Описание

Отправляет запрос для выполнения следующих операций:

  • Обновление параметра TTL для существующих DnsRecords конфигураций
  • Добавление, обновление или удаление HealthCheckConfig для указанной службы

Примечание

Вы не можете добавить, обновить или удалить HealthCheckCustomConfig конфигурацию.

Для общедоступных и частных пространств имён DNS обратите внимание на следующее:

  • Если вы опустите любые существующие DnsRecords или HealthCheckConfig конфигурации из запроса UpdateService, конфигурации удаляются из службы.
  • Если вы опустите существующую HealthCheckCustomConfig конфигурацию из запроса UpdateService, конфигурация не удаляется из службы.

При обновлении параметров службы Cloud Map также обновляет соответствующие параметры во всех записях и проверках работоспособности, созданных с помощью указанной службы.

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

Синтаксис

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

Параметры

--id (строка)

Идентификатор службы, которую вы хотите обновить.

--service (структура)

Сложный тип, содержащий новые параметры службы. Вы можете указать не более 30 атрибутов (пар ключ-значение).

Описание -> (строка)

Описание службы.

DnsConfig -> (структура)

Информация о записях DNS Route 53, которые вы хотите, чтобы Cloud Map создавал при регистрации экземпляра.

DnsRecords -> (список)

Массив, содержащий по одному DnsRecord объекту для каждой записи Route 53, которую вы хотите, чтобы Cloud Map создавал при регистрации экземпляра.

(структура)

Сложный тип, содержащий информацию о записях DNS Route 53, которые вы хотите, чтобы Cloud Map создавал при регистрации экземпляра.

Тип -> (строка)

Тип ресурса, который указывает тип значения, возвращаемого Route 53 в ответ на запросы DNS. Вы можете указать значения для Type в следующих комбинациях:

  • **A **
  • **AAAA **
  • **A ** и ** AAAA **
  • **SRV **
  • **CNAME **

Если вы хотите, чтобы Cloud Map создавал запись алиаса Route 53 при регистрации экземпляра, укажите A или AAAA для Type .

Другие параметры, такие как IP-адрес для записей A и AAAA, вы указываете при регистрации экземпляра. Дополнительную информацию см. в RegisterInstance .

Поддерживаются следующие значения:

A

Route 53 возвращает IP-адрес ресурса в формате IPv4, например 192.0.2.44.

AAAA

Route 53 возвращает IP-адрес ресурса в формате IPv6, например 2001:0db8:85a3:0000:0000:abcd:0001:2345.

CNAME

Route 53 возвращает доменное имя ресурса, например www.example.com. Обратите внимание на следующее:

  • Вы указываете доменное имя, на которое вы хотите направить трафик, при регистрации экземпляра. Дополнительную информацию см. в разделе Атрибуты в теме RegisterInstance .

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

  • Вы не можете указать одновременно CNAME для Type и параметры для HealthCheckConfig . В противном случае запрос завершится ошибкой InvalidInput .

    SRV

Route 53 возвращает значение для записи SRV. Значение для записи SRV использует следующие значения:

priority weight port service-hostname

Обратите внимание на следующее по поводу этих значений:

  • Значения priority и weight оба установлены в 1 и не могут быть изменены.
  • Значение port взято из значения, которое вы указываете для атрибута AWS_INSTANCE_PORT при отправке запроса RegisterInstance.
  • Значение service-hostname представляет собой конкатенацию следующих значений:
    • Значение, которое вы указываете для InstanceId при регистрации экземпляра.
    • Название службы.
    • Название пространства имён.

Например, если значение InstanceId равно test, имя службы равно backend, а имя пространства имён равно example.com, то значение service-hostname будет следующим:

test.backend.example.com

Если вы указываете параметры для записи SRV, обратите внимание на следующее:

  • Если вы указываете значения для AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6 или для обоих в запросе RegisterInstance, Cloud Map автоматически создаёт записи A и/или AAAA, которые имеют такое же имя, как значение service-hostname в записи SRV. Вы можете проигнорировать эти записи.
  • Если вы используете систему, которая требует определённого формата SRV, например HAProxy, см. элемент Name в документации по CreateService для получения информации о том, как указать правильный формат имени.

TTL -> (целое число)

Время в секундах, в течение которого DNS-серверы должны кэшировать параметры этой записи.

Примечание

Записи алиасов не включают TTL, так как Route 53 использует TTL для ресурса Amazon Web Services, на который запись алиаса направляет трафик. Если вы включаете атрибут AWS_ALIAS_DNS_NAME при отправке запроса RegisterInstance, значение TTL игнорируется. Всегда указывайте TTL для службы; вы можете использовать службу для регистрации экземпляров, которые создают либо записи алиасов, либо записи, не являющиеся алиасами.

HealthCheckConfig -> (структура)

Только для общедоступных пространств имён DNS и HTTP. Настройки для необязательной проверки работоспособности. Если вы указываете параметры проверки работоспособности, Cloud Map связывает проверку работоспособности с записями, которые вы указываете в DnsConfig.

Тип -> (строка)

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

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

Вы не можете изменить значение Type после создания проверки работоспособности.

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

  • HTTP : Route 53 пытается установить TCP-соединение. В случае успеха Route 53 отправляет HTTP-запрос и ждёт HTTP-код состояния 200 или выше и меньше 400.
  • HTTPS : Route 53 пытается установить TCP-соединение. В случае успеха Route 53 отправляет HTTPS-запрос и ждёт HTTP-код состояния 200 или выше и меньше 400.

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

Если вы указываете HTTPS в качестве значения для Type, конечная точка должна поддерживать TLS v1.0 или более позднюю версию.
  • TCP : Route 53 пытается установить TCP-соединение. Если вы указываете TCP для Type, не указывайте значение для ResourcePath.

Дополнительную информацию см. в разделе Как Route 53 определяет, является ли конечная точка работоспособной в Руководстве разработчика Route 53.

ResourcePath -> (строка)

Путь, который вы хотите, чтобы Route 53 запросил при выполнении проверок работоспособности. Путь может иметь любое значение, которое ваша конечная точка возвращает в формате HTTP-кода состояния 2xx или 3xx, когда конечная точка работоспособна. Пример файла - /docs/route53-health-check.html. Route 53 автоматически добавляет DNS-имя для службы. Если вы не указываете значение для ResourcePath, значение по умолчанию - /.

Если вы указываете TCP для Type, не указывайте значение для ResourcePath.

FailureThreshold -> (целое число)

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

Синтаксис JSON:

{
  "Description": "string",
  "DnsConfig": {
    "DnsRecords": [
      {
        "Type": "SRV"|"A"|"AAAA"|"CNAME",
        "TTL": long
      }
      ...
    ]
  },
  "HealthCheckConfig": {
    "Type": "HTTP"|"HTTPS"|"TCP",
    "ResourcePath": "string",
    "FailureThreshold": integer
  }
}

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

Для обновления сервиса

Следующий update-service пример обновляет сервис для обновления параметров DnsConfig и HealthCheckConfig.

aws servicediscovery update-service \
    --id srv-e4anhexample0004 \
    --service "DnsConfig={DnsRecords=[{"Type"="A","TTL"=60}]},HealthCheckConfig={"Type"="HTTP","ResourcePath"="/","FailureThreshold"="2"}"

Вывод:

{
    "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"
}

Чтобы подтвердить успешность операции, вы можете запустить get-operation.

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

Вывод

OperationId -> (string)

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

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

Spec-Zone.ru

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