Skip to main content
ZStack
Monitoring & Collection/Monitoring Query & Overview

GetCapacitySummary

Get a consolidated capacity summary across all resource types

GET/api/v1/monitoring/capacity/summary

Operation ID

GetCapacitySummary

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • totalResources
    Integer

    Total number of resources across all types

    Example: 1200

  • byType
    LinkedHashMap

    Breakdown by category type

    Example: (nested object)

    • *
      Object

      Map value

  • overallUsage
    Long

    Overall platform usage ratio

    Example: 0.82