3 Services de statut

Les services de statut permettent aux utilisateurs d'obtenir le statut des lecteurs et des volumes. Vous pouvez par exemple utiliser un service de statut pour obtenir toutes les informations sur un volume, obtenir le statut d'un volume, ou encore obtenir le statut en ligne/hors ligne des lecteurs. Ces services peuvent renvoyer un résultat de manière quasi instantanée en interrogeant la base de données, et ils sont donc implémentés sous la forme d'un appel synchrone. Le résultat de l'opération est renvoyé dès que celle-ci a été exécutée.

Services de statut général

Les deux services Web suivants sont les services Web de statut général ; ils servent à extraire le statut et le résultat du travail pour chaque exécution d'un service de gestion asynchrone.

  • getJobResult(int jobId)

  • getJobStatus(int jobId)

Les services Web getjobstatus et getJobResult sont des exemples de cas où des services asynchrones (gestion) sont associés à des services synchrones (statut) pour obtenir les résultats d'une exécution.

getJobResult

Cet appel synchrone extrait le résultat du travail pour l'ID de travail saisi.

Format

getJobResult(int jobId)

Service Web LTFS-LE à appeler :

getJobResult(jobId)

Paramètres

jobId

ID de travail renvoyé par un appel de service Web de fichier ou de gestion pour indiquer le travail de service Web est en cours d'exécution.

Rôles

Admin, Monitor ou Service

Exceptions générées

ResultNotFoundException

La liste suivante répertorie des exemples d'exceptions générées :

  • The JobResult cannot be found with the jobId1234

Délai d'expiration recommandé

600 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" >
xmlns:ns1="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <      ns1:getJobResult>
         <arg0>1212</arg0>
      </ns2:getJobResult>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns2:getJobResultResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>
            <callerIp>127.0.0.1</callerIp>
            <jobCompletedOn>1399190120</jobCompletedOn>
            <jobId>607</jobId>
            <jobStatus>Success</jobStatus>
            <jobUser>Admin</jobUser>
            <serviceCalled>enterVolume</serviceCalled>
         </return>
      </ns2:getJobResultResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <S:Fault xmlns:ns4="http://schemas.xmlsoap.org/soap/envelope/"
         <S:Code>
            <S:Value>S:Receiver</S:Value>
         <S:Code>
         <S:Reason>
            <S:Text>The JobResult cannot be found with the jobId 607</S:Text>
         <S:Reason>
         <S:Detail>
            <ns2:ResultNotFoundException xmlns:ns2="http://wsb.ejb.ws.mds.ltfsle.oracle/">
               <message>The JobResult cannot be found with the jobId 607</message>
            </ns2:ResultNotFoundException>
         <S:Detail>
      <S:Fault>
   </S:Body>
</S:Envelope>

getJobStatus

Cet appel synchrone extrait le statut du travail pour l'ID de travail saisi. Les codes retour sont :

  • 0 (l'appel de service Web associé à cet ID de travail est terminé)

  • 1 (l'appel de service Web associé à cet ID de travail est toujours en cours)

  • -1 (aucun appel de service Web associé à cet ID de travail n'a été trouvé au sein du système)

Format

getJobStatus(int jobId)

Chaîne de service Web LTFS-LE à appeler :

getJobStatus(jobId)

Paramètres

jobId

ID de travail renvoyé par un appel de service Web pour indiquer le travail de service Web en cours d'exécution.

Rôles

Admin, Monitor ou Service

Exceptions générées

Aucune

Délai d'expiration recommandé

600 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?
<env:Envelope  xmlns:env="http://www.w3.org/2003/05/soap-envelope" 
xmlns:ns1="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-sece
xt-1.0.xsd" xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns2:getJobStatus>
         <arg0>1212</arg0>
      </ns2:getJobStatus>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns2:getJobStatusResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>0</return>
      </ns2:getJobStatusResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

Aucune

Services de statut de volume et de lecteur

Ces signatures de service extraient les statuts de volume et de lecteur.

  • getAllDriveInfo()

  • getAllVolumeInfo()

  • getVolumeInfoByStatus (String status)

  • getVolumeInfoByVolser (String[] volsers)

getAllDriveInfo

Appel synchrone qui extrait toutes les informations sur les lecteurs de bande de la bibliothèque.

Format

getAllDriveInfo()

Type d'entrée

Aucun

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin, Monitor ou Service

Exceptions générées

Aucune. En cas d'erreur lors de l'obtention de toutes les informations sur les lecteurs, la valeur de retour est un tableau de lecteurs vide.

Délai d'expiration recommandé

600 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:getAllDriveInfo/>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns2:getAllDriveInfoResponse xmlns:ns2="http://ws.ltfsle.oracle/">
         <return>
            <acslsPath>0    ,0    ,12     ,5</acslsPath>
            <availableStatus>Available</availableStatus>
            <driveCompress>Compression Enabled</driveCompress>
            <driveEncry>Encryption NO</driveEncry>
            <driveFwRev>RF53</driveFwRev>
            <driveGenDev>/dev/sg10</driveGenDev>
            <driveLtfsCap>LTFS Capable</driveLtfsCap>
            <drivePoolName>Default Drive Pool</drivePoolName>
            <driveProdId>T10000C</driveProdId>
            <driveSn>576001000421</driveSn>
            <driveStatus>Assigned</driveStatus>
            <driveStdDev>/dev/st3</driveStdDev>
            <driveType>T1C</driveType>
            <driveVendor>STK</driveVendor>
            <onlineStatus>Online</onlineStatus>
         </return>
      </ns2:getAllDriveInfoResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

Aucune. La réponse renverra des lecteurs vides si une erreur quelconque se produit pendant cet appel de service Web.

getAllVolumeInfo

Cette fonction de demande est un appel synchrone qui extrait toutes les informations sur les volumes présents dans LTFS-LE.

Format

getAllVolumeInfo()

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin, Monitor ou Service

Exceptions générées

Aucune. En cas d'erreur lors de l'obtention des informations sur tous les volumes, la valeur de retour est un tableau de volumes vide.

Délai d'expiration recommandé

600 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
xmlns:ns1="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
  <env:Header>
    <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns2:getAllVolumeInfo/>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
  <S:Body>
   <ns2:getAllVolumeInfoResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
    <return>
     <acslsPath>0,   ,0    ,12     ,24   ,4</acslsPath>
     <assignedStatus>Assigned</assignedStatus>
     <availableStatus>Available</availableStatus>
     <capacityAvailable>1453410222080</capacityAvailable>
     <capacityUsed>24117248</capacityUsed>
     <currentLocation>home</currentLocation>
     <inuseStatus>In use</inuseStatus>
     <ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
     <onlineStatus>Online</onlineStatus>
     <volser>F50191</volser>
     <volumeCreatedOn>1403014692</volumeCreatedOn>
     <volumePoolName>Default Volume Pool</volumePoolName>
     <volumeType>LTO-1.5T</volumeType>
    </return>
    <return>
     <acslsPath>0,   ,0    ,12     ,23    ,5</acslsPath>
     <assignedStatus>Assigned</assignedStatus>
     <availableStatus>Available</availableStatus>
     <capacityAvailable>1453410222080</capacityAvailable>
     <capacityUsed>24117248</capacityUsed>
     <currentLocation>home</currentLocation>
     <inuseStatus>In use</inuseStatus>
     <ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
     <onlineStatus>Online</onlineStatus>
     <volser>F50192</volser>
     <volumeCreatedOn>1403014692</volumeCreatedOn>
     <volumePoolName>Default Volume Pool</volumePoolName>
     <volumeType>LTO-1.5T</volumeType>
    </return>
    <return>
   </ns2:getAllVolumeInfoResponse>
  </S:Body>
</S:Envelope>

Erreur SOAP

Aucune. La réponse renverra des volumes vides si une erreur quelconque se produit pendant cet appel de service Web.

getVolumeInfoByStatus

Appel synchrone qui extrait les informations de volume en fonction du statut de volume.

Format

getVolumeInfoByStatus(String status)

Chaîne de service Web LTFS-LE à appeler :

getVolumeInfoByStatus(status)

Type d'entrée

Les statuts de volume valides sont les suivants : Online, Offline, Assigned, Unassigned, In Use, Idle, Available ou Unavailable.

La saisie de plusieurs statuts n'est pas prise en charge, de même que le statut Pending.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin, Monitor ou Service

Exceptions générées

StatusNotFoundException

Délai d'expiration recommandé

600 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1
="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns2
="http://sb.ejb.ws.mds..ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns2:getVolumeInfoByStatus>
         <arg0>online</arg0>
      </ns2:getVolumeInfoByStatus>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns2:getVolumeInfoByStatusResponse xmlns:ns2="http://ws.ltfsle.oracle/">
         <return>
            <acslsPath>3  ,0  ,12   ,38 ,1</acslsPath>
            <assignedStatus>Assigned</assignedStatus>
            <availableStatus>Available</availableStatus>
            <capacityAvailable>1453410222080</capacityAvailable>
            <capacityUsed>24117248</capacityUsed>
            <currentLocation>home</currentLocation>
            <inuseStatus>In use</inuseStatus>
            <ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
            <onlineStatus>Online</onlineStatus>
            <volser>O50191</volser>
            <volumeCreatedOn>1402933089</volumeCreatedOn>
            <volumePoolName>Default Volume Pool</volumePoolName>
            <volumeType>LTO-1.5T</volumeType>
         </return>
         <return>
            <acslsPath>3  ,0  ,12   ,41 ,2</acslsPath>
            <assignedStatus>Assigned</assignedStatus>
            <availableStatus>Available</availableStatus>
            <capacityAvailable>1453410222080</capacityAvailable>
            <capacityUsed>24117248</capacityUsed>
            <currentLocation>home</currentLocation>
            <inuseStatus>In use</inuseStatus>
            <ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
            <onlineStatus>Online</onlineStatus>
            <volser>O50191</volser>
            <volumeCreatedOn>1402933089</volumeCreatedOn>
            <volumePoolName>Default Volume Pool</volumePoolName>
            <volumeType>LTO-1.5T</volumeType>
         </return>
      </ns2:getVolumeInfoByStatusResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns3:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
         <ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>Status not found: [status]</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:StatusNotFoundException xmlns:ns2="http://ws.ltfsle.oracle/">
               <message>Status not found: [status]</message>
            </ns2:StatusNotFoundException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

getVolumeInfoByVolser

Appel synchrone qui extrait toutes les informations de volume d'un ou plusieurs volumes en fonction du numéro de série de volume.

Format

getVolumeInfoByVolser (String[] volsers)

Service Web LTFS-LE à appeler :

getVolumeInfoByVolser([volser1, volser2, ...])

Paramètre

volser désigne le numéro de série du volume.

Rôles

Admin, Monitor ou Service

Exceptions générées

Si l'un des numéros de série de volume est introuvable, une exception VolumeNotFoundException est générée.

Délai d'expiration recommandé

600 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1
="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns2
="http://1.0.xsd" xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
         </ns1:UsernameToken>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns2:getVolumeInfoByVolser>
         <arg0>F52270</arg0>
         <arg0>EL0010</arg0>
         <arg0>F50331</arg0>
      </ns2:getVolumeInfoByVolser>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns2:getVolumeInfoByVolserResponse xmlns:ns2="http://ws.ltfsle.oracle/">
         <return>
            <acslsPath>3  ,0  ,12   ,38 ,1</acslsPath>
            <assignedStatus>Assigned</assignedStatus>
            <availableStatus>Available</availableStatus>
            <capacityAvailable>1453410222080</capacityAvailable>
            <capacityUsed>24117248</capacityUsed>
            <currentLocation>home</currentLocation>
            <inuseStatus>In use</inuseStatus>
            <ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
            <onlineStatus>Online</onlineStatus>
            <volser>O50191</volser>
            <volumeCreatedOn>1403015625</volumeCreatedOn>
            <volumePoolName>Default Volume Pool</volumePoolName>
            <volumeType>LTO-1.5T</volumeType>
         </return>
         <return>
            <acslsPath>3  ,0  ,12   ,38 ,2</acslsPath>
            <assignedStatus>Assigned</assignedStatus>
            <availableStatus>Available</availableStatus>
            <capacityAvailable>1453410222080</capacityAvailable>
            <capacityUsed>24117248</capacityUsed>
            <currentLocation>home</currentLocation>
            <inuseStatus>In use</inuseStatus>
            <ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
            <onlineStatus>Online</onlineStatus>
            <volser>O50191</volser>
            <volumeCreatedOn>1403015625</volumeCreatedOn>
            <volumePoolName>Default Volume Pool</volumePoolName>
            <volumeType>LTO-1.5T</volumeType>
      </ns2:getVolumeInfoByVolserResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
    <ns3:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
         </ns3:Code>
            <ns3:Value>ns3:Receiver</ns3:Value>
         </ns3:Code>
         <ns3:Reason>
            <ns3:Text>Volume is not found: [volser]</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:VolumeNotFoundException xmlns:ns2="http://ws.ltfsle.oracle/">
               <message>Volume is not found: [volser]</message>
            </ns2:VolumeNotFoundException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>