REST API for MFT の概要

administrative REST API for Managed File Transfer を素早く開始し、 MFT エージェントの状況を表示したり、転送のリストを表示したりするためのいくつかの要求例を試します。

始める前に

  • これらの例では、 cURL を使用して REST 要求を送信し、転送のリストを表示して MFT エージェントの状況を表示します。 したがって、このタスクを実行するためには、ご使用のシステムに cURL がインストールされている必要があります。
  • このタスクを実行するには、 dspmqweb コマンドを使用するための特定の特権を持つユーザーでなければなりません。
    • [z/OS] z/OS®では、 dspmqweb コマンドを実行する権限と、 mqwebuser.xml ファイルへの書き込み権限が必要です。
    • [UNIX、Linux、Windows、IBM i]他のすべてのオペレーティング・システムでは、 特権ユーザーでなければなりません。

手順

  1. mqweb サーバーが administrative REST API for MFT用に構成されていることを確認します。
    • mqweb サーバーが administrative REST API、 administrative REST API for MFT、 messaging REST API、または IBM® MQ Console用にまだ構成されていない場合は、mqweb サーバーを構成します。基本レジストリーを使用して mqweb サーバーの基本構成を作成する方法について詳しくは、 mqweb サーバーの基本構成を参照してください。
    • mqweb サーバーが構成されている場合は、 mqweb サーバーの基本構成 のステップ 8 が完了して、 administrative REST API for MFTが使用可能になっていることを確認します。
  2. [z/OS] z/OSでは、 dspmqweb コマンドを使用できるように WLP_USER_DIR 環境変数を設定します。 次のコマンドを入力して、mqweb サーバー構成を指すように変数を設定します。
    export WLP_USER_DIR=WLP_user_directory
    ここで、 WLP_user_directory は、 crtmqwebに渡されるディレクトリーの名前です。 以下に例を示します。
    export WLP_USER_DIR=/var/mqm/web/installation1

    詳しくは、 mqweb サーバーの作成を参照してください。

  3. 次のコマンドを入力して、 REST API URL を決定します
    dspmqweb status
    以下の手順の例では、 REST API URL がURL https://localhost:9443/ibmmq/rest/v1/ であることを前提としています。 デフォルト以外の URL を使用している場合は、以下の手順の URL を置き換えてください。
  4. agent リソースに対して GET 要求を行い、名前、タイプ、状態など、すべてのエージェントに関する基本的な詳細を返します。
    curl -k https://localhost:9443/ibmmq/rest/v2/admin/mft/agent/ -X GET -u mftadmin:mftadmin
  5. fteCreateTransfer コマンドを使用して、表示するいくつかの転送を作成します。

    mqweb サーバーは、転送に関する情報をキャッシュに入れておき、要求されたときにその情報を返します。 このキャッシュは、mqweb サーバーが再始動するとリセットされます。 サーバーが再起動されたかどうかは、console.log and messages.log ファイルを見るか、ファイルを見るか、あるいはz/OS, スタートしたタスクの出力を見ることで確認できます。

  6. transfer リソースに対して GET 要求を行い、mqweb サーバーの開始以降に行われた最大 4 つの転送の詳細を返します。
    curl -k https://localhost:9443/ibmmq/rest/v2/admin/mft/transfer?limit=4 -X GET -u mftadmin:mftadmin

次のタスク