7.1.32 実行エージェントグループの追加API
マネージャーホストに実行エージェントグループを追加します。
- 実行権限
-
ログインしたJP1ユーザーが,次に示すJP1権限レベルが与えられている必要があります。
-
JP1_JPQ_Admin権限
-
- リクエストの形式
-
- リクエスト行
POST /application/component/apiVersion/objects/execAgents httpVersion
- メッセージボディ
{ "parameters":{ "manager":"マネージャーホスト名またはIPアドレス", "mode":"対象モード", "execAgent":"実行エージェントグループ名", "status":"実行エージェントグループの受付配信制限の状態", "description":"説明文" } }
- APIのバージョン
-
v1
- リソースを一意に識別する情報
-
なし
- パラメーター
-
リクエストのメッセージボディのparametersに指定するパラメーターを次の表に示します。
表7‒32 実行エージェントグループの追加APIのパラメーター一覧 パラメーター
データ型
値の説明
必須・任意
manager
string
マネージャーホスト名またはIPアドレスを,1〜255バイトの文字列で指定します。
必須
mode
string
対象のモードを文字列で指定します。ここでは「agentGroup」を指定します。
必須
execAgent
string
実行エージェントグループ名を,1〜255バイトの文字列で指定します。
必須
status
string
実行エージェントグループの受付配信制限の状態を,定数ExecAgentStatusに規定した文字列定数で指定します。
定数ExecAgentStatusの詳細については,「7.4.14(1) ExecAgentStatus」を参照してください。
実行エージェントグループの受付配信制限の状態を指定しない場合は,このパラメーターを指定しないか,空文字列(0バイト)を指定してください。
任意
description
string
説明文を0〜80バイトの文字列で指定します。
説明文を指定しない場合は,このパラメーターを指定しないか,空文字列(0バイト)を指定してください。
任意
- ステータスコード
-
レスポンスで返却するステータスコードを次の表に示します。
ステータスコード
メッセージ
説明
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 実行エージェントの操作結果オブジェクト」を参照してください。
- 注意事項
-
JP1/AJS3 - Web Consoleでエラーが発生した場合でも,マネージャーホストで実行エージェントの操作に成功していることがあります。
- 使用例
-
実行エージェントグループを追加するAPIの使用例を次に示します。
- リクエストの例
POST /ajs/api/v1/objects/execAgents HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja Content-Type: application/json X-AJS-Authorization: dXNlcjpwYXNzd29yZA== { "parameters":{ "manager":"HOSTM", "mode":"agentGroup", "execAgent":"AGTG01", "status":"BLOCKADE", "description":"test" } }
- レスポンスの例
HTTP/1.1 200 OK Content-Type: application/json Cache-Control: no-store, no-cache, max-age=0 Date: Tue, 25 Aug 2020 08:15:36 GMT Expires: Thu, 01 Jan 1970 00:00:00 GMT Pragma: no-cache Server: Cosminexus HTTP Server { "results": [ { "execAgent":"AGTG01", "rtnCode":"0", "output":null } ] }