Spec-Zone.ru › AWS CLI v2

[ aws . codestar-connections ]

list-hosts

Описание

Выводит список хостов, связанных с вашей учётной записью.

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

Синтаксис

  list-hosts
[--max-results <value>]
[--next-token <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]

Параметры

--max-results (целое число)

Максимальное количество результатов, возвращаемых за один вызов. Чтобы получить оставшиеся результаты, сделайте ещё один вызов с возвращённым значением nextToken.

--next-token (строка)

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

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

Чтобы вывести список хостов

Следующий list-hosts пример извлекает список всех хостов в вашей учётной записи.

aws codestar-connections list-hosts

Вывод:

{
    "Hosts": [
        {
            "Name": "My-Host",
            "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605",
            "ProviderType": "GitHubEnterpriseServer",
            "ProviderEndpoint": "https://my-instance.test.dev",
            "Status": "AVAILABLE"
        }
    ]
}

Дополнительную информацию см. в разделе Список хостов (CLI) в Руководстве пользователя консоли Developer Tools.

Вывод

Хосты -> (список)

Список хостов и подробной информации о каждом хосте, такой как статус, конечная точка и тип провайдера.

(структура)

Ресурс, представляющий инфраструктуру, где установлен провайдер сторонней компании. Хост используется при создании подключений к установленным типам провайдеров сторонних компаний, таким как GitHub Enterprise Server. Вы создаёте один хост для всех подключений к этому провайдеру.

Примечание

Хост, созданный через CLI или SDK, по умолчанию имеет статус ОЖИДАЕТСЯ. Вы можете изменить его статус на ДОСТУПНО, настроив хост в консоли.

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

Имя хоста.

HostArn -> (строка)

Amazon Resource Name (ARN) хоста.

ТипПровайдера -> (строка)

Имя установленного провайдера, который нужно связать с вашим подключением. Ресурс хоста представляет инфраструктуру, где установлен ваш тип провайдера. Допустимый тип провайдера - GitHub Enterprise Server.

КонечнаяТочкаПровайдера -> (строка)

Конечная точка инфраструктуры, где установлен ваш тип провайдера.

НастройкаVPC -> (структура)

Настройка VPC, предоставленная для хоста.

VpcId -> (строка)

ID Amazon VPC, подключённого к инфраструктуре, где установлен ваш тип провайдера.

SubnetIds -> (список)

ID подсети или подсетей, связанных с Amazon VPC, подключённым к инфраструктуре, где установлен ваш тип провайдера.

(строка)

SecurityGroupIds -> (список)

ID группы безопасности или групп безопасности, связанных с Amazon VPC, подключённым к инфраструктуре, где установлен ваш тип провайдера.

(строка)

TlsCertificate -> (строка)

Значение сертификата Transport Layer Security (TLS), связанного с инфраструктурой, где установлен ваш тип провайдера.

Статус -> (строка)

Статус хоста, такой как ОЖИДАЕТСЯ, ДОСТУПНО, УДАЛЯЕТСЯ_НАСТРОЙКА_VPC, ИНИЦИАЛИЗИРУЕТСЯ_НАСТРОЙКА_VPC и НЕ_УДАЛОСЬ_ИНИЦИАЛИЗИРОВАТЬ_НАСТРОЙКУ_VPC.

Сообщ.Статуса -> (строка)

Описание статуса хоста.

NextToken -> (строка)

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

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

Spec-Zone.ru

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