スケジュールの統合ジョブのリスト
get
/api/v2/schedules/{id}/jobs/
このリソースに対してGETリクエストを行って、選択したスケジュールに関連付けられた統合ジョブのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、対象となる問合せで見つかった統合ジョブの合計数を示します。nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。resultsリストには、0個以上の統合ジョブ・レコードが含まれます。
結果
それぞれの統合ジョブ・データ構造には次のフィールドが含まれます。
id: この統合ジョブのデータベースID。(整数)type: この統合ジョブのデータ型。(選択)url: この統合ジョブのURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: この統合ジョブが作成されたときのタイムスタンプ。(日時)modified: この統合ジョブが最後に変更されたときのタイムスタンプ。(日時)name: この統合ジョブの名前。(文字列)description: この統合ジョブのオプションの説明。(文字列)unified_job_template: (id)launch_type: (選択)manual: 手動relaunch: 再起動callback: コールバックscheduled: スケジュール済dependency: 依存性workflow: ワークフローwebhook: Webフックsync: 同期scm: SCM更新
status: (選択)new: 新規pending: 保留中waiting: 待機中running: 実行中successful: 成功failed: 失敗error: エラーcanceled: 取消し済
execution_environment: 実行に使用されるコンテナ・イメージ。(id)failed: (ブール)started: ジョブが開始のためにキューに入れられた日時。(日時)finished: ジョブの実行が終了した日時。(日時)canceled_on: 取消しリクエストが送信された日時。(日時)elapsed: ジョブが実行された経過時間(秒)。(10進)job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)execution_node: ジョブが実行されたノード。(文字列)controller_node: 実行環境を管理していたインスタンス。(文字列)launched_by: (フィールド)work_unit_id: このジョブに関連付けられているレセプタの作業単位ID。(文字列)
ソート
統合ジョブが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。
?order_by=name
フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。
?order_by=-name
フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。
?order_by=name,some_other_field
ページ区切り
リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。
?page_size=100&page=2
結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。
検索
モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。
?search=findme
(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page: 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size: 整数
ページごとに返す結果の数。
- search: 文字列
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ネストされたスキーマ : UnifiedJobList
型:
ソースを表示
object- canceled_on: 文字列(日付-時間)
タイトル:
Canceled on読取り専用:true取消しリクエストが送信された日時。 - controller_node: 文字列
タイトル:
Controller node読取り専用:true最小長:1実行環境を管理していたインスタンス。 - created: 文字列
タイトル:
Created読取り専用:true - description: 文字列
タイトル:
Description - elapsed: 文字列(10進)
タイトル:
Elapsed読取り専用:trueジョブが実行された経過時間(秒)。 - execution_environment: 整数
タイトル:
Execution environment実行に使用されるコンテナ・イメージ。 - execution_node: 文字列
タイトル:
Execution node読取り専用:true最小長:1ジョブが実行されるノード。 - failed: ブール
タイトル:
Failed読取り専用:true - finished: 文字列(日付-時間)
タイトル:
Finished読取り専用:trueジョブの実行が終了たした日時。 - id: 整数
タイトル:
ID読取り専用:true - job_explanation: 文字列
タイトル:
Job explanation読取り専用:true最小長:1ジョブを実行できず、stdoutを取得できなかった場合に、そのジョブの状態を示すステータス・フィールド(文字列) - launch_type: 文字列
タイトル:
Launch type読取り専用:true指定できる値:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ] - launched_by: 文字列
タイトル:
Launched by読取り専用:true - modified: 文字列
タイトル:
Modified読取り専用:true - name(必須): 文字列
タイトル:
Name最小長:1最大長:512 - related: 文字列
- started: 文字列(日付-時間)
タイトル:
Started読取り専用:trueジョブが開始のためにキューに入れられた日時。 - status: 文字列
タイトル:
Status読取り専用:true指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ] - summary_fields: 文字列
タイトル:
Summary fields読取り専用:true - type: 文字列
タイトル:
Type読取り専用:true - unified_job_template: 文字列
タイトル:
unified job template読取り専用:true - url: 文字列
タイトル:
Url読取り専用:true - work_unit_id: 文字列
タイトル:
Work unit id読取り専用:true最小長:1このジョブに関連付けられているレセプタの作業単位ID。