Cosmic Admin API Reference

listHAWorkers

Lists all HA workers

Request parameters

Parameter Name	Description	Required
domainid	list only resources belonging to the domain specified	false
id	the ID of the HA worker	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
keyword	List by keyword	false
listall	If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false	false
page		false
pagesize		false

Response Tags

Response Name	Description
id	ID of the HA worker
created	Date when the HA worker was created
domainid	ID of the domain this HA worker belongs too
domainname	Name of the domain this HA worker belongs too
hypervisor	Hypervisor this HA worker belongs too
managementservername	Name of the management server this HA worker belongs too
state	Previous state of the virtual machine this HA worker belongs too
step	Current step the HA worker is at
taken	Date of the last step this HA worker has taken
type	Type of the HA worker
virtualmachineid	ID of the virtual machine this HA worker belongs too
virtualmachinename	Name of the virtual machine this HA worker belongs too
virtualmachinestate	State of the virtual machine this HA worker belongs too