7.1.28 実行エージェントの状態の変更API
マネージャーホストに登録されている実行エージェントに対して,状態を変更します。複数の実行エージェントを指定して変更することもできます。
ジョブ配信遅延の軽減機能が有効な場合,実行エージェントの状態を変更できます。ジョブ配信遅延の軽減機能が無効な場合,返却される実行エージェントの操作結果はすべてエラーになります。
ジョブ配信遅延の軽減機能については,マニュアル「JP1/Automatic Job Management System 3 設計ガイド(システム構築編) 2.5.5 ジョブ配信遅延の軽減の検討」を参照してください。
このAPIは,JP1/AJS3 - Web Consoleのバージョンが12-50以降,かつ接続先JP1/AJS3 - Managerのバージョンが12-50以降の場合だけ指定できます。バージョン情報の取得APIの戻り値(productVersionNumber)が125000以上,かつJP1/AJS3 - Managerのプロトコルバージョンの取得APIの戻り値(protocolVersionNumber)が1250以上であることを確認して,指定してください。
- 実行権限
-
ログインしたJP1ユーザーが,次に示すどれかのJP1権限レベルが与えられている必要があります。
-
JP1_JPQ_Admin権限
-
JP1_JPQ_Operator権限
-
- リクエストの形式
-
- リクエスト行
POST /application/component/apiVersion/objects/execAgents/actions/changeComStatus/invoke httpVersion
- メッセージボディ
{ "parameters":{ "manager":"マネージャーホスト名またはIPアドレス", "comStatus":"実行エージェントの状態", "execAgents":["実行エージェント",...] } }
- APIのバージョン
-
v1
- リソースを一意に識別する情報
-
なし
- パラメーター
-
リクエストのメッセージボディのparametersに指定するパラメーターを次の表に示します。
表7‒28 実行エージェントの状態の変更APIのパラメーター一覧 パラメーター
データ型
値の説明
必須・任意
manager
string
マネージャーホスト名またはIPアドレスを,1〜255バイトの文字列で指定します。
必須
comStatus
string
実行エージェントの状態を,定数ComStatusに規定した文字列定数で指定します。
定数ComStatusの詳細については,「7.4.14(2) ComStatus」を参照してください。
必須
execAgent
string[]
実行エージェント名を,文字列の配列で指定します。実行エージェントは最大100個まで指定できます。
一つの実行エージェント名は,1〜255バイトの文字列で指定します。
必須
- ステータスコード
-
レスポンスで返却するステータスコードを次の表に示します。
ステータスコード
テキスト記述
説明
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[]
実行エージェントの操作結果オブジェクトの配列を返却します。
配列の要素数は,パラメーターexecAgentsに指定された配列の要素数と同じです。
また,マネージャーホスト上でコマンドが異常終了した場合は,対象処理の結果コードに「0」以外を格納し,メッセージに「KNAK3696-E」を格納して返却します。
実行エージェントの操作結果オブジェクトの詳細については,「7.3.6 実行エージェントの操作結果オブジェクト」を参照してください。
- 注意事項
-
JP1/AJS3 - Web Consoleでエラーが発生した場合でも,マネージャーホストで実行エージェントの操作に成功していることがあります。
- 使用例
-
実行エージェントの状態を変更するAPIの使用例を次に示します。
- リクエストの例
POST /ajs/api/v1/objects/execAgents/actions/changeComStatus/invoke HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja Content-Type: application/json X-AJS-Authorization: dXNlcjpwYXNzd29yZA== { "parameters":{ "manager":"HOSTM", "comStatus":"UNAVAILABLE", "execAgents":["AGT01"] } }
- レスポンス(メッセージボディ)の例
{ "results": [ { "rtnCode":"0", "output":null, "execAgent":"AGT01" } ] }