健全性チェック API

健全性チェック API を使用して、サーバーが有効なライセンスをもち HTTP リクエストを処理できるかどうかを判別します。健全性チェックでは、サーバーが有効なライセンスをもつか、またネットワーク ライセンス マネージャーと通信できるかどうかに基づいて、サーバーを健全または不健全に分類します。サーバーの健全性を確認するには、GET Server Healthを使用します。

サーバーは、次のいずれかの状態にあれば健全です。

  • サーバーは有効なライセンスで動作している。サーバーがネットワーク ライセンス マネージャーと通信しており、必要な数のライセンス キーがチェックアウトされている。

  • サーバーはネットワーク ライセンス マネージャーとの通信を失っているが、サーバーは完全に動作しており、license-grace-period プロパティで指定された猶予期間の最後まで動作し続ける。

健全性チェックが成功した場合、サーバーは 200 OK の HTTP ステータス コード、およびサーバーが健全であることを示す JSON オブジェクトを含むレスポンスを返します。 

{
  "status": "ok"
}

サーバーが HTTP リクエストを処理できない場合、健全性チェック API は 503 Health Check Failed HTTP レスポンス コードと空のレスポンス本文を返します。サーバーが、猶予期間を超える期間にわたってネットワーク ライセンス マネージャーとの通信を失っている場合、健全性チェックは失敗します。サーバーがこの状態の場合、サーバーはライセンス マネージャーとの通信を再確立しようと積極的に試みます。サーバーがライセンス マネージャーとの通信を再確立できれば、リクエストの処理が再開されます。

健全性チェックが失敗した場合、失敗の原因に関する追加情報はレスポンス本文に示されません。サーバー管理者は、mps-status を使用してサーバー ステータスに関する詳細情報を取得できます。ターミナルは、mps-status を実行するサーバーと同じシステム上になければなりません。

ライセンスの詳細については、MATLAB Production Server ライセンスの管理を参照してください。

参考

|

トピック