Skip to main content

Get API Usage

GET 

/storage/buckets/:bucketName/usage/api

Returns the detail on API usage on a bucket of a particular time period, group by method category.

Request

Path Parameters

    bucketName stringrequired

    The name of the bucket

Query Parameters

    filter[start_time] date-timerequired

    The start time of the period to filter the usage (ISO microsecond format)

    Examples:

    Example: 2020-01-01T00:00:00.000Z

    filter[end_time] date-timerequired

    The end time of the period to filter the usage (ISO microsecond format)

    Examples:

    Example: 2020-01-01T00:00:00.000Z

Responses

200: Bucket Usage

Schema

    data

    object[]

  • Array [

  • categories

    object[]

  • Array [

  • bytes_sent integer

    The number of bytes sent

    bytes_received integer

    The number of bytes received

    ops integer

    The number of operations

    successful_ops integer

    The number of successful operations

    category string

    Possible values: [list_bucket, list_buckets, get-bucket_location, create_bucket, stat_bucket, get_bucket_versioning, set_bucket_versioning, get_obj, put_obj, delete_obj]

    The category of the bucket operation

  • ]

  • total

    object

    bytes_sent integer

    The number of bytes sent

    bytes_received integer

    The number of bytes received

    ops integer

    The number of operations

    successful_ops integer

    The number of successful operations

    timestamp date-time

    The time the usage was recorded

  • ]

Loading...