Spec-Zone.ru › AWS CLI v2

[ aws . cloudhsmv2 ]

describe-clusters

Описание

Получает информацию о кластерах CloudHSM.

Это операция с постраничной загрузкой, что означает, что каждый ответ может содержать только подмножество всех кластеров. Когда ответ содержит только подмножество кластеров, он включает значение NextToken. Используйте это значение в последующем запросе DescribeClusters, чтобы получить больше кластеров. Когда вы получаете ответ без NextToken (или пустое или null значение), это означает, что больше кластеров получить нельзя.

Использование между аккаунтами: Нет. Вы не можете выполнить эту операцию с кластерами CloudHSM в другом аккаунте Amazon Web Services.

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

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

Синтаксис

  describe-clusters
[--filters <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]

Параметры

--filters (карта)

Один или несколько фильтров для ограничения элементов, возвращаемых в ответе.

Используйте фильтр clusterIds, чтобы вернуть только указанные кластеры. Укажите кластеры по их идентификатору (ID).

Используйте фильтр vpcIds, чтобы вернуть только кластеры в указанных виртуальных частных облаках (VPC). Укажите VPC по их идентификатору (ID).

Используйте фильтр states, чтобы вернуть только кластеры, соответствующие указанному состоянию.

ключ -> (строка)

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

(строка)

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

KeyName1=string,string,KeyName2=string,string

Синтаксис JSON:

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

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

Вывод

Кластеры -> (список)

Список кластеров.

(структура)

Содержит информацию о кластере CloudHSM.

BackupPolicy -> (строка)

Политика резервного копирования кластера.

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

Политика, определяющая, как служба сохраняет резервные копии.

Тип -> (строка)

Тип политики сохранения резервных копий. Для типа DAYS значение представляет количество дней сохранения резервных копий.

Значение -> (строка)

Используйте значение от 7 до 379.

ClusterId -> (строка)

Идентификатор (ID) кластера.

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

Дата и время создания кластера.

Hsms -> (список)

Содержит информацию об HSM в кластере.

(структура)

Содержит информацию о модуле аппаратной защиты (HSM) в кластере CloudHSM.

AvailabilityZone -> (строка)

Доступная зона, содержащая HSM.

ClusterId -> (строка)

Идентификатор (ID) кластера, содержащего HSM.

SubnetId -> (строка)

Подсеть, содержащая эластичный сетевой интерфейс (ENI) HSM.

EniId -> (строка)

Идентификатор (ID) эластичного сетевого интерфейса (ENI) HSM.

EniIp -> (строка)

IP-адрес эластичного сетевого интерфейса (ENI) HSM.

EniIpV6 -> (строка)

IPv6-адрес (при наличии) эластичного сетевого интерфейса (ENI) HSM.

HsmId -> (строка)

Идентификатор (ID) HSM.

HsmType -> (строка)

Тип HSM.

Состояние -> (строка)

Состояние HSM.

Сообщение о состоянии -> (строка)

Описание состояния HSM.

HsmType -> (строка)

Тип HSM, содержащийся в кластере.

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

Метка времени до которого можно откатить тип HSM кластера к исходному.

PreCoPassword -> (строка)

Пароль по умолчанию для пользователя Pre-Crypto Officer (PRECO) кластера.

SecurityGroup -> (строка)

Идентификатор (ID) группы безопасности кластера.

SourceBackupId -> (строка)

Идентификатор (ID) резервной копии, используемой для создания кластера. Это значение существует только в случае создания кластера из резервной копии.

Состояние -> (строка)

Состояние кластера.

Сообщение о состоянии -> (строка)

Описание состояния кластера.

SubnetMapping -> (карта)

Карта, отображающая доступную зону и подсеть кластера в этой доступной зоне.

ключ -> (строка)

значение -> (строка)

VpcId -> (строка)

Идентификатор (ID) виртуальной частной сети (VPC), содержащей кластер.

NetworkType -> (строка)

NetworkType кластера может быть IPv4 (по умолчанию) или DUALSTACK. NetworkType IPv4 ограничивает общение между вашим приложением и модулями аппаратной защиты (HSM) только протоколом IPv4. NetworkType DUALSTACK позволяет использовать протоколы IPv4 и IPv6. Чтобы использовать DUALSTACK, настройте виртуальную частную сеть (VPC) и подсети для поддержки как IPv4, так и IPv6. Это включает добавление блоков IPv6 CIDR к существующим блокам IPv4 CIDR в ваших подсетях. Выбранный NetworkType влияет на параметры адресации сети для вашего кластера. DUALSTACK обеспечивает большую гибкость, поддерживая как IPv4, так и IPv6 общение.

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

Содержит один или несколько сертификатов или запрос на подписание сертификата (CSR).

ClusterCsr -> (строка)

Запрос на подписание сертификата (CSR) кластера. CSR существует только, когда состояние кластера - UNINITIALIZED.

HsmCertificate -> (строка)

Сертификат HSM, выпущенный (подписанный) аппаратным обеспечением HSM.

AwsHardwareCertificate -> (строка)

Сертификат аппаратного обеспечения HSM, выпущенный (подписанный) CloudHSM.

ManufacturerHardwareCertificate -> (строка)

Сертификат аппаратного обеспечения HSM, выпущенный (подписанный) производителем оборудования.

ClusterCertificate -> (строка)

Сертификат кластера, выпущенный (подписанный) центром сертификации (CA) владельца кластера.

TagList -> (список)

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

(структура)

Содержит тег. Тег — это пара ключ-значение.

Ключ -> (строка)

Ключ тега.

Значение -> (строка)

Значение тега.

Режим -> (строка)

Режим кластера.

NextToken -> (строка)

Непрозрачная строка, указывающая, что ответ содержит только подмножество кластеров. Используйте это значение в последующем запросе DescribeClusters, чтобы получить больше кластеров.

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

Spec-Zone.ru

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