Spec-Zone.ru › AWS CLI v2

[ aws . servicediscovery ]

list-services

Описание

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

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

list-services — это операция с разбивкой на страницы. Может быть выполнено несколько вызовов API для получения всего набора данных результатов. Вы можете отключить разбиение на страницы, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с разбивкой на страницы, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Services

Синопсис

  list-services
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--filters (list)

Сложный тип, содержащий спецификации пространств имен, для которых вы хотите перечислить сервисы.

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

(структура)

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

Name -> (string)

Specify NAMESPACE_ID .

Values -> (list)

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

(string)

Condition -> (string)

Оператор, который вы хотите использовать для определения того, возвращается ли сервис ListServices. Допустимые значения для Condition включают следующее:

  • EQ: When you specify EQ, specify one namespace ID for Values. EQ is the default condition and can be omitted.

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

Name=string,Values=string,string,Condition=string ...

Синтаксис JSON:

[
  {
    "Name": "NAMESPACE_ID",
    "Values": ["string", ...],
    "Condition": "EQ"|"IN"|"BETWEEN"|"BEGINS_WITH"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

Токен для указания места начала разбивки на страницы. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Разбиение на страницы в Руководстве пользователя интерфейса командной строки AWS.

--page-size (integer)

Размер каждой страницы для получения при вызове сервиса AWS. Это не влияет на количество элементов, возвращаемых в выходных данных команды. Установка меньшего размера страницы приводит к большему количеству вызовов сервиса AWS, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов сервиса AWS.

Примеры использования см. в разделе Разбиение на страницы в Руководстве пользователя интерфейса командной строки AWS.

--max-items (integer)

Общее количество элементов, которые необходимо вернуть в выходных данных команды. Если общее количество доступных элементов больше указанного значения, в выходных данных команды предоставляется NextToken. Чтобы возобновить разбиение на страницы, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Разбиение на страницы в Руководстве пользователя интерфейса командной строки AWS.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Глобальные параметры

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

Для списка сервисов

Следующий пример list-services выводит список сервисов.

aws servicediscovery list-services

Вывод:

{
    "Services": [
        {
            "Id": "srv-p5zdwlg5uvvzjita",
            "Arn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita",
            "Name": "myservice",
            "DnsConfig": {
                "RoutingPolicy": "MULTIVALUE",
                "DnsRecords": [
                    {
                        "Type": "A",
                        "TTL": 60
                    }
                ]
            },
            "CreateDate": 1587081768.334
        }
    ]
}

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

Вывод

Services -> (list)

Массив, содержащий один объект ServiceSummary для каждого сервиса, который соответствует указанным критериям фильтрации.

(структура)

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

Id -> (string)

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

Arn -> (string)

Имя ресурса Amazon (ARN), которое Cloud Map присваивает службе при ее создании.

Name -> (string)

Имя службы.

Type -> (string)

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

DNS_HTTP

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

HTTP

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

DNS

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

Description -> (string)

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

InstanceCount -> (integer)

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

DnsConfig -> (structure)

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

NamespaceId -> (string)

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

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

RoutingPolicy -> (string)

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

Примечание

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

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

MULTIVALUE

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

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

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

Дополнительные сведения о политике маршрутизации нескольких значений см. в разделе Multivalue Answer Routing в Руководстве разработчика Route 53 .

WEIGHTED

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

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

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

Дополнительные сведения о политике взвешенной маршрутизации см. в разделе Weighted Routing в Руководстве разработчика Route 53 .

DnsRecords -> (list)

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

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

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

(structure)

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

Type -> (string)

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

  • Вы указываете доменное имя, на которое вы хотите перенаправить трафик, при регистрации экземпляра. Дополнительные сведения см. в разделе Attributes в разделе 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 -> (long)

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

Примечание

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

HealthCheckConfig -> (structure)

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

Type -> (string)

Тип проверки работоспособности, которую вы хотите создать, который указывает, как 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 -> (string)

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

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

FailureThreshold -> (integer)

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

HealthCheckCustomConfig -> (structure)

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

  • Вы не можете использовать проверку работоспособности, определенную HealthCheckConfig, потому что ресурс недоступен через Интернет. Например, вы можете использовать пользовательскую проверку работоспособности, когда экземпляр находится в Amazon VPC. (Чтобы проверить работоспособность ресурсов в VPC, средство проверки работоспособности также должно находиться в VPC.)
  • Вы хотите использовать стороннюю программу проверки работоспособности независимо от того, где находятся ваши ресурсы.

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

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

FailureThreshold -> (integer)

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

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

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

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

CreateDate -> (timestamp)

Дата и время создания сервиса.

NextToken -> (string)

Если ответ содержит NextToken, отправьте еще один ListServices запрос, чтобы получить следующую группу результатов. Укажите значение NextToken из предыдущего ответа в следующем запросе.

Примечание

Cloud Map получает MaxResults сервисов, а затем фильтрует их на основе указанных критериев. Вполне возможно, что ни один из сервисов в первых MaxResults сервисах не соответствует указанным критериям, но что последующие группы MaxResults сервисов содержат сервисы, соответствующие критериям.

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

Spec-Zone.ru

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