グループのすべてのホストのリスト
get
/api/v2/groups/{id}/all_hosts/
このリソースに対して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
: このホストのオプションの説明。(文字列)inventory
: (id)enabled
: このホストがオンラインで、ジョブの実行に使用できるかどうか。(ブール)instance_id
: ホストを一意に識別するためにリモート・インベントリ・ソースによって使用される値(文字列)variables
: JSONまたはYAML形式のホスト変数。(json)has_active_failures
: (フィールド)has_inventory_sources
: (フィールド)last_job
: (id)last_job_host_summary
: (id)insights_system_id
: Red Hat Insightsのホストの一意識別子。(文字列)ansible_facts_modified
: ansible_factsが最後に変更された日時。(日時)
ソート
ホストが特定の順序で返されるように指定するには、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(オプション): 文字列
検索条件。