7.1.24　実行エージェントの追加API

マネージャーホストに実行エージェントを追加します。

この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権限

リクエストの形式

リクエスト行

POST /application/component/apiVersion/objects/execAgents httpVersion

メッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "mode":"対象モード",
    "execAgent":"実行エージェント名",
    "execHost":"実行ホスト名",
    "timePeriods":[{
    "timePeriod":"時間帯",
    "conExe":ジョブ実行多重度
    },...],
    "status":"実行エージェントの受付配信制限の状態",
    "description":"説明文"
  }
}

APIのバージョン

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

なし

パラメーター

リクエストのメッセージボディのparametersに指定するパラメーターを次の表に示します。

表7‒24　実行エージェントの追加APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`mode`	string	対象のモードを文字列で指定します。ここでは「`agent`」を指定します。	必須
`execAgent`	string	実行エージェント名を，1〜255バイトの文字列で指定します。	必須
`execHost`	string	ジョブの実行先ホスト名を，0〜255バイトの文字列で指定します。ジョブの実行先ホスト名を指定しない場合は，このパラメーターを指定しないか，空文字列（0バイト）を指定してください。	任意
`timePeriods`	object[]	ジョブ実行多重度を，オブジェクトの配列で指定します。ジョブ実行多重度を指定しない場合は，このパラメーターを指定しないか，空オブジェクト（要素数0のオブジェクト）または「`null`」を指定してください。	任意
`timePeriod`	string	ジョブ実行多重度を指定する時間帯を，「hh`:`mm`-`hh`:`mm」の形式で指定します。指定できる値を次に示します。 hh：時間を指定します。時間に指定できる値は00〜23（単位：時）です。 mm：分を指定します。分に指定できる値は00または30（単位：分）です。	必須
`conExe`	long	指定した時間帯のジョブ実行多重度を，0〜4294967295の範囲の数値で指定します。	必須
`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 実行エージェントの操作結果オブジェクト」を参照してください。

メンバー

データ型

説明

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":"agent",
    "execAgent":"AGT01",
    "execHost":"AGT01",
    "timePeriods":[{
      "timePeriod":"00:00-00:00",
      "conExe":20
    }],
    "status":"BLOCKADE",
    "description":"test"
  }
}

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

{
    "results":
    [
        {
            "rtnCode":"0",
            "output":null,
            "execAgent":"AGT01"
        }
    ]
}

ページの先頭へ

7.1.24 実行エージェントの追加API

7.1.24　実行エージェントの追加API