Spec-Zone.ru › AWS CLI v2

[ aws . snowball ]

describe-cluster

Описание

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

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

Синтаксис

  describe-cluster
--cluster-id <value>
[--cli-input-json | --cli-input-yaml]
[--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-id (строка)

Автоматически сгенерированный идентификатор кластера.

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

--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
  • таблица
  • 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.

Вывод

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

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

ClusterId -> (строка)

Автоматически сгенерированный идентификатор кластера.

Description -> (строка)

Необязательное описание кластера.

KmsKeyARN -> (строка)

KmsKeyARN Amazon Resource Name (ARN), связанный с этим кластером. Этот ARN был создан с помощью действия CreateKey API в службе управления ключами (KMS.

RoleARN -> (строка)

ARN роли, связанной с этим кластером. Этот ARN был создан с помощью действия CreateRole API в службе управления удостоверениями и доступом (IAM).

ClusterState -> (строка)

Текущее состояние кластера.

JobType -> (строка)

Тип задачи для этого кластера. В настоящее время для кластеров поддерживается только тип задачи LOCAL_USE .

SnowballType -> (строка)

Тип устройства Snowcone для использования в этом кластере.

Примечание

Для задач кластера Amazon Web Services Snow Family в настоящее время поддерживается только тип устройства EDGE.

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

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

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

Массивы объектов JobResource, которые могут включать обновленные объекты S3Resource или LambdaResource.

S3Resources -> (список)

Массив объектов S3Resource.

(структура)

Каждый объект S3Resource представляет собой ведро Amazon S3, из которого или в которое будет экспортироваться переносимые данные. Для задач экспорта этот объект может иметь необязательное значение KeyRange. Длина диапазона определяется при создании задачи и содержит либо включительную BeginMarker, либо включительную EndMarker, или обе. Диапазоны сортируются по двоичному представлению UTF-8.

BucketArn -> (строка)

Amazon Resource Name (ARN) ведра Amazon S3.

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

Для задач экспорта вы можете указать необязательный KeyRange в определенном ведре Amazon S3. Длина диапазона определяется при создании задачи и содержит либо включительную BeginMarker, либо включительную EndMarker, или обе. Диапазоны сортируются по двоичному представлению UTF-8.

BeginMarker -> (строка)

Ключ, определяющий начало необязательного диапазона ключей для задачи экспорта. Диапазоны включают ключ и сортируются по двоичному представлению UTF-8.

EndMarker -> (строка)

Ключ, определяющий конец необязательного диапазона ключей для задачи экспорта. Диапазоны включают ключ и сортируются по двоичному представлению UTF-8.

TargetOnDeviceServices -> (список)

Указывает службу или службы на устройстве Snow Family, из которой или в которую будут экспортироваться переносимые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System).

(структура)

Объект, представляющий службу или службы на устройстве Snow Family, из которой или в которую будут экспортироваться переносимые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System).

ServiceName -> (строка)

Указывает имя службы на устройстве Snow Family, из которой или в которую будут экспортироваться переносимые данные.

TransferOption -> (строка)

Указывает, импортируются или экспортируются данные, или они используются локально на устройстве.

LambdaResources -> (список)

Функции Python-языковых Lambda для этой задачи.

(структура)

Идентифицирует

LambdaArn -> (строка)

Amazon Resource Name (ARN), представляющий функцию Lambda, которая будет вызываться действиями PUT объекта в связанном локальном ресурсе Amazon S3.

EventTriggers -> (список)

Массив ARNs объектов S3Resource для вызова объектов LambdaResource, связанных с этой задачей.

(структура)

Контейнер для EventTriggerDefinition$EventResourceARN.

EventResourceARN -> (строка)

Amazon Resource Name (ARN) любого локального ресурса Amazon S3, который является триггером события функции Lambda, связанной с этой задачей.

Ec2AmiResources -> (список)

Amazon Machine Images (AMIs), связанные с этой задачей.

(структура)

Объект в формате JSON, содержащий идентификаторы Amazon Machine Image (AMI), включая идентификатор AMI, совместимый с Amazon EC2, и идентификатор AMI устройства Snow. Каждая AMI имеет эти два идентификатора для упрощения определения AMI как в облаке Amazon Web Services, так и на устройстве.

AmiId -> (строка)

Идентификатор AMI в Amazon EC2.

SnowballAmiId -> (строка)

Идентификатор AMI на устройстве Snow.

AddressId -> (строка)

Автоматически сгенерированный идентификатор конкретного адреса.

ShippingOption -> (строка)

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

  • В Австралии доступна экспресс-доставка. Как правило, устройства, отправленные экспресс-почтой, доставляются в течение примерно одного дня.
  • В Европейском союзе (ЕС) доступна экспресс-доставка. Как правило, устройства Snow, отправленные экспресс-почтой, доставляются примерно в течение одного дня. Кроме того, большинство стран ЕС имеют доступ к стандартной доставке, которая обычно занимает менее недели в одну сторону.
  • В Индии устройства Snow доставляются в течение одного-семи дней.
  • В США доступна доставка в течение одного дня и в течение двух дней.

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

Настройки уведомлений Amazon Simple Notification Service (Amazon SNS) для этого кластера.

SnsTopicARN -> (строка)

Новый SNS TopicArn, который вы хотите связать с этой задачей. Вы можете создавать Amazon Resource Names (ARN) для тем, используя действие CreateTopic API Amazon SNS.

Вы можете подписывать адреса электронной почты на тему Amazon SNS с помощью консоли управления Amazon Web Services или с помощью действия Subscribe API Amazon Simple Notification Service (Amazon SNS).

JobStatesToNotify -> (список)

Список состояний задачи, которые будут вызывать уведомление для этой задачи.

(строка)

NotifyAll -> (булево)

Любое изменение состояния задачи вызовет уведомление для этой задачи.

DevicePickupSnsTopicARN -> (строка)

Используется для отправки уведомлений SNS лицу, забирающему устройство (определенному при создании задачи).

ForwardingAddressId -> (строка)

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

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

Налоговые документы, необходимые в вашем регионе Amazon Web Services.

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

Налоговые документы, необходимые в регионе Amazon Web Services в Индии.

GSTIN -> (строка)

Налоговые документы по товарам и услугам (GST), необходимые в регионе Amazon Web Services в Индии.

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

Представляет метаданные и настройки служб на устройстве Amazon Web Services Snow Family.

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

Представляет службу NFS (Network File System) на устройстве Snow Family.

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

Максимальный размер хранилища NFS для одного устройства Snow Family.

StorageUnit -> (строка)

Единица измерения масштаба хранилища NFS на устройстве.

Допустимые значения: TB.

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

Представляет службу Storage Gateway типа Tape Gateway на устройстве Snow Family.

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

Максимальное количество виртуальных лент для хранения на одном устройстве Snow Family. Из-за ограничений физических ресурсов это значение должно быть установлено в 80 для Snowball Edge.

StorageUnit -> (строка)

Единица измерения масштаба виртуальных лент на устройстве.

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

Настройки EKS Anywhere на устройстве Snow Family.

KubernetesVersion -> (строка)

Версия Kubernetes для EKS Anywhere на устройстве Snow Family.

EKSAnywhereVersion -> (строка)

Необязательная версия EKS Anywhere на устройстве Snow Family.

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

Настройки для Amazon S3 совместимого хранилища на устройствах Snow family.

StorageLimit -> (двойное число)

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

StorageUnit -> (строка)

Единица измерения хранилища. В настоящее время поддерживается только единица TB.

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

Применимо при создании кластера. Указывает, сколько узлов требуется для Amazon S3 совместимого хранилища на устройствах Snow family. Если указано, другие входные данные могут быть опущены.

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

>Уровень отказоустойчивости кластера. Это указывает на количество узлов, которые могут выйти из строя, не ухудшая производительности кластера. Эти дополнительные входные данные помогают, когда указанное StorageLimit соответствует более чем одной конфигурации Amazon S3 совместимого хранилища на устройствах Snow family.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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