HistoricalUsageResponse

HistoricalUsageResponse
HistoricalUsageResponse

Response object returned in the Get Historical Usage Records API response

JSON Example
{
    "metadata": {
        "metric_id": "<metric ID for vRNI vCPUs Public Cloud>",
        "service_definition_id": "<service definition ID for VMC-AWS>",
        "display_name": "i3en US West 2",
        "unit_of_measure_display_name": "Hosts",
        "charge_attributes": {
            "category": "HOST_USAGE"
        }
    },
    "content": [
        {
            "usage_datetime": "2023-03-25T07:00:00.000Z",
            "commitment": 3,
            "usage": 4,
            "overage": 1,
            "resources": [
                {
                    "resource_id": "res1",
                    "usage_quantity": 10
                }
            ],
            "projects": [
                {
                    "project_id": "proj1",
                    "usage_quantity": 10,
                    "commit_quantity": 5
                }
            ]
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "number_of_elements": 0,
    "pageable": {
        "offset": 0,
        "page_number": 0,
        "page_size": 0,
        "paged": false,
        "sort": {
            "empty": false,
            "sorted": false,
            "unsorted": false
        },
        "unpaged": false
    },
    "size": 0,
    "sort": {
        "empty": false,
        "sorted": false,
        "unsorted": false
    },
    "total_elements": 0,
    "total_pages": 0
}
metadata
Optional

metadata

content
Optional

List of Historical Usage Record items

boolean
empty
Optional

True if no elements in the system match given request

boolean
first
Optional

True if this is the first page of items

boolean
last
Optional

True if this is the last page of MetricUsage items

number
Optional

number

integer As int32 As int32
number_of_elements
Optional

The number of HistoricalUsageRecord items in the response for given request after pagination operations. If number of items is less then size, it will be equal to total_elements.

pageable
Optional

pageable

integer As int32 As int32
size
Optional

Max number of HistoricalUsageRecord items in the response (controlled by query parameter size or system default)

sort
Optional

sort

integer As int64 As int64
total_elements
Optional

The total number of HistoricalUsageRecord items in the system for given request.

total_pages
Optional

total_pages