在庫の在庫のリスト
get
/api/v2/inventories/{id}/input_inventories/
このリソースに対してGETリクエストを行って、選択したインベントリに関連付けられたインベントリのリストを取得します。
結果のデータ構造には次のものが含まれます:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、特定の問合せについて検出されたインベントリの合計数を示します。 nextフィールドとpreviousフィールドには、単一ページに収まる以上の結果へのリンクが表示されます。 resultsリストには、0個以上のインベントリ・レコードが含まれます。
結果
各インベントリ・データ構造には次のフィールドが含まれます。
id: このインベントリのデータベースID。(integer)type: このインベントリのデータ型。(choice)url: このインベントリのURL。(string)related: 関連リソースのURLを持つデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を持つデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: このインベントリが作成された時点のタイムスタンプ。(datetime)modified: このインベントリが最後に変更されたタイムスタンプ。(datetime)name: このインベントリの名前。(string)description: このインベントリのオプションの説明。(string)organization: このインベントリを含む組織。(id)kind: 表されるインベントリの種類。(choice)"": ホストには、このインベントリへの直接リンクがあります。smart: host_filterプロパティを使用して生成されたインベントリのホスト。constructed: 構築されたインベントリ・プラグインでソース在庫のリストを解析します。
host_filter: このインベントリのホストに適用されるフィルタ。(string)variables: JSONまたはYAML形式のインベントリ変数。(json)has_active_failures: このフィールドは非推奨であり、将来のリリースで削除されます。 このインベントリのホストが失敗したかどうかを示すフラグ。(boolean)total_hosts: このフィールドは非推奨であり、将来のリリースで削除されます。 このインベントリの合計ホスト数。(integer)hosts_with_active_failures: このフィールドは非推奨であり、将来のリリースで削除されます。 アクティブな失敗のあるこのインベントリのホスト数。(integer)total_groups: このフィールドは非推奨であり、将来のリリースで削除されます。 このインベントリのグループの合計数。(integer)has_inventory_sources: このフィールドは非推奨であり、将来のリリースで削除されます。 このインベントリに外部インベントリ・ソースがあるかどうかを示すフラグ。(boolean)total_inventory_sources: このインベントリ内に構成されている外部インベントリ・ソースの合計数。(integer)inventory_sources_with_failures: 障害のあるこのインベントリの外部インベントリ・ソースの数。(integer)pending_deletion: インベントリが削除されていることを示すフラグ。(boolean)prevent_instance_group_fallback: 有効にすると、在庫管理では、関連付けられたジョブ・テンプレートを実行するために、組織インスタンス・グループを優先インスタンス・グループのリストに追加できなくなります。この設定が有効で、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。(ブール)
ソート
インベントリが特定の順序で返されることを指定するには、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タワー3.1.0で追加」)関連フィールド全体を検索します:
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page: integer
ページ区切り結果セット内のページ番号。
- page_size: integer
ページ当たりに返す結果の数。
- search: string
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ネストされたスキーマ : インベントリ
型:
ソースを表示
object- created: string
タイトル:
Created読取り専用:true - description: string
タイトル:
Description - has_active_failures: boolean
タイトル:
Has active failures読取り専用:trueこのフィールドは非推奨であり、将来のリリースで削除されます。 このインベントリ内のホストに障害が発生したかどうかを示すフラグ。 - has_inventory_sources: boolean
タイトル:
Has inventory sources読取り専用:trueこのフィールドは非推奨であり、将来のリリースで削除されます。 この在庫に外部在庫ソースがあるかどうかを示すフラグ。 - host_filter: string
タイトル:
Host filterこのインベントリのホストに適用されるフィルタ。 - hosts_with_active_failures: integer
タイトル:
Hosts with active failures読取り専用:true最小値:0このフィールドは非推奨であり、将来のリリースで削除されます。 アクティブな障害があるこのインベントリ内のホストの数。 - id: integer
タイトル:
ID読取り専用:true - inventory_sources_with_failures: integer
タイトル:
Inventory sources with failures読取り専用:true最小値:0失敗があるこのインベントリ内の外部インベントリ・ソースの数。 - 親切な: string
タイトル:
Kind指定できる値:[ "", "smart", "constructed" ]表される在庫の種類。 - modified: string
タイトル:
Modified読取り専用:true - name(required): string
タイトル:
Name最小長:1最大長:512 - organization(required): integer
タイトル:
Organizationこの在庫を含む組織。 - pending_deletion: boolean
タイトル:
Pending deletion読取り専用:true在庫が削除されることを示すフラグ。 - prevent_instance_group_fallback: boolean
タイトル:
Prevent instance group fallback有効にすると、在庫管理では、関連付けられたジョブ・テンプレートを実行するために、組織インスタンス・グループを優先インスタンス・グループのリストに追加できなくなります。この設定が有効で、空のリストを指定した場合、グローバル・インスタンス・グループが適用されます。 - related: string
- summary_fields: string
タイトル:
Summary fields読取り専用:true - total_groups: integer
タイトル:
Total groups読取り専用:true最小値:0このフィールドは非推奨であり、将来のリリースで削除されます。 この在庫のグループの合計数。 - total_hosts: integer
タイトル:
Total hosts読取り専用:true最小値:0このフィールドは非推奨であり、将来のリリースで削除されます。 このインベントリ内のホストの合計数。 - total_inventory_sources: integer
タイトル:
Total inventory sources読取り専用:true最小値:0この在庫内に構成された外部在庫ソースの合計数。 - type: string
タイトル:
Type読取り専用:true - url: string
タイトル:
Url読取り専用:true - variables: string
タイトル:
VariablesJSONまたはYAML形式のインベントリ変数。