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

list-Methode (group-Objekt)

Description

Gruppen in der lokalen Verzeichnisdienst-Datenbank der Grid-Steuerung und Gruppen in der globalen Verzeichnisdienst-Datenbank auflisten (wenn das Grid so konfiguriert ist, dass ein solcher Dienst verwendet wird).

Syntax

/api/v2/group/list?vdc=controller-name 

Argument

vdc (optional)

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

Transaktionsart

synchron

Anfragetyp

GET

Beispiele

Gruppen auflisten.

GET
http://192.168.123.200/api/v2/group/list?vdc=mygrid

Auflisten lokaler Gruppen

GET
http://192.168.123.200/api/v2/group/list?local&vdc=mygrid

Globale Gruppen auflisten.

GET
http://192.168.123.200/api/v2/group/list?global&vdc=mygrid

Beispielausgabe

JSON:

{
   "group" : [
      {
         "can_own" : "0",
         "name" : "local:admin",
         "description" : "",
         "scope" : "local"
      },
      {
         "can_own" : "0",
         "name" : "local:all",
         "description" : "implicitly contains all users as members",
         "scope" : "local"
      }
   ]
}

XML:

<groups>
  <group>
    <can_own>0</can_own>
    <description></description>
    <name>local:admin</name>
    <scope>local</scope>
  </group>
  <group>
    <can_own>0</can_own>
    <description>implicitly contains all users as members</description>
    <name>local:all</name>
    <scope>local</scope>
  </group>
</groups>

HTTP-Fehlercodes

400

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

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