Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

list-servers

Описание

Отображает серверы протокола передачи файлов, связанные с вашей учетной записью Amazon Web Services.

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

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

Синтаксис

  list-servers
[--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]

Параметры

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания начальной точки постраничной навигации. Это NextToken из предыдущего усеченного ответа.

Примеры использования см. в разделе «Постраничная навигация» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе «Постраничная навигация» в Руководстве пользователя AWS Command Line Interface.

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

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

Примеры использования см. в разделе «Постраничная навигация» в Руководстве пользователя AWS Command Line Interface.

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

Вывод

NextToken -> (строка)

Когда вы можете получить дополнительные результаты из операции ListServers, в выводе возвращается параметр NextToken. В последующей команде вы можете передать параметр NextToken для продолжения перечисления дополнительных серверов.

Servers -> (список)

Массив серверов, которые были перечислены.

(структура)

Возвращает свойства сервера протокола передачи файлов, который был указан.

Arn -> (строка)

Указывает уникальный Amazon Resource Name (ARN) для сервера, который должен быть перечислен.

Domain -> (строка)

Указывает домен системы хранения, используемой для передачи файлов. Доступны два домена: Amazon Simple Storage Service (Amazon S3) и Amazon Elastic File System (Amazon EFS). Значение по умолчанию — S3.

IdentityProviderType -> (строка)

Режим аутентификации для сервера. Значение по умолчанию — SERVICE_MANAGED, что позволяет хранить и получать доступ к учетным данным пользователя в службе Transfer Family.

Используйте AWS_DIRECTORY_SERVICE, чтобы предоставить доступ к группам Active Directory в службе каталогов Microsoft Active Directory или Microsoft Active Directory в вашей локальной среде или в Amazon Web Services с помощью AD Connector. Этот параметр также требует предоставления идентификатора каталога с использованием параметра IdentityProviderDetails.

Используйте значение API_GATEWAY, чтобы интегрироваться с поставщиком идентификации по вашему выбору. Настройка API_GATEWAY требует предоставления URL-адреса конечной точки Amazon API Gateway для вызова аутентификации с использованием параметра IdentityProviderDetails.

Используйте значение AWS_LAMBDA, чтобы напрямую использовать функцию Lambda в качестве вашего поставщика идентификации. Если вы выберете это значение, вам необходимо указать ARN для функции Lambda в параметре Function для типа данных IdentityProviderDetails.

EndpointType -> (строка)

Указывает тип VPC-точки входа, к которой подключен ваш сервер. Если ваш сервер подключен к VPC-точке входа, к вашему серверу нет доступа через общедоступный интернет.

LoggingRole -> (строка)

Amazon Resource Name (ARN) роли Identity and Access Management (IAM), которая позволяет серверу включать регистрация в Amazon CloudWatch для событий Amazon S3 или Amazon EFS. При установке вы можете просматривать действия пользователей в своих логах CloudWatch.

ServerId -> (строка)

Указывает уникальный системный идентификатор для перечисленных серверов.

State -> (строка)

Состояние описанного сервера. Значение ONLINE указывает, что сервер может принимать задания и передавать файлы. Значение State, равное OFFLINE, означает, что сервер не может выполнять операции передачи файлов.

Состояния STARTING и STOPPING указывают, что сервер находится в промежуточном состоянии, либо не может полностью отвечать, либо не полностью офлайн. Значения START_FAILED или STOP_FAILED могут указывать на ошибку.

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

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

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

Spec-Zone.ru

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