Operations

Hämta klusternoder

GET /clusters/{cluster}/nodes

Parametrar

Typ	Name	Beskrivning	Schema
Sökväg	Kluster Krävs	Klustret som ska frågas	sträng
Query	Drift Valfri	Om detta anges returneras endast noderna för det här åtgärds-ID:t och innehåller åtgärdsattributet i brödtexten	sträng
Query	request_id Valfri	Om detta anges returneras endast noderna för åtgärden som identifieras av det här begärande-ID:t. och innehåller åtgärdsattributet i brödtexten	sträng

Svar

HTTP-kod	Description	Schema
200	OK	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

Http-exempelsvar

Svar 200

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

Skapa klusternoder

POST /clusters/{cluster}/nodes/create

Description

Den här åtgärden lägger till nya noder från en nodmatris i 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	Name	Beskrivning	Schema
Sökväg	cluster 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

Svar

HTTP-kod	Description	Schema
202	Har godkänts 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" ]
}

Http-exempelsvar

Svar 202

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

Frigör klusternoder

POST /clusters/{cluster}/nodes/deallocate

Description

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	Name	Beskrivning	Schema
Sökväg	cluster Krävs	Klustret för att frigöra noder i	sträng
Brödtext	Åtgärder krävs	Beskrivning av vilka noder som ska frigöras	NodeManagementRequest

Svar

HTTP-kod	Description	Schema
202	Har godkänts 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

Description

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), i så fall är det här anropet inte annorlunda än avsluta.

Parametrar

Typ	Name	Beskrivning	Schema
Sökväg	Kluster krävs	Klustret för att ta bort noder i	sträng
Brödtext	Åtgärder Krävs	Beskrivning av vilka noder som ska tas bort	NodeManagementRequest

Svar

HTTP-kod	Description	Schema
202	Har godkänts 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

Description

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

Parametrar

Typ	Name	Beskrivning	Schema
Sökväg	Kluster krävs	Klustret som ska stängas av noder i	sträng
Brödtext	Åtgärder Krävs	Beskrivning av vilka noder som ska stängas av	NodeManagementRequest

Svar

HTTP-kod	Description	Schema
202	Har godkänts 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

Description

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	Name	Beskrivning	Schema
Sökväg	Kluster krävs	Klustret som ska starta noder i	sträng
Brödtext	Åtgärder krävs	Beskrivning av vilka noder som ska startas	NodeManagementRequest

Svar

HTTP-kod	Description	Schema
202	Har godkänts 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

Description

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	Name	Beskrivning	Schema
Sökväg	cluster krävs	Klustret som ska avsluta noder i	sträng
Brödtext	Åtgärder Krävs	Beskrivning av vilka noder som ska avslutas	NodeManagementRequest

Svar

HTTP-kod	Description	Schema
202	Har godkänts 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}

Description

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 numret. Detta skalas efter antingen totala kärnor eller totala 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	Name	Beskrivning	Schema
Sökväg	cluster Krävs	Klustret för att lägga till noder i	sträng
Sökväg	nodearray krävs	Den nodearray som noderna ska läggas till i	sträng
Query	totalCoreCount Valfri	Det totala antalet kärnor som ska ha i den här nodearrayen, inklusive noder som redan har skapats	heltal
Query	totalNodeCount Valfri	Det totala antalet datorer som ska ha i den här nodearrayen, inklusive noder som redan har skapats	heltal

Svar

HTTP-kod	Description	Schema
202	Har godkänts 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

Description

Den här åtgärden innehåller information om noderna och nodearrays i ett visst kluster. För varje nodearray returneras status 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. Giltiga bucketar för en nodearray bestäms av användarens klusterdefinition, men gränserna bestäms delvis av molnleverantören.

Parametrar

Typ	Name	Beskrivning	Schema
Sökväg	Kluster krävs	Klustret som ska frågas	sträng
Query	Noder Valfri	Om det är sant returneras noder och nodreferenser i svaret	boolean

Svar

HTTP-kod	Description	Schema
200	OK	ClusterStatus

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/status

Http-exempelsvar

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

Description

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 nodmatris. Som standard returneras den aktuella månadens användningsvärde.

Parametrar

Typ	Name	Beskrivning	Schema
Sökväg	Kluster krävs	Klustret som ska returnera användningsdata för	sträng
Query	Tidsram Valfri	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 frågeparametrarna "från" och "till". Standardvärdet är MonthToDate. Alla tider anges i UTC-tid.	enum (monthToDate, lastMonth, weekToDate, custom)
Query	Från Valfri	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
Query	Att Valfri	För anpassade tidsramar är detta slutet på tidsramen i ISO-8601-format. Detta avrundas upp till närmaste timme eller dag.	sträng
Query	Granularitet Valfri	Anger hur data ska aggregeras: per timme, per dag eller som ett enda tal. Den här standardinställningen är dagligen.	enum (totalt, dagligen, varje timme)

Svar

HTTP-kod	Description	Schema
200	OK	ClusterUsage

Exempel på HTTP-begäran

Sökväg för begäran

/clusters/CLUSTER_NAME/usage

Http-exempelsvar

Svar 200

{
  "usage" : [ "object" ]
}

Listor status för åtgärder

GET /operations/

Parametrar

Typ	Name	Beskrivning	Schema
Query	request_id Valfri	Begärande-ID för åtgärden. Om detta anges har listan bara 0 eller 1 element i listan.	sträng

Svar

HTTP-kod	Description	Schema
200	OK	<OperationStatus> Array
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	Name	Beskrivning	Schema
Sökväg	id krävs	Åtgärds-ID	sträng

Svar

HTTP-kod	Description	Schema
200	OK	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

Name	Beskrivning	Schema
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> Array
Noder Valfri	En valfri lista över noder i det här klustret ingår endast om nodes=true finns i frågan Exempel : [ "[node](#node)" ]	<Nod> Array
Statligt Valfri	Aktuellt tillstånd för klustret, om det har startats minst en gång Exempel : "Starting"	sträng
targetState Valfri	Önskat tillstånd för klustret (t.ex. Startat eller avslutat) Exempel : "Started"	sträng

nodearrays

Name	Beskrivning	Schema
Hinkar Krävs	Varje bucket med allokering för den här nodearrayen. Inställningarna för antal kärnor är alltid en multipel av antalet kärnor för den här bucketen. Exempel : [ "object" ]	<Hinkar> Array
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

Hinkar

Name	Beskrivning	Schema
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 Valfri	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ängmatris >
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 Valfri	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 dess bucket egenskap. Exempel : "object"	Definition
familyConsumedCoreCount Valfri	Antalet kärnor för den här familjen som redan används i hela regionen. Exempel : 2	heltal
familyQuotaCoreCount Valfri	Antalet kärnor som kan startas för den här familjen i den här regionen. Det här är kanske inte en heltalsmultipel för quotaCount. Exempel : 16	heltal
familyQuotaCount Valfri	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	antal
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 sådana finns. Exempel : [ "object" ]	<placementGroups> Array
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 är kanske inte en heltalsmultipel för quotaCount. Exempel : 16	heltal
quotaCount krävs	Antalet totala instanser som kan startas (givet quotaCoreCount) Exempel : 4	heltal
regionalConsumedCoreCount Valfri	Antalet kärnor som redan används i hela regionen. Exempel : 2	heltal
regionalQuotaCoreCount Valfri	Antalet kärnor som kan startas i den här regionen. Det här är kanske inte ett heltalsmultipel för regionalQuotaCount. Exempel : 16	heltal
regionalQuotaCount Valfri	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	boolean
virtualMachine Krävs	Egenskaperna för de virtuella datorer som startas från den här bucketen Exempel : "object"	virtualMachine

Definition

Name	Beskrivning	Schema
machineType Krävs	Vm-storleken på den virtuella datorn Exempel : "A2"	sträng

placementGroups

Name	Beskrivning	Schema
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 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

Name	Beskrivning	Schema
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	boolean
Minne krävs	RAM-minnet i den här virtuella datorn i GB Exempel : 7.5	antal
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 Valfri	Antalet vCPU:er som den här datorn använder från kvoten Exempel : 2	heltal

ClusterUsage

Användning och valfri kostnadsinformation för klustret

Name	Beskrivning	Schema
Användning Krävs	En lista över användningar efter tidsintervall Exempel : [ "object" ]	<Användning> Array

Användning

Name	Beskrivning	Schema
Uppdelning Krävs	Uppdelningen av användningen i det här intervallet, efter kategori "node" och "nodearray" Exempel : [ "[clusterusageitem](#clusterusageitem)" ]	<ClusterUsageItem> Array
Slutet krävs	Slutet av intervallet (exklusivt) Exempel : "string"	sträng
Börja Krävs	Början av intervallet (inklusive) Exempel : "string"	sträng
Totala Krävs	Den totala användningen för det här klustret i det här intervallet, med kategorin "kluster" Exempel : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Name	Beskrivning	Schema
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"	uppräkning (kluster, nod, nodearray)
Kostnad Valfri	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	antal
Detaljer Valfri	Information om vm-storlek som används av en nodearray, inklusive timmar, core_count, regionsprioritet och operativsystem. Exempel : [ "object" ]	<Detaljer> Array
Timmar Krävs	Antalet kärntimmar för användning för den här kategorin Exempel : 0.0	antal
Nod Valfri	Namnet på noden eller nodearray som användningen är för (saknas för data på klusternivå) Exempel : "string"	sträng

Detaljer

Name	Beskrivning	Schema
core_count Valfri	Antalet kärnor i den här VM-storleken Exempel : 0.0	antal
Kostnad Valfri	Kostnaden för den här VM-storleken Exempel : 0.0	antal
Timmar Valfri	Antalet kärntimmars användning för den här VM-storleken Exempel : 0.0	antal
Os Valfri	Typ av operativsystem Exempel : "string"	uppräkning (Windows, Linux)
Prioritet Valfri	Prioritet för vm-Sku:n Exempel : "string"	uppräkning (vanlig, punkt)
Regionen Valfri	Den region som vm-storleken instansieras i Exempel : "string"	sträng
vm_size Valfri	VM SKU-storlek Exempel : "string"	sträng

Nod

En nodpost

Typ : objekt

NodeCreationRequest

Anger hur du lägger till noder i ett kluster

Name	Beskrivning	Schema
requestId Valfri	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
Uppsättningar 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" ]	<Uppsättningar> Array

Uppsättningar

Name	Beskrivning	Schema
Räkna Krävs	Antalet noder som ska skapas Exempel : 1	heltal
Definition Valfri	Definitionen av bucketen som ska användas. Detta tillhandahålls av API-anropet för klusterstatus. Om vissa av objekten som anges i statusanropet saknas eller hela bucketegenskapen saknas används den första bucketen som matchar de angivna objekten. Exempel : "object"	Definition
nameFormat Valfri	Om detta anges använder noderna den här namngivningskonventionen i stället för standardformatet "nodearray-%d" Exempel : "custom-name-%d"	sträng
nameOffset Valfri	Om detta anges, tillsammans med nameFormat, förskjuts nodeindex för nya noder. Exempel : 1	heltal
nodeAttributes Valfri	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 Valfri	Om detta anges startas noder med samma värde för groupId i samma placeringsgrupp. Exempel : "string"	sträng

Definition

Name	Beskrivning	Schema
machineType Valfri	Exempel : "A2"	sträng

NodeCreationResult

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

Uppsättningar

Name	Beskrivning	Schema
Tillade Krävs	Hur många noder som startades i den här uppsättningen Exempel : 1	heltal
meddelande Valfri	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

Name	Beskrivning	Schema
Noder Krävs	Noderna som returnerades Exempel : [ "[node](#node)" ]	<Nod> Array
Drift Valfri	Om frågan innehåller ett åtgärds-ID är det här statusen 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.

Name	Beskrivning	Schema
Filter Valfri	Ett filteruttryck som matchar noder. Observera att strängar i uttrycket måste citeras korrekt. Exempel : "State === \"Started\""	sträng
Värdnamn Valfri	En lista över korta värdnamn (utan domän) att hantera Exempel : [ "hostname1", "hostname2" ]	<strängmatris >
Id Valfri	En lista över nod-ID:t som ska hanteras Exempel : [ "id1", "id2" ]	<strängmatris >
ip_addresses Valfri	En lista över IP-adresser att hantera Exempel : [ "10.0.1.1", "10.1.1.2" ]	<strängmatris >
Namn Valfri	En lista över nodnamn att hantera Exempel : [ "name1", "name2" ]	<strängmatris >
requestId Valfri	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

Name	Beskrivning	Schema
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> Array
operationId Krävs	ID:t för den här åtgärden Exempel : "00000000-0000-0000-0000-000000000000"	sträng

Noder

Name	Beskrivning	Schema
Fel Valfri	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 för noden Exempel : "id1"	sträng
Namn krävs	Nodens namn Exempel : "name1"	sträng
Status Valfri	Ett av OK eller fel Exempel : "Error"	uppräkning (OK, fel)

OperationStatus

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

Name	Beskrivning	Schema
Åtgärder 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)