# stats

Get statistics of the cluster and servers.
Set management node URL:

# GET /stats/server-names

Get available server names for statistics.

# Parameters

  • No parameters...

# Endpoint

curl -X GET http://mgmt-node:8080/api/stats/server-names 

# Response 200

  • hostnamestringThe hostname
  • idintegerUse this id as template parameter.

# Example response

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

# GET /stats/pool-names

Get available Ceph pools for statistics.

# Parameters

  • No parameters...

# Endpoint

curl -X GET http://mgmt-node:8080/api/stats/pool-names 

# Response 200

  • displayNamestringName for users
  • queryNamestringName for the template-pool-name query parameter
  • descriptionstringDescription of the pool
  • quotaBytesintegerData quota of the pool if configured
  • quotaObjectsintegerObject 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.

# Parameters

  • No parameters...

# Endpoint

curl -X GET http://mgmt-node:8080/api/stats/s3-bucket-names 

# Response 200

  • displayNamestringName for users
  • queryNamestringName for the template-s3-bucket-name query parameter
  • quotaBytesintegerData quota of the bucket if configured
  • quotaObjectsintegerObject 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.

# Parameters

  • No parameters...

# Endpoint

curl -X GET http://mgmt-node:8080/api/stats/s3-user-names 

# Response 200

  • displayNamestringName for users
  • queryNamestringName for the template-s3-user-name query parameter
  • quotaBytesintegerData quota of the user if configured
  • quotaObjectsintegerObject 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.

# Parameters

  • No parameters...

# Endpoint

curl -X GET http://mgmt-node:8080/api/stats/cephfs-monitored-dirs 

# Response 200

  • displayNamestringName for users
  • queryNamestringName for the template-cephfs-dir-name query parameter
  • quotaBytesintegerMaximum number of bytes.
  • quotaFilesintegerMaximum 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.

# Parameters

  • bodyAdditional CephFS directories to monitor continuously.

# Endpoint

curl -X POST http://mgmt-node:8080/api/stats/cephfs-monitored-dirs 

# Example body

[
  "string"
]

# PUT /stats/cephfs-monitored-dirs

Set the CephFS directories that are monitored for statistics.

# Parameters

  • bodyCephFS directories to monitor continuously.

# Endpoint

curl -X PUT http://mgmt-node:8080/api/stats/cephfs-monitored-dirs 

# Example body

[
  "string"
]

# DELETE /stats/cephfs-monitored-dirs

Remove directories from the set of monitored cephfs dirs.

# Parameters

  • bodyCephFS directories to stop monitoring.

# Endpoint

curl -X DELETE http://mgmt-node:8080/api/stats/cephfs-monitored-dirs 

# Example body

[
  "string"
]

# GET /stats

Get a graph by name.

# Parameters

  • graphstringThe graph to query.
  • startTimeintegerStart time of the graph. Either an absolute UNIX timestamp in seconds or a negative value in seconds for x seconds ago.
  • endTimeintegerEnd time of the graph, default = 0. Either an absolute UNIX timestamp in seconds or a negative value in seconds for x seconds ago.
  • maxDataPointsintegerMaximum number of data points to return to thin out graphs over long time ranges. Default = 500

# Endpoint

curl -X GET http://mgmt-node:8080/api/stats 

# Response 200

  • namestring-
  • axis1object-
    • unitstring[IOPS, BYTES_PER_SECOND, BITS_PER_SECOND, OBJECTS_PER_SECOND, OBJECTS, BYTES, SECONDS, MICROSECONDS, PERCENT, COUNT, NONE]
    • graphsarray-
      • datapointsarray-
        • vnumberValue, see unit property of the axis.
        • tintegerUnix timestamp in seconds.
      • namestring-
      • serverIdintegerid 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-
        • vnumberValue, see unit property of the axis.
        • tintegerUnix timestamp in seconds.
      • namestring-
      • serverIdintegerid 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
      }
    ]
  }
}