Hitachi

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


7.1.29 ジョブ配信遅延の軽減機能の通信状態確認API

マネージャーホストで,ジョブ配信遅延の軽減機能の通信状態の確認操作をします。次のうち,指定された操作をします。

ジョブ配信遅延の軽減機能が有効な場合だけ,このAPIで実行エージェントを操作できます。ジョブ配信遅延の軽減機能が無効な場合は,このAPIでの実行エージェントの操作はすべてエラーになります。

ジョブ配信遅延の軽減機能については,マニュアル「JP1/Automatic Job Management System 3 設計ガイド(システム構築編) 2.5.5 ジョブ配信遅延の軽減の検討」を参照してください。

実行権限

ログインしたJP1ユーザーが,次の管理者権限を持つOSユーザーにマッピングされている必要があります。

  • Windowsの場合:Administrators権限

  • UNIXの場合:スーパーユーザー権限

リクエストの形式
リクエスト行
POST /application/component/apiVersion/objects/execAgents/actions/check/invoke httpVersion
メッセージボディ
{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "action":"対象操作"
  }
}
APIのバージョン

v1

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

なし

パラメーター

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

表7‒29 ジョブ配信遅延の軽減機能の通信状態確認APIのパラメーター一覧

パラメーター

データ型

値の説明

任意・必須

manager

string

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

必須

action

string

対象の操作を文字列で指定します。

通信状態の確認開始の場合は「start」,通信状態の確認終了の場合は「stop」,通信状態の確認の場合は「status」を指定します。

必須

ステータスコード

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

ステータスコード

メッセージ

説明

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番目に実行結果を格納して返却します。

実行エージェントの操作結果オブジェクトの詳細については,「7.3.6 実行エージェントの操作結果オブジェクト」を参照してください。

注意事項

JP1/AJS3 - Web Consoleでエラーが発生した場合でも,マネージャーホストで実行エージェントの操作に成功していることがあります。

使用例

ジョブ配信遅延の軽減機能の通信状態を確認するAPIの使用例を次に示します。

リクエストの例
POST /ajs/api/v1/objects/execAgents/actions/check/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-Type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "action":"start"
  }
}
レスポンスの例
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Date: Tue, 25 Aug 2020 11:12:38 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
    "results":
    [
        {
            "execAgent":"",
            "rtnCode":"0",
            "output":
            {
                "text":"KNAC1200-I エージェント監視プロセスに通信状態確認開始要求を行いました",
                "serverTime":"",
                "statuses":null,
                "definitions":null
            }
        }
    ]
}