Get Information About a Resource

Request

Response

 
METHODURL
GET

https://zcm_ip:port/v1/resources/{resourceIdentifier}

 

Where:

 
zcm_ipThe IP address of the Zerto Cloud Manager where the API is run.
portThe port to access the Zerto Cloud Manager. The default port is 9989.
resourceIdentifierInternal identifier of a resource.
 

Request

The request body is empty.

Response

The following is an example response Json body.

[{
  "CloudSiteName": "London",
  "Identifier": "datastore-11.621941a3-d220-4fd3-92de-3f9d7472b9e4",
  "Link": {
    "href": "https://10.10.1.115:9672/v1/resources/datastore-11.621941a3-d220-4fd3-92de-3f9d74",
    "identifier": "datastore-11.621941a3-d220-4fd3-92de-3f9d7472b9e4",
    "rel": null,
    "type": "ResourceApi",
  "MaskedName": "datastore1",
  "MaxStorageGB": 0,
  "MaxVms": 0,
  "OwnerVCDOrgName": null,
  "ResourceName": "datastore1",
  "SiteIdentifier": "eda3d8a4-5c2b-481a-9144-23c59375dd6b",
  "Type": "VCenterDatastore",
  "VirtualizationSite": "Hypervisor"
}]

RESPONSETYPE DESCRIPTION
CloudSiteNameStringCloud site name.
IdentifierStringInternal identifier of resource.
Link Link information for the URL.

href

StringURL for API call(s) to the resource.

identifier

StringThe unique internal identifier of the resource.

rel

StringNext path level for the API relative to the current path.
typeStringAPI interface type.
MaskedNameStringAlternate name of the resource.
MaxStorageGBNumberMaximum size in Gigabytes.
MaxVmsNumberMaximum number of VMs.
OwnerVCDOrgNameStringName of the owner of the VCD organization.
ResourceNameStringName of the resource.
SiteIdentifierStringInternal site identifier.
TypeStringResource type
VirtualizationSiteStringType of resource origin.
 

Back to List of APIs

See also Starting and Ending a Session