describe-replication-tasks

Описание

Возвращает информацию о задачах репликации для вашей учетной записи в текущем регионе.

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

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

Синтаксис

  describe-replication-tasks
[--filters <value>]
[--without-settings | --no-without-settings]
[--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]

Параметры

--filters (список)

Фильтры, применяемые к задачам репликации.

Допустимые имена фильтров: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

(структура)

Определяет имя и значение объекта фильтра. Этот фильтр используется для ограничения количества и типа объектов DMS, возвращаемых для конкретного вызова Describe* или аналогичной операции. Фильтры используются в качестве необязательного параметра для определенных операций API.

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

Имя фильтра, указанное для вызова Describe* или аналогичной операции.

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

Значение фильтра, которое может указывать одно или несколько значений, используемых для сужения возвращаемых результатов.

(строка)

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

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

Синтаксис JSON:

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

--without-settings | --no-without-settings (булево)

Вариант, чтобы избежать возвращения информации о настройках. Используйте это, чтобы уменьшить нагрузку, когда информация о настройках слишком большая. Для использования этого параметра выберите true; в противном случае, выберите false (по умолчанию).

--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
текст
таблица
yaml
yaml-потоковый

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

включен
выключен
авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

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

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Для описания задачи репликации

Следующий пример describe-replication-tasks описывает текущие задачи репликации.

aws dms describe-replication-tasks

Вывод:

{
    "ReplicationTasks": [
        {
            "ReplicationTaskIdentifier": "moveit2",
            "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA",
            "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:EOM4SFKCZEYHZBFGAGZT3QEC5U",
            "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
            "MigrationType": "full-load",
            "TableMappings": ...output omitted... ,
            "ReplicationTaskSettings": ...output omitted... ,
            "Status": "stopped",
            "StopReason": "Stop Reason FULL_LOAD_ONLY_FINISHED",
            "ReplicationTaskCreationDate": 1590524772.505,
            "ReplicationTaskStartDate": 1590619805.212,
            "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII",
            "ReplicationTaskStats": {
                "FullLoadProgressPercent": 100,
                "ElapsedTimeMillis": 0,
                "TablesLoaded": 0,
                "TablesLoading": 0,
                "TablesQueued": 0,
                "TablesErrored": 0,
                "FreshStartDate": 1590619811.528,
                "StartDate": 1590619811.528,
                "StopDate": 1590619842.068
            }
        }
    ]
}

Для получения дополнительной информации см. Работа с задачами AWS DMS в Руководстве пользователя AWS Database Migration Service.

Вывод

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

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

ReplicationTasks -> (список)

Описание задач репликации.

(структура)

Предоставляет информацию, описывающую задачу репликации, созданную операцией CreateReplicationTask.

ReplicationTaskIdentifier -> (строка)

Идентификатор или имя задачи репликации, назначенные пользователем.

Ограничения:

Должно содержать 1-255 буквенно-цифровых символов или дефисов.
Первый символ должен быть буквой.
Не может заканчиваться дефисом или содержать два последовательных дефиса.

SourceEndpointArn -> (строка)

Идентификатор Amazon Resource Name (ARN) узла, уникально идентифицирующего его.

TargetEndpointArn -> (строка)

ARN, уникально идентифицирующий узел.

ReplicationInstanceArn -> (строка)

ARN экземпляра репликации.

MigrationType -> (строка)

Тип миграции.

TableMappings -> (строка)

Сопоставления таблиц, указанные в задаче.

ReplicationTaskSettings -> (строка)

Настройки задачи репликации.

Status -> (строка)

Статус задачи репликации. Этот параметр ответа может возвращать одно из следующих значений:

"moving" – Задача перемещается в ответ на запуск операции ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__.
"creating" – Задача создаётся в ответ на запуск операции ` CreateReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationTask.html`__.
"deleting" – Задача удаляется в ответ на запуск операции ` DeleteReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html`__.
"failed" – Задача не выполнила миграцию базы данных успешно в ответ на запуск операции ` StartReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__.
"failed-move" – Задача не смогла переместиться в ответ на запуск операции ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__.
"modifying" – Определение задачи изменяется в ответ на запуск операции ` ModifyReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_ModifyReplicationTask.html`__.
"ready" – Задача находится в состоянии ready, где она может реагировать на другие операции с задачами, такие как ` StartReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__ или ` DeleteReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_DeleteReplicationTask.html`__.
"running" – Задача выполняет миграцию базы данных в ответ на запуск операции ` StartReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__.
"starting" – Задача готовится к выполнению миграции базы данных в ответ на запуск операции ` StartReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTask.html`__.
"stopped" – Задача остановлена в ответ на запуск операции ` StopReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html`__.
"stopping" – Задача готовится к остановке в ответ на запуск операции ` StopReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_StopReplicationTask.html`__.
"testing" – Миграция базы данных для этой задачи тестируется в ответ на запуск операции ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ или ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__.

Примечание

` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ — это улучшенная операция предварительной оценки задач миграции. Операция ` StartReplicationTaskAssessment https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessment.html`__ оценивает совместимость типов данных только между исходной и целевой базами данных данной задачи миграции. В отличие от этого, ` StartReplicationTaskAssessmentRun https://docs.aws.amazon.com/dms/latest/APIReference/API_StartReplicationTaskAssessmentRun.html`__ позволяет указать различные предварительные оценки задач миграции помимо совместимости типов данных. Эти оценки включают проверку правильности определений первичных ключей и вероятных проблем с производительностью миграции базы данных, среди прочего.

LastFailureMessage -> (строка)

Последнее сообщение об ошибке (остановке) задачи репликации.

StopReason -> (строка)

Причина остановки задачи репликации. Этот параметр ответа может возвращать одно из следующих значений:

"Stop Reason NORMAL" – Задача выполнена успешно без дополнительной информации.
"Stop Reason RECOVERABLE_ERROR"
"Stop Reason FATAL_ERROR"
"Stop Reason FULL_LOAD_ONLY_FINISHED" – Задача завершила фазу полной загрузки. DMS применил кэшированные изменения, если вы установили StopTaskCachedChangesApplied в true.
"Stop Reason STOPPED_AFTER_FULL_LOAD" – Полная загрузка завершена, кэшированные изменения не применены
"Stop Reason STOPPED_AFTER_CACHED_EVENTS" – Полная загрузка завершена, кэшированные изменения применены
"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
"Stop Reason STOPPED_AFTER_DDL_APPLY" – Пользовательская остановка задачи после применения DDL
"Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
"Stop Reason STOPPED_DUE_TO_LOW_DISK"
"Stop Reason STOPPED_AT_SERVER_TIME" – Пользовательское серверное время для остановки задачи
"Stop Reason STOPPED_AT_COMMIT_TIME" – Пользовательское время подтверждения для остановки задачи
"Stop Reason RECONFIGURATION_RESTART"
"Stop Reason RECYCLE_TASK"

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

Дата создания задачи репликации.

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

Дата, когда запланировано начать задачу репликации.

CdcStartPosition -> (строка)

Указывает, когда нужно начать операцию захвата изменений (CDC). Используйте либо CdcStartPosition, либо CdcStartTime, чтобы указать, когда нужно начать операцию CDC. Указание обоих значений приводит к ошибке.

Значение может быть в формате даты, контрольной точки или LSN/SCN.

Пример даты: –cdc-start-position “2018-03-08T12:12:12”

Пример контрольной точки: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”

Пример LSN: –cdc-start-position “mysql-bin-changelog.000024:373”

CdcStopPosition -> (строка)

Указывает, когда следует остановить операцию захвата изменений (CDC). Значение может быть серверным временем или временем подтверждения.

Пример серверного времени: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Пример времени подтверждения: –cdc-stop-position “commit_time:2018-02-09T12:12:12“

RecoveryCheckpoint -> (строка)

Указывает последнюю контрольную точку, которая произошла во время операции захвата изменений (CDC). Вы можете предоставить это значение параметру CdcStartPosition, чтобы начать операцию CDC, начинающуюся с этой контрольной точки.

ReplicationTaskArn -> (строка)

Amazon Resource Name (ARN) задачи репликации.

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

Статистика задачи, включая затраченное время, загруженные таблицы и ошибки таблиц.

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

Процент завершения задачи миграции полной загрузки.

ElapsedTimeMillis -> (длинное целое число)

Затраченное время задачи в миллисекундах.

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

Количество загруженных таблиц для этой задачи.

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

Количество таблиц, которые загружаются для этой задачи.

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

Количество таблиц, очереди для этой задачи.

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

Количество ошибок, произошедших во время этой задачи.

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

Дата запуска задачи репликации с новым началом или перегрузкой целевого объекта.

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

Дата запуска задачи репликации с новым началом или возобновлением. Для получения дополнительной информации см. StartReplicationTaskType .

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

Дата остановки задачи репликации.

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

Дата запуска полной загрузки задачи репликации.

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

Дата завершения полной загрузки задачи репликации.

TaskData -> (строка)

Дополнительная информация, необходимая задаче для миграции данных для определенных исходных и целевых узлов. Для получения дополнительной информации см. Указание дополнительных данных для настроек задачи в руководстве пользователя Database Migration Service.

TargetReplicationInstanceArn -> (строка)

ARN экземпляра репликации, в который перемещена эта задача в ответ на запуск операции ` MoveReplicationTask https://docs.aws.amazon.com/dms/latest/APIReference/API_MoveReplicationTask.html`__ . В противном случае этот параметр ответа не является членом объекта ReplicationTask.