Operations

Clusterknooppunten ophalen

GET /clusters/{cluster}/nodes

Parameters

Type	Naam	Beschrijving	Schema
Pad	cluster vereist	Het cluster dat moet worden opgevraagd	tekenreeks
Query	Bewerking Optionele	Als dit wordt opgegeven, worden alleen de knooppunten voor deze bewerkings-id geretourneerd en wordt het bewerkingskenmerk in de hoofdtekst opgenomen	tekenreeks
Query	request_id Optionele	Als dit wordt opgegeven, worden alleen de knooppunten geretourneerd voor de bewerking die wordt geïdentificeerd door deze aanvraag-id, en bevat het bewerkingskenmerk op de hoofdtekst	tekenreeks

Antwoorden

HTTP-code	Description	Schema
200	OK	NodeList
400	Ongeldige specificatie	Geen inhoud
404	Niet gevonden	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/nodes

Voorbeeld van HTTP-antwoord

Antwoord 200

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

Clusterknooppunten maken

POST /clusters/{cluster}/nodes/create

Description

Met deze bewerking worden nieuwe knooppunten van een knooppuntmaarray toegevoegd aan een cluster. Het accepteert meerdere knooppuntdefinities in één aanroep. Deze retourneert de URL naar de bewerking die kan worden gebruikt om de status van de bewerking bij te houden.

Parameters

Type	Naam	Beschrijving	Schema
Pad	Cluster vereist	Het cluster waaraan knooppunten moeten worden toegevoegd	tekenreeks
Hoofdtekst	Knooppunten vereist	Sets met knooppunten die moeten worden gemaakt	NodeCreationRequest

Antwoorden

HTTP-code	Description	Schema
202	Geaccepteerd Kopteksten : Location (tekenreeks) : de URL voor de bewerking.	NodeCreationResult
409	Ongeldige invoer	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/nodes/create

Aanvraagbody

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

Voorbeeld van HTTP-antwoord

Antwoord 202

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

De toewijzing van clusterknooppunten ongedaan maken

POST /clusters/{cluster}/nodes/deallocate

Description

Met deze bewerking wordt de toewijzing van knooppunten in een cluster ongedaan gemaakt. De knooppunten kunnen op verschillende manieren worden geïdentificeerd, waaronder de naam van het knooppunt, de knooppunt-id of door een filter.

Parameters

Type	Naam	Beschrijving	Schema
Pad	Cluster vereist	Het cluster waarin de toewijzing van knooppunten ongedaan moet worden gemaakt	tekenreeks
Hoofdtekst	action Vereist	Beschrijving van welke knooppunten de toewijzing ongedaan moet maken	NodeManagementRequest

Antwoorden

HTTP-code	Description	Schema
202	Geaccepteerd Kopteksten : Location (tekenreeks) : de URL voor de bewerking.	NodeManagementResult
409	Ongeldige invoer	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/nodes/deallocate

Aanvraagbody

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

Voorbeeld van HTTP-antwoord

Antwoord 202

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

Clusterknooppunten beëindigen en verwijderen

POST /clusters/{cluster}/nodes/remove

Description

Met deze bewerking worden knooppunten in een cluster verwijderd. De knooppunten kunnen op verschillende manieren worden geïdentificeerd, zoals knooppuntnaam, knooppunt-id of filter. Houd er rekening mee dat knooppunten standaard worden verwijderd wanneer ze worden beëindigd (tenzij het knooppunt Vast is ingesteld op true). In dat geval is deze aanroep niet anders dan beëindigen.

Parameters

Type	Naam	Beschrijving	Schema
Pad	cluster vereist	Het cluster voor het verwijderen van knooppunten in	tekenreeks
Hoofdtekst	action Vereist	Beschrijving van welke knooppunten u wilt verwijderen	NodeManagementRequest

Antwoorden

HTTP-code	Description	Schema
202	Geaccepteerd Kopteksten : Location (tekenreeks) : de URL voor de bewerking.	NodeManagementResult
409	Ongeldige invoer	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/nodes/remove

Aanvraagbody

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

Voorbeeld van HTTP-antwoord

Antwoord 202

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

Clusterknooppunten beëindigen of de toewijzing ervan ongedaan maken

POST /clusters/{cluster}/nodes/shutdown

Description

Met deze bewerking worden knooppunten in een cluster beëindigd of ongedaan gemaakt, afhankelijk van of het kenmerk ShutdownPolicy op elk knooppunt respectievelijk Beëindigen (de standaardinstelling) of Toewijzing ongedaan maken is.

Parameters

Type	Naam	Beschrijving	Schema
Pad	cluster Vereist	Het cluster om knooppunten in af te sluiten	tekenreeks
Hoofdtekst	action Vereist	Beschrijving van welke knooppunten moeten worden afgesloten	NodeManagementRequest

Antwoorden

HTTP-code	Description	Schema
202	Geaccepteerd Kopteksten : Location (tekenreeks) : de URL voor de bewerking.	NodeManagementResult
409	Ongeldige invoer	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/nodes/shutdown

Aanvraagbody

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

Voorbeeld van HTTP-antwoord

Antwoord 202

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

Toewijzing ongedaan maken of beëindigde clusterknooppunten starten

POST /clusters/{cluster}/nodes/start

Description

Met deze bewerking worden knooppunten in een cluster gestart. De knooppunten kunnen op verschillende manieren worden geïdentificeerd, zoals knooppuntnaam, knooppunt-id of filter.

Parameters

Type	Naam	Beschrijving	Schema
Pad	cluster Vereist	Het cluster waarin knooppunten moeten worden gestart	tekenreeks
Hoofdtekst	action Vereist	Beschrijving van welke knooppunten moeten worden gestart	NodeManagementRequest

Antwoorden

HTTP-code	Description	Schema
202	Geaccepteerd Kopteksten : Location (tekenreeks) : de URL voor de bewerking.	NodeManagementResult
409	Ongeldige invoer	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/nodes/start

Aanvraagbody

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

Voorbeeld van HTTP-antwoord

Antwoord 202

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

Clusterknooppunten beëindigen

POST /clusters/{cluster}/nodes/terminate

Description

Met deze bewerking worden knooppunten in een cluster beëindigd. De knooppunten kunnen op verschillende manieren worden geïdentificeerd, zoals knooppuntnaam, knooppunt-id of filter.

Parameters

Type	Naam	Beschrijving	Schema
Pad	Cluster vereist	Het cluster voor het beëindigen van knooppunten in	tekenreeks
Hoofdtekst	action Vereist	Beschrijving van welke knooppunten moeten worden beëindigd	NodeManagementRequest

Antwoorden

HTTP-code	Description	Schema
202	Geaccepteerd Kopteksten : Location (tekenreeks) : de URL voor de bewerking.	NodeManagementResult
409	Ongeldige invoer	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/nodes/terminate

Aanvraagbody

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

Voorbeeld van HTTP-antwoord

Antwoord 202

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

Cluster schalen naar grootte

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

Description

Met deze bewerking worden knooppunten indien nodig toegevoegd aan een knooppuntmaarray om een totaalaantal te bereiken. De aanvraag wordt één keer verwerkt en voegt later geen knooppunten opnieuw toe om het opgegeven nummer te behouden. Dit wordt geschaald op basis van het totale aantal kernen of het totale aantal knooppunten, maar niet op beide. Het retourneert de URL naar de bewerking die kan worden gebruikt om de status van de bewerking bij te houden.

Parameters

Type	Naam	Beschrijving	Schema
Pad	Cluster Vereist	Het cluster waaraan knooppunten moeten worden toegevoegd	tekenreeks
Pad	nodearray vereist	De knooppuntmaarray waaraan knooppunten moeten worden toegevoegd	tekenreeks
Query	totalCoreCount Optionele	Het totale aantal kernen in deze knooppuntmaarray, inclusief knooppunten die al zijn gemaakt	geheel getal
Query	totalNodeCount Optionele	Het totale aantal machines dat in deze knooppuntmaarray moet worden gebruikt, inclusief knooppunten die al zijn gemaakt	geheel getal

Antwoorden

HTTP-code	Description	Schema
202	Geaccepteerd Kopteksten : Location (tekenreeks) : de URL voor de bewerking.	NodeCreationResult
409	Ongeldige invoer	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Voorbeeld van HTTP-antwoord

Antwoord 202

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

Clusterstatus ophalen

GET /clusters/{cluster}/status

Description

Deze bewerking bevat informatie voor de knooppunten en knooppuntarrays in een bepaald cluster. Voor elke knooppuntmaarray wordt de status geretourneerd van elke 'bucket' met toewijzing die kan worden gebruikt, zoals hoeveel knooppunten er in de bucket zijn, hoeveel er meer kunnen worden toegevoegd, enzovoort. Elke bucket is een set mogelijke VM's van een bepaald hardwareprofiel, die kunnen worden gemaakt op een bepaalde locatie, onder een bepaald klantaccount, enzovoort. De geldige buckets voor een knooppuntmaarray worden bepaald door de clusterdefinitie van de gebruiker, maar de limieten worden gedeeltelijk bepaald door de cloudprovider.

Parameters

Type	Naam	Beschrijving	Schema
Pad	cluster vereist	Het cluster dat moet worden opgevraagd	tekenreeks
Query	Knooppunten Optionele	Indien waar, worden knooppunten en knooppuntverwijzingen geretourneerd in het antwoord	booleaans

Antwoorden

HTTP-code	Description	Schema
200	OK	ClusterStatus

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/status

Voorbeeld van HTTP-antwoord

Antwoord 200

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

Gebruiks- en optionele kostengegevens voor een cluster ophalen

GET /clusters/{cluster}/usage

Description

Deze bewerking retourneert algemene gebruiksgegevens (kernuren) en kostengegevens, indien beschikbaar, voor het cluster, evenals een uitsplitsing per knooppuntarray. Standaard wordt de waarde van het gebruik van de huidige maand geretourneerd.

Parameters

Type	Naam	Beschrijving	Schema
Pad	cluster vereist	Het cluster waarvoor gebruiksgegevens moeten worden geretourneerd	tekenreeks
Query	Tijdsbestek Optionele	Als dit wordt opgegeven, geeft dit het tijdsbereik op dat moet worden gebruikt voor de query. monthToDate retourneert het gebruik voor de huidige maand en lastMonth retourneert het gebruik voor de vorige maand. weekToDate retourneert het gebruik voor de huidige week (vanaf zondag). aangepast vereist queryparameters 'van' en 'naar'. De standaardwaarde is MonthToDate. Alle tijden zijn in UTC.	enum (monthToDate, lastMonth, weekToDate, aangepast)
Query	Van Optionele	Voor aangepaste tijdsbestekken is dit het begin van het tijdsbestek in ISO-8601-indeling. Dit wordt naar beneden afgerond op het dichtstbijzijnde uur of de dichtstbijzijnde dag.	tekenreeks
Query	Aan Optionele	Voor aangepaste tijdsbestekken is dit het einde van het tijdsbestek in ISO-8601-indeling. Dit wordt naar boven afgerond op het dichtstbijzijnde uur of de dichtstbijzijnde dag.	tekenreeks
Query	Granulariteit Optionele	Hiermee geeft u op hoe gegevens moeten worden geaggregeerd: per uur, per dag of als één getal. Deze standaardwaarde is dagelijks.	enum (totaal, dagelijks, elk uur)

Antwoorden

HTTP-code	Description	Schema
200	OK	ClusterUsage

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/usage

Voorbeeld van HTTP-antwoord

Antwoord 200

{
  "usage" : [ "object" ]
}

de status van bewerkingen Lijsten

GET /operations/

Parameters

Type	Naam	Beschrijving	Schema
Query	request_id Optionele	De aanvraag-id voor de bewerking. Als dit wordt opgegeven, bevat de lijst slechts 0 of 1 element.	tekenreeks

Antwoorden

HTTP-code	Description	Schema
200	OK	<OperationStatus> Array
400	Ongeldige aanvraag	Geen inhoud
404	Niet gevonden	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

/operations/

Voorbeeld van HTTP-antwoord

Antwoord 200

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

Hiermee wordt de bewerkingsstatus opgehaald op id

GET /operations/{id}

Parameters

Type	Naam	Beschrijving	Schema
Pad	id Vereist	De bewerkings-id	tekenreeks

Antwoorden

HTTP-code	Description	Schema
200	OK	OperationStatus
404	Niet gevonden	Geen inhoud

Voorbeeld van HTTP-aanvraag

Aanvraagpad

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

Voorbeeld van HTTP-antwoord

Antwoord 200

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

Resources

Clusterstatus

Status van het cluster

Naam	Beschrijving	Schema
maxCoreCount vereist	Het maximum aantal kernen dat aan dit cluster kan worden toegevoegd Voorbeeld : 16	geheel getal
maxCount vereist	Het maximum aantal knooppunten dat aan dit cluster kan worden toegevoegd Voorbeeld : 4	geheel getal
nodearrays vereist	Voorbeeld : [ "object" ]	<nodearrays> Array
Knooppunten Optionele	Een optionele lijst met knooppunten in dit cluster, alleen opgenomen als nodes=true in de query staat Voorbeeld : [ "[node](#node)" ]	<Knooppunt> Array
Staat Optionele	De huidige status van het cluster, als het ten minste eenmaal is gestart Voorbeeld : "Starting"	tekenreeks
targetState Optionele	De gewenste status van het cluster (bijvoorbeeld Gestart of Beëindigd) Voorbeeld : "Started"	tekenreeks

nodearrays

Naam	Beschrijving	Schema
Emmers Vereist	Elke bucket met toewijzing voor deze knooppuntmaarray. De instellingen voor het aantal kernen zijn altijd een veelvoud van het aantal kernen voor deze bucket. Voorbeeld : [ "object" ]	<Emmers> Array
maxCoreCount vereist	Het maximum aantal kernen dat zich in deze knooppuntmaarray kan bevinden Voorbeeld : 16	geheel getal
maxCount vereist	Het maximum aantal knooppunten dat zich in deze knooppuntmaarray kan bevinden Voorbeeld : 4	geheel getal
name Vereist	De nodemaarray die dit beschrijft Voorbeeld : "execute"	tekenreeks
nodearray Vereist	De kenmerken van deze knooppuntmaarray Voorbeeld : "[node](#node)"	Knooppunt

Emmers

Naam	Beschrijving	Schema
activeCoreCount Vereist	Het aantal kernen dat voor deze bucket wordt gebruikt, in deze knooppuntmaarray Voorbeeld : 40	geheel getal
activeCount vereist	Het aantal knooppunten dat voor deze bucket wordt gebruikt, in deze knooppuntmaarray. Dit geldt ook voor knooppunten die nog steeds een VIRTUELE machine ophalen. Voorbeeld : 10	geheel getal
activeNodes Optionele	De knooppuntnamen die worden gebruikt voor deze bucket, in deze knooppuntmaarray. Dit geldt ook voor knooppunten die nog steeds een VIRTUELE machine ophalen. Dit wordt alleen opgenomen als nodes=true zich in de query bevindt. Voorbeeld : [ "string" ]	<tekenreeksmatrix >
availableCoreCount vereist	Hoeveel extra kernen er in deze bucket kunnen worden gemaakt, in deze knooppuntmaarray. Altijd een veelvoud van availableCount. Voorbeeld : 8	geheel getal
availableCount vereist	Hoeveel extra knooppunten er in deze bucket kunnen worden gemaakt, in deze knooppuntmaarray. Houd er rekening mee dat dit mogelijk minder is dan geïmpliceerd door maxCount en usedCount, omdat maxCount wereldwijd beperkt kan zijn. Voorbeeld : 2	geheel getal
bucketId vereist	De id voor deze bucket. Dit heeft altijd dezelfde waarde voor een bepaalde bucket in een knooppuntmaarray, zolang het cluster niet wordt verwijderd. Voorbeeld : "00000000-0000-0000-0000-000000000000"	tekenreeks
consumedCoreCount vereist	Het aantal kernen voor dit gezin dat al in de hele regio wordt gebruikt. Voorbeeld : 2	geheel getal
Definitie Optionele	De eigenschappen van deze bucket, die worden gebruikt om knooppunten van deze bucket te maken. De API create-nodes neemt deze definitie op in de bucket eigenschap. Voorbeeld : "object"	Definitie
familyConsumedCoreCount Optionele	Het aantal kernen voor dit gezin dat al in de hele regio wordt gebruikt. Voorbeeld : 2	geheel getal
familyQuotaCoreCount Optionele	Het totale aantal kernen dat kan worden gestart voor deze familie in deze regio. Dit is mogelijk geen veelvoud van een geheel getal van quotaCount. Voorbeeld : 16	geheel getal
familyQuotaCount Optionele	Het aantal exemplaren dat kan worden gestart (gegeven familyQuotaCoreCount) Voorbeeld : 4	geheel getal
invalidReason Vereist	Als geldig onwaar is, bevat dit de reden waarom de bucket ongeldig is. Momenteel zijn NotActivated en DisabledMachineType de enige redenen. Voorbeeld : "DisabledMachineType"	tekenreeks
lastCapacityFailure vereist	Hoe lang, in seconden, sinds de laatste keer dat deze bucket een capaciteitsstoring heeft ondervonden. Elke negatieve waarde wordt behandeld als nooit. Voorbeeld : 180.0	getal
maxCoreCount vereist	Het maximum aantal kernen dat zich in deze bucket kan bevinden, inclusief globale limieten en knooppuntmaarraylimieten. Altijd een veelvoud van maxCount. Voorbeeld : 16	geheel getal
maxCount vereist	Het maximum aantal knooppunten dat zich in deze bucket kan bevinden, inclusief globale limieten en knooppuntmaarraylimieten Voorbeeld : 4	geheel getal
maxPlacementGroupCoreSize vereist	Het maximale totale aantal kernen dat zich in een plaatsingsgroep in deze bucket kan bevinden. Altijd een veelvoud van maxPlacementGroupSize. Voorbeeld : 64	geheel getal
maxPlacementGroupSize vereist	Het maximum aantal exemplaren dat zich in een plaatsingsgroep in deze bucket kan bevinden Voorbeeld : 16	geheel getal
placementGroups vereist	De plaatsingsgroepen die voor deze knooppuntmaarray worden gebruikt, indien van toepassing. Voorbeeld : [ "object" ]	<placementGroups> Array
quotaCoreCount vereist	Het aantal kernen dat voor deze familie in deze regio kan worden gestart, rekening houdend met het aantal regionale quotumkernen. Dit is mogelijk geen veelvoud van een geheel getal van quotaCount. Voorbeeld : 16	geheel getal
quotaCount Vereist	Het aantal exemplaren dat kan worden gestart (gegeven quotaCoreCount) Voorbeeld : 4	geheel getal
regionalConsumedCoreCount Optionele	Het aantal kernen dat al in gebruik is in de hele regio. Voorbeeld : 2	geheel getal
regionalQuotaCoreCount Optionele	Het totale aantal kernen dat in deze regio kan worden gestart. Dit is mogelijk geen geheel getal veelvoud van regionalQuotaCount. Voorbeeld : 16	geheel getal
regionalQuotaCount Optionele	Het aantal exemplaren dat kan worden gestart (gegeven regionalQuotaCoreCount) Voorbeeld : 4	geheel getal
Geldig vereist	Indien waar, vertegenwoordigt deze bucket een momenteel geldige bucket die kan worden gebruikt voor nieuwe knooppunten. Indien onwaar, vertegenwoordigt deze bucket alleen bestaande knooppunten. Voorbeeld : true	booleaans
virtualMachine Vereist	De eigenschappen van de virtuele machines die vanuit deze bucket zijn gestart Voorbeeld : "object"	virtualMachine

Definitie

Naam	Beschrijving	Schema
machineType Vereist	De VM-grootte van de virtuele machine Voorbeeld : "A2"	tekenreeks

placementGroups

Naam	Beschrijving	Schema
activeCoreCount Vereist	Hoeveel kernen deze schaalset bevat Voorbeeld : 16	geheel getal
activeCount Vereist	Hoeveel knooppunten zich in deze schaalset bevinden Voorbeeld : 4	geheel getal
name Vereist	De unieke id van deze plaatsingsgroep Voorbeeld : "my-placement-group"	tekenreeks

virtualMachine

Naam	Beschrijving	Schema
gpuCount Vereist	Het aantal GPU's dat dit type machine heeft Voorbeeld : 2	geheel getal
Infiniband vereist	Als deze virtuele machine InfiniBand-connectiviteit ondersteunt Voorbeeld : true	booleaans
Geheugen vereist	Het RAM-geheugen in deze virtuele machine, in GB Voorbeeld : 7.5	getal
pcpuCount vereist	Het aantal fysieke CPU's van dit type machine Voorbeeld : 16	geheel getal
vcpuCount vereist	Het aantal virtuele CPU's van dit type machine Voorbeeld : 32	geheel getal
vcpuQuotaCount Optionele	Het aantal vCPU's dat deze computer gebruikt vanaf quotum Voorbeeld : 2	geheel getal

ClusterUsage

Gebruiks- en optionele kostengegevens voor het cluster

Naam	Beschrijving	Schema
Gebruik Vereist	Een lijst met gebruiksgegevens per tijdsinterval Voorbeeld : [ "object" ]	<Gebruik> Array

Gebruik

Naam	Beschrijving	Schema
Verdeling Vereist	De uitsplitsing van het gebruik in dit interval, per categorie van 'knooppunt' en 'knooppuntmaarray' Voorbeeld : [ "[clusterusageitem](#clusterusageitem)" ]	<ClusterUsageItem> Array
Einde vereist	Het einde van het interval (exclusief) Voorbeeld : "string"	tekenreeks
start Vereist	Het begin van het interval (inclusief) Voorbeeld : "string"	tekenreeks
Totale vereist	Het algemene gebruik voor dit cluster in dit interval, met een categorie 'cluster' Voorbeeld : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Naam	Beschrijving	Schema
category vereist	"cluster" voor het algehele gebruik; "knooppunt" voor één niet-matrixhoofdknooppunt; "nodearray" voor een hele knooppuntmaarray Voorbeeld : "string"	enum (cluster, knooppunt, knooppuntmaarray)
Kosten Optionele	Het bedrag dat in rekening wordt gebracht voor dit gebruik, in Amerikaanse dollars en tegen retailtarieven. Opmerking: alle kostenbedragen zijn schattingen en weerspiegelen niet de werkelijke factuur! Voorbeeld : 0.0	getal
Details Optionele	Details van de VM-grootte die door een knooppuntmaarray wordt gebruikt, inclusief uren, core_count, regioprioriteit en besturingssysteem. Voorbeeld : [ "object" ]	<Details> Array
Uur Vereist	Het aantal kernuren van gebruik voor deze categorie Voorbeeld : 0.0	getal
Knooppunt Optionele	De naam van het knooppunt of de knooppuntmaarray waarvoor het gebruik is (afwezig voor gegevens op clusterniveau) Voorbeeld : "string"	tekenreeks

Details

Naam	Beschrijving	Schema
core_count Optionele	Het aantal kernen in deze VM-grootte Voorbeeld : 0.0	getal
Kosten Optionele	Kosten van deze VM-grootte Voorbeeld : 0.0	getal
Uur Optionele	Het aantal kernuren van gebruik voor deze VM-grootte Voorbeeld : 0.0	getal
Os Optionele	Type besturingssysteem Voorbeeld : "string"	enum (Windows, Linux)
Prioriteit Optionele	Prioriteit van de VM-SKU Voorbeeld : "string"	enum (Normaal, Spot)
regio Optionele	De regio waarin de VM-grootte wordt geïnstantieerd Voorbeeld : "string"	tekenreeks
vm_size Optionele	VM-SKU-grootte Voorbeeld : "string"	tekenreeks

Knooppunt

Een knooppuntrecord

Type : object

NodeCreationRequest

Hiermee geeft u op hoe knooppunten aan een cluster worden toegevoegd

Naam	Beschrijving	Schema
requestId Optionele	Optioneel door de gebruiker opgegeven uniek token om dubbele bewerkingen te voorkomen in het geval van netwerkcommunicatiefouten. Als deze is opgenomen en overeenkomt met een eerdere aanvraag-id, negeert de server deze aanvraag en retourneert een 409-fout. Voorbeeld : "00000000-0000-0000-0000-000000000000"	tekenreeks
Ingesteld Vereist	Een lijst met te maken knooppuntdefinities. De aanvraag moet ten minste één set bevatten. Elke set kan een andere set eigenschappen opgeven. Voorbeeld : [ "object" ]	<Ingesteld> Array

Ingesteld

Naam	Beschrijving	Schema
Tellen Vereist	Het aantal knooppunten dat moet worden gemaakt Voorbeeld : 1	geheel getal
Definitie Optionele	De definitie van de bucket die moet worden gebruikt. Dit wordt geleverd door de API-aanroep voor de clusterstatus. Als sommige van de items in de statusoproep ontbreken of als de hele bucketeigenschap ontbreekt, wordt de eerste bucket gebruikt die overeenkomt met de opgegeven items. Voorbeeld : "object"	Definitie
nameFormat Optionele	Als dit wordt opgegeven, gebruiken knooppunten deze naamconventie in plaats van de standaardnotatie nodearray-%d Voorbeeld : "custom-name-%d"	tekenreeks
nameOffset Optionele	Indien opgegeven, samen met nameFormat, offsets knooppuntindex voor nieuwe knooppunten. Voorbeeld : 1	geheel getal
nodeAttributes Optionele	Aanvullende kenmerken die moeten worden ingesteld op elk knooppunt van deze set Voorbeeld : "[node](#node)"	Knooppunt
nodearray vereist	De naam van de knooppuntmaarray waaruit knooppunten moeten worden gestart Voorbeeld : "execute"	tekenreeks
placementGroupId Optionele	Indien opgegeven, worden knooppunten met dezelfde waarde voor groupId allemaal gestart in dezelfde plaatsingsgroep. Voorbeeld : "string"	tekenreeks

Definitie

Naam	Beschrijving	Schema
machineType Optionele	Voorbeeld : "A2"	tekenreeks

NodeCreationResult

Naam	Beschrijving	Schema
operationId vereist	De id van deze bewerking Voorbeeld : "00000000-0000-0000-0000-000000000000"	tekenreeks
Ingesteld Vereist	Een matrix met sets, in dezelfde volgorde als in de aanvraag Voorbeeld : [ "object" ]	<Ingesteld> Array

Ingesteld

Naam	Beschrijving	Schema
Toegevoegd vereist	Hoeveel knooppunten er zijn gestart in deze set Voorbeeld : 1	geheel getal
bericht Optionele	Geeft aan waarom niet alle aangevraagde knooppunten kunnen worden toegevoegd, indien aanwezig Voorbeeld : "string"	tekenreeks

NodeList

Resultaten van een knooppuntzoekopdracht

Naam	Beschrijving	Schema
Knooppunten vereist	De geretourneerde knooppunten Voorbeeld : [ "[node](#node)" ]	<Knooppunt> Array
Bewerking Optionele	Als de query een bewerkings-id bevat, is dit de status van die bewerking Voorbeeld : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

Hiermee geeft u op hoe acties moeten worden uitgevoerd op knooppunten in een cluster. Er zijn meerdere manieren om knooppunten op te geven. Als er meer dan één manier is opgenomen, wordt dit behandeld als een samenvoeging.

Naam	Beschrijving	Schema
Filter Optionele	Een filterexpressie die overeenkomt met knooppunten. Houd er rekening mee dat tekenreeksen in de expressie correct moeten worden geciteerd. Voorbeeld : "State === \"Started\""	tekenreeks
Hostnamen Optionele	Een lijst met korte hostnamen (zonder domein) die u wilt beheren Voorbeeld : [ "hostname1", "hostname2" ]	<tekenreeksmatrix >
ids Optionele	Een lijst met te beheren knooppunt-id's Voorbeeld : [ "id1", "id2" ]	<tekenreeksmatrix >
ip_addresses Optionele	Een lijst met TE beheren IP-adressen Voorbeeld : [ "10.0.1.1", "10.1.1.2" ]	<tekenreeksmatrix >
namen Optionele	Een lijst met te beheren knooppuntnamen Voorbeeld : [ "name1", "name2" ]	<tekenreeksmatrix >
requestId Optionele	Optioneel door de gebruiker opgegeven uniek token om dubbele bewerkingen te voorkomen in het geval van netwerkcommunicatiefouten. Als deze is opgenomen en overeenkomt met een eerdere aanvraag-id, negeert de server deze aanvraag en retourneert een 409-fout. Voorbeeld : "00000000-0000-0000-0000-000000000000"	tekenreeks

NodeManagementResult

Naam	Beschrijving	Schema
Knooppunten vereist	Een matrix met informatie over elk knooppunt dat overeenkomt met het filter in de beheeraanvraag. De status van elk knooppunt geeft aan of het is beïnvloed door de aanvraag. Voorbeeld : [ "object" ]	<Knooppunten> Array
operationId vereist	De id van deze bewerking Voorbeeld : "00000000-0000-0000-0000-000000000000"	tekenreeks

Knooppunten

Naam	Beschrijving	Schema
Fout Optionele	Als de status Fout is, bevat dit het foutbericht Voorbeeld : "This node must be terminated before it can be removed"	tekenreeks
id Vereist	De id van het knooppunt Voorbeeld : "id1"	tekenreeks
name vereist	De naam van het knooppunt Voorbeeld : "name1"	tekenreeks
status Optionele	Een van OK of Fout Voorbeeld : "Error"	enum (OK, fout)

OperationStatus

De status van deze knooppuntbewerking

Naam	Beschrijving	Schema
action vereist	Voorbeeld : "string"	enum (maken)
Starttime Vereist	Wanneer deze bewerking is verzonden Voorbeeld : "2020-01-01T12:34:56Z"	tekenreeks (datum-tijd)