Dela via

Verksamhet

  • Artikel

Hämta klusternoder

GET /clusters/{cluster}/nodes

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret som ska frågas sträng
Fråga åtgärd
valfritt		 Om detta anges returnerar endast noderna för det här åtgärds-ID:t och innehåller åtgärdsattributet i brödtexten sträng
Fråga request_id
valfritt		 Om detta anges returnerar endast noderna för den åtgärd som identifieras av det här begärande-ID:t.
och innehåller åtgärdsattributet på brödtexten		 sträng

Svaren

HTTP-kod Beskrivning Schemat
200 OKEJ NodeList
400 Ogiltig specifikation Inget innehåll
404 Hittades inte Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/nodes

Exempel på HTTP-svar

Svar 200

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

Skapa klusternoder

POST /clusters/{cluster}/nodes/create

Beskrivning

Den här åtgärden lägger till nya noder från en nodearray till ett kluster. Den accepterar flera noddefinitioner i ett enda anrop. Den returnerar URL:en till den åtgärd som kan användas för att spåra åtgärdens status.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret för att lägga till noder i sträng
Brödtext noder
krävs		 Uppsättningar med noder som ska skapas NodeCreationRequest

Svaren

HTTP-kod Beskrivning Schemat
202 Accepterad
rubriker :
Location (sträng) : URL:en för åtgärden.		 NodeCreationResult
409 Ogiltiga indata Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/nodes/create

Begärandetext

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

Exempel på HTTP-svar

Svar 202

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

Frigöra klusternoder

POST /clusters/{cluster}/nodes/deallocate

Beskrivning

Den här åtgärden frigör noder i ett kluster. Noderna kan identifieras på flera sätt, inklusive nodnamn, nod-ID eller filter.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret för att frigöra noder i sträng
Brödtext åtgärd
krävs		 Beskrivning av vilka noder som ska frigöras NodeManagementRequest

Svaren

HTTP-kod Beskrivning Schemat
202 Accepterad
rubriker :
Location (sträng) : URL:en för åtgärden.		 NodeManagementResult
409 Ogiltiga indata Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/nodes/deallocate

Begärandetext

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

Exempel på HTTP-svar

Svar 202

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

Avsluta och ta bort klusternoder

POST /clusters/{cluster}/nodes/remove

Beskrivning

Den här åtgärden tar bort noder i ett kluster. Noderna kan identifieras på flera sätt, inklusive nodnamn, nod-ID eller filter. Observera att noder som standard tas bort när de avslutas (såvida inte noden har fast inställd på true), vilket innebär att det här anropet inte skiljer sig från avsluta.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret för att ta bort noder i sträng
Brödtext åtgärd
krävs		 Beskrivning av vilka noder som ska tas bort NodeManagementRequest

Svaren

HTTP-kod Beskrivning Schemat
202 Accepterad
rubriker :
Location (sträng) : URL:en för åtgärden.		 NodeManagementResult
409 Ogiltiga indata Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/nodes/remove

Begärandetext

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

Exempel på HTTP-svar

Svar 202

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

Avsluta eller frigöra klusternoder

POST /clusters/{cluster}/nodes/shutdown

Beskrivning

Den här åtgärden avslutar eller frigör noder i ett kluster, beroende på om attributet ShutdownPolicy på varje nod är Terminate (standard) respektive Deallocate.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret för att stänga av noder i sträng
Brödtext åtgärd
krävs		 Beskrivning av vilka noder som ska stängas av NodeManagementRequest

Svaren

HTTP-kod Beskrivning Schemat
202 Accepterad
rubriker :
Location (sträng) : URL:en för åtgärden.		 NodeManagementResult
409 Ogiltiga indata Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/nodes/shutdown

Begärandetext

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

Exempel på HTTP-svar

Svar 202

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

Starta frigjorda eller avslutade klusternoder

POST /clusters/{cluster}/nodes/start

Beskrivning

Den här åtgärden startar noder i ett kluster. Noderna kan identifieras på flera sätt, inklusive nodnamn, nod-ID eller filter.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret som ska starta noder i sträng
Brödtext åtgärd
krävs		 Beskrivning av vilka noder som ska startas NodeManagementRequest

Svaren

HTTP-kod Beskrivning Schemat
202 Accepterad
rubriker :
Location (sträng) : URL:en för åtgärden.		 NodeManagementResult
409 Ogiltiga indata Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/nodes/start

Begärandetext

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

Exempel på HTTP-svar

Svar 202

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

Avsluta klusternoder

POST /clusters/{cluster}/nodes/terminate

Beskrivning

Den här åtgärden avslutar noder i ett kluster. Noderna kan identifieras på flera sätt, inklusive nodnamn, nod-ID eller filter.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret för att avsluta noder i sträng
Brödtext åtgärd
krävs		 Beskrivning av vilka noder som ska avslutas NodeManagementRequest

Svaren

HTTP-kod Beskrivning Schemat
202 Accepterad
rubriker :
Location (sträng) : URL:en för åtgärden.		 NodeManagementResult
409 Ogiltiga indata Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/nodes/terminate

Begärandetext

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

Exempel på HTTP-svar

Svar 202

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

Skala kluster till storlek

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

Beskrivning

Den här åtgärden lägger till noder efter behov i en nodearray för att nå ett totalt antal. Begäran bearbetas en gång och lägger inte till noder igen senare för att behålla det angivna talet. Detta skalar antingen efter totalt antal kärnor eller totalt antal noder, men inte båda. Den returnerar URL:en till den åtgärd som kan användas för att spåra åtgärdens status.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret för att lägga till noder i sträng
Sökväg nodearray
krävs		 Nodearray för att lägga till noder i sträng
Fråga totalCoreCount
valfritt		 Det totala antalet kärnor som ska finnas i den här nodearrayen, inklusive noder som redan har skapats heltal
Fråga totalNodeCount
valfritt		 Det totala antalet datorer som ska ha i den här nodearrayen, inklusive noder som redan har skapats heltal

Svaren

HTTP-kod Beskrivning Schemat
202 Accepterad
rubriker :
Location (sträng) : URL:en för åtgärden.		 NodeCreationResult
409 Ogiltiga indata Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Exempel på HTTP-svar

Svar 202

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

Hämta klusterstatus

GET /clusters/{cluster}/status

Beskrivning

Den här åtgärden innehåller information om noderna och nodearrays i ett visst kluster. För varje nodearray returneras statusen för varje "bucket" med allokering som kan användas, till exempel hur många noder som finns i bucketen, hur många fler som kan läggas till osv. Varje bucket är en uppsättning möjliga virtuella datorer för en viss maskinvaruprofil, som kan skapas på en viss plats, under ett visst kundkonto osv. De giltiga bucketarna för en nodearray bestäms av användarens klusterdefinition, men gränserna bestäms delvis av molnleverantören.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret som ska frågas sträng
Fråga noder
valfritt		 Om sant returneras noder och nodreferenser i svaret boolesk

Svaren

HTTP-kod Beskrivning Schemat
200 OKEJ ClusterStatus

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/status

Exempel på HTTP-svar

Svar 200

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

Hämta information om användning och valfri kostnad för ett kluster

GET /clusters/{cluster}/usage

Beskrivning

Den här åtgärden returnerar övergripande användningsdata (kärntimmar) och kostnadsdata, om de är tillgängliga, för klustret samt en uppdelning per nodrad. Som standard returneras den aktuella månadens användningsvärde.

Parametrar

Typ Namn Beskrivning Schemat
Sökväg kluster
krävs		 Klustret som ska returnera användningsdata för sträng
Fråga tidsram
valfritt		 Om detta anges anger det tidsintervall som ska användas för frågan. monthToDate returnerar användningen för den aktuella månaden och lastMonth returnerar användningen för föregående månad. weekToDate returnerar användningen för den aktuella veckan (från och med söndag). anpassade kräver att "från" och "till" frågeparametrar. Standardvärdet är MonthToDate. Alla tider finns i UTC. uppräkning (monthToDate, lastMonth, weekToDate, custom)
Fråga från
valfritt		 För anpassade tidsramar är detta början på tidsramen i ISO-8601-format. Detta avrundas ned till närmaste timme eller dag. sträng
Fråga till
valfritt		 För anpassade tidsramar är detta slutet på tidsramen i ISO-8601-format. Detta avrundas upp till närmaste timme eller dag. sträng
Fråga kornighet
valfritt		 Anger hur du aggregerar data: per timme, per dag eller som ett enda tal. Det här standardvärdet är dagligen. uppräkning (totalt, dagligen, per timme)

Svaren

HTTP-kod Beskrivning Schemat
200 OKEJ ClusterUsage

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/usage

Exempel på HTTP-svar

Svar 200

{
  "usage" : [ "object" ]
}

Visar status för åtgärder

GET /operations/

Parametrar

Typ Namn Beskrivning Schemat
Fråga request_id
valfritt		 Begärande-ID:t för åtgärden. Om detta anges har listan bara 0 eller 1 element i den. sträng

Svaren

HTTP-kod Beskrivning Schemat
200 OKEJ < OperationStatus> matris
400 Ogiltig begäran Inget innehåll
404 Hittades inte Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

/operations/

Exempel på HTTP-svar

Svar 200

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

Hämtar åtgärdsstatus efter ID

GET /operations/{id}

Parametrar

Typ Namn Beskrivning Schemat
Sökväg ID
krävs		 Åtgärds-ID sträng

Svaren

HTTP-kod Beskrivning Schemat
200 OKEJ OperationStatus
404 Hittades inte Inget innehåll

Exempel på HTTP-begäran

Sökväg för begäran

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

Exempel på HTTP-svar

Svar 200

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

Resurser

ClusterStatus

Status för klustret

Namn Beskrivning Schemat
maxCoreCount
krävs		 Det maximala antalet kärnor som kan läggas till i det här klustret
Exempel: 16		 heltal
maxCount
krävs		 Det maximala antalet noder som kan läggas till i det här klustret
Exempel: 4		 heltal
nodearrays
krävs		 Exempel: [ "object" ] < nodearrays> matris
noder
valfritt		 En valfri lista över noder i det här klustret ingår endast om noder=true finns i frågan
Exempel: [ "[node](#node)" ]		 < node>-matris
tillstånd
valfritt		 Klustrets aktuella tillstånd, om det har startats minst en gång
Exempel: "Starting"		 sträng
targetState
valfritt		 Det önskade tillståndet för klustret (t.ex. Startat eller avslutat)
Exempel: "Started"		 sträng

nodearrays

Namn Beskrivning Schemat
bucketar
krävs		 Varje bucket med allokering för den här nodearrayen. Inställningarna för "kärnantal" är alltid en multipel av antalet kärnor för den här bucketen.
Exempel: [ "object" ]		 < bucketar> matris
maxCoreCount
krävs		 Det maximala antalet kärnor som kan finnas i den här nodearrayen
Exempel: 16		 heltal
maxCount
krävs		 Det maximala antalet noder som kan finnas i den här nodearrayen
Exempel: 4		 heltal
namn
krävs		 Den nodearray som detta beskriver
Exempel: "execute"		 sträng
nodearray
krävs		 Attributen för den här nodearrayen
Exempel: "[node](#node)"		 Node

bucketar

Namn Beskrivning Schemat
activeCoreCount
krävs		 Antalet kärnor som används för den här bucketen i den här nodearrayen
Exempel: 40		 heltal
activeCount
krävs		 Antalet noder som används för den här bucketen i den här nodearrayen. Detta inkluderar noder som fortfarande hämtar en virtuell dator.
Exempel: 10		 heltal
activeNodes
valfritt		 Nodnamnen som används för den här bucketen i den här nodearrayen. Detta inkluderar noder som fortfarande hämtar en virtuell dator. Detta ingår endast om nodes=true finns i frågan.
Exempel: [ "string" ]		 < sträng > matris
availableCoreCount
krävs		 Hur många extra kärnor som kan skapas i den här bucketen i den här nodearrayen. Alltid en multipel av availableCount.
Exempel: 8		 heltal
availableCount
krävs		 Hur många extra noder som kan skapas i den här bucketen i den här nodearrayen. Observera att detta kan vara mindre underförstått av maxCount och usedCount, eftersom maxCount kan vara begränsat globalt.
Exempel: 2		 heltal
bucketId
krävs		 Identifieraren för den här bucketen. Detta har alltid samma värde för en viss bucket i en nodearray, så länge klustret inte tas bort.
Exempel: "00000000-0000-0000-0000-000000000000"		 sträng
consumedCoreCount
krävs		 Antalet kärnor för den här familjen som redan används i hela regionen.
Exempel: 2		 heltal
definition
valfritt		 Egenskaperna för den här bucketen, som används för att skapa noder från den här bucketen. API:et create-nodes tar den här definitionen i egenskapen bucket.
Exempel: "object"		 definition
familyConsumedCoreCount
valfritt		 Antalet kärnor för den här familjen som redan används i hela regionen.
Exempel: 2		 heltal
familyQuotaCoreCount
valfritt		 Antalet kärnor som kan startas för den här familjen i den här regionen. Det här kanske inte är en heltalsmultipel av quotaCount.
Exempel: 16		 heltal
familyQuotaCount
valfritt		 Antalet totala instanser som kan startas (givet familyQuotaCoreCount)
Exempel: 4		 heltal
invalidReason
krävs		 Om giltigt är falskt innehåller detta orsaken till att bucketen är ogiltig. NotActivated och DisabledMachineType är för närvarande de enda orsakerna.
Exempel: "DisabledMachineType"		 sträng
lastCapacityFailure
krävs		 Hur länge, i sekunder, sedan den senaste gången den här bucketen upplevde ett kapacitetsfel. Negativa värden behandlas som aldrig.
Exempel: 180.0		 nummer
maxCoreCount
krävs		 Det maximala antalet kärnor som kan finnas i den här bucketen, inklusive globala gränser och nodearray-gränser. Alltid en multipel av maxCount.
Exempel: 16		 heltal
maxCount
krävs		 Det maximala antalet noder som kan finnas i den här bucketen, inklusive globala gränser och nodearray-gränser
Exempel: 4		 heltal
maxPlacementGroupCoreSize
krävs		 Det maximala totala antalet kärnor som kan finnas i en placeringsgrupp i den här bucketen. Alltid en multipel av maxPlacementGroupSize.
Exempel: 64		 heltal
maxPlacementGroupSize
krävs		 Det maximala totala antalet instanser som kan finnas i en placeringsgrupp i den här bucketen
Exempel: 16		 heltal
placementGroups
krävs		 De placeringsgrupper som används för den här nodearrayen, om några.
Exempel: [ "object" ]		 < placementGroups> matris
quotaCoreCount
krävs		 Antalet kärnor som kan startas för den här familjen i den här regionen, med hänsyn även till antalet regionala kvotkärnor. Det här kanske inte är en heltalsmultipel av quotaCount.
Exempel: 16		 heltal
quotaCount
krävs		 Antalet totala instanser som kan startas (givet quotaCoreCount)
Exempel: 4		 heltal
regionalConsumedCoreCount
valfritt		 Antalet kärnor som redan används i hela regionen.
Exempel: 2		 heltal
regionalQuotaCoreCount
valfritt		 Antalet kärnor som kan startas i den här regionen. Det här kanske inte är en heltalsmultipel för regionalQuotaCount.
Exempel: 16		 heltal
regionalQuotaCount
valfritt		 Antalet totala instanser som kan startas (givet regionalQuotaCoreCount)
Exempel: 4		 heltal
giltig
krävs		 Om det är sant representerar den här bucketen en giltig bucket som ska användas för nya noder. Om det är falskt representerar den här bucketen endast befintliga noder.
Exempel: true		 boolesk
virtualMachine
krävs		 Egenskaperna för de virtuella datorer som startas från den här bucketen
Exempel: "object"		 virtualMachine

definition

Namn Beskrivning Schemat
machineType
krävs		 Vm-storleken på den virtuella datorn
Exempel: "A2"		 sträng

placementGroups

Namn Beskrivning Schemat
activeCoreCount
krävs		 Hur många kärnor som finns i den här skalningsuppsättningen
Exempel: 16		 heltal
activeCount
krävs		 Hur många noder som finns i den här skalningsuppsättningen
Exempel: 4		 heltal
namn
krävs		 Den unika identifieraren för den här placeringsgruppen
Exempel: "my-placement-group"		 sträng

virtualMachine

Namn Beskrivning Schemat
gpuCount
krävs		 Antalet GPU:er som den här datortypen har
Exempel: 2		 heltal
infiniband
krävs		 Om den här virtuella datorn stöder InfiniBand-anslutning
Exempel: true		 boolesk
minne
krävs		 RAM-minnet på den här virtuella datorn, i GB
Exempel: 7.5		 nummer
pcpuCount
krävs		 Antalet fysiska processorer som den här datortypen har
Exempel: 16		 heltal
vcpuCount
krävs		 Antalet virtuella processorer som den här datortypen har
Exempel: 32		 heltal
vcpuQuotaCount
valfritt		 Antalet virtuella processorer som den här datorn använder från kvoten
Exempel: 2		 heltal

ClusterUsage

Användningsinformation och valfri kostnadsinformation för klustret

Namn Beskrivning Schemat
användning
krävs		 En lista över användningar efter tidsintervall
Exempel: [ "object" ]		 < användning> matris

användning

Namn Beskrivning Schemat
uppdelning
krävs		 Uppdelningen av användningen i det här intervallet, efter kategori "nod" och "nodearray"
Exempel: [ "[clusterusageitem](#clusterusageitem)" ]		 < ClusterUsageItem> matris
slut
krävs		 Slutet av intervallet (exklusivt)
Exempel: "string"		 sträng
starta
krävs		 Början av intervallet (inklusive)
Exempel: "string"		 sträng
totalt
krävs		 Den övergripande användningen för det här klustret i det här intervallet, med en kategori av "kluster"
Exempel: "[clusterusageitem](#clusterusageitem)"		 ClusterUsageItem

ClusterUsageItem

Namn Beskrivning Schemat
kategori
krävs		 "kluster" för den totala användningen. "nod" för en enda huvudnod som inte är matris. "nodearray" för en hel nodearray
Exempel: "string"		 enum (kluster, nod, nodearray)
kostnad
valfritt		 Det belopp som skulle debiteras för denna användning, i AMERIKANSKA dollar och till detaljhandelspriser. Obs! Alla kostnadsbelopp är uppskattningar och återspeglar inte den faktiska fakturan!
Exempel: 0.0		 nummer
information
valfritt		 Information om vm-storlek som används av en nodearray, inklusive timmar, core_count, regionprioritet och operativsystem.
Exempel: [ "object" ]		 < information> matris
timmar
krävs		 Antalet kärntimmar för användning för den här kategorin
Exempel: 0.0		 nummer
nod
valfritt		 Namnet på den nod eller nodearray som användningen är för (saknas för data på klusternivå)
Exempel: "string"		 sträng

information

Namn Beskrivning Schemat
core_count
valfritt		 Antalet kärnor i den här VM-storleken
Exempel: 0.0		 nummer
kostnad
valfritt		 Kostnaden för den här vm-storleken
Exempel: 0.0		 nummer
timmar
valfritt		 Antalet kärntimmar för användning för den här vm-storleken
Exempel: 0.0		 nummer
os
valfritt		 Typ av operativsystem
Exempel: "string"		 uppräkning (Windows, Linux)
prioritet
valfritt		 Prioritet för den virtuella datorns Sku
Exempel: "string"		 uppräkning (vanlig, punkt)
region
valfritt		 Den region som den virtuella datorns storlek instansieras i
Exempel: "string"		 sträng
vm_size
valfritt		 VM SKU-storlek
Exempel: "string"		 sträng

Nod

En nodpost

Typ : objekt

NodeCreationRequest

Anger hur du lägger till noder i ett kluster

Namn Beskrivning Schemat
requestId
valfritt		 Valfri unik token som tillhandahålls av användaren för att förhindra duplicerade åtgärder vid nätverkskommunikationsfel. Om detta ingår och matchar ett tidigare begärande-ID ignorerar servern den här begäran och returnerar ett 409-fel.
Exempel: "00000000-0000-0000-0000-000000000000"		 sträng
anger
krävs		 En lista över noddefinitioner som ska skapas. Begäran måste innehålla minst en uppsättning. Varje uppsättning kan ange en annan uppsättning egenskaper.
Exempel: [ "object" ]		 < anger> matris

uppsättningar

Namn Beskrivning Schemat
antal
krävs		 Antalet noder som ska skapas
Exempel: 1		 heltal
definition
valfritt		 Definitionen av bucketen som ska användas. Detta tillhandahålls av API-anropet för klusterstatus. Om vissa av de objekt som anges i statusanropet saknas, eller om hela bucketegenskapen saknas, används den första bucketen som matchar de angivna objekten.
Exempel: "object"		 definition
nameFormat
valfritt		 Om detta anges använder noder den här namngivningskonventionen i stället för standardformatet "nodearray-%d"
Exempel: "custom-name-%d"		 sträng
nameOffset
valfritt		 Om detta anges, tillsammans med nameFormat, förskjuts nodeindex för nya noder.
Exempel: 1		 heltal
nodeAttributes
valfritt		 Ytterligare attribut som ska anges på varje nod från den här uppsättningen
Exempel: "[node](#node)"		 Node
nodearray
krävs		 Namnet på den nodearray som noderna ska startas från
Exempel: "execute"		 sträng
placementGroupId
valfritt		 Om detta anges startas noder med samma värde för groupId i samma placeringsgrupp.
Exempel: "string"		 sträng

definition

Namn Beskrivning Schemat
machineType
valfritt		 Exempel: "A2" sträng

NodeCreationResult

Namn Beskrivning Schemat
operationId
krävs		 ID:t för den här åtgärden
Exempel: "00000000-0000-0000-0000-000000000000"		 sträng
anger
krävs		 En matris med uppsättningar i samma ordning som i begäran
Exempel: [ "object" ]		 < anger> matris

uppsättningar

Namn Beskrivning Schemat
har lagts till
krävs		 Hur många noder som startades i den här uppsättningen
Exempel: 1		 heltal
meddelande
valfritt		 Anger varför inte alla begärda noder kan läggas till, om de finns
Exempel: "string"		 sträng

NodeList

Resultat av en nodsökning

Namn Beskrivning Schemat
noder
krävs		 Noderna som returnerades
Exempel: [ "[node](#node)" ]		 < node>-matris
åtgärd
valfritt		 Om frågan innehåller ett åtgärds-ID är detta status för åtgärden
Exempel: "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

Anger hur du utför åtgärder på noder i ett kluster. Det finns flera sätt att ange noder, och om fler än ett sätt ingår behandlas det som en union.

Namn Beskrivning Schemat
filtrera
valfritt		 Ett filteruttryck som matchar noder. Observera att strängar i uttrycket måste citeras korrekt.
Exempel: "State === \"Started\""		 sträng
värdnamn
valfritt		 En lista med korta värdnamn (utan domän) att hantera
Exempel: [ "hostname1", "hostname2" ]		 < sträng > matris
ID:t
valfritt		 En lista över nod-ID:t som ska hanteras
Exempel: [ "id1", "id2" ]		 < sträng > matris
ip_addresses
valfritt		 En lista över IP-adresser att hantera
Exempel: [ "10.0.1.1", "10.1.1.2" ]		 < sträng > matris
namn
valfritt		 En lista över nodnamn som ska hanteras
Exempel: [ "name1", "name2" ]		 < sträng > matris
requestId
valfritt		 Valfri unik token som tillhandahålls av användaren för att förhindra duplicerade åtgärder vid nätverkskommunikationsfel. Om detta ingår och matchar ett tidigare begärande-ID ignorerar servern den här begäran och returnerar ett 409-fel.
Exempel: "00000000-0000-0000-0000-000000000000"		 sträng

NodeManagementResult

Namn Beskrivning Schemat
noder
krävs		 En matris med information om varje nod som matchade filtret i hanteringsbegäran. Varje nods status anger om den påverkades av begäran.
Exempel: [ "object" ]		 < noder> matris
operationId
krävs		 ID:t för den här åtgärden
Exempel: "00000000-0000-0000-0000-000000000000"		 sträng

noder

Namn Beskrivning Schemat
fel
valfritt		 Om statusen är Fel innehåller detta felmeddelandet
Exempel: "This node must be terminated before it can be removed"		 sträng
ID
krävs		 ID:t för noden
Exempel: "id1"		 sträng
namn
krävs		 Namnet på noden
Exempel: "name1"		 sträng
status
valfritt		 Ett av OK eller fel
Exempel: "Error"		 uppräkning (OK, fel)

OperationStatus

Status för den här nodåtgärden

Namn Beskrivning Schemat
åtgärd
krävs		 Exempel: "string" uppräkning (skapa)
startTime
krävs		 När den här åtgärden skickades
Exempel: "2020-01-01T12:34:56Z"		 sträng (datum-tid)