7.1.1　ユニット一覧の取得API

指定したユニットまたはユニット配下の，ジョブグループ，ジョブネット，およびジョブの情報を取得します。情報を取得するユニットは，条件を記述することで指定します。条件を複数記述した場合，すべての条件を満たすユニットの一覧が取得されます。

条件を満たすユニットが一つも存在しない場合，0件のユニット一覧を返却します。ログインしたJP1ユーザーに参照権限がないユニットの情報は取得結果に含まれません。取得できるユニットは最大1,000件です。取得件数が1,000件を超える場合は，条件を変更し，取得件数を絞り込んでください。

実行権限

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

JP1_AJS_Admin権限
JP1_AJS_Manager権限
JP1_AJS_Editor権限
JP1_AJS_Operator権限
JP1_AJS_Guest権限

リクエストの形式

リクエスト行

GET /application/component/apiVersion/objects/statuses?query httpVersion

APIのバージョン

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

なし

パラメーター

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

表7‒1　ユニット一覧の取得APIのパラメーター一覧
パラメーター	値の説明	必須・任意
`mode`	固定で「`search`」を指定します。	必須
`manager`	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`serviceName`	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須
`location`	取得したいユニットの上位ユニット（ジョブグループまたはジョブネット）のユニット完全名を，1〜930バイトの文字列で指定します。	必須
`searchLowerUnits`	パラメーター`location`で指定したユニットの，直下1階層のユニット情報を取得対象とするか，配下のユニットすべての情報を取得対象とするかを，定数`LowerType`に規定されている文字列定数で指定します。定数`LowerType`の詳細については，「7.4.2(1) LowerType」を参照してください。このパラメーターを指定しなかった場合，「`NO`（直下1階層のユニット）」が仮定されます。	任意
`searchTarget`	ユニットの定義だけを取得対象とするか，ユニットの定義および状態を取得対象とするかを，定数`SearchTargetType`に規定されている文字列定数で指定します。定数`SearchTargetType`の詳細については，「7.4.2(2) SearchTargetType」を参照してください。「`DEFINITION`（定義）」を指定した場合は，次のパラメーターの指定は無視されます。 `execID` `generation` `periodBegin` `periodEnd` `status` `delayStatus` `holdPlan` `execHost` `execHostMatchMethods` このパラメーターを指定しなかった場合，「`DEFINITION_AND_STATUS`（定義と状態）」が仮定されます。	任意
`unitName`	取得したいユニットの名称を指定します。パラメーター`unitNameMatchMethods`でユニット名の比較方法を指定した場合だけ，このパラメーターを指定できます。また，ユニット名の比較方法に「`NO`（検索条件にしない）」を指定した場合は，このパラメーターの指定は無視されます。指定できるユニット名のバイト数は，パラメーター`unitNameMatchMethods`の指定値によって異なります。パラメーター`unitNameMatchMethods`の指定値と，このパラメーターに指定できるバイト数を次に示します。 `EQ`，`BW`，`EW`，`NE`，`CO`，`NC`：1〜30バイト `RE`：1〜64バイト	任意
`unitNameMatchMethods`	ユニット名の比較方法を定数`MatchMethods`に規定されている文字列定数で指定します。定数`MatchMethods`の詳細については，「7.4.2(3) MatchMethods」を参照してください。「`NO`（検索条件にしない）」を指定した場合は，すべてのユニット名が取得対象となります。このパラメーターを指定しなかった場合，「`NO`」が仮定されます。	任意
`execID`	取得したいユニットの実行IDを「`@[`mmmm`]{`A〜Z`}`nnnn」の形式で指定します（例：`@10A200`）`。` パラメーター`generation`で「`EXECID`（指定した実行IDの世代を取得）」を指定した場合だけ，このパラメーターを指定できます。その他の値を指定した場合，このパラメーターの指定は無視されます。	任意
`unitType`	取得したいユニットの種別を定数`UnitType`に規定されている文字列定数で指定します。定数`UnitType`の詳細については，「7.4.2(4) UnitType」を参照してください。「`NO`（検索条件にしない）」を指定した場合，すべてのユニットの種別が取得対象となります。「`GROUP`（ジョブグループなど）」を指定した場合，次のパラメーターの指定は無視されます。 `execID` `generation` `periodBegin` `periodEnd` `status` `delayStatus` `holdPlan` `execHost` `execHostMatchMethods` `releaseID` `releaseInfoSearchMethods` 「`ROOT`（ルートジョブネットなど）」および「`NET`（ジョブネットなど）」を指定した場合，次のパラメーターの指定は無視されます。 `execHost` `execHostMatchMethods` このパラメーターを指定しなかった場合，「`NO`」が仮定されます。	任意
`generation`	取得したいユニットの世代を定数`GenerationType`に規定されている文字列定数で指定します。定数`GenerationType`の詳細については，「7.4.2(5) GenerationType」を参照してください。このパラメーターを指定しなかった場合，「`STATUS`（最新状態）」が仮定されます。	任意
`periodBegin`	取得したいユニットの世代の開始日時を，「YYYY`-`MM`-`DD`T`hh`:`mm」の形式で指定します。指定した日時以降に存在する世代が取得対象となります。指定できる値を次に示します。 YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。 MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。 DD：日にちを指定します。日にちに指定できる値は，01〜指定した月の最終日（単位：日）です。 hh：時間を指定します。時間に指定できる値は，00〜23（単位：時）です。 mm：分を指定します。分に指定できる値は，00〜59（単位：分）です。指定する日時は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。パラメーター`generation`で「`PERIOD`（期間指定）」を指定した場合だけ，このパラメーターを指定できます。その他の値を指定した場合，このパラメーターの指定は無視されます。期間の終了日時はパラメーター`periodEnd`で指定します。パラメーター`periodEnd`で指定した終了日時以前の日時を指定してください。	任意
`periodEnd`	取得したいユニットの世代の終了日時を，「YYYY`-`MM`-`DD`T`hh`:`mm」の形式で指定します。指定した日時以前に存在する世代が取得対象になります。指定できる値を次に示します。 YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。 MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。 DD：日にちを指定します。日にちに指定できる値は，01〜指定した月の最終日（単位：日）です。 hh：時間を指定します。時間に指定できる値は，00〜23（単位：時）です。 mm：分を指定します。分に指定できる値は，00〜59（単位：分）です。指定する日時は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。パラメーター`generation`で「`PERIOD`（期間指定）」を指定した場合だけ，このパラメーターを指定します。その他の値を指定した場合，このパラメーターの指定は無視されます。期間の開始日時はパラメーター`periodBegin`で指定します。パラメーター`periodBegin`で指定した開始日時以降の日時を指定してください。	任意
`status`	取得したいユニットの状態を定数`UnitStatus`に規定されている文字列定数で指定します。定数`UnitStatus`の詳細については，「7.4.2(6) UnitStatus」を参照してください。「`NO`（検索条件にしない）」を指定した場合，すべてのユニットの状態が取得対象となります。「`UNREGISTERED`（未登録）」を指定した場合，次のパラメーターの指定は無視されます。 `execID` `generation` `periodBegin` `periodEnd` `delayStatus` `holdPlan` `execHost` `execHostMatchMethods` 「`UNREGISTERED`（未登録）」を指定した場合で，ジョブネットリリース機能を使用しているときは，同一ユニット名のユニット情報が複数取得されることがあります。この場合，パラメーター`releaseInfoSearchMethods`とパラメーター`releaseID`を指定して，取得対象を特定してください。このパラメーターを指定しなかった場合は，「`NO`」が仮定されます。	任意
`delayStatus`	取得したいユニットの遅延状態を定数`DelayType`に規定されている文字列定数で指定します。定数`DelayType`の詳細については，「7.4.2(7) DelayType」を参照してください。このパラメーターを指定しなかった場合，「`NO`（遅延を検索条件にしない）」が仮定されます。	任意
`holdPlan`	取得したいユニットの保留予定の有無を定数`HoldPlan`に規定されている文字列定数で指定します。定数`HoldPlan`の詳細については，「7.4.2(8) HoldPlan」を参照してください。「`PLAN_YES`（保留予定あり）」を指定した場合は，実行待ち，保留中，および実行が終了した世代が対象になります。実行が終了した世代も対象になるため，再実行時に保留される世代の情報も取得されます。実行待ちの世代だけ，実行が終了した世代だけ，または特定の世代だけを取得対象にしたい場合は，パラメーター`generation`やパラメーター`status`を同時に指定して，取得対象の世代を特定してください。このパラメーターを指定しなかった場合，「`NO`（保留予定を検索条件にしない）」が仮定されます。	任意
`unitComment`	取得したいユニットのコメントを指定します。パラメーター`unitCommentMatchMethods`でコメントの比較方法を指定した場合だけ，このパラメーターを指定できます。コメントの比較方法に「`NO`（検索条件にしない）」を指定した場合は，このパラメーターの指定は無視されます。コメントの比較方法に「`EQ`（完全一致）」を指定して，このパラメーターに空文字列（0バイト）を指定した場合は，コメントの定義されていないユニットが取得対象となります。指定できるコメントのバイト数は，パラメーター`unitCommentMatchMethods`の指定値によって異なります。パラメーター`unitCommentMatchMethods`の指定値と，このパラメーターに指定できるバイト数を次に示します。 `EQ`，`NE`：0〜80バイト `BW`，`EW`，`CO`，`NC`：1〜80バイト `RE`：1〜164バイト	任意
`unitCommentMatchMethods`	ユニットのコメントの比較方法を定数`MatchMethods`に規定されている文字列定数で指定します。定数`MatchMethods`の詳細については，「7.4.2(3) MatchMethods」を参照してください。このパラメーターを指定しなかった場合，「`NO`（検索条件にしない）」が仮定されます。	任意
`execHost`	取得したいユニットの実行ホストを指定します。ユニット定義の実行エージェントではなく，実際に実行されたエージェントホスト名を指定します。パラメーター`execHostMatchMethods`で実行ホスト名の比較方法を指定した場合だけ，このパラメーターを指定できます。実行ホスト名の比較方法に「`NO`（検索条件にしない）」を指定した場合は，このパラメーターの指定は無視されます。実行ホスト名の比較方法に「`EQ`（完全一致）」を指定して，このパラメーターに空文字列（0バイト）を指定した場合は，実行ホストが確定していない待ち状態のジョブが取得対象になります。指定できる実行ホストのバイト数は，パラメーター`execHostMatchMethods`の指定値によって異なります。パラメーター`execHostMatchMethods`の指定値と，このパラメーターに指定できるバイト数を次に示します。 `EQ`，`NE`：0〜255バイト `BW`，`EW`，`CO`，`NC`：1〜255バイト `RE`：1〜514バイト	任意
`execHostMatchMethods`	ユニットの実行ホスト名の比較方法を定数`MatchMethods`に規定されている文字列定数で指定します。定数`MatchMethods`の詳細については，「7.4.2(3) MatchMethods」を参照してください。このパラメーターを指定しなかった場合，「`NO`（検索条件にしない）」が仮定されます。	任意
`releaseID`	取得したいユニットのリリースIDを1〜30バイトの文字列で指定します。パラメーター`releaseInfoSearchMethods`で「`ID`（リリースID）」を指定した場合に，このパラメーターを指定します。その他の指定では，このパラメーターの指定は無視されます。	任意
`releaseInfoSearchMethods`	リリース情報の取得方法を定数`ReleaseInfoSearchMethods`に規定されている文字列定数で指定します。定数`ReleaseInfoSearchMethods`の詳細については，「7.4.2(9) ReleaseInfoSearchMethods」を参照してください。「`NO`（検索条件にしない）」を指定した場合，すべてのリリース情報が取得対象となります。このパラメーターを指定しなかった場合，「`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サーバ処理エラーが発生しました。

レスポンスの形式

メッセージボディ

{
  "statuses":[ステータス監視のリソース,...],
  "all":すべての情報を取得できたかどうか
}

戻り値

ステータスコードが「200」の場合，次の情報を返却します。

メンバー	データ型	説明
`statuses`	object[]	ステータス監視のリソースの配列を返却します。条件を満たすユニットが一つも存在しない場合は，要素数0個の配列を返却します。ステータス監視のリソースの詳細については，「7.2.1 ステータス監視のリソース」を参照してください。
`all`	boolean	すべての情報を取得できたかどうかを返却します。すべての情報を取得できた場合，「`true`」を返却します。すべての情報を取得できなかった場合，「`false`」を返却します。

メンバー

データ型

説明

statuses

object[]

ステータス監視のリソースの配列を返却します。条件を満たすユニットが一つも存在しない場合は，要素数0個の配列を返却します。ステータス監視のリソースの詳細については，「7.2.1 ステータス監視のリソース」を参照してください。

all

boolean

すべての情報を取得できたかどうかを返却します。

すべての情報を取得できた場合，「true」を返却します。すべての情報を取得できなかった場合，「false」を返却します。

使用例

ジョブグループ（/JobGroup）直下のユニット一覧（最新状態）を取得する場合のAPIの使用例を次に示します。

リクエストの例

GET /ajs/api/v1/objects/statuses?mode=search&manager=HOSTM&serviceName=AJSROOT1&location=%2FJobGroup 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: Wed, 02 Sep 2015 13:54:03 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
  "statuses": [
    {
      "definition": {
        "owner": "jp1admin",
        "customJobType": "",
        "registerStatus": "YES",
        "rootJobnetName": "/JobGroup/Jobnet",
        "recoveryUnit": false,
        "unitType": "ROOTNET",
        "unitComment": "",
        "simpleUnitName": "Jobnet",
        "parameters": "",
        "execAgent": "",
        "execFileName": "",
        "wait": false,
        "jobnetReleaseUnit": false,
        "jp1ResourceGroup": "",
        "unitName": "/JobGroup/Jobnet",
        "unitID": 1560
      },
      "release": null,
      "unitStatus": {
        "status": "RUNNING",
        "execHost": "",
        "startDelayStatus": "NO",
        "nestStartDelayStatus": "NO",
        "endDelayStatus": "NO",
        "nestEndDelayStatus": "NO",
        "startDelayTime": "",
        "endDelayTime": "",
        "changeType": "NO",
        "registerTime": "",
        "jobNumber": -1,
        "retCode": "",
        "simpleUnitName": "Jobnet",
        "schStartTime": "2015-09-02T00:00:00+09:00",
        "reStartTime": "",
        "endTime": "",
        "holdAttr": "NO",
        "startTime": "2015-09-02T22:50:28+09:00",
        "unitName": "/JobGroup/Jobnet",
        "execID": "@A2959"
      }
    }
  ],
  "all": true
}

ページの先頭へ

7.1.1 ユニット一覧の取得API

7.1.1　ユニット一覧の取得API