List Instance Groups for an Organization
get
/api/v2/organizations/{id}/instance_groups/
Make a GET request to this resource to retrieve a list of instance groups associated with the selected organization.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The count field indicates the total number of instance groups
found for the given query. The next and previous fields provides links to
additional results if there are more than will fit on a single page. The
results list contains zero or more instance group records.
Results
Each instance group data structure includes the following fields:
id: Database ID for this instance group. (integer)type: Data type for this instance group. (choice)url: URL for this instance group. (string)related: Data structure with URLs of related resources. (object)name: Name of this instance group. (string)created: Timestamp when this instance group was created. (datetime)modified: Timestamp when this instance group was last modified. (datetime)capacity: (field)committed_capacity: (field)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance group (integer)jobs_total: Count of all jobs that target this instance group (integer)instances: (field)controller: Instance Group to remotely control this group. (id)is_controller: Indicates whether instance group controls any other group (boolean)is_isolated: Indicates whether instances in this group are isolated.Isolated groups have a designated controller group. (boolean)is_containerized: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean)credential: (id)policy_instance_percentage: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer)policy_instance_minimum: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer)policy_instance_list: List of exact-match Instances that will be assigned to this group (json)pod_spec_override: (string)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
Sorting
To specify that instance groups are returned in a particular
order, use the order_by query string parameter on the GET request.
?order_by=name
Prefix the field name with a dash - to sort in reverse:
?order_by=-name
Multiple sorting fields may be specified by separating the field names with a
comma ,:
?order_by=name,some_other_field
Pagination
Use the page_size query string parameter to change the number of results
returned for each request. Use the page query string parameter to retrieve
a particular page of results.
?page_size=100&page=2
The previous and next links returned with the results will set these query
string parameters automatically.
Searching
Use the search query string parameter to perform a case-insensitive search
within all designated text fields of a model.
?search=findme
(Added in Ansible Tower 3.1.0) Search across related fields:
?related__search=findme
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
page(optional): integer
A page number within the paginated result set.
-
page_size(optional): integer
Number of results to return per page.
-
search(optional): string
A search term.
Response
Supported Media Types
- application/json
200 Response
Example Response (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":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/"
},
{
"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-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/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":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":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":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-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/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/"
}
]
}