Rubrique précédente: Méthode put_desc (objet app)

Rubrique suivante: Méthode put_acl (objet app)


Méthode get_acl (objet app)
Description

Récupérer la liste de contrôle d'accès de l'application ou la partie de cette liste qui se rapporte à un principal spécifique

Syntaxe
/api/v1/app/get_acl?app=application&principal=<principal>&vdc=nom-contrôleur
Arguments
app

Nom de l'application

principal

Un principal, encodé au format URL. Par exemple, local:user:api@3tera.com doit être passé sous la forme local%3Auser%3Aapi%403tera.com

vdc

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemple : récupération de la liste de contrôle d'accès de l'application

Récupérer la liste de contrôle d'accès de l'application test

GET http://192.168.123.200/api/v1/app/get_acl?app=test&principal=&vdc=mygrid 
Exemple de sortie
JSON
{
   "acl" : {
      "owner" : {
         "id" : "b543eff7-db88-4d79-a11c-4de22d5e6d3b"
      },
      "entries" : {
         "entries[0]" : {
            "id" : "4f865f5b-e63a-410a-9d9a-96427c3ecfc7",
            "full" : 1
         },
         "entries[1]" : {
            "id" : "b543eff7-db88-4d79-a11c-4de22d5e6d3b",
            "full" : 1
         }
      }
   }
}

XML

<acl>
  <entries>
    <name>entries[0]</name>
    <full>1</full>
    <id>4f865f5b-e63a-410a-9d9a-96427c3ecfc7</id>
  </entries>
  <entries>
    <name>entries[1]</name>
    <configure>1</configure>
    <id>b543eff7-db88-4d79-a11c-4de22d5e6d3b</id>
  </entries>
  <owner>
    <id>b543eff7-db88-4d79-a11c-4de22d5e6d3b</id>
  </owner>
</acl>

Exemple : récupération des données de la liste de contrôle d'accès pour le principal

Récupérer les données de la liste de contrôle d'accès pour le principal local:user:api@3tera.com et l'application test

GET
http://192.168.123.200/api/v1/app/get_acl?app=test&principal=local%3Auser%3Aapi%403tera.com&vdc=mygrid
Exemple de sortie
JSON

{
   "acl" : {
      "entries" : {
         "entries[0]" : {
            "id" : "4f865f5b-e63a-410a-9d9a-96427c3ecfc7",
            "full" : 1
         }
      }
   }

XML

<acl>
  <entries>
    <name>entries[0]</name>
    <full>1</full>
    <id>4f865f5b-e63a-410a-9d9a-96427c3ecfc7</id>
  </entries>
</acl>

Codes d'erreur HTTP
404

L'entité vdc mygrid est introuvable - Le nom de VDC spécifié n'est pas configuré dans l'application WS_API.

400.4

Missing required arguments (app). 
- La requête ne contient pas l'argument app=application.

Missing required arguments (principal)
- Argument principal=principal manquant

404.1

Entity not found - Application test does not exist.

- Une application spécifiée n'existe pas sur mygrid.

Entity not found - Failed to retrieve application ACL - ACL does not contain principal local user 'test@3tera.com'.

- Un principal non valide a été spécifié

Remarque : Cette API est disponible avec WS_API_r6-1.0.6-1 et les versions ultérieures.