Operations

Azure CycleCloud stellt eine REST-API zum programmgesteuerten Verwalten von Clustern, Knoten und verwandten Ressourcen bereit. Verwenden Sie diese API-Vorgänge, um den Clusterstatus abzufragen, Knoten zu erstellen und zu verwalten und lange ausgeführte Vorgänge nachzuverfolgen. In dieser Referenz werden die verfügbaren Endpunkte, Parameter und Antwortformate aufgelistet, die Ihnen beim Automatisieren und Integrieren der CycleCloud-Clusterverwaltung in Ihre Workflows helfen.

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 Vorgangsattribut im Textkörper.	string

Responses

HTTP-Code	Description	Schema
200	OK	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

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, der verwendet werden kann, 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	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

Description

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.

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

Clusterknoten neu abbilden

POST /clusters/{cluster}/nodes/reimage

Description

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

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster zum Umbilden von Knoten in	string
Body	action required	Beschreibung, welche Knoten neu abbilden sollen	NodeManagementRequest

Responses

HTTP-Code	Description	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/reimage

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

Description

Mit diesem Vorgang werden Knoten in einem Cluster entfernt. Sie können die Knoten anhand des Knotennamens, der Knoten-ID oder des Filters identifizieren. Standardmäßig entfernt CycleCloud Knoten beim Beenden, sodass sich dieser Aufruf wie "terminate" verhält. Knoten mit festgelegtem Fixed-Attribut auf "true" werden beim Beenden nicht entfernt.

Parameters

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

Responses

HTTP-Code	Description	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"
}

Neustarten von Clusterknoten

POST /clusters/{cluster}/nodes/restart

Description

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

Parameters

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

Responses

HTTP-Code	Description	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/restart

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

Description

Dieser Aufruf beendet Knoten in einem Cluster. Das ShutdownPolicy-Attribut jedes Knotens beschließt die Aktion: Beenden (Standard) oder Deallocate.

Parameters

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

Responses

HTTP-Code	Description	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

Description

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

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

Description

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

Parameters

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

Responses

HTTP-Code	Description	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"
}

Senden des Gaststatusberichts für clusterknoten

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

Description

Übermitteln eines Integritätsberichts für einen Knoten mit einem Integritätsproblem

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, der den zu meldenden Knoten enthält	string
Path	node required	Der zu meldende Knoten	string
Query	category optional	Kategorie "Gastintegritätsbericht" für die Auswirkungen	string
Query	Beschreibung optional	Benutzerdefinierte Meldung, die den Fehler oder Kontext beschreibt	string

Responses

HTTP-Code	Description	Schema
202	Zulässig	Kein Inhalt
400	Ungültige Eingabe	Kein Inhalt
404	Nicht gefunden	Kein Inhalt
409	Konflikt – Der Gaststatusbericht wurde bereits für diesen Knoten übermittelt.	Kein Inhalt

Beispiel-HTTP-Anforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/string/ghr

Abrufen des Gaststatusberichts für Clusterknoten

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

Description

Gibt die Auswirkungen der Workload eines Knotens mit einem Integritätsproblem zurück, sodass Sie ihn an den Endpunkt für die Integritätsberichterstattung übermitteln können.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der Cluster, der den zu meldenden Knoten enthält	string
Path	node required	Der zu meldende Knoten	string
Query	category optional	Kategorie "Gastintegritätsbericht" für die Auswirkungen	string
Query	Beschreibung optional	Benutzerdefinierte Meldung, die den Fehler oder Kontext beschreibt	string

Responses

HTTP-Code	Description	Schema
200	Okay	Kein Inhalt
400	Ungültige Eingabe	Kein Inhalt
404	Nicht gefunden	Kein Inhalt

Beispiel-HTTP-Anforderung

Anforderungspfad

/clusters/CLUSTER_NAME/nodes/string/ghr

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. Die Anforderung wird einmal verarbeitet und fügt später keine Knoten erneut hinzu, um die angegebene Zahl beizubehalten. Geben Sie die Zielgröße entweder mithilfe totalCoreCount von (CPU-Kernen insgesamt) oder (Gesamt-VMs) an totalNodeCount , aber nicht beide in derselben Anforderung. Sie gibt die URL zu dem Vorgang zurück, den Sie zum Nachverfolgen des Status verwenden können.

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 Gesamtanzahl der Kerne, die in diesem Knotenarray enthalten sein sollen, einschließlich der bereits erstellten Knoten	integer
Query	totalNodeCount optional	Die Gesamtzahl der Computer, die in diesem Knotenarray vorhanden sind, einschließlich bereits erstellter Knoten	integer

Responses

HTTP-Code	Description	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

Description

Dieser Vorgang enthält Informationen für die Knoten und Knotenarrays in einem bestimmten Cluster. Für jedes Knotenarray gibt er den Status jeder verfügbaren Zuordnung "Bucket" zurück. Der Status enthält die aktuelle Knotenanzahl im Bucket und wie viele weitere Knoten Sie hinzufügen können. Jeder Bucket ist eine Reihe möglicher VMs eines bestimmten Hardwareprofils, das an einem bestimmten Ort unter einem bestimmten Kundenkonto erstellt werden kann usw. Die Clusterdefinition des Benutzers bestimmt die gültigen Buckets für ein Knotenarray, aber der Cloudanbieter bestimmt teilweise die Grenzwerte.

Parameters

Type	Name	Description	Schema
Path	cluster required	Der abzufragende Cluster	string
Query	nodes optional	Wenn wahr, werden Knoten- und Knotenverweise in der Antwort zurückgegeben.	boolean

Responses

HTTP-Code	Description	Schema
200	OK	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

Description

Dieser Vorgang gibt allgemeine Nutzungsdaten (Kernstunden) und Kostendaten (sofern verfügbar) für den Cluster und eine Aufschlüsselung pro Knotenmatrix 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	Zeitrahmen optional	Der zeitbereich, der für die Abfrage verwendet werden soll. Gültige Werte: monthToDate (aktueller Monat), lastMonth (vorheriger Monat), weekToDate (aktuelle Woche, Start Sonntag) oder custom (erfordert die from Parameter und to Abfrageparameter). Der Standardwert lautet monthToDate. Alle Zeitangaben sind in UTC.	Enumeration (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Bei benutzerdefinierten Zeitrahmen ist dieser Wert der Anfang des Zeitrahmens im ISO-8601-Format. Sie wird auf die nächste Stunde oder den nächsten Tag aufgerundet.	string
Query	to optional	Bei benutzerdefinierten Zeitrahmen ist dieser Wert das Ende des Zeitrahmens im ISO-8601-Format. Sie wird auf die nächste Stunde oder den nächsten Tag aufgerundet.	string
Query	Granularität optional	Gibt an, wie Daten aggregiert werden: stündlich, täglich oder als einzelne Summe. Das Standardintervall ist täglich.	Enumeration (Summe, täglich, stündlich)

Responses

HTTP-Code	Description	Schema
200	OK	ClusterUsage

Beispiel-HTTP-Anforderung

Anforderungspfad

/clusters/CLUSTER_NAME/usage

Beispiel-HTTP-Antwort

Antwort 200

{
  "usage" : [ "object" ]
}

Auflisten des Status von Vorgängen

GET /operations/

Parameters

Type	Name	Description	Schema
Query	request_id optional	Die Anforderungs-ID für den Vorgang. Wenn dieser Wert angegeben wird, enthält die Liste 0 oder 1 Element.	string

Responses

HTTP-Code	Description	Schema
200	OK	< 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}

Parameters

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

Responses

HTTP-Code	Description	Schema
200	OK	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"
}

Azure CycleCloud definiert eine Reihe von Ressourcenmodellen, die Cluster, Knotenarrays, Knoten und Zuordnungsstatus beschreiben. Diese Ressourcen werden von der REST-API zurückgegeben und geben Details wie Kapazitätsbeschränkungen, Nutzung und Clusterstatus an. Verwenden Sie diesen Verweis, um die Struktur und Eigenschaften von API-Antworten beim programmgesteuerten Verwalten und Überwachen von CycleCloud-Clustern zu verstehen.

ClusterStatus

Status des Clusters

Name	Description	Schema
maxCoreCount required	Die maximale Anzahl von Kernen, die diesem Cluster hinzugefügt werden können Beispiel : 16	integer
maxCount required	Die maximale Anzahl von Knoten, die diesem Cluster hinzugefügt werden können Beispiel : 4	integer
nodearrays required	Beispiel : [ "object" ]	< nodearrays> Array
nodes optional	Eine optionale Liste von Knoten in diesem Cluster, nur enthalten, wenn knoten=true in der Abfrage enthalten ist. Beispiel : [ "[node](#node)" ]	< Knoten> Array
state optional	Der aktuelle Status des Clusters, verfügbar nach mindestens einem Start Beispiel : "Starting"	string
targetState optional	Der gewünschte Status des Clusters (z. B. "Gestartet" oder "Beendet") Beispiel : "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. Beispiel : [ "object" ]	< Eimer> Array
maxCoreCount required	Die maximale Anzahl von Kernen, die sich in diesem Knotenarray befinden können Beispiel : 16	integer
maxCount required	Die maximale Anzahl von Knoten, die sich in diesem Knotenarray befinden können Beispiel : 4	integer
name required	Der Name des Knotenarrays Beispiel : "execute"	string
nodearray required	Die Attribute dieses Knotenarrays Beispiel : "[node](#node)"	Node

Eimer

Name	Description	Schema
activeCoreCount required	Die Anzahl der für diesen Bucket verwendeten Kerne in diesem Knotenarray Beispiel : 40	integer
activeCount required	Die Anzahl der Knoten, die für diesen Bucket verwendet werden, in diesem Knotenarray. Diese Zahl enthält Knoten, die noch einen virtuellen Computer abrufen. Beispiel : 10	integer
activeNodes optional	Namen der Knoten, die für diesen Bucket innerhalb des Knotenarrays verwendet werden, einschließlich Knoten, die noch einen virtuellen Computer abrufen. Wird nur zurückgegeben, wenn die Abfrage knoten=true enthält. Beispiel : [ "string" ]	<Zeichenfolgenarray >
availableCoreCount required	Wie viele zusätzliche Kerne in diesem Bucket erstellt werden können, in diesem Knotenarray. Immer ein Vielfaches von availableCount. Beispiel : 8	integer
availableCount required	Die Anzahl zusätzlicher Knoten, die in diesem Bucket innerhalb des Knotenarrays erstellt werden können. Der Wert kann niedriger als maxCount minus usedCount sein, da maxCount er möglicherweise durch einen globalen Grenzwert begrenzt wird. Beispiel : 2	integer
bucketId required	Der eindeutige Bezeichner für den Bucket. Der Wert bleibt für einen bestimmten Bucket in einem Knotenarray für die Lebensdauer des Clusters identisch. Beispiel : "00000000-0000-0000-0000-000000000000"	string
consumedCoreCount required	Die Anzahl der Kerne für diese Familie, die bereits in der gesamten Region verwendet werden. Beispiel : 2	integer
definition optional	Die Eigenschaften, die zum Erstellen von Knoten aus diesem Bucket verwendet werden. Die Create-Nodes-API verwendet 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 VM-Familie in der Region ausgeführt werden können. Der Wert ist nicht unbedingt ein ganzzahliges Vielfaches von familyQuotaCount. Beispiel : 16	integer
familyQuotaCount optional	Die Anzahl der Gesamtinstanzen, die gestartet werden können (vorausgesetzt, familyQuotaCoreCount) Beispiel : 4	integer
invalidReason required	Der Grund, warum der Bucket ungültig ist, wenn valid "false" ist. Derzeit sind NotActivated die einzigen möglichen Werte und DisabledMachineType. Beispiel : "DisabledMachineType"	string
lastCapacityFailure required	Die Anzahl der Sekunden, seit dieser Bucket einen Kapazitätsausfall verursacht hat. Jeder negative Wert wird nie behandelt. Beispiel : 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. Beispiel : 16	integer
maxCount required	Die maximale Anzahl von Knoten, die sich in diesem Bucket befinden können, einschließlich globaler und Knotenarray-Grenzwerte Beispiel : 4	integer
maxPlacementGroupCoreSize required	Die maximale Gesamtanzahl der Kerne, die sich in einer Platzierungsgruppe in diesem Bucket befinden können. Immer ein Vielfaches von maxPlacementGroupSize. Beispiel : 64	integer
maxPlacementGroupSize required	Die maximale Gesamtanzahl der Instanzen, die sich in einer Platzierungsgruppe in diesem Bucket befinden können Beispiel : 16	integer
placementGroups required	Die Platzierungsgruppen, die für dieses Knotenarray verwendet werden, falls vorhanden. Beispiel : [ "object" ]	< placementGroups> Array
quotaCoreCount required	Die Gesamtzahl der Kerne, die für diese VM-Familie in der Region ausgeführt werden können, wobei die anzahl der regionalen Kontingentkerne berücksichtigt wird. Der Wert ist nicht unbedingt ein ganzzahliges Vielfaches von quotaCount. Beispiel : 16	integer
quotaCount required	Die Anzahl der Gesamtinstanzen, 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 Gesamtzahl der Kerne, die in der Region ausgeführt werden können. Der Wert ist nicht unbedingt ein ganzzahliges Vielfaches von regionalQuotaCount. Beispiel : 16	integer
regionalQuotaCount optional	Die Anzahl der Gesamtinstanzen, die gestartet werden können (je nach regionalQuotaCoreCount) Beispiel : 4	integer
spotPlacementScore required	Spotplatzierungsbewertung für diesen Bucket, der die Wahrscheinlichkeit der Verfügbarkeit von Spot-VM angibt. Kann hoch, mittel, niedrig oder eine leere Zeichenfolge sein, falls nicht zutreffend. Beispiel : "High"	string
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. Beispiel : true	boolean
virtualMachine required	Die Eigenschaften der virtuellen Computer, die aus diesem Bucket gestartet wurden Beispiel : "object"	virtualMachine

Definition

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

placementGroups

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

virtualMachine

Name	Description	Schema
gpuCount required	Die Anzahl der GPUs, die dieser Computertyp hat Beispiel : 2	integer
Infiniband required	Wenn dieser virtuelle Computer die InfiniBand-Konnektivität unterstützt Beispiel : true	boolean
memory required	Der RAM auf diesem virtuellen Computer in GB Beispiel : 7.5	number
pcpuCount required	Die Anzahl der physischen CPUs, die dieser Computertyp hat Beispiel : 16	integer
vcpuCount required	Die Anzahl der virtuellen CPUs, die dieser Computertyp hat 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	Description	Schema
usage required	Eine Liste der Verwendungen nach Zeitintervall Beispiel : [ "object" ]	< Verwendung> Array

Verwendung

Name	Description	Schema
Aufschlüsselung required	Die Aufschlüsselung der Verwendung in diesem Intervall nach Kategorie "node" und "nodearray" Beispiel : [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> Array
end required	Das Ende des Intervalls (exklusiv) Beispiel : "string"	string
start required	Der Anfang des Intervalls (einschließlich) Beispiel : "string"	string
total required	Die allgemeine Verwendung für diesen Cluster in diesem Intervall mit einer Kategorie von "Cluster" Beispiel : "[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 Beispiel : "string"	Enumeration (Cluster, Knoten, Knotenarray)
cost optional	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	number
details optional	Details zur VM-Größe, die von einem Knotenarray verwendet wird, einschließlich Stunden, core_count, Region, Priorität und Betriebssystem. Beispiel : [ "object" ]	< Details> Array
hours required	Die Anzahl der Kernstunden der Nutzung für diese Kategorie Beispiel : 0.0	number
node optional	Der Name des Knotens oder Knotenarrays, für den die Verwendung erforderlich ist (für Daten auf Clusterebene nicht vorhanden) Beispiel : "string"	string

Details

Name	Description	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	Typ des Betriebssystems 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"	string
vm_size optional	VM-SKU-Größe Beispiel : "string"	string

Node

Ein Knotendatensatz

Typ: Objekt

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 zu verhindern, wenn Netzwerkkommunikationsfehler auftreten. Wenn dieser Wert 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"	string
Legt required	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

Legt

Name	Description	Schema
count required	Die Anzahl der zu erstellenden Knoten Beispiel : 1	integer
definition optional	Die Definition des zu verwendenden Buckets, bereitgestellt vom Clusterstatus-API-Aufruf. 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 optional	Wenn angegeben, verwenden Knoten diese Benennungskonvention anstelle des standardmäßigen "nodearray-%d"-Formats. Beispiel : "custom-name-%d"	string
nameOffset optional	Wenn angegeben, wird zusammen mit nameFormat der Knotenindex für neue Knoten versetzt. Beispiel : 1	integer
nodeAttributes optional	Zusätzliche Attribute, die für jeden Knoten aus diesem Satz festgelegt werden sollen Beispiel : "[node](#node)"	Node
nodearray required	Der Name des Knotenarrays, von dem Knoten gestartet werden sollen Beispiel : "execute"	string
placementGroupId optional	Wenn angegeben, beginnen Knoten mit demselben Wert für groupId alle in derselben Platzierungsgruppe. Beispiel : "string"	string

Definition

Name	Description	Schema
machineType optional	Beispiel : "A2"	string

NodeCreationResult

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

Legt

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

NodeList

Ergebnisse einer Knotensuche

Name	Description	Schema
nodes required	Die zurückgegebenen Knoten Beispiel : [ "[node](#node)" ]	< Knoten> Array
operation optional	Der Status eines Vorgangs, wenn die Abfrage eine Vorgangs-ID enthält 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	Description	Schema
filter optional	Ein Filterausdruck, der Knoten entspricht. Zeichenfolgen im Ausdruck müssen richtig zitiert werden. Beispiel : "State === \"Started\""	string
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 zu verhindern, wenn Netzwerkkommunikationsfehler auftreten. Wenn dieser Wert 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"	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 die Anforderung davon betroffen ist. Beispiel : [ "object" ]	< Knoten> Array
operationId required	Die ID dieses Vorgangs Beispiel : "00000000-0000-0000-0000-000000000000"	string

Knoten

Name	Description	Schema
error optional	Die Fehlermeldung, wenn status dies der Fehler ist Error. Beispiel : "This node must be terminated before it can be removed"	string
id required	Die ID des Knotens Beispiel : "id1"	string
name required	Der Name des Knotens Beispiel : "name1"	string
status optional	Einer von "OK" oder "Fehler" Beispiel : "Error"	Enumeration (OK, Fehler)

OperationStatus

Der Status dieses Knotenvorgangs

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