Operazioni

Ottenere i nodi del cluster

GET /clusters/{cluster}/nodes

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster su cui eseguire query	corda
query	'operazione facoltativo	Se specificato, restituisce solo i nodi per questo ID operazione e include l'attributo dell'operazione nel corpo	corda
query	request_id facoltativo	Se specificato, restituisce solo i nodi per l'operazione identificata da questo ID richiesta, e include l'attributo dell'operazione nel corpo	corda

Risposte

Codice HTTP	Descrizione	Schema
200	OK	NodeList
400	Specifica non valida	Nessun contenuto
404	Non trovato	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes

Esempio di risposta HTTP

Risposta 200

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

Creare nodi del cluster

POST /clusters/{cluster}/nodes/create

Descrizione

Questa operazione aggiunge nuovi nodi da un nodearray a un cluster. Accetta più definizioni di nodo in una singola chiamata. Restituisce l'URL all'operazione che può essere usata per tenere traccia dello stato dell'operazione.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster a cui aggiungere nodi	corda
corpo	nodi necessario	Set di nodi da creare	NodeCreationRequest

Risposte

Codice HTTP	Descrizione	Schema
202	Accettato intestazioni : Location (stringa): URL dell'operazione.	NodeCreationResult
409	Input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/create

Corpo della richiesta

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

Esempio di risposta HTTP

Risposta 202

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

Deallocare i nodi del cluster

POST /clusters/{cluster}/nodes/deallocate

Descrizione

Questa operazione dealloca i nodi in un cluster. I nodi possono essere identificati in diversi modi, tra cui nome del nodo, ID nodo o filtro.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster in cui deallocare i nodi	corda
corpo	'azione necessario	Descrizione dei nodi da deallocare	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	Schema
202	Accettato intestazioni : Location (stringa): URL dell'operazione.	NodeManagementResult
409	Input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/deallocate

Corpo della richiesta

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

Esempio di risposta HTTP

Risposta 202

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

Terminare e rimuovere nodi del cluster

POST /clusters/{cluster}/nodes/remove

Descrizione

Questa operazione rimuove i nodi in un cluster. I nodi possono essere identificati in diversi modi, tra cui nome del nodo, ID nodo o filtro. Si noti che per impostazione predefinita i nodi vengono rimossi quando terminati (a meno che il nodo non abbia impostato Fixed su true), nel qual caso questa chiamata non è diversa da terminate.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster in cui rimuovere i nodi	corda
corpo	'azione necessario	Descrizione dei nodi da rimuovere	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	Schema
202	Accettato intestazioni : Location (stringa): URL dell'operazione.	NodeManagementResult
409	Input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/remove

Corpo della richiesta

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

Esempio di risposta HTTP

Risposta 202

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

Terminare o deallocare nodi del cluster

POST /clusters/{cluster}/nodes/shutdown

Descrizione

Questa operazione termina o dealloca i nodi in un cluster, a seconda che l'attributo ShutdownPolicy in ogni nodo sia Terminate (impostazione predefinita) o Deallocate rispettivamente.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster in cui arrestare i nodi	corda
corpo	'azione necessario	Descrizione dei nodi da arrestare	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	Schema
202	Accettato intestazioni : Location (stringa): URL dell'operazione.	NodeManagementResult
409	Input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/shutdown

Corpo della richiesta

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

Esempio di risposta HTTP

Risposta 202

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

Avviare nodi del cluster deallocati o terminati

POST /clusters/{cluster}/nodes/start

Descrizione

Questa operazione avvia i nodi in un cluster. I nodi possono essere identificati in diversi modi, tra cui nome del nodo, ID nodo o filtro.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster in cui avviare i nodi	corda
corpo	'azione necessario	Descrizione dei nodi da avviare	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	Schema
202	Accettato intestazioni : Location (stringa): URL dell'operazione.	NodeManagementResult
409	Input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/start

Corpo della richiesta

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

Esempio di risposta HTTP

Risposta 202

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

Terminare i nodi del cluster

POST /clusters/{cluster}/nodes/terminate

Descrizione

Questa operazione termina i nodi in un cluster. I nodi possono essere identificati in diversi modi, tra cui nome del nodo, ID nodo o filtro.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster in cui terminare i nodi	corda
corpo	'azione necessario	Descrizione dei nodi da terminare	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	Schema
202	Accettato intestazioni : Location (stringa): URL dell'operazione.	NodeManagementResult
409	Input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/terminate

Corpo della richiesta

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

Esempio di risposta HTTP

Risposta 202

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

Ridimensionare il cluster per le dimensioni

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

Descrizione

Questa operazione aggiunge nodi in base alle esigenze di un nodearray per raggiungere un conteggio totale. La richiesta viene elaborata una volta e non aggiunge nuovamente nodi in un secondo momento per mantenere il numero specificato. Questa scalabilità viene eseguita in base ai core totali o ai nodi totali, ma non entrambi. Restituisce l'URL all'operazione che può essere usata per tenere traccia dello stato dell'operazione.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster a cui aggiungere nodi	corda
percorso	nodearray necessario	Nodearray a cui aggiungere nodi	corda
query	totalCoreCount facoltativo	Numero totale di core da includere in questo nodearray, inclusi i nodi già creati	numero intero
query	totalNodeCount facoltativo	Numero totale di computer da includere in questo nodearray, inclusi i nodi già creati	numero intero

Risposte

Codice HTTP	Descrizione	Schema
202	Accettato intestazioni : Location (stringa): URL dell'operazione.	NodeCreationResult
409	Input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Esempio di risposta HTTP

Risposta 202

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

Ottenere lo stato del cluster

GET /clusters/{cluster}/status

Descrizione

Questa operazione contiene informazioni per i nodi e i nodearray in un determinato cluster. Per ogni nodearray, restituisce lo stato di ogni "bucket" di allocazione che può essere usato, ad esempio quanti nodi si trovano nel bucket, quanti altri possono essere aggiunti e così via. Ogni bucket è un set di possibili macchine virtuali di un determinato profilo hardware, che può essere creato in una determinata posizione, con un determinato account cliente e così via. I bucket validi per un nodearray sono determinati dalla definizione del cluster dell'utente, ma i limiti vengono determinati in parte dal provider di servizi cloud.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster su cui eseguire query	corda
query	nodi facoltativo	Se true, i nodi e i riferimenti ai nodi vengono restituiti nella risposta	booleano

Risposte

Codice HTTP	Descrizione	Schema
200	OK	clusterStatus

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/status

Esempio di risposta HTTP

Risposta 200

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

Ottenere informazioni sull'utilizzo e sui costi facoltativi per un cluster

GET /clusters/{cluster}/usage

Descrizione

Questa operazione restituisce i dati di utilizzo complessivi (ore di base) e i dati sui costi, se disponibili, per il cluster, nonché una suddivisione per nodoarray. Per impostazione predefinita, restituisce il valore di utilizzo del mese corrente.

Parametri

Digitare	Nome	Descrizione	Schema
percorso	cluster necessario	Cluster per cui restituire i dati di utilizzo	corda
query	intervallo di tempo facoltativo	Se specificato, specifica l'intervallo di tempo da usare per la query. monthToDate restituisce l'utilizzo per il mese corrente e lastMonth restituisce l'utilizzo per il mese precedente. weekToDate restituisce l'utilizzo per la settimana corrente (a partire da domenica). custom richiede i parametri di query 'from' e 'to'. Il valore predefinito è MonthToDate. Tutte le ore sono in formato UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
query	da facoltativo	Per gli intervalli di tempo personalizzati, si tratta dell'inizio dell'intervallo di tempo in formato ISO-8601. Questo valore viene arrotondato per difetto all'ora o al giorno più vicino.	corda
query	a facoltativo	Per gli intervalli di tempo personalizzati, si tratta della fine dell'intervallo di tempo in formato ISO-8601. Questo valore viene arrotondato fino all'ora o al giorno più vicino.	corda
query	granularità facoltativo	Specifica come aggregare i dati: per ora, per giorno o come numero singolo. Questo valore predefinito è giornaliero.	enum (totale, giornaliero, orario)

Risposte

Codice HTTP	Descrizione	Schema
200	OK	clusterUsage

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/usage

Esempio di risposta HTTP

Risposta 200

{
  "usage" : [ "object" ]
}

Elenca lo stato delle operazioni

GET /operations/

Parametri

Digitare	Nome	Descrizione	Schema
query	request_id facoltativo	ID richiesta per l'operazione. Se questa opzione è specificata, l'elenco avrà solo 0 o 1 elemento.	corda

Risposte

Codice HTTP	Descrizione	Schema
200	OK	matrice <OperationStatus>
400	Richiesta non valida	Nessun contenuto
404	Non trovato	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/operations/

Esempio di risposta HTTP

Risposta 200

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

Ottiene lo stato dell'operazione in base all'ID

GET /operations/{id}

Parametri

Digitare	Nome	Descrizione	Schema
percorso	ID necessario	ID operazione	corda

Risposte

Codice HTTP	Descrizione	Schema
200	OK	OperationStatus
404	Non trovato	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

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

Esempio di risposta HTTP

Risposta 200

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

Risorse

ClusterStatus

Stato del cluster

Nome	Descrizione	Schema
maxCoreCount necessario	Numero massimo di core che possono essere aggiunti a questo cluster esempio : 16	numero intero
maxCount necessario	Numero massimo di nodi che possono essere aggiunti a questo cluster esempio : 4	numero intero
nodearrays necessario	esempio : [ "object" ]	< nodearrays> matrice
nodi facoltativo	Elenco facoltativo di nodi in questo cluster, incluso solo se nodes=true si trova nella query esempio : [ "[node](#node)" ]	matrice node
stato facoltativo	Stato corrente del cluster, se è stato avviato almeno una volta esempio : "Starting"	corda
targetState facoltativo	Stato desiderato del cluster (ad esempio Avviato o Terminato) esempio : "Started"	corda

nodearrays

Nome	Descrizione	Schema
bucket necessario	Ogni bucket di allocazione per questo oggetto nodearray. Le impostazioni "numero di core" sono sempre un multiplo del numero di core per questo bucket. esempio : [ "object" ]	< bucket> matrice
maxCoreCount necessario	Numero massimo di core che possono trovarsi in questo oggetto nodearray esempio : 16	numero intero
maxCount necessario	Numero massimo di nodi che possono trovarsi in questo oggetto nodearray esempio : 4	numero intero
nome necessario	Nodearray che descrive esempio : "execute"	corda
nodearray necessario	Attributi di questo nodearray esempio : "[node](#node)"	Node

bucket

Nome	Descrizione	Schema
activeCoreCount necessario	Numero di core in uso per questo bucket, in questo nodearray esempio : 40	numero intero
activeCount necessario	Numero di nodi in uso per questo bucket, in questo nodearray. Sono inclusi i nodi che ancora acquisiscono una macchina virtuale. esempio : 10	numero intero
activeNodes facoltativo	I nomi dei nodi in uso per questo bucket, in questo oggetto nodearray. Sono inclusi i nodi che ancora acquisiscono una macchina virtuale. Questa opzione è inclusa solo se nodes=true si trova nella query. esempio : [ "string" ]	< matrice di stringhe >
availableCoreCount necessario	Quanti core aggiuntivi possono essere creati in questo bucket, in questo nodearray. Sempre un multiplo di availableCount. esempio : 8	numero intero
availableCount necessario	Numero di nodi aggiuntivi che possono essere creati in questo bucket, in questo oggetto nodearray. Si noti che questo può essere minore di quanto implicito da maxCount e usedCount, poiché maxCount può essere limitato a livello globale. esempio : 2	numero intero
bucketId necessario	Identificatore del bucket. Questo valore avrà sempre lo stesso valore per un determinato bucket in un oggetto nodearray, purché il cluster non venga eliminato. esempio : "00000000-0000-0000-0000-000000000000"	corda
consumedCoreCount necessario	Numero di core per questa famiglia già in uso nell'intera area. esempio : 2	numero intero
definizione facoltativo	Le proprietà di questo bucket, usate per creare nodi da questo bucket. L'API create-nodes accetta questa definizione nella relativa proprietà bucket. esempio : "object"	definizione
famigliaConsumedCoreCount facoltativo	Numero di core per questa famiglia già in uso nell'intera area. esempio : 2	numero intero
familyQuotaCoreCount facoltativo	Numero di core totali che possono essere avviati per questa famiglia in questa area. Questo potrebbe non essere un multiplo intero di quotaCount. esempio : 16	numero intero
familyQuotaCount facoltativo	Numero di istanze totali che è possibile avviare (dato familyQuotaCoreCount) esempio : 4	numero intero
invalidReason necessario	Se valido è false, questo conterrà il motivo per cui il bucket non è valido. Attualmente NotActivated e DisabledMachineType sono gli unici motivi. esempio : "DisabledMachineType"	corda
lastCapacityFailure necessario	Quanto tempo, in secondi, dall'ultima volta che questo bucket ha riscontrato un errore di capacità. Qualsiasi valore negativo viene considerato come mai. esempio : 180.0	numero
maxCoreCount necessario	Numero massimo di core che possono trovarsi in questo bucket, inclusi i limiti globali e nodearray. Sempre un multiplo di maxCount. esempio : 16	numero intero
maxCount necessario	Numero massimo di nodi che possono trovarsi in questo bucket, inclusi i limiti globali e nodearray esempio : 4	numero intero
maxPlacementGroupCoreSize necessario	Numero totale massimo di core che possono trovarsi in un gruppo di posizionamento in questo bucket. Sempre un multiplo di maxPlacementGroupSize. esempio : 64	numero intero
maxPlacementGroupSize necessario	Numero totale massimo di istanze che possono trovarsi in un gruppo di posizionamento in questo bucket esempio : 16	numero intero
placementGroups necessario	Gruppi di posizionamento in uso per questo nodearray, se presente. esempio : [ "object" ]	< placementGroups> matrice
quotaCoreCount necessario	Numero di core totali che possono essere avviati per questa famiglia in questa area, tenendo conto anche del numero di core di quota regionale. Questo potrebbe non essere un multiplo intero di quotaCount. esempio : 16	numero intero
quotaCount necessario	Numero di istanze totali che possono essere avviate (quotaCoreCount specificato) esempio : 4	numero intero
regionalConsumedCoreCount facoltativo	Numero di core già in uso nell'intera area. esempio : 2	numero intero
regionalQuotaCoreCount facoltativo	Numero di core totali che possono essere avviati in questa area. Potrebbe non trattarsi di un multiplo intero di regionalQuotaCount. esempio : 16	numero intero
regionalQuotaCount facoltativo	Numero di istanze totali che è possibile avviare (dato regionalQuotaCoreCount) esempio : 4	numero intero
validi necessario	Se true, questo bucket rappresenta un bucket attualmente valido da usare per i nuovi nodi. Se false, questo bucket rappresenta solo i nodi esistenti. esempio : true	booleano
virtualMachine necessario	Proprietà delle macchine virtuali avviate da questo bucket esempio : "object"	virtualMachine

definizione

Nome	Descrizione	Schema
machineType necessario	Dimensioni della macchina virtuale esempio : "A2"	corda

placementGroups

Nome	Descrizione	Schema
activeCoreCount necessario	Quanti core si trovano in questo set di scalabilità esempio : 16	numero intero
activeCount necessario	Quanti nodi si trovano in questo set di scalabilità esempio : 4	numero intero
nome necessario	Identificatore univoco di questo gruppo di posizionamento esempio : "my-placement-group"	corda

virtualMachine

Nome	Descrizione	Schema
gpuCount necessario	Numero di GPU di questo tipo di computer esempio : 2	numero intero
infiniband necessario	Se questa macchina virtuale supporta la connettività InfiniBand esempio : true	booleano
memoria necessario	RAM in questa macchina virtuale, in GB esempio : 7.5	numero
pcpuCount necessario	Numero di CPU fisiche di questo tipo di computer esempio : 16	numero intero
vcpuCount necessario	Numero di CPU virtuali di questo tipo di macchina esempio : 32	numero intero
vcpuQuotaCount facoltativo	Numero di vCPU usati da questa macchina da quota esempio : 2	numero intero

ClusterUsage

Informazioni sull'utilizzo e sui costi facoltativi per il cluster

Nome	Descrizione	Schema
di utilizzo necessario	Elenco di utilizzi per intervallo di tempo esempio : [ "object" ]	< matrice di> di utilizzo

di utilizzo

Nome	Descrizione	Schema
necessario	Suddivisione dell'utilizzo in questo intervallo, per categoria di "node" e "nodearray" esempio : [ "[clusterusageitem](#clusterusageitem)" ]	matrice di ClusterUsageItem
fine necessario	Fine dell'intervallo (esclusivo) esempio : "string"	corda
avviare necessario	Inizio dell'intervallo (incluso) esempio : "string"	corda
totale necessario	Utilizzo complessivo per questo cluster in questo intervallo, con una categoria "cluster" esempio : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Nome	Descrizione	Schema
categoria necessario	"cluster" per l'utilizzo complessivo; "node" per un singolo nodo head non matrice; "nodearray" per un intero nodearray esempio : "string"	enumerazione (cluster, nodo, nodearray)
costo facoltativo	Importo che verrebbe addebitato per questo utilizzo, in dollari STATUNITENSi e a tariffe al dettaglio. Nota: tutti gli importi dei costi sono stime e non riflettono la fattura effettiva! esempio : 0.0	numero
dettagli facoltativo	Dettagli delle dimensioni della macchina virtuale usate da un nodearray, tra cui ore, core_count, priorità dell'area e sistema operativo. esempio : [ "object" ]	< dettagli> matrice
ore necessario	Numero di ore di utilizzo core per questa categoria esempio : 0.0	numero
nodo facoltativo	Il nome del nodo o nodearray per cui l'utilizzo è (assente per i dati a livello di cluster) esempio : "string"	corda

dettagli

Nome	Descrizione	Schema
core_count facoltativo	Numero di core in questa dimensione della macchina virtuale esempio : 0.0	numero
costo facoltativo	Costo di questa dimensione della macchina virtuale esempio : 0.0	numero
ore facoltativo	Numero di ore di utilizzo core per le dimensioni della macchina virtuale esempio : 0.0	numero
os facoltativo	Tipo di sistema operativo esempio : "string"	enumerazione (Windows, Linux)
priorità facoltativo	Priorità dello SKU della macchina virtuale esempio : "string"	enumerazione (regolare, spot)
'area facoltativo	Viene creata un'istanza dell'area in cui viene creata un'istanza della macchina virtuale esempio : "string"	corda
vm_size facoltativo	Dimensioni sku macchina virtuale esempio : "string"	corda

Nodo

Un record di nodo

Tipo : oggetto

NodeCreationRequest

Specifica come aggiungere nodi a un cluster

Nome	Descrizione	Schema
requestId facoltativo	Token univoco fornito dall'utente facoltativo per impedire operazioni duplicate in caso di errori di comunicazione di rete. Se è incluso e corrisponde a un ID richiesta precedente, il server ignora questa richiesta e restituisce un errore 409. esempio : "00000000-0000-0000-0000-000000000000"	corda
set di necessario	Elenco di definizioni di nodo da creare. La richiesta deve contenere almeno un set. Ogni set può specificare un set di proprietà diverso. esempio : [ "object" ]	< imposta> matrice

imposta

Nome	Descrizione	Schema
conteggio necessario	Numero di nodi da creare esempio : 1	numero intero
definizione facoltativo	Definizione del bucket da usare. Questa operazione viene fornita dalla chiamata API per lo stato del cluster. Se alcuni elementi specificati nella chiamata di stato sono mancanti o l'intera proprietà bucket è mancante, viene usato il primo bucket che corrisponde agli elementi specificati. esempio : "object"	definizione
nameFormat facoltativo	Se specificato, i nodi useranno questa convenzione di denominazione anziché il formato standard "nodearray-%d" esempio : "custom-name-%d"	corda
nameOffset facoltativo	Se specificato, insieme a nameFormat, offset nodeindex per i nuovi nodi. esempio : 1	numero intero
nodeAttributes facoltativo	Attributi aggiuntivi da impostare in ogni nodo da questo set esempio : "[node](#node)"	Node
nodearray necessario	Nome dell'oggetto nodearray da cui avviare i nodi esempio : "execute"	corda
placementGroupId facoltativo	Se specificato, i nodi con lo stesso valore per groupId verranno tutti avviati nello stesso gruppo di posizionamento. esempio : "string"	corda

definizione

Nome	Descrizione	Schema
machineType facoltativo	esempio : "A2"	corda

NodeCreationResult

Nome	Descrizione	Schema
operationId necessario	ID di questa operazione esempio : "00000000-0000-0000-0000-000000000000"	corda
set di necessario	Matrice di set, nello stesso ordine di quella della richiesta esempio : [ "object" ]	< imposta> matrice

imposta

Nome	Descrizione	Schema
aggiunta di necessario	Numero di nodi avviati in questo set esempio : 1	numero intero
messaggio facoltativo	Indica perché non è possibile aggiungere tutti i nodi richiesti, se presenti esempio : "string"	corda

NodeList

Risultati di una ricerca di nodi

Nome	Descrizione	Schema
nodi necessario	Nodi restituiti esempio : [ "[node](#node)" ]	matrice node
'operazione facoltativo	Se la query include un ID operazione, si tratta dello stato dell'operazione esempio : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

Specifica come eseguire azioni sui nodi di un cluster. Esistono diversi modi per specificare i nodi e, se è incluso più di un modo, viene considerato come un'unione.

Nome	Descrizione	Schema
filtro facoltativo	Espressione di filtro che corrisponde ai nodi. Si noti che le stringhe nell'espressione devono essere racchiuse correttamente tra virgolette. esempio : "State === \"Started\""	corda
nomi host facoltativo	Elenco di nomi host brevi (senza dominio) da gestire esempio : [ "hostname1", "hostname2" ]	< matrice di stringhe >
ID facoltativo	Elenco di ID nodo da gestire esempio : [ "id1", "id2" ]	< matrice di stringhe >
ip_addresses facoltativo	Elenco di indirizzi IP da gestire esempio : [ "10.0.1.1", "10.1.1.2" ]	< matrice di stringhe >
nomi facoltativo	Elenco di nomi di nodi da gestire esempio : [ "name1", "name2" ]	< matrice di stringhe >
requestId facoltativo	Token univoco fornito dall'utente facoltativo per impedire operazioni duplicate in caso di errori di comunicazione di rete. Se è incluso e corrisponde a un ID richiesta precedente, il server ignora questa richiesta e restituisce un errore 409. esempio : "00000000-0000-0000-0000-000000000000"	corda

NodeManagementResult

Nome	Descrizione	Schema
nodi necessario	Matrice di informazioni su ogni nodo che corrisponde al filtro nella richiesta di gestione. Lo stato di ogni nodo indica se è stato interessato dalla richiesta. esempio : [ "object" ]	< nodi> matrice
operationId necessario	ID di questa operazione esempio : "00000000-0000-0000-0000-000000000000"	corda

nodi

Nome	Descrizione	Schema
errore facoltativo	Se lo stato è Errore, contiene il messaggio di errore esempio : "This node must be terminated before it can be removed"	corda
ID necessario	ID del nodo esempio : "id1"	corda
nome necessario	Nome del nodo esempio : "name1"	corda
facoltativo	Uno degli errori o OK esempio : "Error"	enumerazione (OK, Errore)

OperationStatus

Stato dell'operazione del nodo

Nome	Descrizione	Schema
'azione necessario	esempio : "string"	enumerazione (creazione)
startTime necessario	Quando l'operazione è stata inviata esempio : "2020-01-01T12:34:56Z"	string (date-time)