[ aws . storagegateway ]
list-file-shares
Описание
Получает список сетевых хранилищ для определённого S3 File Gateway или список сетевых хранилищ, принадлежащих учетной записи Amazon Web Services, вызвавшей эту операцию. Данная операция поддерживается только для S3 File Gateway.
См. также: Документация API AWS
list-file-shares является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой аргумент --query должен извлекать данные из результатов следующих выражений запросов: FileShareInfoList
Синтаксис
list-file-shares
[--gateway-arn <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]
Параметры
--gateway-arn (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной обработки. Это NextToken из ранее обрезанного ответа.
Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.
--page-size (целое число)
Размер каждой страницы для вызова службы AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.
Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.
--max-items (целое число)
Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.
--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 (булево)
Автоматически запрашивать параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода командной строки.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. в руководстве «Начало работы» в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.
Для отображения сетевых хранилищ
Следующий command-name пример отображает доступные сетевые хранилища в вашей учетной записи AWS.
aws storagegateway list-file-shares \
--gateway-arn arn:aws:storagegateway:us-east-1:209870788375:gateway/sgw-FB02E292
Вывод:
{
"FileShareInfoList": [
{
"FileShareType": "NFS",
"FileShareARN": "arn:aws:storagegateway:us-east-1:111122223333:share/share-2FA12345",
"FileShareId": "share-2FA12345",
"FileShareStatus": "AVAILABLE",
"GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-FB0AAAAA"
}
],
"Marker": null
}
Дополнительную информацию см. в разделе ListFileShares в Справочнике по API-интерфейсам службы AWS Storage Gateway.
Вывод
Маркер -> (строка)
Marker, ответ возвращает это значение в этом поле.СледующийМаркер -> (строка)
NextMarker в качестве значения для Marker, чтобы получить следующий набор сетевых хранилищ.FileShareInfoList -> (список)
Массив информации о сетевых хранилищах S3 File Gateway.
(структура)
Описание сетевого хранилища. Поддерживается только S3 File Gateway.
FileShareType -> (строка)
FileShareARN -> (строка)
FileShareId -> (строка)
FileShareStatus -> (строка)
Состояние сетевого хранилища.
Допустимые значения: CREATING | UPDATING | AVAILABLE | DELETING
GatewayARN -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.