usage

Returns metered usage for the caller's tenant over the requested period. Requires the usage:read or machine:read scope.

get/v1/usage

Request

Response

Usage report

consumedFromstring

Start of the period the consumed metrics actually cover.

totalUptimeSeconds and machineCount are computed over the requested from..to. The four consumed dimensions cannot be: they come from the tenant's running per-billing-period counters — the same numbers billing charges on — and no per-window consumed history exists to recompute them from. (Deriving them from the window instead reported PROVISIONED figures that ran 177x the actual bill.)

So for any window other than the current billing period this differs from from, rather than leaving the response looking as though every number shared one time base.

consumedTostring

End of the period the consumed metrics actually cover. See consumedFrom.

cpuHoursnumber double required

The four metered-and-priced dimensions, over consumedFrom..consumedTo — NOT over from..to. Exec is intentionally absent: it is metered for the event timeline but priced at $0, so surfacing it as "usage" here would imply a charge that never happens.

diskGbHoursnumber double required
egressGbnumber double required
fromstring required
machineCountinteger required
memoryGbHoursnumber double required
tenantIdstring required
tostring required
totalUptimeSecondsinteger required

Changes

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status