Gestione operativa

Ottenere i nodi del cluster

GET /clusters/{cluster}/nodes

Parametri

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo Obbligatorio	Cluster su cui eseguire query	string
Query	operation Opzionale	Se specificato, restituisce solo i nodi per questo ID operazione e include l'attributo dell'operazione nel corpo	string
Query	request_id Opzionale	Se specificato, restituisce solo i nodi per l'operazione identificata da questo ID richiesta, e include l'attributo dell'operazione nel corpo	string

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

Risposta HTTP di esempio

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

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo necessario	Cluster a cui aggiungere nodi	string
Corpo	Nodi necessario	Set di nodi da creare	NodeCreationRequest

Risposte

Codice HTTP	Descrizione	SCHEMA
202	Accettato Intestazioni : Location (string) : URL dell'operazione.	NodeCreationResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/create

Testo della richiesta

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

Risposta HTTP di esempio

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

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo necessario	Cluster in cui deallocare i nodi	string
Corpo	action necessario	Descrizione dei nodi da deallocare	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	SCHEMA
202	Accettato Intestazioni : Location (string) : URL dell'operazione.	NodeManagementResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/deallocate

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

Risposta HTTP di esempio

Risposta 202

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

Terminare e rimuovere i 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 il nome del nodo, l'ID nodo o il filtro. Si noti che per impostazione predefinita i nodi vengono rimossi quando terminati (a meno che il nodo non sia impostato su true), in tal caso questa chiamata non è diversa da quella di terminazione.

Parametri

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo Obbligatorio	Cluster da rimuovere nodi in	string
Corpo	action necessario	Descrizione dei nodi da rimuovere	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	SCHEMA
202	Accettato Intestazioni : Location (stringa) : URL per l'operazione.	NodeManagementResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/remove

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

Risposta HTTP di esempio

Risposta 202

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

Terminare o deallocare i 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 su ogni nodo sia Termina (il valore predefinito) o Deallocate rispettivamente.

Parametri

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo necessario	Cluster in cui arrestare i nodi	string
Corpo	action Obbligatorio	Descrizione dei nodi da arrestare	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	SCHEMA
202	Accettato Intestazioni : Location (stringa) : URL per l'operazione.	NodeManagementResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/shutdown

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

Risposta HTTP di esempio

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 nodi in un cluster. I nodi possono essere identificati in diversi modi, tra cui il nome del nodo, l'ID nodo o il filtro.

Parametri

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo necessario	Cluster in cui avviare i nodi	string
Corpo	action necessario	Descrizione dei nodi da avviare	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	SCHEMA
202	Accettato Intestazioni : Location (string) : URL dell'operazione.	NodeManagementResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/start

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

Risposta HTTP di esempio

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

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo Obbligatorio	Cluster in cui terminare i nodi	string
Corpo	action necessario	Descrizione dei nodi da terminare	NodeManagementRequest

Risposte

Codice HTTP	Descrizione	SCHEMA
202	Accettato Intestazioni : Location (string) : URL dell'operazione.	NodeManagementResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/terminate

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

Risposta HTTP di esempio

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 a entrambi. Restituisce l'URL all'operazione che può essere usata per tenere traccia dello stato dell'operazione.

Parametri

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo necessario	Cluster a cui aggiungere nodi	string
Percorso	nodearray Obbligatorio	Nodearray a cui aggiungere nodi	string
Query	totalCoreCount Opzionale	Numero totale di core da includere in questo nodearray, inclusi i nodi già creati	numero intero
Query	totalNodeCount Opzionale	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 (string) : URL dell'operazione.	NodeCreationResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Risposta HTTP di esempio

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 gli oggetti nodearray in un determinato cluster. Per ogni nodearray, restituisce lo stato di ogni "bucket" di allocazione che può essere usata, ad esempio il numero di nodi nel bucket, il numero di nodi che possono essere aggiunti e così via. Ogni bucket è un set di macchine virtuali possibili di un determinato profilo hardware, che può essere creato in una determinata posizione, in 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

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo necessario	Cluster su cui eseguire query	string
Query	Nodi Opzionale	Se true, i nodi e i riferimenti ai nodi vengono restituiti nella risposta	boolean

Risposte

Codice HTTP	Descrizione	SCHEMA
200	OK	ClusterStatus

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/status

Risposta HTTP di esempio

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

Type	Nome	Descrizione	SCHEMA
Percorso	grappolo necessario	Cluster per cui restituire i dati di utilizzo	string
Query	Calendario Opzionale	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	from Opzionale	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.	string
Query	to Opzionale	Per gli intervalli di tempo personalizzati, si tratta della fine dell'intervallo di tempo in formato ISO-8601. Questo valore viene arrotondato all'ora o al giorno più vicino.	string
Query	Granularità Opzionale	Specifica come aggregare i dati: per ora, per giorno o come singolo numero. Questo valore predefinito è giornaliero.	enumerazione (totale, giornaliero, orario)

Risposte

Codice HTTP	Descrizione	SCHEMA
200	OK	ClusterUsage

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/usage

Risposta HTTP di esempio

Risposta 200

{
  "usage" : [ "object" ]
}

Elenchi lo stato delle operazioni

GET /operations/

Parametri

Type	Nome	Descrizione	SCHEMA
Query	request_id Opzionale	ID richiesta per l'operazione. Se viene specificato, l'elenco avrà solo 0 o 1 elemento al suo interno.	string

Risposte

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

Richiesta HTTP di esempio

Percorso della richiesta

/operations/

Risposta HTTP di esempio

Risposta 200

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

Ottiene lo stato dell'operazione in base all'ID

GET /operations/{id}

Parametri

Type	Nome	Descrizione	SCHEMA
Percorso	id Obbligatorio	ID operazione	string

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

Risposta HTTP di esempio

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 Obbligatorio	Numero massimo di nodi che possono essere aggiunti a questo cluster Esempio : 4	numero intero
nodearrays necessario	Esempio : [ "object" ]	<nodearrays> Matrice
Nodi Opzionale	Elenco facoltativo di nodi in questo cluster, incluso solo se i nodi=true si trovano nella query Esempio : [ "[node](#node)" ]	<Nodo> Matrice
state Opzionale	Stato corrente del cluster, se è stato avviato almeno una volta Esempio : "Starting"	string
targetState Opzionale	Stato desiderato del cluster (ad esempio Avviato o Terminato) Esempio : "Started"	string

nodearrays

Nome	Descrizione	SCHEMA
Secchi necessario	Ogni bucket di allocazione per questo nodoarray. Le impostazioni "conteggio core" sono sempre un numero multiplo del numero di core per questo bucket. Esempio : [ "object" ]	<Secchi> Matrice
maxCoreCount necessario	Numero massimo di core che possono trovarsi in questo nodoarray Esempio : 16	numero intero
maxCount Obbligatorio	Numero massimo di nodi che possono trovarsi in questo nodoarray Esempio : 4	numero intero
nome Obbligatorio	Nodearray che descrive Esempio : "execute"	string
nodearray necessario	Attributi di questo nodearray Esempio : "[node](#node)"	Node

Secchi

Nome	Descrizione	SCHEMA
activeCoreCount Obbligatorio	Numero di core in uso per questo bucket, in questo nodoarray Esempio : 40	numero intero
activeCount necessario	Numero di nodi in uso per questo bucket, in questo nodoarray. Sono inclusi i nodi che stanno ancora acquisendo una macchina virtuale. Esempio : 10	numero intero
activeNodes Opzionale	I nomi dei nodi in uso per questo bucket, in questo nodearray. Sono inclusi i nodi che stanno ancora acquisendo una macchina virtuale. Questa operazione è inclusa solo se i nodi=true si trovano nella query. Esempio : [ "string" ]	<matrice di stringhe >
availableCoreCount necessario	Quanti core aggiuntivi possono essere creati in questo bucket, in questo nodoarray. Sempre un numero multiplo di availableCount. Esempio : 8	numero intero
availableCount Obbligatorio	Quanti nodi aggiuntivi possono essere creati in questo bucket, in questo nodoarray. Si noti che questo può essere minore di implicito da maxCount e usedCount, poiché maxCount può essere limitato a livello globale. Esempio : 2	numero intero
bucketId necessario	Identificatore per questo bucket. Questo valore avrà sempre lo stesso valore per un determinato bucket in un nodearray, purché il cluster non venga eliminato. Esempio : "00000000-0000-0000-0000-000000000000"	string
consumedCoreCount necessario	Numero di core per questa famiglia già in uso nell'intera area. Esempio : 2	numero intero
Definizione Opzionale	Le proprietà di questo bucket, usate per creare nodi da questo bucket. L'API create-nodes accetta questa definizione nella relativa bucket proprietà. Esempio : "object"	Definizione
familyConsumedCoreCount Opzionale	Numero di core per questa famiglia già in uso nell'intera area. Esempio : 2	numero intero
familyQuotaCoreCount Opzionale	Numero di core totali che possono essere avviati per questa famiglia in questa area. Potrebbe non trattarsi di un multiplo intero di quotaCount. Esempio : 16	numero intero
familyQuotaCount Opzionale	Numero di istanze totali che è possibile avviare (data la famigliaQuotaCoreCount) Esempio : 4	numero intero
invalidReason Obbligatorio	Se valido è false, questo conterrà il motivo per cui il bucket non è valido. Attualmente NotActivated e DisabledMachineType sono gli unici motivi. Esempio : "DisabledMachineType"	string
lastCapacityFailure necessario	Tempo, espresso in secondi, dall'ultima volta che questo bucket ha riscontrato un errore di capacità. Qualsiasi valore negativo viene considerato mai. Esempio : 180.0	d'acquisto
maxCoreCount Obbligatorio	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 Obbligatorio	Numero massimo di nodi che possono trovarsi in questo bucket, inclusi i limiti globali e nodearray Esempio : 4	numero intero
maxPlacementGroupCoreSize Obbligatorio	Numero 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 Obbligatorio	I gruppi di posizionamento in uso per questo nodearray, se presenti. 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 quota regionale. Potrebbe non trattarsi di 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 Opzionale	Numero di core già in uso nell'intera area. Esempio : 2	numero intero
regionalQuotaCoreCount Opzionale	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 Opzionale	Numero di istanze totali che è possibile avviare (dato regionalQuotaCoreCount) Esempio : 4	numero intero
Valido 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	boolean
virtualMachine Obbligatorio	Le proprietà delle macchine virtuali avviate da questo bucket Esempio : "object"	virtualMachine

Definizione

Nome	Descrizione	SCHEMA
machineType necessario	Dimensioni della macchina virtuale Esempio : "A2"	string

placementGroups

Nome	Descrizione	SCHEMA
activeCoreCount Obbligatorio	Numero di core in questo set di scalabilità Esempio : 16	numero intero
activeCount Obbligatorio	Numero di nodi in questo set di scalabilità Esempio : 4	numero intero
nome Obbligatorio	Identificatore univoco di questo gruppo di posizionamento Esempio : "my-placement-group"	string

virtualMachine

Nome	Descrizione	SCHEMA
gpuCount Obbligatorio	Numero di GPU di questo tipo di computer Esempio : 2	numero intero
Infiniband Obbligatorio	Se questa macchina virtuale supporta la connettività InfiniBand Esempio : true	boolean
Memoria Obbligatorio	RAM in questa macchina virtuale, in GB Esempio : 7.5	d'acquisto
pcpuCount Obbligatorio	Numero di CPU fisiche di questo tipo di computer Esempio : 16	numero intero
vcpuCount Obbligatorio	Numero di CPU virtuali di questo tipo di macchina Esempio : 32	numero intero
vcpuQuotaCount Opzionale	Numero di vCPU usati dal computer dalla quota Esempio : 2	numero intero

ClusterUsage

Informazioni sull'utilizzo e sui costi facoltativi per il cluster

Nome	Descrizione	SCHEMA
Utilizzo necessario	Elenco di utilizzi in base all'intervallo di tempo Esempio : [ "object" ]	<Utilizzo> Matrice

Utilizzo

Nome	Descrizione	SCHEMA
Crollo Obbligatorio	Suddivisione dell'utilizzo in questo intervallo, per categoria di "node" e "nodearray" Esempio : [ "[clusterusageitem](#clusterusageitem)" ]	<ClusterUsageItem> Matrice
end Obbligatorio	Fine dell'intervallo (esclusivo) Esempio : "string"	string
start Obbligatorio	Inizio dell'intervallo (inclusivo) Esempio : "string"	string
total necessario	Utilizzo complessivo per questo cluster in questo intervallo, con una categoria di "cluster" Esempio : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Nome	Descrizione	SCHEMA
category Obbligatorio	"cluster" per l'utilizzo complessivo; "node" per un singolo nodo head non matrice; "nodearray" per un intero nodearray Esempio : "string"	enumerazione (cluster, node, nodearray)
cost Opzionale	Importo che verrebbe addebitato per questo utilizzo, in dollari USA e a tariffe al dettaglio. Nota: tutti gli importi dei costi sono stime e non riflettono la fattura effettiva. Esempio : 0.0	d'acquisto
Dettagli Opzionale	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 base di utilizzo per questa categoria Esempio : 0.0	d'acquisto
node Opzionale	Il nome del nodo o nodearray per l'utilizzo è (assente per i dati a livello di cluster) Esempio : "string"	string

Dettagli

Nome	Descrizione	SCHEMA
core_count Opzionale	Numero di core in questa dimensione della macchina virtuale Esempio : 0.0	d'acquisto
cost Opzionale	Costo di questa dimensione della macchina virtuale Esempio : 0.0	d'acquisto
Ore Opzionale	Numero di ore di core di utilizzo per questa dimensione della macchina virtuale Esempio : 0.0	d'acquisto
Os Opzionale	Tipo di sistema operativo Esempio : "string"	enum (Windows, Linux)
priority Opzionale	Priorità dello SKU della macchina virtuale Esempio : "string"	enumerazione (regolare, spot)
region Opzionale	Viene creata un'istanza dell'area in cui viene creata un'istanza della macchina virtuale Esempio : "string"	string
vm_size Opzionale	Dimensioni sku della macchina virtuale Esempio : "string"	string

Nodo

Un record di nodo

Tipo : oggetto

NodeCreationRequest

Specifica come aggiungere nodi a un cluster

Nome	Descrizione	SCHEMA
Requestid Opzionale	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"	string
Imposta Obbligatorio	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
count necessario	Numero di nodi da creare Esempio : 1	numero intero
Definizione Opzionale	Definizione del bucket da usare. Questa operazione viene fornita dalla chiamata API relativa allo stato del cluster. Se mancano alcuni degli elementi specificati nella chiamata di stato o se manca l'intera proprietà bucket, viene usato il primo bucket corrispondente agli elementi specificati. Esempio : "object"	Definizione
nameFormat Opzionale	Se specificato, i nodi useranno questa convenzione di denominazione anziché il formato standard "nodearray-%d" Esempio : "custom-name-%d"	string
nameOffset Opzionale	Se specificato, insieme a nameFormat, esegue l'offset nodeindex per i nuovi nodi. Esempio : 1	numero intero
nodeAttributes Opzionale	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"	string
placementGroupId Opzionale	Se specificato, i nodi con lo stesso valore per groupId verranno tutti avviati nello stesso gruppo di posizionamento. Esempio : "string"	string

Definizione

Nome	Descrizione	SCHEMA
machineType Opzionale	Esempio : "A2"	string

NodeCreationResult

Nome	Descrizione	SCHEMA
operationId necessario	ID di questa operazione Esempio : "00000000-0000-0000-0000-000000000000"	string
Imposta Obbligatorio	Matrice di set, nello stesso ordine della richiesta Esempio : [ "object" ]	<Imposta> Matrice

Imposta

Nome	Descrizione	SCHEMA
Aggiunto necessario	Numero di nodi avviati in questo set Esempio : 1	numero intero
message Opzionale	Indica perché non è possibile aggiungere tutti i nodi richiesti, se presenti Esempio : "string"	string

NodeList

Risultati di una ricerca di nodi

Nome	Descrizione	SCHEMA
Nodi Obbligatorio	Nodi restituiti Esempio : [ "[node](#node)" ]	<Nodo> Matrice
operation Opzionale	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
filter Opzionale	Espressione di filtro che corrisponde ai nodi. Si noti che le stringhe nell'espressione devono essere racchiuse correttamente tra virgolette. Esempio : "State === \"Started\""	string
Host Opzionale	Elenco di nomi host brevi (senza dominio) da gestire Esempio : [ "hostname1", "hostname2" ]	<matrice di stringhe >
Id Opzionale	Elenco di ID nodo da gestire Esempio : [ "id1", "id2" ]	<matrice di stringhe >
ip_addresses Opzionale	Elenco di indirizzi IP da gestire Esempio : [ "10.0.1.1", "10.1.1.2" ]	<matrice di stringhe >
Nomi Opzionale	Elenco dei nomi dei nodi da gestire Esempio : [ "name1", "name2" ]	<matrice di stringhe >
Requestid Opzionale	Token univoco fornito dall'utente facoltativo per evitare 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"	string

NodeManagementResult

Nome	Descrizione	SCHEMA
Nodi necessario	Matrice di informazioni su ogni nodo corrispondente al filtro nella richiesta di gestione. Lo stato di ogni nodo indica se è stato interessato dalla richiesta. Esempio : [ "object" ]	<Nodi> Matrice
operationId Obbligatorio	ID di questa operazione Esempio : "00000000-0000-0000-0000-000000000000"	string

Nodi

Nome	Descrizione	SCHEMA
error Opzionale	Se lo stato è Errore, contiene il messaggio di errore Esempio : "This node must be terminated before it can be removed"	string
id necessario	ID del nodo Esempio : "id1"	string
nome Obbligatorio	Nome del nodo Esempio : "name1"	string
Stato Opzionale	Uno di OK o Errore Esempio : "Error"	enumerazione (OK, Errore)

OperationStatus

Stato dell'operazione del nodo

Nome	Descrizione	SCHEMA
action necessario	Esempio : "string"	enumerazione (create)
Starttime Obbligatorio	Quando questa operazione è stata inviata Esempio : "2020-01-01T12:34:56Z"	string (date-time)