list-kx-clusters
Описание
Возвращает список кластеров.
См. также: Документацию API AWS
Синтаксис
list-kx-clusters
--environment-id <value>
[--cluster-type <value>]
[--max-results <value>]
[--next-token <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 (строка)
--cluster-type (строка)
Указывает тип базы данных KDB, которая создается. Доступны следующие типы:
- HDB – Историческая база данных. Данные доступны только для чтения из одной из управляемых FinSpace баз данных kdb, подключенных к кластеру.
- RDB – База данных в реальном времени. Этот тип базы данных собирает все данные с центра обработки тикеров и хранит их в памяти до конца дня, после чего записывает все данные на диск и перезагружает HDB. Для этого типа кластера требуется локальное хранилище для временного хранения данных во время процесса сохранения. Если вы указываете это поле в запросе, вы должны предоставить параметр
savedownStorageConfiguration. - GATEWAY – Кластер шлюза позволяет получить доступ к данным через процессы в системах kdb. Он позволяет создавать собственную логику маршрутизации с использованием скриптов инициализации и пользовательского кода. Для этого типа кластера не требуется локальное хранилище для записи.
- GP – Кластер общего назначения позволяет быстро итерировать код во время разработки, предоставив больший доступ к системным командам и ускоренную перезагрузку пользовательского кода. Этот тип кластера может по желанию подключать базы данных, включая кеш и хранилище сохранения. Для этого типа кластера количество узлов фиксировано и равно 1. Он не поддерживает автоматическое масштабирование и поддерживает только режим
SINGLEAZ. - Tickerplant – Кластер tickerplant позволяет подписываться на обработчики данных на основе разрешений IAM. Он может публиковать данные в RDB, другие tickerplant и подписчиков в реальном времени (RTS). Tickerplant могут сохранять сообщения в журнал, который доступен для любой среды RDB. Он поддерживает только единственный узел, представляющий собой один процесс kdb.
Возможные значения:
HDBRDBGATEWAYGPTICKERPLANT
--max-results (целое число)
--next-token (строка)
--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 (строка)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружаться, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с корневым сертификатом для проверки сертификатов 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.
Вывод
kxClusterSummaries -> (список)
Отображает подробности кластера.
(структура)
Подробности кластера kdb.
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. Он не поддерживает автоматическое масштабирование и поддерживает только режим
SINGLEAZ. - Tickerplant – Кластер tickerplant позволяет подписываться на обработчики данных на основе разрешений IAM. Он может публиковать данные в RDB, другие tickerplant и подписчиков в реальном времени (RTS). Tickerplant могут сохранять сообщения в журнал, который доступен для любой среды RDB. Он поддерживает только единственный узел, представляющий собой один процесс kdb.
clusterDescription -> (строка)
releaseLabel -> (строка)
volumes -> (список)
Список объемов, подключенных к кластеру.
(структура)
Структура, которая состоит из имени и типа объема.
volumeName -> (строка)
volumeType -> (строка)
NAS_1.initializationScript -> (строка)
somedir/init.q.executionRole -> (строка)
azMode -> (строка)
Количество зон доступности, назначаемых на кластер. Это может быть одно из следующих:
-
SINGLE– Назначает одну зону доступности на кластер. -
MULTI– Назначает все зоны доступности на кластер.
availabilityZoneId -> (строка)
lastModifiedTimestamp -> (временная метка)
createdTimestamp -> (временная метка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.