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

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

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

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

APIまたはパラメーター	参照先
計画実行登録APIの次のパラメーター holding	7.1.4 計画実行登録API
確定実行登録APIの次のパラメーター holding passedDaemonStarts	7.1.5 確定実行登録API

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

実行権限

なし

リクエストの形式

リクエスト行

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

APIのバージョン

v1

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

なし

パラメーター

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

表7‒19　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==

レスポンスの例

HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
  "protocolVersionNumber":1110
}

ページの先頭へ