7.1.36　実行エージェントの除外，追加，優先順位の変更API

マネージャーホストに登録されている実行エージェントグループに対して，実行エージェントの除外，追加，または優先順位の変更をします。

実行権限

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

JP1_JPQ_Admin権限

リクエストの形式

リクエスト行

POST /application/component/apiVersion/objects/execAgents/actions/chengeLinkAgent/invoke httpVersion

リクエストのメッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "execAgentGroup":"実行エージェントグループ名",
    "action":"対象の操作",
    "execAgent":"実行エージェント名",
    "priority":優先順位
  }
}

APIのバージョン

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

なし

パラメーター

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

表7‒36　実行エージェントの除外，追加，優先順位の変更APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`execAgentGroup`	string	実行エージェントグループ名を指定します。実行エージェントグループ名は，1〜255バイトの文字列で指定します。	必須
`action`	string	対象の操作を文字列で指定します。実行エージェントの除外の場合は「`remove`」，実行エージェントの追加の場合は「`add`」，実行エージェントの優先順位の変更の場合は「`changePriority`」を指定します。	必須
`execAgent`	string	除外，追加，優先順位の変更をする実行エージェント名を，1〜255バイトの文字列で指定します。一つの実行エージェントグループ名は，1〜255バイトの文字列で指定します。	必須
`priority`	int	優先順位を，1〜16の範囲の数値で指定します。パラメーター`action`に「`remove`」を指定した場合，または優先順位を指定しない場合はこのパラメーターを指定しないでください。	任意

ステータスコード

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

ステータスコード	メッセージ	説明
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/actions/chengeLinkAgent/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-Type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "execAgentGroup":"AGTG01",
    "action":"add",
    "execAgent":"AGT03",
    "priority":1
  }
}

レスポンスの例

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Date: Tue, 25 Aug 2020 11:51:42 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
    "results":
    [
        {
            "execAgent":"AGTG01",
            "rtnCode":"0",
            "output":null
        }
    ]
}

ページの先頭へ

7.1.36 実行エージェントの除外，追加，優先順位の変更API

7.1.36　実行エージェントの除外，追加，優先順位の変更API