stats

Get statistics of the cluster and servers.

GET /stats

Parameters

graph
string
query
optional
The graph to query.
startTime
integer
query
optional
Start time of the graph. Either an absolute UNIX timestamp in seconds or a negative value in seconds for x seconds ago.
endTime
integer
query
optional
End time of the graph, default = 0. Either an absolute UNIX timestamp in seconds or a negative value in seconds for x seconds ago.
maxDataPoints
integer
query
optional
Maximum 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?graph=string&startTime=0&endTime=0&maxDataPoints=0
                

Response 200

name
string
optional
Suggested title for the graph
description
string
optional
Suggested description for the graph
axis1
object
optional
Collection of plots with the same unit
axis2
object
optional
Collection of plots with the same unit

Example response

{
  "name": "string",
  "description": "string",
  "axis1": {
    "unit": "IOPS",
    "graphs": [
      {
        "datapoints": [
          {
            "v": 0,
            "t": 0
          }
        ],
        "name": "string",
        "tags": {}
      }
    ]
  },
  "axis2": {
    "unit": "IOPS",
    "graphs": [
      {
        "datapoints": [
          {
            "v": 0,
            "t": 0
          }
        ],
        "name": "string",
        "tags": {}
      }
    ]
  }
}
                  

GET /stats/server-names

Parameters

No parameters...

Endpoint

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

Response 200

hostname
string
optional
The hostname
id
integer
optional
Use this id as template parameter.

Example response

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

GET /stats/pool-names

Parameters

No parameters...

Endpoint

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

Response 200

displayName
string
optional
Name for users
queryName
string
optional
Name for the template-pool-name query parameter
description
string
optional
Description of the pool
quotaBytes
integer
optional
Data quota of the pool if configured
quotaObjects
integer
optional
Object quota of the pool if configured

Example response

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

GET /stats/s3-bucket-names

Parameters

No parameters...

Endpoint

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

Response 200

displayName
string
optional
Name for users
queryName
string
optional
Name for the template-s3-bucket-name query parameter
quotaBytes
integer
optional
Data quota of the bucket if configured
quotaObjects
integer
optional
Object quota of the bucket if configured

Example response

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

GET /stats/s3-user-names

Parameters

No parameters...

Endpoint

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

Response 200

displayName
string
optional
Name for users
queryName
string
optional
Name for the template-s3-user-name query parameter

Example response

[
  {
    "displayName": "string",
    "queryName": "string"
  }
]
                  

GET /stats/cephfs-monitored-dirs

Parameters

No parameters...

Endpoint

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

Response 200

displayName
string
optional
Name for users
queryName
string
optional
Name for the template-cephfs-dir-name query parameter
quotaBytes
integer
optional
Maximum number of bytes.
quotaFiles
integer
optional
Maximum number of files.

Example response

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

POST /stats/cephfs-monitored-dirs

Parameters

body
body
optional
Additional 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

Parameters

body
body
optional
CephFS 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

Parameters

body
body
optional
CephFS directories to stop monitoring.

Endpoint

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

Example body

[
  "string"
]