7.1.2　ユニット情報の取得API

指定したユニットの情報を取得します。ログインしたJP1ユーザーに該当のユニットの参照権限がない場合は，ユニットの情報は取得できません。

このAPIは，JP1/AJS3 - Web Consoleのバージョンが11-50以降のときに使用できます。バージョン情報の取得APIの戻り値（productVersionNumber）が115000以上であることを確認して使用してください。

実行権限

ログインしたJP1ユーザーが，情報を取得するユニットに対して，次に示すどれかのJP1権限が与えられている必要があります。

• JP1_AJS_Admin権限

• JP1_AJS_Manager権限

• JP1_AJS_Editor権限

• JP1_AJS_Operator権限

• JP1_AJS_Guest権限

リクエストの形式

リクエスト行

GET /application/component/apiVersion/objects/statuses/unitName:execID?query httpVersion

APIのバージョン

v1

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

リソースを一意に識別する情報を次の表に示します。

なお，パラメーターの指定に誤りがある場合，またはパラメーターを指定しなかった場合は，リソースを一意に識別できないため，ステータスコード「404」のエラーになります。

リソースを一意に識別する情報	データ型	説明	必須・任意
unitName	string	要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。	必須
execID	string	実行IDを，文字列で指定します。 指定する形式は「@[mmmm]{A〜Z}nnnn」です（例：@10A200）。	必須

パラメーター

「query」に指定するパラメーターを次の表に示します。

表7‒2　ユニット情報の取得APIのパラメーター一覧

パラメーター	値の説明	必須・任意
manager	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
serviceName	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須
searchConnectInfo	ステータス監視リソースの「ステータス情報オブジェクト（unitStatus）」を取得するときに，接続情報を取得するか，接続情報を取得しないかを，定数ConnectInfoTypeに規定されている文字列定数で指定します。定数ConnectInfoTypeについては，「7.4.16(1) ConnectInfoType」を参照してください。 このパラメーターを指定しなかった場合，「NO（接続情報を取得しない）」が仮定されます。	任意

ステータスコード

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

ステータスコード	メッセージ	説明
200	OK	ユニット情報の取得に成功しました。
400	Bad Request	クエリ文字列が不正です。
401	Unauthorized	認証が必要です。
403	Forbidden	実行権限がありません。
404	Not found	リソースにアクセスする権限がありません。または，リソースがありません。
409	Conflict	リクエストは現在のリソースの状態と矛盾しているため，処理を続行できません。
412	Precondition failed	Web Consoleサーバが利用できません。
500	Server-side error	Web Consoleサーバ処理エラーが発生しました。

レスポンスの形式

メッセージボディ

ステータス監視のリソース

戻り値

ステータスコードが「200」の場合，ステータス監視のリソースを返却します。ステータス監視のリソースの詳細については，「7.2.1 ステータス監視のリソース」を参照してください。

使用例

指定したユニットの情報を取得するAPIの使用例を次に示します。

リクエストの例

GET /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet:@A119?manager=HOSTM&serviceName=AJSROOT1 HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==

レスポンスの例

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Date: Thu, 20 Apr 2017 13:54:03 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
   "definition":
   {
      "owner":"user",
      "parameters":"",
      "unitID":29444,
      "simpleUnitName":"Jobnet",
      "unitType":"ROOTNET",
      "unitComment":"",
      "jp1ResourceGroup":"",
      "unitName":"/JobGroup/Jobnet",
      "customJobType":"",
      "execAgent":"",
      "execFileName":"",
      "registerStatus":"YES",
      "scenarioUnit":false,
      "recoveryUnit":false,
      "wait":false,
      "jobnetReleaseUnit":false,
      "horizontalPosition":-1,
      "verticalPosition":-1,
      "rootJobnetName":"/JobGroup/Jobnet"
   },
   "unitStatus":
   {
      "status":"NORMAL",
      "simpleUnitName":"Jobnet",
      "holdPlan":"NONE",
      "execHost":"",
      "delayedStart":"NOT",
      "holdAttr":"NO",
      "startTime":"2017-04-20T17:27:10+09:00",
      "endTime":"2017-04-20T17:27:10+09:00",
      "delayedStartTime":"",
      "delayedEnd":"NOT",
      "delayedEndTime":"",
      "timeRequiredForExecution":"-1",
      "unitName":"/JobGroup/Jobnet",
      "execID":"@A119",
      "schStartTime":"2017-04-20T00:00:00+09:00",
      "reStartTime":"",
      "startDelayStatus":"NO",
      "nestStartDelayStatus":"NO",
      "endDelayStatus":"NO",
      "nestEndDelayStatus":"NO",
      "startDelayTime":"",
      "endDelayTime":"",
      "changeType":"NO",
      "registerTime":"",
      "jobNumber":-1,
      "retCode":"",
      "executionType":"NONE",
      "startConditionTimes":-1,
      "startConditionPeriodType":"NONE",
      "startConditionPeriod":"",
      "retryStatus":"NONE",
      "retryTimes":-1,
      "execSchedule":"NONE",
      "statusInSummary": [
         "NONE"
      ],
      "execDateBaseTime":"",
      "waiting":"NONE",
      "monitoringJobnet":"TIME_REQUIRED_FOR_EXECUTION_NO"
   },
   "release":null
}

ページの先頭へ