Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

describe-table-restore-status

Описание

Отображает статус одного или нескольких запросов на восстановление таблицы, выполненных с помощью действия API RestoreTableFromClusterSnapshot. Если вы не укажете значение для параметра TableRestoreRequestId, то DescribeTableRestoreStatus вернёт статус всех запросов на восстановление таблиц, отсортированных по дате и времени запроса в порядке возрастания. В противном случае DescribeTableRestoreStatus вернёт статус таблицы, указанной в TableRestoreRequestId.

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

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

Синтаксис

  describe-table-restore-status
[--cluster-identifier <value>]
[--table-restore-request-id <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]

Параметры

--cluster-identifier (строка)

Кластер Amazon Redshift, в который восстанавливается таблица.

--table-restore-request-id (строка)

Идентификатор запроса на восстановление таблицы, для которого требуется вернуть статус. Если вы не укажете значение TableRestoreRequestId, то DescribeTableRestoreStatus вернёт статус всех активных запросов на восстановление таблиц.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это нельзя указать вместе с --cli-input-yaml.

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

Маркер, указывающий, с какой точки начать постраничную передачу. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная передача в руководстве пользователя AWS CLI.

--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 (целое число)

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

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

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

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

Примеры

Примечание

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

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

Чтобы описать статус запросов на восстановление таблицы со снимка кластера

В следующем примере describe-table-restore-status отображаются данные для запросов на восстановление таблицы для указанного кластера.

aws redshift describe-table-restore-status /
    --cluster-identifier mycluster

Вывод:

{
    "TableRestoreStatusDetails": [
        {
            "TableRestoreRequestId": "z1116630-0e80-46f4-ba86-bd9670411ebd",
            "Status": "IN_PROGRESS",
            "RequestTime": "2019-12-27T18:22:12.257Z",
            "ClusterIdentifier": "mycluster",
            "SnapshotIdentifier": "mysnapshotid",
            "SourceDatabaseName": "dev",
            "SourceSchemaName": "public",
            "SourceTableName": "mytable",
            "TargetDatabaseName": "dev",
            "TargetSchemaName": "public",
            "NewTableName": "mytable-clone"
        }
    ]
}

Дополнительные сведения см. в разделе Восстановление таблицы со снимка в руководстве по управлению кластерами Amazon Redshift.

Вывод

TableRestoreStatusDetails -> (список)

Список деталей статуса одного или нескольких запросов на восстановление таблицы.

(структура)

Описание статуса операции RestoreTableFromClusterSnapshot.

TableRestoreRequestId -> (строка)

Уникальный идентификатор запроса на восстановление таблицы.

Status -> (строка)

Значение, описывающее текущее состояние запроса на восстановление таблицы.

Допустимые значения: SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS

Message -> (строка)

Описание статуса запроса на восстановление таблицы. Значения статуса включают SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS.

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

Время создания запроса на восстановление таблицы в универсальном времени координации (UTC).

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

Объем данных, восстановленных в новую таблицу на данный момент, в мегабайтах (МБ).

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

Общий объем данных, подлежащих восстановлению в новую таблицу, в мегабайтах (МБ).

ClusterIdentifier -> (строка)

Идентификатор кластера Amazon Redshift, в который восстанавливается таблица.

SnapshotIdentifier -> (строка)

Идентификатор снимка, с которого восстанавливается таблица.

SourceDatabaseName -> (строка)

Имя исходной базы данных, содержащей восстанавливаемую таблицу.

SourceSchemaName -> (строка)

Имя исходной схемы, содержащей восстанавливаемую таблицу.

SourceTableName -> (строка)

Имя исходной таблицы, подлежащей восстановлению.

TargetDatabaseName -> (строка)

Имя базы данных, в которую восстанавливается таблица.

TargetSchemaName -> (строка)

Имя схемы, в которую восстанавливается таблица.

NewTableName -> (строка)

Имя таблицы, которая должна быть создана в результате запроса на восстановление таблицы.

Marker -> (строка)

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

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

Spec-Zone.ru

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