Operations

Abrufen von Clusterknoten

GET /clusters/{cluster}/nodes

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der abzufragende Cluster	Zeichenfolge
Abfrage	operation optional	Wenn angegeben, gibt nur die Knoten für diese Vorgangs-ID zurück und schließt das Vorgangsattribut im Textkörper ein.	Zeichenfolge
Abfrage	request_id optional	Wenn angegeben, gibt nur die Knoten für den Vorgang zurück, der durch diese Anforderungs-ID identifiziert wird. und schließt das Vorgangsattribut im Textkörper ein.	Zeichenfolge

Antworten

HTTP-Code	BESCHREIBUNG	Schema
200	OK	NodeList
400	Ungültige Spezifikation	Kein Inhalt
404	Nicht gefunden	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes

HTTP-Beispielantwort

Antwort 200

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

Erstellen von Clusterknoten

POST /clusters/{cluster}/nodes/create

BESCHREIBUNG

Dieser Vorgang fügt einem Cluster neue Knoten aus einem Nodearray hinzu. Sie akzeptiert mehrere Knotendefinitionen in einem einzigen Aufruf. Es gibt die URL an den Vorgang zurück, mit dem die status des Vorgangs nachverfolgt werden kann.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der Cluster, dem Knoten hinzugefügt werden sollen	Zeichenfolge
Text	Knoten erforderlich	Zu erstellende Knotensätze	NodeCreationRequest

Antworten

HTTP-Code	BESCHREIBUNG	Schema
202	Akzeptiert Header : Location (string) : Die URL für den Vorgang.	NodeCreationResult
409	Ungültige Eingabe	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/create

Anforderungstext

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

HTTP-Beispielantwort

Antwort 202

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

Zuordnung von Clusterknoten

POST /clusters/{cluster}/nodes/deallocate

BESCHREIBUNG

Mit diesem Vorgang werden Knoten in einem Cluster zugeordnet. Die Knoten können auf verschiedene Arten identifiziert werden, z. B. Knotenname, Knoten-ID oder durch Filter.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der Cluster, in dem Knoten zugeordnet werden sollen	Zeichenfolge
Text	action erforderlich	Beschreibung, welche Knoten zugeordnet werden sollen	NodeManagementRequest

Antworten

HTTP-Code	BESCHREIBUNG	Schema
202	Akzeptiert Header : Location (string) : Die URL für den Vorgang.	NodeManagementResult
409	Ungültige Eingabe	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/deallocate

Anforderungstext

{
  "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 für EINE HTTP-Antwort

Antwort 202

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

Beenden und Entfernen von Clusterknoten

POST /clusters/{cluster}/nodes/remove

BESCHREIBUNG

Dieser Vorgang entfernt Knoten in einem Cluster. Die Knoten können auf verschiedene Arten identifiziert werden, z. B. Knotenname, Knoten-ID oder durch Filter. Beachten Sie, dass Knoten standardmäßig entfernt werden, wenn sie beendet werden (es sei denn, für den Knoten ist Fixed auf true festgelegt). In diesem Fall unterscheidet sich dieser Aufruf nicht vom Beenden.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der Cluster, in dem Knoten entfernt werden sollen.	Zeichenfolge
Text	action erforderlich	Beschreibung der zu entfernenden Knoten	NodeManagementRequest

Antworten

HTTP-Code	BESCHREIBUNG	Schema
202	Akzeptiert Header: Location (string) : Die URL für den Vorgang.	NodeManagementResult
409	Ungültige Eingabe	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/remove

Anforderungstext

{
  "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 für EINE HTTP-Antwort

Antwort 202

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

Beenden oder Aufheben der Zuordnung von Clusterknoten

POST /clusters/{cluster}/nodes/shutdown

BESCHREIBUNG

Mit diesem Vorgang werden Knoten in einem Cluster beendet oder aufgehoben, je nachdem, ob das ShutdownPolicy-Attribut auf jedem Knoten Terminate (Standard) oder Deallocate ist.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der Cluster, in dem Knoten heruntergefahren werden sollen	Zeichenfolge
Text	action erforderlich	Beschreibung, welche Knoten heruntergefahren werden sollen	NodeManagementRequest

Antworten

HTTP-Code	BESCHREIBUNG	Schema
202	Akzeptiert Header: Location (string) : Die URL für den Vorgang.	NodeManagementResult
409	Ungültige Eingabe	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/shutdown

Anforderungstext

{
  "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 für EINE HTTP-Antwort

Antwort 202

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

Starten einer freigegebenen oder beendeten Clusterknoten

POST /clusters/{cluster}/nodes/start

BESCHREIBUNG

Dieser Vorgang startet Knoten in einem Cluster. Die Knoten können auf verschiedene Arten identifiziert werden, z. B. Knotenname, Knoten-ID oder durch Filter.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der Cluster, in dem Knoten gestartet werden sollen.	Zeichenfolge
Text	action erforderlich	Beschreibung, welche Knoten gestartet werden sollen	NodeManagementRequest

Antworten

HTTP-Code	BESCHREIBUNG	Schema
202	Akzeptiert Header : Location (string) : Die URL für den Vorgang.	NodeManagementResult
409	Ungültige Eingabe	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/start

Anforderungstext

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

HTTP-Beispielantwort

Antwort 202

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

Clusterknoten beenden

POST /clusters/{cluster}/nodes/terminate

BESCHREIBUNG

Dieser Vorgang beendet Knoten in einem Cluster. Die Knoten können auf verschiedene Arten identifiziert werden, z. B. Knotenname, Knoten-ID oder durch Filter.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der Cluster zum Beenden von Knoten in	Zeichenfolge
Text	action erforderlich	Beschreibung, welche Knoten beendet werden sollen	NodeManagementRequest

Antworten

HTTP-Code	BESCHREIBUNG	Schema
202	Akzeptiert Header : Location (string) : Die URL für den Vorgang.	NodeManagementResult
409	Ungültige Eingabe	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/terminate

Anforderungstext

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

HTTP-Beispielantwort

Antwort 202

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

Cluster auf Größe skalieren

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

BESCHREIBUNG

Dieser Vorgang fügt knoten bei Bedarf einem Nodearray hinzu, um eine Gesamtanzahl zu erreichen. Die Anforderung wird einmal verarbeitet und fügt keine Knoten später erneut hinzu, um die angegebene Nummer zu erhalten. Dies wird entweder nach Gesamtkernen oder Knoten insgesamt skaliert, aber nicht nach beiden. Es gibt die URL an den Vorgang zurück, mit dem die status des Vorgangs nachverfolgt werden kann.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der Cluster, dem Knoten hinzugefügt werden sollen	Zeichenfolge
Pfad	nodearray erforderlich	Das Nodearray, dem Knoten hinzugefügt werden sollen	Zeichenfolge
Abfrage	totalCoreCount optional	Die Gesamtzahl der Kerne, die in diesem Nodearray enthalten sein sollen, einschließlich bereits erstellter Knoten	integer
Abfrage	totalNodeCount optional	Die Gesamtzahl der Computer, die in diesem Nodearray vorhanden sein sollen, einschließlich bereits erstellter Knoten	integer

Antworten

HTTP-Code	BESCHREIBUNG	Schema
202	Akzeptiert Header : Location (string) : Die URL für den Vorgang.	NodeCreationResult
409	Ungültige Eingabe	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

HTTP-Beispielantwort

Antwort 202

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

Abrufen des Clusterstatus

GET /clusters/{cluster}/status

BESCHREIBUNG

Dieser Vorgang enthält Informationen zu den Knoten und Nodearrays in einem bestimmten Cluster. Für jedes Nodearray wird die status jedes "Buckets" der Zuordnung zurückgegeben, der verwendet werden kann, z. B. wie viele Knoten sich im Bucket befinden, wie viele weitere hinzugefügt werden können usw. Jeder Bucket ist eine Gruppe möglicher VMs eines bestimmten Hardwareprofils, die an einem bestimmten Standort, unter einem bestimmten Kundenkonto usw. erstellt werden können. Die gültigen Buckets für ein Nodearray werden durch die Clusterdefinition des Benutzers bestimmt, aber die Grenzwerte werden teilweise vom Cloudanbieter bestimmt.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der abzufragende Cluster	Zeichenfolge
Abfrage	Knoten optional	Wenn true, werden Knoten und Knotenverweise in der Antwort zurückgegeben.	boolean

Antworten

HTTP-Code	BESCHREIBUNG	Schema
200	OK	ClusterStatus

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/status

Beispiel für EINE HTTP-Antwort

Antwort 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

BESCHREIBUNG

Dieser Vorgang gibt die Gesamtnutzungsdaten (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.

Parameter

type	Name	Beschreibung	Schema
Pfad	cluster erforderlich	Der Cluster, für den Nutzungsdaten zurückgegeben werden sollen.	Zeichenfolge
Abfrage	timeframe optional	Wenn angegeben, gibt dies den Zeitbereich an, der für die Abfrage verwendet werden soll. monthToDate gibt die Nutzung für den aktuellen Monat und lastMonth die Nutzung für den vorherigen Monat zurück. weekToDate gibt die Nutzung für die aktuelle Woche (ab Sonntag) zurück. custom erfordert die Abfrageparameter "from" und "to". Der Standardwert ist MonthToDate. Alle Zeitangaben sind in UTC.	Enumeration (monthToDate, lastMonth, weekToDate, custom)
Abfrage	from optional	Bei benutzerdefinierten Zeitrahmen ist dies der Anfang des Zeitrahmens im ISO-8601-Format. Dies wird auf die nächste Stunde oder den nächsten Tag abgerundet.	Zeichenfolge
Abfrage	to optional	Bei benutzerdefinierten Zeitrahmen ist dies das Ende des Zeitrahmens im ISO-8601-Format. Dies wird auf die nächste Stunde oder den nächsten Tag aufgerundet.	Zeichenfolge
Abfrage	Granularität optional	Gibt an, wie Daten aggregiert werden: nach Stunde, täglich oder als einzelne Zahl. Dieser Standardwert ist täglich.	Enumeration (gesamt, täglich, stündlich)

Antworten

HTTP-Code	BESCHREIBUNG	Schema
200	OK	ClusterUsage

HTTP-Beispielanforderung

Anforderungspfad

/clusters/CLUSTER_NAME/usage

Beispiel für EINE HTTP-Antwort

Antwort 200

{
  "usage" : [ "object" ]
}

Listen der status von Vorgängen

GET /operations/

Parameter

type	Name	Beschreibung	Schema
Abfrage	request_id optional	Die Anforderungs-ID für den Vorgang. Wenn dies angegeben ist, enthält die Liste nur 0 oder 1 Element.	Zeichenfolge

Antworten

HTTP-Code	BESCHREIBUNG	Schema
200	OK	<OperationStatus> Array
400	Ungültige Anforderung	Kein Inhalt
404	Nicht gefunden	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

/operations/

HTTP-Beispielantwort

Antwort 200

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

Ruft den Vorgang status nach id ab.

GET /operations/{id}

Parameter

type	Name	Beschreibung	Schema
Pfad	id erforderlich	Die Vorgangs-ID	Zeichenfolge

Antworten

HTTP-Code	BESCHREIBUNG	Schema
200	OK	OperationStatus
404	Nicht gefunden	Kein Inhalt

HTTP-Beispielanforderung

Anforderungspfad

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

HTTP-Beispielantwort

Antwort 200

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

Ressourcen

ClusterStatus

Status des Clusters

Name	Beschreibung	Schema
maxCoreCount erforderlich	Die maximale Anzahl von Kernen, die diesem Cluster hinzugefügt werden können Beispiel : 16	integer
maxCount erforderlich	Die maximale Anzahl von Knoten, die diesem Cluster hinzugefügt werden können Beispiel : 4	integer
nodearrays erforderlich	Beispiel : [ "object" ]	<nodearrays> Array
Knoten optional	Eine optionale Liste der Knoten in diesem Cluster, die nur enthalten ist, wenn knoten=true in der Abfrage ist. Beispiel : [ "[node](#node)" ]	<Knoten> Array
state optional	Der aktuelle Status des Clusters, wenn er mindestens einmal gestartet wurde Beispiel : "Starting"	Zeichenfolge
targetState optional	Der gewünschte Status des Clusters (z. B. Gestartet oder Beendet) Beispiel : "Started"	Zeichenfolge

nodearrays

Name	Beschreibung	Schema
Eimer erforderlich	Jeder Bucket der Zuordnung für dieses nodearray. Die Einstellungen für die "Kernanzahl" sind immer ein Vielfaches der Kernanzahl für diesen Bucket. Beispiel : [ "object" ]	<Eimer> Array
maxCoreCount erforderlich	Die maximale Anzahl von Kernen, die sich in diesem Nodearray befinden können Beispiel : 16	integer
maxCount erforderlich	Die maximale Anzahl von Knoten, die sich in diesem nodearray befinden können. Beispiel : 4	integer
name erforderlich	Das nodearray, das hier beschrieben wird Beispiel : "execute"	Zeichenfolge
nodearray erforderlich	Die Attribute dieses Nodearrays Beispiel : "[node](#node)"	Node

Eimer

Name	Beschreibung	Schema
activeCoreCount erforderlich	Die Anzahl der Kerne, die für diesen Bucket in diesem nodearray verwendet werden. Beispiel : 40	integer
activeCount erforderlich	Die Anzahl der Knoten, die für diesen Bucket in diesem nodearray verwendet werden. Dies schließt Knoten ein, die noch einen virtuellen Computer abrufen. Beispiel : 10	integer
activeNodes optional	Die Knotennamen, die für diesen Bucket in diesem nodearray verwendet werden. Dies schließt Knoten ein, die noch einen virtuellen Computer abrufen. Dies ist nur enthalten, wenn knoten=true in der Abfrage enthalten ist. Beispiel : [ "string" ]	<Zeichenfolgenarray >
availableCoreCount erforderlich	Wie viele zusätzliche Kerne in diesem Bucket in diesem nodearray erstellt werden können. Immer ein Vielfaches von availableCount. Beispiel : 8	integer
availableCount erforderlich	Wie viele zusätzliche Knoten in diesem Bucket in diesem nodearray erstellt werden können. Beachten Sie, dass dies kleiner sein kann als von maxCount und usedCount impliziert, da maxCount global begrenzt sein kann. Beispiel : 2	integer
bucketId erforderlich	Der Bezeichner für diesen Bucket. Dies hat immer den gleichen Wert für einen bestimmten Bucket in einem Nodearray, solange der Cluster nicht gelöscht wird. Beispiel : "00000000-0000-0000-0000-000000000000"	Zeichenfolge
consumedCoreCount erforderlich	Die Anzahl der Kerne für diese Familie, die bereits in der gesamten Region verwendet werden. Beispiel : 2	integer
definition optional	Die Eigenschaften dieses Buckets, die zum Erstellen von Knoten aus diesem Bucket verwendet werden. Die API zum Erstellen von Knoten akzeptiert diese Definition in ihrer bucket -Eigenschaft. Beispiel : "object"	definition
familyConsumedCoreCount optional	Die Anzahl der Kerne für diese Familie, die bereits in der gesamten Region verwendet werden. Beispiel : 2	integer
familyQuotaCoreCount optional	Die Gesamtzahl der Kerne, die für diese Familie in dieser Region gestartet werden können. Dies ist möglicherweise kein ganzzahliges Vielfaches von quotaCount. Beispiel : 16	integer
familyQuotaCount optional	Die Anzahl der Insgesamtinstanzen, die gestartet werden können (gegeben unter familyQuotaCoreCount) Beispiel : 4	integer
invalidReason erforderlich	Wenn "valid" auf "false" festgelegt ist, enthält dies den Grund, warum der Bucket ungültig ist. Derzeit sind NotActivated und DisabledMachineType die einzigen Gründe. Beispiel : "DisabledMachineType"	Zeichenfolge
lastCapacityFailure erforderlich	Gibt an, wie lange in Sekunden seit dem letzten Kapazitätsausfall in diesem Bucket aufgetreten ist. Jeder negative Wert wird als nie behandelt. Beispiel : 180.0	number
maxCoreCount erforderlich	Die maximale Anzahl von Kernen, die sich in diesem Bucket befinden können, einschließlich globaler Und Nodearray-Grenzwerte. Immer ein Vielfaches von maxCount. Beispiel : 16	integer
maxCount erforderlich	Die maximale Anzahl von Knoten, die sich in diesem Bucket befinden können, einschließlich globaler grenzwerte und nodearray-Grenzwerte Beispiel : 4	integer
maxPlacementGroupCoreSize erforderlich	Die maximale Gesamtanzahl von Kernen, die sich in einer Platzierungsgruppe in diesem Bucket befinden können. Immer ein Vielfaches von maxPlacementGroupSize. Beispiel : 64	integer
maxPlacementGroupSize erforderlich	Die maximale Gesamtanzahl von Instanzen, die sich in einer Platzierungsgruppe in diesem Bucket befinden können Beispiel : 16	integer
placementGroups erforderlich	Die platzierungsgruppen, die für dieses nodearray verwendet werden, sofern vorhanden. Beispiel : [ "object" ]	<placementGroups> Array
quotaCoreCount erforderlich	Die Anzahl der Gesamtkerne, die für diese Familie in dieser Region gestartet werden können, wobei auch die regionale Anzahl der Kontingente berücksichtigt wird. Dies ist möglicherweise kein ganzzahliges Vielfaches von quotaCount. Beispiel : 16	integer
quotaCount erforderlich	Die Anzahl der Insgesamtinstanzen, die gestartet werden können (angegebene QuotaCoreCount) Beispiel : 4	integer
regionalConsumedCoreCount optional	Die Anzahl der Kerne, die bereits in der gesamten Region verwendet werden. Beispiel : 2	integer
regionalQuotaCoreCount optional	Die Anzahl der Gesamtkerne, die in dieser Region gestartet werden können. Dies ist möglicherweise kein ganzzahliges Vielfaches von regionalQuotaCount. Beispiel : 16	integer
regionalQuotaCount optional	Die Anzahl der Insgesamtinstanzen, die gestartet werden können (unter Angabe von regionalQuotaCoreCount) Beispiel : 4	integer
Gültig erforderlich	Wenn true, stellt dieser Bucket einen derzeit gültigen Bucket dar, der für neue Knoten verwendet werden soll. Wenn false, stellt dieser Bucket nur vorhandene Knoten dar. Beispiel : true	boolean
virtualMachine erforderlich	Die Eigenschaften der mit diesem Bucket gestarteten virtuellen Computer Beispiel : "object"	virtualMachine

Definition

Name	Beschreibung	Schema
machineType erforderlich	Die VM-Größe des virtuellen Computers Beispiel : "A2"	Zeichenfolge

placementGroups

Name	Beschreibung	Schema
activeCoreCount erforderlich	Wie viele Kerne sich in diesem Skalierungsset befinden Beispiel : 16	integer
activeCount erforderlich	Wie viele Knoten sich in diesem Skalierungsset befinden Beispiel : 4	integer
name erforderlich	Der eindeutige Bezeichner dieser Platzierungsgruppe Beispiel : "my-placement-group"	Zeichenfolge

virtualMachine

Name	Beschreibung	Schema
gpuCount erforderlich	Die Anzahl der GPUs, über die dieser Computertyp verfügt Beispiel : 2	integer
Infiniband erforderlich	Wenn dieser virtuelle Computer Die InfiniBand-Konnektivität unterstützt Beispiel : true	boolean
memory erforderlich	Der RAM auf diesem virtuellen Computer in GB Beispiel : 7.5	number
pcpuCount erforderlich	Die Anzahl der physischen CPUs, über die dieser Computertyp verfügt Beispiel : 16	integer
vcpuCount erforderlich	Die Anzahl der virtuellen CPUs, über die dieser Computertyp verfügt Beispiel : 32	integer
vcpuQuotaCount optional	Die Anzahl der vCPUs, die dieser Computer aus dem Kontingent verwendet Beispiel : 2	integer

ClusterUsage

Nutzungs- und optionale Kosteninformationen für den Cluster

Name	Beschreibung	Schema
Verwendung erforderlich	Eine Liste der Verwendungen nach Zeitintervall Beispiel : [ "object" ]	<Verwendung> Array

Verwendung

Name	Beschreibung	Schema
breakdown erforderlich	Aufschlüsselung der Nutzung in diesem Intervall nach Kategorie von "node" und "nodearray" Beispiel : [ "[clusterusageitem](#clusterusageitem)" ]	<ClusterUsageItem> Array
end erforderlich	Das Ende des Intervalls (exklusiv) Beispiel : "string"	Zeichenfolge
start erforderlich	Beginn des Intervalls (einschließlich) Beispiel : "string"	Zeichenfolge
total erforderlich	Die Gesamtnutzung für diesen Cluster in diesem Intervall mit der Kategorie "Cluster" Beispiel : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Name	Beschreibung	Schema
category erforderlich	"Cluster" für die Gesamtnutzung; "Knoten" für einen einzelnen Hauptknoten ohne Array; "nodearray" für ein ganzes Nodearray Beispiel : "string"	Enumeration (Cluster, Knoten, Nodearray)
cost optional	Der Betrag, der für diese Nutzung in Us-Dollar und zu Einzelhandelspreisen in Rechnung gestellt würde. Hinweis: Alle Kostenbeträge sind Schätzungen und spiegeln nicht die tatsächliche Rechnung wider! Beispiel : 0.0	number
details optional	Details zur VM-Größe, die von einem Nodearray verwendet wird, einschließlich Stunden, core_count, Regionspriorität und Betriebssystem. Beispiel : [ "object" ]	<Details> Array
hours erforderlich	Die Anzahl der Kernstunden der Nutzung für diese Kategorie Beispiel : 0.0	number
Node optional	Der Name des Knotens oder Nodearrays, für den die Verwendung verwendet wird (fehlt für Daten auf Clusterebene) Beispiel : "string"	Zeichenfolge

Details

Name	Beschreibung	Schema
core_count optional	Die Anzahl der Kerne in dieser VM-Größe Beispiel : 0.0	number
cost optional	Kosten für diese VM-Größe Beispiel : 0.0	number
hours optional	Die Anzahl der Kernstunden der Nutzung für diese VM-Größe Beispiel : 0.0	number
Os optional	Betriebssystemtyp Beispiel : "string"	Enumeration (Windows, Linux)
priority optional	Priorität der VM-SKU Beispiel : "string"	Enumeration (Normal, Spot)
Region optional	Die Region, in der die VM-Größe instanziiert wird Beispiel : "string"	Zeichenfolge
vm_size optional	VM-SKU-Größe Beispiel : "string"	Zeichenfolge

Node

Knotendatensatz

Typ : object

NodeCreationRequest

Gibt an, wie Knoten zu einem Cluster hinzugefügt werden.

Name	Beschreibung	Schema
Requestid optional	Optionales vom Benutzer bereitgestelltes eindeutiges Token, um doppelte Vorgänge bei Netzwerkkommunikationsfehlern zu verhindern. Wenn dies enthalten ist und einer früheren Anforderungs-ID entspricht, ignoriert der Server diese Anforderung und gibt einen Fehler 409 zurück. Beispiel : "00000000-0000-0000-0000-000000000000"	Zeichenfolge
Sets erforderlich	Eine Liste der zu erstellenden Knotendefinitionen. Die Anforderung muss mindestens einen Satz enthalten. Jede Gruppe kann einen anderen Satz von Eigenschaften angeben. Beispiel : [ "object" ]	<Legt> Array

Legt

Name	Beschreibung	Schema
count erforderlich	Die Anzahl der zu erstellenden Knoten Beispiel : 1	integer
definition optional	Die Definition des zu verwendenden Buckets. Dies wird vom Api-Aufruf des Clusters status bereitgestellt. Wenn einige der im status-Aufruf angegebenen Elemente fehlen oder die gesamte Bucketeigenschaft fehlt, wird der erste Bucket verwendet, der den angegebenen Elementen entspricht. Beispiel : "object"	definition
nameFormat optional	Falls angegeben, verwenden Knoten diese Namenskonvention anstelle des standardmäßigen "nodearray-%d"-Formats. Beispiel : "custom-name-%d"	Zeichenfolge
nameOffset optional	Wenn angegeben, versetzt nodeindex zusammen mit nameFormat für neue Knoten. Beispiel : 1	integer
nodeAttributes optional	Zusätzliche Attribute, die auf jedem Knoten aus dieser Gruppe festgelegt werden sollen Beispiel : "[node](#node)"	Node
nodearray erforderlich	Der Name des Knotenarrays, von dem Knoten gestartet werden sollen. Beispiel : "execute"	Zeichenfolge
placementGroupId optional	Wenn angegeben, werden Knoten mit demselben Wert für groupId alle in derselben Platzierungsgruppe gestartet. Beispiel : "string"	Zeichenfolge

Definition

Name	Beschreibung	Schema
machineType optional	Beispiel : "A2"	Zeichenfolge

NodeCreationResult

Name	Beschreibung	Schema
operationId erforderlich	Die ID dieses Vorgangs Beispiel : "00000000-0000-0000-0000-000000000000"	Zeichenfolge
Sets erforderlich	Ein Array von Sätzen in derselben Reihenfolge wie in der Anforderung Beispiel : [ "object" ]	<Legt> Array

Legt

Name	Beschreibung	Schema
Hinzugefügt erforderlich	Wie viele Knoten in diesem Satz gestartet wurden Beispiel : 1	integer
Nachricht optional	Gibt an, warum nicht alle angeforderten Knoten hinzugefügt werden konnten, falls vorhanden. Beispiel : "string"	Zeichenfolge

NodeList

Ergebnisse einer Knotensuche

Name	Beschreibung	Schema
Knoten erforderlich	Die zurückgegebenen Knoten Beispiel : [ "[node](#node)" ]	<Knoten> Array
operation optional	Wenn die Abfrage eine Vorgangs-ID enthält, ist dies die status dieses Vorgangs. Beispiel : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

Gibt an, wie Aktionen auf Knoten in einem Cluster ausgeführt werden. Es gibt mehrere Möglichkeiten, Knoten anzugeben, und wenn mehrere Wege enthalten sind, wird sie als Union behandelt.

Name	Beschreibung	Schema
filter optional	Ein Filterausdruck, der knotengleicht. Beachten Sie, dass Zeichenfolgen im Ausdruck ordnungsgemäß in Anführungszeichen gesetzt werden müssen. Beispiel : "State === \"Started\""	Zeichenfolge
Hostnamen optional	Eine Liste mit kurzen Hostnamen (ohne Domäne), die verwaltet werden sollen Beispiel : [ "hostname1", "hostname2" ]	<Zeichenfolgenarray >
ids optional	Eine Liste der zu verwaltenden Knoten-IDs Beispiel : [ "id1", "id2" ]	<Zeichenfolgenarray >
ip_addresses optional	Eine Liste der zu verwaltenden IP-Adressen Beispiel : [ "10.0.1.1", "10.1.1.2" ]	<Zeichenfolgenarray >
Namen optional	Eine Liste der zu verwaltenden Knotennamen Beispiel : [ "name1", "name2" ]	<Zeichenfolgenarray >
Requestid optional	Optionales vom Benutzer bereitgestelltes eindeutiges Token, um doppelte Vorgänge bei Netzwerkkommunikationsfehlern zu verhindern. Wenn dies enthalten ist und einer früheren Anforderungs-ID entspricht, ignoriert der Server diese Anforderung und gibt einen Fehler 409 zurück. Beispiel : "00000000-0000-0000-0000-000000000000"	Zeichenfolge

NodeManagementResult

Name	Beschreibung	Schema
Knoten erforderlich	Ein Array von Informationen zu jedem Knoten, der mit dem Filter in der Verwaltungsanforderung übereinstimmt. Die status jedes Knotens gibt an, ob er von der Anforderung betroffen war. Beispiel : [ "object" ]	<Knoten> Array
operationId erforderlich	Die ID dieses Vorgangs Beispiel : "00000000-0000-0000-0000-000000000000"	Zeichenfolge

Knoten

Name	Beschreibung	Schema
error optional	Wenn der status Fehler ist, enthält dies die Fehlermeldung. Beispiel : "This node must be terminated before it can be removed"	Zeichenfolge
id erforderlich	Die ID des Knotens Beispiel : "id1"	Zeichenfolge
name erforderlich	Der Name des Knotens Beispiel : "name1"	Zeichenfolge
status optional	Einer von OK oder Error Beispiel : "Error"	Enumeration (OK, Fehler)

OperationStatus

Die status dieses Knotenvorgangs

Name	Beschreibung	Schema
action erforderlich	Beispiel : "string"	Enumeration (erstellen)
startTime erforderlich	Zeitpunkt der Übermittlung dieses Vorgangs Beispiel : "2020-01-01T12:34:56Z"	string (Datum/Uhrzeit)