List Job Host Summaries for a Job
/api/v2/jobs/{id}/job_host_summaries/
Make a GET request to this resource to retrieve a list of job host summaries associated with the selected job.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The count field indicates the total number of job host summaries
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 job host summary records.
Results
Each job host summary data structure includes the following fields:
id: Database ID for this job host summary. (integer)type: Data type for this job host summary. (choice)url: URL for this job host summary. (string)related: Data structure with URLs of related resources. (object)summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created: Timestamp when this job host summary was created. (datetime)modified: Timestamp when this job host summary was last modified. (datetime)job: (id)host: (id)constructed_host: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)host_name: (string)changed: (integer)dark: (integer)failures: (integer)ok: (integer)processed: (integer)skipped: (integer)failed: (boolean)ignored: (integer)rescued: (integer)
Sorting
To specify that job host summaries 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
- application/json
-
page: integer
A page number within the paginated result set.
-
page_size: integer
Number of results to return per page.
-
search: string
A search term.
Response
- application/json
200 Response
object-
changed:
integer
Title:
ChangedRead Only:trueMinimum Value:0 -
constructed_host:
integer
Title:
Constructed hostRead Only:trueOnly for jobs run against constructed inventories, this links to the host inside the constructed inventory. -
created:
string
Title:
CreatedRead Only:true -
dark:
integer
Title:
DarkRead Only:trueMinimum Value:0 -
failed:
boolean
Title:
FailedRead Only:true -
failures:
integer
Title:
FailuresRead Only:trueMinimum Value:0 -
host:
integer
Title:
HostRead Only:true -
host_name:
string
Title:
Host nameRead Only:trueMinimum Length:1 -
id:
integer
Title:
IDRead Only:true -
ignored:
integer
Title:
IgnoredRead Only:trueMinimum Value:0 -
job:
string
Title:
JobRead Only:true -
modified:
string
Title:
ModifiedRead Only:true -
ok:
integer
Title:
OkRead Only:trueMinimum Value:0 -
processed:
integer
Title:
ProcessedRead Only:trueMinimum Value:0 - related: string
-
rescued:
integer
Title:
RescuedRead Only:trueMinimum Value:0 -
skipped:
integer
Title:
SkippedRead Only:trueMinimum Value:0 -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
type:
string
Title:
TypeRead Only:true -
url:
string
Title:
UrlRead Only:true