Spec-Zone.ru › AWS CLI v2

[ aws . fsx ]

describe-file-caches

Описание

Возвращает описание конкретного ресурса Amazon File Cache, если для этого кэша предоставлено значение FileCacheIds. В противном случае возвращает описания всех кэшей, принадлежащих вашей учетной записи Amazon Web Services в регионе Amazon Web Services конечной точки, к которой вы обращаетесь.

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

Эта операция используется в итерационном процессе для получения списка описаний ваших кэшей. DescribeFileCaches вызывается в первую очередь без значения NextToken. Затем операция продолжает вызываться с параметром NextToken, установленным в значение последнего значения NextToken, пока ответ не содержит NextToken.

При использовании этой операции учтите следующее:

  • Реализация может вернуть меньше, чем MaxResults описаний кэшей, но при этом включить значение NextToken.
  • Порядок кэшей, возвращаемых в ответе одного вызова DescribeFileCaches, и порядок кэшей, возвращаемых в ответах итерации мультикалла, не определён.

См. также: AWS API Documentation

Синтаксис

  describe-file-caches
[--file-cache-ids <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--file-cache-ids (список)

Идентификаторы кэшей, описания которых вы хотите получить (строка).

(строка)

Синтаксис:

"string" "string" ...

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

Максимальное количество ресурсов, возвращаемых в ответе. Это значение должно быть целым числом, большим нуля.

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

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

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

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Использовать определённый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--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 для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросить параметры входных данных CLI.

Вывод

FileCaches -> (список)

Объект ответа для операции DescribeFileCaches.

(структура)

Описание конкретного ресурса Amazon File Cache, который является объектом ответа операции DescribeFileCaches.

OwnerId -> (строка)

Идентификатор учетной записи Amazon Web Services. Этот идентификатор — 12-значное число, используемое для построения имен ресурсов Amazon Resource Names (ARN) для ресурсов.

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

Время создания ресурса в секундах (с 1970-01-01T00:00:00Z), также известное как время Unix.

FileCacheId -> (строка)

Сгенерированный системой уникальный идентификатор кэша.

FileCacheType -> (строка)

Тип кэша, который должен быть LUSTRE.

FileCacheTypeVersion -> (строка)

Версия Lustre кэша, которая должна быть 2.12.

Lifecycle -> (строка)

Статус жизненного цикла кэша. Возможные значения и их значения:

  • AVAILABLE - Кэш находится в работоспособном состоянии, доступен и готов к использованию.
  • CREATING - Создается новый кэш.
  • DELETING - Существующий кэш удаляется.
  • UPDATING - Кэш проходит обновление, инициированное пользователем.
  • FAILED - Существующий кэш претерпел необратимый сбой. При создании нового кэша он не смог быть создан.

FailureDetails -> (структура)

Структура, предоставляющая подробности о любых возникших ошибках.

Message -> (строка)

Сообщение, описывающее любые возникшие ошибки.

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

Емкость кэша в гигабайтах (GiB).

VpcId -> (строка)

Идентификатор вашей виртуальной частной сети (VPC). Дополнительную информацию см. в руководстве пользователя Amazon VPC, раздел «VPC и подсети».

SubnetIds -> (список)

Список идентификаторов подсетей, из которых будет доступен кэш. В вызове операции CreateFileCache можно указать только один идентификатор подсети.

(строка)

Идентификатор подсети. Подсеть — это диапазон IP-адресов в вашей виртуальной частной сети (VPC). Дополнительную информацию см. в руководстве пользователя Amazon VPC, раздел «VPC и подсети».

NetworkInterfaceIds -> (список)

Список идентификаторов сетевых интерфейсов.

(строка)

Идентификатор эластичного сетевого интерфейса. Эластичный сетевой интерфейс — это логический сетевой компонент в виртуальной частной сети (VPC), который представляет собой виртуальную сетевую карту. Дополнительную информацию см. в руководстве пользователя Amazon EC2 для Linux-инстансов, раздел «Эластичные сетевые интерфейсы».

DNSName -> (строка)

Имя домена системы доменных имен (DNS) для кэша.

KmsKeyId -> (строка)

Указывает идентификатор ключа Key Management Service (KMS), который используется для шифрования данных в Amazon File Cache. Если KmsKeyId не указан, используется управляемый Amazon FSx ключ KMS для вашей учетной записи. Дополнительную информацию см. в разделе «Шифрование» в справочнике API Key Management Service.

ResourceARN -> (строка)

Идентификатор ресурса Amazon Resource Name (ARN) для данного ресурса. ARN уникально идентифицируют ресурсы Amazon Web Services. ARN требуется, когда необходимо однозначно указать ресурс во всех службах Amazon Web Services. Дополнительную информацию см. в разделе «Имена ресурсов Amazon Resource Names (ARN)» в общем справочнике Amazon Web Services.

LustreConfiguration -> (структура)

Конфигурация ресурса Amazon File Cache.

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

Пропускная способность хранения на единицу — это мегабайты в секунду пропускной способности чтения или записи на 1 тебибайт предоставленного хранилища. Пропускная способность кэша равна емкости хранения (ТБ) * PerUnitStorageThroughput (МБ/с/ТБ). Поддерживается только значение 1000.

DeploymentType -> (строка)

Тип развертывания ресурса Amazon File Cache, который должен быть CACHE_1.

MountName -> (строка)

Значение MountName используется при подключении кэша. Если вы передадите идентификатор кэша в операцию DescribeFileCaches, она вернет значение MountName в описании кэша.

WeeklyMaintenanceStartTime -> (строка)

Повторяющееся еженедельное время в формате D:HH:MM.

D — это день недели, где 1 соответствует понедельнику, а 7 — воскресенью. Подробности см. в спецификации ISO-8601 на Википедии.

HH — это нулевое значение часа (0-23), а MM — нулевое значение минуты.

Например, 1:05:00 указывает обслуживание в 5:00 понедельника.

MetadataConfiguration -> (структура)

Конфигурация для хранилища Lustre MDT (целевой объем метаданных).

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

Емкость хранилища Lustre MDT (целевой объем метаданных) в гигабайтах (GiB). Поддерживается только значение 2400 GiB.

LogConfiguration -> (структура)

Конфигурация Lustre-логирования для записи событий включенного ведения журнала для ресурса Amazon File Cache в Amazon CloudWatch Logs.

Level -> (строка)

События репозитория данных, регистрируемые Amazon FSx.

  • WARN_ONLY - регистрируются только предупреждения.
  • ERROR_ONLY - регистрируются только ошибки.
  • WARN_ERROR - регистрируются как предупреждения, так и ошибки.
  • DISABLED - ведение журнала событий репозитория данных отключено.

Обратите внимание, что Amazon File Cache использует значение по умолчанию WARN_ERROR, которое изменить нельзя.

Destination -> (строка)

Идентификатор ресурса Amazon Resource Name (ARN), который указывает место назначения журналов. Местом назначения может быть любой ARN группы журналов Amazon CloudWatch Logs. ARN места назначения должен находиться в той же облачной инфраструктуре Amazon Web Services, области Amazon Web Services и учетной записи Amazon Web Services, что и ваш файл системы Amazon FSx.

DataRepositoryAssociationIds -> (список)

Список идентификаторов ассоциаций репозиториев данных, связанных с этим кэшем.

(строка)

NextToken -> (строка)

(Необязательно) Непрозрачный маркер пагинации, возвращенный в предыдущей операции (строка). При наличии этот маркер указывает, с какой точки можно продолжить обработку запроса, где прервалось предыдущее значение NextToken.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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