Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Query & Overview
POSTMonitoringSince 1.0SynchronousAuth Required

RecordCapacitySnapshot

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • resourceTypeStringRequired

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

    Example: vm

  • totalCountIntegerRequired

    Total resource count at snapshot time

    Example: 500

  • activeCountIntegerRequired

    Active resource count at snapshot time

    Example: 480

  • usagePercentLongRequired

    Resource usage percentage at snapshot time

    Example: 96

  • tenantIdStringRequired

    Tenant identifier for this snapshot

    Example: tenant-001-xyz

Responses

200 OK

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

Endpoint

POST/api/v1/monitoring/capacity/snapshots

/api/v1/monitoring/capacity/snapshots

Operation ID

RecordCapacitySnapshot

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/capacity/snapshots' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"resourceType":"vm","totalCount":500,"activeCount":480,"usagePercent":96.0,"tenantId":"tenant-001-xyz"}'

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history