Apache CloudStack v4.5.0 User API Reference


Lists vm groups

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idlist instance groups by IDfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
namelist instance groups by namefalse
projectidlist objects by projectfalse

Response Tags

Response NameDescription
idthe id of the instance group
accountthe account owning the instance group
createdtime and date the instance group was created
domainthe domain name of the instance group
domainidthe domain ID of the instance group
namethe name of the instance group
projectthe project name of the group
projectidthe project id of the group