7.1.38　JP1/AJS3 - Managerのプロトコルバージョンの取得API

接続先JP1/AJS3 - Managerのプロトコルのバージョンを取得します。

プロトコルのバージョンとは，接続先JP1/AJS3 - Managerの通信インターフェースのバージョンを表す値です。

このAPIは，次の表に示すAPIまたはパラメーターを指定するときの，接続先JP1/AJS3 - Managerのプロトコルバージョンの判定に使用します。詳細については，各APIまたはパラメーターの説明を参照してください。

APIまたはパラメーター	参照先
ユニット一覧の取得APIの次のパラメーター `periodBegin` `periodEnd`	7.1.1 ユニット一覧の取得API
計画実行登録APIの次のパラメーター `holding`	7.1.5 計画実行登録API
確定実行登録APIの次のパラメーター `holding` `passedDaemonStarts` `fixedScheduleFrom` `fixedScheduleTo` `startTime`	7.1.6 確定実行登録API
登録解除APIの次のパラメーター `begin` `end`	7.1.8 登録解除API
計画一時変更（日時変更）APIの次のパラメーター `absoluteTime`	7.1.12 計画一時変更（日時変更）API
実行エージェントの状況一覧の取得API	7.1.21 実行エージェントの状況一覧の取得API
実行エージェントの状況の取得API	7.1.22 実行エージェントの状況の取得API
実行エージェントの定義の取得API	7.1.23 実行エージェントの定義の取得API
実行エージェントの追加API	7.1.24 実行エージェントの追加API
実行エージェントの削除API	7.1.25 実行エージェントの削除API
実行エージェントの設定変更API	7.1.26 実行エージェントの設定変更API
実行エージェントの受付配信制限の状態の変更API	7.1.27 実行エージェントの受付配信制限の状態の変更API
実行エージェントの状態の変更API	7.1.28 実行エージェントの状態の変更API
ジョブ配信遅延の軽減機能の通信状態確認API	7.1.29 ジョブ配信遅延の軽減機能の通信状態確認API
実行エージェントグループの状況一覧の取得API	7.1.30 実行エージェントグループの状況一覧の取得API
実行エージェントグループの定義の取得API	7.1.31 実行エージェントグループの定義の取得API
実行エージェントグループの追加API	7.1.32 実行エージェントグループの追加API
実行エージェントグループの削除API	7.1.33 実行エージェントグループの削除API
実行エージェントグループの設定変更API	7.1.34 実行エージェントグループの設定変更API
実行エージェントグループの受付配信制限の状態の変更API	7.1.35 実行エージェントグループの受付配信制限の状態の変更API
実行エージェントの除外，追加，優先順位の変更API	7.1.36 実行エージェントの除外，追加，優先順位の変更API

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

実行権限

なし

リクエストの形式

リクエスト行

GET /application/component/apiVersion/protocolVersion?query httpVersion

APIのバージョン

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

なし

パラメーター

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

表7‒38　JP1/AJS3 - Managerのプロトコルバージョンの取得APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須

ステータスコード

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

ステータスコード	テキスト記述	説明
200	OK	接続先JP1/AJS3 - Managerのプロトコルバージョンの取得が成功しました。
400	Bad Request	クエリ文字列が不正です。
401	Unauthorized	認証が必要です。
404	Not found	リソースにアクセスする権限がありません。または，リソースがありません。
412	Precondition failed	Web Consoleサーバが利用できません。
500	Server-side error	Web Consoleサーバ処理エラーが発生しました。

レスポンスの形式

レスポンスのメッセージボディ

{
  "protocolVersionNumber":接続先JP1/AJS3 - Managerのプロトコルバージョン
}

戻り値

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

メンバー	データ型	説明
`protocolVersionNumber`	int	接続先JP1/AJS3 - Managerのプロトコルのバージョンを，数値で返却します。

使用例

接続先JP1/AJS3 - Managerのプロトコルバージョンを取得するAPIの使用例を次に示します。

リクエストの例

GET /ajs/api/v1/protocolVersion?manager=HOSTM HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==

レスポンス（メッセージボディ）の例

{
  "protocolVersionNumber":1110
}

ページの先頭へ

7.1.38 JP1/AJS3 - Managerのプロトコルバージョンの取得API

7.1.38　JP1/AJS3 - Managerのプロトコルバージョンの取得API