Operations

Azure CycleCloud fornisce un'API REST per la gestione di cluster, nodi e risorse correlate a livello di codice. Usare queste operazioni API per eseguire query sullo stato del cluster, creare e gestire nodi e tenere traccia delle operazioni a esecuzione prolungata. Questo riferimento elenca gli endpoint, i parametri e i formati di risposta disponibili per automatizzare e integrare la gestione del cluster CycleCloud nei flussi di lavoro.

Ottenere i nodi del cluster

GET /clusters/{cluster}/nodes

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster su cui eseguire query	string
Query	operation optional	Se specificato, restituisce solo i nodi per questo ID operazione e include l'attributo dell'operazione nel corpo	string
Query	request_id optional	Se specificato, restituisce solo i nodi per l'operazione identificata da questo ID richiesta e include l'attributo dell'operazione nel corpo	string

Responses

Codice HTTP	Description	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

Description

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.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster a cui aggiungere nodi	string
Body	nodes required	Set di nodi da creare	NodeCreationRequest

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): URL per l'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" ]
}

Esempio di risposta HTTP

Risposta 202

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

Deallocare i nodi del cluster

POST /clusters/{cluster}/nodes/deallocate

Description

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.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster in cui deallocare i nodi	string
Body	action required	Descrizione dei nodi da deallocare	NodeManagementRequest

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): URL per l'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"
}

Esempio di risposta HTTP

Risposta 202

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

Ricreazione dell'immagine dei nodi del cluster

POST /clusters/{cluster}/nodes/reimage

Description

Questa operazione ricrea l'immagine dei nodi in un cluster. I nodi possono essere identificati in diversi modi, tra cui nome del nodo, ID nodo o filtro.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster in cui creare nuovamente l'immagine dei nodi	string
Body	action required	Descrizione dei nodi di cui eseguire la ricreazione dell'immagine	NodeManagementRequest

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): URL per l'operazione.	NodeManagementResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/reimage

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

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

Description

Questa operazione rimuove i nodi in un cluster. È possibile identificare i nodi in base al nome del nodo, all'ID nodo o al filtro. Per impostazione predefinita, CycleCloud rimuove i nodi alla terminazione, quindi questa chiamata si comporta come terminate. I nodi con l'attributo Fixed impostato su true non vengono rimossi alla terminazione.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster in cui rimuovere i nodi	string
Body	action required	Descrizione dei nodi da rimuovere	NodeManagementRequest

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): 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"
}

Esempio di risposta HTTP

Risposta 202

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

Riavviare i nodi del cluster

POST /clusters/{cluster}/nodes/restart

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster in cui riavviare i nodi	string
Body	action required	Descrizione dei nodi da riavviare	NodeManagementRequest

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): URL per l'operazione.	NodeManagementResult
409	input non valido	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/restart

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

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

Description

Questa chiamata arresta i nodi in un cluster. L'attributo ShutdownPolicy di ogni nodo decide l'azione: Terminate (impostazione predefinita) o Deallocate.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster in cui arrestare i nodi	string
Body	action required	Descrizione dei nodi da arrestare	NodeManagementRequest

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): 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"
}

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

Description

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.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster in cui avviare i nodi	string
Body	action required	Descrizione dei nodi da avviare	NodeManagementRequest

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): URL per l'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"
}

Esempio di risposta HTTP

Risposta 202

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

Terminare i nodi del cluster

POST /clusters/{cluster}/nodes/terminate

Description

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.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster in cui terminare i nodi	string
Body	action required	Descrizione dei nodi da terminare	NodeManagementRequest

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): URL per l'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"
}

Esempio di risposta HTTP

Risposta 202

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

Inviare report sull'integrità guest per il nodo del cluster

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

Description

Inviare un report di integrità per un nodo con un problema di integrità

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster che contiene il nodo da segnalare	string
Path	node required	Nodo da segnalare	string
Query	category optional	Categoria Report integrità guest per l'impatto	string
Query	descrizione optional	Messaggio personalizzato che descrive l'errore o il contesto	string

Responses

Codice HTTP	Description	Schema
202	Accettate	Nessun contenuto
400	input non valido	Nessun contenuto
404	Non trovato	Nessun contenuto
409	Conflitto - Report sull'integrità guest già inviato per questo nodo	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/string/ghr

Ottenere il report sull'integrità guest per il nodo del cluster

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

Description

Restituisce l'impatto del carico di lavoro di un nodo con un problema di integrità, in modo da poterlo inviare all'endpoint di report sull'integrità.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster che contiene il nodo da segnalare	string
Path	node required	Nodo da segnalare	string
Query	category optional	Categoria Report integrità guest per l'impatto	string
Query	descrizione optional	Messaggio personalizzato che descrive l'errore o il contesto	string

Responses

Codice HTTP	Description	Schema
200	Ok	Nessun contenuto
400	input non valido	Nessun contenuto
404	Non trovato	Nessun contenuto

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/nodes/string/ghr

Ridimensionare il cluster per le dimensioni

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

Description

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. Specificare le dimensioni di destinazione usando totalCoreCount (core CPU totali) o totalNodeCount (macchine virtuali totali), ma non entrambe nella stessa richiesta. Restituisce l'URL all'operazione che è possibile usare per tenere traccia dello stato.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster a cui aggiungere nodi	string
Path	nodearray required	Nodearray a cui aggiungere nodi	string
Query	totalCoreCount optional	Numero totale di core da includere in questo nodearray, inclusi i nodi già creati	integer
Query	totalNodeCount optional	Numero totale di computer da includere in questo nodearray, inclusi i nodi già creati	integer

Responses

Codice HTTP	Description	Schema
202	Accettato Intestazioni : Location (string): URL per l'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

Description

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 disponibile. Lo stato include il numero di nodi corrente nel bucket e il numero di nodi che è possibile aggiungere. Ogni bucket è un set di macchine virtuali possibili di un determinato profilo hardware che può essere creato in una determinata posizione con un determinato account cliente e così via. La definizione del cluster dell'utente determina i bucket validi per un nodearray, ma il provider di servizi cloud determina in parte i limiti.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster su cui eseguire query	string
Query	nodes optional	Se true, i nodi e i riferimenti ai nodi vengono restituiti nella risposta	boolean

Responses

Codice HTTP	Description	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

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster per cui restituire i dati di utilizzo	string
Query	Calendario optional	Intervallo di tempo da usare per la query. Valori validi: monthToDate (mese corrente), lastMonth (mese precedente), weekToDate (settimana corrente, domenica di inizio) o custom (richiede i parametri di from query e to ). Il valore predefinito è monthToDate. Tutte le ore sono in formato UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Per gli intervalli di tempo personalizzati, questo valore è l'inizio dell'intervallo di tempo in formato ISO-8601. Viene arrotondato per difetto all'ora o al giorno più vicino.	string
Query	to optional	Per gli intervalli di tempo personalizzati, questo valore è la fine dell'intervallo di tempo in formato ISO-8601. Viene arrotondato fino all'ora o al giorno più vicino.	string
Query	Granularità optional	Specifica come aggregare i dati: oraria, giornaliera o come singolo totale. L'intervallo predefinito è giornaliero.	enum (totale, giornaliero, orario)

Responses

Codice HTTP	Description	Schema
200	OK	ClusterUsage

Richiesta HTTP di esempio

Percorso della richiesta

/clusters/CLUSTER_NAME/usage

Esempio di risposta HTTP

Risposta 200

{
  "usage" : [ "object" ]
}

Elencare lo stato delle operazioni

GET /operations/

Parameters

Type	Name	Description	Schema
Query	request_id optional	ID richiesta per l'operazione. Se questo valore viene specificato, l'elenco contiene 0 o 1 elemento.	string

Responses

Codice HTTP	Description	Schema
200	OK	< OperationStatus> Matrice
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}

Parameters

Type	Name	Description	Schema
Path	id required	ID operazione	string

Responses

Codice HTTP	Description	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"
}

Azure CycleCloud definisce un set di modelli di risorse che descrivono cluster, matrici di nodi, nodi e stato di allocazione. Queste risorse vengono restituite dall'API REST e forniscono dettagli quali limiti di capacità, utilizzo e stato del cluster. Usare questo riferimento per comprendere la struttura e le proprietà delle risposte api durante la gestione e il monitoraggio dei cluster CycleCloud a livello di codice.

ClusterStatus

Stato del cluster

Name	Description	Schema
maxCoreCount required	Numero massimo di core che possono essere aggiunti a questo cluster Esempio : 16	integer
maxCount required	Numero massimo di nodi che possono essere aggiunti a questo cluster Esempio : 4	integer
nodearrays required	Esempio : [ "object" ]	< nodearrays> Matrice
nodes optional	Elenco facoltativo di nodi in questo cluster, incluso solo se nodes=true si trova nella query Esempio : [ "[node](#node)" ]	< Nodo> Matrice
state optional	Stato corrente del cluster, disponibile dopo almeno un avvio Esempio : "Starting"	string
targetState optional	Stato desiderato del cluster (ad esempio, Avviato o Terminato) Esempio : "Started"	string

nodearrays

Name	Description	Schema
Secchi required	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" ]	< Secchi> Matrice
maxCoreCount required	Numero massimo di core che possono trovarsi in questo oggetto nodearray Esempio : 16	integer
maxCount required	Numero massimo di nodi che possono trovarsi in questo oggetto nodearray Esempio : 4	integer
name required	Nome dell'oggetto nodearray Esempio : "execute"	string
nodearray required	Attributi di questo nodearray Esempio : "[node](#node)"	Node

Secchi

Name	Description	Schema
activeCoreCount required	Numero di core in uso per questo bucket, in questo nodearray Esempio : 40	integer
activeCount required	Numero di nodi in uso per questo bucket, in questo nodearray. Questo numero include nodi che ancora acquisiscono una macchina virtuale. Esempio : 10	integer
activeNodes optional	Nomi dei nodi in uso per questo bucket all'interno dell'oggetto nodearray, inclusi i nodi che stanno ancora acquisendo una macchina virtuale. Restituito solo quando la query include nodes=true. Esempio : [ "string" ]	<matrice di stringhe >
availableCoreCount required	Quanti core aggiuntivi possono essere creati in questo bucket, in questo nodearray. Sempre un multiplo di availableCount. Esempio : 8	integer
availableCount required	Numero di nodi aggiuntivi che possono essere creati in questo bucket all'interno dell'oggetto nodearray. Il valore può essere inferiore a maxCount meno usedCount perché maxCount può essere limitato da un limite globale. Esempio : 2	integer
bucketId required	Identificatore univoco per il bucket. Il valore rimane invariato per un determinato bucket in un oggetto nodearray per la durata del cluster. Esempio : "00000000-0000-0000-0000-000000000000"	string
consumedCoreCount required	Numero di core per questa famiglia già in uso nell'intera area. Esempio : 2	integer
definition optional	Proprietà usate per creare nodi da questo bucket. L'API create-nodes accetta questa definizione nella relativa bucket proprietà. Esempio : "object"	definition
familyConsumedCoreCount optional	Numero di core per questa famiglia già in uso nell'intera area. Esempio : 2	integer
familyQuotaCoreCount optional	Numero totale di core che possono essere eseguiti per questa famiglia di macchine virtuali nell'area. Il valore non è necessariamente un multiplo intero di familyQuotaCount. Esempio : 16	integer
familyQuotaCount optional	Numero di istanze totali che è possibile avviare (dato familyQuotaCoreCount) Esempio : 4	integer
invalidReason required	Motivo per cui il bucket non è valido quando valid è false. Attualmente, gli unici valori possibili sono NotActivated e DisabledMachineType. Esempio : "DisabledMachineType"	string
lastCapacityFailure required	Numero di secondi dopo che questo bucket ha riscontrato un errore di capacità. Qualsiasi valore negativo viene considerato come mai. Esempio : 180.0	number
maxCoreCount required	Numero massimo di core che possono trovarsi in questo bucket, inclusi i limiti globali e nodearray. Sempre un multiplo di maxCount. Esempio : 16	integer
maxCount required	Numero massimo di nodi che possono trovarsi in questo bucket, inclusi i limiti globali e nodearray Esempio : 4	integer
maxPlacementGroupCoreSize required	Numero totale massimo di core che possono trovarsi in un gruppo di posizionamento in questo bucket. Sempre un multiplo di maxPlacementGroupSize. Esempio : 64	integer
maxPlacementGroupSize required	Numero totale massimo di istanze che possono trovarsi in un gruppo di posizionamento in questo bucket Esempio : 16	integer
placementGroups required	Gruppi di posizionamento in uso per questo nodearray, se presente. Esempio : [ "object" ]	< placementGroups> Matrice
quotaCoreCount required	Numero totale di core che possono essere eseguiti per questa famiglia di macchine virtuali nell'area, tenendo conto del numero di core di quota a livello di area. Il valore non è necessariamente un multiplo intero di quotaCount. Esempio : 16	integer
quotaCount required	Numero di istanze totali che possono essere avviate (quotaCoreCount specificato) Esempio : 4	integer
regionalConsumedCoreCount optional	Numero di core già in uso nell'intera area. Esempio : 2	integer
regionalQuotaCoreCount optional	Numero totale di core che possono essere eseguiti nell'area. Il valore non è necessariamente un multiplo intero di regionalQuotaCount. Esempio : 16	integer
regionalQuotaCount optional	Numero di istanze totali che è possibile avviare (dato regionalQuotaCoreCount) Esempio : 4	integer
spotPlacementScore required	Punteggio di posizionamento spot per questo bucket che indica la probabilità di disponibilità della macchina virtuale spot. Può essere alta, media, bassa o una stringa vuota, se non applicabile. Esempio : "High"	string
valido required	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 required	Proprietà delle macchine virtuali avviate da questo bucket Esempio : "object"	virtualMachine

Definizione

Name	Description	Schema
machineType required	Dimensioni della macchina virtuale Esempio : "A2"	string

placementGroups

Name	Description	Schema
activeCoreCount required	Quanti core si trovano in questo set di scalabilità Esempio : 16	integer
activeCount required	Quanti nodi si trovano in questo set di scalabilità Esempio : 4	integer
name required	Identificatore univoco di questo gruppo di posizionamento Esempio : "my-placement-group"	string

virtualMachine

Name	Description	Schema
gpuCount required	Numero di GPU di questo tipo di computer Esempio : 2	integer
Infiniband required	Se questa macchina virtuale supporta la connettività InfiniBand Esempio : true	boolean
memory required	RAM in questa macchina virtuale, in GB Esempio : 7.5	number
pcpuCount required	Numero di CPU fisiche di questo tipo di computer Esempio : 16	integer
vcpuCount required	Numero di CPU virtuali di questo tipo di macchina Esempio : 32	integer
vcpuQuotaCount optional	Numero di vCPU usati da questa macchina da quota Esempio : 2	integer

ClusterUsage

Informazioni sull'utilizzo e sui costi facoltativi per il cluster

Name	Description	Schema
usage required	Elenco di utilizzi per intervallo di tempo Esempio : [ "object" ]	< Utilizzo> Matrice

Utilizzo

Name	Description	Schema
Crollo required	Suddivisione dell'utilizzo in questo intervallo, per categoria di "node" e "nodearray" Esempio : [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> Matrice
end required	Fine dell'intervallo (esclusivo) Esempio : "string"	string
start required	Inizio dell'intervallo (incluso) Esempio : "string"	string
total required	Utilizzo complessivo per questo cluster in questo intervallo, con una categoria "cluster" Esempio : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Name	Description	Schema
category required	"cluster" per l'utilizzo complessivo; "node" per un singolo nodo head non matrice; "nodearray" per un intero nodearray Esempio : "string"	enumerazione (cluster, nodo, nodearray)
cost optional	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	number
details optional	Dettagli delle dimensioni della macchina virtuale usate da un nodearray, tra cui ore, core_count, area, priorità e sistema operativo. Esempio : [ "object" ]	< Dettagli> Matrice
hours required	Numero di ore di utilizzo core per questa categoria Esempio : 0.0	number
node optional	Il nome del nodo o nodearray per cui l'utilizzo è (assente per i dati a livello di cluster) Esempio : "string"	string

Dettagli

Name	Description	Schema
core_count optional	Numero di core in questa dimensione della macchina virtuale Esempio : 0.0	number
cost optional	Costo di questa dimensione della macchina virtuale Esempio : 0.0	number
hours optional	Numero di ore di utilizzo core per le dimensioni della macchina virtuale Esempio : 0.0	number
os optional	Tipo di sistema operativo Esempio : "string"	enumerazione (Windows, Linux)
priority optional	Priorità dello SKU della macchina virtuale Esempio : "string"	enumerazione (regolare, spot)
region optional	Viene creata un'istanza dell'area in cui viene creata un'istanza della macchina virtuale Esempio : "string"	string
vm_size optional	Dimensioni DELLO SKU della macchina virtuale Esempio : "string"	string

Node

Un record di nodo

Tipo: oggetto

NodeCreationRequest

Specifica come aggiungere nodi a un cluster

Name	Description	Schema
Requestid optional	Token univoco fornito dall'utente facoltativo per impedire operazioni duplicate in caso di errori di comunicazione di rete. Se questo valore è 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 required	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

Name	Description	Schema
count required	Numero di nodi da creare Esempio : 1	integer
definition optional	Definizione del bucket da usare, 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"	definition
nameFormat optional	Se specificato, i nodi usano questa convenzione di denominazione anziché il formato standard "nodearray-%d" Esempio : "custom-name-%d"	string
nameOffset optional	Se specificato, insieme a nameFormat, scosta l'indice del nodo per i nuovi nodi. Esempio : 1	integer
nodeAttributes optional	Attributi aggiuntivi da impostare in ogni nodo da questo set Esempio : "[node](#node)"	Node
nodearray required	Nome dell'oggetto nodearray da cui avviare i nodi Esempio : "execute"	string
placementGroupId optional	Se specificato, i nodi con lo stesso valore per groupId iniziano tutti nello stesso gruppo di posizionamento. Esempio : "string"	string

Definizione

Name	Description	Schema
machineType optional	Esempio : "A2"	string

NodeCreationResult

Name	Description	Schema
operationId required	ID di questa operazione Esempio : "00000000-0000-0000-0000-000000000000"	string
Imposta required	Matrice di set, nello stesso ordine di quella della richiesta Esempio : [ "object" ]	< Imposta> Matrice

Imposta

Name	Description	Schema
Aggiunto required	Numero di nodi avviati in questo set Esempio : 1	integer
message optional	Indica perché non è possibile aggiungere tutti i nodi richiesti, se presenti Esempio : "string"	string

NodeList

Risultati di una ricerca di nodi

Name	Description	Schema
nodes required	Nodi restituiti Esempio : [ "[node](#node)" ]	< Nodo> Matrice
operation optional	Stato di un'operazione se la query include un ID 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.

Name	Description	Schema
filter optional	Espressione di filtro che corrisponde ai nodi. Le stringhe nell'espressione devono essere racchiuse correttamente tra virgolette. Esempio : "State === \"Started\""	string
Host optional	Elenco di nomi host brevi (senza dominio) da gestire Esempio : [ "hostname1", "hostname2" ]	<matrice di stringhe >
Id optional	Elenco di ID nodo da gestire Esempio : [ "id1", "id2" ]	<matrice di stringhe >
ip_addresses optional	Elenco di indirizzi IP da gestire Esempio : [ "10.0.1.1", "10.1.1.2" ]	<matrice di stringhe >
names optional	Elenco di nomi di nodi da gestire Esempio : [ "name1", "name2" ]	<matrice di stringhe >
Requestid optional	Token univoco fornito dall'utente facoltativo per impedire operazioni duplicate in caso di errori di comunicazione di rete. Se questo valore è 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

Name	Description	Schema
nodes required	Matrice di informazioni su ogni nodo che corrisponde al filtro nella richiesta di gestione. Lo stato di ogni nodo indica se la richiesta l'ha interessata. Esempio : [ "object" ]	< Nodi> Matrice
operationId required	ID di questa operazione Esempio : "00000000-0000-0000-0000-000000000000"	string

Nodi

Name	Description	Schema
error optional	Messaggio di errore quando status è Error. Esempio : "This node must be terminated before it can be removed"	string
id required	ID del nodo Esempio : "id1"	string
name required	Nome del nodo Esempio : "name1"	string
status optional	Uno degli errori o OK Esempio : "Error"	enumerazione (OK, Errore)

OperationStatus

Stato dell'operazione del nodo

Name	Description	Schema
action required	Esempio : "string"	enumerazione (creazione)
startTime required	Quando l'operazione è stata inviata Esempio : "2020-01-01T12:34:56Z"	string (date-time)