Integrationshandbücher › Webservice-API-Referenzhandbuch › Gültige Objekte › group-Objekt › get-Methode (group-Objekt)

get-Methode (group-Objekt)

Description

Gruppeninformationen anzeigen. Die angezeigten Informationen sind u. a.: Gruppenname, ID, Geltungsbereich, Beschreibung und Prinzipalgruppenmitglieder.

Syntax

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

Argument

Gruppe

Name der Gruppe

vdc

Name des virtuellen Rechenzentrums (Virtual Data Center), welches das Ziel darstellt

Transaktionsart

synchron

Anfragetyp

GET

Beispiele

Lokale Gruppe mit dem Namen mygroup erstellen.

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

Gruppeninformationen für mygroup abrufen

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

Beispielausgabe

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>

HTTP-Fehlercodes

400

Entität vdc mygrid nicht gefunden.
- Ein VDC-Name wurde angegeben, der in der WS_API-Anwendung nicht konfiguriert ist.

400.4

Erforderliche Argumente fehlen (app).
- Argument group=group nicht vorhanden.

Hinweis: Diese API ist verfügbar mit WS_API_r6-1.0.6-1 und höher.