APIによる実行中のプロセス一覧の取得

コメント

4件のコメント

  • 正式なコメント
    Ichiro Takahashi

    フィックスポイントの高橋です。

    この時Kompira EnterpriseのAPIを用いて外部の監視システムから上記のプロセス一覧を取得できればと思っているのですが、取得するための方法はありますでしょうか?

    Kompira Enterprise の REST-API でプロセスの一覧情報を取得することができます。
    (以下では REST-API の基本的な呼び出し方の説明については省略しています)

    マニュアル「8.4.1. プロセス一覧の取得」にある以下のAPIを用いると、プロセスオブジェクトの一覧を取得することができます。

    GET /process

    ただし、このままでは終了したプロセスの情報も取得されます。実行中のプロセスに限る場合は、以下のように is_active=true パラメータを追加してみてください。

    GET /process?is_active=true

    コンソール情報などが不要な場合、attrs パラメータで必要なフィールドだけ取得することもできます。以下の例ではプロセスの ID, ステータス, 開始日時, 現在のジョブ、だけを取得します。

    /process?is_active=true&attrs=id&attrs=status&attrs=started_time&attrs=current_job

    プロセス一覧は結果に含まれる results 配列から得られます。絞り込み対象のプロセスの個数については結果に含まれる count から知ることができます。

    {
      "count": 1,
      "next": null,
      "previous": null,
      "results": [
        {
          "id": 46898,
          "started_time": "2024-07-05T18:33:00.876283+09:00",
          "status": "WAITING",
        "current_job": "/foo/bar/jobflow"
        }
      ]
    }

    参考になさってみてください。

    コメントアクション パーマリンク
  • mtakagi

    迅速にご回答くださりありがとうございます。

    ご提示いただいた内容を元に監視を検討してみます。

    0
    コメントアクション パーマリンク
  • Ichiro Takahashi

    一点、補足がございました。

    回答で示させていただいた is_active=true パラメータによる、実行中プロセスの絞り込みですが、REST-API のマニュアルに記載のない非公式なパラメータを利用しておりました。

    GET /process?is_active=true

    おそらく大丈夫だと思いますが、今後のバージョンで利用できなく可能性はゼロではないことをご承知おきください。

    0
    コメントアクション パーマリンク
  • mtakagi

    補足ありがとうございます。非公式なパラメータであるとのこと承知しました。
    今後のバージョンアップの際には注意するようにいたします。

    0
    コメントアクション パーマリンク

サインインしてコメントを残してください。