Zerto Cloud Manager APIs : Cloudconnector APIs : List All Cloud Connectors of a ZORG / Get Information About a Single Cloud Connector
  
List All Cloud Connectors of a ZORG / Get Information About a Single Cloud Connector
The response for both APIs is identical.
Display a list of cloud connectors attached to a ZORG using the following API.
 
Method
URL
GET
https://zcm_ip:port/v1/cloudconnectors?zorgidentifier={zorgidentifier}
 
Display information for a single cloud connector using the following API.
 
Method
URL
GET
https://zcm_ip:port/v1/cloudconnectors/{CloudConnectorIdentifier}
 
Where:
 
zcm_ip
The IP address of the Zerto Cloud Manager where the API is run.
port
The port to access the Zerto Cloud Manager. The default port is 9989.
cloudconnectoridentifier
Internal identifier for the cloud connector.
zorgidentifier
The identifier of the ZORG used for the VPG.
 
Request
Response
Request
The request body is empty.
Response
The following is an example response Json body of a list of all cloud connectors of a ZORG and, without the array statement, of a single cloud connector.
 
[{
  "CloudConnectorIdentifier": "6605279f-7967-43c3-a747-ddb58e8343d5",
  "CloudNetworkData": {
    "CloudNetwork": "VM Network",
    "CloudNetworkAddress": "15.15.15.8",
    "CloudNetworkSubnetMask": "255.255.255.0",
    "CloudStaticRouteGroup": "N/A"
  },
  "CustomerName": "CloudServiceProvider-1-VC_TenantA",
  "CustomerNetworkData": {
    "CustomerNetwork": "VM Network",
    "CustomerNetworkAddress": "172.20.184.250",
    "CustomerNetworkDefaultGatway": "172.20.184.254",
    "CustomerNetworkSubnetMask": "255.255.255.0"
  },
  "DatastoreName": "BK3BL2-07_COMP_DS",
  "GhostStatus": False
  "HostName": "172.20.184.5",
  "Link": {
    "href": "https://172.20.184.51:9989/v1/cloudconnectors/6605279f-7967-43c3-a747-ddb58e8343d",
    "identifier": "6605279f-7967-43c3-a747-ddb58e8343d5",
    "rel":"null",
    "type": "CloudConnectorApi"
  },
  "Progress": 0,
  "SiteName": "CloudServiceProvider-1-VC",
  "SitePaired": true
  "Status": "Installed",
  "VmName": "Zerto-ZCC-TenantA-1"
}]
 
Parameter
type
Description
CloudConnectorIdentifier
String
Internal identifier for the cloud network.
CloudNetworkData
 
Cloud network information.
CloudNetwork
String
Cloud network name.
CloudNetworkAddress
String
Cloud network IP address.
CloudNetworkSubnetMask
String
Cloud network subnet mask.
CloudStaticRouteGroup
String
Cloud network static route group name.
CustomerName
String
Customer name.
CustomerNetworkData
 
 
CloudNetwork
String
 
CloudNetworkAddress
String
 
CloudNetworkSubnetMask
String
 
CloudStaticRouteGroup
String
 
DatastoreName
String
 
GhostStatus
Boolean
Boolean value indicating ghost error.
HostName
String
Host name.
Link
 
Link information for the URL.
href
String
URL for API call(s) to the resource.
identifier
String
The unique internal identifier of the resource.
rel
String
Next path level for the API relative to the current path.
type
String
API interface type.
Progress
Number
Integer value between 1 - 100 indicating percentage completion of operation.
SiteName
String
Site name.
SitePaired
Boolean
Indicates whether the site is paired.
Status
String
Possible values:
Orphaned: One of the specified networks is invalid or inaccessible.
Installed: The ZCC was installed.
Installing: The ZCC is installing.
Removing: The ZCC is being removed.
VmName
String
Virtual machine name.
 
Back to Cloudconnector APIs
Back to List of APIs.
See also Starting and Ending a Session, on page 4.