Manuels d'intégration › Manuel de référence de l'API de service Web › Objets valides › Objet group › Méthode get (objet group)

Méthode get (objet group)

Description

Affiche des informations concernant le groupe. Ces informations incluent : le nom du groupe, l'ID, la portée, la description et les membres principaux du groupe.

Syntaxe

/api/v2/group/get?group=group&vdc=controller-name 

Arguments

groupe

Nom du groupe

vdc

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemples

Créer un groupe local nommé mygroup

GET
http://192.168.123.200/api/v2/group/create?group=mygroup&vdc=mygrid

Récupérer les informations sur le groupe mygroup

GET
http://192.168.123.200/api/v2/group/get?group=mygroup&vdc=mygrid

Exemple de sortie

JSON

{
   "group" : {
      "can_own" : "0",
      "name" : "mygroup",
      "id" : "1c534f9d-e26d-41e8-922f-4649743b9e98",
      "description" : "",
      "scope" : "local"
   }
}

XML

<group>
  <can_own>0</can_own>
  <description></description>
  <id>1c534f9d-e26d-41e8-922f-4649743b9e98</id>
  <name>mygroup</name>
  <scope>local</scope>
</group>

Codes d'erreur HTTP

400

L'entité vdc mygrid est introuvable.
- Le nom de VDC spécifié n'est pas configuré dans l'application WS_API.

400.4

Missing required arguments (app).
- Argument group=group missing.

Remarque : Cette API est disponible avec WS_API_r6-1.0.6-1 et les versions ultérieures.