ジョブの Bastion API

ジョブの Bastion API 解説書

ジョブ

GET /jobs

クラスタのジョブのリストを取得する

リクエストヘッダ:
  • waitIndex – ウェイトインデックスは、長いプルのジョブ監視に使用します。
応答 JSON オブジェクト:
  • [] (object) –
  • [].name (string) – ジョブ名。
  • [].status (string) – ジョブステータス。
  • [].autostart (boolean) – すべてのジョブ開始時にジョブが始まるかどうか。
  • [].byCluster (boolean) – ジョブを各クラスタで開始する必要があるかどうか。
  • [].taskGroups[] (object) – タスクグループの配列。
  • [].taskGroups[].name (string) – タスクグループ名。
  • [].taskGroups[].count (integer) – 実行に必要なタスクグループ数
  • [].taskGroups[].summary.queued (integer) –
  • [].taskGroups[].summary.complete (integer) –
  • [].taskGroups[].summary.failed (integer) –
  • [].taskGroups[].summary.running (integer) –
  • [].taskGroups[].summary.starting (integer) –
  • [].taskGroups[].summary.lost (integer) –
レスポンスヘッダ:
  • waitIndex – 未定義

応答例 :

[
  {
    "name": "jobName",
    "status": "running",
    "autostart": true,
    "byCluster": true,
    "taskGroups": [
      {
        "name": "takGroupName",
        "count": 0,
        "summary": {
          "queued": 0,
          "complete": 0,
          "failed": 0,
          "running": 0,
          "starting": 0,
          "lost": 0
        }
      }
    ]
  }
]
GET /job/{jobName}/summary

ジョブサマリーを取得する

パラメータ:
  • jobName – ジョブ名
応答 JSON オブジェクト:
  • name (string) – ジョブ名。
  • status (string) – ジョブステータス。
  • autostart (boolean) – すべてのジョブ開始時にジョブが始まるかどうか。
  • byCluster (boolean) – ジョブを各クラスタで開始する必要があるかどうか。
  • taskGroups[] (object) – タスクグループの配列。
  • taskGroups[].name (string) – タスクグループ名。
  • taskGroups[].count (integer) – 実行に必要なタスクグループ数
  • taskGroups[].summary.queued (integer) –
  • taskGroups[].summary.complete (integer) –
  • taskGroups[].summary.failed (integer) –
  • taskGroups[].summary.running (integer) –
  • taskGroups[].summary.starting (integer) –
  • taskGroups[].summary.lost (integer) –

応答例 :

{
  "name": "jobName",
  "status": "running",
  "autostart": true,
  "byCluster": true,
  "taskGroups": [
    {
      "name": "takGroupName",
      "count": 0,
      "summary": {
        "queued": 0,
        "complete": 0,
        "failed": 0,
        "running": 0,
        "starting": 0,
        "lost": 0
      }
    }
  ]
}
POST /jobs/start/{jobName}

開始するジョブをスケジュールする

パラメータ:
  • jobName – ジョブ名
POST /jobs/stop/{jobName}

停止するジョブをスケジュールする

パラメータ:
  • jobName – ジョブ名
POST /jobs/startall

自動で開始するすべてのジョブをスケジュールする

POST /jobs/stopall

自動で停止するすべてのジョブをスケジュールする。

POST /jobs/updatecounts

タスクグループ数を増減させます。0 の場合、0 に設定します。

リクエスト JSON オブジェクト:
 
  • jobID (string) – ジョブ名。
  • taskGroup (string) – タスクグループ。
  • count (integer) – カウントのデータ値。0 でジョブを停止します。

クエリ例 :

{
  "jobID": "jobName",
  "taskGroup": "taskGrouName",
  "count": 0
}
POST /jobs/settaskgroupcount

タスクグループ数を設定します。

バージョン 1.23.0 で追加.

リクエスト JSON オブジェクト:
 
  • jobID (string) – ジョブ名。
  • taskGroup (string) – タスクグループ。
  • count (integer) – タスクグループ数に設定する値。

クエリ例 :

{
  "jobID": "jobName",
  "taskGroup": "taskGrouName",
  "count": 0
}