7.1.21　実行エージェントの状況一覧の取得API

マネージャーホストに登録されている実行エージェントの状況一覧を取得します。

実行権限

ログインしたJP1ユーザーが，次に示すどれかのJP1権限レベルが与えられている必要があります。

JP1_JPQ_Admin権限
JP1_JPQ_Operator権限
JP1_JPQ_User権限

リクエストの形式

リクエスト行

GET /application/component/apiVersion/objects/execAgents/statuses?query httpVersion

APIのバージョン

リソースを一意に識別する情報

なし

パラメーター

「query」に指定するパラメーターを次の表に示します。

表7‒21　実行エージェントの状況一覧の取得APIのパラメーター一覧
パラメーター	値の説明	必須・任意
`manager`	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`mode`	取得するモードを文字列で指定します。ここでは「`agent`」を指定します。	必須

ステータスコード

レスポンスで返却するステータスコードを次の表に示します。

ステータスコード	メッセージ	説明
200	OK	実行エージェントの状況一覧の取得に成功しました。
400	Bad Request	クエリ文字列が不正です。
401	Unauthorized	認証が必要です。
403	Forbidden	実行権限がありません。
404	Not found	リソースにアクセスする権限がありません。または，リソースがありません。
412	Precondition failed	Web Consoleサーバが利用できません。
500	Server-side error	Web Consoleサーバ処理エラーが発生しました。

レスポンスの形式

レスポンスのメッセージボディ

{
  "results":[実行エージェントの操作結果オブジェクト]
}

戻り値

ステータスコードが「200」の場合，次の情報を返却します。

メンバー	データ型	説明
`results`	object[]	実行エージェントの操作結果オブジェクトの配列を返却します。配列の要素の0番目に，実行エージェントの状況の取得結果を格納して返却します。また，マネージャーホスト上でコマンドが異常終了した場合は，対象処理の結果コードに「`0`」以外を格納し，メッセージに「KNAK3696-E」を格納して返却します。実行エージェントの操作結果オブジェクトの詳細については，「7.3.6 実行エージェントの操作結果オブジェクト」を参照してください。

メンバー

データ型

説明

results

object[]

実行エージェントの操作結果オブジェクトの配列を返却します。配列の要素の0番目に，実行エージェントの状況の取得結果を格納して返却します。

また，マネージャーホスト上でコマンドが異常終了した場合は，対象処理の結果コードに「0」以外を格納し，メッセージに「KNAK3696-E」を格納して返却します。

実行エージェントの操作結果オブジェクトの詳細については，「7.3.6 実行エージェントの操作結果オブジェクト」を参照してください。

使用例

実行エージェントの状況一覧を取得するAPIの使用例を次に示します。

リクエストの例

GET /ajs/api/v1/objects/execAgents/statuses?manager=HOSTM&mode=agent HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==

レスポンスの例

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Date: Wed, 26 Aug 2020 00:09:14 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
    "results":
    [
        {
            "execAgent":"",
            "rtnCode":"0",
            "output":
            {
                "text":"",
                "serverTime":"2020-08-26T09:09:14+09:00",
                "statuses":
                [
                    {
                        "comStatus":"NOTCHECKED",
                        "conExe":5,
                        "status":"EFFECTIVE",
                        "description":"",
                        "execAgent":"@SYSTEM",
                        "execHost":"HISOL8139682",
                        "que":0,
                        "job":0,
                        "event":0
                    },
                    {
                        "comStatus":"NOTCHECKED",
                        "conExe":20,
                        "status":"BLOCKADE",
                        "description":"test",
                        "execAgent":"AGT01",
                        "execHost":"AGT01",
                        "que":0,
                        "job":0,
                        "event":0
                    }
                ],
                "definitions":null
            }
        }
    ]
}

ページの先頭へ

7.1.21 実行エージェントの状況一覧の取得API

7.1.21　実行エージェントの状況一覧の取得API