Operace

Získání uzlů clusteru

GET /clusters/{cluster}/nodes

Parametry

Typ	Název	Description	Schéma
Cesta	cluster Požadované	Cluster, na který se má dotazovat	řetězec
Dotaz	Operace Volitelné	Pokud je dané, vrátí pouze uzly pro toto ID operace a zahrne atribut operace v těle.	řetězec
Dotaz	request_id Volitelné	Pokud je zadáno, vrátí pouze uzly pro operaci identifikované tímto ID požadavku. a obsahuje atribut operace v těle.	řetězec

Odpovědi

Kód HTTP	Description	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"
  }
}

Vytváření uzlů clusteru

POST /clusters/{cluster}/nodes/create

Description

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

Parametry

Typ	Název	Description	Schéma
Cesta	cluster vyžadováno	Cluster, do který chcete přidat uzly	řetězec
Text	Uzly vyžadováno	Sady uzlů, které se mají vytvořit	NodeCreationRequest

Odpovědi

Kód HTTP	Description	Schéma
202	Přijato Hlavičky : Location (string) : 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" ]
}

Uvolnění uzlů clusteru

POST /clusters/{cluster}/nodes/deallocate

Description

Tato operace zruší přidělení uzlů v clusteru. Uzly je možné identifikovat několika způsoby, včetně názvu uzlu, ID uzlu nebo podle filtru.

Parametry

Typ	Název	Description	Schéma
Cesta	cluster vyžadováno	Cluster pro uvolnění uzlů v	řetězec
Text	Akce Požadované	Popis uzlů, které se mají uvolnit	NodeManagementRequest

Odpovědi

Kód HTTP	Description	Schéma
202	Přijato Hlavičky : Location (string) : 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

Description

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

Parametry

Typ	Název	Description	Schéma
Cesta	cluster vyžadováno	Cluster, ve který se mají odebrat uzly	řetězec
Text	Akce vyžadováno	Popis uzlů, které se mají odebrat	NodeManagementRequest

Odpovědi

Kód HTTP	Description	Schéma
202	Přijato Hlavičky : Location (string) : 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

Description

Tato operace ukončí nebo zruší přidělení uzlů v clusteru v závislosti na tom, jestli atribut ShutdownPolicy na každém uzlu je Terminate (výchozí nastavení) nebo Deallocate (Zrušit přidělení).

Parametry

Typ	Název	Description	Schéma
Cesta	cluster vyžadováno	Cluster pro vypnutí uzlů v	řetězec
Text	Akce vyžadováno	Popis uzlů, které se mají vypnout	NodeManagementRequest

Odpovědi

Kód HTTP	Description	Schéma
202	Přijato Hlavičky : Location (string) : 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

Description

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

Parametry

Typ	Název	Description	Schéma
Cesta	cluster vyžadováno	Cluster, ve který se mají spouštět uzly	řetězec
Text	Akce vyžadováno	Popis uzlů, které se mají spustit	NodeManagementRequest

Odpovědi

Kód HTTP	Description	Schéma
202	Přijato Hlavičky : Location (string) : 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

Description

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

Parametry

Typ	Název	Description	Schéma
Cesta	cluster Požadované	Cluster pro ukončení uzlů v	řetězec
Text	Akce vyžadováno	Popis uzlů, které se mají ukončit	NodeManagementRequest

Odpovědi

Kód HTTP	Description	Schéma
202	Přijato Hlavičky : Location (string) : 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}

Description

Tato operace přidá uzly podle potřeby do pole uzlu, aby se dosáhlo celkového počtu. Požadavek se zpracuje jednou a později znovu nepřidá uzly, aby se zachovalo dané číslo. Škáluje se buď podle celkového počtu jader, nebo celkového počtu uzlů, ale ne podle obou. Vrátí adresu URL operace, kterou lze použít ke sledování stavu operace.

Parametry

Typ	Název	Description	Schéma
Cesta	cluster vyžadováno	Cluster, do který chcete přidat uzly	řetězec
Cesta	nodearray vyžadováno	Pole uzlu, do které se mají přidat uzly	řetězec
Dotaz	totalCoreCount Volitelné	Celkový počet jader, která se mají mít v tomto uzluarray, včetně již vytvořených uzlů	integer
Dotaz	totalNodeCount Volitelné	Celkový počet počítačů, které mají mít v tomto uzluarray, včetně již vytvořených uzlů	integer

Odpovědi

Kód HTTP	Description	Schéma
202	Přijato Hlavičky : Location (string) : 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

Description

Tato operace obsahuje informace o uzlech a polích uzlů v daném clusteru. Pro každé pole uzlu vrátí stav každého kontejneru přidělení, který je možné použít, například kolik uzlů je 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 zákaznickým účtem atd. Platné kontejnery pro nodearray jsou určeny definicí clusteru uživatele, ale omezení určuje částečně poskytovatel cloudu.

Parametry

Typ	Název	Description	Schéma
Cesta	cluster vyžadováno	Cluster, který se má dotazovat	řetězec
Dotaz	Uzly Volitelné	Pokud je true, vrátí se v odpovědi odkazy na uzly a uzly.	boolean

Odpovědi

Kód HTTP	Description	Schéma
200	OK	Stav clusteru

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 na cluster

GET /clusters/{cluster}/usage

Description

Tato operace vrátí data o celkovém využití (počet hodin jádra) a údaje o nákladech, pokud jsou k dispozici, pro cluster a také rozpis podle uzlů. Ve výchozím nastavení vrátí využití za aktuální měsíc.

Parametry

Typ	Název	Description	Schéma
Cesta	cluster Požadované	Cluster, pro který se mají vracet data o využití	řetězec
Dotaz	Časový rámec Volitelné	Pokud je zadaný, určuje časový rozsah, který se má pro dotaz použít. monthToDate vrátí využití pro aktuální měsíc a lastMonth vrátí využití za předchozí měsíc. WeekToDate vrátí využití pro aktuální týden (počínaje neděli). Vlastní vyžaduje parametry dotazu from a to. Výchozí hodnota je MonthToDate. Všechny časy jsou v UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Dotaz	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
Dotaz	na Volitelné	U vlastních časových rámců je to konec časového rámce ve formátu ISO-8601. Zaokrouhlí se nahoru na nejbližší hodinu nebo den.	řetězec
Dotaz	Rozlišovací schopnost Volitelné	Určuje, jak se mají agregovat data: podle hodin, podle denních dat nebo jako jedno číslo. Tato výchozí hodnota je denně.	výčet (celkem, denně, hodinově)

Odpovědi

Kód HTTP	Description	Schéma
200	OK	ClusterUsage

Příklad požadavku HTTP

Cesta požadavku

/clusters/CLUSTER_NAME/usage

Příklad odpovědi HTTP

Odpověď 200

{
  "usage" : [ "object" ]
}

Seznamy stav operací

GET /operations/

Parametry

Typ	Název	Description	Schéma
Dotaz	request_id Volitelné	ID požadavku pro operaci. Pokud je tato možnost zadána, bude seznam obsahovat pouze 0 nebo 1 prvek.	řetězec

Odpovědi

Kód HTTP	Description	Schéma
200	OK	<OperationStatus> Pole
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	Název	Description	Schéma
Cesta	id Požadované	ID operace	řetězec

Odpovědi

Kód HTTP	Description	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"
}

Zdroje informací

ClusterStatus

Stav clusteru

Název	Description	Schéma
maxCoreCount vyžadováno	Maximální počet jader, která je možné přidat do tohoto clusteru Příklad : 16	integer
maxCount vyžadováno	Maximální počet uzlů, které lze přidat do tohoto clusteru Příklad : 4	integer
nodearrays vyžadováno	Příklad : [ "object" ]	<nodearrays> Pole
Uzly Volitelné	Volitelný seznam uzlů v tomto clusteru, který je zahrnutý pouze v případě, že je v dotazu nodes=true Příklad : [ "[node](#node)" ]	<Uzel> Pole
Státu Volitelné	Aktuální stav clusteru, pokud byl aspoň jednou spuštěn Příklad : "Starting"	řetězec
targetState Volitelné	Požadovaný stav clusteru (např. Spuštěno nebo Ukončeno) Příklad : "Started"	řetězec

nodearrays

Název	Description	Schéma
Kbelíky vyžadováno	Každý kbelík přidělení pro tento uzelarray. Nastavení počtu jader je vždy násobek počtu jader pro tento kbelík. Příklad : [ "object" ]	<Kbelíky> Pole
maxCoreCount Požadované	Maximální počet jader, která můžou být v tomto uzluarray Příklad : 16	integer
maxCount vyžadováno	Maximální počet uzlů, které mohou být v tomto uzluarray Příklad : 4	integer
Jméno vyžadováno	Pole uzlu, které popisuje Příklad : "execute"	řetězec
nodearray vyžadováno	Atributy tohoto uzluarray Příklad : "[node](#node)"	Node

Kbelíky

Název	Description	Schéma
activeCoreCount Požadované	Počet jader, která se používají v tomto kontejneru nodearray Příklad : 40	integer
activeCount Požadované	Počet uzlů, které se používají pro tento kontejner, v tomto poli uzlu. To zahrnuje uzly, které stále získávají virtuální počítač. Příklad : 10	integer
activeNodes Volitelné	Názvy uzlů, které se používají pro tento kontejner, v tomto nodearray. To zahrnuje uzly, které stále získávají virtuální počítač. To se zahrne jenom v případě, že je v dotazu nodes=true. Příklad : [ "string" ]	<pole řetězců >
availableCoreCount Požadované	Kolik dalších jader může být vytvořeno v tomto kontejneru, v tomto nodearray. Vždy násobek availableCount. Příklad : 8	integer
availableCount vyžadováno	Kolik dalších uzlů může být vytvořeno v tomto kontejneru, v tomto nodearray. Mějte na paměti, že tato hodnota může být menší než hodnota maxCount a usedCount, protože hodnota maxCount může být globálně omezená. Příklad : 2	integer
id kbelíku vyžadováno	Identifikátor tohoto kbelíku. Tato hodnota bude mít vždy stejnou hodnotu pro daný kbelík ve službě nodearray, pokud se cluster neodstraní. Příklad : "00000000-0000-0000-0000-000000000000"	řetězec
consumedCoreCount vyžadováno	Počet jader pro tuto řadu, která se už používají v celé oblasti. Příklad : 2	integer
Definice Volitelné	Vlastnosti tohoto kontejneru, které se používají k vytvoření uzlů z tohoto kontejneru. Rozhraní API pro vytváření uzlů přebírá tuto definici ve své bucket vlastnosti. Příklad : "object"	Definice
familyConsumedCoreCount Volitelné	Počet jader pro tuto řadu, která se už používají v celé oblasti. Příklad : 2	integer
familyQuotaCoreCount Volitelné	Celkový počet jader, která se dají pro tuto rodinu v této oblasti spustit. Nemusí se jednat o celočíselný násobek quotaCount. Příklad : 16	integer
familyQuotaCount Volitelné	Celkový počet instancí, které je možné spustit (vzhledem k hodnotě familyQuotaCoreCount) Příklad : 4	integer
invalidReason vyžadováno	Pokud je hodnota valid false, bude obsahovat důvod, proč je kontejner neplatný. V současné době jsou jedinými důvody NotActivated a DisabledMachineType. Příklad : "DisabledMachineType"	řetězec
lastCapacityFailure Požadované	Jak dlouho (v sekundách) od posledního selhání kapacity v tomto kbelíku. Jakákoli záporná hodnota se považuje za nikdy. Příklad : 180.0	číslo
maxCoreCount Požadované	Maximální počet jader, která můžou být v tomto kbelíku, včetně globálních limitů a omezení nodearray. Vždy násobek hodnoty maxCount. Příklad : 16	integer
maxCount vyžadováno	Maximální počet uzlů, které se můžou nacházet v tomto kbelíku, včetně globálních limitů a omezení nodearray Příklad : 4	integer
maxPlacementGroupCoreSize vyžadováno	Maximální celkový počet jader, která mohou být ve skupině umístění v tomto kbelíku. Vždy násobek maxPlacementGroupSize. Příklad : 64	integer
maxPlacementGroupSize vyžadováno	Maximální celkový počet instancí, které mohou být ve skupině umístění v tomto kbelíku Příklad : 16	integer
placementGroups vyžadováno	Skupiny umístění používané pro tento uzelarray, pokud existuje. Příklad : [ "object" ]	<placementGroups> Pole
quotaCoreCount vyžadováno	Celkový počet jader, která je možné pro tuto řadu v této oblasti zahájit, a také s ohledem na počet jader v oblasti kvót. Nemusí se jednat o celočíselný násobek quotaCount. Příklad : 16	integer
quotaCount Požadované	Celkový počet instancí, které je možné spustit (vzhledem k hodnotě quotaCoreCount) Příklad : 4	integer
regionalConsumedCoreCount Volitelné	Počet jader, která se už používají v celé oblasti. Příklad : 2	integer
regionalQuotaCoreCount Volitelné	Celkový počet jader, která je možné v této oblasti spustit. Nemusí se jednat o celočíselný násobek regionalQuotaCount. Příklad : 16	integer
regionalQuotaCount Volitelné	Celkový počet instancí, které je možné spustit (s ohledem na regionalQuotaCoreCount) Příklad : 4	integer
Platný vyžadováno	Pokud je hodnota true, představuje tento kbelík 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	boolean
virtuální počítač Požadované	Vlastnosti virtuálních počítačů spuštěných z tohoto kontejneru Příklad : "object"	virtualMachine

Definice

Název	Description	Schéma
machineType vyžadováno	Velikost virtuálního počítače virtuálního počítače Příklad : "A2"	řetězec

placementGroups

Název	Description	Schéma
activeCoreCount Požadované	Kolik jader je v této škálovací sadě? Příklad : 16	integer
activeCount vyžadováno	Kolik uzlů je v této škálovací sadě Příklad : 4	integer
Jméno Požadované	Jedinečný identifikátor této skupiny umístění Příklad : "my-placement-group"	řetězec

virtualMachine

Název	Description	Schéma
gpuCount vyžadováno	Počet grafických procesorů tohoto typu počítače Příklad : 2	integer
infiniband Požadované	Pokud tento virtuální počítač podporuje připojení InfiniBand Příklad : true	boolean
Paměti vyžadováno	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ů tohoto typu počítače Příklad : 16	integer
vcpuCount vyžadováno	Počet virtuálních procesorů tohoto typu počítače Příklad : 32	integer
vcpuQuotaCount Volitelné	Počet virtuálních procesorů, které tento počítač používá z kvóty Příklad : 2	integer

ClusterUsage

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

Název	Description	Schéma
Použití Požadované	Seznam využití podle časového intervalu Příklad : [ "object" ]	<Použití> Pole

Použití

Název	Description	Schéma
Členění vyžadováno	Rozpis využití v tomto intervalu podle kategorií "node" a "nodearray" Příklad : [ "[clusterusageitem](#clusterusageitem)" ]	<ClusterUsageItem> Pole
Konec Požadované	Konec intervalu (výhradní) Příklad : "string"	řetězec
Spustit 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í "cluster" Příklad : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Název	Description	Schéma
Kategorie vyžadováno	"cluster" pro celkové využití; "node" 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 v maloobchodních sazbách. Poznámka: Všechny částky nákladů jsou odhady a neodrážejí skutečnou fakturu. Příklad : 0.0	číslo
Podrobnosti Volitelné	Podrobnosti o velikosti virtuálního počítače používané nodearray, včetně hodin, core_count, priority oblasti a operačního systému Příklad : [ "object" ]	<Podrobnosti> Pole
Hodin vyžadováno	Počet hodin využití v této kategorii Příklad : 0.0	číslo
Uzel Volitelné	Název uzlu nebo uzluarray, pro který se používá (chybí pro data na úrovni clusteru) Příklad : "string"	řetězec

Podrobnosti

Název	Description	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)
Prioritou Volitelné	Priorita skladové položky virtuálního počítače Příklad : "string"	enum (běžný, bodový)
Oblasti Volitelné	Oblast, ve které se vytváří instance velikosti 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 : object

NodeCreationRequest

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

Název	Description	Schéma
requestId Volitelné	Volitelný jedinečný token zadaný uživatelem, který zabraňuje duplicitním operacím v případě chyb síťové komunikace. Pokud je zahrnuta a odpovídá dřívějšímu ID požadavku, server tento požadavek ignoruje a vrátí chybu 409. Příklad : "00000000-0000-0000-0000-000000000000"	řetězec
Nastaví vyžadováno	Seznam definic uzlů, které chcete vytvořit. Požadavek musí obsahovat alespoň jednu sadu. Každá sada může určit jinou sadu vlastností. Příklad : [ "object" ]	<Nastaví> Pole

Nastaví

Název	Description	Schéma
Počet vyžadováno	Počet uzlů, které se mají vytvořit Příklad : 1	integer
Definice Volitelné	Definice kbelíku, který se má použít. To je poskytováno voláním rozhraní API pro stav clusteru. Pokud chybí některé položky uvedené ve volání stavu nebo chybí celá vlastnost kbelíku, použije se první kbelík, který odpovídá daným položkám. Příklad : "object"	Definice
nameFormat Volitelné	Pokud je tato možnost uvedena, uzly místo standardního formátu nodearray-%d použijí tuto konvenci vytváření názvů. Příklad : "custom-name-%d"	řetězec
nameOffset Volitelné	Pokud je zadaný, společně s nameFormat odsadí nodeindex pro nové uzly. Příklad : 1	integer
nodeAttributes Volitelné	Další atributy, které se mají nastavit na každém uzlu z této sady Příklad : "[node](#node)"	Node
nodearray vyžadováno	Název uzluarray, ze které se mají spouštět uzly Příklad : "execute"	řetězec
placementGroupId Volitelné	Pokud je daná hodnota, všechny uzly se stejnou hodnotou groupId se spustí ve stejné skupině umístění. Příklad : "string"	řetězec

Definice

Název	Description	Schéma
machineType Volitelné	Příklad : "A2"	řetězec

NodeCreationResult

Název	Description	Schéma
id operace vyžadováno	ID této operace Příklad : "00000000-0000-0000-0000-000000000000"	řetězec
Nastaví Požadované	Pole sad ve stejném pořadí jako v požadavku Příklad : [ "object" ]	<Nastaví> Pole

Nastaví

Název	Description	Schéma
Přidány vyžadováno	Kolik uzlů bylo v této sadě spuštěno Příklad : 1	integer
message Volitelné	Označuje, proč není možné přidat všechny požadované uzly, pokud jsou k dispozici Příklad : "string"	řetězec

NodeList

Výsledky hledání uzlu

Název	Description	Schéma
Uzly vyžadováno	Vrácené uzly Příklad : [ "[node](#node)" ]	<Uzel> Pole
Operace Volitelné	Pokud dotaz obsahuje ID operace, jedná se o stav dané 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 zahrnuto více než jeden způsob, považuje se za sjednocovací.

Název	Description	Schéma
Filtr Volitelné	Výraz filtru, který odpovídá uzlům. Všimněte si, že řetězce ve výrazu musí být uvozovány správně. Příklad : "State === \"Started\""	řetězec
Hostname Volitelné	Seznam krátkých názvů hostitelů (bez domény) pro správu Příklad : [ "hostname1", "hostname2" ]	<pole řetězců >
Id Volitelné	Seznam ID uzlů ke správě Příklad : [ "id1", "id2" ]	<pole řetězců >
ip_addresses Volitelné	Seznam IP adres ke správě Příklad : [ "10.0.1.1", "10.1.1.2" ]	<pole řetězců >
Názvy Volitelné	Seznam názvů uzlů, které se mají spravovat Příklad : [ "name1", "name2" ]	<pole řetězců >
requestId Volitelné	Volitelný jedinečný token zadaný uživatelem, který zabraňuje duplicitním operacím v případě chyb síťové komunikace. Pokud je zahrnuta a odpovídá dřívějšímu ID požadavku, server tento požadavek ignoruje a vrátí chybu 409. Příklad : "00000000-0000-0000-0000-000000000000"	řetězec

NodeManagementResult

Název	Description	Schéma
Uzly vyžadováno	Pole informací o jednotlivých uzlech, které odpovídaly filtru v žádosti o správu. Stav každého uzlu označuje, jestli byl ovlivněn požadavkem. Příklad : [ "object" ]	<Uzly> Pole
ID operace Požadované	ID této operace Příklad : "00000000-0000-0000-0000-000000000000"	řetězec

Uzly

Název	Description	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
Jméno Požadované	Název uzlu Příklad : "name1"	řetězec
Stav Volitelné	Jedna z MOŽNOSTÍ OK nebo Chyba Příklad : "Error"	výčet (OK, chyba)

OperationStatus

Stav této operace uzlu

Název	Description	Schéma
Akce Požadované	Příklad : "string"	enum (create)
Starttime Požadované	Kdy byla tato operace odeslána Příklad : "2020-01-01T12:34:56Z"	string (datum a čas)