Zerto APIs : Datastores API : Format
  
Format
Json, XML
Request Body Using Json Format
The request body is empty.
Response In Json Format
The following is an example response Json body for https://zvm_ip:port/v1/datastores.
[
 {
  "Config": {
    "Devices": [
     "string content"
    ]
    "OwningDatastoreCluster": null,
    "Type": null
  }
  "DatastoreIdentifier": "string content",
  "DatastoreName": "string content",
  "Health": {
    "Alerts": [],
    "Status": "Normal"
  }
  "Stats": {
    "AvailabilityStatus": "Normal",
    "NumIncomingVMs": 7,
    "NumOutgoingVMs": 0,
    "NumVRAs": 0,
    "Usage": {
           },
     
 "Datastore": {
        "CapacityInBytes": 536870912000,
        "FreeInBytes": 323713236992,
        "ProvisionedInBytes": 386572688763,
        "UsedInBytes": 213157675008
    }
    "Zerto": {
      "Appliances": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Journal": {
        "ProvisionedInBytes": 234995712,
        "UsedInBytes": 325058560
      },
      "Protected": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Recovery": {
        "ProvisionedInBytes": 29360128,
        "UsedInBytes": 10124001280
 "Scratch": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Unknown": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
   }
  ,
 {
[
 {
  "Config": {
    "Devices": [
     "string content"
    ]
    "OwningDatastoreCluster":{
      "DatastoreClusterIdentifier": "string content"
      "DatastoreClusterName": "string content"
    "Type": null
  }
  "DatastoreIdentifier": "string content",
  "DatastoreName": "string content",
  "Health": {
    "Alerts": [],
    "Status": "Normal"
  }
  "Stats": {
    "AvailabilityStatus": "Normal",
    "NumIncomingVMs": 7,
    "NumOutgoingVMs": 0,
    "NumVRAs": 0,
    "Usage": {
      "Datastore": {
        "CapacityInBytes": 536870912000,
        "FreeInBytes": 419582443520,
        "ProvisionedInBytes": 169459472274,
        "UsedInBytes": 117288468480
    }
 "Zerto": {
      "Appliances": {
        "ProvisionedInBytes": 13422821376,,
        "UsedInBytes": 13422821376
      },
      "Journal": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Protected": {
        "ProvisionedInBytes": 15032385536,
        "UsedInBytes": 13422821376
      },
         "Recovery": {
        "ProvisionedInBytes": 0,
        "UsedInBytes":0
      },
      "Scratch": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Unknown": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
   }
  ,
 {
[
 {
  "Config": {
    "Devices": [
     "string content"
    ]
    "OwningDatastoreCluster": null,
    "Type": null
  }
  "DatastoreIdentifier": "string content",
  "DatastoreName": "string content",
  "Health": {
    "Alerts": [],
    "Status": "Normal"
  }
  "Stats": {
    "AvailabilityStatus": "Normal",
    "NumIncomingVMs": 7,
    "NumOutgoingVMs": 0,
    "NumVRAs": 0,
    "Usage": {
      "Datastore": {
        "CapacityInBytes": 536870912,
        "FreeInBytes": 519045120,
        "ProvisionedInBytes": 17825792,
        "UsedInBytes": 17825792
    }
"Zerto": {
      "Appliances": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Journal": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Protected": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Recovery": {
        "ProvisionedInBytes": 0,
        "UsedInBytes":0
          },
      "Scratch": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Unknown": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
   }
  ,
 {
The following is an example response Json body for https://zvm_ip:port/v1/datastores/{datastoreIdentifier}.
[
 {
  "Config": {
    "Devices": [
     "string content"
    ]
    "OwningCluster": null,
    "Type": null
  }
  "DatastoreIdentifier": "string content",
  "DatastoreName": "string content",
  "Health": {
    "Alerts": [],
    "Status": "Normal"
  }
  "Stats": {
    "AvailabilityStatus": "Normal",
    "NumIncomingVMs": 7,
    "NumOutgoingVMs": 0,
    "NumVRAs": 0,
    "Usage": {
      "Datastore": {
        "CapacityInBytes": 536870912000,
        "FreeInBytes": 323713236992,
        "ProvisionedInBytes": 386572688763,
        "UsedInBytes": 213157675008
    }
    "Zerto": {
      "Appliances": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Journal": {
        "ProvisionedInBytes": 234995712,
        "UsedInBytes": 325058560
      },
      "Protected": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Recovery": {
        "ProvisionedInBytes": 29360128,
        "UsedInBytes": 10124001280
      },
      "Scratch": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      },
      "Unknown": {
        "ProvisionedInBytes": 0,
        "UsedInBytes": 0
      }
     }
    }
   }
  ,
 {
 
XML Response Format
For the XML response format, see “Datastores API XML Response Format”, on page 356.
Response Values
Response values for https://zvm_ip:port/v1/datastores and https://zvm_ip:port/v1/datastores/{datastoreIdentifier}.
Parameter
Description
Config
The datastore configuration.
Devices
List of the datastore devices.
OwningDatastoreCluster
DatastoreClusterIdentifier
The identifier of the cluster that the datastore is associated with.
DatastoreClusterName
The name of the cluster that the datastore is associated with.
Type
The type of datastore.
DatastoreIdentifier
The identifier of the datastore.
DatastoreName
The datastore name.
Health
Alerts
The alert status of the datastore.
Status
The status of the datastore. Possible values are:
NotApplicable
Error
Normal
Warning
Stats
AvailabilityStatus
The datastore availability status. Possible values are:
EnteringMaintenance
InMaintenance
Normal
Unavailable
NumIncomingVMs
The number of virtual machines to be recovered using the datastore.
NumOutgoingVMs
The number of virtual machines to be protected using the datastore.
NumVRAs
The number of VRAs using the datastore.
Usage
The amount of space used in relation to the total amount available.
Datastore
CapacityInBytes
The capacity of the datastore, in bytes.
FreeInBytes
The amount of free space of the datastore, in bytes.
ProvisionedInBytes
The amount of provisioned space of the datastore, in bytes.
UsedInBytes
The amount of used space of the datastore, in bytes.
Zerto
Appliances
ProvisionedInBytes
The amount of provisioned space of the appliances’ volumes, in bytes.
UsedInBytes
The amount of used space of the appliances’ volumes, in bytes.
Journal
ProvisionedInBytes
The amount of provisioned space of the journal’s volumes, in bytes.
UsedInBytes
The amount of used space of the journal’s volumes used size in bytes.
Protected
ProvisionedInBytes
The amount of provisioned space of the protected volumes, in bytes.
UsedInBytes
The amount of used space of the protected volumes, in bytes.
Recovery
ProvisionedInBytes
The amount of provisioned space of the recovery volumes, in bytes.
UsedInBytes
The amount of used space of the recovery volumes, in bytes.
Scratch
ProvisionedInBytes
The amount of provisioned space of the scratch volumes, in bytes.
UsedInBytes
The amount of used space of the scratch volumes, in bytes.
Unknown
ProvisionedInBytes
The amount of provisioned space of the unknown volumes, in bytes.
UsedInBytes
The amount of used space of the unknown volumes, in bytes.