Jump to

• Request
• Response

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

• application/json

Query Parameters

• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/HostMetricSummaryMonthly"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

• Array of: object HostMetricSummaryMonthly

{
    "items":{
        "$ref":"#/definitions/HostMetricSummaryMonthly"
    },
    "type":"array"
}

Nested Schema : HostMetricSummaryMonthly

Type: object

Show Source

• date: string(date)
  Title: Date

  Read Only: true
• hosts_added: integer
  Title: Hosts added

  Read Only: true

  How many hosts were added in the associated month, consuming more license capacity
• hosts_deleted: integer
  Title: Hosts deleted

  Read Only: true

  How many hosts were deleted in the associated month, freeing the license capacity
• id: integer
  Title: ID

  Read Only: true
• indirectly_managed_hosts: integer
  Title: Indirectly managed hosts

  Read Only: true

  Manually entered number indirectly managed hosts for a certain month
• license_capacity: integer
  Title: License capacity

  Read Only: true

  'License capacity as max. number of unique hosts
• license_consumed: integer
  Title: License consumed

  Read Only: true

  How many unique hosts are consumed from the license

{
    "properties":{
        "date":{
            "format":"date",
            "readOnly":true,
            "title":"Date",
            "type":"string"
        },
        "hosts_added":{
            "description":"How many hosts were added in the associated month, consuming more license capacity",
            "readOnly":true,
            "title":"Hosts added",
            "type":"integer"
        },
        "hosts_deleted":{
            "description":"How many hosts were deleted in the associated month, freeing the license capacity",
            "readOnly":true,
            "title":"Hosts deleted",
            "type":"integer"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "indirectly_managed_hosts":{
            "description":"Manually entered number indirectly managed hosts for a certain month",
            "readOnly":true,
            "title":"Indirectly managed hosts",
            "type":"integer"
        },
        "license_capacity":{
            "description":"'License capacity as max. number of unique hosts",
            "readOnly":true,
            "title":"License capacity",
            "type":"integer"
        },
        "license_consumed":{
            "description":"How many unique hosts are consumed from the license",
            "readOnly":true,
            "title":"License consumed",
            "type":"integer"
        }
    },
    "type":"object"
}

Back to Top