Get usage information
Learn how to get bandwidth usage information.
Capabilities
`usage=read`Syntax
GET /admin/usage?format=json HTTP/1.1
Host: FULLY_QUALIFIED_DOMAIN_NAMERequest Parameters
uid
- Description
-
The user for which the information is requested.
- Type
-
String
- Required
-
Yes
start
- Description
-
The date, and optionally, the time of when the data request started. For example,
2012-09-25 16:00:00. - Type
-
String
- Required
-
No
end
- Description
-
The date, and optionally, the time of when the data request ended. For example,
2012-09-25 16:00:00. - Type
-
String
- Required
-
No
show-entries
- Description
-
Specifies whether data entries should be returned.
- Type
-
Boolean
- Required
-
No
show-summary
- Description
-
Specifies whether data entries should be returned.
- Type
-
Boolean
- Required
-
No
Response Entities
usage
- Description
-
A container for the usage information.
- Type
-
Container
entries
- Description
-
A container for the usage entries information.
- Type
-
Container
user
- Description
-
A container for the user data information.
- Type
-
Container
owner
- Description
-
The name of the user that owns the buckets.
- Type
-
String
bucket
- Description
-
The bucket name.
- Type
-
String
time
- Description
-
Time lower bound for which data is being specified that is rounded to the beginning of the first relevant hour.
- Type
-
String
epoch
- Description
-
The time specified in seconds since
1/1/1970. - Type
-
String
categories
- Description
-
A container for stats categories.
- Type
-
Container
entry
- Description
-
A container for stats entry.
- Type
-
Container
category
- Description
-
Name of request category for which the stats are provided.
- Type
-
String
bytes_sent
- Description
-
Number of bytes sent by the Ceph Object Gateway.
- Type
-
Integer
bytes_received
- Description
-
Number of bytes received by the Ceph Object Gateway.
- Type
-
Integer
ops
- Description
-
Number of operations.
- Type
-
Integer
successful_ops
- Description
-
Number of successful operations.
- Type
-
Integer
summary
- Description
-
Number of successful operations.
- Type
-
Container
total
- Description
-
A container for stats summary aggregated total.
- Type
-
Container
If successful, the response contains the requested information.