Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-export-tasks

Описание

Возвращает информацию о задаче экспорта моментальной копии или кластера в Amazon S3. Данный API-запрос поддерживает постраничную навигацию.

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

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

Синтаксис

  describe-export-tasks
[--export-task-identifier <value>]
[--source-arn <value>]
[--filters <value>]
[--source-type <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]

Параметры

--export-task-identifier (строка)

Идентификатор задачи экспорта моментальной копии или кластера, который нужно описать.

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

Amazon Resource Name (ARN) моментальной копии или кластера, экспортированных в Amazon S3.

--filters (список)

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

Поддерживаемые фильтры включают следующие:

  • export-task-identifier — идентификатор задачи экспорта моментальной копии или кластера.
  • s3-bucket — ведро Amazon S3, в которое экспортируются данные.
  • source-arn — Amazon Resource Name (ARN) моментальной копии или кластера, экспортированных в Amazon S3.
  • status — состояние задачи экспорта. Должно быть в нижнем регистре. Допустимые состояния:
    • canceled
    • canceling
    • complete
    • failed
    • in_progress
    • starting

(структура)

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

Примечание

В настоящее время подстановка шаблонов не поддерживается в фильтрах.

Следующие действия могут быть отфильтрованы:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

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

Имя фильтра. Имена фильтров чувствительны к регистру.

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

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

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

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

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--source-type (строка)

Тип источника для экспорта.

Возможные значения:

  • SNAPSHOT
  • CLUSTER

--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
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Примеры

Примечание

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

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

Для описания задач экспорта моментальных копий

Следующий пример describe-export-tasks возвращает информацию о задачах экспорта моментальных копий в Amazon S3.

aws rds describe-export-tasks

Вывод:

{
    "ExportTasks": [
        {
            "ExportTaskIdentifier": "test-snapshot-export",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot",
            "SnapshotTime": "2020-03-02T18:26:28.163Z",
            "TaskStartTime": "2020-03-02T18:57:56.896Z",
            "TaskEndTime": "2020-03-02T19:10:31.985Z",
            "S3Bucket": "amzn-s3-demo-bucket",
            "S3Prefix": "",
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
            "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
            "Status": "COMPLETE",
            "PercentProgress": 100,
            "TotalExtractedDataInGB": 0
        },
        {
            "ExportTaskIdentifier": "my-s3-export",
            "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test",
            "SnapshotTime": "2020-03-27T20:48:42.023Z",
            "S3Bucket": "amzn-s3-demo-bucket",
            "S3Prefix": "",
            "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
            "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
            "Status": "STARTING",
            "PercentProgress": 0,
            "TotalExtractedDataInGB": 0
        }
    ]
}

Для получения дополнительной информации см. Мониторинг экспорта моментальных копий в Руководстве пользователя Amazon RDS.

Вывод

Маркер -> (строка)

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

ExportTasks -> (список)

Информация об экспорте моментального снимка или кластера в Amazon S3.

(структура)

Содержит детали экспорта моментального снимка или кластера в Amazon S3.

Этот тип данных используется в качестве элемента ответа в операции DescribeExportTasks.

ExportTaskIdentifier -> (строка)

Уникальный идентификатор задачи экспорта моментального снимка или кластера. Этот идентификатор не является идентификатором ведра Amazon S3, в которое экспортируются данные.

SourceArn -> (строка)

Идентификатор ресурса Amazon (ARN) моментального снимка или кластера, экспортированного в Amazon S3.

ExportOnly -> (список)

Данные, экспортированные из моментального снимка или кластера.

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

  • database - Экспортировать все данные из указанной базы данных.
  • database.table имя_таблицы - Экспортировать таблицу моментального снимка или кластера. Этот формат допустим только для RDS для MySQL, RDS для MariaDB и Aurora MySQL.
  • database.schema имя_схемы - Экспортировать схему базы данных моментального снимка или кластера. Этот формат допустим только для RDS для PostgreSQL и Aurora PostgreSQL.
  • database.schema.table имя_таблицы - Экспортировать таблицу из схемы базы данных. Этот формат допустим только для RDS для PostgreSQL и Aurora PostgreSQL.

(строка)

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

Время создания моментального снимка.

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

Время начала задачи экспорта моментального снимка или кластера.

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

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

S3Bucket -> (строка)

Ведро Amazon S3, в которое экспортируется моментальный снимок или кластер.

S3Prefix -> (строка)

Префикс ведра Amazon S3, который представляет собой имя файла и путь к экспортированным данным.

IamRoleArn -> (строка)

Имя роли IAM, используемой для записи в Amazon S3 при экспорте моментального снимка или кластера.

KmsKeyId -> (строка)

Идентификатор ключа Amazon Web Services KMS, используемого для шифрования данных при экспорте в Amazon S3. Идентификатор ключа KMS представляет собой его ARN ключа, ID ключа, ARN псевдонима или имя псевдонима. Роль IAM, используемая для экспорта, должна иметь права шифрования и дешифрования для использования этого ключа KMS.

Status -> (строка)

Статус выполнения задачи экспорта. Статус может быть одним из следующих:

  • CANCELED
  • CANCELING
  • COMPLETE
  • FAILED
  • IN_PROGRESS
  • STARTING

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

Прогресс задачи экспорта моментального снимка или кластера в процентах.

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

Общий объем экспортированных данных в гигабайтах.

FailureCause -> (строка)

Причина сбоя экспорта, если экспорт завершился с ошибкой.

WarningMessage -> (строка)

Предупреждение о задаче экспорта моментального снимка или кластера.

SourceType -> (строка)

Тип источника экспорта.

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

Spec-Zone.ru

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