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

RecordCapacitySnapshot

Record a capacity usage snapshot for a resource type at the current time

POST/api/v1/monitoring/capacity/snapshots

Operation ID

RecordCapacitySnapshot

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

application/json

Body Fields

  • resourceType
    StringRequired

    Resource type of this snapshot (e.g. vm, host)

    Example: vm

  • totalCount
    IntegerRequired

    Total resource count at snapshot time

    Example: 500

  • activeCount
    IntegerRequired

    Active resource count at snapshot time

    Example: 480

  • usagePercent
    LongRequired

    Resource usage percentage at snapshot time

    Example: 96

  • tenantId
    StringRequired

    Tenant identifier for this snapshot

    Example: tenant-001-xyz

Responses

200 OK
200 OK

On success, this API returns an empty JSON object {}.