Guías de integración › Guía de referencia de API de servicio Web › Objetos válidos › Objeto group › Método list (Objeto group)

Método list (Objeto group)

Descripción

Enumera los grupos incluidos en la base de datos del servicio de directorio local del controlador del grid y los grupos incluidos en la base de datos del servicio de directorio global (si el grid está configurado para utilizar este servicio).

Sintaxis

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

Argumentos

vdc (opcional)

Nombre del centro de datos virtual de destino

Tipo de transacción

sincrónica

Tipo de solicitud

GET

Ejemplos

Enumere los grupos.

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

Enumerar los grupos locales.

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

Enumere los grupos globales.

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

Ejemplo de salida

JSON:

{
   "group" : [
      {
         "can_own" : "0",
         "name" : "local:admin",
         "description" : "",
         "scope" : "local"
      },
      {
         "can_own" : "0",
         "name" : "local:all",
         "description" : "de forma implícita contiene a todos los usuarios como miembros",
         "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>

Códigos de error de HTTP

400

Entidad vdc mygrid no encontrada
se ha especificado un nombre de VDC que no está configurado en la aplicación WS_API.

Nota: Esta API está disponible con WS_API_r6-1.0.6-1 y versiones superiores.