GET

agentName

(オプション) 照会するエージェントの名前を指定します。

小文字または大/小文字混合で入力されたエージェント名は大文字に変換されます。 REST サービスからの応答として受け取るエージェント名の値は、常に大文字です。

エージェント名は最大 28 文字であり、IBM® MQ オブジェクトの命名規則に準拠していなければなりません。 IBM MQ オブジェクトの命名規則に加えて、パーセント (%) 文字をエージェント名に使用することはできません。

attributes={object,...|*|object.attributeName,...}

object

詳細全体のサブセクションである 1 つの JSON オブジェクトに追加される JSON オブジェクトをコンマ区切りリストで指定します。

以下に例を示します。

• すべてのエージェントまたは特定のエージェントのすべての一般的な詳細を返すには、general を指定します。
• すべてのエージェントまたは特定のエージェントのキュー・マネージャー接続の全詳細を返すには、qmgrConnection を指定します。
• connect direct ブリッジ・エージェントの詳細を返すには、connectDirectBridge を指定します。 (エージェント・タイプが「connect direct bridge」の場合にのみ使用可能)
• プロトコル・エージェントの詳細を返すには、protocolBridge を指定します。 (エージェント・タイプが「protocal bridge」の場合にのみ使用可能)

属性の完全なリストについては、 エージェントの応答本体の属性 を参照してください。

*

すべての属性を指定します。

object.attributeName.,...

戻すエージェント属性をコンマ区切りのリストにして指定します。

各属性は、属性を含む JSON オブジェクトをobject.attributeNameの形式で指定する必要があります。 例えば、一般オブジェクトに含まれているstatusAge属性を返すには、general.statusAgeと指定します。

同じ属性を複数回指定することはできません。 特定のエージェントにとって有効でない属性を要求した場合、そのエージェントの属性は返されません。

指定されたパターンを持つ特定のタイプ、状態、または名前のエージェント・セットの詳細を照会できます。

name=validPattern
state=valid atent State
type=validType

要求で以下のヘッダーを送信する必要があります。

許可

基本認証を使用している場合、このヘッダーを送信する必要があります。 詳しくは、 REST APIでの HTTP 基本認証の使用を参照してください。

200

エージェント情報は正常に取得されました。

400

無効なデータが指定されました。

例えば、無効なエージェント属性が指定されました。

401

認証されませんでした。

呼び出し元は mqweb サーバーで認証を受ける必要があります。また、呼び出し元は MFTWebAdmin 役割または MFTWebAdminRO 役割のうち 1 つ以上の役割を持つメンバーでなければなりません。 詳しくは、 セキュリティー要件を参照してください。

403

許可がありません。

呼び出し元は mqweb サーバーで認証を受け、有効なプリンシパルと関連付けられました。 しかし、プリンシパルには、必要な IBM MQ リソースのすべてまたはサブセットに対するアクセス権がありません。 必要なアクセス権について詳しくは、 セキュリティー要件を参照してください。

404

エージェントが存在しません。

500

IBM MQからのサーバーの問題またはエラー・コード。

503

キュー・マネージャーが実行されていません。

Content-Type

このヘッダーは、値 application/json;charset=utf-8 と一緒に返されます。

応答は、UTF-8 エンコードの JSON 形式です。 応答には、agentという単一の JSON 配列を含む外部 JSON オブジェクトが含まれています。 その配列の各エレメントは、エージェントに関する情報を表す JSON オブジェクトです。 これらの JSON オブジェクトにはそれぞれ、以下の属性が含まれています。

名前

ストリング。

エージェントの名前を示します。

この属性は、常に返されます。

タイプ

ストリング。

エージェントのタイプを示します。

値は、以下のいずれかの値です。

• standard
• connectDirectBridge
• protocolBridge

state

エージェントの状態を示します。 値は、次の値のうちのいずれかです。

• アクティブ
• ready
• 始動
• unreachable
• stopped

以下の例では、すべてのエージェントの基本的な詳細を返します。つまり、以下の情報のみが表示されます。

• エージェント名
• エージェント・タイプ
• エージェントの状態

HTTP GET メソッドで以下の URL を使用します。

https://localhost:9443/ibmmq/rest/v1/admin/mft/agent/

以下の JSON 応答が返されます。

{
     “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 "}]
}

以下の例では、standardタイプのすべてのエージェントをgeneralオブジェクトとともにリストします。 HTTP GET メソッドで以下の URL を使用します。

https://localhost:9443/ibmmq/rest/v1/admin/mft/agent?attributes=general&type=standard 

以下の JSON 応答が返されます。

{
     “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” }  
             }
   ]
}          

以下の例では、AGENT という名前で始まり、ready状態で、タイプstandardのすべてのエージェントを、ステータス・エイジのgeneralオブジェクトとともにリストします。 HTTP GET メソッドで以下の URL を使用します。

https://localhost:9443/ibmmq/rest/v1/admin/mft/agent?name=AGENT*&state=ready&type=standard&attributes=general.statusAge

以下の JSON 応答が返されます。

{“agent”:[
              {   “name”: “AGENT1”,
                   “state" : "ready",
                   “type”:”standard”,
                   “general”:
                      { “statusAge" : “05:00:00” }
                 },
                { “name”: “AGENT2”,
                   “state" : "ready",
                   “type”:”standard”
                   “general” : 
                     { “ statusAge”: “03:00:00”}
               },
              { “name”: “AGENT3”,               
                 “state" : "ready",
                 “type” : “standard” ,
                 “general”:
                     {  “statusAge " : “05:00:00”}
                }
            ]