機械翻訳について

移動先

• リクエスト
• レスポンス

プロジェクト更新の取得

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: Git
  • svn: Subversion
  • insights: Red Hat Insights
  • archive: リモート・アーカイブ
• scm_url: プロジェクトが格納される場所。(文字列)
• scm_branch: チェックアウトする特定のブランチ、タグまたはコミット。(文字列)
• scm_refspec: gitプロジェクトについて、フェッチする追加のrefspec。(文字列)
• scm_clean: プロジェクトを同期化する前にローカルの変更を破棄します。(ブール)
• scm_track_submodules: 定義済ブランチでサブ・モジュールの最新コミットを追跡します。(ブール)
• 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: 取消し済
• execution_environment: 実行に使用されるコンテナ・イメージ。(id)
• failed: (ブール)
• started: ジョブが開始のためにキューに入れられた日時。(日時)
• finished: ジョブの実行が終了した日時。(日時)
• canceled_on: 取消しリクエストが送信された日時。(日時)
• elapsed: ジョブが実行された経過時間(秒)。(10進)
• job_args: (文字列)
• job_cwd: (文字列)
• job_env: (json)
• job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)
• execution_node: ジョブが実行されたノード。(文字列)
• result_traceback: (文字列)
• event_processing_finished: この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。(ブール)
• launched_by: (フィールド)
• work_unit_id: このジョブに関連付けられた受信者作業ユニットID。(文字列)
• project: (id)
• job_type: (選択)
  • run: 実行
  • check: チェック
• job_tags: プロジェクト更新プレイブックのうち、実行される部分。(文字列)
• host_status_counts: Ansible playbook_on_statsイベントからのPlaybook統計。(json)
• playbook_counts: ジョブ実行のすべてのプレイおよびタスクの数。(フィールド)

リクエスト

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

• application/json

パス・パラメータ

• id(required): string

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : ProjectUpdateDetail

型: object

ソースを表示

• canceled_on: string(date-time)
  タイトル: Canceled on

  読取り専用: true

  取消リクエストが送信された日時。
• created: string
  タイトル: Created

  読取り専用: true
• credential: integer
  タイトル: Credential
• description: string
  タイトル: Description
• elapsed: string(decimal)
  タイトル: Elapsed

  読取り専用: true

  ジョブが実行された経過時間(秒)。
• event_processing_finished: boolean
  タイトル: Event processing finished

  読取り専用: true

  この統合ジョブによって生成されたすべてのイベントがデータベースに保存されているかどうかを示します。
• execution_environment: integer
  タイトル: Execution environment

  実行に使用するコンテナ・イメージ。
• execution_node: string
  タイトル: Execution node

  読取り専用: true

  最小長: 1

  ジョブが実行されたノード。
• failed: boolean
  タイトル: Failed

  読取り専用: true
• finished: string(date-time)
  タイトル: Finished

  読取り専用: true

  ジョブの実行が終了した日時。
• host_status_counts: object Host status counts
  タイトル: Host status counts

  読取り専用: true

  Ansible playbook_on_statsイベントからのPlaybook統計。
• id: integer
  タイトル: ID

  読取り専用: true
• job_args: string
  タイトル: Job args

  読取り専用: true

  最小長: 1
• job_cwd: string
  タイトル: Job cwd

  読取り専用: true

  最小長: 1
• job_env: object job_env
  タイトル: job_env

  読取り専用: true
• job_explanation: string
  タイトル: Job explanation

  読取り専用: true

  最小長: 1

  ジョブが実行および取得できなかった場合にジョブの状態を示すステータス・フィールド
• job_tags: string
  タイトル: Job tags

  最大長: 1024

  実行されるプロジェクト更新プレイブックの一部。
• job_type: string
  タイトル: Job type

  デフォルト値: check

  指定できる値: [ "run", "check" ]
• launch_type: string
  タイトル: Launch type

  読取り専用: true

  指定できる値: [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
• launched_by: string
  タイトル: Launched by

  読取り専用: true
• local_path: string
  タイトル: Local path

  最大長: 1024

  このプロジェクトのプレイブックおよび関連ファイルを含むローカル・パス(PROJECTS_ROOTに対して相対的)。
• modified: string
  タイトル: Modified

  読取り専用: true
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 512
• playbook_counts: string
  タイトル: Playbook counts

  読取り専用: true

  ジョブ実行のすべての再生およびタスクの数。
• project: string
  タイトル: Project

  読取り専用: true
• related: string
  タイトル: Related

  読取り専用: true
• result_traceback: string
  タイトル: Result traceback

  読取り専用: true

  最小長: 1
• scm_branch: string
  タイトル: SCM Branch

  最大長: 256

  チェックアウトする特定のブランチ、タグまたはコミット。
• scm_clean: boolean
  タイトル: Scm clean

  プロジェクトを同期する前にローカルの変更を破棄します。
• scm_delete_on_update: boolean
  タイトル: Scm delete on update

  同期する前にプロジェクトを削除してください。
• scm_refspec: string
  タイトル: SCM refspec

  最大長: 1024

  gitプロジェクトの場合、フェッチする追加のrefspec。
• scm_revision: string
  タイトル: SCM Revision

  読取り専用: true

  最小長: 1

  指定されたプロジェクトおよびブランチについて、この更新によって検出されたSCMリビジョン。
• scm_track_submodules: boolean
  タイトル: Scm track submodules

  定義済ブランチの最新のコミットを追跡します。
• scm_type: string
  タイトル: SCM Type

  指定できる値: [ "", "git", "svn", "insights", "archive" ]

  プロジェクトを格納するために使用するソース管理システムを指定します。
• scm_url: string
  タイトル: SCM URL

  最大長: 1024

  プロジェクトが格納されるロケーション。
• started: string(date-time)
  タイトル: Started

  読取り専用: true

  ジョブが開始のためにキューに入れられた日時。
• status: string
  タイトル: Status

  読取り専用: true

  指定できる値: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• timeout: integer
  タイトル: Timeout

  タスクが取り消されるまでに実行される時間(秒)。
• type: string
  タイトル: Type

  読取り専用: true
• unified_job_template: string
  タイトル: unified job template

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true
• work_unit_id: string
  タイトル: Work unit id

  読取り専用: true

  最小長: 1

  このジョブに関連付けられた受容体作業ユニットID。

{
    "properties":{
        "canceled_on":{
            "description":"The date and time when the cancel request was sent.",
            "format":"date-time",
            "readOnly":true,
            "title":"Canceled on",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "event_processing_finished":{
            "description":"Indicates whether all of the events generated by this unified job have been saved to the database.",
            "readOnly":true,
            "title":"Event processing finished",
            "type":"boolean"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "execution_node":{
            "description":"The node the job executed on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Execution node",
            "type":"string"
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "finished":{
            "description":"The date and time the job finished execution.",
            "format":"date-time",
            "readOnly":true,
            "title":"Finished",
            "type":"string",
            "x-nullable":true
        },
        "host_status_counts":{
            "description":"Playbook stats from the Ansible playbook_on_stats event.",
            "readOnly":true,
            "title":"Host status counts",
            "type":"object",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "job_args":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job args",
            "type":"string"
        },
        "job_cwd":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job cwd",
            "type":"string"
        },
        "job_env":{
            "readOnly":true,
            "title":"job_env",
            "type":"object"
        },
        "job_explanation":{
            "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout",
            "minLength":"1",
            "readOnly":true,
            "title":"Job explanation",
            "type":"string"
        },
        "job_tags":{
            "description":"Parts of the project update playbook that will be run.",
            "maxLength":"1024",
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "default":"check",
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "launch_type":{
            "enum":[
                "manual",
                "relaunch",
                "callback",
                "scheduled",
                "dependency",
                "workflow",
                "webhook",
                "sync",
                "scm"
            ],
            "readOnly":true,
            "title":"Launch type",
            "type":"string"
        },
        "launched_by":{
            "readOnly":true,
            "title":"Launched by",
            "type":"string"
        },
        "local_path":{
            "description":"Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.",
            "maxLength":"1024",
            "title":"Local path",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "playbook_counts":{
            "description":"A count of all plays and tasks for the job run.",
            "readOnly":true,
            "title":"Playbook counts",
            "type":"string"
        },
        "project":{
            "readOnly":true,
            "title":"Project",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_traceback":{
            "minLength":"1",
            "readOnly":true,
            "title":"Result traceback",
            "type":"string"
        },
        "scm_branch":{
            "description":"Specific branch, tag or commit to checkout.",
            "maxLength":"256",
            "title":"SCM Branch",
            "type":"string",
            "x-nullable":true
        },
        "scm_clean":{
            "description":"Discard any local changes before syncing the project.",
            "title":"Scm clean",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_delete_on_update":{
            "description":"Delete the project before syncing.",
            "title":"Scm delete on update",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_refspec":{
            "description":"For git projects, an additional refspec to fetch.",
            "maxLength":"1024",
            "title":"SCM refspec",
            "type":"string",
            "x-nullable":true
        },
        "scm_revision":{
            "description":"The SCM Revision discovered by this update for the given project and branch.",
            "minLength":"1",
            "readOnly":true,
            "title":"SCM Revision",
            "type":"string"
        },
        "scm_track_submodules":{
            "description":"Track submodules latest commits on defined branch.",
            "title":"Scm track submodules",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_type":{
            "description":"Specifies the source control system used to store the project.",
            "enum":[
                "",
                "git",
                "svn",
                "insights",
                "archive"
            ],
            "title":"SCM Type",
            "type":"string",
            "x-nullable":true
        },
        "scm_url":{
            "description":"The location where the project is stored.",
            "maxLength":"1024",
            "title":"SCM URL",
            "type":"string",
            "x-nullable":true
        },
        "started":{
            "description":"The date and time the job was queued for starting.",
            "format":"date-time",
            "readOnly":true,
            "title":"Started",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "title":"Timeout",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "readOnly":true,
            "title":"unified job template",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "work_unit_id":{
            "description":"The Receptor work unit ID associated with this job.",
            "minLength":"1",
            "readOnly":true,
            "title":"Work unit id",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

ネストされたスキーマ : ホスト・ステータス数

型: object

タイトル: Host status counts

読取り専用: true

Ansible playbook_on_statsイベントからのPlaybook統計。

ネストされたスキーマ : job_env

型: object

タイトル: job_env

読取り専用: true

先頭に戻る