Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

get-service

Описание

Получает настройки указанной службы.

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

Синтаксис

  get-service
--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]

Параметры

--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
  • текст
  • таблица
  • 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-service пример получает настройки указанной службы.

aws servicediscovery get-service \
    --id srv-e4anhexample0004

Вывод:

{
    "Service": {
        "Id": "srv-e4anhexample0004",
        "Arn": "arn:aws:servicediscovery:us-west-2:111122223333:service/srv-e4anhexample0004",
        "Name": "test-service",
        "NamespaceId": "ns-e4anhexample0004",
        "DnsConfig": {},
        "Type": "HTTP",
        "CreateDate": "2025-02-24T10:59:02.905000-06:00",
        "CreatorRequestId": "3f50f9d9-b14c-482e-a556-d2a22fe6106d"
    }
}

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

Вывод

Служба -> (структура)

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

Id -> (строка)

Идентификатор, присвоенный службе Cloud Map при её создании.

Arn -> (строка)

Amazon Resource Name (ARN), присвоенный службе Cloud Map при её создании.

Имя -> (строка)

Имя службы.

NamespaceId -> (строка)

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

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

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

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

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

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

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

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

Тип записей службы можно изменить только удалив службу и повторно создав её с новой Dnsconfig .

NamespaceId -> (строка)

Используйте NamespaceId в `Служба <https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html>`__ вместо него.

Идентификатор пространства имён для использования в конфигурации DNS.

RoutingPolicy -> (строка)

Политика маршрутизации, которую следует применять ко всем записям DNS Route 53, которые Cloud Map создаёт при регистрации экземпляра и указании этой службы.

Примечание

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

Можно указать следующие значения:

MULTIVALUE

Если вы определили проверку работоспособности для службы и проверка работоспособности прошла успешно, Route 53 возвращает соответствующее значение для до восьми экземпляров.

Например, предположим, что служба включает конфигурации для одной A записи и проверки работоспособности. Вы используете службу для регистрации 10 экземпляров. Route 53 отвечает на запросы DNS с IP-адресами до восьми работоспособных экземпляров. Если работоспособных экземпляров меньше восьми, Route 53 отвечает на каждый запрос DNS с IP-адресами всех работоспособных экземпляров.

Если вы не определили проверку работоспособности для службы, Route 53 предполагает, что все экземпляры работоспособны, и возвращает значения для до восьми экземпляров.

Дополнительную информацию о политике маршрутизации multivalue см. в разделе Маршрутизация ответов multivalue в руководстве разработчика Route 53.

WEIGHTED

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

Например, предположим, что служба включает конфигурации для одной A записи и проверки работоспособности. Вы используете службу для регистрации 10 экземпляров. Route 53 отвечает на запросы DNS с IP-адресом случайным образом выбранного экземпляра из числа работоспособных экземпляров. Если ни один экземпляр не работоспособен, Route 53 отвечает на запросы DNS так, как будто все экземпляры работоспособны.

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

Дополнительную информацию о политике маршрутизации weighted см. в разделе Маршрутизация weighted в руководстве разработчика Route 53.

DnsRecords -> (список)

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

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

Тип записи службы, указанный в DnsRecord объекте, не может быть обновлён. Чтобы изменить тип записи, необходимо удалить службу и повторно создать её с новой DnsConfig .

(структура)

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

Type -> (строка)

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

Type -> (строка)

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

DNS_HTTP

Экземпляры службы могут быть обнаружены с помощью запросов DNS или операции API DiscoverInstances .

HTTP

Экземпляры службы могут быть обнаружены только с помощью операции API DiscoverInstances .

DNS

Зарезервировано.

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

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

Сведения о стоимости проверок работоспособности см. в Amazon Route 53 Pricing .

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

Тип проверки работоспособности, который вы хотите создать, указывающий, как 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 определяет работоспособность конечной точки в Руководстве разработчика Route 53 .

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

Сложный тип, содержащий сведения об необязательной кастомной проверке работоспособности.

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

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

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

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

Этот параметр больше не поддерживается и всегда устанавливается в 1. Cloud Map ожидает приблизительно 30 секунд после получения запроса UpdateInstanceCustomHealthStatus, прежде чем изменить состояние экземпляра службы.

Количество 30-секундных интервалов, которые вы хотите, чтобы Cloud Map ожидал после получения запроса UpdateInstanceCustomHealthStatus, прежде чем изменить статус работоспособности экземпляра службы.

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

CreateDate -> (метка времени)

Дата и время создания службы в формате Unix и в координированном универсальном времени (UTC). Значение CreateDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, в 00:11:30.087.

CreatorRequestId -> (строка)

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

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

Spec-Zone.ru

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