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

Método get (Objeto group)

Descripción

Muestra información sobre los grupos. La información mostrada incluye: nombre del grupo, ID, ámbito, descripción y miembros del grupo del elemento principal.

Sintaxis

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

Argumentos

grupo

Nombre del grupo

vdc

Nombre del centro de datos virtual de destino

Tipo de transacción

sincrónica

Tipo de solicitud

GET

Ejemplos

Cree un grupo local denominado mygroup.

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

Obtenga información de grupo para el grupo "mygroup".

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

Ejemplo de salida

JSON:

{
   "group" : {
      "members" : {
         "members[2]" : {
            "name" : "*",
            "id" : "f29c1426-10c1-4715-a763-b0bcc4b8b9d5",
            "type" : "user",
            "scope" : "local"
         },
         "members[0]" : {
            "name" : "apimig@3tera.com",
            "id" : "e1a5357f-204b-4cd3-9ca8-9e09f45b21c6",
            "type" : "user",
            "scope" : "local"
         },
         "members[1]" : {
            "name" : "api@3tera.com",
            "id" : "4f865f5b-e63a-410a-9d9a-96427c3ecfc7",
            "type" : "user",
            "scope" : "local"
         },
         "members[3]" : {
            "name" : "apoorva@3tera.com",
            "id" : "b543eff7-db88-4d79-a11c-4de22d5e6d3b",
            "type" : "user",
            "scope" : "local"
         }
      },
      "name" : "mygroup",
      "id" : "a5cb10bc-7291-4a86-84f8-74419fc9ae63",
      "description" : "us",
      "scope" : "local"
   }
}

XML:

<group>
  <name>mygroup</name>
  <description>us</description>
  <id>a5cb10bc-7291-4a86-84f8-74419fc9ae63</id>
  <members>
    <name>apimig@3tera.com</name>
    <id>e1a5357f-204b-4cd3-9ca8-9e09f45b21c6</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <members>
    <name>api@3tera.com</name>
    <id>4f865f5b-e63a-410a-9d9a-96427c3ecfc7</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <members>
    <name>*</name>
    <id>f29c1426-10c1-4715-a763-b0bcc4b8b9d5</id>
    <scope>local</scope>
    <type>user</type>
  </members>
  <scope>local</scope>
</group>

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.

400.4

Faltan argumentos obligatorios (app):
- Falta el argumento group=group

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