2 API の使用

このドキュメントで説明されている Web サービスは、LTFS-LE 1.0.4.01 リリースのソフトウェアでのみ使用できます。

Web Services Description Language ファイルへのアクセス

プログラマは、インストールされているバージョンの LTFS-LE ソフトウェアで利用できる Web サービスのサポートされているシグネチャーを Web Services Description Language 1.1 (WSDL) ファイルから取得できます。このファイルには次の場所からアクセスできます。

https://server.mydomain.com:7002/LTFS/LTFSLEWS?WSDL

上記の例では、server.mydomain.com はホスト名とドメイン名です。

プログラミングの事例によっては、次のポート名が必要になることもあります。

port name="LTFSLEWSSoap12HttpPort"

API 関数

LTFS LE Web サービスのバックエンドの実行時間はさまざまです。ボリュームまたは操作のステータスに関連する Web サービスはすぐに返すことができます。しかし、一部の Web サービスの実行時間は、ソフトウェアでは制御できないいくつかの要因に左右されます。ユーザーアクションなどの機械的要因は、ソフトウェアには予測できません。たとえば、Assign Volume サービスなどの一部の Web サービスは、ボリュームに多数のファイルが含まれていると、より時間がかかる可能性があります。別の例を挙げると、イジェクト操作の完了はライブラリのところに行き、CAP からボリュームを取り外すオペレータによって異なります。

これらの食い違いに対処し、なおかつすべての Web サービス呼び出しにわたって一貫したプログラムインタフェースを提供するために、API サービス呼び出しはただちに復帰します。返される結果はサービスの種類によって異なります。LTFS LE には、2 つのカテゴリの Web サービスがあります。

  • ステータスサービス

    ステータスサービスとは、ユーザーがボリュームやドライブのステータスを取得できるサービスです。詳細は、ステータスサービスを参照してください。

  • 管理サービス

    管理サービスとは、ハードウェアリソースを管理するサービスです。たとえば、管理サービスを使用してボリュームのエンターやボリュームのイジェクトを行なったり、ボリュームをオンラインまたはオフラインにしたりします。詳細は、管理サービスを参照してください。

API 関数の呼び出し

管理サービスでは、2 つの手順から成るプロセスを使用して API 関数を呼び出し、結果を返します。

  1. 関数を呼び出します。一意のリクエストジョブ ID が即時に返されます。

  2. 手順 1 で返されたジョブ ID を指定して getJobStatus 関数を呼び出します。

    これにより、次のジョブステータスのいずれかが返されます。

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

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

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

シグネチャー

LTFS-LE Web サービスのシグネチャーには、それぞれ SOAP リクエストメッセージフォーマット、SOAP 応答メッセージフォーマット、および SOAP フォルトメッセージフォーマットが含まれています。すべての LTFS LE Web サービスは SOAP メッセージのみをサポートしています。SOAP メッセージフォーマットは SOAP 1.2 仕様を実装しています。各関数に有効な SOAP シグネチャーについては、ステータスサービスおよび管理サービスを参照してください。

一般ノート

  • このドキュメントで概説されている Web サービスは、LTFS-LE 1.0.4.01 リリースのソフトウェアでのみ使用できます。

  • すべての Web サービス API には、HTTPS 経由でのみアクセスできます。

  • Web サービスセキュリティーを使用すると、Web サービス API のすべての SOAP リクエストメッセージの SOAP ヘッダーに、ユーザー名とパスワードがすべてプレーンテキストで記述されているユーザー名トークンが含められます

  • usernamepassword は、ユーザー名トークンで一例として使用されているにすぎません。有効なユーザー名とパスワードに置き換える必要があります

  • SOAP リクエストおよび応答メッセージで使用されるデータはすべて、SOAP リクエストおよび応答メッセージのデータ構造を示すためだけのサンプルデータです。