統合ジョブのリスト
get
/api/v2/unified_jobs/
このリソースに対してGETリクエストを行って、統合ジョブのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、対象となる問合せで見つかった統合ジョブの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上の統合ジョブ・レコードが含まれます。
結果
それぞれの統合ジョブ・データ構造には次のフィールドが含まれます。
id: この統合ジョブのデータベースID。(整数)type: この統合ジョブのデータ型。(選択)url: この統合ジョブのURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: この統合ジョブが作成されたときのタイムスタンプ。(日時)modified: この統合ジョブが最後に変更されたときのタイムスタンプ。(日時)name: この統合ジョブの名前。(文字列)description: この統合ジョブのオプションの説明。(文字列)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_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)execution_node: ジョブが実行されたノード。(文字列)controller_node: 分離された実行環境を管理していたインスタンス。(文字列)
ソート
統合ジョブが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。
?order_by=name
フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。
?order_by=-name
フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。
?order_by=name,some_other_field
ページ区切り
リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。 特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。
?page_size=100&page=2
結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。
検索
モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。
?search=findme
(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"count":1,
"next":null,
"previous":null,
"results":[
{
"allow_simultaneous":false,
"artifacts":{
},
"canceled_on":null,
"controller_node":"",
"created":"2018-02-01T08:00:00.000000Z",
"description":"",
"diff_mode":false,
"elapsed":0,
"execution_node":"",
"extra_vars":"{}",
"failed":false,
"finished":null,
"force_handlers":false,
"forks":0,
"id":1,
"instance_group":null,
"inventory":null,
"job_explanation":"",
"job_slice_count":1,
"job_slice_number":0,
"job_tags":"",
"job_template":1,
"job_type":"run",
"launch_type":"manual",
"limit":"",
"modified":"2018-02-01T08:00:00.000000Z",
"name":"",
"organization":null,
"passwords_needed_to_start":[
],
"playbook":"",
"project":null,
"related":{
"activity_stream":"/api/v2/jobs/1/activity_stream/",
"cancel":"/api/v2/jobs/1/cancel/",
"create_schedule":"/api/v2/jobs/1/create_schedule/",
"credentials":"/api/v2/jobs/1/credentials/",
"job_events":"/api/v2/jobs/1/job_events/",
"job_host_summaries":"/api/v2/jobs/1/job_host_summaries/",
"job_template":"/api/v2/job_templates/1/",
"labels":"/api/v2/jobs/1/labels/",
"notifications":"/api/v2/jobs/1/notifications/",
"relaunch":"/api/v2/jobs/1/relaunch/",
"stdout":"/api/v2/jobs/1/stdout/",
"unified_job_template":"/api/v2/job_templates/1/"
},
"scm_branch":"",
"scm_revision":"",
"skip_tags":"",
"start_at_task":"",
"started":null,
"status":"new",
"summary_fields":{
"credentials":[
],
"job_template":{
"description":"",
"id":1,
"name":""
},
"labels":{
"count":0,
"results":[
]
},
"unified_job_template":{
"description":"",
"id":1,
"name":"",
"unified_job_type":"job"
},
"user_capabilities":{
"delete":true,
"start":false
}
},
"timeout":0,
"type":"job",
"unified_job_template":1,
"url":"/api/v2/jobs/1/",
"use_fact_cache":false,
"verbosity":0,
"webhook_credential":null,
"webhook_guid":"",
"webhook_service":""
}
]
}