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

Metodo modify (oggetto group)

Description

Sostituisce una descrizione del gruppo locale o di appartenenza.

Sintassi

/api/v2/group/modify?group=group&add_principal=add_principal&remove_principal=remove_principal&vdc=controller-name 

Argomenti

group

Nome del gruppo

add_principal

Elenco delimitato da ‘/’ delle entità principali da aggiungere al gruppo.

Ad esempio: local:user:api@3tera.com dovrebbe essere utilizzato come local%3Auser%3Aapi%403tera.com

Ad esempio, local:user:api@3tera.com /local:user:test@3tera.com should be passed as local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com

remove_principal

Elenco delimitato da ‘/’ delle entità principali da rimuovere dal gruppo.

Ad esempio: local:user:api@3tera.com dovrebbe essere utilizzato come local%3Auser%3Aapi%403tera.com

Ad esempio, local:user:api@3tera.com /local:user:test@3tera.com should be passed as local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com

vdc

Nome del data center virtuale di destinazione

Tipo di transazione

sincrona

Tipo di richiesta

GET

Esempi

Sostituzione dell'intera descrizione con “API GROUP” ma senza modificare l'appartenenza

                                                                                                                                   
GET
http://192.168.123.200/api/v2/group/modify?group=mygroup&description=API%20Group&add_principal=&remove_principal=&vdc=mygrid

Sostituzione dell'intera descrizione con “API GROUP”, aggiunta di local:user:api@3tera.com all'appartenenza e rimozione di local:user:test@3tera.com da mygroup.

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&add_principal=local%3Auser%3Aapi%403tera.com&remove_principal=local%3Auser%3Atest%403tera.com&vdc=mygrid

Sostituzione dell'intera descrizione con “API GROUP” e rimozione di local:user:api@3tera.com e local:user:test@3tera.com da mygroup.

GET
http://192.168.123.200/api/v2/group/put?group=mygroup&description=API%20Group&remove_principal=local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com&add_principal=&vdc=mygrid

Output di esempio

JSON:

{
   "message" : ""
} 

XML:

<message></message>

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 obbligatori mancanti (add_principal, remove_principal, can_own o descrizione).

404.1

Entità non trovata - Il gruppo mygroup non esiste.

- È stato specificato un gruppo che non esiste in mygrid.

Entità non trovata - Impossibile applicare l'ACL dell'applicazione - Dati principali non validi - L'utente principale locale 'test@3tera.com' non esiste.

- È stata specificata un'entità principale non valida.

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