Main Content

GET Server Health

サーバーの全体的な健全性に関する情報を取得する

R2019b 以降

説明

GET メソッドを使用して、サーバーが健全であり HTTP リクエストを処理できるかどうかを判別します。

サーバーに有効なライセンスがある場合、またはネットワーク ライセンス マネージャーとの通信が切断されたが license-grace-period プロパティで指定された猶予期間内にまだある場合、サーバーは健全です。

リクエスト

HTTP メソッド

GET

URI

http://host:port/api/health

レスポンス

成功

HTTP ステータス コード

200 OK

本文
名前説明値のタイプ
statusサーバーのステータス。

ok

例: 

{
  "status": "ok"
}

エラー

HTTP ステータス コード

503 Health check failed

サンプル呼び出し

HTTP

リクエスト:

GET /api/health HTTP/1.1
Host: localhost:9910

レスポンス:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "status": "ok"
}

JavaScript 

var data = null;
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "http://localhost:9910/api/health");
xhr.send(data);

バージョン履歴

R2019b で導入

参考

トピック