object-storage-2

List service metrics series

Returns Object Storage instance metrics series by a given {service_uuid}.

get/1.3/object-storage-2/{service-uuid}/metrics/series

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/object-storage-2/{service-uuid}/metrics/series
  • Auth: HTTP bearer

Path parameters

service-uuidstring uuid required

The unique identifier for the service.

Example:01234567-89ab-cdef-0123-456789abcdef

Service UUID

Query parameters

fromstring date-time

Schema for a query parameter specifying a timestamp.

Example:2024-01-01T00:00:00Z

Beginning of the time range for which to return metrics.

tostring date-time

Schema for a query parameter specifying a timestamp.

Example:2024-01-01T00:00:00Z

End of the time range for which to return metrics.

intervalstring

Schema for a query parameter specifying the time interval.

Example:1h

Metrics aggregation interval.

sort'created_at' | '-created_at' | 'service_name' | '-service_name' | 'operational_state' | '-operational_state' | 'region_name' | '-region_name'

Schema for a query parameter specifying the sort field and direction. Prefix with '-' for descending order.

Example:-created_at

Order of returned results.

limitinteger

Schema for a query parameter specifying the maximum number of entries to return (limit).

Example:10

Number of entries to receive at most.

offsetinteger

Schema for a query parameter specifying the offset for pagination.

Offset for retrieved results.

Response

OK

bytes_createdinteger
bytes_deletedinteger
bytes_receivedinteger
bytes_totalinteger
bytes_transmittedinteger
end_atstring date-time
objects_createdinteger
objects_deletedinteger
objects_totalinteger
start_atstring date-time

Example response

[
  {
    "bytes_created": 530000,
    "bytes_deleted": 244000,
    "bytes_received": 530000,
    "bytes_total": 7502000,
    "bytes_transmitted": 0,
    "end_at": "2023-10-31T12:00:00Z",
    "objects_created": 79,
    "objects_deleted": 40,
    "objects_total": 1237,
    "start_at": "2023-10-31T11:00:00Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.