Guide di integrazione › Guida di riferimento API del servizio Web › Oggetti validi › Oggetto group › Metodo info (oggetto group)

Metodo info (oggetto group)

Description

Mostra informazioni sul gruppo. Le informazioni visualizzate comprendono: nome del gruppo, ID, ambito, descrizione e membri del gruppo principale.

Sintassi

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

Argomenti

group

Nome del gruppo

vdc

Nome del data center virtuale di destinazione

Tipo di transazione

sincrona

Tipo di richiesta

GET

Esempi

Ottenere informazioni sul gruppo per il gruppo mygroup

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

Output di esempio

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>

Codici di errore HTTP

400

Entità vdc mygrid non trovata
- È stato specificato un nome di VDC non configurato nell'applicazione WS_API.

400.4

Argomenti necessari mancanti (app).
- Argomento group=group mancante.

Nota: questa API è disponibile con WS_API_r6-1.0.6-1 e versioni successive.