インベントリのルート・グループのリスト
get
/api/v2/inventories/{id}/root_groups/
このリソースに対して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)variables: JSONまたはYAML形式のグループ変数。(json)
ソート
グループが特定の順序で返されるように指定するには、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レスポンス
ネストされたスキーマ : Group
型:
ソースを表示
object- created: 文字列
タイトル:
Created読取り専用:true - description: 文字列
タイトル:
Description - id: 整数
タイトル:
ID読取り専用:true - inventory(必須): 整数
タイトル:
Inventory - modified: 文字列
タイトル:
Modified読取り専用:true - name(必須): 文字列
タイトル:
Name最小長:1最大長:512 - related: 文字列
- summary_fields: 文字列
タイトル:
Summary fields読取り専用:true - type: 文字列
タイトル:
Type読取り専用:true - url: 文字列
タイトル:
Url読取り専用:true - variables: 文字列
タイトル:
VariablesJSONまたはYAML形式のグループ変数。