Spec-Zone.ru › AWS CLI v2

[ aws . storagegateway ]

refresh-cache

Описание

Обновляет кэшированный инвентарь объектов для указанного общего ресурса файлов. Данная операция находит объекты в ведре Amazon S3, которые были добавлены, удалены или заменены с момента последнего перечисления содержимого ведра шлюзом и кеширования результатов. Эта операция не импортирует файлы в хранилище кэша S3 File Gateway. Она только обновляет кэшированный инвентарь, чтобы отразить изменения в инвентаре объектов в ведре S3. Данная операция поддерживается только для типов шлюзов S3 File Gateway.

Вы можете подписаться на уведомления через Amazon CloudWatch о завершении своей RefreshCache операции. Дополнительную информацию см. в руководстве пользователя Amazon S3 File Gateway в разделе «Получение уведомлений об операциях с файлами». Данная операция поддерживается только для S3 File Gateway.

При вызове данного API запускается только операция обновления. Когда вызов API завершается и возвращает код успешного выполнения, это не обязательно означает, что обновление файлов завершено. Для определения завершения операции перед проверкой новых файлов на общем ресурсе файлов шлюза необходимо использовать уведомление refresh-complete. Вы можете подписаться на уведомления через CloudWatch о завершении своей RefreshCache операции.

Предел ограничений: данный API асинхронный, поэтому шлюз будет принимать не более двух обновлений одновременно. Рекомендуется использовать уведомление о завершении обновления CloudWatch перед отправкой дополнительных запросов. Дополнительную информацию см. в руководстве пользователя Amazon S3 File Gateway в разделе «Получение уведомлений об операциях с файлами».

Предупреждение

  • Выдерживайте интервал не менее 60 секунд между последовательными запросами API RefreshCache.
  • Если вы вызываете API RefreshCache, когда уже обрабатываются два запроса, любой новый запрос приведет к ошибке InvalidGatewayRequestException из-за отправки слишком большого количества запросов на сервер.

Примечание

Имя ведра S3 не нужно включать при вводе списка папок в параметре FolderList.

Дополнительную информацию см. в руководстве пользователя Amazon S3 File Gateway в разделе «Получение уведомлений об операциях с файлами».

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

Синтаксис

  refresh-cache
--file-share-arn <value>
[--folder-list <value>]
[--recursive | --no-recursive]
[--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-share-arn (строка)

Amazon Resource Name (ARN) общего ресурса файлов, который необходимо обновить.

--folder-list (список)

Список путей папок для обновления в кэше, разделенные запятыми. По умолчанию ["/" ]. По умолчанию обновляются объекты и папки в корне ведра Amazon S3. Если Recursive установлено в значение true, обновляется всё ведро S3, к которому имеет доступ общий ресурс файлов.

Не включайте / при указании имен папок. Например, укажите samplefolder, а не samplefolder/.

(строка)

Синтаксис:

"string" "string" ...

--recursive | --no-recursive (логическое значение)

Значение, определяющее, нужно ли рекурсивно обновлять папки в кэше. Обновление включает папки, которые находились в кэше в последний раз, когда шлюз перечислял содержимое папки. Если это значение установлено в true, каждая папка, перечисленная в FolderList, обновляется рекурсивно. В противном случае подпапки, перечисленные в FolderList, не обновляются. Обновление ищут только объекты, которые находятся в папках, перечисленных непосредственно под FolderList. Значение по умолчанию - true.

Допустимые значения: true | false

--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
  • таблица
  • 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, подобные правилам unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной программы. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Для обновления кэша общего ресурса файлов

Следующий refresh-cache пример обновляет кэш для указанного общего ресурса файлов.

aws storagegateway refresh-cache \
    --file-share-arn arn:aws:storagegateway:us-east-1:111122223333:share/share-2FA12345

Вывод:

{
    "FileShareARN": "arn:aws:storagegateway:us-east-1:111122223333:share/share-2FA12345",
    "NotificationId": "4954d4b1-abcd-ef01-1234-97950a7d3483"
}

Дополнительную информацию см. в разделе ListFileShares в справочнике по API-интерфейсу службы AWS Storage Gateway.

Вывод

FileShareARN -> (строка)

Amazon Resource Name (ARN) общего ресурса файлов.

NotificationId -> (строка)

Случайный ID уведомления, которое было отправлено. Этот идентификатор имеет формат UUID.

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

Spec-Zone.ru

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