1. Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド
  2. タスク
  3. ジョブ

ジョブのジョブ・ホスト・サマリーのリスト

get

/api/v2/jobs/{id}/job_host_summaries/

このリソースに対して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: このジョブ・ホスト・サマリーが最後に変更されたときのタイムスタンプ。(日時)
  • job: (id)
  • host: (id)
  • constructed_host: 構築済インベントリに対して実行されるジョブの場合のみ、これが構築済インベントリ内のホストにリンクされます。(id)
  • host_name: (文字列)
  • changed: (整数)
  • dark: (整数)
  • failures: (整数)
  • ok: (整数)
  • processed: (整数)
  • skipped: (整数)
  • failed: (ブール)
  • ignored: (整数)
  • rescued: (整数)

ソート

ジョブ・ホスト・サマリーが特定の順序で返されるように指定するには、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

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
問合せパラメータ
先頭に戻る

レスポンス

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

200レスポンス

本文()
ルート・スキーマ: schema
型: object
ソースを表示
ネストされたスキーマ : results
型: array
ソースを表示
ネストされたスキーマ : JobHostSummary
型: object
ソースを表示
先頭に戻る