Manuels d'intégration › Manuel de référence de l'API de service Web › Objets valides › Objet vol › Méthode list (objet vol)

Méthode list (objet vol)

Description

Récupérer la liste des volumes dans l'application

Syntaxe

/api/v2/vol/list?app=application&vdc=controller-name 

Arguments

app

Nom de l'application

vdc

Nom du centre de données virtuel cible

Type de transaction

Synchrone

Type de requête

GET

Exemples

Pour récupérer la liste des volumes de l'application test :

GET http://192.168.123.200/api/v2/vol/list?app=test&vdc=mygrid 

Exemple de sortie

XML

<volumes>
  <volume>
    <comment></comment>
    <filesystem>ext3</filesystem>
    <mount_state>in_use</mount_state>
    <n_mirrors>2</n_mirrors>
    <name>WS_API_r271:code</name>
    <scope_name>WS_API_r271</scope_name>
    <scope_type>application</scope_type>
    <server>srv1,srv2</server>
    <size>54525952</size>
    <state>ok</state>
    <store>local</store>
    <uuid>fc746912-cc65-4e9c-9327-14c66b1741c7</uuid>
  <volume> 
  .
  .
  .
  <volume>
    <comment></comment>
    <filesystem>ext3</filesystem>
    <mount_state>available</mount_state>
    <n_mirrors>2</n_mirrors>
    <name>WS_API_r271:mon</name>
    <scope_name>WS_API_r271</scope_name>
    <scope_type>application</scope_type>
    <server>srv1,srv2</server>
    <size>53477376</size>
    <state>ok</state>
    <store>local</store>
    <uuid>f4fd637c-4aa8-4111-be31-55d28a1e275d</uuid>
  <volume> 
</volumes>

JSON

{
   "volume" : [
      {
         "store" : "local",
         "scope_type" : "application",
         "name" : "WS_API_r271:code",
         "scope_name" : "WS_API_r271",
         "mount_state" : "in_use",
         "uuid" : "fc746912-cc65-4e9c-9327-14c66b1741c7",
         "size" : "54525952",
         "state" : "ok",
         "comment" : "",
         "filesystem" : "ext3",
         "n_mirrors" : "2",
         "server" : "srv1,srv2"
      },
      .
      .
      .
      {
         "store" : "local",
         "scope_type" : "application",
         "name" : "WS_API_r271:mon",
         "scope_name" : "WS_API_r271",
         "mount_state" : "available",
         "uuid" : "f4fd637c-4aa8-4111-be31-55d28a1e275d",
         "size" : "53477376",
         "state" : "ok",
         "comment" : "",
         "filesystem" : "ext3",
         "n_mirrors" : "2",
         "server" : "srv1,srv2"
      }
   ]
}

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.1

L'application test n'existe pas. - Une application non valide a été spécifiée dans la requête.