List Host Metric Summary Monthlys

get

/api/v2/host_metric_summary_monthly/

Make a GET request to this resource to retrieve the list of host metric summary monthlys.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of host metric summary monthlys 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 host metric summary monthly records.

Results

Each host metric summary monthly data structure includes the following fields:

  • id: Database ID for this host metric summary monthly. (integer)
  • date: (date)
  • license_consumed: How many unique hosts are consumed from the license (integer)
  • license_capacity: 'License capacity as max. number of unique hosts (integer)
  • hosts_added: How many hosts were added in the associated month, consuming more license capacity (integer)
  • hosts_deleted: How many hosts were deleted in the associated month, freeing the license capacity (integer)
  • indirectly_managed_hosts: Manually entered number indirectly managed hosts for a certain month (integer)

Sorting

To specify that host metric summary monthlys 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
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : results
Type: array
Show Source
Nested Schema : HostMetricSummaryMonthly
Type: object
Show Source
Back to Top