Spec-Zone.ru › AWS CLI v2

[ aws . нептун ]

describe-db-cluster-snapshots

Описание

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

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

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

Синтаксис

  describe-db-cluster-snapshots
[--db-cluster-identifier <value>]
[--db-cluster-snapshot-identifier <value>]
[--snapshot-type <value>]
[--filters <value>]
[--include-shared | --no-include-shared]
[--include-public | --no-include-public]
[--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]

Параметры

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

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

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

  • Если указан, должен соответствовать идентификатору существующего DBCluster.

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

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

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

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

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

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

  • automated - Возвращает все моментальные снимки кластера баз данных, автоматически созданные Amazon Neptune для моей учетной записи Amazon.
  • manual - Возвращает все моментальные снимки кластера баз данных, созданные моей учетной записью Amazon.
  • shared - Возвращает все ручные моментальные снимки кластера баз данных, которые были предоставлены для моей учетной записи Amazon.
  • public - Возвращает все моментальные снимки кластера баз данных, помеченные как общедоступные.

Если вы не указываете значение SnapshotType, возвращаются как автоматические, так и ручные моментальные снимки кластера баз данных. Вы можете включить предоставленные моментальные снимки кластера баз данных в эти результаты, установив параметр IncludeShared в значение true. Вы можете включить общедоступные моментальные снимки кластера баз данных в эти результаты, установив параметр IncludePublic в значение true.

Параметры IncludeShared и IncludePublic не применяются для значений SnapshotType manual или automated. Параметр IncludePublic не применяется, когда SnapshotType установлено в shared. Параметр IncludeShared не применяется, когда SnapshotType установлено в public.

--filters (список)

Этот параметр в настоящее время не поддерживается.

(структура)

Этот тип в настоящее время не поддерживается.

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

Этот параметр в настоящее время не поддерживается.

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

Этот параметр в настоящее время не поддерживается.

(строка)

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

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

Синтаксис JSON:

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

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

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

Вы можете предоставить учетной записи Amazon разрешение на восстановление ручного моментального снимка кластера баз данных из другой учетной записи Amazon с помощью действия API ModifyDBClusterSnapshotAttribute.

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

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

Вы можете предоставить моментальному снимку кластера баз данных статус «общедоступный» с помощью действия API ModifyDBClusterSnapshotAttribute.

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

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

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

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

Отключить автоматическую запрос параметров CLI.

Вывод

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

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

DBClusterSnapshots -> (список)

Предоставляет список снимков баз данных DB кластеров для пользователя.

(структура)

Содержит подробную информацию о снимке Amazon Neptune DB кластера.

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

AvailabilityZones -> (список)

Предоставляет список зон доступности EC2, в которых можно восстановить экземпляры в снимке DB кластера.

(строка)

DBClusterSnapshotIdentifier -> (строка)

Указывает идентификатор снимка DB кластера. Должен соответствовать идентификатору существующего снимка.

После восстановления DB кластера с помощью DBClusterSnapshotIdentifier, вы должны указать тот же DBClusterSnapshotIdentifier для любых будущих обновлений DB кластера. При указании этого свойства для обновления DB кластер не восстанавливается из снимка повторно, и данные в базе данных не изменяются.

Однако, если вы не укажете DBClusterSnapshotIdentifier, будет создан пустой DB кластер, а исходный DB кластер будет удален. Если вы укажете свойство, отличное от свойства предыдущего восстановления из снимка, DB кластер восстанавливается из снимка, указанного в DBClusterSnapshotIdentifier, а исходный DB кластер удаляется.

DBClusterIdentifier -> (строка)

Указывает идентификатор DB кластера, из которого был создан данный снимок DB кластера.

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

Предоставляет время создания снимка в формате UTC (всемирное координированное время).

Engine -> (строка)

Указывает имя движка базы данных.

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

Указывает размер выделенного хранилища в гигабайтах (GiB).

Status -> (строка)

Указывает состояние снимка DB кластера.

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

Указывает порт, на котором DB кластер прослушивал запросы на момент создания снимка.

VpcId -> (строка)

Предоставляет идентификатор VPC, связанный со снимком DB кластера.

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

Указывает время создания DB кластера в формате UTC (всемирное координированное время).

MasterUsername -> (строка)

Не поддерживается Neptune.

EngineVersion -> (строка)

Предоставляет версию движка базы данных для данного снимка DB кластера.

LicenseModel -> (строка)

Предоставляет информацию о лицензионной модели для этого снимка DB кластера.

SnapshotType -> (строка)

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

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

Указывает процент данных, которые были перенесены.

StorageEncrypted -> (булево)

Указывает, зашифрован ли снимок DB кластера.

KmsKeyId -> (строка)

Если значение StorageEncrypted равно true, это идентификатор ключа Amazon KMS для зашифрованного снимка DB кластера.

DBClusterSnapshotArn -> (строка)

Amazon Resource Name (ARN) снимка DB кластера.

SourceDBClusterSnapshotArn -> (строка)

Если снимок DB кластера скопирован со снимка исходного DB кластера, это Amazon Resource Name (ARN) исходного снимка DB кластера, иначе — значение null.

IAMDatabaseAuthenticationEnabled -> (булево)

True, если сопоставление учетных записей Amazon Identity and Access Management (IAM) с учетными записями базы данных включено, и false в противном случае.

StorageType -> (строка)

Тип хранилища, связанный со снимком DB кластера.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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