Operations

Azure CycleCloud предоставляет REST API для управления кластерами, узлами и связанными ресурсами программным способом. Используйте эти операции API для запроса состояния кластера, создания узлов и управления ими и отслеживания длительных операций. В этой ссылке перечислены доступные конечные точки, параметры и форматы ответов, которые помогут автоматизировать и интегрировать управление кластерами CycleCloud в рабочие процессы.

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

GET /clusters/{cluster}/nodes

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для запроса	string
Query	operation optional	Если задано, возвращает только узлы для этого идентификатора операции и включает атрибут операции в тексте.	string
Query	request_id optional	Если задано, возвращает только узлы для операции, определяемой этим идентификатором запроса, и включает атрибут операции в тексте.	string

Responses

КОД HTTP	Description	Schema
200	OK	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

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для добавления узлов в	string
Body	nodes required	Наборы создаваемых узлов	NodeCreationRequest

Responses

КОД HTTP	Description	Schema
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

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для освобождения узлов в	string
Body	action required	Описание узлов для освобождения	NodeManagementRequest

Responses

КОД HTTP	Description	Schema
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/reimage

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для повторного создания образа узлов в	string
Body	action required	Описание узлов для повторного создания образа	NodeManagementRequest

Responses

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

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

Путь запроса

/clusters/CLUSTER_NAME/nodes/reimage

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

{
  "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

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для удаления узлов в	string
Body	action required	Описание узлов для удаления	NodeManagementRequest

Responses

КОД HTTP	Description	Schema
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/restart

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для перезапуска узлов в	string
Body	action required	Описание узлов для перезапуска	NodeManagementRequest

Responses

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

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

Путь запроса

/clusters/CLUSTER_NAME/nodes/restart

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

{
  "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

Description

Этот вызов завершает работу узлов в кластере. Атрибут ShutdownPolicy каждого узла решает действие: завершить (по умолчанию) или Deallocate.

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для завершения работы узлов в	string
Body	action required	Описание узлов для завершения работы	NodeManagementRequest

Responses

КОД HTTP	Description	Schema
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

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для запуска узлов в	string
Body	action required	Описание запуска узлов	NodeManagementRequest

Responses

КОД HTTP	Description	Schema
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

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для завершения узлов в	string
Body	action required	Описание того, какие узлы следует завершить	NodeManagementRequest

Responses

КОД HTTP	Description	Schema
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}/nodes/{node}/ghr

Description

Отправка отчета о работоспособности узла с проблемой работоспособности

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер, содержащий узел для отчета	string
Path	node required	Узел для отчета	string
Query	category optional	Категория отчета о работоспособности гостей для влияния	string
Query	описание optional	Пользовательское сообщение, описывающее сбой или контекст	string

Responses

КОД HTTP	Description	Schema
202	Принято	Нет содержимого
400	недопустимые входные данные	Нет содержимого
404	Не найдено	Нет содержимого
409	Конфликт — отчет о работоспособности гостя, уже отправленный для этого узла	Нет содержимого

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

Путь запроса

/clusters/CLUSTER_NAME/nodes/string/ghr

Получение отчета о работоспособности гостей для узла кластера

GET /clusters/{cluster}/nodes/{node}/ghr

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер, содержащий узел для отчета	string
Path	node required	Узел для отчета	string
Query	category optional	Категория отчета о работоспособности гостей для влияния	string
Query	описание optional	Пользовательское сообщение, описывающее сбой или контекст	string

Responses

КОД HTTP	Description	Schema
200	Ok	Нет содержимого
400	недопустимые входные данные	Нет содержимого
404	Не найдено	Нет содержимого

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

Путь запроса

/clusters/CLUSTER_NAME/nodes/string/ghr

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

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

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для добавления узлов в	string
Path	nodearray required	Nodearray для добавления узлов в	string
Query	totalCoreCount optional	Общее количество ядер, которые должны быть в этом узлеarray, включая уже созданные узлы	integer
Query	totalNodeCount optional	Общее количество компьютеров, имеющихся в этом узле, включая уже созданные узлы	integer

Responses

КОД HTTP	Description	Schema
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

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для запроса	string
Query	nodes optional	Если значение true, ссылки на узлы и узлы возвращаются в ответе	boolean

Responses

КОД HTTP	Description	Schema
200	OK	ClusterStatus

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

Путь запроса

/clusters/CLUSTER_NAME/status

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

Ответ 200

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

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

GET /clusters/{cluster}/usage

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Кластер для возврата данных об использовании	string
Query	Таймфрейме optional	Диапазон времени, используемый для запроса. Допустимые значения: monthToDate (текущий месяц), lastMonth (предыдущий месяц), (текущая неделя, weekToDate начало воскресенье) или custom (требуется from параметры запроса и т to . д.). Значение по умолчанию — monthToDate. Все значения времени указаны в формате UTC.	перечисление (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Для пользовательских периодов это значение является началом интервала времени в формате ISO-8601. Округляется до ближайшего часа или дня.	string
Query	to optional	Для пользовательских периодов это значение является окончанием интервала времени в формате ISO-8601. Округляется до ближайшего часа или дня.	string
Query	Гранулярности optional	Указывает, как агрегировать данные: почасовую, ежедневную или в виде одной общей суммы. Интервал по умолчанию — ежедневно.	перечисление (общее, ежедневное, почасовое)

Responses

КОД HTTP	Description	Schema
200	OK	ClusterUsage

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

Путь запроса

/clusters/CLUSTER_NAME/usage

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

Ответ 200

{
  "usage" : [ "object" ]
}

Вывод списка состояний операций

GET /operations/

Parameters

Type	Name	Description	Schema
Query	request_id optional	Идентификатор запроса для операции. Если это значение задано, список содержит 0 или 1 элемент.	string

Responses

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

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

Путь запроса

/operations/

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

Ответ 200

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

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

GET /operations/{id}

Parameters

Type	Name	Description	Schema
Path	id required	Идентификатор операции	string

Responses

КОД HTTP	Description	Schema
200	OK	OperationStatus
404	Не найдено	Нет содержимого

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

Путь запроса

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

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

Ответ 200

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

Resources

Azure CycleCloud определяет набор моделей ресурсов, описывающих кластеры, массивы узлов, узлы и состояние выделения. Эти ресурсы возвращаются REST API и предоставляют такие сведения, как ограничения емкости, использование и состояние кластера. Используйте эту ссылку, чтобы понять структуру и свойства ответов API при управлении кластерами CycleCloud программными средствами.

ClusterStatus

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

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

nodearrays

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

Ведра

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

Определение

Name	Description	Schema
machineType required	Размер виртуальной машины виртуальной машины Пример:"A2"	string

placementGroups

Name	Description	Schema
activeCoreCount required	Сколько ядер в этом масштабируемом наборе Пример:16	integer
activeCount required	Сколько узлов в этом масштабируемом наборе Пример:4	integer
name required	Уникальный идентификатор этой группы размещения Пример:"my-placement-group"	string

virtualMachine

Name	Description	Schema
gpuCount required	Количество графических процессоров этого типа компьютера Пример:2	integer
Infiniband required	Если эта виртуальная машина поддерживает подключение InfiniBand Пример:true	boolean
memory required	ОЗУ на этой виртуальной машине в ГБ Пример:7.5	number
pcpuCount required	Количество физических ЦП этого типа компьютера Пример:16	integer
vcpuCount required	Количество виртуальных ЦП этого типа компьютера Пример:32	integer
vcpuQuotaCount optional	Количество виртуальных ЦП, используемых этим компьютером из квоты Пример:2	integer

ClusterUsage

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

Name	Description	Schema
usage required	Список использования по интервалу времени Пример:[ "object" ]	< Использования> Массива

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

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

ClusterUsageItem

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

Детали

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

Node

Запись узла

Тип: объект

NodeCreationRequest

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

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

Задает

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

Определение

Name	Description	Schema
machineType optional	Пример:"A2"	string

NodeCreationResult

Name	Description	Schema
operationId required	Идентификатор этой операции Пример:"00000000-0000-0000-0000-000000000000"	string
Задает required	Массив наборов в том же порядке, что и в запросе Пример:[ "object" ]	< Задает> Массива

Задает

Name	Description	Schema
Добавили required	Сколько узлов было запущено в этом наборе Пример:1	integer
message optional	Указывает, почему не все запрошенные узлы могут быть добавлены, если они присутствуют Пример:"string"	string

NodeList

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

Name	Description	Schema
nodes required	Возвращенные узлы Пример:[ "[node](#node)" ]	< Узла> Массива
operation optional	Состояние операции, если запрос содержит идентификатор операции Пример:"[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

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

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

NodeManagementResult

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

Узлов

Name	Description	Schema
error optional	Сообщение об ошибке при status возникновении Errorошибки. Пример:"This node must be terminated before it can be removed"	string
id required	Идентификатор узла Пример:"id1"	string
name required	Имя узла Пример:"name1"	string
status optional	Одна из ОК или ошибка Пример:"Error"	перечисление (ОК, ошибка)

OperationStatus

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

Name	Description	Schema
action required	Пример:"string"	перечисление (create)
startTime required	Когда эта операция была отправлена Пример:"2020-01-01T12:34:56Z"	строка (дата и время)