Operations

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	request_id 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

HTTP Code	Description	Schema
200	OK	NodeList
400	Invalid specification	No Content
404	Not found	No Content

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/nodes

Respuesta HTTP de ejemplo

Response 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 una matriz de nodos a un clúster. Acepta varias definiciones de nodo en una sola llamada. Devuelve la dirección URL a la operación que 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

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (string) : la dirección URL de la operación.	NodeCreationResult
409	Invalid input	No Content

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/nodes/create

Request body

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

Respuesta HTTP de ejemplo

Response 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. Puede identificar los nodos mediante varios métodos, como el nombre del nodo, el identificador de nodo o un filtro.

Parameters

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

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (string) : la dirección URL de la operación.	NodeManagementResult
409	Invalid input	No Content

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/nodes/deallocate

Request body

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

Response 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 de varias maneras, incluido el nombre del nodo, el identificador de nodo o mediante un filtro. De forma predeterminada, los nodos se quitan cuando finalizan a menos que el nodo tenga la Fixed propiedad establecida trueen . En ese caso, esta llamada actúa igual que finalizar.

Parameters

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

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (string) : la dirección URL de la operación.	NodeManagementResult
409	Invalid input	No Content

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/nodes/remove

Request body

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

Response 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 operación finaliza o desasigna los nodos de un clúster. La operación usa el ShutdownPolicy atributo en cada nodo para determinar la acción. Si el atributo se establece en Terminate (valor predeterminado), la operación finaliza el nodo. Si el atributo se establece Deallocateen , la operación desasigna el nodo.

Parameters

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

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (string) : la dirección URL de la operación.	NodeManagementResult
409	Invalid input	No Content

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/nodes/shutdown

Request body

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

Response 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. Puede identificar los nodos por nombre de nodo, identificador de nodo o mediante un 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

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (string) : la dirección URL de la operación.	NodeManagementResult
409	Invalid input	No Content

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/nodes/start

Request body

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

Response 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. Puede identificar los nodos de varias maneras, incluido el nombre del nodo, el identificador de nodo o mediante un filtro.

Parameters

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

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (string) : la dirección URL de la operación.	NodeManagementResult
409	Invalid input	No Content

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/nodes/terminate

Request body

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

Response 202

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

Escalado del clúster al tamaño

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

Description

Esta operación agrega nodos según sea necesario a una matriz de nodos para alcanzar un recuento total. El clúster procesa la solicitud una vez. No vuelve a agregar nodos más adelante para mantener el número. Puede escalar por núcleos totales o nodos totales, pero no ambos. La operación devuelve la dirección URL que se va a 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
Path	nodearray required	Matriz de nodos a la que se van a agregar nodos	string
Query	totalCoreCount optional	Número total de núcleos de esta matriz de nodos, incluidos los nodos que ya ha creado.	integer
Query	totalNodeCount optional	Número total de máquinas de esta matriz de nodos, incluidos los nodos que ya ha creado.	integer

Responses

HTTP Code	Description	Schema
202	Accepted Headers : `Location` (string) : la dirección URL de la operación.	NodeCreationResult
409	Invalid input	No Content

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Respuesta HTTP de ejemplo

Response 202

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

Obtención del estado del clúster

GET /clusters/{cluster}/status

Description

Esta operación devuelve información de los nodos y matrices de nodos de un clúster. Para cada matriz de nodos, devuelve el estado de cada "cubo" de asignación que puede usar. El estado muestra cuántos nodos se encuentran en el cubo y cuántos nodos más se pueden agregar. Cada cubo es un conjunto de máquinas virtuales posibles con un perfil de hardware específico. Puede crear estas máquinas virtuales en una ubicación específica en una cuenta de cliente. La definición del clúster del usuario determina los cubos válidos para una matriz de nodos. El proveedor de nube determina 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, la respuesta incluye nodos y referencias de nodo.	boolean

Responses

HTTP Code	Description	Schema
200	OK	ClusterStatus

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/status

Respuesta HTTP de ejemplo

Response 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, así como un desglose por nodoarray. 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	timeframe optional	Intervalo de tiempo de 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 se muestran en UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Para períodos de tiempo personalizados, el inicio del período de tiempo en formato ISO-8601. El valor se redondea hacia abajo hasta la hora o el día más cercano.	string
Query	to optional	Para períodos de tiempo personalizados, use el final del período de tiempo en formato ISO-8601. El valor se redondea hasta la hora o el día más cercano.	string
Query	granularity optional	Especifica cómo agregar datos: por hora, por día o como un solo número. El valor predeterminado es diario.	enumeración (total, diaria, horaria)

Responses

HTTP Code	Description	Schema
200	OK	ClusterUsage

Solicitud HTTP de ejemplo

Request path

/clusters/CLUSTER_NAME/usage

Respuesta HTTP de ejemplo

Response 200

{
  "usage" : [ "object" ]
}

Enumera el estado de las operaciones

GET /operations/

Parameters

Type	Name	Description	Schema
Query	request_id optional	Identificador de solicitud de la operación. Si proporciona este identificador, la lista contiene cero o un elemento.	string

Responses

HTTP Code	Description	Schema
200	OK	< OperationStatus> array
400	Invalid request	No Content
404	Not found	No Content

Solicitud HTTP de ejemplo

Request path

/operations/

Respuesta HTTP de ejemplo

Response 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

HTTP Code	Description	Schema
200	OK	OperationStatus
404	Not found	No Content

Solicitud HTTP de ejemplo

Request path

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

Respuesta HTTP de ejemplo

Response 200

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

Resources

ClusterStatus

Estado del clúster.

Name	Description	Schema
maxCoreCount required	Número máximo de núcleos que puede agregar a este clúster. Example : `16`	integer
maxCount required	Número máximo de nodos que puede agregar a este clúster. Example : `4`	integer
nodearrays required	Example : `[ "object" ]`	< nodearrays> array
nodes optional	Lista opcional de nodos de este clúster. La respuesta incluye esta lista solo si se establece `nodes=true` en la consulta. Example : `[ "[node](#node)" ]`	< Node> array
state optional	Estado actual del clúster, si el clúster se inició al menos una vez. Example : `"Starting"`	string
targetState optional	Estado deseado del clúster (por ejemplo, Iniciado o Finalizado) Example : `"Started"`	string

nodearrays

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

buckets

Name	Description	Schema
activeCoreCount required	Número de núcleos en uso para este cubo, en esta matriz de nodos Example : `40`	integer
activeCount required	Número de nodos que se usan para este cubo, en esta matriz de nodos. Este recuento incluye nodos que todavía adquieren una máquina virtual. Example : `10`	integer
activeNodes optional	Los nombres de nodo que se usan para este cubo, en esta matriz de nodos. Esta lista incluye nodos que todavía adquieren una máquina virtual. La respuesta incluye esta propiedad solo si la consulta contiene `nodes=true`. Example : `[ "string" ]`	<matriz de cadenas >
availableCoreCount required	Cuántos núcleos adicionales puede crear en este cubo y matriz de nodos. Este valor siempre es un múltiplo de `availableCount`. Example : `8`	integer
availableCount required	Cuántos nodos adicionales puede crear en este cubo y matriz de nodos. Este valor puede ser menor que el número que obtiene al restar `usedCount` de `maxCount`, ya que `maxCount` podría tener un límite global. Example : `2`	integer
bucketId required	Identificador de este cubo. Este valor permanece igual para un cubo determinado en una matriz de nodos siempre que no elimine el clúster. Example : `"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. Example : `2`	integer
definition optional	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 `bucket` propiedad . Example : `"object"`	definition
familyConsumedCoreCount optional	Número de núcleos de esta familia que ya están en uso en toda la región. Example : `2`	integer
familyQuotaCoreCount optional	Número de núcleos totales que puede iniciar para esta familia en esta región. Es posible que este número no sea un entero múltiplo de quotaCount. Example : `16`	integer
familyQuotaCount optional	Número de instancias totales que puede iniciar al establecer familyQuotaCoreCount. Example : `4`	integer
invalidReason required	Si es válido es false, el campo contiene el motivo por el que el cubo no es válido. Actualmente NotActivated y DisabledMachineType son las únicas razones. Example : `"DisabledMachineType"`	string
lastCapacityFailure required	Cuánto tiempo, en segundos, desde la última vez que este cubo experimentó un error de capacidad. Cualquier valor negativo se trata como nunca. Example : `180.0`	number
maxCoreCount required	El 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. Example : `16`	integer
maxCount required	El número máximo de nodos que pueden estar en este cubo, incluidos los límites globales y de nodoarray. Example : `4`	integer
maxPlacementGroupCoreSize required	Número total máximo de núcleos de un grupo de selección de ubicación para este cubo. Siempre un múltiplo de `maxPlacementGroupSize`. Example : `64`	integer
maxPlacementGroupSize required	Número total máximo de instancias de un grupo de selección de ubicación para este cubo. Example : `16`	integer
placementGroups required	Los grupos de selección de ubicación que se usan para esta matriz de nodos, si los hay. Example : `[ "object" ]`	< placementGroups> array
quotaCoreCount required	Número de núcleos totales que puede iniciar para esta familia en esta región. Este número también tiene en cuenta el recuento de núcleos de cuota regional. Es posible que este valor no sea un entero múltiplo de quotaCount. Example : `16`	integer
quotaCount required	Número de instancias totales que se pueden iniciar, dada la cuotaCoreCount. Example : `4`	integer
regionalConsumedCoreCount optional	Número de núcleos que ya están en uso en toda la región. Example : `2`	integer
regionalQuotaCoreCount optional	Número de núcleos totales que puede iniciar en esta región. Es posible que este número no sea un entero múltiplo de regionalQuotaCount. Example : `16`	integer
regionalQuotaCount optional	Número de instancias totales que puede iniciar (dada regionalQuotaCoreCount) Example : `4`	integer
valid 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. Example : `true`	boolean
virtualMachine required	Las propiedades de las máquinas virtuales que se inician desde este cubo Example : `"object"`	virtualMachine

definition

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

placementGroups

Name	Description	Schema
activeCoreCount required	El número de núcleos de este conjunto de escalado Example : `16`	integer
activeCount required	Número de nodos de este conjunto de escalado Example : `4`	integer
name required	Identificador único de este grupo de selección de ubicación Example : `"my-placement-group"`	string

virtualMachine

Name	Description	Schema
gpuCount required	El número de GPU que tiene este tipo de máquina Example : `2`	integer
infiniband required	Si esta máquina virtual admite la conectividad infiniBand Example : `true`	boolean
memory required	Ram en esta máquina virtual, en GB Example : `7.5`	number
pcpuCount required	El número de CPU físicas que tiene este tipo de máquina Example : `16`	integer
vcpuCount required	Número de CPU virtuales para este tipo de máquina Example : `32`	integer
vcpuQuotaCount optional	Número de vCPU que usa esta máquina a partir de la cuota Example : `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 Example : `[ "object" ]`	< usage> array

usage

Name	Description	Schema
breakdown required	Desglose del uso en este intervalo, por categoría de "node" y "nodearray" Example : `[ "[clusterusageitem](#clusterusageitem)" ]`	< ClusterUsageItem> array
end required	Final del intervalo (exclusivo) Example : `"string"`	string
start required	El principio del intervalo (inclusivo) Example : `"string"`	string
total required	El uso general de este clúster en este intervalo, con una categoría de "clúster" Example : `"[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 Example : `"string"`	enum (cluster, node, nodearray)
cost optional	Cantidad que se va a cobrar 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. Example : `0.0`	number
details optional	Detalles del tamaño de la máquina virtual que usa un elemento nodearray, incluidas las horas, el recuento de núcleos, la prioridad de la región y el sistema operativo. Example : `[ "object" ]`	< details> array
hours required	Número de horas básicas de uso para esta categoría Example : `0.0`	number
node optional	Nombre del nodo o matriz de nodos para el que se usa (ausente para los datos de nivel de clúster) Example : `"string"`	string

details

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

Node

Un registro de nodo.

Type : object

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 en caso de errores de comunicación de red. Si el servidor recibe una solicitud con un `requestId` que coincide con una solicitud anterior, omite la solicitud y devuelve un error 409. Example : `"00000000-0000-0000-0000-000000000000"`	string
sets 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. Example : `[ "object" ]`	< sets> array

sets

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

definition

Name	Description	Schema
machineType optional	Example : `"A2"`	string

NodeCreationResult

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

sets

Name	Description	Schema
added required	Número de nodos que se van a agregar en el conjunto Example : `1`	integer
message optional	Explica por qué el sistema no puede agregar todos los nodos solicitados, si están presentes Example : `"string"`	string

NodeList

Resultados de una búsqueda de nodos

Name	Description	Schema
nodes required	Nodos que devuelve el sistema Example : `[ "[node](#node)" ]`	< Node> array
operation optional	Si la consulta incluye un identificador de operación, este campo muestra el estado de esa operación. Example : `"[operationstatus](#operationstatus)"`	OperationStatus

NodeManagementRequest

Especifica cómo realizar acciones en nodos de un clúster. Puede especificar nodos de varias maneras. Si incluye más de una manera, la solicitud trata la especificación como una unión.

Name	Description	Schema
filter optional	Expresión de filtro que coincide con los nodos. Tenga en cuenta que las cadenas de la expresión deben estar entrecomilladas correctamente. Example : `"State === \"Started\""`	string
hostnames optional	Lista de nombres de host cortos (sin dominio) que se van a administrar Example : `[ "hostname1", "hostname2" ]`	<matriz de cadenas >
ids optional	Lista de identificadores de nodo que se van a administrar Example : `[ "id1", "id2" ]`	<matriz de cadenas >
ip_addresses optional	Lista de direcciones IP que se van a administrar Example : `[ "10.0.1.1", "10.1.1.2" ]`	<matriz de cadenas >
names optional	Lista de nombres de nodo que se van a administrar Example : `[ "name1", "name2" ]`	<matriz de cadenas >
requestId optional	Token único proporcionado por el usuario opcional para evitar operaciones duplicadas en caso de errores de comunicación de red. Si el servidor recibe una solicitud con un `requestId` que coincide con un identificador de solicitud anterior, omite la solicitud y devuelve un error 409. Example : `"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 afecta. Example : `[ "object" ]`	< nodes> array
operationId required	Identificador de esta operación Example : `"00000000-0000-0000-0000-000000000000"`	string

nodes

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

OperationStatus

Estado de la operación de nodo.

Name	Description	Schema
action required	Example : `"string"`	enum (create)
startTime required	Cuando envió la operación Example : `"2020-01-01T12:34:56Z"`	string (date-time)

Comentarios

¿Le ha resultado útil esta página?

Last updated on 2025-07-16

Compartir a través de

Operations

Obtención de nodos de clúster

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Respuesta HTTP de ejemplo

Response 200

Creación de nodos de clúster

Description

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Request body

Respuesta HTTP de ejemplo

Response 202

Desasignar nodos de clúster

Description

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Request body

Respuesta HTTP de ejemplo

Response 202

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

Description

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Request body

Respuesta HTTP de ejemplo

Response 202

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

Description

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Request body

Respuesta HTTP de ejemplo

Response 202

Inicio de nodos de clúster desasignados o terminados

Description

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Request body

Respuesta HTTP de ejemplo

Response 202

Finalización de nodos de clúster

Description

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Request body

Respuesta HTTP de ejemplo

Response 202

Escalado del clúster al tamaño

Description

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Respuesta HTTP de ejemplo

Response 202

Obtención del estado del clúster

Description

Parameters

Responses

Solicitud HTTP de ejemplo

Request path

Respuesta HTTP de ejemplo

Response 200

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