インベントリのインスタンス・グループのリスト
get
/api/v2/inventories/{id}/instance_groups/
このリソースに対してGETリクエストを行って、選択したインベントリに関連付けられたインスタンス・グループのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、対象となる問合せで見つかったインスタンス・グループの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上のインスタンス・グループ・レコードが含まれます。
結果
それぞれのインスタンス・グループ・データ構造には次のフィールドが含まれます。
id: このインスタンス・グループのデータベースID。(整数)type: このインスタンス・グループのデータ型。(選択)url: このインスタンス・グループのURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)name: このインスタンス・グループの名前。(文字列)created: このインスタンス・グループが作成されたときのタイムスタンプ。(日時)modified: このインスタンス・グループが最後に変更されたときのタイムスタンプ。(日時)capacity: (フィールド)committed_capacity: (フィールド)consumed_capacity: (フィールド)percent_capacity_remaining: (フィールド)jobs_running: このインスタンス・グループの対象となる実行状態または待機状態のジョブの数(整数)jobs_total: このインスタンス・グループを対象とするすべてのジョブの数(整数)instances: (フィールド)controller: このグループをリモートで制御するインスタンス・グループ。(id)is_controller: インスタンス・グループが他のグループを制御するかどうかを示します(ブール)is_isolated: このグループのインスタンスが分離されているかどうかを示します。分離されているグループには、指定されたコントローラ・グループがあります。(ブール)is_containerized: このグループのインスタンスがコンテナ化されているかどうかを示します。コンテナ化されているグループには、指定されたOpenshiftまたはKubernetesクラスタがあります。(ブール)credential: (id)policy_instance_percentage: 新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるすべてのインスタンスの最小パーセント。(整数)policy_instance_minimum: 新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるインスタンスの静的最小数。(整数)policy_instance_list: このグループに割り当てられる完全一致インスタンスのリスト(json)pod_spec_override: (文字列)summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
ソート
インスタンス・グループが特定の順序で返されるように指定するには、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":5,
"next":null,
"previous":null,
"results":[
{
"capacity":0,
"committed_capacity":0,
"consumed_capacity":0,
"controller":null,
"created":"2018-02-01T08:00:00.000000Z",
"credential":null,
"id":5,
"instances":0,
"is_containerized":false,
"is_controller":false,
"is_isolated":false,
"jobs_running":0,
"jobs_total":0,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"iso-3",
"percent_capacity_remaining":0,
"pod_spec_override":"",
"policy_instance_list":[
],
"policy_instance_minimum":0,
"policy_instance_percentage":0,
"related":{
"instances":"/api/v2/instance_groups/5/instances/",
"jobs":"/api/v2/instance_groups/5/jobs/"
},
"summary_fields":{
"user_capabilities":{
"delete":true,
"edit":true
}
},
"type":"instance_group",
"url":"/api/v2/instance_groups/5/"
},
{
"capacity":0,
"committed_capacity":0,
"consumed_capacity":0,
"controller":null,
"created":"2018-02-01T08:00:00.000000Z",
"credential":null,
"id":3,
"instances":0,
"is_containerized":false,
"is_controller":false,
"is_isolated":false,
"jobs_running":0,
"jobs_total":0,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"iso-0",
"percent_capacity_remaining":0,
"pod_spec_override":"",
"policy_instance_list":[
],
"policy_instance_minimum":0,
"policy_instance_percentage":0,
"related":{
"instances":"/api/v2/instance_groups/3/instances/",
"jobs":"/api/v2/instance_groups/3/jobs/"
},
"summary_fields":{
"user_capabilities":{
"delete":true,
"edit":true
}
},
"type":"instance_group",
"url":"/api/v2/instance_groups/3/"
},
{
"capacity":0,
"committed_capacity":0,
"consumed_capacity":0,
"controller":null,
"created":"2018-02-01T08:00:00.000000Z",
"credential":null,
"id":4,
"instances":0,
"is_containerized":false,
"is_controller":false,
"is_isolated":false,
"jobs_running":0,
"jobs_total":0,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"iso-2",
"percent_capacity_remaining":0,
"pod_spec_override":"",
"policy_instance_list":[
],
"policy_instance_minimum":0,
"policy_instance_percentage":0,
"related":{
"instances":"/api/v2/instance_groups/4/instances/",
"jobs":"/api/v2/instance_groups/4/jobs/"
},
"summary_fields":{
"user_capabilities":{
"delete":true,
"edit":true
}
},
"type":"instance_group",
"url":"/api/v2/instance_groups/4/"
},
{
"capacity":0,
"committed_capacity":0,
"consumed_capacity":0,
"controller":null,
"created":"2018-02-01T08:00:00.000000Z",
"credential":null,
"id":2,
"instances":0,
"is_containerized":false,
"is_controller":false,
"is_isolated":false,
"jobs_running":0,
"jobs_total":0,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"iso-4",
"percent_capacity_remaining":0,
"pod_spec_override":"",
"policy_instance_list":[
],
"policy_instance_minimum":0,
"policy_instance_percentage":0,
"related":{
"instances":"/api/v2/instance_groups/2/instances/",
"jobs":"/api/v2/instance_groups/2/jobs/"
},
"summary_fields":{
"user_capabilities":{
"delete":true,
"edit":true
}
},
"type":"instance_group",
"url":"/api/v2/instance_groups/2/"
},
{
"capacity":0,
"committed_capacity":0,
"consumed_capacity":0,
"controller":null,
"created":"2018-02-01T08:00:00.000000Z",
"credential":null,
"id":1,
"instances":0,
"is_containerized":false,
"is_controller":false,
"is_isolated":false,
"jobs_running":0,
"jobs_total":0,
"modified":"2018-02-01T08:00:00.000000Z",
"name":"iso-1",
"percent_capacity_remaining":0,
"pod_spec_override":"",
"policy_instance_list":[
],
"policy_instance_minimum":0,
"policy_instance_percentage":0,
"related":{
"instances":"/api/v2/instance_groups/1/instances/",
"jobs":"/api/v2/instance_groups/1/jobs/"
},
"summary_fields":{
"user_capabilities":{
"delete":true,
"edit":true
}
},
"type":"instance_group",
"url":"/api/v2/instance_groups/1/"
}
]
}