4 管理サービス

管理サービスとは、ストレージリソースを管理するサービスです。たとえば、管理サービスを使用してボリュームのエンターやボリュームのイジェクトを行なったり、ボリュームをオンラインまたはオフラインにしたりします。

概要

これらのサービスはソリューションの機械コンポーネントと通信する必要があるため、応答時間は操作の種類や機械的な待機時間によって異なります。管理サービスは、非同期呼び出しとして実装されます。管理サービスが非同期であるのは、ジョブの実行が完了する前に復帰するからです。

  • 操作が完了すると、呼び出し元のサービスが結果 (入手可能な場合) を取得するために呼び出す必要のあるプログラムまたはジョブ ID が返されます。

  • 非同期サービスが復帰するときに、応答の一環としてジョブ ID が返されます。その戻りコードは次のとおりです。

    • 0 (このジョブ ID に関連付けられている Web サービス呼び出しは完了です。)

    • 1 (このジョブ ID に関連付けられている Web サービス呼び出しはまだ進行中です。)

    • -1 (このようなジョブ ID を持つ Web サービス呼び出しはシステム内に見つかりません。)

  • Web サービスクライアントを実装するプログラマは、クライアントにジョブ ID を渡すことで、定期的に getJobStatus Web サービスを呼び出してジョブのステータスを取得する必要があります。

  • getJobStatus が「0」を返したら、getJobResult Web サービスを呼び出してサービス結果を取得します。

それぞれの非同期 Web サービスが完了するまでにかかる時間はさまざまです。機械側に障害がある場合、バックエンドはタイムアウトします。このガイドでは、サードパーティーの Web サービスクライアントがタイムアウトするまでに待機する最大推奨時間に関するガイドラインを示します。

getJobStatus および getJobResult については、ステータスサービスを参照してください。

assignVolume

LTFS-LE を使用してボリュームを管理するには、ボリュームを LTFS-LE アプリケーションに割り当てる必要があります。

ボリュームを LTFS-LE に割り当てると、自動的にオンラインになり、デフォルトのボリュームプールに追加されます。フォーマットされていないボリュームを割り当てると、LTFS-LE で使用できるように自動的にフォーマットされます。

形式

        assignVolume(String[] volsers)

前提条件:

ボリュームを割り当てる前に、互換性のあるドライブが使用可能であることと、ボリュームがオフライン、未割り当て、プールに入っていない、および使用可能であることを確認します。ボリューム (複数も可) はライブラリ内に存在する必要があります。

これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • ボリュームが必要な状態のいずれかにあることを確認し、必要に応じて続行する前に修正アクションを取ります。

呼び出す LTFS-LE Web サービス:

assignVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームが LTFS-LE ソフトウェアに割り当てられます。ボリュームが LTFS でフォーマットされていない場合は、自動的に LTFS でフォーマットされます。

パラメータ

  • volser は、割り当てられるボリューム (複数も可) のボリュームシリアル番号です。入力パラメータは文字列の配列であり、複数のボリュームの割り当てが可能になります。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームがオフラインでも未割り当てでもなく、プールから除去もされていない場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Online です。

  • ボリューム SL0010 の assignedStatus が Assigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

  • ボリューム SL0010 の inuseStatus が In use です。

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:assignVolume>
         <arg0>F50233</arg0>
         <arg0>F50234</arg0>
      </ns1:assignVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

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

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>The volume SL0010’s assignedStatus is Assigned</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s assignedStatus is Assigned</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

ejectVolume

この API 関数は、1 つ以上の LTFS-LE ボリュームをライブラリからイジェクトします。

メッセージサイズを考慮すると、LTFS LE ではメールスロット (CAP) を使用して最大 30 ボリュームのイジェクトのみをサポートしています。イジェクトは、すべてのボリュームが完全にイジェクトされるまで 4 つずつ行われます。タイムアウトはありません。これは非同期呼び出しです。

形式

ejectVolume(String[] volsers,String acs,String lsm,String cap)

前提条件:

イジェクトする前にボリューム (複数も可) がファイナライズされ、オフラインになっていること、CAP が使用可能であること、および ACS が構成されたライブラリと同じであることを確認します。これを行うには:

  1. ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  2. ボリュームがオンラインであるが使用中でない場合は、そのボリュームをファイナライズします。

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    
  3. ボリュームがオンラインである場合は、イジェクト API 呼び出しを実行する前にそのボリュームをオフラインにします。

    offlineVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    

呼び出す LTFS-LE Web サービスチェーン:

ejectVolume([volser1,volser2,...],acs,lsm,cap) 
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームがライブラリからイジェクトされます。ユーザーはライブラリのところに行き、CAP のドアを開いたあとにそのボリュームを取り出す必要があります。

パラメータ

  • volser は、イジェクトされるボリューム (複数も可) のシリアル番号です。

  • acs は、ライブラリ ACS 識別子です。

  • lsm は、ライブラリ LSM 識別子です。

  • cap は、ボリュームのイジェクトに使用されるライブラリ CAP (メールスロット) ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser 配列内の 1 つの volser が空の場合、または CAP 識別子 (acs、lsm、cap_id) の一部が見つからないか使用中である場合は、null パラメータが返されます。

  • ボリュームがオフラインでも未割り当てでもなく、プールから除去もされていない場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Online です。

  • ボリューム SL0010 の assignedStatus が Assigned です。

  • ボリューム SL0010 の availableStatus が Available です。

  • ボリューム SL0010 の inuseStatus が In use です。

  • ACS 0 がライブラリの acs 7 と矛盾しています。

推奨されるタイムアウト

これは、CAP (メールスロット) からボリュームを取り除くのにかかる時間によって異なります。

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:ejectVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
         <arg1>3</arg1>
         <arg2>0</arg2>
         <arg3>1</arg3>
      </ns1:ejectVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401  -wss-wssecurity-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:ejectVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1213</return>
      </ns2:ejectVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume SL0010’s onlineStatus is Online</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s onlineStatus is Online</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

enterVolume

これは、CAP (メールスロット) を使用して 1 つ以上のボリュームをライブラリにエンターする非同期呼び出しです。

形式

enterVolume(String acs,String lsm,String cap)

前提条件:

ボリュームを CAP にエンターするための特定の前提条件はありません。ただし、このコマンドを実行する前に、管理者またはサービスは CAP 識別子 (acslsm、および cap_id) を収集し、CAP が使用可能であり、操作 (保留、イジェクト、エンター、監査) の途中でないことを確認する必要があります。

呼び出す LTFS-LE Web サービスチェーン:

enterVolume(acs,lsm,cap)
getJobStatus(jobId) <poll each 10s until status is complete>
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームがライブラリにエンターされます。

パラメータ

  • acs は、ライブラリ ACS 識別子です。

  • lsm は、ライブラリ LSM 識別子です。

  • cap は、ボリュームのエンターに使用されるライブラリ CAP (メールスロット) ID です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

いずれかのパラメータが空の場合は、null 例外がスローされます。次は、スローされる例外の例を示しています。

  • ACS 4 がライブラリの acs 7 と矛盾しています。

  • 無効な ACS 番号です。

推奨されるタイムアウト

これは、管理者がボリュームを CAP にエンターするのにかかる時間によって異なります。

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1
="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:enterVolume>
         <arg0>3</arg0>
         <arg1>0</arg1>
         <arg2>1</arg2>
      </ns1:enterVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/
oasis-200401-wss-wssecurity-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:enterVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1212</return>
      </ns2:enterVolumeResponse>
   </S:Body>
</S:Envelope>

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> Invalid ACS number </ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>Invalid ACS number</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

finalizeVolume

ボリュームの変更をコミットするには、finalizeVolume コマンドを使用します。このアクションは通常、ボリュームがオフラインになってライブラリからイジェクトされる前に実行されます。ボリュームをファイナライズすると、書き込まれていないメタデータまたは適用されていないファイルの削除がボリュームに適用されます。このアクションにより、グローバル名前空間に対するアクションが確実に物理ボリュームに反映されます。ボリュームがオフラインになる前にそのファイナライズに失敗すると、ボリュームのオフライン化が遅延する可能性があります。

形式

finalizeVolume(String volser)

前提条件:

ボリュームをファイナライズする前に、互換性のあるドライブが使用可能であることと、ボリュームがオンライン、プールに入っている、アイドル状態、および使用可能であることを確認します。これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • ボリュームがすべての必要な状態にあることを確認し、必要に応じて続行する前に修正アクションを取ります。

呼び出す LTFS-LE Web サービス:

finalizeVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームに適用される必要のある保留中の操作がすべてボリュームに適用されています。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

パラメータ

  • volser は、ファイナライズされるボリュームのボリュームシリアル番号です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームがオフラインでも未割り当てでもなく、プールから除去もされていない場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Offline です。

  • Tボリューム SL0010 の assignedStatus が Unassigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

  • ボリューム SL0010 の inuseStatus が In use です。

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:ns1
="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:finalizeVolume>
         <arg0>F50233</arg0>
      </ns1:finalizeVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
        <wsu:Timestamp   xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:finalizeVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1219</return>
      </ns2:finalizeVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume SL0010’s onlineStatus is Offline</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s onlineStatus is Offline</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

formatVolume

ボリュームを LTFS でフォーマットされたボリュームにフォーマットする非同期呼び出しです。この LTFS-LE Web サービスでは、確認を必要とせず、ボリュームの検証も一切行いません。ユーザーはフォーマット対象のボリュームを認識し、必ず正しいボリュームがフォーマットされるようにする必要があります。

ボリュームがフォーマットされると、そのボリューム上の以前のデータはすべて削除されます。

形式

formatVolume(String volser)

前提条件:

ボリュームをフォーマットする前に、ボリュームがオフライン、割り当て済み、プールに入っている、および使用可能であることを確認します。使用可能な互換性のあるドライブがあることを確認します。

これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • ボリュームが、前提条件で必要とされた状態にあることを確認します。

  • 必要に応じて、続行する前に修正アクションを取ります。

呼び出す LTFS-LE Web サービスチェーン:

formatVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームが LTFS-LE でフォーマットされます。

パラメータ

  • volser は、イジェクトされるボリュームのシリアル番号です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

次のリストは、スローされる例外の例を示しています。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム EL0010 の onlineStatus が Online です。

  • ボリューム EL0010 の assignedStatus が Unassigned です。

  • ボリューム EL0010 の availableStatus が Unavailable です。

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:ns1
="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:formatVolume>
         <arg0>F50234</arg0>
      </ns1:formatVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:formatVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1215</return>
      </ns2:formatVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

formatVolumeWithDrive

この非同期呼び出しはボリュームを LTFS 形式にフォーマットするもので、ボリュームを特定のドライブでフォーマットする必要があるときに使用されます。ボリュームとドライブは互換性がある必要があります。

形式

formatVolumeWithDrive (String volser, String drivesn)

前提条件:

ボリュームをフォーマットする前に、ボリュームがオフライン、割り当て済み、プールに入っている、および使用可能であることを確認します。ボリュームとドライブはライブラリ内に存在し、互換性がある必要があります。ドライブはアイドル状態または使用可能な状態になっている必要があります。

これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • ボリュームが、前提条件で必要とされた状態にあることを確認します。

  • 必要に応じて、続行する前に修正アクションを取ります。

呼び出す LTFS-LE Web サービスチェーン:

formatVolumeWithDrive(volser,drivesn)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームが LTFS-LE でフォーマットされます。

パラメータ

  • volser は、ボリュームシリアル番号です。

  • drivesn は、ボリュームをフォーマットするドライブのドライブシリアル番号です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

次のリストは、スローされる例外の例を示しています。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム EL0010 の assignedStatus が Unassigned です。

  • ボリューム EL0010 の onlineStatus が Online です。

  • ボリューム EL0010 の availableStatus が Unavailable です

  • ドライブ 123456 が LTFS ライブラリ内に見つかりません。

  • ドライブ 123456 の availableStatus が In use です

  • ドライブ 123456 の onlineStatus が Offline です

  • ドライブ 123456 の assignedStatus が Unassigned です

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="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:formatVolumeWithDrive>
         <arg0>F50234</arg0>
         <arg1>576001000421</arg1>
      </ns1:formatVolumeWithDrive>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:formatVolumeWithDriveResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1215</return>
      </ns2:formatVolumeWithDriveResponse>
   </S:Body>
</S:Envelope>

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>The Volume F50377's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The Volume F50377's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

getVolumePath

この非同期呼び出しは、グローバル名前空間内でボリュームパスを見つけます。

形式

getVolumePath(volser)

パラメータ

  • volser は、検索されるボリュームパス用のボリュームシリアル番号です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

ボリュームはライブラリ内に存在し、割り当て済みかつ使用可能である必要があります。

次のリストは、スローされる例外の例を示しています。

  • ボリューム EL0020 の assignedStatus が Unassigned です。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム EL0010 の availableStatus が Unavailable です。

推奨されるタイムアウト

3600 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:getVolumePath>
         <arg0>F50233</arg0>
      </ns1:getVolumePath>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope  xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2: getVolumePath xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1225</return>
      </ns2: getVolumePath >
   </S:Body>
</S:Envelope>

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>The volume EL0010’s availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010’s availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

offlineVolume

これは、ボリュームをオフライン状態にして、1 つ以上のボリュームのイジェクト、ボールティング、フォーマット、割り当て、および割り当て解除を可能にする非同期呼び出しです。

形式

offlineVolume(String[] volser)

前提条件:

ボリュームをオフラインに設定する前に、そのボリュームがライブラリ内に存在し、かつオンライン、割り当て済み、使用可能、およびファイナライズ済みであることを確認します。使用可能な互換性のあるドライブがあることを確認します。

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • ボリュームがオンラインの割り当て済み状態である場合は、そのボリュームをファイナライズします。

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete >
    getJobResult(jobId)
    

呼び出す LTFS-LE Web サービスチェーン:

offlineVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームがオフラインになります。

パラメータ

  • volser は、オフラインにされるボリューム (複数も可) のボリュームシリアル番号です。入力パラメータは文字列の配列であり、この呼び出しによって複数のボリュームをオフラインにできます。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームをオフラインに設定する前にそれがライブラリ内に存在せず、かつオンライン、割り当て済み、使用可能、およびファイナライズ済みである場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Offline です。

  • ボリューム SL0010 の assignedStatus が Unassigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:offlineVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
      </ns1:offlineVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope    xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:offlineVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1218</return>
      </ns2:offlineVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

onlineVolume

ボリュームをオンライン状態にすることで、ボリュームの読み取り、書き込み、またはファイナライズが可能になる非同期呼び出しです。

形式

onlineVolume(String[] volsers)

前提条件:

ボリュームをオンラインに設定する前に、それがライブラリ内に存在し、かつオフライン、割り当て済み、プールに入っている、および使用可能であることを確認します。使用可能な互換性のあるドライブがあることを確認します。

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

呼び出す LTFS-LE Web サービス:

onlineVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームがオンラインになります。

パラメータ

  • volser は、オンラインにされるボリューム (複数も可) のボリュームシリアル番号です。入力パラメータは文字列の配列であり、この呼び出しによって複数のボリュームをオンラインにできます。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームをオンラインに設定する前にそれがライブラリ内に存在せず、かつオンライン、未割り当て、プールに入っていない、および使用不可である場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Online です。

  • ボリューム SL0010 の assignedStatus が Unassigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

  • ボリューム EL0010 の inuseStatus が In use です。

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="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:onlineVolume>
         <arg0>F40244</arg0>
         <arg0>F43022</arg0>
      </ns1:onlineVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:onlineVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1217</return>
      </ns2:onlineVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume SL0010’s availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

prepareVolume

この非同期呼び出しは、ボリュームフォルダを /LTFSLE/LOST+FOUND+VOLUMES/ から /LTFSLE/ フォルダに移動します。

形式

prepareVolume(volser)

前提条件:

ボリュームを準備する前に、ボリュームフォルダが /LTFSLE/LOST+FOUND+VOLUMES にあることと、ボリュームがライブラリ内に存在し、かつオフライン、割り当て済み、および使用可能であることを確認します。これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • ボリュームの場所を取得します。

    getVolumePath(volser)
    
  • ボリュームがすべての必要な状態にあることを確認し、必要に応じて続行する前に修正アクションを取ります。

呼び出す LTFS-LE Web サービス:

prepareVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、/LTFSLE フォルダからボリュームフォルダにアクセスできるようになります。

パラメータ

  • volser は、/LTFSLE/ という場所を通じてアクセスできるよう準備するボリュームシリアル番号です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームを準備する前にそのボリュームがライブラリ内に存在せず、かつオンライン、未割り当て、および使用不可である場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Online です。

  • ボリューム SL0010 の assignedStatus が Unassigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

  • ボリューム EL0010 の inuseStatus が In use です。

推奨されるタイムアウト

3600 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:prepareVolume>
         <arg0>F50233</arg0>
      </ns1:prepareVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope   xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:prepareVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1221</return>
      </ns2:prepareVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unassignVolume

このコマンドは、LTFS-LE へのボリュームの割り当てを解除します。

形式

unassignVolume(String[] volsers)

前提条件:

ボリュームを割り当て解除する前に、そのボリュームがライブラリ内に存在し、かつオフライン、割り当て済み、プールに入っている、および使用可能であることを確認します。これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • ボリュームがすべての必要な状態にあることを確認し、必要に応じて続行する前に修正アクションを取ります。

呼び出す LTFS-LE Web サービス:

unassignVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームがライブラリから割り当て解除されます。

パラメータ

  • volser は、割り当て解除されるボリューム (複数も可) のボリュームシリアル番号です。入力パラメータは文字列の配列であり、複数のボリュームの割り当て解除が可能になります。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームを割り当て解除する前にそのボリュームがライブラリ内に存在せず、かつオンライン、未割り当て、プールに入っていない、および使用不可である場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Online です。

  • ボリューム SL0010 の assignedStatus が Unassigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

  • ボリューム EL0010 の inuseStatus が In use です。

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:unassignVolume>
         <arg0>F50233</arg0>
         <arg0>F50234</arg0>
      </ns1:unassignVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp   xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unassignVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1221</return>
      </ns2:unassignVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unformatVolume

この非同期な unformatVolume 呼び出しは、ボリュームから LTFS 形式を削除します。LTFS ボリュームをフォーマット解除すると、ボリュームから LTFS フォーマットヘッダー (メタデータおよびデータのパーティション) が削除され、標準の非 LTFS ボリュームになります。

この LTFS-LE Web サービスでは、確認を必要とせず、ボリュームの検証も一切行いません。ただし、ボリュームがフォーマット解除されると、そのボリューム上の以前のデータはすべて削除されます。ユーザーはフォーマット解除対象のボリュームを認識し、必ず正しいボリュームがフォーマット解除されるようにする必要があります。

前提条件:

ボリュームをフォーマット解除する前に、そのボリュームがオフラインかつ未割り当てであることを確認します。使用可能な互換性のあるドライブがあることを確認します。

これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • ボリュームが、前提条件で必要とされた状態にあることを確認します。

  • 必要に応じて、続行する前に修正アクションを取ります。

呼び出す LTFS-LE Web サービスチェーン:

unformatVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合、ボリュームは LTFS-LE でフォーマットされなくなり、LTFS-LE フォーマットはボリュームから削除されています。

形式

unformatVolume(String volser)

パラメータ

  • volser は、フォーマット解除されるボリュームのシリアル番号です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームをフォーマット解除する前にそのボリュームがライブラリ内に存在せず、かつオンライン、未割り当て、および使用不可である場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Online です。

  • ボリューム SL0010 の assignedStatus が Unassigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

  • ボリューム EL0010 の inuseStatus が In use です。

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:unformatVolume>
         <arg0>F50344</arg0>
      </ns1:unformatVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp     xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unformatVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1216</return>
      </ns2:unformatVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unformatVolumeWithDrive

この非同期呼び出しは、ボリュームから LTFS 形式を削除します。LTFS ボリュームをフォーマット解除すると、ボリュームから LTFS フォーマットヘッダー (メタデータおよびデータのパーティション) が削除され、標準の非 LTFS ボリュームになります。

形式

unformatVolumeWithDrive (String volser, String drivesn)

前提条件:

ボリュームとドライブはライブラリ内に存在する必要があります。ボリュームとドライブは互換性がある必要があります。ボリュームは未割り当て、オフライン、および使用可能である必要があります。ドライブはアイドル状態、オンライン状態、または使用可能な状態になっている必要があります。

これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • ボリュームが、前提条件で必要とされた状態にあることを確認します。

  • 必要に応じて、続行する前に修正アクションを取ります。

呼び出す LTFS-LE Web サービスチェーン:

unformatVolumeWithDrive(volser,drivesn)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームが LTFS-LE でフォーマットされます。

パラメータ

  • volser は、フォーマット解除されるボリュームシリアル番号です。

  • drivesn は、文字と数字から成る文字列であるドライブシリアル番号です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームがライブラリ内に存在せず、かつオフライン、未割り当て、使用中、および使用不可である場合、またはドライブがボリュームと互換性がないか、ライブラリ内に存在する場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Online です。

  • ボリューム SL0010 の assignedStatus が Unassigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

  • ボリューム EL0010 の inuseStatus が In use です。

  • ボリュームのタイプ LTO-5 がドライブのタイプ T1C と互換性がありません。

  • ドライブ HP23112 が LTFS ライブラリ内に見つかりません。

  • ドライブ 123456 の availableStatus が In use です。

  • ドライブ 123456 の onlineStatus が Offline です。

  • ドライブ 123456 の assignedStatus が Unassigned です。

推奨されるタイムアウト

7200 秒

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="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:unformatVolumeWithDrive>
         <arg0>F50344</arg0>
         <arg1>576001000421</arg1>
      </ns1:unformatVolumeWithDrive>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp       xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unformatVolumeWithDriveResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1216</return>
      </ns2:unformatVolumeWithDriveResponse>
   </S:Body>
</S:Envelope>

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>The volume's type LTO-5 is not compatible with drive's type T1C</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume's type LTO-5 is not compatible with drive's type T1C</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

vaultVolume

この API 関数は、LTFS-LE のデフォルトボリュームプール内にある 1 つ以上の LTFS-LE ボリュームをボールティングします。1 回につき 1 つのボリュームのみをボールティングできます。

この非同期呼び出しは、CAP (メールスロット) を使用して最大 30 ボリュームをボールティングできます。メールスロットには 4 ボリューム分の余地があります。ユーザーが 30 ボリュームをボールティングした場合は、すべてのイジェクトが完了するまで、ボリュームは 1 回につき 4 つずつメールスロットに送られます。

形式

vaultVolume(String[] volsers,String acs,String lsm,String cap)

前提条件:

ボールティングの前に、CAP が使用可能であることと、ボリュームがファイナライズ済みでオフラインになっていることを確認します。ボリュームの総数は 30 以下にするようにしてください。ボリュームは同じライブラリ内に構成されている必要があります。これを行うには:

  • ボリュームステータスを取得します。

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • ボリュームがオンラインの割り当て済み状態である場合は、そのボリュームをファイナライズします。

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    
  • ボリュームがオンラインである場合は、vaultVolume API 呼び出しを実行する前にそのボリュームをオフラインにします。

    offlineVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    

呼び出す LTFS-LE Web サービスチェーン:

vaultVolume([volser1,volser2,...],acs,lsm,cap)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

事後条件:

一連の Web サービス呼び出しの実行が完了すると、結果は XML ドキュメントになります。それらを適切な戻りコードに変換する必要があります。API 呼び出しが成功した場合は、ボリュームがライブラリにエンターされます。ユーザーはライブラリのところに行き、CAP のドアを開いたあとにそのボリュームを取り出す必要があります。

パラメータ

  • volser は、ボールティングされるボリューム (複数も可) のシリアル番号です。

  • acs は、ライブラリ ACS 識別子です。

  • lsm は、ライブラリ LSM 識別子です。

  • cap は、ボリュームのイジェクトに使用されるライブラリ CAP (メールスロット) ID です。

  • jobId は、ジョブのステータスおよび結果を取得するために使用されるジョブ ID です。

応答

SOAP 応答の例に有効な応答が示されています。定義については、用語集を参照してください。

ロール

「Admin」または「Service」

スローされる例外

ValidationFailedException

例外がスローされることがあります。

  • volser シリアル番号が入力されない場合、スローされる例外は「パラメータ volser は null です」になります。

  • ボリュームをボールティングする前にそれがライブラリ内に存在せず、かつオンライン、未割り当て、プールに入っていない、および使用不可である場合、使用可能なステータスによって検証失敗例外が「volume [volume sn] status is []」としてスローされます。

次の例を参照してください。

  • ボリューム EL0010 が LTFS ライブラリ内に見つかりません。

  • ボリューム SL0010 の onlineStatus が Online です。

  • ボリューム SL0010 の assignedStatus が Unassigned です。

  • ボリューム SL0010 の availableStatus が Unavailable です。

  • ボリューム EL0010 の inuseStatus が In use です。

推奨されるタイムアウト

これは、管理者が CAP (メールスロット) からボリュームを取り除くのにかかる時間によって異なります。

推奨されるジョブのポーリング間隔

10 秒

SOAP リクエスト

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="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:vaultVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
         <arg1>3</arg1>
         <arg2>0</arg2>
         <arg3>1</arg3>
      </ns1:vaultVolume>
   </env:Body>
</env:Envelope>

SOAP 応答

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:vaultVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1214</return>
      </ns2:vaultVolumeResponse>
   </S:Body>
</S:Envelope>

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>The volume EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>