Операционный
Получение узлов кластера
GET /clusters/{cluster}/nodes
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для запроса | струна |
запроса |
операции необязательный |
Если задано, возвращает только узлы для этого идентификатора операции и включает атрибут операции в тексте. | струна |
запроса |
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-адрес операции, которую можно использовать для отслеживания состояния операции.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для добавления узлов в | струна |
тела | узлы обязательный |
Наборы создаваемых узлов | NodeCreationRequest |
Ответы
КОД HTTP | Описание | Схема |
---|---|---|
202 | Принятый заголовков Location (строка) — 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
Описание
Эта операция освобождает узлы в кластере. Узлы можно определить несколькими способами, включая имя узла, идентификатор узла или фильтр.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для освобождения узлов в | струна |
тела |
действия обязательный |
Описание узлов для освобождения | NodeManagementRequest |
Ответы
КОД HTTP | Описание | Схема |
---|---|---|
202 | Принятый заголовков Location (строка) — 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), в этом случае этот вызов не отличается от завершения.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для удаления узлов в | струна |
тела |
действия обязательный |
Описание узлов для удаления | NodeManagementRequest |
Ответы
КОД HTTP | Описание | Схема |
---|---|---|
202 | Принятый заголовков Location (строка) — 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 на каждом узле завершен (по умолчанию) или Deallocate соответственно.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для завершения работы узлов в | струна |
тела |
действия обязательный |
Описание узлов для завершения работы | NodeManagementRequest |
Ответы
КОД HTTP | Описание | Схема |
---|---|---|
202 | Принятый заголовков Location (строка) — 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
Описание
Эта операция запускает узлы в кластере. Узлы можно определить несколькими способами, включая имя узла, идентификатор узла или фильтр.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для запуска узлов в | струна |
тела |
действия обязательный |
Описание запуска узлов | NodeManagementRequest |
Ответы
КОД HTTP | Описание | Схема |
---|---|---|
202 | Принятый заголовков Location (строка) — 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
Описание
Эта операция завершает узлы в кластере. Узлы можно определить несколькими способами, включая имя узла, идентификатор узла или фильтр.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для завершения узлов в | струна |
тела |
действия обязательный |
Описание того, какие узлы следует завершить | NodeManagementRequest |
Ответы
КОД HTTP | Описание | Схема |
---|---|---|
202 | Принятый заголовков Location (строка) — 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}
Описание
Эта операция добавляет узлы по мере необходимости в узел, чтобы получить общее количество. Запрос обрабатывается один раз и не повторно добавляет узлы позже, чтобы сохранить заданное число. Это масштабируется на общих ядрах или общих узлах, но не на обоих. Он возвращает URL-адрес операции, которую можно использовать для отслеживания состояния операции.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для добавления узлов в | струна |
Путь |
nodearray обязательный |
Nodearray для добавления узлов в | струна |
запроса |
totalCoreCount необязательный |
Общее количество ядер, которые должны быть в этом узлеarray, включая уже созданные узлы | целое число |
запроса |
totalNodeCount необязательный |
Общее количество компьютеров, имеющихся в этом узле, включая уже созданные узлы | целое число |
Ответы
КОД HTTP | Описание | Схема |
---|---|---|
202 | Принятый заголовков Location (строка) — 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 определяются определением кластера пользователя, но ограничения определяются частично поставщиком облачных служб.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для запроса | струна |
запроса |
узлы необязательный |
Если значение 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
Описание
Эта операция возвращает общие данные об использовании (основные часы) и данные о затратах, если они доступны для кластера, а также разбивку по узлам. По умолчанию он возвращает стоимость использования текущего месяца.
Параметры
Тип | Имя | Описание | Схема |
---|---|---|---|
Путь | кластера обязательный |
Кластер для возврата данных об использовании | струна |
запроса |
период времени необязательный |
Если задано, это указывает диапазон времени, используемый для запроса. MonthToDate возвращает использование текущего месяца, а последнийMonth возвращает использование за предыдущий месяц. weekToDate возвращает использование текущей недели (начиная с воскресенья). для пользовательских параметров запроса "from" и "to". Значение по умолчанию — MonthToDate. Все время находятся в формате UTC. | перечисление (monthToDate, lastMonth, weekToDate, custom) |
запроса |
из необязательный |
Для пользовательских периодов это начало интервала времени в формате ISO-8601. Это округляется до ближайшего часа или дня. | струна |
запроса |
необязательный |
Для пользовательских периодов это конец интервала времени в формате ISO-8601. Это округляется до ближайшего часа или дня. | струна |
запроса |
детализации необязательный |
Указывает, как агрегировать данные: по часам, по дням или как одно число. Это значение по умолчанию ежедневно. | перечисление (общее, ежедневное, почасовое) |
Ответы
КОД 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 обязательный |
Максимальное количество ядер, которые могут быть добавлены в этот кластер Пример |
целое число |
maxCount обязательный |
Максимальное количество узлов, которые могут быть добавлены в этот кластер Пример |
целое число |
nodearrays обязательный |
Пример |
массив |
узлы необязательный |
Необязательный список узлов в этом кластере, включенный только в том случае, если nodes=true находится в запросе Пример |
массив |
состояния необязательный |
Текущее состояние кластера, если оно было запущено по крайней мере один раз Пример |
струна |
targetState необязательный |
Требуемое состояние кластера (например, запущено или завершено) Пример |
струна |
Имя | Описание | Схема |
---|---|---|
контейнеров обязательный |
Каждый контейнер выделения для этого узла. Параметры "число ядер" всегда являются несколькими из числа ядер для этого контейнера. Пример |
< массив> контейнеров |
maxCoreCount обязательный |
Максимальное количество ядер, которые могут находиться в этом узле Пример |
целое число |
maxCount обязательный |
Максимальное количество узлов, которые могут находиться в этом узле Пример |
целое число |
имени обязательный |
Узеларрей, описывающий Пример |
струна |
nodearray обязательный |
Атрибуты этого узла Пример |
|
Имя | Описание | Схема |
---|---|---|
activeCoreCount обязательный |
Количество ядер, используемых для этого контейнера, в этом узле Пример |
целое число |
activeCount обязательный |
Количество узлов, используемых для этого контейнера, в этом узле. Сюда входят узлы, которые по-прежнему получают виртуальную машину. Пример |
целое число |
activeNodes необязательный |
Имена узлов, используемых для этого контейнера, в этом узле. Сюда входят узлы, которые по-прежнему получают виртуальную машину. Это включается только в том случае, если nodes=true находится в запросе. Пример |
< массив строк > |
availableCoreCount обязательный |
Сколько дополнительных ядер может быть создано в этом контейнере, в этом узле. Всегда доступно несколько доступныхcount. Пример |
целое число |
availableCount обязательный |
Сколько дополнительных узлов может быть создано в этом контейнере, в этом узле. Обратите внимание, что это может быть меньше, чем подразумевается maxCount и usedCount, так как maxCount может быть ограничен глобально. Пример |
целое число |
bucketId обязательный |
Идентификатор этого контейнера. Это всегда будет иметь то же значение для заданного контейнера в узле, если кластер не удаляется. Пример |
струна |
потребленная CoreCount обязательный |
Количество ядер для этой семьи, которые уже используются во всем регионе. Пример |
целое число |
определения необязательный |
Свойства этого контейнера, используемые для создания узлов из этого контейнера. API создания узлов принимает это определение в своем свойстве bucket . Пример |
определения |
familyConsumedCoreCount необязательный |
Количество ядер для этой семьи, которые уже используются во всем регионе. Пример |
целое число |
familyQuotaCoreCount необязательный |
Общее количество ядер, которые можно запустить для этой семьи в этом регионе. Это может не быть целым числом нескольких квот. Пример |
целое число |
familyQuotaCount необязательный |
Число общих экземпляров, которые можно запустить (учитывая familyQuotaCoreCount) Пример |
целое число |
invalidReason обязательный |
Если допустимо значение false, это будет содержать причину, по которой контейнер недопустим. В настоящее время NotActivated и DisabledMachineType являются единственными причинами. Пример |
струна |
lastCapacityFailure обязательный |
Сколько времени, в секундах, с момента последнего сбоя емкости этого контейнера. Любое отрицательное значение рассматривается как никогда. Пример |
число |
maxCoreCount обязательный |
Максимальное количество ядер, которые могут находиться в этом контейнере, включая глобальные и ограничения nodearray. Всегда несколько maxCount. Пример |
целое число |
maxCount обязательный |
Максимальное количество узлов, которые могут находиться в этом контейнере, включая глобальные и ограничения nodearray Пример |
целое число |
maxPlacementGroupCoreSize обязательный |
Максимальное общее количество ядер, которые могут находиться в группе размещения в этом контейнере. Всегда несколько maxPlacementGroupSize. Пример |
целое число |
maxPlacementGroupSize обязательный |
Максимальное общее количество экземпляров, которые могут находиться в группе размещения в этом контейнере. Пример |
целое число |
placementGroups обязательный |
Группы размещения, используемые для этого узла, если таковые есть. Пример |
массив <placementGroups> |
квотаCoreCount обязательный |
Общее количество ядер, которые можно запустить для этой семьи в этом регионе, учитывая также количество ядер региональной квоты. Это может не быть целым числом нескольких квот. Пример |
целое число |
квоты обязательный |
Общее количество экземпляров, которые можно запустить (с учетом квотыCoreCount) Пример |
целое число |
regionalConsumedCoreCount необязательный |
Количество ядер, которые уже используются во всем регионе. Пример |
целое число |
regionalQuotaCoreCount необязательный |
Общее количество ядер, которые можно запустить в этом регионе. Это может не быть целым числом из регионаQuotaCount. Пример |
целое число |
regionalQuotaCount необязательный |
Общее число экземпляров, которые можно запустить (с учетом регионаQuotaCoreCount) Пример |
целое число |
допустимые обязательный |
Если задано значение true, этот контейнер представляет допустимый контейнер, используемый для новых узлов. Если значение false, этот контейнер представляет только существующие узлы. Пример |
булев |
virtualMachine обязательный |
Свойства виртуальных машин, запущенных из этого контейнера Пример |
virtualMachine |
определения
Имя | Описание | Схема |
---|---|---|
machineType обязательный |
Размер виртуальной машины виртуальной машины Пример |
струна |
Имя | Описание | Схема |
---|---|---|
activeCoreCount обязательный |
Сколько ядер в этом масштабируемом наборе Пример |
целое число |
activeCount обязательный |
Сколько узлов в этом масштабируемом наборе Пример |
целое число |
имени обязательный |
Уникальный идентификатор этой группы размещения Пример |
струна |
Имя | Описание | Схема |
---|---|---|
gpuCount обязательный |
Количество графических процессоров этого типа компьютера Пример |
целое число |
infiniband обязательный |
Если эта виртуальная машина поддерживает подключение InfiniBand Пример |
булев |
памяти обязательный |
ОЗУ на этой виртуальной машине в ГБ Пример |
число |
pcpuCount обязательный |
Количество физических ЦП этого типа компьютера Пример |
целое число |
vcpuCount обязательный |
Количество виртуальных ЦП этого типа компьютера Пример |
целое число |
vcpuQuotaCount необязательный |
Количество виртуальных ЦП, используемых этим компьютером из квоты Пример |
целое число |
ClusterUsage
Сведения об использовании и необязательных затратах для кластера
Имя | Описание | Схема |
---|---|---|
использования обязательный |
Список использования по интервалу времени Пример |
массив |
Имя | Описание | Схема |
---|---|---|
разбивки обязательный |
Разбивка использования в этом интервале по категориям "node" и "nodearray" Пример |
массив |
конце обязательный |
Конец интервала (эксклюзивный) Пример |
струна |
запуска обязательный |
Начало интервала (включительно) Пример |
струна |
всего обязательный |
Общее использование этого кластера в этом интервале с категорией "кластер" Пример |
ClusterUsageItem |
ClusterUsageItem
Имя | Описание | Схема |
---|---|---|
категории обязательный |
"кластер" для общего использования; "node" для одного головного узла, отличного от массива; "nodearray" для всего узлаarray Пример |
перечисление (кластер, узел, nodearray) |
затраты необязательный |
Сумма, которая будет взиматься за это использование, в долларах США и по розничным тарифам. Примечание. Все суммы затрат являются оценками и не отражают фактический счет! Пример |
число |
подробные сведения необязательный |
Сведения о размере виртуальной машины, используемой nodearray, включая часы, core_count, приоритет региона и операционную систему. Пример |
< подробные сведения> массиве |
часов обязательный |
Количество основных часов использования для этой категории Пример |
число |
узла необязательный |
Имя узла или узла, для использования (отсутствует для данных на уровне кластера) Пример |
струна |
Имя | Описание | Схема |
---|---|---|
core_count необязательный |
Количество ядер в этом размере виртуальной машины Пример |
число |
затраты необязательный |
Стоимость этой виртуальной машины Пример |
число |
часов необязательный |
Количество основных часов использования для этого размера виртуальной машины Пример |
число |
ос необязательный |
Тип операционной системы Пример |
перечисление (Windows, Linux) |
приоритет необязательный |
Приоритет SKU виртуальной машины Пример |
перечисление (regular, spot) |
региона необязательный |
Регион, в который создается экземпляр виртуальной машины Пример |
струна |
vm_size необязательный |
Размер SKU виртуальной машины Пример |
струна |
Узел
Запись узла
Type : object
NodeCreationRequest
Указывает, как добавлять узлы в кластер
Имя | Описание | Схема |
---|---|---|
requestId необязательный |
Необязательный уникальный маркер, предоставленный пользователем, чтобы предотвратить повторяющиеся операции в случае ошибок сетевого взаимодействия. Если это включается и соответствует идентификатору предыдущего запроса, сервер игнорирует этот запрос и возвращает ошибку 409. Пример |
струна |
наборов обязательный |
Список определений узлов для создания. Запрос должен содержать по крайней мере один набор. Каждый набор может указать другой набор свойств. Пример |
< задает массив> |
Имя | Описание | Схема |
---|---|---|
число обязательный |
Количество создаваемых узлов Пример |
целое число |
определения необязательный |
Определение используемого контейнера. Это обеспечивается вызовом API состояния кластера. Если некоторые элементы, указанные в вызове состояния, отсутствуют, или все свойство контейнера отсутствует, используется первый контейнер, соответствующий заданным элементам. Пример |
определения |
nameFormat необязательный |
Если задано, узлы будут использовать это соглашение об именовании вместо стандартного формата nodearray-%d Пример |
струна |
nameOffset необязательный |
Если задано, а также nameFormat, смещает nodeindex для новых узлов. Пример |
целое число |
nodeAttributes необязательный |
Дополнительные атрибуты, заданные на каждом узле из этого набора Пример |
|
nodearray обязательный |
Имя nodearray для запуска узлов из Пример |
струна |
placementGroupId необязательный |
Если задано, узлы с одинаковым значением groupId будут запущены в одной группе размещения. Пример |
струна |
определения
Имя | Описание | Схема |
---|---|---|
machineType необязательный |
Пример |
струна |
NodeCreationResult
Имя | Описание | Схема |
---|---|---|
operationId обязательный |
Идентификатор этой операции Пример |
струна |
наборов обязательный |
Массив наборов в том же порядке, что и в запросе Пример |
< задает массив> |
Имя | Описание | Схема |
---|---|---|
добавлен обязательный |
Сколько узлов было запущено в этом наборе Пример |
целое число |
сообщения необязательный |
Указывает, почему не все запрошенные узлы могут быть добавлены, если они присутствуют Пример |
струна |
NodeList
Результаты поиска узла
Имя | Описание | Схема |
---|---|---|
узлы обязательный |
Возвращенные узлы Пример |
массив |
операции необязательный |
Если запрос содержит идентификатор операции, это состояние этой операции Пример |
OperationStatus |
NodeManagementRequest
Указывает, как выполнять действия на узлах в кластере. Существует несколько способов указания узлов, и если включено несколько способов, он рассматривается как объединение.
Имя | Описание | Схема |
---|---|---|
фильтра необязательный |
Выражение фильтра, соответствующее узлам. Обратите внимание, что строки в выражении должны быть указаны должным образом. Пример |
струна |
имена узлов необязательный |
Список коротких имен узлов (без домена) для управления Пример |
< массив строк > |
идентификаторов необязательный |
Список идентификаторов узлов для управления Пример |
< массив строк > |
ip_addresses необязательный |
Список IP-адресов для управления Пример |
< массив строк > |
имена необязательный |
Список имен узлов для управления Пример |
< массив строк > |
requestId необязательный |
Необязательный уникальный маркер, предоставленный пользователем, чтобы предотвратить повторяющиеся операции в случае ошибок сетевого взаимодействия. Если это включается и соответствует идентификатору предыдущего запроса, сервер игнорирует этот запрос и возвращает ошибку 409. Пример |
струна |
NodeManagementResult
Имя | Описание | Схема |
---|---|---|
узлы обязательный |
Массив сведений о каждом узле, который соответствовал фильтру в запросе управления. Состояние каждого узла указывает, повлияло ли оно на запрос. Пример |
< узлах> массиве |
operationId обязательный |
Идентификатор этой операции Пример |
струна |
узлов
Имя | Описание | Схема |
---|---|---|
ошибка необязательный |
Если состояние равно "Ошибка", это сообщение об ошибке Пример |
струна |
идентификатор обязательный |
Идентификатор узла Пример |
струна |
имени обязательный |
Имя узла Пример |
струна |
состояние необязательный |
Одна из ОК или ошибка Пример |
перечисление (ОК, ошибка) |
OperationStatus
Состояние этой операции узла
Имя | Описание | Схема |
---|---|---|
действия обязательный |
Пример |
перечисление (create) |
startTime обязательный |
Когда эта операция была отправлена Пример |
строка (дата и время) |