Operaties

Clusterknooppunten ophalen

GET /clusters/{cluster}/nodes

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster om een query uit te voeren	snaar
Query-	bewerking optionele	Indien gegeven, retourneert alleen de knooppunten voor deze bewerkings-id en bevat het bewerkingskenmerk op de hoofdtekst	snaar
Query-	request_id optionele	Als dit wordt opgegeven, worden alleen de knooppunten geretourneerd voor de bewerking die is geïdentificeerd door deze aanvraag-id, en bevat het bewerkingskenmerk op de hoofdtekst	snaar

Reacties

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

Voorbeeld van EEN 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

Beschrijving

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

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster waaraan knooppunten moeten worden toegevoegd	snaar
hoofdtekst	knooppunten vereiste	Sets knooppunten die moeten worden gemaakt	NodeCreationRequest

Reacties

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

Voorbeeld van EEN 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" ]
}

Toewijzing van clusterknooppunten ongedaan maken

POST /clusters/{cluster}/nodes/deallocate

Beschrijving

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

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster waarin de toewijzing van knooppunten ongedaan moet worden gemaakt	snaar
hoofdtekst	actie vereiste	Beschrijving van welke knooppunten de toewijzing ongedaan moet worden gemaakt	NodeManagementRequest

Reacties

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

Voorbeeld van EEN 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

Beschrijving

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

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster waarin knooppunten moeten worden verwijderd	snaar
hoofdtekst	actie vereiste	Beschrijving van welke knooppunten moeten worden verwijderd	NodeManagementRequest

Reacties

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

Voorbeeld van EEN 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

Beschrijving

Met deze bewerking worden knooppunten in een cluster beëindigd of opgeheven, afhankelijk van of het kenmerk ShutdownPolicy op elk knooppunt wordt beëindigd (de standaardinstelling) of de toewijzing ervan ongedaan wordt gemaakt.

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster waarin knooppunten moeten worden afgesloten	snaar
hoofdtekst	actie vereiste	Beschrijving van welke knooppunten moeten worden afgesloten	NodeManagementRequest

Reacties

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

Voorbeeld van EEN 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 van clusterknooppunten ongedaan maken of beëindigen

POST /clusters/{cluster}/nodes/start

Beschrijving

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

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster waarin knooppunten moeten worden gestart	snaar
hoofdtekst	actie vereiste	Beschrijving van welke knooppunten moeten worden gestart	NodeManagementRequest

Reacties

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

Voorbeeld van EEN 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

Beschrijving

Met deze bewerking worden knooppunten in een cluster beëindigd. De knooppunten kunnen op verschillende manieren worden geïdentificeerd, waaronder de naam van het knooppunt, de knooppunt-id of het filter.

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster waarin knooppunten moeten worden beëindigd	snaar
hoofdtekst	actie vereiste	Beschrijving van welke knooppunten moeten worden beëindigd	NodeManagementRequest

Reacties

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

Voorbeeld van EEN 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}

Beschrijving

Met deze bewerking worden knooppunten toegevoegd aan een knooppuntmaarray om een totaalaantal te bereiken. De aanvraag wordt eenmalig 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 totaalknooppunten, maar niet op beide. Hiermee wordt de URL geretourneerd naar de bewerking die kan worden gebruikt om de status van de bewerking bij te houden.

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster waaraan knooppunten moeten worden toegevoegd	snaar
pad	nodearray- vereiste	De knooppuntmaarray waaraan knooppunten moeten worden toegevoegd	snaar
Query-	totalCoreCount- optionele	Het totale aantal kernen dat in deze knooppuntmaarray moet worden opgenomen, inclusief knooppunten die al zijn gemaakt	geheel getal
Query-	totalNodeCount- optionele	Het totale aantal machines dat in deze knooppuntmaarray moet worden opgenomen, inclusief knooppunten die al zijn gemaakt	geheel getal

Reacties

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

Voorbeeld van EEN 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

Beschrijving

Deze bewerking bevat informatie voor de knooppunten en nodearrays in een bepaald cluster. Voor elke knooppuntmaarray wordt de status geretourneerd van elke 'bucket' van toewijzing die kan worden gebruikt, zoals het aantal knooppunten in de bucket, hoeveel 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 deels bepaald door de cloudprovider.

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster om een query uit te voeren	snaar
Query-	knooppunten optionele	Als waar, worden knooppunten en knooppuntverwijzingen geretourneerd in het antwoord	booleaans

Reacties

HTTP-code	Beschrijving	Schema
200	OK	ClusterStatus-

Voorbeeld van EEN 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 kosteninformatie voor een cluster ophalen

GET /clusters/{cluster}/usage

Beschrijving

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

Parameters

Type	Naam	Beschrijving	Schema
pad	cluster vereiste	Het cluster voor het retourneren van gebruiksgegevens voor	snaar
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). voor aangepaste queryparameters moet 'van' en 'naar' worden uitgevoerd. De standaardwaarde is MonthToDate. Alle tijden zijn in UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Query-	uit 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.	snaar
Query-	optionele	Voor aangepaste tijdsbestekken is dit het einde van het tijdsbestek in ISO-8601-indeling. Dit wordt afgerond op het dichtstbijzijnde uur of de dichtstbijzijnde dag.	snaar
Query-	granulariteit optionele	Hiermee geeft u op hoe u gegevens kunt aggregeren: per uur, per dag of als één getal. Deze standaardwaarde is dagelijks.	enum (totaal, dagelijks, elk uur)

Reacties

HTTP-code	Beschrijving	Schema
200	OK	ClusterUsage-

Voorbeeld van EEN HTTP-aanvraag

Aanvraagpad

/clusters/CLUSTER_NAME/usage

Voorbeeld van HTTP-antwoord

Antwoord 200

{
  "usage" : [ "object" ]
}

Geeft de status van bewerkingen weer

GET /operations/

Parameters

Type	Naam	Beschrijving	Schema
Query-	request_id optionele	De aanvraag-id voor de bewerking. Als dit wordt opgegeven, heeft de lijst slechts 0 of 1 element erin.	snaar

Reacties

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

Voorbeeld van EEN HTTP-aanvraag

Aanvraagpad

/operations/

Voorbeeld van HTTP-antwoord

Antwoord 200

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

Hiermee haalt u de bewerkingsstatus op id op

GET /operations/{id}

Parameters

Type	Naam	Beschrijving	Schema
pad	id vereiste	De bewerkings-id	snaar

Reacties

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

Voorbeeld van EEN HTTP-aanvraag

Aanvraagpad

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

Voorbeeld van HTTP-antwoord

Antwoord 200

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

Weg

ClusterStatus

Status van het cluster

Naam	Beschrijving	Schema
maxCoreCount- vereiste	Het maximum aantal kernen dat aan dit cluster kan worden toegevoegd voorbeeld van: 16	geheel getal
maxCount- vereiste	Het maximum aantal knooppunten dat aan dit cluster kan worden toegevoegd voorbeeld van: 4	geheel getal
nodearrays vereiste	voorbeeld van: [ "object" ]	< knooppuntmatrix>
knooppunten optionele	Een optionele lijst met knooppunten in dit cluster, alleen opgenomen als knooppunten=true zich in de query bevinden voorbeeld van: [ "[node](#node)" ]	< knooppuntmatrix>
status optionele	De huidige status van het cluster, als het ten minste één keer is gestart voorbeeld van: "Starting"	snaar
targetState- optionele	De gewenste status van het cluster (bijvoorbeeld gestart of beëindigd) voorbeeld van: "Started"	snaar

nodearrays

Naam	Beschrijving	Schema
buckets vereiste	Elke bucket van toewijzing voor deze knooppuntmaarray. De instellingen voor het aantal kernen zijn altijd een veelvoud van het aantal kernen voor deze bucket. voorbeeld van: [ "object" ]	< buckets> matrix
maxCoreCount- vereiste	Het maximum aantal kernen dat zich mogelijk in deze knooppuntmaarray bevindt voorbeeld van: 16	geheel getal
maxCount- vereiste	Het maximum aantal knooppunten dat zich mogelijk in deze knooppuntmaarray bevindt voorbeeld van: 4	geheel getal
naam vereiste	De knooppuntmaarray die hier wordt beschreven voorbeeld van: "execute"	snaar
nodearray- vereiste	De kenmerken van deze knooppuntmaarray voorbeeld van: "[node](#node)"	Node-

buckets

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

definitie

Naam	Beschrijving	Schema
machineType- vereiste	De VM-grootte van de virtuele machine voorbeeld van: "A2"	snaar

placementGroups

Naam	Beschrijving	Schema
activeCoreCount- vereiste	Hoeveel kernen zijn er in deze schaalset voorbeeld van: 16	geheel getal
activeCount- vereiste	Hoeveel knooppunten zich in deze schaalset bevinden voorbeeld van: 4	geheel getal
naam vereiste	De unieke id van deze plaatsingsgroep voorbeeld van: "my-placement-group"	snaar

virtualMachine

Naam	Beschrijving	Schema
gpuCount- vereiste	Het aantal GPU's dat dit type machine heeft voorbeeld van: 2	geheel getal
vereiste	Als deze virtuele machine ondersteuning biedt voor InfiniBand-connectiviteit voorbeeld van: true	booleaans
geheugen vereiste	Het RAM-geheugen in deze virtuele machine, in GB voorbeeld van: 7.5	getal
pcpuCount- vereiste	Het aantal fysieke CPU's dat dit machinetype heeft voorbeeld van: 16	geheel getal
vcpuCount- vereiste	Het aantal virtuele CPU's dat dit machinetype heeft voorbeeld van: 32	geheel getal
vcpuQuotaCount optionele	Het aantal vCPU's dat door deze computer wordt gebruikt op basis van quota voorbeeld van: 2	geheel getal

ClusterUsage

Gebruiks- en optionele kosteninformatie voor het cluster

Naam	Beschrijving	Schema
vereiste	Een lijst met gebruiksgegevens per tijdsinterval voorbeeld van: [ "object" ]	< > matrix

Naam	Beschrijving	Schema
uitsplitsing vereiste	De uitsplitsing van het gebruik in dit interval, per categorie 'knooppunt' en 'nodearray' voorbeeld van: [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> matrix
beëindigen vereiste	Het einde van het interval (exclusief) voorbeeld van: "string"	snaar
starten vereiste	Het begin van het interval (inclusief) voorbeeld van: "string"	snaar
totaal vereiste	Het algemene gebruik voor dit cluster in dit interval, met een categorie 'cluster' voorbeeld van: "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem-

ClusterUsageItem

Naam	Beschrijving	Schema
categorie vereiste	"cluster" voor het algehele gebruik; "knooppunt" voor één niet-matrixhoofdknooppunt; "nodearray" voor een hele knooppuntmaarray voorbeeld van: "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 van: 0.0	getal
details optionele	Details van de VM-grootte die wordt gebruikt door een knooppuntmaarray, inclusief uren, core_count, regioprioriteit en besturingssysteem. voorbeeld van: [ "object" ]	< details> matrix
uur vereiste	Het aantal kernuren van gebruik voor deze categorie voorbeeld van: 0.0	getal
knooppunt optionele	De naam van het knooppunt of de knooppuntmaarray waarvoor het gebruik is bedoeld (afwezig voor gegevens op clusterniveau) voorbeeld van: "string"	snaar

details

Naam	Beschrijving	Schema
core_count optionele	Het aantal kernen in deze VM-grootte voorbeeld van: 0.0	getal
kosten optionele	Kosten van deze VM-grootte voorbeeld van: 0.0	getal
uur optionele	Het aantal kernuren van gebruik voor deze VM-grootte voorbeeld van: 0.0	getal
besturingssysteem optionele	Type besturingssysteem voorbeeld van: "string"	enum (Windows, Linux)
prioriteit optionele	Prioriteit van de VM-SKU voorbeeld van: "string"	enum (normaal, spot)
regio optionele	De regio waarin de VM-grootte wordt geïnstantieerd voorbeeld van: "string"	snaar
vm_size optionele	VM-SKU-grootte voorbeeld van: "string"	snaar

Knoop

Een knooppuntrecord

Type: object

NodeCreationRequest

Hiermee geeft u op hoe u knooppunten toevoegt aan een cluster

Naam	Beschrijving	Schema
requestId- optionele	Optionele door de gebruiker opgegeven unieke token om dubbele bewerkingen te voorkomen in het geval van netwerkcommunicatiefouten. Als dit is opgenomen en overeenkomt met een eerdere aanvraag-id, negeert de server deze aanvraag en retourneert een 409-fout. voorbeeld van: "00000000-0000-0000-0000-000000000000"	snaar
stelt vereiste	Een lijst met knooppuntdefinities die moeten worden gemaakt. De aanvraag moet ten minste één set bevatten. Elke set kan een andere set eigenschappen opgeven. voorbeeld van: [ "object" ]	< stelt> matrix in

stelt

Naam	Beschrijving	Schema
aantal vereiste	Het aantal knooppunten dat moet worden gemaakt voorbeeld van: 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 items in de statusoproep ontbreken of als de hele bucket-eigenschap ontbreekt, wordt de eerste bucket gebruikt die overeenkomt met de opgegeven items. voorbeeld van: "object"	definitie
nameFormat- optionele	Indien gegeven, gebruiken knooppunten deze naamconventie in plaats van de standaardnotatie 'nodearray-%d' voorbeeld van: "custom-name-%d"	snaar
nameOffset optionele	Als dit wordt opgegeven, samen met nameFormat, worden knooppuntindexen voor nieuwe knooppunten verschoven. voorbeeld van: 1	geheel getal
nodeAttributes optionele	Aanvullende kenmerken die op elk knooppunt uit deze set moeten worden ingesteld voorbeeld van: "[node](#node)"	Node-
nodearray- vereiste	De naam van de knooppuntmaarray waaruit knooppunten moeten worden gestart voorbeeld van: "execute"	snaar
placementGroupId optionele	Indien gegeven, worden knooppunten met dezelfde waarde voor groupId allemaal gestart in dezelfde plaatsingsgroep. voorbeeld van: "string"	snaar

definitie

Naam	Beschrijving	Schema
machineType- optionele	voorbeeld van: "A2"	snaar

NodeCreationResult

Naam	Beschrijving	Schema
operationId vereiste	De id van deze bewerking voorbeeld van: "00000000-0000-0000-0000-000000000000"	snaar
stelt vereiste	Een matrix van sets, in dezelfde volgorde als in de aanvraag voorbeeld van: [ "object" ]	< stelt> matrix in

stelt

Naam	Beschrijving	Schema
toegevoegd vereiste	Hoeveel knooppunten zijn gestart in deze set voorbeeld van: 1	geheel getal
bericht optionele	Geeft aan waarom niet alle aangevraagde knooppunten kunnen worden toegevoegd, indien aanwezig voorbeeld van: "string"	snaar

NodeList

Resultaten van een knooppuntzoekopdracht

Naam	Beschrijving	Schema
knooppunten vereiste	De geretourneerde knooppunten voorbeeld van: [ "[node](#node)" ]	< knooppuntmatrix>
bewerking optionele	Als de query een bewerkings-id bevat, is dit de status van die bewerking voorbeeld van: "[operationstatus](#operationstatus)"	OperationStatus-

NodeManagementRequest

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

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

NodeManagementResult

Naam	Beschrijving	Schema
knooppunten vereiste	Een matrix met informatie over elk knooppunt dat overeenkomt met het filter in de beheeraanvraag. De status van elk knooppunt geeft aan of dit wordt beïnvloed door de aanvraag. voorbeeld van: [ "object" ]	< knooppunten> matrix
operationId vereiste	De id van deze bewerking voorbeeld van: "00000000-0000-0000-0000-000000000000"	snaar

knooppunten

Naam	Beschrijving	Schema
fout optionele	Als de status Fout is, bevat dit het foutbericht voorbeeld van: "This node must be terminated before it can be removed"	snaar
id vereiste	De id van het knooppunt voorbeeld van: "id1"	snaar
naam vereiste	De naam van het knooppunt voorbeeld van: "name1"	snaar
status optionele	Een van OK of Fout voorbeeld van: "Error"	enum (OK, fout)

OperationStatus

De status van deze knooppuntbewerking

Naam	Beschrijving	Schema
actie vereiste	voorbeeld van: "string"	enum (maken)
startTime vereiste	Wanneer deze bewerking is verzonden voorbeeld van: "2020-01-01T12:34:56Z"	tekenreeks (datum/tijd)