Skip to main content
API Explorer|API Explorer
Platform Operations/Platforms
GETPlatformSince 1.0SynchronousAuth Required

GetSyncOverview

Get a per-resource-type overview of synced counts for a platform.

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the platform to get the sync overview for

Responses

200 OK

On success, this API returns the following response structure.

  • platformUuidString

    UUID of the platform this overview belongs to

    Example: plat-abc123-def456

  • platformNameString

    Human-readable name of the platform

    Example: prod-zstack-01

  • productTypeString

    Product type of the platform

    Example: zstack

  • platformIpString

    IP address of the platform

    Example: 192.168.1.100

  • totalResourcesString

    Total number of resources synced across all types

    Example: 512

  • lastSyncTimeString

    Last sync time

    Example: 2026-01-15T08:00:00Z

  • jobStateString

    Current state of the sync job (running, idle, error)

    Example: idle

  • detailsList

    Per-resource-type breakdown of synced counts

    Example: (nested array)

    • resourceTypeString

      Type of resource being tracked

      Example: vm

    • syncedCountString

      Number of resources synced for this resource type

      Example: 128

Endpoint

GET/api/v1/platforms/syncs/{uuid}/overview

/api/v1/platforms/syncs/{uuid}/overview

Operation ID

GetSyncOverview

Permalink

Request Example

curl -X GET '{host}/api/v1/platforms/syncs/{uuid}/overview' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "platformUuid": "plat-abc123-def456",
  "platformName": "prod-zstack-01",
  "productType": "zstack",
  "platformIp": "192.168.1.100",
  "totalResources": 512,
  "lastSyncTime": "example",
  "jobState": "idle",
  "details": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history