Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 コマンドリファレンス


7.1.35 実行エージェントグループの受付配信制限の状態の変更API

マネージャーホストに登録されている実行エージェントグループに対して,受付配信制限の状態を変更します。複数の実行エージェントグループを指定して変更することもできます。

実行権限

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

  • JP1_JPQ_Admin権限

  • JP1_JPQ_Operator権限

リクエストの形式
リクエスト行
POST /application/component/apiVersion/objects/execAgents/actions/changeStatus/invoke httpVersion
メッセージボディ
{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "mode":"agentGroup",
    "status":"実行エージェントグループの受付配信制限の状態",
    "execAgents":["実行エージェントグループ名",...]
  }
}
APIのバージョン

v1

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

なし

パラメーター

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

表7‒35 実行エージェントグループの受付配信制限の状態の変更APIのパラメーター一覧

パラメーター

データ型

値の説明

必須・任意

manager

string

マネージャーホスト名またはIPアドレスを,1〜255バイトの文字列で指定します。

必須

mode

string

対象のモードを文字列で指定します。ここでは「agentGroup」を指定します。

必須

status

string

実行エージェントグループの受付配信制限の状態を,定数ExecAgentStatusに規定した文字列定数で指定します。

定数ExecAgentStatusの詳細については,「7.4.14(1) ExecAgentStatus」を参照してください。

必須

execAgents

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/changeStatus/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-Type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "mode":"agentGroup",
    "status":"HOLD",
    "execAgents":["AGTG01"]
  }
}
レスポンスの例
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Date: Tue, 25 Aug 2020 09:19:15 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
    "results":
    [
        {
            "execAgent":"AGTG01",
            "rtnCode":"0",
            "output":null
        }
    ]
}