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

ジョブの取得

get

/api/v2/jobs/{id}/

このリソースに対してGETリクエストを行って、次のフィールドを含む単一のジョブ・レコードを取得します。

  • id: このジョブのデータベースID。(整数)
  • type: このジョブのデータ型。(選択)
  • url: このジョブのURL。(文字列)
  • related: 関連リソースのURLを含むデータ構造。(オブジェクト)
  • summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
  • created: このジョブが作成されたときのタイムスタンプ。(日時)
  • modified: このジョブが最後に変更されたときのタイムスタンプ。(日時)
  • name: このジョブの名前。(文字列)
  • description: このジョブのオプションの説明。(文字列)
  • 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)
  • 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_args: (文字列)
  • job_cwd: (文字列)
  • job_env: (json)
  • job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)
  • execution_node: ジョブが実行されたノード。(文字列)
  • controller_node: 実行環境を管理していたインスタンス。(文字列)
  • result_traceback: (文字列)
  • event_processing_finished: この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。(ブール)
  • launched_by: (フィールド)
  • work_unit_id: このジョブに関連付けられているレセプタの作業単位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フックをトリガーしたイベントの一意の識別子(文字列)
  • host_status_counts: Ansible playbook_on_statsイベントからのプレイブック統計。(json)
  • playbook_counts: ジョブ実行のすべてのプレイおよびタスクの数。(フィールド)
  • custom_virtualenv: (文字列)

リクエスト

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

レスポンス

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

200レスポンス

本文()
ルート・スキーマ : JobDetail
型: object
ソースを表示
ネストされたスキーマ : Host status counts
型: object
タイトル: Host status counts
読取り専用: true
Ansible playbook_on_statsイベントからのプレイブック統計。
ネストされたスキーマ : job_env
型: object
タイトル: job_env
読取り専用: true
先頭に戻る