GET /api/system/metrics/{metric}

Owned by Technische Redaktion
Last updated: Mar 03, 2023
3 min read
As of Version2023 Spring

Request Method

GET

Response Format

JSON

Required Permission

available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched.

>> AUTHENTICATION Service

Description

Retrieve the specified metric for all tenants.

>> Metrics

Following values are available for the metric path parameter:

  • storage - The endpoint retrieves the dynamically calculated binary storage individually used by  tenants.

Request Example

/api/system/metrics/storage

Result Example


{
  "objects": [
    {
      "properties": {
        "system:tenant": {
          "value": "tenant1"
        }
      },
      "options": {
        "storageUsed": {
          "humanReadable": "121 MB",
          "value": 127508469
        }
      }
    },
    {
      "properties": {
        "system:tenant": {
          "value": "yuuvistest"
        }
      },
      "options": {
        "storageUsed": {
          "humanReadable": "12 GB",
          "value": 13518072956
        }
      }
    },
    {
      "properties": {
        "system:tenant": {
          "value": "testyuuvis"
        }
      },
      "options": {
        "storageUsed": {
          "humanReadable": "164 MB",
          "value": 172295598
        }
      }
    },
    {
      "properties": {
        "system:tenant": {
          "value": "exampletenant"
        }
      },
      "options": {
        "storageUsed": {
          "humanReadable": "456 KB",
          "value": 467485
        }
      }
    },
    {
      "properties": {
        "system:tenant": {
          "value": "mytenant"
        }
      },
      "options": {
        "storageUsed": {
          "humanReadable": "0 bytes",
          "value": 0
        }
      }
    }
  ],
  "numItems": 5,
  "hasMoreItems": false,
  "totalNumItems": 5
}