Operations

Azure CycleCloud proporciona una API REST para administrar clústeres, nodos y recursos relacionados mediante programación. Use estas operaciones de API para consultar el estado del clúster, crear y administrar nodos y realizar un seguimiento de las operaciones de larga duración. En esta referencia se enumeran los puntos de conexión, los parámetros y los formatos de respuesta disponibles para ayudarle a automatizar e integrar la administración de clústeres de CycleCloud en los flujos de trabajo.

Obtención de nodos de clúster

GET /clusters/{cluster}/nodes

Parameters

Type	Name	Description	Schema
Path	cluster required	El clúster que se va a consultar	string
Query	operation optional	Si se indica, devuelve solo los nodos para este identificador de operación e incluye el atributo operation en el cuerpo.	string
Query	id_de_solicitud optional	Si se indica, devuelve solo los nodos de la operación identificada por este identificador de solicitud e incluye el atributo operation en el cuerpo.	string

Responses

Código HTTP	Description	Schema
200	OK	NodeList
400	Especificación no válida	Sin contenido
404	No encontrado	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes

Respuesta HTTP de ejemplo

Respuesta 200

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

Creación de nodos de clúster

POST /clusters/{cluster}/nodes/create

Description

Esta operación agrega nuevos nodos de un elemento nodearray a un clúster. Acepta varias definiciones de nodo en una sola llamada. Devuelve la dirección URL a la operación que se puede usar para realizar el seguimiento del estado de la operación.

Parameters

Type	Name	Description	Schema
Path	cluster required	Clúster al que se van a agregar nodos	string
Body	nodes required	Conjuntos de nodos que se van a crear	NodeCreationRequest

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeCreationResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/create

Cuerpo de la solicitud

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

Respuesta HTTP de ejemplo

Respuesta 202

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

Desasignar nodos de clúster

POST /clusters/{cluster}/nodes/deallocate

Description

Esta operación desasigna los nodos de un clúster. Los nodos se pueden identificar de varias maneras, como el nombre del nodo, el identificador de nodo o el filtro.

Parameters

Type	Name	Description	Schema
Path	cluster required	Clúster en el que se desasignar los nodos	string
Body	action required	Descripción de los nodos que se van a desasignar	NodeManagementRequest

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeManagementResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/deallocate

Cuerpo de la solicitud

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

Respuesta HTTP de ejemplo

Respuesta 202

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

Cambiar la imagen de los nodos del clúster

POST /clusters/{cluster}/nodes/reimage

Description

Esta operación vuelve a crear una imagen de los nodos de un clúster. Los nodos se pueden identificar de varias maneras, como el nombre del nodo, el identificador de nodo o el filtro.

Parameters

Type	Name	Description	Schema
Path	cluster required	El clúster en el que se va a cambiar la imagen de los nodos	string
Body	action required	Descripción de qué nodos se va a volver a crear una imagen	NodeManagementRequest

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeManagementResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/reimage

Cuerpo de la solicitud

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

Respuesta HTTP de ejemplo

Respuesta 202

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

Finalización y eliminación de nodos de clúster

POST /clusters/{cluster}/nodes/remove

Description

Esta operación quita los nodos de un clúster. Puede identificar los nodos por nombre de nodo, identificador de nodo o filtro. De forma predeterminada, CycleCloud quita nodos al finalizar, por lo que esta llamada se comporta como finalizar. Los nodos con el atributo Fixed establecido en true no se quitan al finalizar.

Parameters

Type	Name	Description	Schema
Path	cluster required	Clúster en el que se van a quitar nodos	string
Body	action required	Descripción de los nodos que se van a quitar	NodeManagementRequest

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeManagementResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/remove

Cuerpo de la solicitud

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

Respuesta HTTP de ejemplo

Respuesta 202

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

Reinicio de nodos de clúster

POST /clusters/{cluster}/nodes/restart

Description

Esta operación reinicia los nodos de un clúster. Los nodos se pueden identificar de varias maneras, como el nombre del nodo, el identificador de nodo o el filtro.

Parameters

Type	Name	Description	Schema
Path	cluster required	El clúster en el que se reiniciarán los nodos	string
Body	action required	Descripción de los nodos que se van a reiniciar	NodeManagementRequest

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeManagementResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/restart

Cuerpo de la solicitud

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

Respuesta HTTP de ejemplo

Respuesta 202

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

Finalización o desasignación de nodos de clúster

POST /clusters/{cluster}/nodes/shutdown

Description

Esta llamada cierra los nodos de un clúster. El atributo ShutdownPolicy de cada nodo decide la acción: Finalizar (valor predeterminado) o Desasignar.

Parameters

Type	Name	Description	Schema
Path	cluster required	El clúster en el que se apagarán los nodos	string
Body	action required	Descripción de los nodos que se van a apagar	NodeManagementRequest

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeManagementResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/shutdown

Cuerpo de la solicitud

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

Respuesta HTTP de ejemplo

Respuesta 202

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

Inicio de nodos de clúster desasignados o terminados

POST /clusters/{cluster}/nodes/start

Description

Esta operación inicia nodos en un clúster. Los nodos se pueden identificar de varias maneras, como el nombre del nodo, el identificador de nodo o el filtro.

Parameters

Type	Name	Description	Schema
Path	cluster required	El clúster en el que se inician los nodos	string
Body	action required	Descripción de los nodos que se van a iniciar	NodeManagementRequest

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeManagementResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/start

Cuerpo de la solicitud

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

Respuesta HTTP de ejemplo

Respuesta 202

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

Finalización de nodos de clúster

POST /clusters/{cluster}/nodes/terminate

Description

Esta operación finaliza los nodos de un clúster. Los nodos se pueden identificar de varias maneras, como el nombre del nodo, el identificador de nodo o el filtro.

Parameters

Type	Name	Description	Schema
Path	cluster required	Clúster en el que finalizar los nodos	string
Body	action required	Descripción de los nodos que se van a finalizar	NodeManagementRequest

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeManagementResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/terminate

Cuerpo de la solicitud

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

Respuesta HTTP de ejemplo

Respuesta 202

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

Enviar informe de estado de invitado para el nodo de clúster

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

Description

Envío de un informe de mantenimiento para un nodo con un problema de mantenimiento

Parameters

Type	Name	Description	Schema
Path	cluster required	Clúster que contiene el nodo que se va a notificar	string
Path	node required	Nodo que se va a notificar	string
Query	category optional	Categoría De informe de estado de invitado para el impacto	string
Query	descripción optional	Mensaje personalizado que describe el error o el contexto	string

Responses

Código HTTP	Description	Schema
202	Aceptado	Sin contenido
400	Entrada no válida	Sin contenido
404	No encontrado	Sin contenido
409	Conflicto: informe de mantenimiento de invitado ya enviado para este nodo	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/string/ghr

Obtención del informe de estado de invitado para el nodo de clúster

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

Description

Devuelve el impacto de la carga de trabajo de un nodo con un problema de mantenimiento, por lo que puede enviarlo al punto de conexión de informes de estado.

Parameters

Type	Name	Description	Schema
Path	cluster required	Clúster que contiene el nodo que se va a notificar	string
Path	node required	Nodo que se va a notificar	string
Query	category optional	Categoría De informe de estado de invitado para el impacto	string
Query	descripción optional	Mensaje personalizado que describe el error o el contexto	string

Responses

Código HTTP	Description	Schema
200	De acuerdo	Sin contenido
400	Entrada no válida	Sin contenido
404	No encontrado	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/nodes/string/ghr

Escalado del clúster al tamaño

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

Description

Esta operación agrega nodos según sea necesario a un elemento nodearray para alcanzar un recuento total. La solicitud se procesa una vez y no vuelve a agregar nodos más adelante para mantener el número especificado. Especifique el tamaño de destino mediante totalCoreCount (núcleos de CPU totales) o totalNodeCount (total de máquinas virtuales), pero no ambos en la misma solicitud. Devuelve la dirección URL a la operación que puede usar para realizar el seguimiento de su estado.

Parameters

Type	Name	Description	Schema
Path	cluster required	Clúster al que se van a agregar nodos	string
Path	nodearray required	El elemento nodearray al que se van a agregar nodos	string
Query	totalCoreCount optional	Número total de núcleos que se van a tener en esta matriz de nodos, incluidos los nodos ya creados.	integer
Query	totalNodeCount optional	Número total de máquinas que se van a tener en esta matriz de nodos, incluidos los nodos ya creados.	integer

Responses

Código HTTP	Description	Schema
202	Aceptado Encabezados : Location (cadena): dirección URL de la operación.	NodeCreationResult
409	Entrada no válida	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Respuesta HTTP de ejemplo

Respuesta 202

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

Obtención del estado del clúster

GET /clusters/{cluster}/status

Description

Esta operación contiene información para los nodos y nodearrays de un clúster determinado. Para cada elemento nodearray, devuelve el estado de cada "bucket" de asignación disponible. El estado incluye el número de nodos actual en el cubo y cuántos nodos más se pueden agregar. Cada cubo es un conjunto de máquinas virtuales posibles de un perfil de hardware determinado que se puede crear en una ubicación determinada en una cuenta de cliente determinada, etc. La definición del clúster del usuario determina los cubos válidos para un elemento nodearray, pero el proveedor de nube determina parcialmente los límites.

Parameters

Type	Name	Description	Schema
Path	cluster required	El clúster que se va a consultar	string
Query	nodes optional	Si es true, los nodos y las referencias de nodo se devuelven en la respuesta.	boolean

Responses

Código HTTP	Description	Schema
200	OK	ClusterStatus

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/status

Respuesta HTTP de ejemplo

Respuesta 200

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

Obtención de información sobre el uso y los costos opcionales de un clúster

GET /clusters/{cluster}/usage

Description

Esta operación devuelve datos generales de uso (horas básicas) y datos de costo, si están disponibles, para el clúster y un desglose por nodo. De forma predeterminada, devuelve el valor de uso del mes actual.

Parameters

Type	Name	Description	Schema
Path	cluster required	El clúster para devolver los datos de uso de	string
Query	período de tiempo optional	Intervalo de tiempo que se va a usar para la consulta. Valores válidos: monthToDate (mes actual), lastMonth (mes anterior), weekToDate (semana actual, inicio domingo) o custom (requiere los from parámetros de consulta y to ). El valor predeterminado es monthToDate. Todas las horas se muestran en UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Para períodos de tiempo personalizados, este valor es el inicio del período de tiempo en formato ISO-8601. Se redondea hacia abajo hasta la hora o el día más cercano.	string
Query	to optional	Para períodos de tiempo personalizados, este valor es el final del período de tiempo en formato ISO-8601. Se redondea hasta la hora o el día más cercano.	string
Query	granularidad optional	Especifica cómo agregar datos: cada hora, diariamente o como un único total. El intervalo predeterminado es diario.	enumeración (total, diaria, horaria)

Responses

Código HTTP	Description	Schema
200	OK	ClusterUsage

Solicitud HTTP de ejemplo

Ruta de solicitud

/clusters/CLUSTER_NAME/usage

Respuesta HTTP de ejemplo

Respuesta 200

{
  "usage" : [ "object" ]
}

Enumeración del estado de las operaciones

GET /operations/

Parameters

Type	Name	Description	Schema
Query	id_de_solicitud optional	Identificador de solicitud de la operación. Si se da este valor, la lista contiene 0 o 1 elemento.	string

Responses

Código HTTP	Description	Schema
200	OK	< OperationStatus> matriz
400	Solicitud no válida	Sin contenido
404	No encontrado	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

/operations/

Respuesta HTTP de ejemplo

Respuesta 200

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

Obtiene el estado de la operación por identificador.

GET /operations/{id}

Parameters

Type	Name	Description	Schema
Path	id required	El identificador de la operación	string

Responses

Código HTTP	Description	Schema
200	OK	OperationStatus
404	No encontrado	Sin contenido

Solicitud HTTP de ejemplo

Ruta de solicitud

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

Respuesta HTTP de ejemplo

Respuesta 200

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

Azure CycleCloud define un conjunto de modelos de recursos que describen clústeres, matrices de nodos, nodos y estado de asignación. La API REST devuelve estos recursos y proporciona detalles como los límites de capacidad, el uso y el estado del clúster. Use esta referencia para comprender la estructura y las propiedades de las respuestas de API al administrar y supervisar clústeres de CycleCloud mediante programación.

ClusterStatus

Estado del clúster

Name	Description	Schema
maxCoreCount required	Número máximo de núcleos que se pueden agregar a este clúster Ejemplo : 16	integer
maxCount required	Número máximo de nodos que se pueden agregar a este clúster Ejemplo : 4	integer
nodearrays required	Ejemplo : [ "object" ]	< nodearrays> matriz
nodes optional	Una lista opcional de nodos de este clúster, que solo se incluye si nodes=true está en la consulta. Ejemplo : [ "[node](#node)" ]	< Nodo> matriz
state optional	El estado actual del clúster, disponible después de al menos un inicio Ejemplo : "Starting"	string
targetState optional	Estado deseado del clúster (por ejemplo, Iniciado o Finalizado) Ejemplo : "Started"	string

nodearrays

Name	Description	Schema
buckets required	Cada cubo de asignación para este elemento nodearray. La configuración de "recuento de núcleos" siempre es un múltiplo del recuento de núcleos para este cubo. Ejemplo : [ "object" ]	< cubos> matriz
maxCoreCount required	Número máximo de núcleos que pueden estar en esta matriz de nodos Ejemplo : 16	integer
maxCount required	Número máximo de nodos que pueden estar en esta matriz de nodos Ejemplo : 4	integer
name required	Nombre de nodearray Ejemplo : "execute"	string
nodearray required	Atributos de esta clase nodearray Ejemplo : "[node](#node)"	Node

cubos

Name	Description	Schema
activeCoreCount required	Número de núcleos en uso para este cubo, en esta matriz de nodos Ejemplo : 40	integer
activeCount required	Número de nodos que se usan para este cubo, en esta matriz de nodos. Este número incluye nodos que todavía adquieren una máquina virtual. Ejemplo : 10	integer
activeNodes optional	Nombres de los nodos que se usan para este cubo dentro de nodearray, incluidos los nodos que todavía adquieren una máquina virtual. Se devuelve solo cuando la consulta incluye nodes=true. Ejemplo : [ "string" ]	<matriz de cadenas >
availableCoreCount required	Cuántos núcleos adicionales se pueden crear en este cubo, en esta matriz de nodos. Siempre hay un múltiplo de availableCount. Ejemplo : 8	integer
availableCount required	Número de nodos adicionales que se pueden crear en este cubo dentro de nodearray. El valor puede ser menor que maxCount menos usedCount porque maxCount puede limitarse por un límite global. Ejemplo : 2	integer
bucketId required	Identificador único del cubo. El valor sigue siendo el mismo para un cubo determinado en un elemento nodearray durante la vigencia del clúster. Ejemplo : "00000000-0000-0000-0000-000000000000"	string
consumedCoreCount required	Número de núcleos de esta familia que ya están en uso en toda la región. Ejemplo : 2	integer
definition optional	Propiedades usadas para crear nodos a partir de este cubo. La API create-nodes toma esta definición en su bucket propiedad . Ejemplo : "object"	definition
familyConsumedCoreCount optional	Número de núcleos de esta familia que ya están en uso en toda la región. Ejemplo : 2	integer
familyQuotaCoreCount optional	Número total de núcleos que se pueden ejecutar para esta familia de máquinas virtuales en la región. El valor no es necesariamente un entero múltiplo de familyQuotaCount. Ejemplo : 16	integer
familyQuotaCount optional	Número de instancias totales que se pueden iniciar (dada familyQuotaCoreCount) Ejemplo : 4	integer
invalidReason required	La razón por la que el cubo no es válido cuando valid es false. Actualmente, los únicos valores posibles son NotActivated y DisabledMachineType. Ejemplo : "DisabledMachineType"	string
lastCapacityFailure required	Número de segundos desde que este cubo experimentó un error de capacidad. Cualquier valor negativo se trata como nunca. Ejemplo : 180.0	number
maxCoreCount required	Número máximo de núcleos que pueden estar en este cubo, incluidos los límites globales y de nodoarray. Siempre un múltiplo de maxCount. Ejemplo : 16	integer
maxCount required	Número máximo de nodos que pueden estar en este cubo, incluidos los límites globales y de nodoarray. Ejemplo : 4	integer
maxPlacementGroupCoreSize required	Número total máximo de núcleos que pueden estar en un grupo de selección de ubicación de este cubo. Siempre un múltiplo de maxPlacementGroupSize. Ejemplo : 64	integer
maxPlacementGroupSize required	Número total máximo de instancias que pueden estar en un grupo de selección de ubicación en este cubo Ejemplo : 16	integer
placementGroups required	Los grupos de selección de ubicación que se usan para esta matriz de nodos, si los hay. Ejemplo : [ "object" ]	< placementGroups> matriz
quotaCoreCount required	El número total de núcleos que se pueden ejecutar para esta familia de máquinas virtuales en la región, teniendo en cuenta el recuento de núcleos de cuota regional. El valor no es necesariamente un entero múltiplo de quotaCount. Ejemplo : 16	integer
quotaCount required	Número de instancias totales que se pueden iniciar (dado quotaCoreCount) Ejemplo : 4	integer
regionalConsumedCoreCount optional	Número de núcleos que ya están en uso en toda la región. Ejemplo : 2	integer
regionalQuotaCoreCount optional	Número total de núcleos que se pueden ejecutar en la región. El valor no es necesariamente un entero múltiplo de regionalQuotaCount. Ejemplo : 16	integer
regionalQuotaCount optional	Número de instancias totales que se pueden iniciar (dada regionalQuotaCoreCount) Ejemplo : 4	integer
spotPlacementScore required	Puntuación de selección de ubicación de acceso puntual para este cubo que indica la probabilidad de disponibilidad de máquinas virtuales puntuales. Puede ser High, Medium, Low o una cadena vacía si no es aplicable. Ejemplo : "High"	string
válido required	Si es true, este cubo representa un cubo válido actualmente que se va a usar para los nuevos nodos. Si es false, este cubo representa solo los nodos existentes. Ejemplo : true	boolean
virtualMachine required	Las propiedades de las máquinas virtuales iniciadas desde este cubo Ejemplo : "object"	virtualMachine

definición

Name	Description	Schema
machineType required	Tamaño de máquina virtual de la máquina virtual Ejemplo : "A2"	string

placementGroups

Name	Description	Schema
activeCoreCount required	Cuántos núcleos hay en este conjunto de escalado Ejemplo : 16	integer
activeCount required	Cuántos nodos hay en este conjunto de escalado Ejemplo : 4	integer
name required	Identificador único de este grupo de selección de ubicación Ejemplo : "my-placement-group"	string

virtualMachine

Name	Description	Schema
gpuCount required	El número de GPU que tiene este tipo de máquina Ejemplo : 2	integer
infiniband required	Si esta máquina virtual admite la conectividad infiniBand Ejemplo : true	boolean
memory required	Ram en esta máquina virtual, en GB Ejemplo : 7.5	number
pcpuCount required	El número de CPU físicas que tiene este tipo de máquina Ejemplo : 16	integer
vcpuCount required	El número de CPU virtuales que tiene este tipo de máquina Ejemplo : 32	integer
vcpuQuotaCount optional	Número de vCPU que usa esta máquina a partir de la cuota Ejemplo : 2	integer

ClusterUsage

Información de uso y costo opcional para el clúster

Name	Description	Schema
usage required	Lista de usos por intervalo de tiempo Ejemplo : [ "object" ]	< uso> matriz

uso

Name	Description	Schema
desintegración required	Desglose del uso en este intervalo, por categoría de "node" y "nodearray" Ejemplo : [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> matriz
end required	Final del intervalo (exclusivo) Ejemplo : "string"	string
start required	El principio del intervalo (inclusivo) Ejemplo : "string"	string
total required	El uso general de este clúster en este intervalo, con una categoría de "clúster" Ejemplo : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Name	Description	Schema
category required	"cluster" para el uso general; "nodo" para un único nodo principal que no es de matriz; "nodearray" para una matriz de nodos completa Ejemplo : "string"	enum (cluster, node, nodearray)
cost optional	El importe que se cobraría por este uso, en dólares estadounidenses y a tarifas minoristas. Nota: todos los importes de costos son estimaciones y no reflejan la factura real. Ejemplo : 0.0	number
details optional	Detalles del tamaño de la máquina virtual que usa un elemento nodearray, incluidas las horas, los core_count, la región, la prioridad y el sistema operativo. Ejemplo : [ "object" ]	< detalles> matriz
hours required	Número de horas básicas de uso para esta categoría Ejemplo : 0.0	number
node optional	El nombre del nodo o nodearray para el que se usa (ausente para los datos de nivel de clúster) Ejemplo : "string"	string

detalles

Name	Description	Schema
core_count optional	El número de núcleos de este tamaño de máquina virtual Ejemplo : 0.0	number
cost optional	Costo de este tamaño de máquina virtual Ejemplo : 0.0	number
hours optional	El número de horas básicas de uso para este tamaño de máquina virtual Ejemplo : 0.0	number
os optional	Tipo de sistema operativo Ejemplo : "string"	enumeración (Windows, Linux)
priority optional	Prioridad de la SKU de máquina virtual Ejemplo : "string"	enum (Regular, Spot)
region optional	La región en la que se crea una instancia del tamaño de la máquina virtual Ejemplo : "string"	string
vm_size optional	Tamaño de la SKU de máquina virtual Ejemplo : "string"	string

Node

Un registro de nodo

Tipo: objeto

NodeCreationRequest

Especifica cómo agregar nodos a un clúster

Name	Description	Schema
requestId optional	Token único proporcionado por el usuario opcional para evitar operaciones duplicadas si hay errores de comunicación de red. Si se incluye este valor y coincide con un identificador de solicitud anterior, el servidor omite esta solicitud y devuelve un error 409. Ejemplo : "00000000-0000-0000-0000-000000000000"	string
conjuntos required	Lista de definiciones de nodo que se van a crear. La solicitud debe contener al menos un conjunto. Cada conjunto puede especificar un conjunto diferente de propiedades. Ejemplo : [ "object" ]	< conjuntos> matriz

conjuntos

Name	Description	Schema
count required	Número de nodos que se van a crear Ejemplo : 1	integer
definition optional	La definición del cubo que se va a usar, proporcionada por la llamada API de estado del clúster. Si faltan algunos de los elementos especificados en la llamada de estado o falta toda la propiedad bucket, se usa el primer cubo que coincide con los elementos especificados. Ejemplo : "object"	definition
nameFormat optional	Si se especifica, los nodos usan esta convención de nomenclatura en lugar del formato "nodearray-%d" estándar. Ejemplo : "custom-name-%d"	string
nameOffset optional	Si se especifica, junto con nameFormat, desplaza el índice de nodo para los nuevos nodos. Ejemplo : 1	integer
nodeAttributes optional	Atributos adicionales que se van a establecer en cada nodo de este conjunto Ejemplo : "[node](#node)"	Node
nodearray required	Nombre de nodearray desde el que se inician los nodos. Ejemplo : "execute"	string
placementGroupId optional	Si se indica, los nodos con el mismo valor para groupId se inician en el mismo grupo de selección de ubicación. Ejemplo : "string"	string

definición

Name	Description	Schema
machineType optional	Ejemplo : "A2"	string

NodeCreationResult

Name	Description	Schema
operationId required	Identificador de esta operación Ejemplo : "00000000-0000-0000-0000-000000000000"	string
conjuntos required	Matriz de conjuntos, en el mismo orden que en la solicitud Ejemplo : [ "object" ]	< conjuntos> matriz

conjuntos

Name	Description	Schema
agregado required	Cuántos nodos se iniciaron en este conjunto Ejemplo : 1	integer
message optional	Indica por qué no se pueden agregar todos los nodos solicitados, si están presentes. Ejemplo : "string"	string

NodeList

Resultados de una búsqueda de nodos

Name	Description	Schema
nodes required	Los nodos devueltos Ejemplo : [ "[node](#node)" ]	< Nodo> matriz
operation optional	Estado de una operación si la consulta incluye un identificador de operación. Ejemplo : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

Especifica cómo realizar acciones en nodos de un clúster. Hay varias maneras de especificar nodos y, si se incluye más de una manera, se trata como una unión.

Name	Description	Schema
filter optional	Expresión de filtro que coincide con los nodos. Las cadenas de la expresión deben estar entrecomilladas correctamente. Ejemplo : "State === \"Started\""	string
nombres de host optional	Lista de nombres de host cortos (sin dominio) que se van a administrar Ejemplo : [ "hostname1", "hostname2" ]	<matriz de cadenas >
ids optional	Lista de identificadores de nodo que se van a administrar Ejemplo : [ "id1", "id2" ]	<matriz de cadenas >
ip_addresses optional	Lista de direcciones IP que se van a administrar Ejemplo : [ "10.0.1.1", "10.1.1.2" ]	<matriz de cadenas >
names optional	Lista de nombres de nodo que se van a administrar Ejemplo : [ "name1", "name2" ]	<matriz de cadenas >
requestId optional	Token único proporcionado por el usuario opcional para evitar operaciones duplicadas si hay errores de comunicación de red. Si se incluye este valor y coincide con un identificador de solicitud anterior, el servidor omite esta solicitud y devuelve un error 409. Ejemplo : "00000000-0000-0000-0000-000000000000"	string

NodeManagementResult

Name	Description	Schema
nodes required	Matriz de información sobre cada nodo que coincide con el filtro en la solicitud de administración. El estado de cada nodo indica si la solicitud la ha afectado. Ejemplo : [ "object" ]	< nodos> matriz
operationId required	Identificador de esta operación Ejemplo : "00000000-0000-0000-0000-000000000000"	string

nodos

Name	Description	Schema
error optional	Mensaje de error cuando status es Error. Ejemplo : "This node must be terminated before it can be removed"	string
id required	Identificador del nodo Ejemplo : "id1"	string
name required	Nombre del nodo Ejemplo : "name1"	string
status optional	Uno de los errores o correctos Ejemplo : "Error"	enumeración (Ok, Error)

OperationStatus

Estado de esta operación de nodo

Name	Description	Schema
action required	Ejemplo : "string"	enum (create)
startTime required	Cuando se envió esta operación Ejemplo : "2020-01-01T12:34:56Z"	string (fecha y hora)