Operations

Azure CycleCloud poskytuje rozhraní REST API pro správu clusterů, uzlů a souvisejících prostředků prostřednictvím kódu programu. Pomocí těchto operací rozhraní API můžete dotazovat stav clusteru, vytvářet a spravovat uzly a sledovat dlouhotrvající operace. Tento odkaz obsahuje seznam dostupných koncových bodů, parametrů a formátů odpovědí, které vám pomůžou automatizovat a integrovat správu clusteru CycleCloud do pracovních postupů.

Získání uzlů clusteru

GET /clusters/{cluster}/nodes

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster, který se má dotazovat	řetězec
Query	operation optional	Pokud je tato hodnota uvedena, vrátí pouze uzly pro toto ID operace a zahrne atribut operace v těle.	řetězec
Query	request_id optional	Pokud je tato hodnota zadána, vrátí pouze uzly pro operaci identifikovanou tímto ID požadavku a zahrne atribut operace v těle.	řetězec

Responses

Kód HTTP	Description	Schema
200	OK	NodeList
400	Neplatná specifikace	Žádný obsah
404	Nenalezeno	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/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

Description

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.

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro přidání uzlů do	řetězec
Body	nodes required	Sady uzlů, které se mají vytvořit	NodeCreationRequest

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeCreationResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/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

Description

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

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro uvolnění uzlů v	řetězec
Body	action required	Popis, které uzly se mají uvolnit	NodeManagementRequest

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeManagementResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

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

Opětovné vytvoření uzlů clusteru

POST /clusters/{cluster}/nodes/reimage

Description

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

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro opětovné vytvoření uzlu v	řetězec
Body	action required	Popis uzlů, které se mají znovu vytvořit	NodeManagementRequest

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeManagementResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/clusters/CLUSTER_NAME/nodes/reimage

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 můžete identifikovat podle názvu uzlu, ID uzlu nebo filtru. Ve výchozím nastavení CycleCloud odebere uzly při ukončení, takže se toto volání chová jako ukončení. Uzly s pevným atributem nastaveným na true se při ukončení neodeberou.

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro odebrání uzlů v	řetězec
Body	action required	Popis, které uzly se mají odebrat	NodeManagementRequest

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeManagementResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

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

Restartování uzlů clusteru

POST /clusters/{cluster}/nodes/restart

Description

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

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro restartování uzlů v	řetězec
Body	action required	Popis, které uzly se mají restartovat	NodeManagementRequest

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeManagementResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/clusters/CLUSTER_NAME/nodes/restart

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

Toto volání vypne uzly v clusteru. Atribut ShutdownPolicy každého uzlu rozhoduje o akci: Ukončit (výchozí) nebo Zrušit přidělení.

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro vypnutí uzlů v	řetězec
Body	action required	Popis, které uzly se mají vypnout	NodeManagementRequest

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeManagementResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/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 spouští uzly v clusteru. Uzly lze identifikovat několika způsoby, včetně názvu uzlu, ID uzlu nebo podle filtru.

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster ke spuštění uzlů v	řetězec
Body	action required	Popis, které uzly se mají spustit	NodeManagementRequest

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeManagementResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/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 podle filtru.

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro ukončení uzlů v	řetězec
Body	action required	Popis, které uzly se mají ukončit	NodeManagementRequest

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeManagementResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

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

Odeslání sestavy stavu hosta pro uzel clusteru

POST /clusters/{cluster}/nodes/{node}/ghr

Description

Odeslání sestavy o stavu uzlu s problémem se stavem

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster, který obsahuje uzel pro sestavu	řetězec
Path	node required	Uzel, který se má hlásit	řetězec
Query	category optional	Kategorie Sestava stavu hosta pro dopad	řetězec
Query	popis optional	Vlastní zpráva popisující selhání nebo kontext	řetězec

Responses

Kód HTTP	Description	Schema
202	Přijato	Žádný obsah
400	Neplatný vstup	Žádný obsah
404	Nenalezeno	Žádný obsah
409	Konflikt – Sestava stavu hosta již byla pro tento uzel odeslána	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/clusters/CLUSTER_NAME/nodes/string/ghr

Získání sestavy stavu hosta pro uzel clusteru

GET /clusters/{cluster}/nodes/{node}/ghr

Description

Vrátí dopad úlohy uzlu s problémem se stavem, abyste ho mohli odeslat do koncového bodu generování sestav stavu.

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster, který obsahuje uzel pro sestavu	řetězec
Path	node required	Uzel, který se má hlásit	řetězec
Query	category optional	Kategorie Sestava stavu hosta pro dopad	řetězec
Query	popis optional	Vlastní zpráva popisující selhání nebo kontext	řetězec

Responses

Kód HTTP	Description	Schema
200	Ok	Žádný obsah
400	Neplatný vstup	Žádný obsah
404	Nenalezeno	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/clusters/CLUSTER_NAME/nodes/string/ghr

Škálování clusteru podle velikosti

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

Description

Tato operace přidá uzly podle potřeby do nodearray, aby dosáhla celkového počtu. Žádost se zpracuje jednou a později nepřidá uzly, aby se zachovalo dané číslo. Zadejte cílovou velikost pomocí buď totalCoreCount (celkový počet jader procesoru), nebo totalNodeCount (celkový počet virtuálních počítačů), ale ne obě ve stejném požadavku. Vrátí adresu URL operace, kterou můžete použít ke sledování jejího stavu.

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro přidání uzlů do	řetězec
Path	nodearray required	Nodearray pro přidání uzlů do	řetězec
Query	totalCoreCount optional	Celkový počet jader, která mají být v tomto uzlu, včetně již vytvořených uzlů	integer
Query	totalNodeCount optional	Celkový počet počítačů,kteréch	integer

Responses

Kód HTTP	Description	Schema
202	Přijata Hlavičky : Location (řetězec): Adresa URL operace.	NodeCreationResult
409	Neplatný vstup	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/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 uzlech v daném clusteru. U každého uzlu vrátí stav každého dostupného přidělení "kbelíku". Stav zahrnuje aktuální počet uzlů v kontejneru a počet dalších uzlů, které můžete přidat. 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. Definice clusteru uživatele určuje platné kontejnery pro nodearray, ale poskytovatel cloudu částečně určuje limity.

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster, který se má dotazovat	řetězec
Query	nodes optional	Pokud je hodnota true, vrátí se v odpovědi odkazy na uzly a uzly.	boolean

Responses

Kód HTTP	Description	Schema
200	OK	ClusterStatus

Příklad požadavku HTTP

Cesta žádosti

/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

Description

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

Parameters

Typ	Name	Description	Schema
Path	cluster required	Cluster pro vrácení dat o využití pro	řetězec
Query	Časový rámec optional	Časový rozsah, který se má použít pro dotaz. Platné hodnoty: monthToDate (aktuální měsíc), (předchozí měsíc), lastMonthweekToDate (aktuální týden, počáteční neděle) nebo custom (vyžaduje from parametry dotazu).to Výchozí hodnota je monthToDate. Všechny časy jsou v UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	U vlastních časových rámců je tato hodnota začátkem časového rámce ve formátu ISO-8601. Zaokrouhlí se dolů na nejbližší hodinu nebo den.	řetězec
Query	to optional	U vlastních časových rámců je tato hodnota koncem časového rámce ve formátu ISO-8601. Zaokrouhlí se nahoru na nejbližší hodinu nebo den.	řetězec
Query	Rozlišovací schopnost optional	Určuje, jak agregovat data: hodinově, denně nebo jako jeden součet. Výchozí interval je denní.	enum (celkem, denně, hodinově)

Responses

Kód HTTP	Description	Schema
200	OK	ClusterUsage

Příklad požadavku HTTP

Cesta žádosti

/clusters/CLUSTER_NAME/usage

Příklad odpovědi HTTP

Odpověď 200

{
  "usage" : [ "object" ]
}

Výpis stavu operací

GET /operations/

Parameters

Typ	Name	Description	Schema
Query	request_id optional	ID požadavku pro operaci. Pokud je tato hodnota zadána, seznam obsahuje prvek 0 nebo 1.	řetězec

Responses

Kód HTTP	Description	Schema
200	OK	< OperationStatus> Pole
400	Neplatný požadavek	Žádný obsah
404	Nenalezeno	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

/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}

Parameters

Typ	Name	Description	Schema
Path	id required	Identifikátor operace	řetězec

Responses

Kód HTTP	Description	Schema
200	OK	OperationStatus
404	Nenalezeno	Žádný obsah

Příklad požadavku HTTP

Cesta žádosti

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

Příklad odpovědi HTTP

Odpověď 200

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

Resources

Azure CycleCloud definuje sadu modelů prostředků, které popisují clustery, pole uzlů, uzly a stav přidělení. Tyto prostředky vrací rozhraní REST API a poskytují podrobnosti, jako jsou limity kapacity, využití a stav clusteru. Tento odkaz vám umožní porozumět struktuře a vlastnostem odpovědí rozhraní API při programové správě a monitorování clusterů CycleCloud.

ClusterStatus

Stav clusteru

Name	Description	Schema
maxCoreCount required	Maximální počet jader, která se můžou přidat do tohoto clusteru Příklad : 16	integer
maxCount required	Maximální počet uzlů, které mohou být přidány do tohoto clusteru Příklad : 4	integer
nodearrays required	Příklad : [ "object" ]	< nodearrays> Pole
nodes optional	Volitelný seznam uzlů v tomto clusteru, zahrnutý pouze v případě, že je nodes=true v dotazu. Příklad : [ "[node](#node)" ]	< Uzel> Pole
state optional	Aktuální stav clusteru, který je k dispozici po alespoň jednom spuštění Příklad : "Starting"	řetězec
targetState optional	Požadovaný stav clusteru (například Spuštěno nebo Ukončeno) Příklad : "Started"	řetězec

nodearrays

Name	Description	Schema
Kbelíky required	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 required	Maximální počet jader, která mohou být v tomto uzlu Příklad : 16	integer
maxCount required	Maximální početuzlůch Příklad : 4	integer
name required	Název nodearray Příklad : "execute"	řetězec
nodearray required	Atributy tohoto uzlu Příklad : "[node](#node)"	Node

Kbelíky

Name	Description	Schema
activeCoreCount required	Počet jader, která se používají pro tento kbelík, v tomto uzlu Příklad : 40	integer
activeCount required	Počet uzlů, které se používají pro tento kbelík, v tomto uzlu. Toto číslo zahrnuje uzly, které stále získávají virtuální počítač. Příklad : 10	integer
activeNodes optional	Názvy uzlů, které se používají pro tento kontejner v rámci nodearray, včetně uzlů, které stále získávají virtuální počítač. Vráceno pouze v případech, kdy dotaz obsahuje uzly=true. Příklad : [ "string" ]	< Řetězcové > pole
availableCoreCount required	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	integer
availableCount required	Počet dalších uzlů, které lze vytvořit v tomto kontejneru v rámci nodearray. Hodnota může být nižší než maxCount minus usedCount , protože maxCount může být omezena globálním limitem. Příklad : 2	integer
bucketId required	Jedinečný identifikátor kontejneru. Hodnota zůstane stejná pro daný kontejner v nodearray po dobu životnosti clusteru. Příklad : "00000000-0000-0000-0000-000000000000"	řetězec
consumedCoreCount required	Počet jader pro tuto rodinu, která se už používají v celé oblasti. Příklad : 2	integer
definition optional	Vlastnosti použité k vytvoření uzlů z tohoto kontejneru. Rozhraní API create-nodes přebírá tuto definici ve své bucket vlastnosti. Příklad : "object"	definition
familyConsumedCoreCount optional	Počet jader pro tuto rodinu, která se už používají v celé oblasti. Příklad : 2	integer
familyQuotaCoreCount optional	Celkový počet jader, která můžou běžet pro tuto řadu virtuálních počítačů v dané oblasti. Hodnota není nutně celočíselnou násobkem familyQuotaCount. Příklad : 16	integer
familyQuotaCount optional	Celkový počet instancí, které lze spustit (dané familyQuotaCoreCount) Příklad : 4	integer
invalidReason required	Důvod, proč je kontejner neplatný, pokud valid je false. V současné době jsou jediné možné hodnoty a NotActivatedDisabledMachineType. Příklad : "DisabledMachineType"	řetězec
lastCapacityFailure required	Počet sekund, po které došlo k selhání kapacity v tomto kontejneru Jakákoli záporná hodnota se považuje za nikdy. Příklad : 180.0	number
maxCoreCount required	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	integer
maxCount required	Maximální počet uzlů, které mohou být v tomto kontejneru, včetně globálních limitů a limitů nodearray Příklad : 4	integer
maxPlacementGroupCoreSize required	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	integer
maxPlacementGroupSize required	Maximální celkový počet instancí, které mohou být ve skupině umístění v tomto kontejneru Příklad : 16	integer
placementGroups required	Skupiny umístění používané pro tento uzelarray, pokud existuje. Příklad : [ "object" ]	< placementGroups> Pole
quotaCoreCount required	Celkový počet jader, která můžou běžet pro tuto řadu virtuálních počítačů v dané oblasti, a to započítávání počtu jader pro oblastní kvótu. Hodnota není nutně celočíselnou násobkem quotaCount. Příklad : 16	integer
quotaCount required	Celkový počet instancí, které je možné spustit (dané kvótěCoreCount) Příklad : 4	integer
regionalConsumedCoreCount optional	Počet jader, která se už používají v celé oblasti. Příklad : 2	integer
regionalQuotaCoreCount optional	Celkový počet jader, která se dají spustit v dané oblasti. Hodnota není nutně celočíselnou násobkem regionalQuotaCount. Příklad : 16	integer
regionalQuotaCount optional	Počet instancí, které lze spustit (dané regionalQuotaCoreCount) Příklad : 4	integer
spotPlacementScore required	Skóre spotového umístění pro tento kbelík označující pravděpodobnost dostupnosti spotového virtuálního počítače. Může to být vysoký, střední, nízký nebo prázdný řetězec, pokud není k dispozici. Příklad : "High"	řetězec
platný required	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	boolean
virtualMachine required	Vlastnosti virtuálních počítačů spuštěných z tohoto kontejneru Příklad : "object"	virtualMachine

Definice

Name	Description	Schema
machineType required	Velikost virtuálního počítače virtuálního počítače Příklad : "A2"	řetězec

placementGroups

Name	Description	Schema
activeCoreCount required	Kolik jader je v této škálovací sadě Příklad : 16	integer
activeCount required	Kolik uzlů je v této škálovací sadě Příklad : 4	integer
name required	Jedinečný identifikátor této skupiny umístění Příklad : "my-placement-group"	řetězec

virtualMachine

Name	Description	Schema
GpuCount required	Počet GPU, které tento typ počítače obsahuje Příklad : 2	integer
infiniband required	Pokud tento virtuální počítač podporuje připojení InfiniBand Příklad : true	boolean
memory required	Paměť RAM v tomto virtuálním počítači v GB Příklad : 7.5	number
pcpuCount required	Počet fyzických procesorů, které má tento typ počítače Příklad : 16	integer
vcpuCount required	Počet virtuálních procesorů, které tento typ počítače obsahuje Příklad : 32	integer
vcpuQuotaCount optional	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 pro cluster

Name	Description	Schema
usage required	Seznam využití podle časového intervalu Příklad : [ "object" ]	< Použití> Pole

Použití

Name	Description	Schema
Členění required	Rozpis využití v tomto intervalu podle kategorie "node" a "nodearray" Příklad : [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> Pole
end required	Konec intervalu (výhradní) Příklad : "string"	řetězec
start required	Začátek intervalu (včetně) Příklad : "string"	řetězec
total required	Celkové využití tohoto clusteru v tomto intervalu s kategorií clusteru Příklad : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Name	Description	Schema
category required	"cluster" pro celkové využití; "uzel" pro jeden hlavní uzel bez pole; "nodearray" pro celý uzelarray Příklad : "string"	enum (cluster, node, nodearray)
cost optional	Čá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 nejsou reflektovat skutečnou fakturu! Příklad : 0.0	number
details optional	Podrobnosti o velikosti virtuálního počítače používané v nodearray, včetně hodin, core_count, oblasti, priority a operačního systému. Příklad : [ "object" ]	< Podrobnosti> Pole
hours required	Počet hodin využití jádra pro tuto kategorii Příklad : 0.0	number
node optional	Název uzlu nebo nodearray, pro který se používá (chybí pro data na úrovni clusteru) Příklad : "string"	řetězec

Podrobnosti

Name	Description	Schema
core_count optional	Počet jader v této velikosti virtuálního počítače Příklad : 0.0	number
cost optional	Náklady na tuto velikost virtuálního počítače Příklad : 0.0	number
hours optional	Počet hodin využití jádra pro tuto velikost virtuálního počítače Příklad : 0.0	number
os optional	Typ operačního systému Příklad : "string"	enum (Windows, Linux)
priority optional	Priorita skladové položky virtuálního počítače Příklad : "string"	enum (regular, spot)
region optional	Oblast, ve které se vytvoří instance virtuálního počítače Příklad : "string"	řetězec
vm_size optional	Velikost skladové položky virtuálního počítače Příklad : "string"	řetězec

Node

Záznam uzlu

Typ: objekt

NodeCreationRequest

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

Name	Description	Schema
Requestid optional	Volitelný jedinečný token zadaný uživatelem, který zabrání duplicitním operacím, pokud dojde k chybám síťové komunikace. Pokud je tato hodnota 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
Nastaví required	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

Nastaví

Name	Description	Schema
count required	Počet uzlů, které se mají vytvořit Příklad : 1	integer
definition optional	Definice kontejneru, který se má použít, poskytuje volání 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"	definition
nameFormat optional	V případě potřeby používají uzly místo standardního formátu nodearray-%dtuto konvenci pojmenování. Příklad : "custom-name-%d"	řetězec
nameOffset optional	Pokud je to zadané, společně s nameFormat posune index uzlu pro nové uzly. Příklad : 1	integer
nodeAttributes optional	Další atributy, které se mají nastavit na každém uzlu z této sady Příklad : "[node](#node)"	Node
nodearray required	Název nodearray pro spuštění uzlů z Příklad : "execute"	řetězec
placementGroupId optional	Pokud je tato hodnota zadaná, uzly se stejnou hodnotou pro groupId začínají ve stejné skupině umístění. Příklad : "string"	řetězec

Definice

Name	Description	Schema
machineType optional	Příklad : "A2"	řetězec

NodeCreationResult

Name	Description	Schema
operationId required	ID této operace Příklad : "00000000-0000-0000-0000-000000000000"	řetězec
Nastaví required	Pole sad ve stejném pořadí jako v požadavku Příklad : [ "object" ]	< Nastaví> Pole

Nastaví

Name	Description	Schema
Přidány required	Kolik uzlů bylo v této sadě spuštěno Příklad : 1	integer
message optional	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ů

Name	Description	Schema
nodes required	Vrácené uzly Příklad : [ "[node](#node)" ]	< Uzel> Pole
operation optional	Stav operace, pokud dotaz obsahuje ID 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í.

Name	Description	Schema
filter optional	Výraz filtru, který odpovídá uzlům. Řetězce ve výrazu musí být správně citovány. Příklad : "State === \"Started\""	řetězec
Hostname optional	Seznam krátkých názvů hostitelů (bez domény) pro správu Příklad : [ "hostname1", "hostname2" ]	< Řetězcové > pole
Id optional	Seznam ID uzlů pro správu Příklad : [ "id1", "id2" ]	< Řetězcové > pole
ip_addresses optional	Seznam IP adres pro správu Příklad : [ "10.0.1.1", "10.1.1.2" ]	< Řetězcové > pole
names optional	Seznam názvů uzlů pro správu Příklad : [ "name1", "name2" ]	< Řetězcové > pole
Requestid optional	Volitelný jedinečný token zadaný uživatelem, který zabrání duplicitním operacím, pokud dojde k chybám síťové komunikace. Pokud je tato hodnota 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

Name	Description	Schema
nodes required	Pole informací o každém uzlu, který odpovídá filtru v žádosti o správu. Stav každého uzlu označuje, jestli to ovlivnilo požadavek. Příklad : [ "object" ]	< Uzly> Pole
operationId required	ID této operace Příklad : "00000000-0000-0000-0000-000000000000"	řetězec

Uzly

Name	Description	Schema
error optional	Chybová zpráva, pokud status je Error. Příklad : "This node must be terminated before it can be removed"	řetězec
id required	ID uzlu Příklad : "id1"	řetězec
name required	Název uzlu Příklad : "name1"	řetězec
status optional	Jedna z ok nebo chyb Příklad : "Error"	výčet (OK, chyba)

OperationStatus

Stav této operace uzlu

Name	Description	Schema
action required	Příklad : "string"	enum (create)
startTime required	Po odeslání této operace Příklad : "2020-01-01T12:34:56Z"	řetězec (datum a čas)