Sdílet prostřednictvím

Operace

  • Článek

Získání uzlů clusteru

GET /clusters/{cluster}/nodes

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster, který se má dotazovat řetězec
dotazu operace
volitelné		 Pokud je tato hodnota uvedena, vrátí pouze uzly pro toto ID operace a zahrne atribut operace v těle. řetězec
dotazu request_id
volitelné		 Pokud je tato hodnota zadána, vrátí pouze uzly pro operaci identifikovanou tímto ID požadavku.
a obsahuje atribut operace v těle.		 řetězec

Odpovědi

Kód HTTP Popis Schéma
200 OK NodeList
400 Neplatná specifikace Žádný obsah
404 Nenalezena Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/nodes

Příklad odpovědi HTTP

Odpověď 200

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

Vytvoření uzlů clusteru

POST /clusters/{cluster}/nodes/create

Popis

Tato operace přidá do clusteru nové uzly z uzlu. Přijímá definice více uzlů v jednom volání. Vrátí adresu URL operace, kterou lze použít ke sledování stavu operace.

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster pro přidání uzlů do řetězec
základní uzly
požadované		 Sady uzlů, které se mají vytvořit NodeCreationRequest

Odpovědi

Kód HTTP Popis Schéma
202 Přijal
hlaviček :
Location (řetězec): Adresa URL operace.		 NodeCreationResult
409 Neplatný vstup Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/nodes/create

Text požadavku

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

Příklad odpovědi HTTP

Odpověď 202

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

Zrušení přidělení uzlů clusteru

POST /clusters/{cluster}/nodes/deallocate

Popis

Tato operace uvolní uzly v clusteru. Uzly lze identifikovat několika způsoby, včetně názvu uzlu, ID uzlu nebo podle filtru.

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster pro uvolnění uzlů v řetězec
základní akce
požadované		 Popis, které uzly se mají uvolnit NodeManagementRequest

Odpovědi

Kód HTTP Popis Schéma
202 Přijal
hlaviček :
Location (řetězec): Adresa URL operace.		 NodeManagementResult
409 Neplatný vstup Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/nodes/deallocate

Text požadavku

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

Příklad odpovědi HTTP

Odpověď 202

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

Ukončení a odebrání uzlů clusteru

POST /clusters/{cluster}/nodes/remove

Popis

Tato operace odebere uzly v clusteru. Uzly lze identifikovat několika způsoby, včetně názvu uzlu, ID uzlu nebo podle filtru. Všimněte si, že ve výchozím nastavení se uzly při ukončení odeberou (pokud uzel nemá nastavenou hodnotu True), v takovém případě se toto volání neliší od ukončení.

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster pro odebrání uzlů v řetězec
základní akce
požadované		 Popis, které uzly se mají odebrat NodeManagementRequest

Odpovědi

Kód HTTP Popis Schéma
202 Přijal
hlaviček :
Location (řetězec): Adresa URL operace.		 NodeManagementResult
409 Neplatný vstup Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/nodes/remove

Text požadavku

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

Příklad odpovědi HTTP

Odpověď 202

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

Ukončení nebo zrušení přidělení uzlů clusteru

POST /clusters/{cluster}/nodes/shutdown

Popis

Tato operace ukončí nebo uvolní uzly v clusteru v závislosti na tom, jestli je atribut ShutdownPolicy na každém uzlu Terminate (výchozí) nebo Deallocate( v uvedeném pořadí).

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster pro vypnutí uzlů v řetězec
základní akce
požadované		 Popis, které uzly se mají vypnout NodeManagementRequest

Odpovědi

Kód HTTP Popis Schéma
202 Přijal
hlaviček :
Location (řetězec): Adresa URL operace.		 NodeManagementResult
409 Neplatný vstup Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/nodes/shutdown

Text požadavku

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

Příklad odpovědi HTTP

Odpověď 202

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

Spuštění uvolněných nebo ukončených uzlů clusteru

POST /clusters/{cluster}/nodes/start

Popis

Tato operace spouští uzly v clusteru. Uzly lze identifikovat několika způsoby, včetně názvu uzlu, ID uzlu nebo podle filtru.

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster ke spuštění uzlů v řetězec
základní akce
požadované		 Popis, které uzly se mají spustit NodeManagementRequest

Odpovědi

Kód HTTP Popis Schéma
202 Přijal
hlaviček :
Location (řetězec): Adresa URL operace.		 NodeManagementResult
409 Neplatný vstup Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/nodes/start

Text požadavku

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

Příklad odpovědi HTTP

Odpověď 202

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

Ukončení uzlů clusteru

POST /clusters/{cluster}/nodes/terminate

Popis

Tato operace ukončí uzly v clusteru. Uzly lze identifikovat několika způsoby, včetně názvu uzlu, ID uzlu nebo podle filtru.

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster pro ukončení uzlů v řetězec
základní akce
požadované		 Popis, které uzly se mají ukončit NodeManagementRequest

Odpovědi

Kód HTTP Popis Schéma
202 Přijal
hlaviček :
Location (řetězec): Adresa URL operace.		 NodeManagementResult
409 Neplatný vstup Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/nodes/terminate

Text požadavku

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

Příklad odpovědi HTTP

Odpověď 202

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

Škálování clusteru podle velikosti

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

Popis

Tato operace přidá uzly podle potřeby do nodearray, aby dosáhla celkového počtu. Požadavek se zpracuje jednou a později nepřidá uzly, aby se zachovalo dané číslo. To se škáluje buď celkovými jádry, nebo celkovými uzly, ale ne oboje. Vrátí adresu URL operace, kterou lze použít ke sledování stavu operace.

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster pro přidání uzlů do řetězec
cesta nodearray
požadované		 Nodearray pro přidání uzlů do řetězec
dotazu totalCoreCount
volitelné		 Celkový počet jader, která mají být v tomto uzlu, včetně již vytvořených uzlů celé číslo
dotazu totalNodeCount
volitelné		 Celkový počet počítačů,kteréch celé číslo

Odpovědi

Kód HTTP Popis Schéma
202 Přijal
hlaviček :
Location (řetězec): Adresa URL operace.		 NodeCreationResult
409 Neplatný vstup Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Příklad odpovědi HTTP

Odpověď 202

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

Získání stavu clusteru

GET /clusters/{cluster}/status

Popis

Tato operace obsahuje informace o uzlech a uzlech v daném clusteru. U každého uzlu vrátí stav každého kontejneru přidělení, který je možné použít, například počet uzlů v kontejneru, kolik dalších je možné přidat atd. Každý kbelík je sada možných virtuálních počítačů daného hardwarového profilu, které je možné vytvořit v daném umístění, pod daným účtem zákazníka atd. Platné kontejnery pro nodearray jsou určeny definicí clusteru uživatele, ale omezení jsou částečně určena poskytovatelem cloudu.

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster, který se má dotazovat řetězec
dotazu uzly
volitelné		 Pokud je hodnota true, vrátí se v odpovědi odkazy na uzly a uzly. booleovský

Odpovědi

Kód HTTP Popis Schéma
200 OK ClusterStatus

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/status

Příklad odpovědi HTTP

Odpověď 200

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

Získání informací o využití a volitelných nákladech pro cluster

GET /clusters/{cluster}/usage

Popis

Tato operace vrátí data o celkovém využití (hodiny jádra) a data nákladů, pokud jsou k dispozici, pro cluster a také rozpis jednotlivých uzlů. Ve výchozím nastavení vrátí hodnotu využití aktuálního měsíce.

Parametry

Typ Jméno Popis Schéma
cesta clusteru
požadované		 Cluster pro vrácení dat o využití pro řetězec
dotazu časový rámec
volitelné		 Pokud je zadáno, určuje časový rozsah, který se má použít pro dotaz. MonthToDate vrátí využití pro aktuální měsíc a funkce lastMonth vrátí využití za předchozí měsíc. Funkce weekToDate vrátí využití pro aktuální týden (od neděle). Vlastní vyžaduje parametry dotazu "from" a 'to'. Výchozí hodnota je MonthToDate. Všechny časy jsou ve standardu UTC. enum (monthToDate, lastMonth, weekToDate, custom)
dotazu z
volitelné		 U vlastních časových rámců je to začátek časového rámce ve formátu ISO-8601. Zaokrouhlí se dolů na nejbližší hodinu nebo den. řetězec
dotazu na
volitelné		 Pro vlastní časové rámce je to konec časového rámce ve formátu ISO-8601. Zaokrouhlí se nahoru na nejbližší hodinu nebo den. řetězec
dotazu členitosti
volitelné		 Určuje, jak agregovat data: podle hodin, podle denního nebo jednoho čísla. Toto výchozí nastavení je denní. enum (celkem, denně, hodinově)

Odpovědi

Kód HTTP Popis Schéma
200 OK clusteru

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/usage

Příklad odpovědi HTTP

Odpověď 200

{
  "usage" : [ "object" ]
}

Vypíše stav operací.

GET /operations/

Parametry

Typ Jméno Popis Schéma
dotazu request_id
volitelné		 ID požadavku pro operaci. Pokud je tento seznam zadaný, bude mít v něm pouze 0 nebo 1 prvek. řetězec

Odpovědi

Kód HTTP Popis Schéma
200 OK pole <OperationStatus>
400 Neplatný požadavek Žádný obsah
404 Nenalezena Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

/operations/

Příklad odpovědi HTTP

Odpověď 200

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

Získá stav operace podle ID.

GET /operations/{id}

Parametry

Typ Jméno Popis Schéma
cesta id
požadované		 ID operace řetězec

Odpovědi

Kód HTTP Popis Schéma
200 OK OperationStatus
404 Nenalezena Žádný obsah

Příklad požadavku HTTP

Cesta požadavku

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

Příklad odpovědi HTTP

Odpověď 200

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

Prostředky

ClusterStatus

Stav clusteru

Jméno Popis Schéma
maxCoreCount
požadované		 Maximální počet jader, která se můžou přidat do tohoto clusteru
příklad : 16		 celé číslo
maxCount
požadované		 Maximální počet uzlů, které mohou být přidány do tohoto clusteru
příklad : 4		 celé číslo
nodearrays
požadované		 příklad : [ "object" ] < pole nodearrays>
uzly
volitelné		 Volitelný seznam uzlů v tomto clusteru, zahrnutý pouze v případě, že je nodes=true v dotazu.
příklad : [ "[node](#node)" ]		 pole uzlu
stavu
volitelné		 Aktuální stav clusteru, pokud byl spuštěn alespoň jednou
příklad : "Starting"		 řetězec
targetState
volitelné		 Požadovaný stav clusteru (např. Spuštěno nebo Ukončeno)
příklad : "Started"		 řetězec

nodearrays

Jméno Popis Schéma
kontejnery
požadované		 Každý kontejner přidělení pro tento nodearray. Nastavení počtu jader je vždy násobkem počtu jader pro tento kbelík.
příklad : [ "object" ]		 < kbelíky> pole
maxCoreCount
požadované		 Maximální počet jader, která mohou být v tomto uzlu
příklad : 16		 celé číslo
maxCount
požadované		 Maximální početuzlůch
příklad : 4		 celé číslo
název
požadované		 Nodearray, který popisuje
příklad : "execute"		 řetězec
nodearray
požadované		 Atributy tohoto uzlu
příklad : "[node](#node)"		 node

kontejnery

Jméno Popis Schéma
activeCoreCount
požadované		 Počet jader, která se používají pro tento kbelík, v tomto uzlu
příklad : 40		 celé číslo
activeCount
požadované		 Počet uzlů, které se používají pro tento kbelík, v tomto uzlu. To zahrnuje uzly, které stále získávají virtuální počítač.
příklad : 10		 celé číslo
activeNodes
volitelné		 Názvy uzlů používané pro tento kbelík v tomto uzlu. To zahrnuje uzly, které stále získávají virtuální počítač. To je zahrnuto pouze v případě, že nodes=true je v dotazu.
příklad : [ "string" ]		 pole > řetězce <
availableCoreCount
požadované		 Kolik dalších jader může být v tomto kontejneru vytvořeno, v tomto uzlu. Vždy několik dostupnýchcount.
příklad : 8		 celé číslo
availableCount
požadované		 Kolik dalších uzlů může být v tomto kontejneru vytvořeno, v tomto uzlu. Všimněte si, že to může být menší než implicitní hodnota maxCount a usedCount, protože maxCount může být globálně omezený.
příklad : 2		 celé číslo
bucketId
požadované		 Identifikátor pro tento kbelík. To bude mít vždy stejnou hodnotu pro daný kbelík v nodearray, pokud cluster není odstraněn.
příklad : "00000000-0000-0000-0000-000000000000"		 řetězec
consumedCoreCount
požadované		 Počet jader pro tuto rodinu, která se už používají v celé oblasti.
příklad : 2		 celé číslo
definice
volitelné		 Vlastnosti tohoto kontejneru, které slouží k vytváření uzlů z tohoto kontejneru. Rozhraní API pro vytváření uzlů přebírá tuto definici ve své vlastnosti bucket.
příklad : "object"		 definice
familyConsumedCoreCount
volitelné		 Počet jader pro tuto rodinu, která se už používají v celé oblasti.
příklad : 2		 celé číslo
familyQuotaCoreCount
volitelné		 Počet celkového počtu jader, která lze pro tuto rodinu v této oblasti zahájit. Nemusí to být celé číslo násobku kvótyCount.
příklad : 16		 celé číslo
familyQuotaCount
volitelné		 Celkový počet instancí, které lze spustit (dané familyQuotaCoreCount)
příklad : 4		 celé číslo
invalidReason
požadované		 Pokud je platná hodnota false, bude obsahovat důvod, proč je kontejner neplatný. V současné době NotActivated a DisabledMachineType jsou jedinými důvody.
příklad : "DisabledMachineType"		 řetězec
lastCapacityFailure
požadované		 Jak dlouho v sekundách od posledního selhání této sady došlo k selhání kapacity. Jakákoli záporná hodnota se považuje za nikdy.
příklad : 180.0		 číslo
maxCoreCount
požadované		 Maximální počet jader, která mohou být v tomto kbelíku, včetně globálních limitů a limitů nodearray. Vždy násobek maximálního počtu.
příklad : 16		 celé číslo
maxCount
požadované		 Maximální počet uzlů, které mohou být v tomto kontejneru, včetně globálních limitů a limitů nodearray
příklad : 4		 celé číslo
maxPlacementGroupCoreSize
požadované		 Maximální celkový počet jader, která mohou být ve skupině umístění v tomto kontejneru. Vždy násobek maxPlacementGroupSize.
příklad : 64		 celé číslo
maxPlacementGroupSize
požadované		 Maximální celkový počet instancí, které mohou být ve skupině umístění v tomto kontejneru
příklad : 16		 celé číslo
placementGroups
požadované		 Skupiny umístění používané pro tento uzelarray, pokud existuje.
příklad : [ "object" ]		 pole <placementGroups>
quotaCoreCount
požadované		 Počet celkového počtu jader, která je možné pro tuto rodinu v této oblasti zahájit, s přihlédnutím k počtu jader v jednotlivých oblastech. Nemusí to být celé číslo násobku kvótyCount.
příklad : 16		 celé číslo
quotaCount
požadované		 Celkový počet instancí, které je možné spustit (dané kvótěCoreCount)
příklad : 4		 celé číslo
regionalConsumedCoreCount
volitelné		 Počet jader, která se už používají v celé oblasti.
příklad : 2		 celé číslo
regionalQuotaCoreCount
volitelné		 Počet celkového počtu jader, která lze v této oblasti spustit. Nemusí to být celé číslo násobku regionalQuotaCount.
příklad : 16		 celé číslo
regionalQuotaCount
volitelné		 Počet instancí, které lze spustit (dané regionalQuotaCoreCount)
příklad : 4		 celé číslo
platné
požadované		 Pokud je hodnota true, představuje tento kontejner aktuálně platný kontejner, který se má použít pro nové uzly. Pokud je false, představuje tento kbelík pouze existující uzly.
příklad : true		 booleovský
virtualMachine
požadované		 Vlastnosti virtuálních počítačů spuštěných z tohoto kontejneru
příklad : "object"		 virtualMachine

definice

Jméno Popis Schéma
machineType
požadované		 Velikost virtuálního počítače virtuálního počítače
příklad : "A2"		 řetězec

placementGroups

Jméno Popis Schéma
activeCoreCount
požadované		 Kolik jader je v této škálovací sadě
příklad : 16		 celé číslo
activeCount
požadované		 Kolik uzlů je v této škálovací sadě
příklad : 4		 celé číslo
název
požadované		 Jedinečný identifikátor této skupiny umístění
příklad : "my-placement-group"		 řetězec

virtualMachine

Jméno Popis Schéma
gpuCount
požadované		 Počet GPU, které tento typ počítače obsahuje
příklad : 2		 celé číslo
infiniband
požadované		 Pokud tento virtuální počítač podporuje připojení InfiniBand
příklad : true		 booleovský
paměti
požadované		 Paměť RAM v tomto virtuálním počítači v GB
příklad : 7.5		 číslo
pcpuCount
požadované		 Počet fyzických procesorů, které má tento typ počítače
příklad : 16		 celé číslo
vcpuCount
požadované		 Počet virtuálních procesorů, které tento typ počítače obsahuje
příklad : 32		 celé číslo
vcpuQuotaCount
volitelné		 Počet virtuálních procesorů, které tento počítač používá z kvóty
příklad : 2		 celé číslo

ClusterUsage

Informace o využití a volitelných nákladech pro cluster

Jméno Popis Schéma
využití
požadované		 Seznam využití podle časového intervalu
příklad : [ "object" ]		 pole <využití>

využití

Jméno Popis Schéma
rozpisu
požadované		 Rozpis využití v tomto intervalu podle kategorie "node" a "nodearray"
příklad : [ "[clusterusageitem](#clusterusageitem)" ]		 < pole ClusterUsageItem>
koncová
požadované		 Konec intervalu (výhradní)
příklad : "string"		 řetězec
spuštění
požadované		 Začátek intervalu (včetně)
příklad : "string"		 řetězec
celkem
požadované		 Celkové využití tohoto clusteru v tomto intervalu s kategorií clusteru
příklad : "[clusterusageitem](#clusterusageitem)"		 clusterUsageItem

ClusterUsageItem

Jméno Popis Schéma
kategorie
požadované		 "cluster" pro celkové využití; "uzel" pro jeden hlavní uzel bez pole; "nodearray" pro celý uzelarray
příklad : "string"		 enum (cluster, node, nodearray)
náklady
volitelné		 Částka, která se bude účtovat za toto využití, v amerických dolarech a maloobchodních sazbách. Poznámka: Všechny částky nákladů jsou odhady a nerelektují skutečnou fakturu.
příklad : 0.0		 číslo
podrobností
volitelné		 Podrobnosti o velikosti virtuálního počítače používané polem nodearray, včetně hodin, core_count, priority oblastí a operačního systému
příklad : [ "object" ]		 < podrobnosti> pole
hodin
požadované		 Počet hodin využití jádra pro tuto kategorii
příklad : 0.0		 číslo
uzlu
volitelné		 Název uzlu nebo nodearray, pro který se používá (chybí pro data na úrovni clusteru)
příklad : "string"		 řetězec

podrobností

Jméno Popis Schéma
core_count
volitelné		 Počet jader v této velikosti virtuálního počítače
příklad : 0.0		 číslo
náklady
volitelné		 Náklady na tuto velikost virtuálního počítače
příklad : 0.0		 číslo
hodin
volitelné		 Počet hodin využití jádra pro tuto velikost virtuálního počítače
příklad : 0.0		 číslo
os
volitelné		 Typ operačního systému
příklad : "string"		 enum (Windows, Linux)
priority
volitelné		 Priorita skladové položky virtuálního počítače
příklad : "string"		 enum (regular, spot)
oblasti
volitelné		 Oblast, ve které se vytvoří instance virtuálního počítače
příklad : "string"		 řetězec
vm_size
volitelné		 Velikost skladové položky virtuálního počítače
příklad : "string"		 řetězec

Uzel

Záznam uzlu

Typ: objekt

NodeCreationRequest

Určuje, jak přidat uzly do clusteru.

Jméno Popis Schéma
id požadavku
volitelné		 Volitelný jedinečný token zadaný uživatelem, aby se zabránilo duplicitním operacím v případě chyb síťové komunikace. Pokud je tento požadavek zahrnutý a odpovídá id dřívějšího požadavku, server tento požadavek ignoruje a vrátí chybu 409.
příklad : "00000000-0000-0000-0000-000000000000"		 řetězec
sady
požadované		 Seznam definic uzlů, které se mají vytvořit. Požadavek musí obsahovat aspoň jednu sadu. Každá sada může zadat jinou sadu vlastností.
příklad : [ "object" ]		 < nastaví pole>

sady

Jméno Popis Schéma
počet
požadované		 Počet uzlů, které se mají vytvořit
příklad : 1		 celé číslo
definice
volitelné		 Definice kontejneru, který se má použít. Toto je poskytováno voláním rozhraní API stavu clusteru. Pokud některé položky zadané ve stavovém volání chybí nebo chybí celá vlastnost kontejneru, použije se první kbelík, který odpovídá daným položkám.
příklad : "object"		 definice
nameFormat
volitelné		 V případě potřeby budou uzly místo standardního formátu nodearray-%dpoužívat tuto konvenci pojmenování.
příklad : "custom-name-%d"		 řetězec
nameOffset
volitelné		 Pokud je uvedeno, společně s nameFormat posuny nodeindex pro nové uzly.
příklad : 1		 celé číslo
nodeAttributes
volitelné		 Další atributy, které se mají nastavit na každém uzlu z této sady
příklad : "[node](#node)"		 node
nodearray
požadované		 Název nodearray pro spuštění uzlů z
příklad : "execute"		 řetězec
placementGroupId
volitelné		 Pokud je tato hodnota zadaná, všechny uzly se stejnou hodnotou groupId se spustí ve stejné skupině umístění.
příklad : "string"		 řetězec

definice

Jméno Popis Schéma
machineType
volitelné		 příklad : "A2" řetězec

NodeCreationResult

Jméno Popis Schéma
operationId
požadované		 ID této operace
příklad : "00000000-0000-0000-0000-000000000000"		 řetězec
sady
požadované		 Pole sad ve stejném pořadí jako v požadavku
příklad : [ "object" ]		 < nastaví pole>

sady

Jméno Popis Schéma
přidáno
požadované		 Kolik uzlů bylo v této sadě spuštěno
příklad : 1		 celé číslo
zprávy
volitelné		 Označuje, proč nelze přidat všechny požadované uzly, pokud jsou k dispozici.
příklad : "string"		 řetězec

NodeList

Výsledky hledání uzlů

Jméno Popis Schéma
uzly
požadované		 Vrácené uzly
příklad : [ "[node](#node)" ]		 pole uzlu
operace
volitelné		 Pokud dotaz obsahuje ID operace, jedná se o stav této operace.
příklad : "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

Určuje, jak provádět akce na uzlech v clusteru. Existuje několik způsobů, jak určit uzly a pokud je zahrnutých více než jeden způsob, považuje se za sjednocení.

Jméno Popis Schéma
filtru
volitelné		 Výraz filtru, který odpovídá uzlům. Všimněte si, že řetězce ve výrazu musí být správně citovány.
příklad : "State === \"Started\""		 řetězec
názvy hostitelů
volitelné		 Seznam krátkých názvů hostitelů (bez domény) pro správu
příklad : [ "hostname1", "hostname2" ]		 pole > řetězce <
id
volitelné		 Seznam ID uzlů pro správu
příklad : [ "id1", "id2" ]		 pole > řetězce <
ip_addresses
volitelné		 Seznam IP adres pro správu
příklad : [ "10.0.1.1", "10.1.1.2" ]		 pole > řetězce <
názvů
volitelné		 Seznam názvů uzlů pro správu
příklad : [ "name1", "name2" ]		 pole > řetězce <
id požadavku
volitelné		 Volitelný jedinečný token zadaný uživatelem, aby se zabránilo duplicitním operacím v případě chyb síťové komunikace. Pokud je tento požadavek zahrnutý a odpovídá id dřívějšího požadavku, server tento požadavek ignoruje a vrátí chybu 409.
příklad : "00000000-0000-0000-0000-000000000000"		 řetězec

NodeManagementResult

Jméno Popis Schéma
uzly
požadované		 Pole informací o každém uzlu, který odpovídá filtru v žádosti o správu. Stav každého uzlu označuje, jestli byl ovlivněn požadavkem.
příklad : [ "object" ]		 < uzly> pole
operationId
požadované		 ID této operace
příklad : "00000000-0000-0000-0000-000000000000"		 řetězec

uzly

Jméno Popis Schéma
chyba
volitelné		 Pokud je stav Chyba, obsahuje chybovou zprávu.
příklad : "This node must be terminated before it can be removed"		 řetězec
id
požadované		 ID uzlu
příklad : "id1"		 řetězec
název
požadované		 Název uzlu
příklad : "name1"		 řetězec
stavu
volitelné		 Jedna z ok nebo chyb
příklad : "Error"		 výčet (OK, chyba)

OperationStatus

Stav této operace uzlu

Jméno Popis Schéma
akce
požadované		 příklad : "string" enum (create)
startTime
požadované		 Po odeslání této operace
příklad : "2020-01-01T12:34:56Z"		 řetězec (datum a čas)