Documentation

統合ジョブリストの API エンドポイント

このリソースに GET リクエストを実行して、統合ジョブリストを取得します。

GET /api/v1/unified_jobs/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
X-API-Time: 0.063s

返されるデータ構造には以下のものが含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

count フィールドはクエリーで見つかった統合ジョブの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results には統合ジョブレコードが一覧表示されますが、ゼロの場合もあります。

注釈

Ansible Tower の暗号化および暗号化解除のルールは、認証情報外のフィールドである統合ジョブの start_args フィールドにも適用されます。これは、jobad_hoc_command、および system_job のデータタイプに使用されるものです。詳細情報については、Ansible Tower User GuideUnderstanding How Credentials Work を参照してください。

結果

各統合ジョブのデータ構造には以下のフィールドが含まれます。

  • id: 統合ジョブのデータベース ID (整数)
  • type: 統合ジョブのデータタイプ (複数選択)
    • project_update: SCM 更新
    • inventory_update: インベントリーの同期
    • job: Playbook の実行
    • ad_hoc_command: コマンド
    • system_job: 管理ジョブ
  • url: 統合ジョブの URL (文字列)
  • related: 関連リソースの URL のあるデータ構造 (オブジェクト)
  • summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)
  • created: 統合ジョブ作成時のタイムスタンプ (日時)
  • modified: 統合ジョブの最終更新時のタイムスタンプ (日時)
  • name: (文字列)
  • description: (文字列)
  • unified_job_template: (フィールド)
  • launch_type: (複数選択)
    • manual: 手動
    • callback: コールバック
    • scheduled: スケジュール済み
    • dependency: 依存関係
  • status: (複数選択)
    • new: 新規
    • pending: 保留中
    • waiting: 待機中
    • running: 実行中
    • successful: 成功
    • failed: 失敗
    • error: エラー
    • canceled: キャンセル済み
  • failed: (ブール値)
  • started: (日時)
  • finished: (日時)
  • elapsed: (10 進数)
  • job_explanation: (文字列)

オプションエンドポイントの確認

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

name Unified Job List
description # List Unified Jobs: Make a GET request to this resource to retrieve the list of unified jobs.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.4.8
types
0 project_update
1 inventory_update
2 job
3 ad_hoc_command
4 system_job
actions
GET
id
type integer
label ID
help_text Database ID for this unified job.
type
type multiple choice
help_text Data type for this unified job.
choices
0
0 project_update
1 SCM Update
1
0 inventory_update
1 Inventory Sync
2
0 job
1 Playbook Run
3
0 ad_hoc_command
1 Command
4
0 system_job
1 Management Job
url
type string
help_text URL for this unified job.
related
type object
help_text Data structure with URLs of related resources.
summary_fields
type object
help_text Data structure with name/description for related resources.
created
type datetime
help_text Timestamp when this unified job was created.
modified
type datetime
help_text Timestamp when this unified job was last modified.
name
type string
label name
description
type string
label description
unified_job_template
type field
label unified job template
launch_type
type multiple choice
label launch type
choices
0
0 manual
1 Manual
1
0 callback
1 Callback
2
0 scheduled
1 Scheduled
3
0 dependency
1 Dependency
status
type multiple choice
label status
choices
0
0 new
1 New
1
0 pending
1 Pending
2
0 waiting
1 Waiting
3
0 running
1 Running
4
0 successful
1 Successful
5
0 failed
1 Failed
6
0 error
1 Error
7
0 canceled
1 Canceled
failed
type boolean
label failed
started
type datetime
label started
finished
type datetime
label finished
elapsed
type decimal
label elapsed
job_explanation
type string
label job explanation
search_fields
0 description
1 name