Spec-Zone.ru › AWS CLI v2

[ aws . storagegateway ]

describe-tape-archives

Описание

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

Если конкретный TapeARN не указан, Storage Gateway возвращает описание всех виртуальных лент, найденных в VTS, связанном с вашей учетной записью.

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

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

Синтаксис

  describe-tape-archives
[--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 Names (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.

Вывод

TapeArchives -> (список)

Массив объектов виртуальных лент в виртуальном стеллаже лент (VTS). Описание включает Amazon Resource Name (ARN) виртуальных лент. Возвращаемая информация включает Amazon Resource Names (ARN) лент, размер лент, состояние лент, прогресс описания и штрих-код ленты.

(структура)

Представляет виртуальную ленту, архивированную в виртуальном стеллаже лент (VTS).

TapeARN -> (строка)

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

TapeBarcode -> (строка)

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

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

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

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

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

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

Время завершения архивации виртуальной ленты.

Формат метки времени по умолчанию - ISO8601 расширенный YYYY-MM-DD’T’HH:MM:SS’Z’.

RetrievedTo -> (строка)

Amazon Resource Name (ARN) шлюза лент, к которому извлекается виртуальная лента.

Виртуальная лента извлекается из виртуального стеллажа лент (VTS).

TapeStatus -> (строка)

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

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

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

Примечание

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

KMSKey -> (строка)

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

PoolId -> (строка)

Идентификатор пула, который использовался для архивации ленты. Ленты в этом пуле архивируются в хранилище Amazon S3, которое связано с пулом.

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

Устанавливается в значение true, если архивированная лента хранится как лента с одноразовым записью и многократным чтением (WORM).

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

Если архивированная лента подлежит блокировке сохранения, дата начала сохранения архивированной ленты.

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

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

Формат метки времени по умолчанию - ISO8601 расширенный YYYY-MM-DD’T’HH:MM:SS’Z’.

Marker -> (строка)

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

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

Spec-Zone.ru

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