Transaktionen

Abrufen von Clusterknoten

GET /clusters/{cluster}/nodes

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der abzufragende Cluster	Schnur
Abfrage-	Operation optionalen	Wenn angegeben, gibt nur die Knoten für diese Vorgangs-ID zurück und enthält das Operation-Attribut im Textkörper.	Schnur
Abfrage-	request_id optionalen	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.	Schnur

Antworten

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

Beispiel-HTTP-Anforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes

Beispiel-HTTP-Antwort

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 Knotenarray hinzu. Es akzeptiert mehrere Knotendefinitionen in einem einzigen Aufruf. Sie gibt die URL zu dem Vorgang zurück, der verwendet werden kann, um den Status des Vorgangs nachzuverfolgen.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der Cluster, dem Knoten hinzugefügt werden sollen	Schnur
Body-	Knoten erforderliche	Zu erstellende Knotengruppen	NodeCreationRequest-

Antworten

HTTP-Code	Beschreibung	Schema
202	Angenommen Kopfzeilen: Location (Zeichenfolge) : Die URL für den Vorgang.	NodeCreationResult-
409	Ungültige Eingabe	Kein Inhalt

Beispiel-HTTP-Anforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/create

Anforderungstext

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

Beispiel-HTTP-Antwort

Antwort 202

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

Clusterknoten mit Deallocate

POST /clusters/{cluster}/nodes/deallocate

Beschreibung

Mit diesem Vorgang werden Knoten in einem Cluster verwechselt. Die Knoten können auf verschiedene Arten identifiziert werden, einschließlich Knotenname, Knoten-ID oder nach Filter.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der Cluster, in dem Knoten zugeordnet werden sollen	Schnur
Body-	Aktion erforderliche	Beschreibung der Knoten, die verwechselt werden sollen	NodeManagementRequest-

Antworten

HTTP-Code	Beschreibung	Schema
202	Angenommen Kopfzeilen: Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult-
409	Ungültige Eingabe	Kein Inhalt

Beispiel-HTTP-Anforderung

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-HTTP-Antwort

Antwort 202

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

Beenden und Entfernen von Clusterknoten

POST /clusters/{cluster}/nodes/remove

Beschreibung

Mit diesem Vorgang werden Knoten in einem Cluster entfernt. Die Knoten können auf verschiedene Arten identifiziert werden, einschließlich Knotenname, Knoten-ID oder nach Filter. Beachten Sie, dass standardmäßig Knoten beim Beenden entfernt werden (es sei denn, der Knoten hat "Fixed" auf "true" festgelegt), in diesem Fall unterscheidet sich dieser Aufruf nicht von der Beendigung.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der Cluster zum Entfernen von Knoten in	Schnur
Body-	Aktion erforderliche	Beschreibung, welche Knoten entfernt werden sollen	NodeManagementRequest-

Antworten

HTTP-Code	Beschreibung	Schema
202	Angenommen Kopfzeilen: Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult-
409	Ungültige Eingabe	Kein Inhalt

Beispiel-HTTP-Anforderung

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

Dieser Vorgang beendet oder behandelt Knoten in einem Cluster, je nachdem, ob das ShutdownPolicy-Attribut auf jedem Knoten terminate (standard) oder Deallocate ist.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der Cluster zum Herunterfahren von Knoten in	Schnur
Body-	Aktion erforderliche	Beschreibung, welche Knoten heruntergefahren werden sollen	NodeManagementRequest-

Antworten

HTTP-Code	Beschreibung	Schema
202	Angenommen Kopfzeilen: Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult-
409	Ungültige Eingabe	Kein Inhalt

Beispiel-HTTP-Anforderung

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-HTTP-Antwort

Antwort 202

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

Start deallocated or terminated cluster nodes

POST /clusters/{cluster}/nodes/start

Beschreibung

Dieser Vorgang startet Knoten in einem Cluster. Die Knoten können auf verschiedene Arten identifiziert werden, einschließlich Knotenname, Knoten-ID oder nach Filter.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der Cluster zum Starten von Knoten in	Schnur
Body-	Aktion erforderliche	Beschreibung, welche Knoten gestartet werden sollen	NodeManagementRequest-

Antworten

HTTP-Code	Beschreibung	Schema
202	Angenommen Kopfzeilen: Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult-
409	Ungültige Eingabe	Kein Inhalt

Beispiel-HTTP-Anforderung

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

Beispiel-HTTP-Antwort

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, einschließlich Knotenname, Knoten-ID oder nach Filter.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der Cluster zum Beenden von Knoten in	Schnur
Body-	Aktion erforderliche	Beschreibung, welche Knoten beendet werden sollen	NodeManagementRequest-

Antworten

HTTP-Code	Beschreibung	Schema
202	Angenommen Kopfzeilen: Location (Zeichenfolge) : Die URL für den Vorgang.	NodeManagementResult-
409	Ungültige Eingabe	Kein Inhalt

Beispiel-HTTP-Anforderung

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

Beispiel-HTTP-Antwort

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 nach Bedarf zu einem Knotenarray hinzu, um eine Gesamtanzahl zu erreichen. Die Anforderung wird einmal verarbeitet und fügt später keine Knoten erneut hinzu, um die angegebene Zahl beizubehalten. Dies skaliert entweder nach Gesamtkernen oder Gesamtknoten, aber nicht um beide. Sie gibt die URL zu dem Vorgang zurück, der verwendet werden kann, um den Status des Vorgangs nachzuverfolgen.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der Cluster, dem Knoten hinzugefügt werden sollen	Schnur
Pfad-	nodearray- erforderliche	Das Knotenarray, dem Knoten hinzugefügt werden sollen	Schnur
Abfrage-	totalCoreCount- optionalen	Die Gesamtanzahl der Kerne, die in diesem Knotenarray enthalten sein sollen, einschließlich der bereits erstellten Knoten	ganze Zahl
Abfrage-	totalNodeCount- optionalen	Die Gesamtzahl der Computer, die in diesem Knotenarray vorhanden sind, einschließlich bereits erstellter Knoten	ganze Zahl

Antworten

HTTP-Code	Beschreibung	Schema
202	Angenommen Kopfzeilen: Location (Zeichenfolge) : Die URL für den Vorgang.	NodeCreationResult-
409	Ungültige Eingabe	Kein Inhalt

Beispiel-HTTP-Anforderung

Anforderungspfad

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Beispiel-HTTP-Antwort

Antwort 202

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

Clusterstatus abrufen

GET /clusters/{cluster}/status

Beschreibung

Dieser Vorgang enthält Informationen für die Knoten und Knotenarrays in einem bestimmten Cluster. Für jedes Knotenarray gibt er den Status jedes "Buckets" der Zuteilung zurück, die verwendet werden können, z. B. wie viele Knoten im Bucket vorhanden sind, wie viele weitere hinzugefügt werden können usw. Jeder Bucket ist eine Reihe möglicher VMs eines bestimmten Hardwareprofils, die an einem bestimmten Ort, unter einem bestimmten Kundenkonto usw. erstellt werden können. Die gültigen Buckets für ein Nodearray werden von der Clusterdefinition des Benutzers bestimmt, die Grenzwerte werden jedoch teilweise vom Cloudanbieter bestimmt.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der abzufragende Cluster	Schnur
Abfrage-	Knoten optionalen	Wenn wahr, werden Knoten- und Knotenverweise in der Antwort zurückgegeben.	boolesch

Antworten

HTTP-Code	Beschreibung	Schema
200	OKAY	ClusterStatus-

Beispiel-HTTP-Anforderung

Anforderungspfad

/clusters/CLUSTER_NAME/status

Beispiel-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 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.

Parameter

Art	Name	Beschreibung	Schema
Pfad-	Cluster- erforderliche	Der Cluster, der Nutzungsdaten für	Schnur
Abfrage-	Zeitrahmen optionalen	Wenn angegeben, gibt dies den Zeitraum an, der für die Abfrage verwendet werden soll. 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 Zeiten befinden sich in UTC.	Enumeration (monthToDate, lastMonth, weekToDate, custom)
Abfrage-	von optionalen	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 aufgerundet.	Schnur
Abfrage-	zum optionalen	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.	Schnur
Abfrage-	Granularität optionalen	Gibt an, wie Daten aggregiert werden: nach Stunde, täglich oder als einzelne Zahl. Diese Standardeinstellung ist täglich.	Enumeration (Summe, täglich, stündlich)

Antworten

HTTP-Code	Beschreibung	Schema
200	OKAY	ClusterUsage-

Beispiel-HTTP-Anforderung

Anforderungspfad

/clusters/CLUSTER_NAME/usage

Beispiel-HTTP-Antwort

Antwort 200

{
  "usage" : [ "object" ]
}

Listet den Status von Vorgängen auf.

GET /operations/

Parameter

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

Antworten

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

Beispiel-HTTP-Anforderung

Anforderungspfad

/operations/

Beispiel-HTTP-Antwort

Antwort 200

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

Ruft den Vorgangsstatus nach ID ab.

GET /operations/{id}

Parameter

Art	Name	Beschreibung	Schema
Pfad-	id erforderliche	Die Vorgangs-ID	Schnur

Antworten

HTTP-Code	Beschreibung	Schema
200	OKAY	OperationStatus-
404	Nicht gefunden	Kein Inhalt

Beispiel-HTTP-Anforderung

Anforderungspfad

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

Beispiel-HTTP-Antwort

Antwort 200

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

Betriebsmittel

ClusterStatus

Status des Clusters

Name	Beschreibung	Schema
maxCoreCount- erforderliche	Die maximale Anzahl von Kernen, die diesem Cluster hinzugefügt werden können Beispiel- : 16	ganze Zahl
maxCount- erforderliche	Die maximale Anzahl von Knoten, die diesem Cluster hinzugefügt werden können Beispiel- : 4	ganze Zahl
knotenarrays erforderliche	Beispiel- : [ "object" ]	< Knotenarrays> Arrays
Knoten optionalen	Eine optionale Liste von Knoten in diesem Cluster, nur enthalten, wenn knoten=true in der Abfrage enthalten ist. Beispiel- : [ "[node](#node)" ]	< Knotenarray>
Zustand optionalen	Der aktuelle Status des Clusters, wenn er mindestens einmal gestartet wurde Beispiel- : "Starting"	Schnur
targetState- optionalen	Der gewünschte Status des Clusters (z. B. "Gestartet" oder "Beendet") Beispiel- : "Started"	Schnur

knotenarrays

Name	Beschreibung	Schema
Buckets erforderliche	Jeder Bucket der Zuordnung für dieses Knotenarray. Die Einstellungen für die "Kernanzahl" sind immer ein Vielfaches der Kernanzahl für diesen Bucket. Beispiel- : [ "object" ]	< Buckets> Arrays
maxCoreCount- erforderliche	Die maximale Anzahl von Kernen, die sich in diesem Knotenarray befinden können Beispiel- : 16	ganze Zahl
maxCount- erforderliche	Die maximale Anzahl von Knoten, die sich in diesem Knotenarray befinden können Beispiel- : 4	ganze Zahl
Namen erforderliche	Das Knotenarray, das dies beschreibt Beispiel- : "execute"	Schnur
nodearray- erforderliche	Die Attribute dieses Knotenarrays Beispiel- : "[node](#node)"	Node-

Buckets

Name	Beschreibung	Schema
activeCoreCount- erforderliche	Die Anzahl der für diesen Bucket verwendeten Kerne in diesem Knotenarray Beispiel- : 40	ganze Zahl
activeCount- erforderliche	Die Anzahl der Knoten, die für diesen Bucket verwendet werden, in diesem Knotenarray. Dies schließt Knoten ein, die noch einen virtuellen Computer abrufen. Beispiel- : 10	ganze Zahl
activeNodes- optionalen	Die Knotennamen, die für diesen Bucket verwendet werden, in diesem Knotenarray. 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" ]	< Zeichenfolge > Array
availableCoreCount- erforderliche	Wie viele zusätzliche Kerne in diesem Bucket erstellt werden können, in diesem Knotenarray. Immer ein Vielfaches von availableCount. Beispiel- : 8	ganze Zahl
availableCount- erforderliche	Wie viele zusätzliche Knoten in diesem Bucket erstellt werden können, in diesem Knotenarray. Beachten Sie, dass dies weniger als impliziert von maxCount und usedCount sein kann, da maxCount global begrenzt sein kann. Beispiel- : 2	ganze Zahl
bucketId- erforderliche	Der Bezeichner für diesen Bucket. Dies hat immer denselben Wert für einen bestimmten Bucket in einem Knotenarray, solange der Cluster nicht gelöscht wird. Beispiel- : "00000000-0000-0000-0000-000000000000"	Schnur
"consumedCoreCount"- erforderliche	Die Anzahl der Kerne für diese Familie, die bereits in der gesamten Region verwendet werden. Beispiel- : 2	ganze Zahl
Definition optionalen	Die Eigenschaften dieses Buckets, die zum Erstellen von Knoten aus diesem Bucket verwendet werden. Die Create-Nodes-API verwendet diese Definition in der bucket-Eigenschaft. Beispiel- : "object"	Definition
familyConsumedCoreCount optionalen	Die Anzahl der Kerne für diese Familie, die bereits in der gesamten Region verwendet werden. Beispiel- : 2	ganze Zahl
familyQuotaCoreCount optionalen	Die Anzahl der Gesamtkerne, die für diese Familie in dieser Region gestartet werden können. Dies ist möglicherweise kein ganzzahliges Vielfaches von "quotaCount". Beispiel- : 16	ganze Zahl
FamilyQuotaCount optionalen	Die Anzahl der Gesamtinstanzen, die gestartet werden können (vorausgesetzt, familyQuotaCoreCount) Beispiel- : 4	ganze Zahl
invalidReason erforderliche	Ist "false" gültig, enthält dies den Grund, warum der Bucket ungültig ist. Derzeit sind NotActivated und DisabledMachineType die einzigen Gründe. Beispiel- : "DisabledMachineType"	Schnur
lastCapacityFailure erforderliche	Wie lange, in Sekunden, seit der letzten Zeit dieses Buckets einen Kapazitätsausfall erlebt hat. Jeder negative Wert wird nie behandelt. Beispiel- : 180.0	Zahl
maxCoreCount- erforderliche	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	ganze Zahl
maxCount- erforderliche	Die maximale Anzahl von Knoten, die sich in diesem Bucket befinden können, einschließlich globaler und Knotenarray-Grenzwerte Beispiel- : 4	ganze Zahl
maxPlacementGroupCoreSize erforderliche	Die maximale Gesamtanzahl der Kerne, die sich in einer Platzierungsgruppe in diesem Bucket befinden können. Immer ein Vielfaches von maxPlacementGroupSize. Beispiel- : 64	ganze Zahl
maxPlacementGroupSize- erforderliche	Die maximale Gesamtanzahl der Instanzen, die sich in einer Platzierungsgruppe in diesem Bucket befinden können Beispiel- : 16	ganze Zahl
placementGroups erforderliche	Die Platzierungsgruppen, die für dieses Knotenarray verwendet werden, falls vorhanden. Beispiel- : [ "object" ]	< placementGroups> Array
quotaCoreCount- erforderliche	Die Anzahl der Gesamtkerne, die für diese Familie in dieser Region gestartet werden können, wobei auch die anzahl der regionalen Quotenkerne berücksichtigt wird. Dies ist möglicherweise kein ganzzahliges Vielfaches von "quotaCount". Beispiel- : 16	ganze Zahl
quotaCount- erforderliche	Die Anzahl der Gesamtinstanzen, die gestartet werden können (angegebene quotaCoreCount) Beispiel- : 4	ganze Zahl
regionalConsumedCoreCount optionalen	Die Anzahl der Kerne, die bereits in der gesamten Region verwendet werden. Beispiel- : 2	ganze Zahl
regionalQuotaCoreCount optionalen	Die Anzahl der Gesamtkerne, die in dieser Region gestartet werden können. Dies ist möglicherweise kein ganzzahliges Vielfaches von regionalQuotaCount. Beispiel- : 16	ganze Zahl
regionalQuotaCount optionalen	Die Anzahl der Gesamtinstanzen, die gestartet werden können (je nach regionalQuotaCoreCount) Beispiel- : 4	ganze Zahl
gültige erforderliche	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. Beispiel- : true	boolesch
virtualMachine- erforderliche	Die Eigenschaften der virtuellen Computer, die aus diesem Bucket gestartet wurden Beispiel- : "object"	virtualMachine-

Definition

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

placementGroups

Name	Beschreibung	Schema
activeCoreCount- erforderliche	Anzahl der Kerne in dieser Skalierungsmenge Beispiel- : 16	ganze Zahl
activeCount- erforderliche	Anzahl der Knoten in dieser Skalierungsmenge Beispiel- : 4	ganze Zahl
Namen erforderliche	Der eindeutige Bezeichner dieser Platzierungsgruppe Beispiel- : "my-placement-group"	Schnur

virtualMachine-

Name	Beschreibung	Schema
gpuCount- erforderliche	Die Anzahl der GPUs, die dieser Computertyp hat Beispiel- : 2	ganze Zahl
infiniband erforderliche	Wenn dieser virtuelle Computer die InfiniBand-Konnektivität unterstützt Beispiel- : true	boolesch
Speicher erforderliche	Der RAM auf diesem virtuellen Computer in GB Beispiel- : 7.5	Zahl
pcpuCount- erforderliche	Die Anzahl der physischen CPUs, die dieser Computertyp hat Beispiel- : 16	ganze Zahl
vcpuCount- erforderliche	Die Anzahl der virtuellen CPUs, die dieser Computertyp hat Beispiel- : 32	ganze Zahl
vcpuQuotaCount optionalen	Die Anzahl der vCPUs, die dieser Computer aus dem Kontingent verwendet Beispiel- : 2	ganze Zahl

ClusterUsage

Nutzungs- und optionale Kosteninformationen für den Cluster

Name	Beschreibung	Schema
erforderliche	Eine Liste der Verwendungen nach Zeitintervall Beispiel- : [ "object" ]	< Verwendung> Arrays

Name	Beschreibung	Schema
Aufschlüsselung erforderliche	Die Aufschlüsselung der Verwendung in diesem Intervall nach Kategorie "node" und "nodearray" Beispiel- : [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> Array
enden erforderliche	Das Ende des Intervalls (exklusiv) Beispiel- : "string"	Schnur
starten erforderliche	Der Anfang des Intervalls (einschließlich) Beispiel- : "string"	Schnur
gesamt erforderliche	Die allgemeine Verwendung für diesen Cluster in diesem Intervall mit einer Kategorie von "Cluster" Beispiel- : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem-

ClusterUsageItem

Name	Beschreibung	Schema
Kategorie erforderliche	"Cluster" für die allgemeine Nutzung; "Knoten" für einen einzelnen Nicht-Array-Kopfknoten; "nodearray" für ein ganzes Knotenarray Beispiel- : "string"	Enumeration (Cluster, Knoten, Knotenarray)
Kosten optionalen	Der Betrag, der für diese Nutzung in US-Dollar und zu Einzelhandelspreisen in Rechnung gestellt werden würde. Hinweis: Alle Kostenbeträge sind Schätzungen und spiegeln nicht die tatsächliche Rechnung wider! Beispiel- : 0.0	Zahl
Details optionalen	Details zur VM-Größe, die von einem Knotenarray verwendet wird, einschließlich Stunden, core_count, Regionspriorität und Betriebssystem. Beispiel- : [ "object" ]	< Details> Arrays
Stunden erforderliche	Die Anzahl der Kernstunden der Nutzung für diese Kategorie Beispiel- : 0.0	Zahl
Knoten optionalen	Der Name des Knotens oder Knotenarrays, für den die Verwendung erforderlich ist (für Daten auf Clusterebene nicht vorhanden) Beispiel- : "string"	Schnur

Details

Name	Beschreibung	Schema
core_count optionalen	Die Anzahl der Kerne in dieser VM-Größe Beispiel- : 0.0	Zahl
Kosten optionalen	Kosten für diese VM-Größe Beispiel- : 0.0	Zahl
Stunden optionalen	Die Anzahl der Kernstunden der Nutzung für diese VM-Größe Beispiel- : 0.0	Zahl
os optionalen	Typ des Betriebssystems Beispiel- : "string"	Enumeration (Windows, Linux)
Priorität optionalen	Priorität der VM-Sku Beispiel- : "string"	Enumeration (Normal, Spot)
Region optionalen	Die Region, in der die VM-Größe instanziiert wird Beispiel- : "string"	Schnur
vm_size optionalen	VM-Sku-Größe Beispiel- : "string"	Schnur

Knoten

Ein Knotendatensatz

Type : object

NodeCreationRequest

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

Name	Beschreibung	Schema
requestId- optionalen	Optionales vom Benutzer bereitgestelltes eindeutiges Token, um doppelte Vorgänge im Falle von Netzwerkkommunikationsfehlern zu verhindern. Wenn dies enthalten ist und mit einer früheren Anforderungs-ID übereinstimmt, ignoriert der Server diese Anforderung und gibt einen Fehler vom Typ 409 zurück. Beispiel- : "00000000-0000-0000-0000-000000000000"	Schnur
legt erforderliche	Eine Liste der zu erstellenden Knotendefinitionen. Die Anforderung muss mindestens einen Satz enthalten. Jeder Satz kann einen anderen Satz von Eigenschaften angeben. Beispiel- : [ "object" ]	< legt> Array fest.

legt

Name	Beschreibung	Schema
anzahl erforderliche	Die Anzahl der zu erstellenden Knoten Beispiel- : 1	ganze Zahl
Definition optionalen	Die Definition des zu verwendenden Buckets. Dies wird vom Clusterstatus-API-Aufruf bereitgestellt. Wenn einige der im Statusaufruf angegebenen Elemente fehlen oder die gesamte Bucketeigenschaft fehlt, wird der erste Bucket verwendet, der mit den angegebenen Elementen übereinstimmt. Beispiel- : "object"	Definition
nameFormat- optionalen	Wenn angegeben, verwenden Knoten diese Benennungskonvention anstelle des standardmäßigen "nodearray-%d"-Formats. Beispiel- : "custom-name-%d"	Schnur
nameOffset- optionalen	Wenn angegeben, zusammen mit nameFormat, versetzt nodeindex für neue Knoten. Beispiel- : 1	ganze Zahl
nodeAttributes- optionalen	Zusätzliche Attribute, die für jeden Knoten aus diesem Satz festgelegt werden sollen Beispiel- : "[node](#node)"	Node-
nodearray- erforderliche	Der Name des Knotenarrays, von dem Knoten gestartet werden sollen Beispiel- : "execute"	Schnur
placementGroupId- optionalen	Wenn angegeben, werden Knoten mit demselben Wert für groupId alle in derselben Platzierungsgruppe gestartet. Beispiel- : "string"	Schnur

Definition

Name	Beschreibung	Schema
machineType- optionalen	Beispiel- : "A2"	Schnur

NodeCreationResult

Name	Beschreibung	Schema
operationId- erforderliche	Die ID dieses Vorgangs Beispiel- : "00000000-0000-0000-0000-000000000000"	Schnur
legt erforderliche	Ein Array von Sätzen in der gleichen Reihenfolge wie in der Anforderung Beispiel- : [ "object" ]	< legt> Array fest.

legt

Name	Beschreibung	Schema
hinzugefügt erforderliche	Wie viele Knoten in diesem Satz gestartet wurden Beispiel- : 1	ganze Zahl
nachricht optionalen	Gibt an, warum nicht alle angeforderten Knoten hinzugefügt werden konnten, falls vorhanden Beispiel- : "string"	Schnur

NodeList

Ergebnisse einer Knotensuche

Name	Beschreibung	Schema
Knoten erforderliche	Die zurückgegebenen Knoten Beispiel- : [ "[node](#node)" ]	< Knotenarray>
Operation optionalen	Wenn die Abfrage eine Vorgangs-ID enthält, ist dies der Status dieses Vorgangs. Beispiel- : "[operationstatus](#operationstatus)"	OperationStatus-

NodeManagementRequest

Gibt an, wie Aktionen für Knoten in einem Cluster ausgeführt werden. Es gibt mehrere Möglichkeiten zum Angeben von Knoten, und wenn mehr als eine Möglichkeit enthalten ist, wird sie als Vereinigung behandelt.

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

NodeManagementResult

Name	Beschreibung	Schema
Knoten erforderliche	Ein Array von Informationen zu jedem Knoten, der dem Filter in der Verwaltungsanforderung entspricht. Der Status jedes Knotens gibt an, ob er von der Anforderung betroffen war. Beispiel- : [ "object" ]	< Knoten> Arrays
operationId- erforderliche	Die ID dieses Vorgangs Beispiel- : "00000000-0000-0000-0000-000000000000"	Schnur

Knoten

Name	Beschreibung	Schema
Fehler optionalen	Wenn der Status "Fehler" lautet, enthält dies die Fehlermeldung. Beispiel- : "This node must be terminated before it can be removed"	Schnur
id erforderliche	Die ID des Knotens Beispiel- : "id1"	Schnur
Namen erforderliche	Der Name des Knotens Beispiel- : "name1"	Schnur
Status optionalen	Einer von "OK" oder "Fehler" Beispiel- : "Error"	Enumeration (OK, Fehler)

OperationStatus

Der Status dieses Knotenvorgangs

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