| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" href="../includes/main.css" type="text/css"> |
| <link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> |
| <title>Apache CloudStack | The Power Behind Your Cloud</title> |
| </head> |
| <body> |
| <div id="insidetopbg"> |
| <div id="inside_wrapper"> |
| <div class="uppermenu_panel"> |
| <div class="uppermenu_box"></div> |
| </div> |
| <div id="main_controller"> |
| <div id="inside_header"> |
| <div class="header_top"> |
| <a class="cloud_logo" href="http://cloudstack.org"></a> |
| <div class="mainemenu_panel"></div> |
| </div> |
| </div> |
| <div id="main_content"> |
| <div class="inside_apileftpanel"> |
| <div class="inside_contentpanel" style="width:930px;"> |
| <div class="api_titlebox"> |
| <div class="api_titlebox_left"> |
| <span> |
| Apache CloudStack 4.21.0.0 Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>listBuckets</h1> |
| <p>Lists all Buckets.</p> |
| </div> |
| <div class="api_titlebox_right"> |
| <a class="api_backbutton" href="../index.html"></a> |
| </div> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Request parameters</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>account</i></td><td style="width:500px;"><i>list resources by account. Must be used with the domainId parameter.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>list only resources belonging to the domain specified</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>id</i></td><td style="width:500px;"><i>the ID of the bucket</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>ids</i></td><td style="width:500px;"><i>the IDs of the Buckets, mutually exclusive with id</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>isrecursive</i></td><td style="width:500px;"><i>defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>listall</i></td><td style="width:500px;"><i>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.</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>name</i></td><td style="width:500px;"><i>the name of the bucket</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>objectstorageid</i></td><td style="width:500px;"><i>the ID of the object storage pool, available to ROOT admin only</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>projectid</i></td><td style="width:500px;"><i>list objects by project; if projectid=-1 lists All VMs</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>tags</i></td><td style="width:500px;"><i>List resources by tags (key/value pairs)</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| </table> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Response Tags</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>id</strong></td><td style="width:500px;">ID of the Bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>accesskey</strong></td><td style="width:500px;">Bucket Access Key</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account associated with the Bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date the Bucket was created</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain associated with the bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the ID of the domain associated with the bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domainpath</strong></td><td style="width:500px;">path of the domain to which the bucket belongs</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>encryption</strong></td><td style="width:500px;">Bucket Encryption</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>name</strong></td><td style="width:500px;">name of the Bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>objectlocking</strong></td><td style="width:500px;">Bucket Object Locking</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>objectstorageid</strong></td><td style="width:500px;">id of the object storage hosting the Bucket; returned to admin user only</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>objectstore</strong></td><td style="width:500px;">Name of the object storage hosting the Bucket; returned to admin user only</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>policy</strong></td><td style="width:500px;">Bucket Access Policy</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>project</strong></td><td style="width:500px;">the project name of the bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>projectid</strong></td><td style="width:500px;">the project id of the bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>provider</strong></td><td style="width:500px;">Object storage provider</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>quota</strong></td><td style="width:500px;">Bucket Quota in GiB</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>size</strong></td><td style="width:500px;">Total size of objects in Bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">State of the Bucket</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>url</strong></td><td style="width:500px;">Bucket URL</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>usersecretkey</strong></td><td style="width:500px;">Bucket Secret Key</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>versioning</strong></td><td style="width:500px;">Bucket Versioning</td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="comments_thread"> |
| <script src="https://comments.apache.org/show_comments.lua?site=test" async="true"></script> |
| <noscript> |
| <iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin"></iframe> |
| </noscript> |
| </div> |
| <div id="footer_maincontroller"> |
| <p> |
| Copyright © 2015 The Apache Software Foundation, Licensed under the |
| <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a> |
| <br> |
| Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
