Apache CloudStack 4.20.0.0 Root Admin API Reference

listResourceDetails

List resource detail(s)

Request parameters

Parameter Name	Description	Required
resourcetype	list by resource type	true
account	list resources by account. Must be used with the domainId parameter.	false
domainid	list only resources belonging to the domain specified	false
fordisplay	if set to true, only details marked with display=true, are returned. False by default	false
isrecursive	defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.	false
key	list by key	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. Resources dedicated to a project are listed only if using the projectid parameter.	false
page		false
pagesize		false
projectid	list objects by project; if projectid=-1 lists All VMs	false
resourceid	list by resource id	false
value	list by key, value. Needs to be passed only along with key	false

Response Tags

Response Name	Description
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
domainpath	path of the Domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.