Apache CloudStack 4.20.0.0 Root Admin API Reference

listTags

List resource tag(s)

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
customerlist by customer namefalse
domainidlist only resources belonging to the domain specifiedfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keylist by keyfalse
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 false. Resources dedicated to a project are listed only if using the projectid parameter.false
pagefalse
pagesizefalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
resourceidlist by resource idfalse
resourcetypelist by resource typefalse
valuelist by valuefalse

Response Tags

Response NameDescription
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
domainpathpath of the Domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value