Extraction des clusters

Utilisez l'opération GET sur l'élément api/sam/clusters pour demander des informations sur les clusters qui regroupent vos systèmes informatiques hôte. Ces informations indiquent l'état actuel de votre environnement et n'incluent aucune donnée d'historique.

Après avoir extrait les ID de vos clusters, comparez-les à la colonne extraite par l'cluster_id API des systèmes informatiques afin d'identifier quel système appartient à quel cluster. Ces informations peuvent également être affichées dans le rapport Inventaire matériel de l'interface utilisateur.

Pour extraire des informations sur les clusters, utilisez l'URL suivante :

https://hostname:port/api/sam/clusters?token=token

Important :

Pour utiliser cette API, vous devez être affecté au groupe Tous les ordinateurs et disposer du droit Afficher l'inventaire matériel.
Chaque demande d'API doit être authentifiée avec le paramètre token. Vous pouvez l'extraire en utilisant l'API REST pour l'extraction du jeton d'authentification. Vous pouvez également vous connecter à BigFix Inventory, survoler l'icône Utilisateur et cliquer sur Profil. Cliquez ensuite sur Afficher le jeton.
Par défaut, les données extraites sont triées par id.

Tableau 1. Descriptions des opérations
Détails de l'opération	Description
Fonctionnement	`GET /api/sam/clusters`
Finalité	Renvoie la liste des clusters.
Méthode HTTP	`GET`
URI de resources	https://`server_host_name`:`port_number`/api/sam/clusters
Relation du lien de l'URL	n/a
Paramètres de requête URI	Pour une liste de paramètres de requêtes applicables, voir : Paramètres de requête.
En-têtes de demande	Fonction métier `Accept-Language` (Facultatif) Valeurs en-US (seul l'anglais est pris en charge) Sert à négocier la langue de la réponse. Si cet en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
Charge de la demande	Non disponible
Demande `Content-Type`	`application/json`
En-têtes de réponse	En-tête `Content-Type` Valeurs `application/json` Définit le type de contenu de la réponse.
	En-tête `Content-Language` Valeurs en-US, … Définit la langue du contenu de la réponse. Si cet en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
	En-tête `Import-Mode` Valeurs `none`, `idle`, `running`, `pending` Indique l'état d'importation des données.
	En-tête `Import-Progress` Valeurs Une valeur en pourcentage, par exemple `59`. Indique la progression en pourcentage d'une importation de données.
	En-tête `Import-Last-Status` Valeurs `successful`, `failed` Indique l'état de la dernière importation de données.
	En-tête `Import-Last-Success-Time` Valeurs Date, par exemple `2014-06-18T04:00:29Z`. Indique l'heure de la dernière importation de données qui a réussi.
Charge de la réponse	`Clusters` élément
Réponse`Content-Type`	`application/json`
Codes de réponse normaux HTTP	`200 – OK`
Codes de réponse HTTP d'erreur	`500 – "Bad Request"` si un paramètre de requête contient des erreurs ou est manquant Le corps du message comprend un message d'erreur détaillé.

Paramètres de requête

Vous pouvez utiliser des paramètres de requête pour limiter le nombre de résultats de votre recherche. Le tableau suivant présente les paramètres de requête que vous pouvez utiliser pour l'élément api/sam/clusters.

Tableau 2. Paramètres de requête pour l'extraction des clusters
Paramètre	Description	Requis	Valeur
columns	Indique les colonnes à extraire. Si vous n'indiquez pas ce paramètre, un ensemble de colonnes par défaut est extrait. Pour connaître les colonnes disponibles, voir Corps de réponse. Exemple : éxtrayez les colonnes name et id : `URL?columns[]=name&columns[]=id`	Non	Chaîne
order	Indiquez comment trier les données renvoyées. Le sens de tri par défaut des colonnes est croissant. Si vous souhaitez spécifier un tri par ordre décroissant, ajoutez `desc` au nom de la colonne. Exemple : Ordre par type décroissant : `URL?order[]=type desc`	Non	Chaîne
limit	Indiquez le nombre de lignes à extraire. Si vous omettez ce paramètre, toutes les lignes sont extraites.	Non	Numérique
décalage	Indiquez le nombre de lignes à ignorer pour extraire les résultats. Vous pouvez l'utiliser en même temps que le paramètre de limite pour mettre en page les résultats. Exemple : éxtrayez 50 enregistrements en commençant après l'enregistrement 150 : `URL?limit=50&offset=150`	Non	Numérique
Jeton	Identificateur d'authentification utilisateur unique. Vous pouvez afficher votre jeton dans les préférences du profil de BigFix Inventory.	Oui	Alphanumérique

Exemple de conversation HTTP

Demande

GET api/sam/clusters
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

En-tête de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US

L'en-tête de réponse ci-dessus peut être suivi par différentes entrées, en fonction de l'état actuel de l'importation de données qui est représentée par Import-Mode. Pour comprendre les valeurs renvoyées, voir les définitions suivantes :

none - aucune importation de données n'a été initiée
idle - aucune importation de données ne s'exécute actuellement
running - une importation de données est en cours
pending - une action exécutée dans l'interface utilisateur nécessite le démarrage d'une importation de données pour que le changement prenne effet

Si aucune importation de données n'a été initiée :

Import-Mode: none

Si une importation de données est en cours :

Import-Mode: running
Import-Progress: 41

Si aucune importation de données n'est en cours d'exécution :

Import-Mode: idle/pending
Import-Last-Status: successful
Import-Last-Success-Time: Mon, 23 Jun 2014 12:18:29 GMT

Corps de réponse (JSON)

{	
 "id": 1,
 "name": "Production Cluster 1",
 "cores_count": 24,
 "vm_manager_url": "https://198.51.100/sdk",
}

Exemple d'ajout d'une colonne vm_manager_status au résultat

API : /api/sam/clusters?columns[]=name&columns[]=cores_count&columns[]=vm_manager_url&columns[]=vm_manager_status

Réponse :

{
 {
   { 
     "id": 1,
     "name":
     "Production Cluster 1",
     "cores_count": 24, 
     "vm_manager_url":
     "https://198.51.100/sdk",
     "vm_manager_status": "98"
   }
 }
}

Exemple de filtrage des données des gestionnaires de machine virtuelle inactifs

API : api/sam/clusters?criteria=\

{
 "and":
  [
    [
      "vm_manager_status","!=","98"
    ]
   ]
}

Pour obtenir une description des autres statuts des gestionnaires de machine virtuelle, voir Extraction des gestionnaires de machine virtuelle.