Operations

Получение узлов кластера

GET /clusters/{cluster}/nodes

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер для запроса	строка
Запрос	operation необязательный параметр	Если задано, возвращает только узлы для этого идентификатора операции и включает атрибут операции в тексте.	строка
Запрос	request_id необязательный параметр	Если задано значение , возвращает только узлы для операции, определяемые этим идентификатором запроса. и включает атрибут операции в тексте	строка

Ответы

Код HTTP	Описание	схема
200	ОК	NodeList
400	Недопустимая спецификация	Нет содержимого
404	Не найдено	Нет содержимого

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/nodes

Пример HTTP-ответа

Ответ 200

{
  "nodes" : [ { } ],
  "operation" : {
    "action" : "string",
    "startTime" : "2020-01-01T12:34:56Z"
  }
}

Создание узлов кластера

POST /clusters/{cluster}/nodes/create

Описание

Эта операция добавляет новые узлы из nodearray в кластер. Он принимает несколько определений узлов в одном вызове. Он возвращает URL-адрес операции, который можно использовать для отслеживания состояния операции.

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер, в который добавляются узлы	строка
Текст	узлы обязательный параметр	Наборы создаваемых узлов	NodeCreationRequest

Ответы

Код HTTP	Описание	схема
202	Принято Заголовки : Location (string) : URL-адрес для операции.	NodeCreationResult
409	недопустимые входные данные	Нет содержимого

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/nodes/create

Текст запроса

{
  "requestId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Пример HTTP-ответа

Ответ 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Освобождение узлов кластера

POST /clusters/{cluster}/nodes/deallocate

Описание

Эта операция освобождает узлы в кластере. Узлы можно определить несколькими способами, включая имя узла, идентификатор узла или фильтр.

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер для освобождения узлов	строка
Текст	action обязательный параметр	Описание узлов для освобождения	NodeManagementRequest

Ответы

Код HTTP	Описание	схема
202	Принято Заголовки : Location (string) : URL-адрес для операции.	NodeManagementResult
409	недопустимые входные данные	Нет содержимого

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/nodes/deallocate

Текст запроса

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Пример HTTP-ответа

Ответ 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Завершение работы и удаление узлов кластера

POST /clusters/{cluster}/nodes/remove

Описание

Эта операция удаляет узлы в кластере. Узлы можно определить несколькими способами, включая имя узла, идентификатор узла или фильтр. Обратите внимание, что по умолчанию узлы удаляются при завершении работы (если только для узла не задано значение Фиксированное значение true). В этом случае этот вызов не отличается от завершения.

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер для удаления узлов	строка
Текст	action обязательный параметр	Описание удаляемых узлов	NodeManagementRequest

Ответы

Код HTTP	Описание	схема
202	Принято Заголовки : Location (string) : URL-адрес для операции.	NodeManagementResult
409	недопустимые входные данные	Нет содержимого

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/nodes/remove

Текст запроса

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Пример HTTP-ответа

Ответ 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Завершение или отмена выделения узлов кластера

POST /clusters/{cluster}/nodes/shutdown

Описание

Эта операция завершает или отменяет выделение узлов в кластере в зависимости от того, имеет ли атрибут ShutdownPolicy на каждом узле значение Terminate (по умолчанию) или Deallocate соответственно.

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер для завершения работы узлов	строка
Текст	action обязательный параметр	Описание узлов для завершения работы	NodeManagementRequest

Ответы

Код HTTP	Описание	схема
202	Принято Заголовки : Location (string) : URL-адрес для операции.	NodeManagementResult
409	недопустимые входные данные	Нет содержимого

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/nodes/shutdown

Текст запроса

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Пример HTTP-ответа

Ответ 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Запуск освобожденных или завершенных узлов кластера

POST /clusters/{cluster}/nodes/start

Описание

Эта операция запускает узлы в кластере. Узлы можно определить несколькими способами, включая имя узла, идентификатор узла или фильтр.

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер для запуска узлов	строка
Текст	action обязательный параметр	Описание узлов для запуска	NodeManagementRequest

Ответы

Код HTTP	Описание	схема
202	Принято Заголовки : Location (string) : URL-адрес операции.	NodeManagementResult
409	недопустимые входные данные	Нет содержимого

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/nodes/start

Текст запроса

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Пример HTTP-ответа

Ответ 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Завершение работы узлов кластера

POST /clusters/{cluster}/nodes/terminate

Описание

Эта операция завершает работу узлов в кластере. Узлы можно идентифицировать несколькими способами, включая имя узла, идентификатор узла или фильтр.

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер, в который должны быть завершены узлы	строка
Текст	action обязательный параметр	Описание завершаемых узлов	NodeManagementRequest

Ответы

Код HTTP	Описание	схема
202	Принято Заголовки : Location (string) : URL-адрес операции.	NodeManagementResult
409	недопустимые входные данные	Нет содержимого

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/nodes/terminate

Текст запроса

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

Пример HTTP-ответа

Ответ 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

Масштабирование кластера по размеру

POST /clusters/{cluster}/scale/{nodearray}

Описание

Эта операция добавляет узлы по мере необходимости в объект nodearray для получения общего количества. Запрос обрабатывается один раз и не добавляет узлы повторно для сохранения заданного числа. Это масштабируется на общее количество ядер или общее количество узлов, но не на оба. Он возвращает URL-адрес операции, которую можно использовать для отслеживания состояния операции.

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер, в который добавляются узлы	строка
Путь	nodearray обязательный параметр	Объект nodearray для добавления узлов	строка
Запрос	totalCoreCount необязательный параметр	Общее количество ядер, имеющихся в этом экземпляре nodearray, включая уже созданные узлы	Целое число
Запрос	totalNodeCount необязательный параметр	Общее количество компьютеров, имеющихся в этом узле, включая уже созданные узлы.	Целое число

Ответы

Код HTTP	Описание	схема
202	Принято Заголовки : Location (string) : URL-адрес операции.	NodeCreationResult
409	недопустимые входные данные	Нет содержимого

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Пример HTTP-ответа

Ответ 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

Получение сведений о состоянии кластера

GET /clusters/{cluster}/status

Описание

Эта операция содержит сведения для узлов и объектов nodearray в заданном кластере. Для каждого объекта nodearray он возвращает состояние каждого "сегмента" выделения, которое можно использовать, например количество узлов в контейнере, количество дополнительных узлов, которые можно добавить и т. д. Каждый контейнер — это набор возможных виртуальных машин с заданным профилем оборудования, которые можно создать в определенном расположении, под определенной учетной записью клиента и т. д. Допустимые контейнеры для объекта nodearray определяются определением кластера пользователя, но ограничения частично определяются поставщиком облачных служб.

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер для запроса	строка
Запрос	узлы необязательный параметр	Если задано значение true, в ответе возвращаются ссылки на узлы и узлы.	Логическое

Ответы

Код HTTP	Описание	схема
200	ОК	ClusterStatus

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/status

Пример HTTP-ответа

Ответ 200

{
  "maxCoreCount" : 16,
  "maxCount" : 4,
  "nodearrays" : [ "object" ],
  "nodes" : [ { } ],
  "state" : "Starting",
  "targetState" : "Started"
}

Получение сведений об использовании и необязательных затратах для кластера

GET /clusters/{cluster}/usage

Описание

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

Параметры

Тип	Имя	Описание	схема
Путь	cluster обязательный параметр	Кластер для возврата данных об использовании	строка
Запрос	timeframe необязательный параметр	Если этот параметр задан, он указывает диапазон времени, используемый для запроса. monthToDate возвращает данные об использовании за текущий месяц, а lastMonth — за предыдущий месяц. weekToDate возвращает данные об использовании за текущую неделю (начиная с воскресенья). для custom требуются параметры запроса "from" и "to". Значение по умолчанию — MonthToDate. Все значения времени указаны в формате UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Запрос	from необязательный параметр	Для пользовательских временных интервалов это начало периода времени в формате ISO-8601. Округляется до ближайшего часа или дня.	строка
Запрос	to необязательный параметр	Для пользовательских временных интервалов это конец периода в формате ISO-8601. Округляется до ближайшего часа или дня.	строка
Запрос	Гранулярности необязательный параметр	Указывает способ агрегирования данных: по часам, дням или в виде одного числа. По умолчанию используется ежедневно.	enum (total, daily, hourly)

Ответы

Код HTTP	Описание	схема
200	ОК	ClusterUsage

Пример HTTP-запроса

Путь запроса

/clusters/CLUSTER_NAME/usage

Пример HTTP-ответа

Ответ 200

{
  "usage" : [ "object" ]
}

Списки состояние операций

GET /operations/

Параметры

Тип	Имя	Описание	схема
Запрос	request_id необязательный параметр	Идентификатор запроса для операции. Если этот параметр задан, список будет содержать только 0 или 1 элемент.	строка

Ответы

Код HTTP	Описание	схема
200	ОК	<OperationStatus> Массива
400	Недопустимый запрос	Нет содержимого
404	Не найдено	Нет содержимого

Пример HTTP-запроса

Путь запроса

/operations/

Пример HTTP-ответа

Ответ 200

[ {
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
} ]

Возвращает состояние операции по идентификатору.

GET /operations/{id}

Параметры

Тип	Имя	Описание	схема
Путь	идентификатор обязательный параметр	Идентификатор операции	строка

Ответы

Код HTTP	Описание	схема
200	ОК	OperationStatus
404	Не найдено	Нет содержимого

Пример HTTP-запроса

Путь запроса

/operations/00000000-0000-0000-0000-000000000000

Пример HTTP-ответа

Ответ 200

{
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
}

Ресурсы

ClusterStatus

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

Имя	Описание	схема
maxCoreCount обязательный параметр	Максимальное количество ядер, которые могут быть добавлены в этот кластер Пример : 16	Целое число
maxCount обязательный параметр	Максимальное число узлов, которые могут быть добавлены в этот кластер. Пример : 4	Целое число
nodearrays обязательный параметр	Пример : [ "object" ]	<nodearrays> Массива
узлы необязательный параметр	Необязательный список узлов в этом кластере, который включается только в том случае, если nodes=true содержится в запросе. Пример : [ "[node](#node)" ]	<Узла> Массива
state необязательный параметр	Текущее состояние кластера, если он был запущен хотя бы один раз Пример : "Starting"	строка
targetState необязательный параметр	Требуемое состояние кластера (например, Запущено или Завершено) Пример : "Started"	строка

nodearrays

Имя	Описание	схема
Ведра обязательный параметр	Каждый сегмент выделения для этого узла. Параметры "количество ядер" всегда кратны количеству ядер для этого контейнера. Пример : [ "object" ]	<Ведра> Массива
maxCoreCount обязательный параметр	Максимальное число ядер, которые могут находиться в этом узле Пример : 16	Целое число
maxCount обязательный параметр	Максимальное количество узлов, которые могут находиться в этом узле Пример : 4	Целое число
name обязательный параметр	Узел, описываемый этим Пример : "execute"	строка
nodearray обязательный параметр	Атрибуты этого nodearray Пример : "[node](#node)"	Node

Ведра

Имя	Описание	схема
activeCoreCount обязательный параметр	Количество ядер, используемых для этого сегмента, в этом nodearray Пример : 40	Целое число
activeCount обязательный параметр	Количество узлов, используемых для этого сегмента, в этом nodearray. Сюда входят узлы, которые по-прежнему получают виртуальную машину. Пример : 10	Целое число
activeNodes необязательный параметр	Имена узлов, используемых для этого контейнера, в этом nodearray. Сюда входят узлы, которые по-прежнему получают виртуальную машину. Этот параметр включается только в том случае, если в запросе указано значение nodes=true. Пример : [ "string" ]	<массив строк >
availableCoreCount обязательный параметр	Сколько дополнительных ядер может быть создано в этом контейнере в этом nodearray. Всегда кратное значению availableCount. Пример : 8	Целое число
availableCount обязательный параметр	Сколько дополнительных узлов может быть создано в этом контейнере, в этом nodearray. Обратите внимание, что это может быть меньше, чем подразумевается в maxCount и usedCount, так как maxCount может быть ограничен глобально. Пример : 2	Целое число
bucketId обязательный параметр	Идентификатор для этого контейнера. Это значение всегда будет иметь одинаковое значение для заданного контейнера в nodearray, если кластер не удален. Пример : "00000000-0000-0000-0000-000000000000"	строка
consumedCoreCount обязательный параметр	Количество ядер для этого семейства, которые уже используются во всем регионе. Пример : 2	Целое число
definition необязательный параметр	Свойства этого контейнера, используемые для создания узлов из этого сегмента. API create-nodes принимает это определение в своем свойстве bucket . Пример : "object"	definition
familyConsumedCoreCount необязательный параметр	Количество ядер для этого семейства, которые уже используются во всем регионе. Пример : 2	Целое число
familyQuotaCoreCount необязательный параметр	Общее количество ядер, которые можно запустить для этого семейства в этом регионе. Это может быть не целое число, кратное quotaCount. Пример : 16	Целое число
familyQuotaCount необязательный параметр	Общее число экземпляров, которые можно запустить (с учетом familyQuotaCoreCount) Пример : 4	Целое число
invalidReason обязательный параметр	Если значение valid имеет значение false, это будет содержать причину, по которой контейнер является недопустимым. В настоящее время единственными причинами являются NotActivated и DisabledMachineType. Пример : "DisabledMachineType"	строка
lastCapacityFailure обязательный параметр	Сколько времени (в секундах) с момента последнего сбоя емкости в этом контейнере. Любое отрицательное значение обрабатывается как никогда. Пример : 180.0	number
maxCoreCount обязательный параметр	Максимальное количество ядер, которые могут находиться в этом контейнере, включая глобальные ограничения и ограничения nodearray. Всегда кратное maxCount. Пример : 16	Целое число
maxCount обязательный параметр	Максимальное количество узлов, которые могут находиться в этом контейнере, включая глобальные ограничения и ограничения nodearray. Пример : 4	Целое число
maxPlacementGroupCoreSize обязательный параметр	Максимальное общее количество ядер, которые могут находиться в группе размещения в этом контейнере. Всегда кратное maxPlacementGroupSize. Пример : 64	Целое число
maxPlacementGroupSize обязательный параметр	Максимальное общее число экземпляров, которые могут находиться в группе размещения в этом контейнере. Пример : 16	Целое число
placementGroups обязательный параметр	Группы размещения, используемые для этого узла, если таковые есть. Пример : [ "object" ]	<placementGroups> Массива
quotaCoreCount обязательный параметр	Общее количество ядер, которые можно запустить для этого семейства в этом регионе, с учетом числа ядер региональной квоты. Это может быть не целое число, кратное quotaCount. Пример : 16	Целое число
quotaCount обязательный параметр	Общее количество запущенных экземпляров (с учетом quotaCoreCount) Пример : 4	Целое число
regionalConsumedCoreCount необязательный параметр	Количество ядер, которые уже используются во всем регионе. Пример : 2	Целое число
regionalQuotaCoreCount необязательный параметр	Общее количество ядер, которые можно запустить в этом регионе. Это может быть не целое число, кратное значению regionalQuotaCount. Пример : 16	Целое число
regionalQuotaCount необязательный параметр	Общее количество экземпляров, которые можно запустить (с учетом regionalQuotaCoreCount) Пример : 4	Целое число
Действительны обязательный параметр	Если значение равно true, этот контейнер представляет допустимый в настоящее время контейнер для использования для новых узлов. Если значение равно false, этот контейнер представляет только существующие узлы. Пример : true	Логическое
virtualMachine обязательный параметр	Свойства виртуальных машин, запущенных из этого контейнера Пример : "object"	virtualMachine

Определение

Имя	Описание	схема
machineType обязательный параметр	Размер виртуальной машины Пример : "A2"	строка

placementGroups

Имя	Описание	схема
activeCoreCount обязательный параметр	Количество ядер в этом масштабируемом наборе Пример : 16	Целое число
activeCount обязательный параметр	Количество узлов в этом масштабируемом наборе Пример : 4	Целое число
name обязательный параметр	Уникальный идентификатор этой группы размещения Пример : "my-placement-group"	строка

virtualMachine

Имя	Описание	схема
gpuCount обязательный параметр	Количество gpu, которые имеет этот тип компьютера Пример : 2	Целое число
Infiniband обязательный параметр	Если эта виртуальная машина поддерживает подключение InfiniBand Пример : true	Логическое
Памяти обязательный параметр	ОЗУ на этой виртуальной машине в ГБ Пример : 7.5	number
pcpuCount обязательный параметр	Количество физических ЦП этого типа компьютера Пример : 16	Целое число
vcpuCount обязательный параметр	Количество виртуальных ЦП этого типа компьютера Пример : 32	Целое число
vcpuQuotaCount необязательный параметр	Количество виртуальных ЦП, используемых этим компьютером из квоты Пример : 2	Целое число

ClusterUsage

Сведения об использовании и необязательных затратах для кластера

Имя	Описание	схема
Использования обязательный параметр	Список использования по интервалу времени Пример : [ "object" ]	<Использования> Массива

Использования

Имя	Описание	схема
Разбивка обязательный параметр	Разбивка использования в этом интервале по категориям "node" и "nodearray" Пример : [ "[clusterusageitem](#clusterusageitem)" ]	<ClusterUsageItem> Массива
end обязательный параметр	Конец интервала (монопольный) Пример : "string"	строка
start обязательный параметр	Начало интервала (включительно) Пример : "string"	строка
total обязательный параметр	Общее использование этого кластера в этом интервале с категорией "кластер" Пример : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Имя	Описание	схема
category обязательный параметр	"кластер" для общего использования; "узел" для одного головного узла, отличного от массива; "nodearray" для всего nodearray Пример : "string"	enum (cluster, node, nodearray)
cost необязательный параметр	Сумма, которая будет взиматься за это использование, в долларах США и по розничным тарифам. Примечание. Все суммы затрат являются оценками и не отражают фактический счет! Пример : 0.0	number
Детали необязательный параметр	Сведения о размере виртуальной машины, используемом nodearray, включая часы, core_count, приоритет региона и операционную систему. Пример : [ "object" ]	<Детали> Массива
hours обязательный параметр	Количество основных часов использования для этой категории Пример : 0.0	number
node необязательный параметр	Имя узла или узла, для который используется (отсутствует для данных на уровне кластера). Пример : "string"	строка

Детали

Имя	Описание	схема
core_count необязательный параметр	Количество ядер в этом размере виртуальной машины Пример : 0.0	number
cost необязательный параметр	Стоимость этого размера виртуальной машины Пример : 0.0	number
hours необязательный параметр	Количество основных часов использования для этого размера виртуальной машины Пример : 0.0	number
Os необязательный параметр	Тип операционной системы Пример : "string"	enum (Windows, Linux)
priority необязательный параметр	Приоритет номера SKU виртуальной машины Пример : "string"	enum (обычный, точечный)
region необязательный параметр	Регион, в который создается экземпляр виртуальной машины Пример : "string"	строка
vm_size необязательный параметр	Размер номера SKU виртуальной машины Пример : "string"	строка

Узел

Запись узла

Тип : объект

NodeCreationRequest

Указывает, как добавлять узлы в кластер.

Имя	Описание	схема
requestId необязательный параметр	Необязательный уникальный маркер, предоставленный пользователем, для предотвращения повторяющихся операций в случае ошибок сетевого взаимодействия. Если этот параметр включен и соответствует идентификатору предыдущего запроса, сервер игнорирует этот запрос и возвращает ошибку 409. Пример : "00000000-0000-0000-0000-000000000000"	строка
наборы обязательный параметр	Список создаваемых определений узлов. Запрос должен содержать по крайней мере один набор. Каждый набор может указывать свой набор свойств. Пример : [ "object" ]	<Задает> Массива

Задает

Имя	Описание	схема
count обязательный параметр	Число создаваемых узлов Пример : 1	Целое число
definition необязательный параметр	Определение используемого контейнера. Это обеспечивается вызовом API состояния кластера. Если некоторые элементы, указанные в вызове состояния, отсутствуют или отсутствует все свойство контейнера, используется первый контейнер, соответствующий заданным элементам. Пример : "object"	definition
nameFormat необязательный параметр	Если этот параметр задан, узлы будут использовать это соглашение об именовании вместо стандартного формата nodearray-%d Пример : "custom-name-%d"	строка
nameOffset необязательный параметр	При указании вместе с nameFormat смещения nodeindex для новых узлов. Пример : 1	Целое число
nodeAttributes необязательный параметр	Дополнительные атрибуты для задания на каждом узле из этого набора Пример : "[node](#node)"	Node
nodearray обязательный параметр	Имя узлаarray для запуска узлов. Пример : "execute"	строка
placementGroupId необязательный параметр	Если задано значение, все узлы с одинаковым значением groupId будут запущены в одной группе размещения. Пример : "string"	строка

Определение

Имя	Описание	схема
machineType необязательный параметр	Пример : "A2"	строка

NodeCreationResult

Имя	Описание	схема
operationId обязательный параметр	Идентификатор этой операции Пример : "00000000-0000-0000-0000-000000000000"	строка
наборы обязательный параметр	Массив наборов в том же порядке, что и в запросе. Пример : [ "object" ]	<Задает> Массива

Задает

Имя	Описание	схема
Добавили обязательный параметр	Количество запущенных узлов в этом наборе Пример : 1	Целое число
message необязательный параметр	Указывает, почему не все запрошенные узлы могут быть добавлены, если они есть. Пример : "string"	строка

NodeList

Результаты поиска узла

Имя	Описание	схема
узлы обязательный параметр	Возвращенные узлы Пример : [ "[node](#node)" ]	<Узла> Массива
operation необязательный параметр	Если запрос содержит идентификатор операции, это состояние этой операции. Пример : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

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

Имя	Описание	схема
filter необязательный параметр	Выражение фильтра, соответствующее узлам. Обратите внимание, что строки в выражении должны быть правильно в кавычках. Пример : "State === \"Started\""	строка
имена узлов необязательный параметр	Список коротких имен узлов (без домена) для управления Пример : [ "hostname1", "hostname2" ]	<массив строк >
ids необязательный параметр	Список идентификаторов узлов для управления Пример : [ "id1", "id2" ]	<массив строк >
ip_addresses необязательный параметр	Список IP-адресов для управления Пример : [ "10.0.1.1", "10.1.1.2" ]	<массив строк >
Имена необязательный параметр	Список имен узлов для управления Пример : [ "name1", "name2" ]	<массив строк >
requestId необязательный параметр	Необязательный уникальный маркер, предоставленный пользователем, для предотвращения повторяющихся операций в случае ошибок сетевого взаимодействия. Если этот параметр включен и соответствует идентификатору предыдущего запроса, сервер игнорирует этот запрос и возвращает ошибку 409. Пример : "00000000-0000-0000-0000-000000000000"	строка

NodeManagementResult

Имя	Описание	схема
узлы обязательный параметр	Массив сведений о каждом узле, который соответствует фильтру в запросе на управление. Состояние каждого узла указывает, был ли он затронут запросом. Пример : [ "object" ]	<Узлов> Массива
operationId обязательный параметр	Идентификатор этой операции Пример : "00000000-0000-0000-0000-000000000000"	строка

Узлов

Имя	Описание	схема
error необязательный параметр	Если состояние — Ошибка, оно содержит сообщение об ошибке. Пример : "This node must be terminated before it can be removed"	строка
идентификатор обязательный параметр	Идентификатор узла Пример : "id1"	строка
name обязательный параметр	Имя узла Пример : "name1"	строка
status необязательный параметр	Один из ОК или Ошибка Пример : "Error"	перечисление (ОК, ошибка)

OperationStatus

Состояние этой операции узла

Имя	Описание	схема
action обязательный параметр	Пример : "string"	enum (create)
startTime обязательный параметр	Когда эта операция была отправлена Пример : "2020-01-01T12:34:56Z"	строка (дата-время)