機械翻訳について

移動先

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

ジョブの取得

get

/api/v2/jobs/{id}/

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

• id: このジョブのデータベースID。(integer)
• type: このジョブのデータ型。(choice)
• url: このジョブのURL。(string)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このジョブが作成されたときのタイムスタンプ。(datetime)
• modified: このジョブが最後に変更されたときのタイムスタンプ。(datetime)
• name: このジョブの名前。(string)
• description: このジョブのオプションの説明。(string)
• job_type: (選択)
  • run: 実行
  • check: チェック
  • scan: スキャン
• inventory: (id)
• project: (id)
• playbook: (文字列)
• scm_branch: ジョブ実行で使用するブランチ。 空白の場合に使用されるプロジェクト・デフォルト。 プロジェクトallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(string)
• 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: (string)
• timeout: タスクが取り消されるまでに実行する時間(秒)。(integer)
• 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: ジョブが開始のためにキューに入れられた日時。(datetime)
• finished: ジョブの実行が終了した日時。(datetime)
• canceled_on: 取消リクエストが送信された日時。(datetime)
• elapsed: ジョブが実行された経過時間(秒)。(10進数)
• job_args: (文字列)
• job_cwd: (文字列)
• job_env: (json)
• job_explanation: 標準出力(string)を実行および取得できなかったジョブの状態を示すステータス・フィールド
• execution_node: ジョブが実行されたノード。(string)
• controller_node: 実行環境を管理したインスタンス。(文字列)
• result_traceback: (文字列)
• event_processing_finished: この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。(boolean)
• launched_by: (フィールド)
• work_unit_id: このジョブに関連付けられた受信者作業ユニットID。(文字列)
• job_template: (id)
• passwords_needed_to_start: (field)
• allow_simultaneous: (ブール)
• artifacts: (json)
• scm_revision: このジョブに使用されるプロジェクトからのSCMリビジョン(使用可能な場合)(string)
• instance_group: ジョブが実行されたインスタンス・グループ(id)
• diff_mode: 有効にすると、ホスト上のテンプレート化されたファイルに対して行われたテキスト変更が標準出力(boolean)に表示されます。
• job_slice_number: スライスされたジョブの一部である場合、インベントリ・スライスのIDが操作されます。 スライスされたジョブの一部でない場合、パラメータは使用されません。(integer)
• job_slice_count: スライスされたジョブの一部として実行された場合、スライスの合計数。 1の場合、ジョブはスライスされたジョブの一部ではありません。(integer)
• webhook_service: webフック・リクエストが受け入れられるサービス(choice)
  • "": ---------
  • github: GitHub
  • gitlab: GitLab
  • bitbucket_dc: BitBucket DataCenter
• webhook_credential: サービスAPI (id)にステータスを転記するための個人アクセス・トークン
• webhook_guid: このwebフックをトリガーしたイベントの一意識別子(string)
• host_status_counts: Ansible playbook_on_statsイベントからのPlaybook統計。(json)
• playbook_counts: ジョブ実行のすべての再生とタスクの数。(field)
• custom_virtualenv: (文字列)

リクエスト

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

• application/json

パス・パラメータ

• id(required): string

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : JobDetail

型: object

ソースを表示

• allow_simultaneous: boolean
  タイトル: Allow simultaneous
• artifacts: string
  タイトル: Artifacts

  読取り専用: true
• canceled_on: string(date-time)
  タイトル: Canceled on

  読取り専用: true

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

  読取り専用: true

  最小長: 1

  実行環境を管理したインスタンス。
• created: string
  タイトル: Created

  読取り専用: true
• custom_virtualenv: string
  タイトル: Custom virtualenv

  読取り専用: true
• description: string
  タイトル: Description
• diff_mode: boolean
  タイトル: Diff mode

  有効にすると、ホスト上のテンプレート化されたファイルに対して行われたテキスト変更が標準出力に表示されます
• 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

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

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

  読取り専用: true

  ジョブの実行が終了した日時。
• force_handlers: boolean
  タイトル: Force handlers
• forks: integer
  タイトル: Forks

  最小値: 0
• host_status_counts: object Host status counts
  タイトル: Host status counts

  読取り専用: true

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

  読取り専用: true
• instance_group: integer
  タイトル: Instance group

  ジョブが実行されたインスタンス・グループ
• inventory: integer
  タイトル: Inventory
• 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_slice_count: integer
  タイトル: Job slice count

  最小値: 0

  デフォルト値: 1

  スライスされたジョブの一部として実行された場合、スライスの合計数。 1の場合、ジョブはスライスされたジョブの一部ではありません。
• job_slice_number: integer
  タイトル: Job slice number

  最小値: 0

  スライスされたジョブの一部である場合、インベントリ・スライスのIDが操作されます。 スライスされたジョブの一部ではない場合、パラメータは使用されません。
• job_tags: string
  タイトル: Job tags
• job_template: string
  タイトル: Job template
• job_type: string
  タイトル: Job type

  デフォルト値: run

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

  読取り専用: true

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

  読取り専用: true
• limit: string
  タイトル: Limit
• modified: string
  タイトル: Modified

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

  最小長: 1

  最大長: 512
• organization: integer
  タイトル: Organization

  読取り専用: true

  この統合ジョブへのアクセスを決定するために使用される組織。
• passwords_needed_to_start: string
  タイトル: Passwords needed to start

  読取り専用: true
• playbook: string
  タイトル: Playbook

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

  読取り専用: true

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

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

  読取り専用: true

  最小長: 1
• scm_branch: string
  タイトル: Scm branch

  最大長: 1024

  ジョブ実行で使用するブランチ。 空白の場合に使用されるプロジェクト・デフォルト。 プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。
• scm_revision: string
  タイトル: SCM Revision

  読取り専用: true

  最小長: 1

  このジョブに使用されたプロジェクトからのSCM改訂(使用可能な場合)
• skip_tags: string
  タイトル: Skip tags

  最大長: 1024
• start_at_task: string
  タイトル: Start at task

  最大長: 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
• use_fact_cache: boolean
  タイトル: Use fact cache

  有効にすると、サービスはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の最後にファクトを永続化し、Ansibleで使用するファクトをキャッシュします。
• verbosity: integer
  タイトル: Verbosity

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]
• webhook_credential: integer
  タイトル: Webhook credential

  サービスAPIにステータスを転記するための個人アクセス・トークン
• webhook_guid: string
  タイトル: Webhook guid

  最大長: 128

  このwebフックをトリガーしたイベントの一意識別子
• webhook_service: string
  タイトル: Webhook service

  指定できる値: [ "github", "gitlab", "bitbucket_dc" ]

  webフック・リクエストを受け入れるサービス
• work_unit_id: string
  タイトル: Work unit id

  読取り専用: true

  最小長: 1

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

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "artifacts":{
            "readOnly":true,
            "title":"Artifacts",
            "type":"string"
        },
        "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
        },
        "controller_node":{
            "description":"The instance that managed the execution environment.",
            "minLength":"1",
            "readOnly":true,
            "title":"Controller node",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "custom_virtualenv":{
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "diff_mode":{
            "description":"If enabled, textual changes made to any templated files on the host are shown in the standard output",
            "title":"Diff mode",
            "type":"boolean",
            "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"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "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
        },
        "force_handlers":{
            "title":"Force handlers",
            "type":"boolean",
            "x-nullable":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "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"
        },
        "instance_group":{
            "description":"The Instance group the job was run under",
            "title":"Instance group",
            "type":"integer",
            "x-nullable":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "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_slice_count":{
            "default":"1",
            "description":"If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.",
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer"
        },
        "job_slice_number":{
            "description":"If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.",
            "minimum":"0",
            "title":"Job slice number",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_template":{
            "title":"Job template",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "default":"run",
            "enum":[
                "run",
                "check",
                "scan"
            ],
            "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"
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this unified job.",
            "readOnly":true,
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "passwords_needed_to_start":{
            "readOnly":true,
            "title":"Passwords needed to start",
            "type":"string"
        },
        "playbook":{
            "maxLength":"1024",
            "title":"Playbook",
            "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":{
            "title":"Project",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_traceback":{
            "minLength":"1",
            "readOnly":true,
            "title":"Result traceback",
            "type":"string"
        },
        "scm_branch":{
            "description":"Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.",
            "maxLength":"1024",
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "scm_revision":{
            "description":"The SCM Revision from the Project used for this job, if available",
            "minLength":"1",
            "readOnly":true,
            "title":"SCM Revision",
            "type":"string"
        },
        "skip_tags":{
            "maxLength":"1024",
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "start_at_task":{
            "maxLength":"1024",
            "title":"Start at task",
            "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"
        },
        "use_fact_cache":{
            "description":"If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.",
            "title":"Use fact cache",
            "type":"boolean",
            "x-nullable":true
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "title":"Webhook credential",
            "type":"integer",
            "x-nullable":true
        },
        "webhook_guid":{
            "description":"Unique identifier of the event that triggered this webhook",
            "maxLength":"128",
            "title":"Webhook guid",
            "type":"string",
            "x-nullable":true
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "enum":[
                "github",
                "gitlab",
                "bitbucket_dc"
            ],
            "title":"Webhook service",
            "type":"string",
            "x-nullable":true
        },
        "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

先頭に戻る