get-kx-cluster

Описание

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

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

Синтаксис

  get-kx-cluster
--environment-id <value>
--cluster-name <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]

Параметры

--environment-id (строка)

Уникальный идентификатор среды kdb.

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

Имя кластера, который требуется получить.

--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
table
yaml
yaml-stream

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

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

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

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

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

Вывод

status -> (строка)

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

PENDING – Кластер ожидает создания.
CREATING – Процесс создания кластера в процессе.
CREATE_FAILED – Процесс создания кластера завершился неудачей.
RUNNING – Процесс создания кластера выполняется.
UPDATING – Кластер обновляется.
DELETING – Кластер удаляется.
DELETED – Кластер удалён.
DELETE_FAILED – Удаление кластера не удалось.

statusReason -> (строка)

Сообщение об ошибке при возникновении состояния ошибки.

clusterName -> (строка)

Уникальное имя кластера.

clusterType -> (строка)

Определяет тип базы данных KDB, которая создаётся. Доступны следующие типы:

HDB – Историческая база данных. Доступ к данным возможен только с правами на чтение из одной из управляемых FinSpace баз данных kdb, подключённых к кластеру.
RDB – Режим реального времени. Этот тип базы данных собирает все данные с тикера и хранит их в памяти до конца дня, после чего записывает все данные на диск и перезагружает HDB. Этот тип кластера требует локального хранилища для временного хранения данных во время процесса сохранения. Если вы указываете это поле в своём запросе, вы должны предоставить параметр savedownStorageConfiguration.
GATEWAY – Кластер шлюза позволяет вам получить доступ к данным между процессами в системах kdb. Он позволяет создавать собственную логику маршрутизации с использованием скриптов инициализации и пользовательского кода. Этот тип кластера не требует локального хранилища с возможностью записи.
GP – Кластер общего назначения позволяет быстро итерировать код во время разработки, предоставляя больший доступ к системным командам и ускоряя перезагрузку пользовательского кода. Этот тип кластера может дополнительно подключать базы данных, включая кэш и хранилище сохранения. Для этого типа кластера количество узлов фиксировано в 1. Он не поддерживает автоматическое масштабирование и поддерживает только режим SINGLE AZ.
Tickerplant – Кластер тикера позволяет подписываться на обработчики данных на основе прав IAM. Он может публиковать в RDB, другие кластеры Tickerplant и подписчиков реального времени (RTS). Tickerplant может сохранять сообщения в журнал, который может быть прочитан любой средой RDB. Он поддерживает только одноузловой кластер, представляющий собой только один процесс kdb.

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

Настройка для хранения журналов Tickerplant. Она состоит из списка томов, которые будут подключены к вашему кластеру. Для кластера типа Tickerplant, расположение тома TP в кластере будет доступно с помощью глобальной переменной .aws.tp_log_path.

tickerplantLogVolumes -> (список)

Имя томов для журналов tickerplant.

(строка)

volumes -> (список)

Список томов, подключённых к кластеру.

(структура)

Структура, содержащая имя и тип тома.

volumeName -> (строка)

Уникальный идентификатор тома.

volumeType -> (строка)

Тип файловой системы тома. В настоящее время FinSpace поддерживает только тип тома NAS_1.

databases -> (список)

Список баз данных, подключённых к кластеру.

(структура)

Настройка данных, доступных для запросов из этой базы данных.

databaseName -> (строка)

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

cacheConfigurations -> (список)

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

(структура)

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

cacheType -> (строка)

Тип кэша диска. Этот параметр используется для сопоставления пути базы данных с хранилищем кэша. Допустимые значения:

CACHE_1000 – Этот тип обеспечивает пропускную способность доступа к диску не менее 1000 МБ/с.

dbPaths -> (список)

Указывает части базы данных, которые будут загружены в кэш для доступа.

(строка)

dataviewName -> (строка)

Имя представления данных, используемого для кэширования исторических данных на диске.

changesetId -> (строка)

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

dataviewName -> (строка)

Имя представления данных, используемого для кэширования исторических данных на диске.

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

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

dataviewName -> (строка)

Уникальный идентификатор представления данных.

dataviewVersionId -> (строка)

Версия представления данных, соответствующая заданному изменению.

changesetId -> (строка)

Уникальный идентификатор изменения.

segmentConfigurations -> (список)

Путь базы данных и конфигурация тома для сегментированной базы данных.

(структура)

Настройка, содержащая путь к базе данных данных, которую вы хотите разместить на каждом выбранном томе. Каждый сегмент должен иметь уникальный путь к базе данных для каждого тома. Если вы не укажете явно путь к базе данных для тома, они доступны из кластера через сегмент по умолчанию S3/хранилище объектов.

dbPaths -> (список)

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

(строка)

volumeName -> (строка)

Имя тома, куда вы хотите добавить данные.

onDemand -> (логическое значение)

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

cacheStorageConfigurations -> (список)

Настройки для хранилища кэша только для чтения, связанного с кластером. Этот кэш будет храниться как FSx Lustre, который читает из хранилища S3.

(структура)

Настройка кэша только для чтения на диске, связанного с кластером.

type -> (строка)

Тип хранилища кэша. Допустимые значения:

CACHE_1000 – Этот тип обеспечивает пропускную способность доступа к диску не менее 1000 МБ/с.
CACHE_250 – Этот тип обеспечивает пропускную способность доступа к диску не менее 250 МБ/с.
CACHE_12 – Этот тип обеспечивает пропускную способность доступа к диску не менее 12 МБ/с.

Для типов кэша CACHE_1000 и CACHE_250 вы можете выбрать размер кэша 1200 ГБ или приращения по 2400 ГБ. Для типа кэша CACHE_12 вы можете выбрать размер кэша в приращениях по 6000 ГБ.

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

Размер кэша в гигабайтах.

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

Настройка, на основании которой FinSpace будет масштабировать узлы в вашем кластере.

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

Минимальное количество узлов для масштабирования. Это значение должно быть не менее 1 и меньше maxNodeCount. Если узлы в кластере принадлежат нескольким зонам доступности, то minNodeCount должно быть не менее 3.

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

Максимальное количество узлов для масштабирования. Это значение не может быть больше 5.

autoScalingMetric -> (строка)

Метрика, которую ваш кластер отслеживает для масштабирования. Например, CPU_UTILIZATION_PERCENTAGE — среднее использование ЦП на всех узлах кластера.

metricTarget -> (вещественное число)

Желаемое значение выбранной autoScalingMetric. Когда метрика падает ниже этого значения, кластер масштабируется внутрь. Когда метрика поднимается выше этого значения, кластер масштабируется наружу. Вы можете установить целевое значение между 1 и 100 процентами.

scaleInCooldownSeconds -> (вещественное число)

Продолжительность в секундах, которую FinSpace будет ждать после события масштабирования внутрь, прежде чем инициировать другое событие масштабирования.

scaleOutCooldownSeconds -> (вещественное число)

Продолжительность в секундах, которую FinSpace будет ждать после события масштабирования наружу, прежде чем инициировать другое событие масштабирования.

clusterDescription -> (строка)

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

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

Структура метаданных кластера. Она включает информацию о необходимых ЦП, памяти экземпляров и количестве экземпляров.

nodeType -> (строка)

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

Вы можете указать только одно из следующих значений:

kx.s.large – Тип узла с конфигурацией 12 ГБ памяти и 2 виртуальных процессоров.
kx.s.xlarge – Тип узла с конфигурацией 27 ГБ памяти и 4 виртуальных процессоров.
kx.s.2xlarge – Тип узла с конфигурацией 54 ГБ памяти и 8 виртуальных процессоров.
kx.s.4xlarge – Тип узла с конфигурацией 108 ГБ памяти и 16 виртуальных процессоров.
kx.s.8xlarge – Тип узла с конфигурацией 216 ГБ памяти и 32 виртуальных процессоров.
kx.s.16xlarge – Тип узла с конфигурацией 432 ГБ памяти и 64 виртуальных процессоров.
kx.s.32xlarge – Тип узла с конфигурацией 864 ГБ памяти и 128 виртуальных процессоров.

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

Количество экземпляров, запущенных в кластере.

releaseLabel -> (строка)

Версия управляемой FinSpace базы данных kdb для запуска.

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

Подробная информация о сети, где находится конечная точка Privatelink кластера.

vpcId -> (строка)

Идентификатор конечной точки VPC.

securityGroupIds -> (список)

Уникальный идентификатор группы безопасности VPC, применённой к конечной точке VPC ENI для кластера.

(строка)

subnetIds -> (список)

Идентификатор подсети, которую конечная точка VPC Privatelink использует для подключения к кластеру.

(строка)

ipAddressType -> (строка)

Тип IP-адреса для параметров конфигурации сети кластера. Доступен следующий тип:

IP_V4 – IP-адрес версии 4

initializationScript -> (строка)

Указывает программу Q, которая будет запущена при запуске кластера. Это относительный путь внутри файла .zip, содержащего пользовательский код, который будет загружен в кластер. Он должен включать само имя файла. Например, somedir/init.q.

commandLineArguments -> (список)

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

(структура)

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

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

Имя ключа.

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

Значение ключа.

код -> (структура)

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

s3Bucket -> (строка)

Уникальное имя ведра S3.

s3Key -> (строка)

Полный путь S3 (без ведра) к файлу .zip. Этот файл содержит код, который загружается в кластер при его запуске.

s3ObjectVersion -> (строка)

Версия объекта S3.

executionRole -> (строка)

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

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

Последнее время изменения кластера. Значение определяется как время эпохи в миллисекундах. Например, значение для понедельника, 1 ноября 2021 года, 12:00:00 по UTC составляет 1635768000000.

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

Размер и тип временного хранилища, используемого для хранения данных во время процесса savedown. Этот параметр требуется, когда вы выбираете clusterType в качестве RDB. Все данные, записанные в это хранилище, будут потеряны при перезапуске узла кластера.

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

Тип доступного хранилища для временного хранения данных savedown. Допустимые значения:

SDS01 – Этот тип представляет 3000 IOPS и тип тома io2 ebs.

размер -> (целое число)

Размер временного хранилища в гигабайтах.

volumeName -> (строка)

Имя тома kdb, которое вы хотите использовать в качестве хранилища для сохранения данных кластеров.

azMode -> (строка)

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

SINGLE – Назначает одну доступную зону на кластер.
MULTI – Назначает все доступные зоны на кластер.

availabilityZoneId -> (строка)

Идентификаторы доступных зон для запрошенных регионов.

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

Отметка времени создания кластера в FinSpace. Значение определяется как время эпохи в миллисекундах. Например, значение для понедельника, 1 ноября 2021 года, 12:00:00 по UTC составляет 1635768000000.

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

Структура, хранящая сведения о конфигурации ёмкости группы масштабирования.

scalingGroupName -> (строка)

Уникальный идентификатор группы масштабирования kdb.

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

Необязательное жёсткое ограничение на объём памяти, который может использовать кластер kdb.

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

Зарезервированный минимальный объём памяти, который должен быть доступен в группе масштабирования для успешного размещения кластера kdb в группе масштабирования.

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

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

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

Количество vCPU, которые вы хотите зарезервировать для каждого узла этого кластера kdb в хосте группы масштабирования.