プロジェクト更新の取得
get
/api/v2/project_updates/{id}/
このリソースに対してGETリクエストを行って、次のフィールドを含む単一のプロジェクト更新レコードを取得します。
id: このプロジェクト更新のデータベースID。(整数)type: このプロジェクト更新のデータ型。(選択)url: このプロジェクト更新のURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: このプロジェクト更新が作成されたときのタイムスタンプ。(日時)modified: このプロジェクト更新が最後に変更されたときのタイムスタンプ。(日時)name: このプロジェクト更新の名前。(文字列)description: このプロジェクト更新のオプションの説明。(文字列)local_path: このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。(文字列)scm_type: プロジェクトを格納するために使用するソース・コントロール・システムを指定します。(選択)"": 手動git: Githg: Mercurialsvn: Subversioninsights: Red Hat Insightsarchive: リモート・アーカイブ
scm_url: プロジェクトが格納される場所。(文字列)scm_branch: チェックアウトする特定のブランチ、タグまたはコミット。(文字列)scm_refspec: gitプロジェクトについて、フェッチする追加のrefspec。(文字列)scm_clean: プロジェクトを同期化する前にローカルの変更を破棄します。(ブール)scm_delete_on_update: 同期化する前にプロジェクトを削除します。(ブール)credential: (id)timeout: タスクが取り消されるまでの実行時間(秒)。(整数)scm_revision: 対象となるプロジェクトおよびブランチについてこの更新によって検出されたSCMリビジョン。(文字列)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: 取消し済
failed: (ブール)started: ジョブが開始のためにキューに入れられた日時。(日時)finished: ジョブの実行が終了した日時。(日時)canceled_on: 取消しリクエストが送信された日時。(日時)elapsed: ジョブが実行された経過時間(秒)。(10進)job_args: (文字列)job_cwd: (文字列)job_env: (json)job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)execution_node: ジョブが実行されたノード。(文字列)result_traceback: (文字列)event_processing_finished: この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。(ブール)project: (id)job_type: (選択)run: 実行check: チェック
job_tags: プロジェクト更新プレイブックのうち、実行される部分。(文字列)host_status_counts: 各ステータスに一意に割り当てられたホストの数。(フィールド)playbook_counts: ジョブ実行のすべてのプレイおよびタスクの数。(フィールド)
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- search(オプション): 文字列
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"canceled_on":null,
"created":"2018-02-01T08:00:00.000000Z",
"credential":null,
"description":"",
"elapsed":0,
"event_processing_finished":false,
"execution_node":"",
"failed":false,
"finished":null,
"host_status_counts":{
},
"id":2,
"job_args":"",
"job_cwd":"",
"job_env":{
},
"job_explanation":"",
"job_tags":"update_,install_roles,install_collections",
"job_type":"check",
"launch_type":"manual",
"local_path":"",
"modified":"2018-02-01T08:00:00.000000Z",
"name":"",
"playbook_counts":{
"play_count":0,
"task_count":0
},
"project":2,
"related":{
"cancel":"/api/v2/project_updates/2/cancel/",
"events":"/api/v2/project_updates/2/events/",
"notifications":"/api/v2/project_updates/2/notifications/",
"project":"/api/v2/projects/2/",
"scm_inventory_updates":"/api/v2/project_updates/2/scm_inventory_updates/",
"stdout":"/api/v2/project_updates/2/stdout/",
"unified_job_template":"/api/v2/projects/2/"
},
"result_traceback":"",
"scm_branch":"",
"scm_clean":false,
"scm_delete_on_update":false,
"scm_refspec":"",
"scm_revision":"",
"scm_type":"",
"scm_url":"",
"started":null,
"status":"new",
"summary_fields":{
"project":{
"description":"test-proj-desc",
"id":2,
"name":"test-proj",
"scm_type":"git",
"status":"never updated"
},
"unified_job_template":{
"description":"test-proj-desc",
"id":2,
"name":"test-proj",
"unified_job_type":"project_update"
},
"user_capabilities":{
"delete":true,
"start":true
}
},
"timeout":0,
"type":"project_update",
"unified_job_template":2,
"url":"/api/v2/project_updates/2/"
}