Operations

Obtenir des nœuds de cluster

GET /clusters/{cluster}/nodes

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster à interroger	string
Query	operation optional	Si elle est donnée, retourne uniquement les nœuds de cet ID d’opération et inclut l’attribut d’opération sur le corps	string
Query	request_id optional	Si elle est donnée, retourne uniquement les nœuds de l’opération identifiée par cet ID de requête, et inclut l’attribut d’opération sur le corps	string

Responses

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

Exemple de requête HTTP

Request path

/clusters/CLUSTER_NAME/nodes

Exemple de réponse HTTP

Response 200

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

Créer des nœuds de cluster

POST /clusters/{cluster}/nodes/create

Description

Cette opération ajoute de nouveaux nœuds d’un tableau de nœuds à un cluster. Il accepte plusieurs définitions de nœud dans un seul appel. Elle retourne l’URL à l’opération que vous pouvez utiliser pour suivre l’état de l’opération.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster à ajouter des nœuds à	string
Body	nodes required	Ensembles de nœuds à créer	NodeCreationRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (chaîne) : URL de l’opération.	NodeCreationResult
409	Invalid input	No Content

Exemple de requête HTTP

Request path

/clusters/CLUSTER_NAME/nodes/create

Request body

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

Exemple de réponse HTTP

Response 202

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

Libérer des nœuds de cluster

POST /clusters/{cluster}/nodes/deallocate

Description

Cette opération libère des nœuds dans un cluster. Vous pouvez identifier les nœuds à l’aide de plusieurs méthodes, notamment le nom du nœud, l’ID de nœud ou un filtre.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster dans lequel vous souhaitez libérer des nœuds	string
Body	action required	Description des nœuds à libérer	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (chaîne) : URL de l’opération.	NodeManagementResult
409	Invalid input	No Content

Exemple de requête HTTP

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

Exemple de réponse HTTP

Response 202

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

Terminer et supprimer des nœuds de cluster

POST /clusters/{cluster}/nodes/remove

Description

Cette opération supprime les nœuds d’un cluster. Vous pouvez identifier les nœuds de plusieurs façons, notamment le nom du nœud, l’ID de nœud ou à l’aide d’un filtre. Par défaut, les nœuds sont supprimés lorsqu’ils sont arrêtés, sauf si la Fixed propriété est définie truesur le nœud . Dans ce cas, cet appel agit de la même façon qu’il se termine.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster dans lequel vous souhaitez supprimer des nœuds	string
Body	action required	Description des nœuds à supprimer	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (chaîne) : URL de l’opération.	NodeManagementResult
409	Invalid input	No Content

Exemple de requête HTTP

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

Exemple de réponse HTTP

Response 202

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

Arrêter ou libérer des nœuds de cluster

POST /clusters/{cluster}/nodes/shutdown

Description

Cette opération met fin ou désalloue les nœuds dans un cluster. L’opération utilise l’attribut ShutdownPolicy sur chaque nœud pour déterminer l’action. Si l’attribut est défini Terminate sur (valeur par défaut), l’opération met fin au nœud. Si l’attribut est défini Deallocatesur , l’opération libère le nœud.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster dans lequel vous souhaitez arrêter des nœuds	string
Body	action required	Description des nœuds à arrêter	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (chaîne) : URL de l’opération.	NodeManagementResult
409	Invalid input	No Content

Exemple de requête HTTP

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

Exemple de réponse HTTP

Response 202

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

Démarrer les nœuds de cluster désalloués ou arrêtés

POST /clusters/{cluster}/nodes/start

Description

Cette opération démarre les nœuds d’un cluster. Vous pouvez identifier les nœuds par nom de nœud, ID de nœud ou à l’aide d’un filtre.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster dans lequel démarrer des nœuds	string
Body	action required	Description des nœuds à démarrer	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (chaîne) : URL de l’opération.	NodeManagementResult
409	Invalid input	No Content

Exemple de requête HTTP

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

Exemple de réponse HTTP

Response 202

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

Arrêter les nœuds de cluster

POST /clusters/{cluster}/nodes/terminate

Description

Cette opération met fin aux nœuds d’un cluster. Vous pouvez identifier les nœuds de plusieurs façons, notamment le nom du nœud, l’ID de nœud ou à l’aide d’un filtre.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster dans lequel vous souhaitez arrêter les nœuds	string
Body	action required	Description des nœuds à arrêter	NodeManagementRequest

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (chaîne) : URL de l’opération.	NodeManagementResult
409	Invalid input	No Content

Exemple de requête HTTP

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

Exemple de réponse HTTP

Response 202

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

Mettre à l’échelle le cluster à la taille

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

Description

Cette opération ajoute des nœuds selon les besoins à un tableau de nœuds pour atteindre un nombre total. Le cluster traite la requête une seule fois. Il n’ajoute pas de nœuds ultérieurement pour conserver le nombre. Vous pouvez effectuer une mise à l’échelle en fonction du nombre total de cœurs ou de nœuds totaux, mais pas des deux. L’opération retourne l’URL à utiliser pour suivre l’état de l’opération.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster à ajouter des nœuds à	string
Path	nodearray required	Tableau de nœuds auquel ajouter des nœuds	string
Query	totalCoreCount optional	Nombre total de cœurs dans ce tableau de nœuds, y compris les nœuds que vous avez déjà créés	integer
Query	totalNodeCount optional	Nombre total d’ordinateurs dans ce tableau de nœuds, y compris les nœuds que vous avez déjà créés	integer

Responses

HTTP Code	Description	Schema
202	Accepted Headers : Location (chaîne) : URL de l’opération.	NodeCreationResult
409	Invalid input	No Content

Exemple de requête HTTP

Request path

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Exemple de réponse HTTP

Response 202

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

Obtenir l’état du cluster

GET /clusters/{cluster}/status

Description

Cette opération retourne des informations pour les nœuds et les tableaux de nœuds dans un cluster. Pour chaque tableau de nœuds, il retourne l’état de chaque « compartiment » d’allocation que vous pouvez utiliser. L’état indique le nombre de nœuds dans le compartiment et le nombre de nœuds que vous pouvez ajouter. Chaque compartiment est un ensemble de machines virtuelles possibles avec un profil matériel spécifique. Vous pouvez créer ces machines virtuelles dans un emplacement spécifique sous un compte client. La définition du cluster de l’utilisateur détermine les compartiments valides d’un tableau de nœuds. Le fournisseur de cloud détermine les limites.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster à interroger	string
Query	nodes optional	Si la valeur est true, la réponse inclut des nœuds et des références de nœud	boolean

Responses

HTTP Code	Description	Schema
200	OK	ClusterStatus

Exemple de requête HTTP

Request path

/clusters/CLUSTER_NAME/status

Exemple de réponse HTTP

Response 200

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

Obtenir des informations sur l’utilisation et les coûts facultatifs pour un cluster

GET /clusters/{cluster}/usage

Description

Cette opération retourne des données d’utilisation globales (heures principales) et des données de coût, le cas échéant, pour le cluster, ainsi qu’une répartition par nœud. Par défaut, elle retourne la valeur d’utilisation du mois actuel.

Parameters

Type	Name	Description	Schema
Path	cluster required	Cluster pour lequel retourner les données d’utilisation pour	string
Query	timeframe optional	Intervalle de temps pour la requête. monthToDate retourne l’utilisation pour le mois en cours, et lastMonth retourne l’utilisation pour le mois précédent. weekToDate retourne l’utilisation de la semaine en cours (à compter du dimanche). personnalisé requiert des paramètres de requête « from » et « to ». La valeur par défaut est MonthToDate. Toutes les heures sont exprimées en heure UTC.	énumération (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Pour les délais personnalisés, début de la période au format ISO-8601. La valeur est arrondie à l’heure ou au jour le plus proche.	string
Query	to optional	Pour les délais personnalisés, utilisez la fin de la période au format ISO-8601. La valeur arrondit jusqu’à l’heure ou au jour le plus proche.	string
Query	granularity optional	Spécifie comment agréger des données : par heure, par jour ou sous forme de nombre unique. La valeur par défaut est quotidienne.	enum (total, quotidien, horaire)

Responses

HTTP Code	Description	Schema
200	OK	ClusterUsage

Exemple de requête HTTP

Request path

/clusters/CLUSTER_NAME/usage

Exemple de réponse HTTP

Response 200

{
  "usage" : [ "object" ]
}

Répertorie l’état des opérations

GET /operations/

Parameters

Type	Name	Description	Schema
Query	request_id optional	ID de demande de l’opération. Si vous fournissez cet ID, la liste contient zéro ou un élément.	string

Responses

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

Exemple de requête HTTP

Request path

/operations/

Exemple de réponse HTTP

Response 200

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

Obtient l’état de l’opération par ID

GET /operations/{id}

Parameters

Type	Name	Description	Schema
Path	id required	ID d’opération	string

Responses

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

Exemple de requête HTTP

Request path

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

Exemple de réponse HTTP

Response 200

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

ClusterStatus

État du cluster.

Name	Description	Schema
maxCoreCount required	Nombre maximal de cœurs que vous pouvez ajouter à ce cluster. Example : 16	integer
maxCount required	Nombre maximal de nœuds que vous pouvez ajouter à ce cluster. Example : 4	integer
nodearrays required	Example : [ "object" ]	< nodearrays> array
nodes optional	Liste facultative de nœuds dans ce cluster. La réponse inclut cette liste uniquement si vous définissez nodes=true dans la requête. Example : [ "[node](#node)" ]	< Node> array
state optional	État actuel du cluster, si le cluster a démarré au moins une fois Example : "Starting"	string
targetState optional	État souhaité du cluster (par exemple, Démarré ou Terminé) Example : "Started"	string

nodearrays

Name	Description	Schema
buckets required	Chaque compartiment d’allocation pour ce tableau de nœuds. Les paramètres « nombre de cœurs » sont toujours un multiple du nombre de cœurs pour ce compartiment. Example : [ "object" ]	< buckets> array
maxCoreCount required	Nombre maximal de cœurs dans ce tableau de nœuds Example : 16	integer
maxCount required	Nombre maximal de nœuds dans ce tableau de nœuds Example : 4	integer
name required	Nom du tableau de nœuds Example : "execute"	string
nodearray required	Attributs de ce tableau de nœuds Example : "[node](#node)"	Node

buckets

Name	Description	Schema
activeCoreCount required	Nombre de cœurs utilisés pour ce compartiment, dans ce tableau de nœuds Example : 40	integer
activeCount required	Nombre de nœuds utilisés pour ce compartiment, dans ce tableau de nœuds. Ce nombre inclut les nœuds qui acquièrent toujours une machine virtuelle. Example : 10	integer
activeNodes optional	Noms de nœuds utilisés pour ce compartiment, dans ce tableau de nœuds. Cette liste inclut les nœuds qui acquièrent toujours une machine virtuelle. La réponse inclut cette propriété uniquement si la requête contient nodes=true. Example : [ "string" ]	<tableau de chaînes >
availableCoreCount required	Nombre de cœurs supplémentaires que vous pouvez créer dans ce compartiment et ce tableau de nœuds. Cette valeur est toujours un multiple de availableCount. Example : 8	integer
availableCount required	Nombre de nœuds supplémentaires que vous pouvez créer dans ce compartiment et ce tableau de nœuds. Cette valeur peut être inférieure au nombre que vous obtenez lorsque vous soustraitez usedCountmaxCount, car maxCount peut avoir une limite globale. Example : 2	integer
bucketId required	Identificateur de ce compartiment. Cette valeur reste la même pour un compartiment donné dans un tableau de nœuds tant que vous ne supprimez pas le cluster. Example : "00000000-0000-0000-0000-000000000000"	string
consumedCoreCount required	Nombre de cœurs pour cette famille déjà utilisés dans toute la région. Example : 2	integer
definition optional	Propriétés de ce compartiment, utilisées pour créer des nœuds à partir de ce compartiment. L’API create-nodes prend cette définition dans sa bucket propriété. Example : "object"	definition
familyConsumedCoreCount optional	Nombre de cœurs pour cette famille déjà utilisés dans toute la région. Example : 2	integer
familyQuotaCoreCount optional	Nombre total de cœurs que vous pouvez commencer pour cette famille dans cette région. Ce nombre peut ne pas être un multiple entier de quotaCount. Example : 16	integer
familyQuotaCount optional	Nombre total d’instances que vous pouvez démarrer lorsque vous définissez familyQuotaCoreCount. Example : 4	integer
invalidReason required	Si la valeur est false, le champ contient la raison pour laquelle le compartiment n’est pas valide. Actuellement, NotActivated et DisabledMachineType sont les seules raisons. Example : "DisabledMachineType"	string
lastCapacityFailure required	Durée, en secondes, depuis la dernière fois que ce compartiment a rencontré un échec de capacité. Toute valeur négative est traitée comme jamais. Example : 180.0	number
maxCoreCount required	Nombre maximal de cœurs pouvant se trouver dans ce compartiment, y compris les limites globales et nodearray. Toujours un multiple de maxCount. Example : 16	integer
maxCount required	Nombre maximal de nœuds pouvant se trouver dans ce compartiment, y compris les limites globales et nodearray Example : 4	integer
maxPlacementGroupCoreSize required	Nombre total maximal de cœurs dans un groupe de placement pour ce compartiment. Toujours un multiple de maxPlacementGroupSize. Example : 64	integer
maxPlacementGroupSize required	Nombre maximal d’instances dans un groupe de placement pour ce compartiment. Example : 16	integer
placementGroups required	Les groupes de placement utilisés pour ce tableau de nœuds, le cas échéant. Example : [ "object" ]	< placementGroups> array
quotaCoreCount required	Nombre total de cœurs que vous pouvez commencer pour cette famille dans cette région. Ce nombre prend également en compte le nombre de cœurs de quota régional. Cette valeur peut ne pas être un multiple entier de quotaCount. Example : 16	integer
quotaCount required	Nombre total d’instances que vous pouvez démarrer, en fonction du quotaCoreCount. Example : 4	integer
regionalConsumedCoreCount optional	Nombre de cœurs déjà utilisés dans toute la région. Example : 2	integer
regionalQuotaCoreCount optional	Nombre total de cœurs que vous pouvez démarrer dans cette région. Ce nombre peut ne pas être un multiple entier de regionalQuotaCount. Example : 16	integer
regionalQuotaCount optional	Nombre total d’instances que vous pouvez démarrer (en fonction de regionalQuotaCoreCount) Example : 4	integer
valid required	Si la valeur est true, ce compartiment représente un compartiment actuellement valide à utiliser pour les nouveaux nœuds. Si la valeur est false, ce compartiment représente uniquement les nœuds existants. Example : true	boolean
virtualMachine required	Propriétés des machines virtuelles que vous lancez à partir de ce compartiment Example : "object"	virtualMachine

definition

Name	Description	Schema
machineType required	Taille de la machine virtuelle de la machine virtuelle Example : "A2"	string

placementGroups

Name	Description	Schema
activeCoreCount required	Nombre de cœurs dans ce groupe identique Example : 16	integer
activeCount required	Nombre de nœuds dans ce groupe identique Example : 4	integer
name required	Identificateur unique de ce groupe de placement Example : "my-placement-group"	string

virtualMachine

Name	Description	Schema
gpuCount required	Le nombre de GPU dont ce type d’ordinateur a Example : 2	integer
infiniband required	Si cette machine virtuelle prend en charge la connectivité InfiniBand Example : true	boolean
memory required	Ram dans cette machine virtuelle, en Go Example : 7.5	number
pcpuCount required	Nombre de processeurs physiques dont ce type d’ordinateur a Example : 16	integer
vcpuCount required	Nombre de processeurs virtuels pour ce type d’ordinateur Example : 32	integer
vcpuQuotaCount optional	Nombre de processeurs virtuels que cette machine utilise à partir du quota Example : 2	integer

ClusterUsage

Informations sur l’utilisation et les coûts facultatifs pour le cluster

Name	Description	Schema
usage required	Liste des utilisations par intervalle de temps Example : [ "object" ]	< usage> array

usage

Name	Description	Schema
breakdown required	Répartition de l’utilisation dans cet intervalle, par catégorie de « nœud » et « nodearray » Example : [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> array
end required	Fin de l’intervalle (exclusif) Example : "string"	string
start required	Début de l’intervalle (inclusif) Example : "string"	string
total required	Utilisation globale de ce cluster dans cet intervalle, avec une catégorie de « cluster » Example : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Name	Description	Schema
category required	« cluster » pour l’utilisation globale ; « node » pour un seul nœud principal non matricielle ; « nodearray » pour un nœud entier Example : "string"	enum (cluster, node, nodearray)
cost optional	Montant à facturer pour cette utilisation, en dollars américains et aux tarifs de vente au détail. Remarque : tous les montants des coûts sont des estimations et ne reflètent pas la facture réelle ! Example : 0.0	number
details optional	Détails de la taille de machine virtuelle utilisée par un nodearray, y compris les heures, le nombre de cœurs, la priorité de région et le système d’exploitation. Example : [ "object" ]	< details> array
hours required	Nombre d’heures d’utilisation principales pour cette catégorie Example : 0.0	number
node optional	Le nom du nœud ou du tableau de nœuds pour lequel l’utilisation est utilisée (absent pour les données au niveau du cluster) Example : "string"	string

details

Name	Description	Schema
core_count optional	Nombre de cœurs dans cette taille de machine virtuelle Example : 0.0	number
cost optional	Coût de cette taille de machine virtuelle Example : 0.0	number
hours optional	Nombre d’heures d’utilisation principales pour cette taille de machine virtuelle Example : 0.0	number
os optional	Type de système d’exploitation Example : "string"	énumération (Windows, Linux)
priority optional	Priorité de la référence SKU de machine virtuelle Example : "string"	enum (normal, Spot)
region optional	Région où vous instanciez la taille de la machine virtuelle Example : "string"	string
vm_size optional	Taille de la référence SKU de machine virtuelle Example : "string"	string

Node

Enregistrement de nœud.

Type : object

NodeCreationRequest

Spécifie comment ajouter des nœuds à un cluster.

Name	Description	Schema
requestId optional	Jeton unique fourni par l’utilisateur facultatif pour empêcher les opérations en double en cas d’erreurs de communication réseau. Si le serveur reçoit une demande avec une requestId demande qui correspond à une demande antérieure, elle ignore la requête et retourne une erreur 409. Example : "00000000-0000-0000-0000-000000000000"	string
sets required	Liste des définitions de nœud à créer. La demande doit contenir au moins un ensemble. Chaque jeu peut spécifier un ensemble de propriétés différent. Example : [ "object" ]	< sets> array

sets

Name	Description	Schema
count required	Nombre de nœuds à créer Example : 1	integer
definition optional	Définition du compartiment à utiliser. L’appel de l’API d’état du cluster fournit cette définition. Si la définition manque certains éléments donnés dans l’appel d’état ou la propriété de compartiment entier, le premier compartiment qui correspond aux éléments donnés est utilisé. Example : "object"	definition
nameFormat optional	Si vous fournissez cette valeur, les nœuds utilisent cette convention d’affectation de noms au lieu du format standard nodearray-%d Example : "custom-name-%d"	string
nameOffset optional	Si vous fournissez cette propriété nameFormat, les décalages de propriété pour les nodeindex nouveaux nœuds. Example : 1	integer
nodeAttributes optional	Attributs supplémentaires à définir sur chaque nœud de cet ensemble Example : "[node](#node)"	Node
nodearray required	Nom des nodearray nœuds de démarrage à partir de Example : "execute"	string
placementGroupId optional	Si vous fournissez cette propriété, les nœuds ayant la même valeur pour groupId tous les débuts dans le même groupe de placement. Example : "string"	string

definition

Name	Description	Schema
machineType optional	Example : "A2"	string

NodeCreationResult

Name	Description	Schema
operationId required	ID de l’opération Example : "00000000-0000-0000-0000-000000000000"	string
sets required	Tableau de jeux, dans le même ordre que dans la requête Example : [ "object" ]	< sets> array

sets

Name	Description	Schema
added required	Nombre de nœuds à ajouter dans l’ensemble Example : 1	integer
message optional	Explique pourquoi le système ne peut pas ajouter tous les nœuds demandés, le cas échéant Example : "string"	string

NodeList

Résultats d’une recherche de nœud

Name	Description	Schema
nodes required	Nœuds retournés par le système Example : [ "[node](#node)" ]	< Node> array
operation optional	Si la requête inclut un ID d’opération, ce champ affiche l’état de cette opération Example : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

Spécifie comment effectuer des actions sur des nœuds d’un cluster. Vous pouvez spécifier des nœuds de plusieurs façons. Si vous incluez plusieurs façons, la demande traite la spécification en tant qu’union.

Name	Description	Schema
filter optional	Expression de filtre qui correspond aux nœuds. Notez que les chaînes de l’expression doivent être entre guillemets correctement. Example : "State === \"Started\""	string
hostnames optional	Liste des noms d’hôte courts (sans domaine) à gérer Example : [ "hostname1", "hostname2" ]	<tableau de chaînes >
ids optional	Liste des ID de nœud à gérer Example : [ "id1", "id2" ]	<tableau de chaînes >
ip_addresses optional	Liste des adresses IP à gérer Example : [ "10.0.1.1", "10.1.1.2" ]	<tableau de chaînes >
names optional	Liste des noms de nœuds à gérer Example : [ "name1", "name2" ]	<tableau de chaînes >
requestId optional	Jeton unique fourni par l’utilisateur facultatif pour empêcher les opérations en double en cas d’erreurs de communication réseau. Si le serveur reçoit une demande avec un requestId ID de requête antérieur, il ignore la requête et retourne une erreur 409. Example : "00000000-0000-0000-0000-000000000000"	string

NodeManagementResult

Name	Description	Schema
nodes required	Tableau d’informations sur chaque nœud qui correspond au filtre dans la demande de gestion. L’état de chaque nœud indique si la demande l’affecte. Example : [ "object" ]	< nodes> array
operationId required	ID de cette opération Example : "00000000-0000-0000-0000-000000000000"	string

nodes

Name	Description	Schema
error optional	Si l’état est Error, le message d’erreur Example : "This node must be terminated before it can be removed"	string
id required	ID du nœud Example : "id1"	string
name required	Nom du nœud Example : "name1"	string
status optional	Une des erreurs ou OK Example : "Error"	énumération (OK, Erreur)

OperationStatus

État de l’opération de nœud.

Name	Description	Schema
action required	Example : "string"	enum (create)
startTime required	Lorsque vous avez envoyé l’opération Example : "2020-01-01T12:34:56Z"	string (date-time)