MFT エージェント状況の取得

REST API を使用して Managed File Transfer エージェント状況を取得する方法

詳しくは、 REST APIによる管理を参照してください。

エージェント状況を取得するには、以下のようにします。

MFT およびMFT Web アプリケーションを使用しているデフォルトの調整キュー・マネージャーの下で、エージェントに GET 要求を送信します。要求の送信時に URL の形式を検討する必要があります。
詳しくは、 admin/mft/agent を参照してください。
要求が受信されると、要求が有効かどうかを確認するための検査が実行されます。
詳しくは、 MFT REST API セキュリティーの構成を参照してください。
要求が有効な場合は、成功応答と応答本体を受け取ります。そうでない場合は、該当するエラー・コードと応答コードが生成されます。
応答のリストについては、応答状況コードを参照してください。

URL の例

{baseURI}/ibmmq/rest/{version}/admin/mft/agent: 調整キュー・マネージャーの管理下にあるすべてのエージェントの name、state、type のリストを出力します。; これらの属性について詳しくは、「エージェント状況」 REST API 属性を参照してください。; URL ストリングの末尾に ?attributes=* を追加すると、調整キュー・マネージャーの管理下にある各エージェントのすべての属性のリストが出力に組み込まれます。; URL ストリングの末尾に /{agentName} を追加すると、 agentNameに一致するエージェントの name、 state、および type が出力に含まれます。; URL ストリングの末尾に /{agentName}?attributes=* を追加すると、agentName に合致するエージェントのすべての属性のリストが出力に組み込まれます。
{baseURI}/ibmmq/rest/{version}/admin/mft/agent?name={<prefix>*<suffix> }: 例えば、{baseURI}/ibmmq/rest/{version}/admin/mft/agent?name=AGENT*TEST を使用すると、AGENT という名前で始まり TEST という名前で終わるエージェントのデフォルト属性の要約が出力されます。; URL から *TEST を省略すると、AGENT という名前で始まるすべてのエージェントのデフォルト属性の要約が出力に組み込まれます。
{baseURI}/ibmmq/rest/{version}/admin/mft/agent?type={agentType}: 例えば、{baseURI}/ibmmq/rest/{version}/admin/mft/agent?type=standard を使用すると、standard タイプのエージェントのデフォルト属性の要約が出力されます。; type={agentType} を state={agentState} で置き換えると、指定の状態のエージェントのデフォルト属性の要約が出力に表示されます。

{baseURI}/ibmmq/rest/{version}/admin/mft/agent?type={agentType}&attributes=*: 例えば、{baseURI}/ibmmq/rest/{version}/admin/mft/agent?type=standard&attributes=* を使用すると、standard タイプのエージェントのすべての属性が出力されます。

属性を組み合わせてフィルターを作成することもできます。以下に例を示します。

{baseURI}/ibmmq/rest/{version}/admin/mft/agent?name=*bob&type=standard&state=ready&attributes=*
{baseURI}/ibmmq/rest/{version}/admin/mft/agent?type=standard&state=ready&attributes=*
{baseURI}/ibmmq/rest/{version}/admin/mft/agent?name=agent*&state=ready&attributes=*

応答本体の例

説明されている属性について詳しくは、エージェント状況 REST API 属性およびエージェント状況 REST API 応答本体属性を参照してください。

/ibmmq/rest/v1/admin/mft/agent/ コマンドを実行し、基本的なエージェント状況 (名前、タイプ、状態) のリストを表示します。以下に例を示します。


{
     “agent”:[  {“name”: “AGENT1”,
                        “state" : "ready",
                        “type”:”standard”},
                      {“name”: “AGENT2”,
                        “state" : "ready",
                        “type”:”standard”},
                     { “name”: “BRIDGE_AGENT3”,                
                        “type” : “protocolBridge”,
                        “state" : "ready"},
                     {“name”: “CD_AGENT”,
                        “type”:”connectDirectBridge”,
                      “state" : "ready "}]
}

以下の各コマンドを実行します。


/ibmmq/rest/v1/ admin/mft/agent?type=standard
/ibmmq/rest/v1/admin/mft/agent?state=stopped
/ibmmq/rest/v1/admin/mft/agent?name=AGENT*

各コマンドで指定した名前、状態、タイプに合致するエージェントの基本情報のリストを表示します。以下に例を示します。


{ “agent”:[  {“name”: “AGENT1”,
                        “state" : "ready",
                        “type”:”standard”},
                     {“name”: “AGENT2”,
                       “state" : "ready",
                       “type”:”standard”}  ]
}
{ “agent”:[  {“name”: “AGENT1”,
                        “state" : "stopped",
                        “type”:”standard”},
                     {“name”: “AGENT2”,
                       “state" : "stopped",
                       “type”:”standard”} ]
}
{    “agent”:[  {“name”: “AGENT1”,
                        “state" : "ready",
                        “type”:”standard”},
                     {“name”: “AGENT2”,
                       “state" : "ready",
                       “type”:”standard”}  ]
}

次のコマンドを発行すると、 /ibmmq/rest/v1/admin/mft/agent?attributes=general&type=standard は、タイプ standardのすべてのメッセージを general 属性とともにリストします。以下に例を示します。

{
     “agent”:[
            {“name”: “AGENT1”,
              “state" : "ready",
              “type”:”standard”,
              “general”: { “description” : “Standard connected to the qmgr in client mode”, 
                                  “statusAge" : “06:31:00”, 
                                  “version” : “9.0.3.0”, 
                                  “level” : “p903-L170513”,   
                                        “statusPublicationRate” : 300,  
                                 “statusPublishTime” : "2017-10-31T06:57:07.000Z",
                                 “maximumQueuedTransfers” : 1000, 
                                 “maximumDestinationTransfers”:25,
                                “maximumSourceTransfers”:25,
                                 “operatingSystem” : “Windows7” } 
         },
        {“name”: “AGENT2”,
          “state" : "ready",
           “type”:”standard”
            “general” : { “description” : “Standard connected to qmgr in Binding mode”,
                                  “statusAge ":“05:00:00”,      
                                  “version” : “9.0.3.0”, 
                                “level” : “p903-L170513”, 
                                “statusPublicationRate” : 300, 
                                “statusPublishTime” : “2017-09-13T09:10:09.000Z”,
                               “maximumQueuedTransfers” : 1000, 
                               “maximumDestinationTransfers”:25,
                              “maximumSourceTransfers”:25,
                              “operatingSystem” : “Windows7” }  
             }
   ]
}