Spec-Zone.ru › AWS CLI v2

[ aws . storagegateway ]

list-tapes

Описание

Отображает виртуальные ленты в вашей виртуальной ленточной библиотеке (VTL) и вашем виртуальном ленточном стеллаже (VTS). Вы указываете ленты для отображения, указав один или несколько ARN лент Amazon. Если вы не указываете ARN ленты, операция отображает все виртуальные ленты в вашей VTL и VTS.

Эта операция поддерживает постраничную навигацию. По умолчанию операция возвращает не более 100 лент. Вы можете дополнительно указать параметр Limit в теле, чтобы ограничить количество лент в ответе. Если количество лент, возвращенных в ответе, ограничено, ответ включает элемент Marker, который вы можете использовать в последующем запросе для получения следующей группы лент. Данная операция поддерживается только для типа шлюза ленты.

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

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

Синтаксис

  list-tapes
[--tape-arns <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]

Параметры

--tape-arns (список)

Amazon Resource Name (ARN) каждой из лент, которые вы хотите отобразить. Если вы не указываете ARN ленты, в ответе отображаются все ленты в вашей VTL и VTS.

(строка)

Синтаксис:

"string" "string" ...

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

Вывод

TapeInfos -> (список)

Массив объектов TapeInfo, где каждый объект описывает одну ленту. Если в библиотеке лент или VTS нет лент, то TapeInfos — это пустой массив.

(структура)

Описывает виртуальную ленту.

TapeARN -> (строка)

Amazon Resource Name (ARN) виртуальной ленты.

TapeBarcode -> (строка)

Штрих-код, идентифицирующий конкретную виртуальную ленту.

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

Размер виртуальной ленты в байтах.

TapeStatus -> (строка)

Статус ленты.

GatewayARN -> (строка)

Amazon Resource Name (ARN) шлюза. Используйте операцию ListGateways для получения списка шлюзов для вашей учетной записи и региона Amazon Web Services.

PoolId -> (строка)

Идентификатор пула, к которому вы хотите добавить свою ленту для архивирования. Лента в этом пуле архивируется в хранилище S3, связанном с пулом. Когда вы используете приложение резервного копирования для извлечения ленты, лента архивируется непосредственно в хранилище (S3 Glacier или S3 Glacier Deep Archive), соответствующее пулу.

RetentionStartDate -> (временная метка)

Дата, когда лента стала объектом блокировки хранения лент.

PoolEntryDate -> (временная метка)

Дата, когда лента вошла в пользовательский пул лент с включенной блокировкой хранения лент.

Marker -> (строка)

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

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

Spec-Zone.ru

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