Spec-Zone.ru › AWS CLI v2

[ aws . storagegateway ]

describe-tapes

Описание

Возвращает описание виртуальных лент, соответствующих указанным именам ресурсов Amazon (ARN). Если TapeARN не указано, возвращает описание виртуальных лент, связанных с указанным шлюзом. Данная операция поддерживается только для типа шлюза лент.

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

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

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

Синтаксис

  describe-tapes
--gateway-arn <value>
[--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]

Параметры

--gateway-arn (строка)

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

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

Указывает одно или несколько уникальных имён ресурсов Amazon (ARN), представляющих виртуальные ленты, описание которых требуется получить. Если этот параметр не указан, шлюз лент возвращает описание всех виртуальных лент, связанных с указанным шлюзом.

(строка)

Синтаксис:

"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 (логическое значение)

Включить отладочную регистрацию.

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

Вывод

Ленты -> (список)

Массив описаний виртуальных лент.

(структура)

Описывает объект виртуальной ленты.

TapeARN -> (строка)

Имя ресурса Amazon (ARN) виртуальной ленты.

TapeBarcode -> (строка)

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

TapeCreatedDate -> (метка времени)

Дата создания виртуальной ленты.

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

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

TapeStatus -> (строка)

Текущее состояние виртуальной ленты.

VTLDevice -> (строка)

Устройство виртуальной библиотеки лент (VTL), с которым связана виртуальная лента.

Progress -> (дробное число)

Для архивирования виртуальных лент указывает, сколько данных осталось загрузить перед завершением архивирования.

Диапазон: от 0 (не начато) до 100 (завершено).

TapeUsedInBytes -> (длинное целое число)

Размер данных, хранящихся на виртуальной ленте, в байтах.

Примечание

Это значение недоступно для лент, созданных до 13 мая 2015 года.

KMSKey -> (строка)

Необязательно. Имя ресурса Amazon (ARN) симметричного ключа основного мастера (CMK), используемого для шифрования на стороне сервера Amazon S3. Storage Gateway не поддерживает асимметричные CMK. Это значение должно быть установлено, если KMSEncrypted — это true, или если EncryptionType — это SseKms или DsseKms.

PoolId -> (строка)

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

Worm -> (логическое значение)

Если лента архивируется как «один раз запись — многократное чтение» (WORM), это значение — true.

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

Дата первого архивирования ленты с включённой блокировкой хранения лент.

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

Дата ввода ленты в пользовательский пул лент.

Marker -> (строка)

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

Если ответ не содержит маркера, то больше результатов для извлечения нет.

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

Spec-Zone.ru

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