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
| Parameter | In | Type | Description |
|---|---|---|---|
project_id required | path | string | |
start | query | string (date-time) (nullable) | Inclusive; default: end minus a default range |
end | query | string (date-time) (nullable) | Exclusive; default: now |
granularity | query | "minute" | "hour" | "day" | minute, hour or day |
meter | query | string (nullable) | A meter name; '*' matches any characters |
resource_id | query | string (nullable) | |
group_by | query | "meter" | "resource" | One series per meter or per resource |
Responses
200OK (UsageOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of UsageOut
| Field | Type | Description |
|---|---|---|
end | string (date-time) | |
granularity | "minute" | "hour" | "day" | |
metered_until | string (date-time) (nullable) | |
project_id | string | |
series | array of UsageSeries | |
start | string (date-time) |