Integrationshandbücher › Webservice-API-Referenzhandbuch › Zulässige Objekte für CA AppLogic-API › group-Objekt › list-Methode (group-Objekt)

list-Methode (group-Objekt)

Beschreibung

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/v1/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/v1/group/list?vdc=mygrid

Auflisten lokaler Gruppen

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

Globale Gruppen auflisten.

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

Beispielausgabe

JSON:

{
   "group[0]" : {
      "name" : "admin",
      "description" : "us",
      "scope" : "local"
   },
   "group[1]" : {
      "name" : "mygroup",
      "description" : "",
      "scope" : "local"
   }
}

XML:

<opt>
  <group[0]>
    <name>admin</name>
    <description>us</description>
    <scope>local</scope>
  </group[0]>
  <group[1]>
    <name>mygroup</name>
    <description></description>
    <scope>local</scope>
  </group[1]>
</opt>

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.