Apache CloudStack v4.4.1 User API Reference


Lists affinity 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 the affinity group by the id providedfalse
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
namelists affinity groups by namefalse
typelists affinity groups by typefalse
virtualmachineidlists affinity groups by virtual machine idfalse

Response Tags

Response NameDescription
idthe ID of the affinity group
accountthe account owning the affinity group
descriptionthe description of the affinity group
domainthe domain name of the affinity group
domainidthe domain ID of the affinity group
namethe name of the affinity group
typethe type of the affinity group
virtualmachineIdsvirtual machine Ids associated with this affinity group