Spec-Zone.ru › AWS CLI v2

[ aws . fsx ]

describe-data-repository-tasks

Описание

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

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

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

Синтаксис

  describe-data-repository-tasks
[--task-ids <value>]
[--filters <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]

Параметры

--task-ids (список)

(Необязательно) Идентификаторы задач, описание которых требуется получить (строка).

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

(Необязательно) Вы можете использовать фильтры для сужения результатов DescribeDataRepositoryTasks, чтобы включать только задачи для определённых файловых систем или задачи в определённом состоянии жизненного цикла.

(структура)

(Необязательно) Массив объектов фильтров, которые вы можете использовать для фильтрации ответа задач репозитория данных, которые вы увидите в ответе. Вы можете фильтровать возвращаемые задачи по одному или нескольким идентификаторам файловой системы, жизненному циклу задач и типу задач. Объект фильтра состоит из свойства фильтра Name и одного или нескольких значений Values для фильтра.

Name -> (строка)

Имя свойства задачи, используемого для фильтрации задач, возвращаемых в ответе.

  • Используйте file-system-id для получения задач репозитория данных для определённых файловых систем.
  • Используйте task-lifecycle для получения задач репозитория данных со значениями одного или нескольких определённых состояний жизненного цикла: CANCELED, EXECUTING, FAILED, PENDING и SUCCEEDED.

Values -> (список)

Используйте Values для включения определённых идентификаторов файловых систем и состояний жизненного цикла задач для фильтров, которые вы используете.

(строка)

Упрощенный синтаксис:

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

Синтаксис JSON:

[
  {
    "Name": "file-system-id"|"task-lifecycle"|"data-repository-association-id"|"file-cache-id",
    "Values": ["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
  • текст
  • таблица
  • 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.

Вывод

DataRepositoryTasks -> (список)

Возвращаемый набор описаний задач репозитория данных.

(структура)

Описание задачи репозитория данных.

  • Задачи импорта и экспорта репозитория данных используются для выполнения операций по пакетной передаче данных между файловой системой Amazon FSx для Lustre и связанным репозиторием данных.
  • Задачи освобождения репозитория данных используются для освобождения файлов, которые были экспортированы в связанное хранилище S3 из вашей файловой системы Amazon FSx для Lustre.
  • Ресурс Amazon File Cache использует задачу для автоматического освобождения файлов из кэша.

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

TaskId -> (строка)

Уникальный 17-значный идентификатор задачи репозитория данных, сгенерированный системой.

Lifecycle -> (строка)

Состояние жизненного цикла задачи репозитория данных, в следующем виде:

  • PENDING - Задача еще не начата.
  • EXECUTING - Задача выполняется.
  • FAILED - Задача не может быть завершена. Например, могут быть файлы, которые задача не обработала. Свойство DataRepositoryTaskFailureDetails содержит дополнительную информацию о сбоях задачи.
  • SUCCEEDED - Задача успешно завершена.
  • CANCELED - Задача была отменена и не завершена.
  • CANCELING - Задача находится в процессе отмены.

Примечание

Вы не можете удалить файловую систему FSx для Lustre, если для неё есть задачи репозитория данных в состояниях PENDING или EXECUTING. Повторите попытку, когда задача репозитория данных будет завершена (со статусом CANCELED, SUCCEEDED или FAILED). Вы можете отслеживать состояние задачи с помощью действия DescribeDataRepositoryTask. Обратитесь в команду FSx, если вам необходимо немедленно удалить свою файловую систему.

Type -> (строка)

Тип задачи репозитория данных.

  • EXPORT_TO_REPOSITORY задачи экспортируют данные из вашей файловой системы Amazon FSx для Lustre в связанный репозиторий данных.
  • IMPORT_METADATA_FROM_REPOSITORY задачи импортируют изменения метаданных из связанного хранилища S3 в вашу файловую систему Amazon FSx для Lustre.
  • RELEASE_DATA_FROM_FILESYSTEM задачи освобождают файлы в вашей файловой системе Amazon FSx для Lustre, которые были экспортированы в связанное хранилище S3 и отвечают вашим критериям освобождения.
  • AUTO_RELEASE_DATA задачи автоматически освобождают файлы из ресурса Amazon File Cache.

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

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

StartTime -> (временная метка)

Время, когда система начала обработку задачи.

EndTime -> (временная метка)

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

ResourceARN -> (строка)

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

Tags -> (список)

Список значений тегов Tag, с максимальным количеством 50 элементов.

(структура)

Определяет пару ключ-значение для тега ресурса.

Key -> (строка)

Значение, определяющее TagKey, имя тега. Ключи тегов должны быть уникальными для ресурса, к которому они прикреплены.

Value -> (строка)

Значение, определяющее TagValue, значение, назначенное соответствующему ключу тега. Значения тегов могут быть null и не обязательно должны быть уникальными в наборе тегов. Например, вы можете иметь пару ключ-значение в наборе тегов finances : April и также payroll : April.

FileSystemId -> (строка)

Глобальный уникальный идентификатор файловой системы.

Paths -> (список)

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

(По умолчанию) Если Paths не указан, Amazon FSx использует корневой каталог файловой системы.

(строка)

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

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

Message -> (строка)

Подробное сообщение об ошибке.

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

Предоставляет состояние количества файлов, которые задача успешно обработала и не смогла обработать.

TotalCount -> (длинное целое)

Общее количество файлов, которые задача обработает. В то время как задача выполняется, сумма SucceededCount плюс FailedCount может не равняться TotalCount. Когда задача завершена, TotalCount равно сумме SucceededCount плюс FailedCount.

SucceededCount -> (длинное целое)

Текущая сумма количества файлов, которые задача успешно обработала.

FailedCount -> (длинное целое)

Текущая сумма количества файлов, которые задача не смогла обработать.

LastUpdatedTime -> (временная метка)

Время последнего обновления статуса задачи.

ReleasedCapacity -> (длинное целое)

Общий объем данных, в ГБ, освобожденных задачей Amazon File Cache AUTO_RELEASE_DATA, которая автоматически освобождает файлы из кэша.

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

Предоставляет отчет, подробно описывающий результаты задачи репозитория данных для обработанных файлов, которые соответствуют критериям, указанным в параметре отчета Scope. FSx передает отчет в связанный репозиторий данных файловой системы в Amazon S3, используя путь, указанный в параметре отчета Path. Вы можете указать, генерировать или нет отчет для задачи, используя параметр Enabled.

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

Установите Enabled в True, чтобы сгенерировать CompletionReport, когда задача завершается. Если установлено true, то вам нужно указать отчет Scope, Path и Format. Установите Enabled в False, если вы не хотите генерировать CompletionReport при завершении задачи.

Path -> (строка)

Требуется, если Enabled установлено в true. Указывает расположение отчета в связанном репозитории данных S3 файловой системы. Абсолютный путь, определяющий, где будет храниться отчет о завершении в целевом расположении. Path, который вы предоставляете, должен находиться в пределах ExportPath файловой системы. Пример значения Path: «s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix». Отчет содержит следующую информацию для каждого файла в отчете: FilePath, FileStatus и ErrorCode.

Format -> (строка)

Требуется, если Enabled установлено в true. Указывает формат CompletionReport. REPORT_CSV_20191124 — единственный в настоящее время поддерживаемый формат. Когда Format установлено в REPORT_CSV_20191124, CompletionReport предоставляется в формате CSV и передается в {path}/task-{id}/failures.csv.

Scope -> (строка)

Требуется, если Enabled установлено в true. Указывает область CompletionReport; FAILED_FILES_ONLY — единственная в настоящее время поддерживаемая область. Когда Scope установлено в FAILED_FILES_ONLY, CompletionReport содержит только информацию о файлах, которые задача репозитория данных не смогла обработать.

CapacityToRelease -> (длинное целое)

Указывает объем данных для освобождения, в ГБ, задачей Amazon File Cache AUTO_RELEASE_DATA, которая автоматически освобождает файлы из кэша.

FileCacheId -> (строка)

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

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

Конфигурация, определяющая критерии времени последнего доступа для файлов, которые будут освобождены из файловой системы Amazon FSx для Lustre.

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

Определяет момент времени с момента последнего доступа к экспортированному файлу, для того, чтобы этот файл мог быть освобожден. Только файлы, которые были в последний раз обработаны до этого момента, могут быть освобождены из файловой системы.

Unit -> (строка)

Единица времени, используемая параметром Value для определения возможности освобождения файла на основе времени его последнего доступа. DAYS — единственное поддерживаемое значение. Это обязательный параметр.

Value -> (длинное целое)

Целое число, представляющее минимальное количество времени (в днях) с момента последнего доступа к файлу в файловой системе. Только экспортированные файлы с отметкой времени последнего доступа, которая больше этого значения во времени (относительно времени создания задачи), будут освобождены. По умолчанию Value равно 0. Это обязательный параметр.

Примечание

Если экспортированный файл соответствует критериям времени последнего доступа, его путь к файлу или каталогу также должен быть указан в параметре Paths операции, чтобы файл можно было освободить.

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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