1. Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド
  2. タスク
  3. ジョブ・テンプレート

ジョブ・テンプレートのジョブのリスト

get

/api/v2/job_templates/{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。(文字列)
  • job_type: (選択)
    • run: 実行
    • check: チェック
    • scan: スキャン
  • inventory: (id)
  • project: (id)
  • playbook: (文字列)
  • scm_branch: ジョブ実行で使用するブランチ。空白の場合に使用されるプロジェクトのデフォルト。プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(文字列)
  • forks: (整数)
  • limit: (文字列)
  • verbosity: (選択)
    • 0: 0 (標準)
    • 1: 1 (詳細)
    • 2: 2 (より詳細)
    • 3: 3 (デバッグ)
    • 4: 4 (接続デバッグ)
    • 5: 5 (WinRMデバッグ)
  • extra_vars: (json)
  • job_tags: (文字列)
  • force_handlers: (ブール)
  • skip_tags: (文字列)
  • start_at_task: (文字列)
  • timeout: タスクが取り消されるまでの実行時間(秒)。(整数)
  • use_fact_cache: 有効にすると、サービスはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の終了時にファクトをデータベースに永続化し、Ansibleで使用できるようにファクトをキャッシュします。(ブール)
  • organization: この統合ジョブへのアクセス権を決定するために使用される組織。(id)
  • job_template: (id)
  • passwords_needed_to_start: (フィールド)
  • allow_simultaneous: (ブール)
  • artifacts: (json)
  • scm_revision: このジョブに使用される、プロジェクトのSCMリビジョン(使用可能な場合) (文字列)
  • instance_group: ジョブが実行されたインスタンス・グループ(id)
  • diff_mode: 有効にすると、ホスト上のテンプレート化されたファイルに加えられたテキストの変更が標準出力に表示されます(ブール)
  • job_slice_number: スライスされたジョブの一部である場合、操作が行われたインベントリ・スライスのID。スライスされたジョブの一部でない場合、パラメータは使用されません。(整数)
  • job_slice_count: スライスされたジョブの一部として実行された場合、スライスの合計数。1の場合、ジョブはスライスされたジョブの一部ではありません。(整数)
  • webhook_service: Webフック・リクエストを受け入れるサービス(選択)
    • "": ---------
    • github: GitHub
    • gitlab: GitLab
    • bitbucket_dc: BitBucket DataCenter
  • webhook_credential: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id)
  • webhook_guid: このWebフックをトリガーしたイベントの一意の識別子(文字列)

ソート

ジョブが特定の順序で返されるように指定するには、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

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
問合せパラメータ
先頭に戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

本文()
ルート・スキーマ: schema
型: object
ソースを表示
ネストされたスキーマ : results
型: array
ソースを表示
ネストされたスキーマ : JobList
型: object
ソースを表示
先頭に戻る