stats

Get statistics of the cluster and servers.

get /stats

Get a graph by name.

Arguments
  • graphoptionalstring

    The graph to query.

  • startTimeoptionalinteger

    Start time of the graph. Either an absolute UNIX timestamp in seconds or a negative value in seconds for x seconds ago.

  • endTimeoptionalinteger

    End time of the graph, default = 0. Either an absolute UNIX timestamp in seconds or a negative value in seconds for x seconds ago.

  • maxDataPointsoptionalinteger

    Maximum number of data points to return to thin out graphs over long time ranges. Default = 500

Definition
get /stats
Attributes
  • namestring

    -

  • axis1object

    -

    • unitstring

      [IOPS, BYTES_PER_SECOND, BITS_PER_SECOND, OBJECTS_PER_SECOND, OBJECTS, BYTES, SECONDS, MICROSECONDS, PERCENT, COUNT, NONE]

    • graphsarray

      -

      • datapointsarray

        -

        • vnumber

          Value, see unit property of the axis.

        • tinteger

          Unix timestamp in seconds.

      • namestring

        -

      • serverIdinteger

        id of the server this plot belongs to.

  • axis2object

    -

    • unitstring

      [IOPS, BYTES_PER_SECOND, BITS_PER_SECOND, OBJECTS_PER_SECOND, OBJECTS, BYTES, SECONDS, MICROSECONDS, PERCENT, COUNT, NONE]

    • graphsarray

      -

      • datapointsarray

        -

        • vnumber

          Value, see unit property of the axis.

        • tinteger

          Unix timestamp in seconds.

      • namestring

        -

      • serverIdinteger

        id of the server this plot belongs to.

Example response
{ "name": "string", "axis1": { "unit": "IOPS", "graphs": [ { "datapoints": [ { "v": , "t": 0 } ], "name": "string", "serverId": 0 } ] }, "axis2": { "unit": "IOPS", "graphs": [ { "datapoints": [ { "v": , "t": 0 } ], "name": "string", "serverId": 0 } ] } }

get /stats/server-names

Get available server names for statistics.

Arguments
  • No arguments...

Definition
get /stats/server-names
Attributes
  • hostnamestring

    The hostname

  • idinteger

    Use this id as template parameter.

Example response
[ { "hostname": "string", "id": 0 } ]

get /stats/pool-names

Get available Ceph pools for statistics.

Arguments
  • No arguments...

Definition
get /stats/pool-names
Attributes
  • displayNamestring

    Name for users

  • queryNamestring

    Name for the template-pool-name query parameter

  • descriptionstring

    Description of the pool

  • quotaBytesinteger

    Data quota of the pool if configured

  • quotaObjectsinteger

    Object quota of the pool if configured

Example response
[ { "displayName": "string", "queryName": "string", "description": "string", "quotaBytes": 0, "quotaObjects": 0 } ]

get /stats/s3-bucket-names

Get available S3 buckets for statistics.

Arguments
  • No arguments...

Definition
get /stats/s3-bucket-names
Attributes
  • displayNamestring

    Name for users

  • queryNamestring

    Name for the template-s3-bucket-name query parameter

  • quotaBytesinteger

    Data quota of the bucket if configured

  • quotaObjectsinteger

    Object quota of the bucket if configured

Example response
[ { "displayName": "string", "queryName": "string", "quotaBytes": 0, "quotaObjects": 0 } ]

get /stats/s3-user-names

Get available S3 users for statistics.

Arguments
  • No arguments...

Definition
get /stats/s3-user-names
Attributes
  • displayNamestring

    Name for users

  • queryNamestring

    Name for the template-s3-user-name query parameter

  • quotaBytesinteger

    Data quota of the user if configured

  • quotaObjectsinteger

    Object quota of the user if configured

Example response
[ { "displayName": "string", "queryName": "string", "quotaBytes": 0, "quotaObjects": 0 } ]

get /stats/cephfs-monitored-dirs

Get CephFS directories that are monitored for statistics.

Arguments
  • No arguments...

Definition
get /stats/cephfs-monitored-dirs
Attributes
  • displayNamestring

    Name for users

  • queryNamestring

    Name for the template-cephfs-dir-name query parameter

  • quotaBytesinteger

    Maximum number of bytes.

  • quotaFilesinteger

    Maximum number of files.

Example response
[ { "displayName": "string", "queryName": "string", "quotaBytes": 0, "quotaFiles": 0 } ]

post /stats/cephfs-monitored-dirs

Add directories to the set of monitored cephfs dirs.

Arguments
  • bodyoptional

    Additional CephFS directories to monitor continuously.

Definition
post /stats/cephfs-monitored-dirs

put /stats/cephfs-monitored-dirs

Set the CephFS directories that are monitored for statistics.

Arguments
  • bodyoptional

    CephFS directories to monitor continuously.

Definition
put /stats/cephfs-monitored-dirs

delete /stats/cephfs-monitored-dirs

Remove directories from the set of monitored cephfs dirs.

Arguments
  • bodyoptional

    CephFS directories to stop monitoring.

Definition
delete /stats/cephfs-monitored-dirs