Opérations
Obtenir des nœuds de cluster
GET /clusters/{cluster}/nodes
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster à interroger | corde |
| de requête |
opération facultatif |
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 | corde |
| de requête |
request_id facultatif |
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 |
corde |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 200 | D’ACCORD | NodeList |
| 400 | Spécification non valide | Aucun contenu |
| 404 | Introuvable | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/nodes
Exemple de réponse HTTP
Réponse 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 nœud à un cluster. Il accepte plusieurs définitions de nœud dans un seul appel. Elle retourne l’URL à l’opération qui peut être utilisée pour suivre l’état de l’opération.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster à ajouter des nœuds à | corde |
| corps |
nœuds obligatoire |
Ensembles de nœuds à créer | NodeCreationRequest |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 202 | Accepté en-têtes : Location (chaîne) : URL de l’opération. |
NodeCreationResult |
| 409 | Entrée non valide | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/nodes/create
Corps de la demande
{
"requestId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
Exemple de réponse HTTP
Réponse 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. Les nœuds peuvent être identifiés de plusieurs façons, notamment le nom du nœud, l’ID de nœud ou par filtre.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster pour libérer des nœuds dans | corde |
| corps |
action obligatoire |
Description des nœuds à libérer | NodeManagementRequest |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 202 | Accepté en-têtes : Location (chaîne) : URL de l’opération. |
NodeManagementResult |
| 409 | Entrée non valide | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/nodes/deallocate
Corps de la demande
{
"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
Réponse 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. Les nœuds peuvent être identifiés de plusieurs façons, notamment le nom du nœud, l’ID de nœud ou par filtre. Notez que, par défaut, les nœuds sont supprimés lorsqu’ils sont arrêtés (sauf si le nœud a défini la valeur true), auquel cas cet appel n’est pas différent de l’arrêt.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster dans lequel supprimer des nœuds | corde |
| corps |
action obligatoire |
Description des nœuds à supprimer | NodeManagementRequest |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 202 | Accepté en-têtes : Location (chaîne) : URL de l’opération. |
NodeManagementResult |
| 409 | Entrée non valide | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/nodes/remove
Corps de la demande
{
"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
Réponse 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 des nœuds dans un cluster, selon que l’attribut ShutdownPolicy sur chaque nœud est Terminate (valeur par défaut) ou Désalloue, respectivement.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster dans lequel arrêter des nœuds | corde |
| corps |
action obligatoire |
Description des nœuds à arrêter | NodeManagementRequest |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 202 | Accepté en-têtes : Location (chaîne) : URL de l’opération. |
NodeManagementResult |
| 409 | Entrée non valide | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/nodes/shutdown
Corps de la demande
{
"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
Réponse 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. Les nœuds peuvent être identifiés de plusieurs façons, notamment le nom du nœud, l’ID de nœud ou par filtre.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster dans lequel démarrer des nœuds | corde |
| corps |
action obligatoire |
Description des nœuds à démarrer | NodeManagementRequest |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 202 | Accepté en-têtes : Location (chaîne) : URL de l’opération. |
NodeManagementResult |
| 409 | Entrée non valide | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/nodes/start
Corps de la demande
{
"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
Réponse 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. Les nœuds peuvent être identifiés de plusieurs façons, notamment le nom du nœud, l’ID de nœud ou par filtre.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster pour mettre fin aux nœuds dans | corde |
| corps |
action obligatoire |
Description des nœuds à arrêter | NodeManagementRequest |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 202 | Accepté en-têtes : Location (chaîne) : URL de l’opération. |
NodeManagementResult |
| 409 | Entrée non valide | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/nodes/terminate
Corps de la demande
{
"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
Réponse 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 en fonction des besoins à un nodearray pour atteindre un nombre total. La requête est traitée une seule fois et n’ajoute pas de nœuds ultérieurement pour conserver le nombre donné. Cette opération est mise à l’échelle en fonction du nombre total de cœurs ou de nœuds totaux, mais pas des deux. Elle retourne l’URL à l’opération qui peut être utilisée pour suivre l’état de l’opération.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster à ajouter des nœuds à | corde |
| chemin d’accès |
nodearray obligatoire |
Nodearray à ajouter des nœuds à | corde |
| de requête |
totalCoreCount facultatif |
Nombre total de cœurs à avoir dans ce nœud, y compris les nœuds déjà créés | entier |
| de requête |
totalNodeCount facultatif |
Nombre total d’ordinateurs à avoir dans ce nœud, y compris les nœuds déjà créés | entier |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 202 | Accepté en-têtes : Location (chaîne) : URL de l’opération. |
NodeCreationResult |
| 409 | Entrée non valide | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME
Exemple de réponse HTTP
Réponse 202
{
"operationId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
Obtenir l’état du cluster
GET /clusters/{cluster}/status
Description
Cette opération contient des informations sur les nœuds et les nœuds dans un cluster donné. Pour chaque nœud, il retourne l’état de chaque « compartiment » d’allocation qui peut être utilisé, par exemple le nombre de nœuds dans le compartiment, le nombre de plus pouvant être ajoutés, etc. Chaque compartiment est un ensemble de machines virtuelles possibles d’un profil matériel donné, qui peuvent être créées dans un emplacement donné, sous un compte client donné, etc. Les compartiments valides d’un nodearray sont déterminés par la définition du cluster de l’utilisateur, mais les limites sont déterminées en partie par le fournisseur de cloud.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster à interroger | corde |
| de requête |
nœuds facultatif |
Si la valeur est true, les nœuds et les références de nœud sont retournés dans la réponse | booléen |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 200 | D’ACCORD | ClusterStatus |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/status
Exemple de réponse HTTP
Réponse 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.
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès |
de cluster obligatoire |
Cluster pour lequel retourner les données d’utilisation pour | corde |
| de requête |
délai de facultatif |
Si elle est donnée, cela spécifie l’intervalle de temps à utiliser 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 au format UTC. | énumération (monthToDate, lastMonth, weekToDate, custom) |
| de requête |
de facultatif |
Pour les délais personnalisés, il s’agit du début de la période au format ISO-8601. Ceci est arrondi à l’heure ou à la journée la plus proche. | corde |
| de requête |
à facultatif |
Pour les délais personnalisés, il s’agit de la fin de la période au format ISO-8601. Ceci est arrondi à l’heure ou à la journée la plus proche. | corde |
| de requête |
granularité facultatif |
Spécifie comment agréger des données : par heure, par jour ou sous forme de nombre unique. Cette valeur par défaut est quotidienne. | enum (total, quotidien, horaire) |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 200 | D’ACCORD | clusterUsage |
Exemple de requête HTTP
Chemin d’accès de la demande
/clusters/CLUSTER_NAME/usage
Exemple de réponse HTTP
Réponse 200
{
"usage" : [ "object" ]
}
Répertorie l’état des opérations
GET /operations/
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| de requête |
request_id facultatif |
ID de demande de l’opération. Si cela est donné, la liste n’aura que 0 ou 1 élément. | corde |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 200 | D’ACCORD | tableau <OperationStatus> |
| 400 | Demande non valide | Aucun contenu |
| 404 | Introuvable | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/operations/
Exemple de réponse HTTP
Réponse 200
[ {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
} ]
Obtient l’état de l’opération par ID
GET /operations/{id}
Paramètres
| Type | Nom | Description | Schéma |
|---|---|---|---|
| chemin d’accès | id de obligatoire |
ID d’opération | corde |
Réponses
| HTTP Code | Description | Schéma |
|---|---|---|
| 200 | D’ACCORD | OperationStatus |
| 404 | Introuvable | Aucun contenu |
Exemple de requête HTTP
Chemin d’accès de la demande
/operations/00000000-0000-0000-0000-000000000000
Exemple de réponse HTTP
Réponse 200
{
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
Ressources
ClusterStatus
État du cluster
| Nom | Description | Schéma |
|---|---|---|
|
maxCoreCount obligatoire |
Nombre maximal de cœurs qui peuvent être ajoutés à ce cluster exemple : 16 |
entier |
|
maxCount obligatoire |
Nombre maximal de nœuds qui peuvent être ajoutés à ce cluster exemple : 4 |
entier |
|
nodearrays obligatoire |
exemple : [ "object" ] |
tableau <nodearrays> |
|
nœuds facultatif |
Liste facultative de nœuds dans ce cluster, incluse uniquement si node=true se trouve dans la requête exemple : [ "[node](#node)" ] |
tableau de |
|
d’état facultatif |
État actuel du cluster, s’il a été démarré au moins une fois exemple : "Starting" |
corde |
|
targetState facultatif |
État souhaité du cluster (par exemple Démarré ou terminé) exemple : "Started" |
corde |
| Nom | Description | Schéma |
|---|---|---|
| compartiments obligatoire |
Chaque compartiment d’allocation pour ce nœud. Les paramètres « nombre de cœurs » sont toujours un multiple du nombre de cœurs pour ce compartiment. exemple : [ "object" ] |
< compartiments> tableau |
|
maxCoreCount obligatoire |
Nombre maximal de cœurs qui peuvent se trouver dans ce nodearray exemple : 16 |
entier |
|
maxCount obligatoire |
Nombre maximal de nœuds qui peuvent se trouver dans ce nœud exemple : 4 |
entier |
|
nom obligatoire |
Le nodearray décrit exemple : "execute" |
corde |
|
nodearray obligatoire |
Attributs de ce nodearray exemple : "[node](#node)" |
nœud |
| Nom | Description | Schéma |
|---|---|---|
|
activeCoreCount obligatoire |
Nombre de cœurs utilisés pour ce compartiment, dans ce nodearray exemple : 40 |
entier |
|
activeCount obligatoire |
Nombre de nœuds utilisés pour ce compartiment, dans ce nœud. Cela inclut les nœuds qui acquièrent toujours une machine virtuelle. exemple : 10 |
entier |
|
activeNodes facultatif |
Noms de nœuds utilisés pour ce compartiment, dans ce nodearray. Cela inclut les nœuds qui acquièrent toujours une machine virtuelle. Cela n’est inclus que si node=true se trouve dans la requête. exemple : [ "string" ] |
tableau de chaînes >< |
|
availableCoreCount obligatoire |
Combien de cœurs supplémentaires peuvent être créés dans ce compartiment, dans ce nœud. Toujours un multiple de availableCount. exemple : 8 |
entier |
|
availableCount obligatoire |
Combien de nœuds supplémentaires peuvent être créés dans ce compartiment, dans ce nœud. Notez que cela peut être inférieur à celui implicite de maxCount et d’usedCount, car maxCount peut être limité globalement. exemple : 2 |
entier |
|
bucketId obligatoire |
Identificateur de ce compartiment. Cela aura toujours la même valeur pour un compartiment donné dans un nodearray, tant que le cluster n’est pas supprimé. exemple : "00000000-0000-0000-0000-000000000000" |
corde |
|
consomméCoreCount obligatoire |
Nombre de cœurs pour cette famille déjà utilisés dans toute la région. exemple : 2 |
entier |
|
définition facultatif |
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 propriété bucket. exemple : "object" |
définition |
|
familyConsumedCoreCount facultatif |
Nombre de cœurs pour cette famille déjà utilisés dans toute la région. exemple : 2 |
entier |
|
familyQuotaCoreCount facultatif |
Nombre total de cœurs qui peuvent être démarrés pour cette famille dans cette région. Il peut s’agir d’un multiple entier de quotaCount. exemple : 16 |
entier |
|
familyQuotaCount facultatif |
Nombre total d’instances pouvant être démarrées (en fonction de familyQuotaCoreCount) exemple : 4 |
entier |
|
invalidReason obligatoire |
Si la valeur est false, cela contient la raison pour laquelle le compartiment n’est pas valide. Actuellement, NotActivated et DisabledMachineType sont les seules raisons. exemple : "DisabledMachineType" |
corde |
|
lastCapacityFailure obligatoire |
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. exemple : 180.0 |
nombre |
|
maxCoreCount obligatoire |
Nombre maximal de cœurs qui peuvent se trouver dans ce compartiment, y compris les limites globales et nodearray. Toujours un multiple de maxCount. exemple : 16 |
entier |
|
maxCount obligatoire |
Nombre maximal de nœuds qui peuvent se trouver dans ce compartiment, y compris les limites globales et nodearray exemple : 4 |
entier |
|
maxPlacementGroupCoreSize obligatoire |
Nombre maximal de cœurs pouvant se trouver dans un groupe de placement dans ce compartiment. Toujours un multiple de maxPlacementGroupSize. exemple : 64 |
entier |
|
maxPlacementGroupSize obligatoire |
Nombre maximal d’instances pouvant se trouver dans un groupe de placement dans ce compartiment exemple : 16 |
entier |
|
placementGroups obligatoire |
Les groupes de placement utilisés pour ce nœud, le cas échéant. exemple : [ "object" ] |
tableau de groupes de placement <> |
|
quotaCoreCount obligatoire |
Nombre total de cœurs qui peuvent être démarrés pour cette famille dans cette région, en tenant compte également du nombre de cœurs de quota régional. Il peut s’agir d’un multiple entier de quotaCount. exemple : 16 |
entier |
|
quotaCount obligatoire |
Nombre total d’instances pouvant être démarrées (quotaCoreCount donné) exemple : 4 |
entier |
|
regionalConsumedCoreCount facultatif |
Nombre de cœurs déjà utilisés dans toute la région. exemple : 2 |
entier |
|
regionalQuotaCoreCount facultatif |
Nombre total de cœurs pouvant être démarrés dans cette région. Il peut ne pas s’agir d’un multiple entier de regionalQuotaCount. exemple : 16 |
entier |
|
regionalQuotaCount facultatif |
Nombre total d’instances pouvant être démarrées (étant donné regionalQuotaCoreCount) exemple : 4 |
entier |
|
valide obligatoire |
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. exemple : true |
booléen |
|
virtualMachine obligatoire |
Propriétés des machines virtuelles lancées à partir de ce compartiment exemple : "object" |
virtualMachine |
| Nom | Description | Schéma |
|---|---|---|
|
machineType obligatoire |
Taille de la machine virtuelle de la machine virtuelle exemple : "A2" |
corde |
| Nom | Description | Schéma |
|---|---|---|
|
activeCoreCount obligatoire |
Nombre de cœurs dans ce groupe identique exemple : 16 |
entier |
|
activeCount obligatoire |
Nombre de nœuds dans ce groupe de mise à l’échelle exemple : 4 |
entier |
|
nom obligatoire |
Identificateur unique de ce groupe de placement exemple : "my-placement-group" |
corde |
| Nom | Description | Schéma |
|---|---|---|
|
gpuCount obligatoire |
Le nombre de GPU dont ce type d’ordinateur a exemple : 2 |
entier |
|
infiniband obligatoire |
Si cette machine virtuelle prend en charge la connectivité InfiniBand exemple : true |
booléen |
|
de mémoire obligatoire |
Ram dans cette machine virtuelle, en Go exemple : 7.5 |
nombre |
|
pcpuCount obligatoire |
Nombre de processeurs physiques dont ce type d’ordinateur a exemple : 16 |
entier |
|
vcpuCount obligatoire |
Nombre de processeurs virtuels dont ce type de machine a exemple : 32 |
entier |
|
vcpuQuotaCount facultatif |
Nombre de processeurs virtuels que cette machine utilise à partir du quota exemple : 2 |
entier |
ClusterUsage
Informations sur l’utilisation et les coûts facultatifs pour le cluster
| Nom | Description | Schéma |
|---|---|---|
|
d’utilisation obligatoire |
Liste des utilisations par intervalle de temps exemple : [ "object" ] |
tableau de |
| Nom | Description | Schéma |
|---|---|---|
|
de répartition obligatoire |
Répartition de l’utilisation dans cet intervalle, par catégorie de « nœud » et « nodearray » exemple : [ "[clusterusageitem](#clusterusageitem)" ] |
tableau <ClusterUsageItem> |
|
de fin obligatoire |
Fin de l’intervalle (exclusif) exemple : "string" |
corde |
|
démarrer obligatoire |
Début de l’intervalle (inclusif) exemple : "string" |
corde |
|
total obligatoire |
Utilisation globale de ce cluster dans cet intervalle, avec une catégorie de « cluster » exemple : "[clusterusageitem](#clusterusageitem)" |
clusterUsageItem |
ClusterUsageItem
| Nom | Description | Schéma |
|---|---|---|
|
catégorie obligatoire |
« cluster » pour l’utilisation globale ; « node » pour un seul nœud principal non matricielle ; « nodearray » pour un nœud entier exemple : "string" |
enum (cluster, node, nodearray) |
|
coût facultatif |
Montant facturé 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 ! exemple : 0.0 |
nombre |
|
détails facultatif |
Détails de la taille de machine virtuelle utilisée par un nœud, notamment les heures, les core_count, la priorité de région et le système d’exploitation. exemple : [ "object" ] |
< tableau de détails> |
|
heures obligatoire |
Nombre d’heures d’utilisation principales pour cette catégorie exemple : 0.0 |
nombre |
|
nœud facultatif |
Le nom du nœud ou du nœud pour lequel l’utilisation est utilisée (absent pour les données au niveau du cluster) exemple : "string" |
corde |
| Nom | Description | Schéma |
|---|---|---|
|
core_count facultatif |
Nombre de cœurs dans cette taille de machine virtuelle exemple : 0.0 |
nombre |
|
coût facultatif |
Coût de cette taille de machine virtuelle exemple : 0.0 |
nombre |
|
heures facultatif |
Nombre d’heures d’utilisation principales pour cette taille de machine virtuelle exemple : 0.0 |
nombre |
|
os facultatif |
Type de système d’exploitation exemple : "string" |
énumération (Windows, Linux) |
| de priorité facultatif |
Priorité de la référence SKU de machine virtuelle exemple : "string" |
enum (normal, Spot) |
|
région facultatif |
La région dans laquelle la taille de machine virtuelle est instanciée exemple : "string" |
corde |
|
vm_size facultatif |
Taille de la référence SKU de machine virtuelle exemple : "string" |
corde |
Noeud
Un enregistrement de nœud
Type : objet
NodeCreationRequest
Spécifie comment ajouter des nœuds à un cluster
| Nom | Description | Schéma |
|---|---|---|
|
requestId facultatif |
Jeton unique fourni par l’utilisateur facultatif pour empêcher les opérations en double en cas d’erreurs de communication réseau. Si cela est inclus et correspond à un ID de requête antérieur, le serveur ignore cette requête et retourne une erreur 409. exemple : "00000000-0000-0000-0000-000000000000" |
corde |
|
ensembles de obligatoire |
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. exemple : [ "object" ] |
< définit> tableau |
| Nom | Description | Schéma |
|---|---|---|
|
nombre de obligatoire |
Nombre de nœuds à créer exemple : 1 |
entier |
|
définition facultatif |
Définition du compartiment à utiliser. Cela est fourni par l’appel de l’API d’état du cluster. Si certains des éléments donnés dans l’appel d’état sont manquants ou si la propriété de compartiment entière est manquante, le premier compartiment correspondant aux éléments donnés est utilisé. exemple : "object" |
définition |
|
nameFormat facultatif |
Si cela est donné, les nœuds utilisent cette convention d’affectation de noms au lieu du format standard « nodearray-%d» exemple : "custom-name-%d" |
corde |
|
nameOffset facultatif |
Si elle est donnée, ainsi que nameFormat, offsets nodeindex pour les nouveaux nœuds. exemple : 1 |
entier |
|
nodeAttributes facultatif |
Attributs supplémentaires à définir sur chaque nœud de cet ensemble exemple : "[node](#node)" |
nœud |
|
nodearray obligatoire |
Nom du nodearray à partir duquel démarrer des nœuds exemple : "execute" |
corde |
|
placementGroupId facultatif |
Si cela est donné, les nœuds ayant la même valeur pour groupId sont tous démarrés dans le même groupe de placement. exemple : "string" |
corde |
| Nom | Description | Schéma |
|---|---|---|
|
machineType facultatif |
exemple : "A2" |
corde |
NodeCreationResult
| Nom | Description | Schéma |
|---|---|---|
|
operationId obligatoire |
ID de cette opération exemple : "00000000-0000-0000-0000-000000000000" |
corde |
|
ensembles de obligatoire |
Tableau de jeux, dans le même ordre que dans la requête exemple : [ "object" ] |
< définit> tableau |
| Nom | Description | Schéma |
|---|---|---|
|
ajouté obligatoire |
Nombre de nœuds démarrés dans cet ensemble exemple : 1 |
entier |
|
message facultatif |
Indique pourquoi tous les nœuds demandés ne peuvent pas être ajoutés, le cas échéant exemple : "string" |
corde |
NodeList
Résultats d’une recherche de nœud
| Nom | Description | Schéma |
|---|---|---|
|
nœuds obligatoire |
Nœuds retournés exemple : [ "[node](#node)" ] |
tableau de |
|
opération facultatif |
Si la requête inclut un ID d’opération, il s’agit de l’état de cette opération exemple : "[operationstatus](#operationstatus)" |
OperationStatus |
NodeManagementRequest
Spécifie comment effectuer des actions sur des nœuds d’un cluster. Il existe plusieurs façons de spécifier des nœuds et, si plusieurs méthodes sont incluses, elle est traitée comme une union.
| Nom | Description | Schéma |
|---|---|---|
|
filtre facultatif |
Expression de filtre qui correspond aux nœuds. Notez que les chaînes de l’expression doivent être entre guillemets correctement. exemple : "State === \"Started\"" |
corde |
|
noms d’hôte facultatif |
Liste des noms d’hôte courts (sans domaine) à gérer exemple : [ "hostname1", "hostname2" ] |
tableau de chaînes >< |
| id de facultatif |
Liste des ID de nœud à gérer exemple : [ "id1", "id2" ] |
tableau de chaînes >< |
|
ip_addresses facultatif |
Liste des adresses IP à gérer exemple : [ "10.0.1.1", "10.1.1.2" ] |
tableau de chaînes >< |
| noms de facultatif |
Liste des noms de nœuds à gérer exemple : [ "name1", "name2" ] |
tableau de chaînes >< |
|
requestId facultatif |
Jeton unique fourni par l’utilisateur facultatif pour empêcher les opérations en double en cas d’erreurs de communication réseau. Si cela est inclus et correspond à un ID de requête antérieur, le serveur ignore cette requête et retourne une erreur 409. exemple : "00000000-0000-0000-0000-000000000000" |
corde |
NodeManagementResult
| Nom | Description | Schéma |
|---|---|---|
|
nœuds obligatoire |
Tableau d’informations sur chaque nœud qui correspond au filtre dans la demande de gestion. L’état de chaque nœud indique s’il a été affecté par la requête. exemple : [ "object" ] |
< tableau de nœuds> |
|
operationId obligatoire |
ID de cette opération exemple : "00000000-0000-0000-0000-000000000000" |
corde |
| Nom | Description | Schéma |
|---|---|---|
|
erreur facultatif |
Si l’état est Erreur, il contient le message d’erreur exemple : "This node must be terminated before it can be removed" |
corde |
| id de obligatoire |
ID du nœud exemple : "id1" |
corde |
|
nom obligatoire |
Nom du nœud exemple : "name1" |
corde |
|
d’état facultatif |
Une des erreurs ou OK exemple : "Error" |
énumération (OK, Erreur) |
OperationStatus
État de cette opération de nœud
| Nom | Description | Schéma |
|---|---|---|
|
action obligatoire |
exemple : "string" |
enum (create) |
|
startTime obligatoire |
Lorsque cette opération a été envoyée exemple : "2020-01-01T12:34:56Z" |
chaîne (date-heure) |