このリソースに GET リクエストを実行して、ジョブリストを取得します。
GET /api/v2/jobs/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
X-API-Time: 0.052s
返されるデータ構造には以下のものが含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count
フィールドはクエリーで見つかったジョブの合計数を示します。next
および previous
フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results
にはジョブレコードが一覧表示されますが、ゼロの場合もあります。
各ジョブデータ構造には以下のフィールドが含まれます。
id
: ジョブのデータベース ID (整数)type
: ジョブのデータタイプ (複数選択)job
: Playbook の実行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
: (文字列)job_type
: (複数選択)run
: 実行check
: チェックscan
: スキャンinventory
: (フィールド)project
: (フィールド)playbook
: (文字列)credential
: (フィールド)cloud_credential
: (フィールド)forks
: (整数)limit
: (文字列)verbosity
: (複数選択)0
: 0 (正常)1
: 1 (詳細)2
: 2 (より詳細)3
: 3 (デバッグ)4
: 4 (接続デバッグ)5
: 5 (WinRM デバッグ)extra_vars
: (文字列)job_tags
: (文字列)force_handlers
: (ブール値)skip_tags
: (文字列)start_at_task
: (文字列)job_template
: (フィールド)passwords_needed_to_start
: (フィールド)ask_variables_on_launch
: (フィールド)新規ジョブを作成するには、以下のジョブフィールドを使ってリソースに POST リクエストを実行します。
name
: (文字列。必須)description
: (文字列。デフォルトは ""
)job_type
: (複数選択。必須)run
: 実行 (デフォルト)check
: チェックscan
: スキャンinventory
: (フィールド。デフォルトは None)project
: (フィールド。デフォルトは None)playbook
: (文字列。デフォルトは ""
)credential
: (フィールド。デフォルトは None)cloud_credential
: (フィールド。デフォルトは None)forks
: (整数。デフォルトは 0)limit
: (文字列。デフォルトは ""
)verbosity
: (複数選択)0
: 0 (正常。これがデフォルト)1
: 1 (詳細)2
: 2 (より詳細)3
: 3 (デバッグ)4
: 4 (接続デバッグ)5
: 5 (WinRM デバッグ)extra_vars
: (文字列。デフォルトは ""
)job_tags
: (文字列。デフォルトは ""
)force_handlers
: (ブール値。デフォルトは False)skip_tags
: (文字列。デフォルトは ""
)start_at_task
: (文字列。デフォルトは ""
)job_template
: (フィールド。デフォルトは None)job_template フィールドが指定されている場合、新規ジョブの (name および description 以外で) 明示的に指定されていないフィールドでは、このジョブテンプレートのデフォルト値が使用されます。
注釈
Ansible Tower v3.1 からは、/jobs/
エンドポイントでの POST リクエストの実行は廃止されています。
オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。
name | Job List | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
description | # List Jobs: Make a GET request to this resource to retrieve the list of jobs. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renders |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
parses |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
added_in_version | 1.2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
actions |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
types |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
search_fields |
|