ステータスエンドポイント

オンプレミスエージェントの /status エンドポイントを呼び出すことで、そのエージェントのステータスをプログラム的に取得できます。

サンプルリクエスト

$ curl https://localhost:3000/status -i

HTTP/1.1 200
Content-Type: application/json;charset=utf-8
Content-Length: 237
Date: Mon, 07 Mar 2022 07:19:08 GMT

{
  "pid":76801,
  "state":"connected",
  "active":"true",
  "version":"2.10.0",
  "active_requests":0,
  "active_tasks":0,
  "profiles":[
    {"profile":"sql","adapter":"sqlserver"},
    {"profile":"sql2","adapter":"postgresql"},
    {"profile":"sql3","adapter":"mysql"}
  ]
}

レスポンスのスキーマ

名前	型	説明
pid	数値	エージェントのプロセス ID
state	文字列	エージェントの状態。次のうちいずれかの値となります: initial、connecting、connected、disconnected、stopping。
active	文字列	エージェントが有効化されていれば true、そうでなければ false になります。
version	文字列	エージェントのリリースバージョン。
active_requests	数値	エージェントから他のサービスへのアクティブなリクエストの数。
active_tasks	数値	保留中のタスクの数。非同期アクションは1つかそれ以上のタスクを伴います。
profiles	配列	このエージェントで設定されている有効なプロファイルを列挙します。