Apache CloudStack 4.19.0.0 Root Admin API Reference

listBuckets

Lists all Buckets.

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
domainidlist only resources belonging to the domain specifiedfalse
idthe ID of the bucketfalse
idsthe IDs of the Buckets, mutually exclusive with 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 false. Resources dedicated to a project are listed only if using the projectid parameter.false
namethe name of the bucketfalse
objectstorageidthe ID of the object storage pool, available to ROOT admin onlyfalse
pagefalse
pagesizefalse
projectidlist objects by project; if projectid=-1 lists All VMsfalse
tagsList resources by tags (key/value pairs)false

Response Tags

Response NameDescription
idID of the Bucket
accesskeyBucket Access Key
accountthe account associated with the Bucket
createdthe date the Bucket was created
domainthe domain associated with the bucket
domainidthe ID of the domain associated with the bucket
encryptionBucket Encryption
namename of the Bucket
objectlockingBucket Object Locking
objectstorageidid of the object storage hosting the Bucket; returned to admin user only
objectstoreName of the object storage hosting the Bucket; returned to admin user only
policyBucket Access Policy
projectthe project name of the bucket
projectidthe project id of the bucket
providerObject storage provider
quotaBucket Quota in GB
sizeTotal size of objects in Bucket
stateState of the Bucket
urlBucket URL
usersecretkeyBucket Secret Key
versioningBucket Versioning