Operations

Abrufen von Clusterknoten

GET /clusters/{cluster}/nodes

Parameters

Type	Name	Description	Schema
Path	cluster required	Der abzufragende Cluster	string
Query	operation optional	Wenn angegeben, gibt nur die Knoten für diese Vorgangs-ID zurück und enthält das Operation-Attribut im Textkörper.	string
Query	request_id optional	Wenn angegeben, werden nur die Knoten für den vorgang zurückgegeben, der durch diese Anforderungs-ID identifiziert wird. und enthält das Operation-Attribut für den Textkörper.	string

Responses

HTTP Code	Description	Schema
200	OK	NodeList
400	Invalid specification	No Content
404	Not found	No Content

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/nodes

Beispiel-HTTP-Antwort

Response 200

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

Erstellen von Clusterknoten

POST /clusters/{cluster}/nodes/create

Description

Dieser Vorgang fügt einem Cluster neue Knoten aus einem Knotenarray hinzu. Es akzeptiert mehrere Knotendefinitionen in einem einzigen Aufruf. Sie gibt die URL zu dem Vorgang zurück, den Sie verwenden können, um den Status des Vorgangs nachzuverfolgen.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, dem Knoten hinzugefügt werden sollen	string
Body	nodes required	Zu erstellende Knotengruppen	NodeCreationRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (Zeichenfolge) : Die URL für den Vorgang.	NodeCreationResult
409	Invalid input	No Content

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/nodes/create

Request body

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

Beispiel-HTTP-Antwort

Response 202

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

Clusterknoten mit Deallocate

POST /clusters/{cluster}/nodes/deallocate

Description

Mit diesem Vorgang werden Knoten in einem Cluster verwechselt. Sie können die Knoten mithilfe mehrerer Methoden identifizieren, einschließlich Knotenname, Knoten-ID oder filter.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, in dem Knoten zugeordnet werden sollen	string
Body	action required	Beschreibung der Knoten, die verwechselt werden sollen	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult
409	Invalid input	No Content

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/nodes/deallocate

Request body

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

Beispiel-HTTP-Antwort

Response 202

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

Beenden und Entfernen von Clusterknoten

POST /clusters/{cluster}/nodes/remove

Description

Mit diesem Vorgang werden Knoten in einem Cluster entfernt. Sie können die Knoten auf verschiedene Arten identifizieren, einschließlich Knotenname, Knoten-ID oder mithilfe eines Filters. Standardmäßig werden Knoten beim Beenden entfernt, es sei denn, der Knoten hat die Fixed Eigenschaft auf true. In diesem Fall fungiert dieser Aufruf genauso wie "Terminate".

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, in dem Sie Knoten entfernen möchten	string
Body	action required	Beschreibung, welche Knoten entfernt werden sollen	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult
409	Invalid input	No Content

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/nodes/remove

Request body

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

Beispiel-HTTP-Antwort

Response 202

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

Beenden oder Aufheben der Zuordnung von Clusterknoten

POST /clusters/{cluster}/nodes/shutdown

Description

Dieser Vorgang beendet oder behandelt Knoten in einem Cluster. Der Vorgang verwendet das ShutdownPolicy Attribut auf jedem Knoten, um die Aktion zu bestimmen. Wenn das Attribut auf (Standardeinstellung) festgelegt Terminate ist, beendet der Vorgang den Knoten. Wenn das Attribut auf Deallocate festgelegt ist, wird der Knoten vom Vorgang zugeordnet.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, in dem Knoten heruntergefahren werden sollen	string
Body	action required	Beschreibung, welche Knoten heruntergefahren werden sollen	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult
409	Invalid input	No Content

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/nodes/shutdown

Request body

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

Beispiel-HTTP-Antwort

Response 202

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

Start deallocated or terminated cluster nodes

POST /clusters/{cluster}/nodes/start

Description

Dieser Vorgang startet Knoten in einem Cluster. Sie können die Knoten anhand des Knotennamens, der Knoten-ID oder mithilfe eines Filters identifizieren.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster zum Starten von Knoten in	string
Body	action required	Beschreibung, welche Knoten gestartet werden sollen	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult
409	Invalid input	No Content

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/nodes/start

Request body

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

Beispiel-HTTP-Antwort

Response 202

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

Clusterknoten beenden

POST /clusters/{cluster}/nodes/terminate

Description

Dieser Vorgang beendet Knoten in einem Cluster. Sie können die Knoten auf verschiedene Arten identifizieren, einschließlich Knotenname, Knoten-ID oder mithilfe eines Filters.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, in dem Knoten beendet werden sollen	string
Body	action required	Beschreibung, welche Knoten beendet werden sollen	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult
409	Invalid input	No Content

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/nodes/terminate

Request body

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

Beispiel-HTTP-Antwort

Response 202

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

Cluster auf Größe skalieren

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

Description

Dieser Vorgang fügt Knoten nach Bedarf zu einem Knotenarray hinzu, um eine Gesamtanzahl zu erreichen. Der Cluster verarbeitet die Anforderung einmal. Sie fügt später keine Knoten wieder hinzu, um die Nummer beizubehalten. Sie können entweder nach Gesamtkernen oder Gesamtknoten skalieren, aber nicht beides. Der Vorgang gibt die URL zurück, die zum Nachverfolgen des Status des Vorgangs verwendet werden soll.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, dem Knoten hinzugefügt werden sollen	string
Path	nodearray required	Das Knotenarray, dem Knoten hinzugefügt werden sollen	string
Query	totalCoreCount optional	Die Gesamtzahl der Kerne in diesem Knotenarray, einschließlich knoten, die Sie bereits erstellt haben	integer
Query	totalNodeCount optional	Die Gesamtzahl der Computer in diesem Knotenarray, einschließlich knoten, die Sie bereits erstellt haben	integer

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (Zeichenfolge) : Die URL für den Vorgang.	NodeCreationResult
409	Invalid input	No Content

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Beispiel-HTTP-Antwort

Response 202

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

Clusterstatus abrufen

GET /clusters/{cluster}/status

Description

Dieser Vorgang gibt Informationen für die Knoten und Knotenarrays in einem Cluster zurück. Für jedes Knotenarray gibt es den Status jedes "Buckets" der Zuteilung zurück, den Sie verwenden können. Der Status zeigt, wie viele Knoten sich im Bucket befinden und wie viele weitere Knoten Sie hinzufügen können. Jeder Bucket ist eine Reihe möglicher VMs mit einem bestimmten Hardwareprofil. Sie können diese virtuellen Computer an einem bestimmten Ort unter einem Kundenkonto erstellen. Die Clusterdefinition des Benutzers bestimmt die gültigen Buckets für ein Knotenarray. Der Cloudanbieter bestimmt die Grenzwerte.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der abzufragende Cluster	string
Query	nodes optional	Wenn wahr, enthält die Antwort Knoten- und Knotenverweise.	boolean

Responses

HTTP Code	Description	Schema
200	OK	ClusterStatus

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/status

Beispiel-HTTP-Antwort

Response 200

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

Abrufen von Nutzungs- und optionalen Kosteninformationen für einen Cluster

GET /clusters/{cluster}/usage

Description

Dieser Vorgang gibt allgemeine Nutzungsdaten (Kernstunden) und Kostendaten (sofern verfügbar) für den Cluster sowie eine Aufschlüsselung pro Knotenarray zurück. Standardmäßig wird der Nutzungswert des aktuellen Monats zurückgegeben.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, der Nutzungsdaten für	string
Query	timeframe optional	Der Zeitraum für die Abfrage. monthToDate gibt die Verwendung für den aktuellen Monat zurück, und lastMonth gibt die Verwendung für den vorherigen Monat zurück. weekToDate gibt die Verwendung für die aktuelle Woche (ab Sonntag) zurück. custom erfordert abfrageparameter "from" und "to". Der Standardwert ist MonthToDate. Alle Zeitangaben sind in UTC.	Enumeration (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Für benutzerdefinierte Zeitrahmen wird der Anfang des Zeitrahmens im ISO-8601-Format verwendet. Der Wert wird auf die nächste Stunde oder den nächsten Tag aufgerundet.	string
Query	to optional	Verwenden Sie für benutzerdefinierte Zeitrahmen das Ende des Zeitrahmens im ISO-8601-Format. Der Wert wird auf die nächste Stunde oder den nächsten Tag aufgerundet.	string
Query	granularity optional	Gibt an, wie Daten aggregiert werden: nach Stunde, täglich oder als einzelne Zahl. Der Standardwert ist täglich.	Enumeration (Summe, täglich, stündlich)

Responses

HTTP Code	Description	Schema
200	OK	ClusterUsage

Beispiel-HTTP-Anforderung

Request path

/clusters/CLUSTER_NAME/usage

Beispiel-HTTP-Antwort

Response 200

{
  "usage" : [ "object" ]
}

Listet den Status von Vorgängen auf.

GET /operations/

Parameters

Type	Name	Description	Schema
Query	request_id optional	Die Anforderungs-ID für den Vorgang. Wenn Sie diese ID angeben, enthält die Liste entweder null oder ein Element.	string

Responses

HTTP Code	Description	Schema
200	OK	< OperationStatus> array
400	Invalid request	No Content
404	Not found	No Content

Beispiel-HTTP-Anforderung

Request path

/operations/

Beispiel-HTTP-Antwort

Response 200

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

Ruft den Vorgangsstatus nach ID ab.

GET /operations/{id}

Parameters

Type	Name	Description	Schema
Path	id required	Die Vorgangs-ID	string

Responses

HTTP Code	Description	Schema
200	OK	OperationStatus
404	Not found	No Content

Beispiel-HTTP-Anforderung

Request path

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

Beispiel-HTTP-Antwort

Response 200

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

Resources

ClusterStatus

Status des Clusters.

Name	Description	Schema
maxCoreCount required	Die maximale Anzahl von Kernen, die Sie diesem Cluster hinzufügen können. Example : 16	integer
maxCount required	Die maximale Anzahl von Knoten, die Sie diesem Cluster hinzufügen können. Example : 4	integer
nodearrays required	Example : [ "object" ]	< nodearrays> array
nodes optional	Eine optionale Liste der Knoten in diesem Cluster. Die Antwort enthält diese Liste nur, wenn Sie in der Abfrage festlegen nodes=true . Example : [ "[node](#node)" ]	< Node> array
state optional	Der aktuelle Status des Clusters, wenn der Cluster mindestens einmal gestartet wurde Example : "Starting"	string
targetState optional	Der gewünschte Status des Clusters (z. B. "Gestartet" oder "Beendet") Example : "Started"	string

nodearrays

Name	Description	Schema
buckets required	Jeder Bucket der Zuordnung für dieses Knotenarray. Die Einstellungen für die "Kernanzahl" sind immer ein Vielfaches der Kernanzahl für diesen Bucket. Example : [ "object" ]	< buckets> array
maxCoreCount required	Die maximale Anzahl von Kernen in diesem Knotenarray Example : 16	integer
maxCount required	Die maximale Anzahl von Knoten in diesem Knotenarray Example : 4	integer
name required	Der Knotenarrayname Example : "execute"	string
nodearray required	Die Attribute dieses Knotenarrays Example : "[node](#node)"	Node

buckets

Name	Description	Schema
activeCoreCount required	Die Anzahl der für diesen Bucket verwendeten Kerne in diesem Knotenarray Example : 40	integer
activeCount required	Die Anzahl der Knoten, die für diesen Bucket verwendet werden, in diesem Knotenarray. Diese Anzahl umfasst Knoten, die noch einen virtuellen Computer abrufen. Example : 10	integer
activeNodes optional	Die Knotennamen, die für diesen Bucket verwendet werden, in diesem Knotenarray. Diese Liste enthält Knoten, die noch einen virtuellen Computer abrufen. Die Antwort enthält diese Eigenschaft nur, wenn die Abfrage enthält nodes=true. Example : [ "string" ]	<Zeichenfolgenarray >
availableCoreCount required	Wie viele zusätzliche Kerne Sie in diesem Bucket- und Knotenarray erstellen können. Dieser Wert ist immer ein Vielfaches von availableCount. Example : 8	integer
availableCount required	Wie viele zusätzliche Knoten Sie in diesem Bucket- und Knotenarray erstellen können. Dieser Wert ist möglicherweise kleiner als die Zahl, von der Sie subtrahieren usedCountmaxCount, da maxCount möglicherweise ein globaler Grenzwert liegt. Example : 2	integer
bucketId required	Der Bezeichner für diesen Bucket. Dieser Wert bleibt für einen bestimmten Bucket in einem Knotenarray gleich, solange Sie den Cluster nicht löschen. Example : "00000000-0000-0000-0000-000000000000"	string
consumedCoreCount required	Die Anzahl der Kerne für diese Familie, die bereits in der gesamten Region verwendet werden. Example : 2	integer
definition optional	Die Eigenschaften dieses Buckets, die zum Erstellen von Knoten aus diesem Bucket verwendet werden. Die Create-Nodes-API verwendet diese Definition in ihrer bucket Eigenschaft. Example : "object"	definition
familyConsumedCoreCount optional	Die Anzahl der Kerne für diese Familie, die bereits in der gesamten Region verwendet werden. Example : 2	integer
familyQuotaCoreCount optional	Die Anzahl der Gesamtkerne, die Sie für diese Familie in dieser Region beginnen können. Diese Zahl ist möglicherweise kein ganzzahliges Vielfaches von "quotaCount". Example : 16	integer
familyQuotaCount optional	Die Anzahl der Gesamtinstanzen, die Sie starten können, wenn Sie familyQuotaCoreCount festlegen. Example : 4	integer
invalidReason required	Ist "false" gültig, enthält das Feld den Grund, warum der Bucket ungültig ist. Derzeit sind NotActivated und DisabledMachineType die einzigen Gründe. Example : "DisabledMachineType"	string
lastCapacityFailure required	Wie lange, in Sekunden, seit der letzten Zeit dieses Buckets einen Kapazitätsausfall erlebt hat. Jeder negative Wert wird nie behandelt. Example : 180.0	number
maxCoreCount required	Die maximale Anzahl von Kernen, die sich in diesem Bucket befinden können, einschließlich globaler und Nodearray-Grenzwerte. Immer ein Vielfaches von maxCount. Example : 16	integer
maxCount required	Die maximale Anzahl von Knoten, die sich in diesem Bucket befinden können, einschließlich globaler und Knotenarray-Grenzwerte Example : 4	integer
maxPlacementGroupCoreSize required	Die maximale Gesamtanzahl der Kerne in einer Platzierungsgruppe für diesen Bucket. Immer ein Vielfaches von maxPlacementGroupSize. Example : 64	integer
maxPlacementGroupSize required	Die maximale Gesamtanzahl von Instanzen in einer Platzierungsgruppe für diesen Bucket. Example : 16	integer
placementGroups required	Die platzierungsgruppen, die für dieses Knotenarray verwendet werden, falls vorhanden. Example : [ "object" ]	< placementGroups> array
quotaCoreCount required	Die Anzahl der Gesamtkerne, die Sie für diese Familie in dieser Region beginnen können. Diese Zahl berücksichtigt auch die Anzahl der regionalen Kontingentkerne. Dieser Wert ist möglicherweise keine ganze Zahl von "quotaCount". Example : 16	integer
quotaCount required	Die Anzahl der Gesamtinstanzen, die Sie starten können, vorausgesetzt, "quotaCoreCount". Example : 4	integer
regionalConsumedCoreCount optional	Die Anzahl der Kerne, die bereits in der gesamten Region verwendet werden. Example : 2	integer
regionalQuotaCoreCount optional	Die Anzahl der Gesamtkerne, die Sie in dieser Region beginnen können. Diese Zahl ist möglicherweise kein ganzzahliges Vielfaches von regionalQuotaCount. Example : 16	integer
regionalQuotaCount optional	Die Anzahl der Gesamtinstanzen, die Sie starten können (vorausgesetzt, regionalQuotaCoreCount) Example : 4	integer
valid required	Wenn wahr, stellt dieser Bucket einen aktuell gültigen Bucket dar, der für neue Knoten verwendet werden soll. Wenn false, stellt dieser Bucket nur vorhandene Knoten dar. Example : true	boolean
virtualMachine required	Die Eigenschaften der virtuellen Computer, die Sie aus diesem Bucket starten Example : "object"	virtualMachine

definition

Name	Description	Schema
machineType required	Die VM-Größe des virtuellen Computers Example : "A2"	string

placementGroups

Name	Description	Schema
activeCoreCount required	Die Anzahl der Kerne in diesem Skalierungssatz Example : 16	integer
activeCount required	Die Anzahl der Knoten in diesem Skalierungssatz Example : 4	integer
name required	Der eindeutige Bezeichner dieser Platzierungsgruppe Example : "my-placement-group"	string

virtualMachine

Name	Description	Schema
gpuCount required	Die Anzahl der GPUs, die dieser Computertyp hat Example : 2	integer
infiniband required	Wenn dieser virtuelle Computer die InfiniBand-Konnektivität unterstützt Example : true	boolean
memory required	Der RAM auf diesem virtuellen Computer in GB Example : 7.5	number
pcpuCount required	Die Anzahl der physischen CPUs, die dieser Computertyp hat Example : 16	integer
vcpuCount required	Die Anzahl der virtuellen CPUs für diesen Computertyp Example : 32	integer
vcpuQuotaCount optional	Die Anzahl der vCPUs, die dieser Computer aus dem Kontingent verwendet Example : 2	integer

ClusterUsage

Nutzungs- und optionale Kosteninformationen für den Cluster

Name	Description	Schema
usage required	Eine Liste der Verwendungen nach Zeitintervall Example : [ "object" ]	< usage> array

usage

Name	Description	Schema
breakdown required	Die Aufschlüsselung der Verwendung in diesem Intervall nach Kategorie "node" und "nodearray" Example : [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> array
end required	Das Ende des Intervalls (exklusiv) Example : "string"	string
start required	Der Anfang des Intervalls (einschließlich) Example : "string"	string
total required	Die allgemeine Verwendung für diesen Cluster in diesem Intervall mit einer Kategorie von "Cluster" Example : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Name	Description	Schema
category required	"Cluster" für die allgemeine Nutzung; "Knoten" für einen einzelnen Nicht-Array-Kopfknoten; "nodearray" für ein ganzes Knotenarray Example : "string"	Enumeration (Cluster, Knoten, Knotenarray)
cost optional	Der Betrag für diese Nutzung, in US-Dollar und zu Einzelhandelspreisen. Hinweis: Alle Kostenbeträge sind Schätzungen und spiegeln nicht die tatsächliche Rechnung wider! Example : 0.0	number
details optional	Details zur VM-Größe, die von einem Knotenarray verwendet wird, einschließlich Stunden, Kernanzahl, Regionspriorität und Betriebssystem. Example : [ "object" ]	< details> array
hours required	Die Anzahl der Kernstunden der Nutzung für diese Kategorie Example : 0.0	number
node optional	Der Name des Knoten- oder Knotenarrays, für das die Verwendung verwendet wird (für Daten auf Clusterebene nicht vorhanden) Example : "string"	string

details

Name	Description	Schema
core_count optional	Die Anzahl der Kerne in dieser VM-Größe Example : 0.0	number
cost optional	Kosten für diese VM-Größe Example : 0.0	number
hours optional	Die Anzahl der Kernstunden der Nutzung für diese VM-Größe Example : 0.0	number
os optional	Typ des Betriebssystems Example : "string"	Enumeration (Windows, Linux)
priority optional	Priorität der VM-Sku Example : "string"	Enumeration (Normal, Spot)
region optional	Die Region, in der Sie die VM-Größe instanziieren Example : "string"	string
vm_size optional	VM-Sku-Größe Example : "string"	string

Node

Ein Knotendatensatz.

Type : object

NodeCreationRequest

Gibt an, wie Einem Cluster Knoten hinzugefügt werden.

Name	Description	Schema
requestId optional	Optionales vom Benutzer bereitgestelltes eindeutiges Token, um doppelte Vorgänge im Falle von Netzwerkkommunikationsfehlern zu verhindern. Wenn der Server eine Anforderung mit einer requestId Anforderung empfängt, die einer früheren Anforderung entspricht, ignoriert er die Anforderung und gibt einen Fehler vom Typ 409 zurück. Example : "00000000-0000-0000-0000-000000000000"	string
sets required	Eine Liste der zu erstellenden Knotendefinitionen. Die Anforderung muss mindestens einen Satz enthalten. Jeder Satz kann einen anderen Satz von Eigenschaften angeben. Example : [ "object" ]	< sets> array

sets

Name	Description	Schema
count required	Die Anzahl der zu erstellenden Knoten Example : 1	integer
definition optional	Die Definition des zu verwendenden Buckets. Der Clusterstatus-API-Aufruf stellt diese Definition bereit. Wenn in der Definition einige Elemente fehlen, die im Statusaufruf oder in der gesamten Bucketeigenschaft angegeben sind, wird der erste Bucket verwendet, der mit den angegebenen Elementen übereinstimmt. Example : "object"	definition
nameFormat optional	Wenn Sie diesen Wert angeben, verwenden Knoten diese Benennungskonvention anstelle des Standardformats nodearray-%d . Example : "custom-name-%d"	string
nameOffset optional	Wenn Sie diese Eigenschaft bereitstellen nameFormat, werden die Eigenschaftsversatz nodeindex für neue Knoten versetzt. Example : 1	integer
nodeAttributes optional	Zusätzliche Attribute, die für jeden Knoten in diesem Satz festgelegt werden sollen Example : "[node](#node)"	Node
nodearray required	Der Name des nodearray knotenanfangs von Example : "execute"	string
placementGroupId optional	Wenn Sie diese Eigenschaft angeben, beginnen Knoten mit demselben Wert für groupId alle, die in derselben Platzierungsgruppe beginnen. Example : "string"	string

definition

Name	Description	Schema
machineType optional	Example : "A2"	string

NodeCreationResult

Name	Description	Schema
operationId required	Die ID des Vorgangs Example : "00000000-0000-0000-0000-000000000000"	string
sets required	Ein Array von Sätzen in der gleichen Reihenfolge wie in der Anforderung Example : [ "object" ]	< sets> array

sets

Name	Description	Schema
added required	Die Anzahl der Knoten, die im Satz hinzugefügt werden sollen Example : 1	integer
message optional	Erläutert, warum das System nicht alle angeforderten Knoten hinzufügen kann, falls vorhanden Example : "string"	string

NodeList

Ergebnisse einer Knotensuche

Name	Description	Schema
nodes required	Die Knoten, die das System zurückgibt Example : [ "[node](#node)" ]	< Node> array
operation optional	Wenn die Abfrage eine Vorgangs-ID enthält, zeigt dieses Feld den Status dieses Vorgangs an. Example : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

Gibt an, wie Aktionen für Knoten in einem Cluster ausgeführt werden. Sie können Knoten auf mehrere Arten angeben. Wenn Sie mehrere Wege einschließen, behandelt die Anforderung die Spezifikation als Vereinigung.

Name	Description	Schema
filter optional	Ein Filterausdruck, der Knoten entspricht. Beachten Sie, dass Zeichenfolgen im Ausdruck richtig zitiert werden müssen. Example : "State === \"Started\""	string
hostnames optional	Eine Liste mit kurzen Hostnamen (ohne Domäne), die verwaltet werden sollen Example : [ "hostname1", "hostname2" ]	<Zeichenfolgenarray >
ids optional	Eine Liste der zu verwaltenden Knoten-IDs Example : [ "id1", "id2" ]	<Zeichenfolgenarray >
ip_addresses optional	Eine Liste der zu verwaltenden IP-Adressen Example : [ "10.0.1.1", "10.1.1.2" ]	<Zeichenfolgenarray >
names optional	Eine Liste der zu verwaltenden Knotennamen Example : [ "name1", "name2" ]	<Zeichenfolgenarray >
requestId optional	Optionales vom Benutzer bereitgestelltes eindeutiges Token, um doppelte Vorgänge im Falle von Netzwerkkommunikationsfehlern zu verhindern. Wenn der Server eine Anforderung mit einer requestId Anforderung empfängt, die mit einer früheren Anforderungs-ID übereinstimmt, ignoriert er die Anforderung und gibt einen Fehler vom Typ 409 zurück. Example : "00000000-0000-0000-0000-000000000000"	string

NodeManagementResult

Name	Description	Schema
nodes required	Ein Array von Informationen zu jedem Knoten, der dem Filter in der Verwaltungsanforderung entspricht. Der Status jedes Knotens gibt an, ob sich die Anforderung darauf auswirkt. Example : [ "object" ]	< nodes> array
operationId required	Die ID dieses Vorgangs Example : "00000000-0000-0000-0000-000000000000"	string

nodes

Name	Description	Schema
error optional	Wenn der Status "Fehler" lautet, wird die Fehlermeldung angezeigt. Example : "This node must be terminated before it can be removed"	string
id required	Die ID des Knotens Example : "id1"	string
name required	Der Name des Knotens Example : "name1"	string
status optional	Einer von "OK" oder "Fehler" Example : "Error"	Enumeration (OK, Fehler)

OperationStatus

Der Status des Knotenvorgangs.

Name	Description	Schema
action required	Example : "string"	enum (create)
startTime required	Wenn Sie den Vorgang übermittelt haben Example : "2020-01-01T12:34:56Z"	string (date-time)