Operaciones

  • Artículo

Obtención de nodos de clúster

GET /clusters/{cluster}/nodes

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 El clúster que se va a consultar cuerda
consulta de de operación de
opcional		 Si se indica, devuelve solo los nodos para este identificador de operación e incluye el atributo operation en el cuerpo. cuerda
consulta de request_id
opcional		 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		 cuerda

Respuestas

Código HTTP Descripción Esquema
200 De acuerdo NodeList de
400 Especificación no válida Sin contenido
404 No encontrado Sin contenido

Solicitud HTTP de ejemplo

Ruta de acceso 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

Descripción

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.

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 Clúster al que se van a agregar nodos cuerda
cuerpo de nodos de
necesarios		 Conjuntos de nodos que se van a crear NodeCreationRequest de

Respuestas

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

Solicitud HTTP de ejemplo

Ruta de acceso 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

Descripción

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.

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 Clúster en el que se desasignar los nodos cuerda
cuerpo de acción
necesarios		 Descripción de los nodos que se van a desasignar NodeManagementRequest

Respuestas

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

Solicitud HTTP de ejemplo

Ruta de acceso 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"
}

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

POST /clusters/{cluster}/nodes/remove

Descripción

Esta operación quita 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. Tenga en cuenta que, de forma predeterminada, los nodos se quitan cuando finalizan (a menos que el nodo se haya establecido en true), en cuyo caso esta llamada no es diferente de finalizar.

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 Clúster en el que se van a quitar nodos cuerda
cuerpo de acción
necesarios		 Descripción de los nodos que se van a quitar NodeManagementRequest

Respuestas

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

Solicitud HTTP de ejemplo

Ruta de acceso 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"
}

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

POST /clusters/{cluster}/nodes/shutdown

Descripción

Esta operación finaliza o desasigna los nodos de un clúster, en función de si el atributo ShutdownPolicy de cada nodo es Terminate (el valor predeterminado) o Desasignar, respectivamente.

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 El clúster en el que se apagarán los nodos cuerda
cuerpo de acción
necesarios		 Descripción de los nodos que se van a apagar NodeManagementRequest

Respuestas

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

Solicitud HTTP de ejemplo

Ruta de acceso 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

Descripción

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.

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 El clúster en el que se inician los nodos cuerda
cuerpo de acción
necesarios		 Descripción de los nodos que se van a iniciar NodeManagementRequest

Respuestas

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

Solicitud HTTP de ejemplo

Ruta de acceso 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

Descripción

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.

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 Clúster en el que finalizar los nodos cuerda
cuerpo de acción
necesarios		 Descripción de los nodos que se van a finalizar NodeManagementRequest

Respuestas

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

Solicitud HTTP de ejemplo

Ruta de acceso 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"
}

Escalado del clúster al tamaño

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

Descripción

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. Esto escala por núcleos totales o nodos totales, pero no ambos. Devuelve la dirección URL a la operación que se puede usar para realizar el seguimiento del estado de la operación.

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 Clúster al que se van a agregar nodos cuerda
de ruta de acceso de nodearray
necesarios		 El elemento nodearray al que se van a agregar nodos cuerda
consulta de totalCoreCount
opcional		 Número total de núcleos que se van a tener en esta matriz de nodos, incluidos los nodos ya creados. entero
consulta de totalNodeCount
opcional		 Número total de máquinas que se van a tener en esta matriz de nodos, incluidos los nodos ya creados. entero

Respuestas

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

Solicitud HTTP de ejemplo

Ruta de acceso 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

Descripción

Esta operación contiene información para los nodos y nodearrays de un clúster determinado. Para cada nodoarray, devuelve el estado de cada "cubo" de asignación que se puede usar, como el número de nodos en el cubo, cuántos más se pueden agregar, etcetera. 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, etcetera. La definición de clúster del usuario determina los depósitos válidos de un nodoarray, pero los límites se determinan en parte por el proveedor de nube.

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 El clúster que se va a consultar cuerda
consulta de de nodos de
opcional		 Si es true, los nodos y las referencias de nodo se devuelven en la respuesta. booleano

Respuestas

Código HTTP Descripción Esquema
200 De acuerdo clusterStatus de

Solicitud HTTP de ejemplo

Ruta de acceso 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

Descripción

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

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de clúster de
necesarios		 El clúster para devolver los datos de uso de cuerda
consulta de período de tiempo
opcional		 Si se especifica, especifica el intervalo de tiempo que se va a usar para la consulta. monthToDate devuelve el uso del mes actual y lastMonth devuelve el uso del mes anterior. weekToDate devuelve el uso de la semana actual (a partir del domingo). custom requiere para los parámetros de consulta "from" y "to". El valor predeterminado es MonthToDate. Todas las horas están en UTC. enum (monthToDate, lastMonth, weekToDate, custom)
consulta de de
opcional		 En el caso de los períodos de tiempo personalizados, este es el inicio del período de tiempo en formato ISO-8601. Esto se redondea hacia abajo hasta la hora o el día más cercano. cuerda
consulta de
opcional		 Para períodos de tiempo personalizados, este es el final del período de tiempo en formato ISO-8601. Esto se redondea hasta la hora o el día más cercano. cuerda
consulta de de granularidad
opcional		 Especifica cómo agregar datos: por hora, por día o como un solo número. Este valor predeterminado es diario. enumeración (total, diaria, horaria)

Respuestas

Código HTTP Descripción Esquema
200 De acuerdo ClusterUsage

Solicitud HTTP de ejemplo

Ruta de acceso de solicitud

/clusters/CLUSTER_NAME/usage

Respuesta HTTP de ejemplo

Respuesta 200

{
  "usage" : [ "object" ]
}

Enumera el estado de las operaciones

GET /operations/

Parámetros

Tipo Nombre Descripción Esquema
consulta de request_id
opcional		 Identificador de solicitud de la operación. Si se proporciona esto, la lista solo tendrá 0 o 1 elemento en ella. cuerda

Respuestas

Código HTTP Descripción Esquema
200 De acuerdo Matriz de operationStatus de
400 Solicitud no válida Sin contenido
404 No encontrado Sin contenido

Solicitud HTTP de ejemplo

Ruta de acceso 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}

Parámetros

Tipo Nombre Descripción Esquema
de ruta de acceso de de identificador de
necesarios		 El identificador de la operación cuerda

Respuestas

Código HTTP Descripción Esquema
200 De acuerdo OperationStatus
404 No encontrado Sin contenido

Solicitud HTTP de ejemplo

Ruta de acceso de solicitud

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

Respuesta HTTP de ejemplo

Respuesta 200

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

Recursos

ClusterStatus

Estado del clúster

Nombre Descripción Esquema
maxCoreCount
necesarios		 Número máximo de núcleos que se pueden agregar a este clúster
de ejemplo de : 		entero
maxCount
necesarios		 Número máximo de nodos que se pueden agregar a este clúster
de ejemplo de : 		entero
nodearrays
necesarios		 de ejemplo de : matriz nodearrays
de nodos de
opcional		 Una lista opcional de nodos de este clúster, que solo se incluye si nodes=true está en la consulta.
de ejemplo de : 		matriz de node
de estado de
opcional		 Estado actual del clúster, si se ha iniciado al menos una vez.
de ejemplo de : 		cuerda
targetState
opcional		 Estado deseado del clúster (por ejemplo, Iniciado o Finalizado)
de ejemplo de : 		cuerda

nodearrays

Nombre Descripción Esquema
depósitos
necesarios		 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.
de ejemplo de : 		< matriz de cubos>
maxCoreCount
necesarios		 Número máximo de núcleos que pueden estar en esta matriz de nodos
de ejemplo de : 		entero
maxCount
necesarios		 Número máximo de nodos que pueden estar en esta matriz de nodos
de ejemplo de : 		entero
nombre
necesarios		 El elemento nodearray que describe
de ejemplo de : 		cuerda
nodearray
necesarios		 Atributos de esta clase nodearray
de ejemplo de : 		de nodo

depósitos

Nombre Descripción Esquema
activeCoreCount
necesarios		 Número de núcleos en uso para este cubo, en esta matriz de nodos
de ejemplo de : 		entero
activeCount
necesarios		 Número de nodos que se usan para este cubo, en esta matriz de nodos. Esto incluye nodos que todavía adquieren una máquina virtual.
de ejemplo de : 		entero
activeNodes
opcional		 Los nombres de nodo que se usan para este cubo, en esta matriz de nodos. Esto incluye nodos que todavía adquieren una máquina virtual. Esto solo se incluye si nodes=true está en la consulta.
de ejemplo de : 		matriz de > de cadena de <
availableCoreCount
necesarios		 Cuántos núcleos adicionales se pueden crear en este cubo, en esta matriz de nodos. Siempre hay un múltiplo de availableCount.
de ejemplo de : 		entero
availableCount
necesarios		 Número de nodos adicionales que se pueden crear en este cubo, en esta matriz de nodos. Tenga en cuenta que esto puede ser menor que implícito en maxCount y usedCount, ya que maxCount puede estar limitado globalmente.
de ejemplo de : 		entero
bucketId de
necesarios		 Identificador de este cubo. Esto siempre tendrá el mismo valor para un cubo determinado en un elemento nodearray, siempre que el clúster no se elimine.
de ejemplo de : 		cuerda
consumedCoreCount
necesarios		 Número de núcleos de esta familia que ya están en uso en toda la región.
de ejemplo de : 		entero
de definición de
opcional		 Las propiedades de este cubo, que se usan para crear nodos a partir de este cubo. La API create-nodes toma esta definición en su propiedad bucket.
de ejemplo de : 		de definición de
familyConsumedCoreCount
opcional		 Número de núcleos de esta familia que ya están en uso en toda la región.
de ejemplo de : 		entero
familyQuotaCoreCount
opcional		 Número de núcleos totales que se pueden iniciar para esta familia en esta región. Es posible que no sea un entero múltiplo de quotaCount.
de ejemplo de : 		entero
familyQuotaCount
opcional		 Número de instancias totales que se pueden iniciar (dada familyQuotaCoreCount)
de ejemplo de : 		entero
invalidReason
necesarios		 Si es válido es false, esto contendrá el motivo por el que el cubo no es válido. Actualmente NotActivated y DisabledMachineType son las únicas razones.
de ejemplo de : 		cuerda
lastCapacityFailure
necesarios		 Cuánto tiempo, en segundos, desde la última vez que este cubo experimentó un error de capacidad. Cualquier valor negativo se trata como nunca.
de ejemplo de : 		número
maxCoreCount
necesarios		 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.
de ejemplo de : 		entero
maxCount
necesarios		 Número máximo de nodos que pueden estar en este cubo, incluidos los límites globales y de nodoarray.
de ejemplo de : 		entero
maxPlacementGroupCoreSize
necesarios		 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.
de ejemplo de : 		entero
maxPlacementGroupSize
necesarios		 Número total máximo de instancias que pueden estar en un grupo de selección de ubicación en este cubo
de ejemplo de : 		entero
placementGroups
necesarios		 Los grupos de selección de ubicación que se usan para esta matriz de nodos, si los hay.
de ejemplo de : 		matriz de <placementGroups>
quotaCoreCount
necesarios		 Número de núcleos totales que se pueden iniciar para esta familia en esta región, teniendo en cuenta también el recuento de núcleos de cuota regional. Es posible que no sea un entero múltiplo de quotaCount.
de ejemplo de : 		entero
quotaCount de
necesarios		 Número de instancias totales que se pueden iniciar (dado quotaCoreCount)
de ejemplo de : 		entero
regionalConsumedCoreCount
opcional		 Número de núcleos que ya están en uso en toda la región.
de ejemplo de : 		entero
regionalQuotaCoreCount
opcional		 Número de núcleos totales que se pueden iniciar en esta región. Es posible que no sea un entero múltiplo de regionalQuotaCount.
de ejemplo de : 		entero
regionalQuotaCount
opcional		 Número de instancias totales que se pueden iniciar (dada regionalQuotaCoreCount)
de ejemplo de : 		entero
válidos
necesarios		 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.
de ejemplo de : 		booleano
virtualMachine
necesarios		 Las propiedades de las máquinas virtuales iniciadas desde este cubo
de ejemplo de : 		virtualMachine

de definición de

Nombre Descripción Esquema
machineType
necesarios		 Tamaño de máquina virtual de la máquina virtual
de ejemplo de : 		cuerda

placementGroups

Nombre Descripción Esquema
activeCoreCount
necesarios		 Cuántos núcleos hay en este conjunto de escalado
de ejemplo de : 		entero
activeCount
necesarios		 Cuántos nodos hay en este conjunto de escalado
de ejemplo de : 		entero
nombre
necesarios		 Identificador único de este grupo de selección de ubicación
de ejemplo de : 		cuerda

virtualMachine

Nombre Descripción Esquema
gpuCount
necesarios		 El número de GPU que tiene este tipo de máquina
de ejemplo de : 		entero
infiniband
necesarios		 Si esta máquina virtual admite la conectividad infiniBand
de ejemplo de : 		booleano
de memoria de
necesarios		 Ram en esta máquina virtual, en GB
de ejemplo de : 		número
pcpuCount de
necesarios		 El número de CPU físicas que tiene este tipo de máquina
de ejemplo de : 		entero
vcpuCount
necesarios		 El número de CPU virtuales que tiene este tipo de máquina
de ejemplo de : 		entero
vcpuQuotaCount
opcional		 Número de vCPU que usa esta máquina a partir de la cuota
de ejemplo de : 		entero

ClusterUsage

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

Nombre Descripción Esquema
de uso de
necesarios		 Lista de usos por intervalo de tiempo
de ejemplo de : 		matriz de de uso de

de uso

Nombre Descripción Esquema
desglose
necesarios		 Desglose del uso en este intervalo, por categoría de "node" y "nodearray"
de ejemplo de : 		matriz de ClusterUsageItem
final de
necesarios		 Final del intervalo (exclusivo)
de ejemplo de : 		cuerda
iniciar
necesarios		 El principio del intervalo (inclusivo)
de ejemplo de : 		cuerda
total de
necesarios		 El uso general de este clúster en este intervalo, con una categoría de "clúster"
de ejemplo de : 		ClusterUsageItem

ClusterUsageItem

Nombre Descripción Esquema
de categoría
necesarios		 "cluster" para el uso general; "nodo" para un único nodo principal que no es de matriz; "nodearray" para una matriz de nodos completa
de ejemplo de : 		enum (cluster, node, nodearray)
de costos
opcional		 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.
de ejemplo de : 		número
detalles
opcional		 Detalles del tamaño de máquina virtual que usa un elemento nodearray, incluidas las horas, core_count, la prioridad de la región y el sistema operativo.
de ejemplo de : 		< detalles> matriz
horas
necesarios		 Número de horas básicas de uso para esta categoría
de ejemplo de : 		número
de nodo de
opcional		 El nombre del nodo o nodearray para el que se usa (ausente para los datos de nivel de clúster)
de ejemplo de : 		cuerda

detalles

Nombre Descripción Esquema
core_count
opcional		 El número de núcleos de este tamaño de máquina virtual
de ejemplo de : 		número
de costos
opcional		 Costo de este tamaño de máquina virtual
de ejemplo de : 		número
horas
opcional		 El número de horas básicas de uso para este tamaño de máquina virtual
de ejemplo de : 		número
del sistema operativo
opcional		 Tipo de sistema operativo
de ejemplo de : 		enumeración (Windows, Linux)
de prioridad
opcional		 Prioridad de la SKU de máquina virtual
de ejemplo de : 		enum (Regular, Spot)
de región de
opcional		 La región en la que se crea una instancia del tamaño de la máquina virtual
de ejemplo de : 		cuerda
vm_size
opcional		 Tamaño de SKU de máquina virtual
de ejemplo de : 		cuerda

Nodo

Un registro de nodo

Type : object

NodeCreationRequest

Especifica cómo agregar nodos a un clúster

Nombre Descripción Esquema
requestId
opcional		 Token único proporcionado por el usuario opcional para evitar operaciones duplicadas en caso de errores de comunicación de red. Si se incluye y coincide con un identificador de solicitud anterior, el servidor omite esta solicitud y devuelve un error 409.
de ejemplo de : 		cuerda
establece
necesarios		 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.
de ejemplo de : 		< establece> matriz

establece

Nombre Descripción Esquema
recuento de
necesarios		 Número de nodos que se van a crear
de ejemplo de : 		entero
de definición de
opcional		 Definición del cubo que se va a usar. Esto lo proporciona 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.
de ejemplo de : 		de definición de
nameFormat
opcional		 Si se especifica, los nodos usarán esta convención de nomenclatura en lugar del formato "nodearray-%d" estándar.
de ejemplo de : 		cuerda
nameOffset
opcional		 Si se especifica, junto con nameFormat, desplaza nodeindex para los nuevos nodos.
de ejemplo de : 		entero
nodeAttributes
opcional		 Atributos adicionales que se van a establecer en cada nodo de este conjunto
de ejemplo de : 		de nodo
nodearray
necesarios		 Nombre de nodearray desde el que se inician los nodos.
de ejemplo de : 		cuerda
placementGroupId
opcional		 Si se indica, todos los nodos con el mismo valor para groupId se iniciarán en el mismo grupo de selección de ubicación.
de ejemplo de : 		cuerda

de definición de

Nombre Descripción Esquema
machineType
opcional		 de ejemplo de : cuerda

NodeCreationResult

Nombre Descripción Esquema
operationId
necesarios		 Identificador de esta operación
de ejemplo de : 		cuerda
establece
necesarios		 Matriz de conjuntos, en el mismo orden que en la solicitud
de ejemplo de : 		< establece> matriz

establece

Nombre Descripción Esquema
agregado
necesarios		 Cuántos nodos se iniciaron en este conjunto
de ejemplo de : 		entero
de mensajes
opcional		 Indica por qué no se pueden agregar todos los nodos solicitados, si están presentes.
de ejemplo de : 		cuerda

NodeList

Resultados de una búsqueda de nodos

Nombre Descripción Esquema
de nodos de
necesarios		 Los nodos devueltos
de ejemplo de : 		matriz de node
de operación de
opcional		 Si la consulta incluye un identificador de operación, este es el estado de esa operación.
de ejemplo de : 		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.

Nombre Descripción Esquema
de filtro
opcional		 Expresión de filtro que coincide con los nodos. Tenga en cuenta que las cadenas de la expresión deben estar entrecomilladas correctamente.
de ejemplo de : 		cuerda
nombres de host
opcional		 Lista de nombres de host cortos (sin dominio) que se van a administrar
de ejemplo de : 		matriz de > de cadena de <
identificadores de
opcional		 Lista de identificadores de nodo que se van a administrar
de ejemplo de : 		matriz de > de cadena de <
ip_addresses
opcional		 Lista de direcciones IP que se van a administrar
de ejemplo de : 		matriz de > de cadena de <
nombres
opcional		 Lista de nombres de nodo que se van a administrar
de ejemplo de : 		matriz de > de cadena de <
requestId
opcional		 Token único proporcionado por el usuario opcional para evitar operaciones duplicadas en caso de errores de comunicación de red. Si se incluye y coincide con un identificador de solicitud anterior, el servidor omite esta solicitud y devuelve un error 409.
de ejemplo de : 		cuerda

NodeManagementResult

Nombre Descripción Esquema
de nodos de
necesarios		 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 se vio afectado por la solicitud.
de ejemplo de : 		< nodos> matriz
operationId
necesarios		 Identificador de esta operación
de ejemplo de : 		cuerda

de nodos de

Nombre Descripción Esquema
de error
opcional		 Si el estado es Error, contiene el mensaje de error.
de ejemplo de : 		cuerda
de identificador de
necesarios		 Identificador del nodo
de ejemplo de : 		cuerda
nombre
necesarios		 Nombre del nodo
de ejemplo de : 		cuerda
de estado de
opcional		 Uno de los errores o correctos
de ejemplo de : 		enumeración (Ok, Error)

OperationStatus

Estado de esta operación de nodo

Nombre Descripción Esquema
de acción
necesarios		 de ejemplo de : enum (create)
startTime
necesarios		 Cuando se envió esta operación
de ejemplo de : 		string (fecha y hora)