Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

describe-cluster-snapshots

Описание

Возвращает один или несколько объектов моментальных снимков, содержащих метаданные о моментальных снимках кластера. По умолчанию эта операция возвращает информацию обо всех моментальных снимках всех кластеров, которые принадлежат вашей учетной записи Amazon Web Services. Информация не возвращается для моментальных снимков, принадлежащих неактивным учетным записям Amazon Web Services.

Если вы указываете и ключи тегов, и значения тегов в одном запросе, Amazon Redshift возвращает все моментальные снимки, которые соответствуют любому сочетанию указанных ключей и значений. Например, если у вас есть owner и environment в качестве ключей тегов, а admin и test — в качестве значений тегов, возвращаются все моментальные снимки, содержащие любое сочетание этих значений. В ответ возвращаются только моментальные снимки, которые вам принадлежат; общие моментальные снимки не возвращаются при использовании параметров ключа и значения тега.

Если ключи и значения тегов опущены из запроса, моментальные снимки возвращаются независимо от того, имеют ли они связанные с ними ключи или значения тегов.

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

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

Синтаксис

  describe-cluster-snapshots
[--cluster-identifier <value>]
[--snapshot-identifier <value>]
[--snapshot-arn <value>]
[--snapshot-type <value>]
[--start-time <value>]
[--end-time <value>]
[--owner-account <value>]
[--tag-keys <value>]
[--tag-values <value>]
[--cluster-exists | --no-cluster-exists]
[--sorting-entities <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 (строка)

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

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

Идентификатор моментального снимка, о котором нужно вернуть информацию.

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

Amazon Resource Name (ARN) моментального снимка, связанного с сообщением для описания моментальных снимков кластера.

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

Тип моментальных снимков, о которых запрашивается информация. По умолчанию возвращаются моментальные снимки всех типов.

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

--start-time (отметка времени)

Значение, запрашивающее только моментальные снимки, созданные в или после указанного времени. Значение времени указывается в формате ISO 8601. Дополнительную информацию о формате ISO 8601 см. на странице Wikipedia по ISO8601.

Пример: 2012-07-16T18:00:00Z

--end-time (отметка времени)

Значение времени, запрашивающее только моментальные снимки, созданные в или до указанного времени. Значение времени указывается в формате ISO 8601. Дополнительную информацию о формате ISO 8601 см. на странице Wikipedia по ISO8601.

Пример: 2012-07-16T18:00:00Z

--owner-account (строка)

Учетная запись Amazon Web Services, используемая для создания или копирования моментального снимка. Используйте этот параметр для фильтрации результатов на моментальные снимки, принадлежащие определенной учетной записи. Чтобы описать свои моментальные снимки, укажите свою учетную запись Amazon Web Services или не указывайте параметр.

--tag-keys (список)

Ключ или ключи тегов, для которых вы хотите вернуть все соответствующие моментальные снимки кластера, связанные с указанным ключом или ключами. Например, предположим, что у вас есть моментальные снимки, помеченные ключами owner и environment. Если вы указываете оба этих ключа тегов в запросе, Amazon Redshift возвращает ответ с моментальными снимками, у которых ассоциированы либо тот, либо другой, либо оба эти ключа тегов.

(строка)

Синтаксис:

"string" "string" ...

--tag-values (список)

Значение или значения тегов, для которых вы хотите вернуть все соответствующие моментальные снимки кластера, связанные с указанным значением или значениями тега. Например, предположим, что у вас есть моментальные снимки, помеченные значениями admin и test. Если вы указываете оба этих значения тегов в запросе, Amazon Redshift возвращает ответ с моментальными снимками, у которых ассоциированы либо тот, либо другой, либо оба этих значения тегов.

(строка)

Синтаксис:

"string" "string" ...

--cluster-exists | --no-cluster-exists (логическое значение)

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

  • Если ClusterExists установлено в true, то ClusterIdentifier обязательно.
  • Если ClusterExists установлено в false и ClusterIdentifier не указано, возвращаются все моментальные снимки, связанные с удаленными кластерами (сироты).
  • Если ClusterExists установлено в false и ClusterIdentifier указано для удаленного кластера, возвращаются моментальные снимки, связанные с этим кластером.
  • Если ClusterExists установлено в false и ClusterIdentifier указано для существующего кластера, моментальные снимки не возвращаются.

--sorting-entities (список)

(структура)

Описывает элемент сортировки

Атрибут -> (строка)

Категория для сортировки моментальных снимков.

Сортировка -> (строка)

Порядок отображения атрибутов.

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

Attribute=string,SortOrder=string ...

Синтаксис JSON:

[
  {
    "Attribute": "SOURCE_TYPE"|"TOTAL_SIZE"|"CREATE_TIME",
    "SortOrder": "ASC"|"DESC"
  }
  ...
]

--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 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.

Примеры

Примечание

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

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

Получение описания всех снимков кластера

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

Команда:

aws redshift describe-cluster-snapshots

Результат:

{
   "Snapshots": [
      {
         "Status": "available",
         "SnapshotCreateTime": "2013-07-17T22:02:22.852Z",
         "EstimatedSecondsToCompletion": -1,
         "AvailabilityZone": "us-east-1a",
         "ClusterVersion": "1.0",
         "MasterUsername": "adminuser",
         "Encrypted": false,
         "OwnerAccount": "111122223333",
         "BackupProgressInMegabytes": 20.0,
         "ElapsedTimeInSeconds": 0,
         "DBName": "dev",
         "CurrentBackupRateInMegabytesPerSecond: 0.0,
         "ClusterCreateTime": "2013-01-22T21:59:29.559Z",
         "ActualIncrementalBackupSizeInMegabytes"; 20.0
         "SnapshotType": "automated",
         "NodeType": "dw.hs1.xlarge",
         "ClusterIdentifier": "mycluster",
         "Port": 5439,
         "TotalBackupSizeInMegabytes": 20.0,
         "NumberOfNodes": "2",
         "SnapshotIdentifier": "cm:mycluster-2013-01-22-22-04-18"
      },
      {
         "EstimatedSecondsToCompletion": 0,
         "OwnerAccount": "111122223333",
         "CurrentBackupRateInMegabytesPerSecond: 0.1534,
         "ActualIncrementalBackupSizeInMegabytes"; 11.0,
         "NumberOfNodes": "2",
         "Status": "available",
         "ClusterVersion": "1.0",
         "MasterUsername": "adminuser",
         "AccountsWithRestoreAccess": [
            {
               "AccountID": "444455556666"
            } ],
         "TotalBackupSizeInMegabytes": 20.0,
         "DBName": "dev",
         "BackupProgressInMegabytes": 11.0,
         "ClusterCreateTime": "2013-01-22T21:59:29.559Z",
         "ElapsedTimeInSeconds": 0,
         "ClusterIdentifier": "mycluster",
         "SnapshotCreateTime": "2013-07-17T22:04:18.947Z",
         "AvailabilityZone": "us-east-1a",
         "NodeType": "dw.hs1.xlarge",
         "Encrypted": false,
         "SnapshotType": "manual",
         "Port": 5439,
         "SnapshotIdentifier": "my-snapshot-id"
      } ]
   }
   (...remaining output omitted...)

Вывод

Marker -> (строка)

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

Snapshots -> (список)

Список экземпляров снимка.

(структура)

Описание снимка.

SnapshotIdentifier -> (строка)

Идентификатор снимка, предоставленный в запросе.

ClusterIdentifier -> (строка)

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

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

Время (в формате UTC), когда Amazon Redshift начал создание снимка. Снимок содержит копию данных кластера на этот точный момент времени.

Status -> (строка)

Статус снимка. Значение статуса зависит от используемой операции API:

  • CreateClusterSnapshot и CopyClusterSnapshot возвращают статус «создание».
  • DescribeClusterSnapshots возвращает статус «создание», «доступно», «окончательный снимок» или «ошибка».
  • DeleteClusterSnapshot возвращает статус «удалено».

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

Порт, на котором прослушивает кластер.

AvailabilityZone -> (строка)

Зона доступности, в которой был создан кластер.

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

Время (UTC), когда кластер был первоначально создан.

MasterUsername -> (строка)

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

ClusterVersion -> (строка)

Идентификатор версии Amazon Redshift Engine, работающей на кластере.

EngineFullVersion -> (строка)

Версия кластера, использованная для создания снимка. Например, 1.0.15503.

SnapshotType -> (строка)

Тип снимка. Снимки, созданные с помощью CreateClusterSnapshot и CopyClusterSnapshot, имеют тип «ручной».

NodeType -> (строка)

Тип узла узлов в кластере.

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

Количество узлов в кластере.

DBName -> (строка)

Имя базы данных, созданной при создании кластера.

VpcId -> (строка)

Идентификатор VPC кластера, если снимок создан из кластера в VPC. В противном случае это поле отсутствует в выводе.

Encrypted -> (булево)

Если true, данные в снимке шифруются в состоянии покоя.

KmsKeyId -> (строка)

Идентификатор ключа Key Management Service (KMS) ключа шифрования, использованного для шифрования данных в кластере, из которого был создан снимок.

EncryptedWithHSM -> (булево)

Логическое значение, указывающее, зашифрованы ли данные снимка с помощью ключей HSM исходного кластера. true указывает, что данные зашифрованы с помощью ключей HSM.

AccountsWithRestoreAccess -> (список)

Список Amazon Web Services учетных записей, авторизованных для восстановления снимка. Возвращает null, если нет авторизованных учетных записей. Виден только владельцу снимка.

(структура)

Описание Amazon Web Services учетной записи, авторизованной для восстановления снимка.

AccountId -> (строка)

Идентификатор Amazon Web Services учетной записи, авторизованной для восстановления снимка.

AccountAlias -> (строка)

Идентификатор Amazon Web Services учетной записи поддержки, авторизованной для восстановления снимка. Для Amazon Web Services Поддержка идентификатор — amazon-redshift-support.

OwnerAccount -> (строка)

Для ручных снимков — Amazon Web Services учетная запись, использованная для создания или копирования снимка. Для автоматических снимков — владелец кластера. Владелец может выполнять все действия со снимком, например, обмен ручным снимком.

TotalBackupSizeInMegaBytes -> (двойное)

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

ActualIncrementalBackupSizeInMegaBytes -> (двойное)

Размер инкрементной резервной копии.

BackupProgressInMegaBytes -> (двойное)

Количество мегабайтов, перенесенных в резервную копию снимка.

CurrentBackupRateInMegaBytesPerSecond -> (двойное)

Количество мегабайтов в секунду, передаваемых в резервную копию снимка. Возвращает 0 для завершенной резервной копии.

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

Ожидаемое время до завершения резервной копии снимка. Возвращает 0 для завершенной резервной копии.

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

Время работы резервной копии в процессе создания снимка или время завершения завершенной резервной копии.

SourceRegion -> (строка)

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

Tags -> (список)

Список тегов для снимка кластера.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

Key -> (строка)

Ключ или имя тега ресурса.

Value -> (строка)

Значение тега ресурса.

RestorableNodeTypes -> (список)

Список типов узлов, в которые можно восстановить этот снимок кластера.

(строка)

EnhancedVpcRouting -> (булево)

Параметр, указывающий, нужно ли создавать кластер с включенным расширенным маршрутизацией VPC. Для создания кластера с расширенной маршрутизацией VPC кластер должен находиться в VPC. Дополнительную информацию см. в разделе «Расширенная маршрутизация VPC» в Руководстве по администрированию кластеров Amazon Redshift.

Если этот параметр true, расширенная маршрутизация VPC включена.

По умолчанию: false

MaintenanceTrackName -> (строка)

Название отслеживания обслуживания для снимка.

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

Количество дней, в течение которых сохраняется ручной снимок. Если значение равно -1, ручной снимок сохраняется неопределенно.

Значение должно быть либо -1, либо целое число от 1 до 3653.

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

Количество дней до истечения срока действия ручного снимка.

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

Метка времени, представляющая начало срока хранения снимка.

MasterPasswordSecretArn -> (строка)

Amazon Resource Name (ARN) секрета учетных данных административного пользователя кластера.

MasterPasswordSecretKmsKeyId -> (строка)

Идентификатор ключа Key Management Service (KMS), используемого для шифрования и хранения секрета учетных данных административного пользователя кластера.

SnapshotArn -> (строка)

Amazon Resource Name (ARN) снимка.

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

Spec-Zone.ru

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