Spec-Zone.ru › AWS CLI v2

[ aws . storagegateway ]

start-cache-report

Описание

Начинает создание отчета о метаданных файлов, в настоящее время кэшированных файловым шлюзом S3 для конкретной общей папки. Вы можете использовать этот отчет для выявления и решения проблем, если у вас возникают сбои при загрузке файлов со шлюза в Amazon S3. Отчет — это файл CSV, содержащий список файлов, соответствующих набору параметров фильтра, которые вы указали в запросе.

Примечание

Флаг Сбои загрузки файлов сбрасывается каждые 24 часа и во время перезагрузки шлюза. Если этот отчет захватывает файлы после сброса, но до того, как они снова будут помечены, они не будут указаны как Сбои загрузки файлов.

Для успешного создания отчета о кэше должны быть выполнены следующие требования:

  • У вас должны быть разрешения на просмотр всего связанного с указанной общей папкой хранилища Amazon S3.
  • В настоящее время не может быть других отчетов о кэше, которые выполняются для указанной общей папки.
  • Должно быть меньше 10 существующих отчетов о кэше для указанной общей папки.
  • Шлюз должен быть активным и подключенным к Amazon Web Services.
  • Корневой диск должен иметь как минимум 20 ГБ свободного места при запуске генерации отчета.
  • Вы должны указать хотя бы одно значение для InclusionFilters или ExclusionFilters в запросе.

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

Синтаксис

  start-cache-report
--file-share-arn <value>
--role <value>
--location-arn <value>
--bucket-region <value>
[--vpc-endpoint-dns-name <value>]
[--inclusion-filters <value>]
[--exclusion-filters <value>]
--client-token <value>
[--tags <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-share-arn (строка)

Идентификатор ресурса Amazon (ARN) сетевого хранилища.

--role (строка)

ARN роли IAM, используемой при сохранении отчета о кэше в Amazon S3.

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

ARN ведра Amazon S3, в котором вы хотите сохранить отчет о кэше.

Примечание

Не рекомендуется сохранять отчет о кэше в том же ведре Amazon S3, для которого вы генерируете отчет.

Это поле не принимает ARN точек доступа.

--bucket-region (строка)

Регион Amazon Web Services ведра Amazon S3, в котором вы хотите сохранить отчет о кэше.

--vpc-endpoint-dns-name (строка)

DNS-имя конечной точки VPC, связанной с Amazon S3, в котором вы хотите сохранить отчет о кэше. Необязательно.

--inclusion-filters (список)

Список фильтров и параметров, определяющих, какие файлы включены в отчет. Вы должны указать хотя бы одно значение для InclusionFilters или ExclusionFilters в запросе StartCacheReport.

(структура)

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

Имя -> (строка)

Имя параметра фильтра, определяющего, какие файлы включаются или исключаются из отчета о кэше.

Допустимые имена:

UploadFailureReason | UploadState

Значения -> (список)

Значение параметра фильтра, определяющего, какие файлы включаются или исключаются из отчета о кэше.

Допустимые значения ``UploadFailureReason``:

InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied

Допустимые значения ``UploadState``:

FailingUpload

(строка)

Сокращенная синтаксическая запись:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "UploadState"|"UploadFailureReason",
    "Values": ["string", ...]
  }
  ...
]

--exclusion-filters (список)

Список фильтров и параметров, определяющих, какие файлы исключаются из отчета. Вы должны указать хотя бы одно значение для InclusionFilters или ExclusionFilters в запросе StartCacheReport.

(структура)

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

Имя -> (строка)

Имя параметра фильтра, определяющего, какие файлы включаются или исключаются из отчета о кэше.

Допустимые имена:

UploadFailureReason | UploadState

Значения -> (список)

Значение параметра фильтра, определяющего, какие файлы включаются или исключаются из отчета о кэше.

Допустимые значения ``UploadFailureReason``:

InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied

Допустимые значения ``UploadState``:

FailingUpload

(строка)

Сокращенная синтаксическая запись:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "UploadState"|"UploadFailureReason",
    "Values": ["string", ...]
  }
  ...
]

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

Уникальный идентификатор, используемый для обеспечения идемпотентности генерации отчета, если необходимо повторно выполнить неудачный запрос StartCacheReport. При повторном выполнении запроса используйте тот же ClientToken, что и в начальном запросе.

--tags (список)

Список из до 50 пар ключ-значение, которые вы можете назначить отчёту о кэше. Используя теги, вы можете категоризировать отчеты и проще находить их в результатах поиска.

(структура)

Пара ключ-значение, которые помогают управлять, фильтровать и искать ваши ресурсы. Допустимые символы: буквы, пробелы и цифры, представимые в UTF-8, и следующие символы: + - = . _ : /.

Ключ -> (строка)

Ключ тега. Ключ не может начинаться с aws:.

Значение -> (строка)

Значение ключа тега.

Сокращенная синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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
  • текст
  • таблица
  • 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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

CacheReportARN -> (строка)

Amazon Resource Name (ARN) отчета о кэше, сгенерированного запросом StartCacheReport.

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

Spec-Zone.ru

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