Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleReporting Operations

Get Total Count of Snapshots

  • Purpose: Retrieves the total count of snapshots. Several optional filters (see query parameters) limit the snapshots used to compute the total.
  • Request: GET https://host:port/bridge/snapshot/total/count ? host=(host) & storeId=(storeID) & status=(status)

    • host - (optional) DuraCloud host from which the snapshot(s) originated. This is generally in the form (account).duracloud.org

    • storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot(s) originated.

    • status - (optional) Current status of the snapshot(s)

      • Possible status values:

        • INITIALIZED

        • TRANSFERRING_FROM_DURACLOUD

        • REPLICATING_TO_STORAGE

        • CLEANING_UP

        • SNAPSHOT_COMPLETE

        • FAILED_TO_TRANSFER_FROM_DURACLOUD

        • ERROR

        • CANCELLED

  • Response Body: JSON:

    Code Block
    {
      "totalCount: 1
    }


Get Total Size (bytes) of Snapshots

  • Purpose: Retrieves the total size (bytes) of snapshots. Several optional filters (see query parameters) limit the snapshots used to compute the total.
  • Request: GET https://host:port/bridge/snapshot/total/size ? host=(host) & storeId=(storeID) & status=(status)

    • host - (optional) DuraCloud host from which the snapshot(s) originated. This is generally in the form (account).duracloud.org

    • storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot(s) originated.

    • status - (optional) Current status of the snapshot(s)

      • Possible status values:

        • INITIALIZED

        • TRANSFERRING_FROM_DURACLOUD

        • REPLICATING_TO_STORAGE

        • CLEANING_UP

        • SNAPSHOT_COMPLETE

        • FAILED_TO_TRANSFER_FROM_DURACLOUD

        • ERROR

        • CANCELLED

  • Response Body: JSON:

    Code Block
    {
      "totalSize: 1000
    }


Get Total Files of Snapshots

  • Purpose: Retrieves the total files of snapshots. Several optional filters (see query parameters) limit the snapshots used to compute the total.
  • Request: GET https://host:port/bridge/snapshot/total/files ? host=(host) & storeId=(storeID) & status=(status)

    • host - (optional) DuraCloud host from which the snapshot(s) originated. This is generally in the form (account).duracloud.org

    • storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot(s) originated.

    • status - (optional) Current status of the snapshot(s)

      • Possible status values:

        • INITIALIZED

        • TRANSFERRING_FROM_DURACLOUD

        • REPLICATING_TO_STORAGE

        • CLEANING_UP

        • SNAPSHOT_COMPLETE

        • FAILED_TO_TRANSFER_FROM_DURACLOUD

        • ERROR

        • CANCELLED

  • Response Body: JSON:

    Code Block
    {
      "totalFiles": 100
    }


Get All Totals (count, size, files) of Snapshots

  • Purpose: Retrieves total count, size and files of snapshots. Several optional filters (see query parameters) limit the snapshots used to compute the totals.
  • Request: GET https://host:port/bridge/snapshot/total ? host=(host) & storeId=(storeID) & status=(status)

    • host - (optional) DuraCloud host from which the snapshot(s) originated. This is generally in the form (account).duracloud.org

    • storeId - (optional) Identifier for DuraCloud storage provider from which the snapshot(s) originated.

    • status - (optional) Current status of the snapshot(s)

      • Possible status values:

        • INITIALIZED

        • TRANSFERRING_FROM_DURACLOUD

        • REPLICATING_TO_STORAGE

        • CLEANING_UP

        • SNAPSHOT_COMPLETE

        • FAILED_TO_TRANSFER_FROM_DURACLOUD

        • ERROR

        • CANCELLED

  • Response Body: JSON:

    Code Block
    {
      "totalCount": 1,
      "totalSize": 1000,
      "totalFiles": 100
    }


...