Skip to content

API: Usage

Generated from the API's OpenAPI schema. Paths are relative to https://cloud.tebibhost.com. Authentication, errors, pagination and idempotency are on the API overview.

GET/api/v1/projects/{project_id}/usage

Project Usage (projectUsage)

IAM action: metering:DescribeUsage

ParameterInTypeDescription
project_id requiredpathstring
startquerystring (date-time) (nullable)Inclusive; default: end minus a default range
endquerystring (date-time) (nullable)Exclusive; default: now
granularityquery"minute" | "hour" | "day"minute, hour or day
meterquerystring (nullable)A meter name; '*' matches any characters
resource_idquerystring (nullable)
group_byquery"meter" | "resource"One series per meter or per resource

Responses

  • 200 OK (UsageOut)
  • 400 Invalid request (ErrorOut)
  • 401 Not authenticated (ErrorOut)
  • 403 Access denied: the error names the action and the resource (ErrorOut)
  • 404 Not found (also: the resource belongs to another organization) (ErrorOut)
  • 409 Conflict or quota exceeded (ErrorOut)
  • 422 Idempotency key reused for a different request (ErrorOut)
  • 429 Rate limited (ErrorOut)
Fields of UsageOut
FieldTypeDescription
endstring (date-time)
granularity"minute" | "hour" | "day"
metered_untilstring (date-time) (nullable)
project_idstring
seriesarray of UsageSeries
startstring (date-time)