7.1.34　実行エージェントグループの設定変更API

マネージャーホストに設定されている実行エージェントグループの設定を変更します。

実行権限

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

JP1_JPQ_Admin権限

リクエストの形式

リクエスト行

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

メッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "mode":"対象モード",
    "execAgent":"実行エージェントグループ名",
    "description":"説明文"
  }
}

APIのバージョン

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

なし

パラメーター

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

表7‒34　実行エージェントグループの設定変更APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`mode`	string	対象のモードを文字列で指定します。ここでは「`agentGroup`」を指定します。	必須
`execAgent`	string	設定変更する実行エージェント名を，1〜255バイトの文字列で指定します。	必須
`description`	string	説明文を0〜80バイトの文字列で指定します。	必須

ステータスコード

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

ステータスコード	メッセージ	説明
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/update/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-Type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "mode":"agentGroup",
    "execAgent":"AGTG01",
    "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:50:53 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.34 実行エージェントグループの設定変更API

7.1.34　実行エージェントグループの設定変更API