Bucket:Get Buckets

Search (SHIFT+S)

Get Buckets

GET /object/bucket

Gets the list of buckets for the specified namespace. If namespace to this bucket creation does not exist then user's namespace is used.

Query Parameters

namespace	Namespace for which buckets should be listed.
marker	reference to last object returned.
limit	number of objects requested in current fetch.
name	Case sensitive prefix of the Bucket name with a wild card() Ex : any_prefix_string

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
SYSTEM_MONITOR

Response Body

List of buckets associated with the given namespace.

Field	Description	Type	Notes
object_buckets
object_bucket			0-* Elements
name	Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier.	String
id	Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time.	URI	Valid Values: urn:storageos:resource-type:UUID:
link	Hyperlink to the details for this resource
created	Bucket creation time	String
softquota	Bucket soft quota	String
fs_access_enabled	Bucket "file system access enabled" status	Boolean
locked	"Locked" status of a bucket	Boolean
vpool	Replication group id	String
namespace	Namespace	String
owner	Bucket owner	String
is_stale_allowed	Bucket isStaleAllowed flag	Boolean
is_object_lock_with_ado_allowed	If true Object Lock and ADO can be enabled together. See the Admin Guide for more information.	Boolean
is_tso_read_only	Bucket isStaleAllowed flag	Boolean
is_object_lock_enabled	Bucket isObjectLockEnabled flag	Boolean
default_object_lock_retention_mode	Default object lock retention mode	String
default_object_lock_retention_years	Default object lock retention years	Integer
default_object_lock_retention_days	Default object lock retention days	Integer
is_encryption_enabled	D@RE Bucket isEncryptionEnabled flag	String
default_retention	Default bucket retention	Long
block_size	Block size in GB	Long
auto_commit_period	auto-commit interval	Long
notification_size	Notification size in GB	Long
api_type	API type	String
TagSet	Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
Tag			0-* Elements
Key	The key of a tag	String
Value	The value of a tag	String
retention	Default retention value for the bucket.	Long
default_group_file_read_permission	Flag indicating the Read permission for default group	Boolean
default_group_file_write_permission	Flag indicating the file write permission for default group	Boolean
default_group_file_execute_permission	Flag indicating the file execute permission for default group	Boolean
default_group_dir_read_permission	Flag indicating the directory read permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects	Boolean
default_group_dir_write_permission	Flag indicating the directory write permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects	Boolean
default_group_dir_execute_permission	Flag indicating the directory execute permission for default group. This is only applicable to folders created within the Filesystem-Enabled bucket. It is not applicable to files/objects	Boolean
default_group	Bucket's default group	String
search_metadata
metadata			0-* Elements
type	The meta key type.	String
name	The meta key name.	String
datatype	The meta key data type.	String
isEnabled	Getter for the enabled flag.	Boolean
mdTokens	Getter for the mdTokens flag.	Boolean
maxKeys	Getter for maxKeys.	Integer
min_max_governor
enforce_retention		Boolean
minimum_fixed_retention		Long
maximum_fixed_retention		Long
minimum_variable_retention		Long
maximum_variable_retention		Long
audit_delete_expiration	Bucket audit delete expiration in seconds	Long
is_empty_bucket_in_progress	Optional. If true the bucket is in the process of being deleted. The bucket will be read only and no changes will be allowed on the bucket until the operation completes.	Boolean
blockSizeInCount		Long
notificationSizeInCount		Long
enableAdvancedMetadataSearch		Boolean
advancedMetadataSearchTargetName		String
advancedMetadataSearchTargetStream		String
MaxBuckets	Number of buckets requested.	Integer
NextMarker	Reference object to retrieve next set of objects.	String
Filter	filter used to get the objects.	String
NextPageLink	link to get the next page.	String

Examples

Request

GET https://192.168.0.0:4443/object/bucket HTTP/1.1  

Concept-Type: application/xml 
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object_buckets>
    <object_bucket>
        <name>LockedBucket82440140-c11e-11e4-8580-0050569c6fd7</name>
        <tags/>
        <api_type>S3</api_type>
        <block_size>-1</block_size>
        <owner>wuser1@sanity.local</owner>
        <created>2015-03-02T20:48:15.650Z</created>
        <default_retention>-2</default_retention>
        <fs_access_enabled>false</fs_access_enabled>
        <is_stale_allowed>false</is_stale_allowed>
        <locked>true</locked>
        <search_metadata>
        <search_enabled>true</search_enabled>
            <metadata>
                <datatype>integer</datatype>
                <name>x-amz-meta-custom</name>
                <type>User</type>
            </metadata>
        </search_metadata>
        <namespace>s3</namespace>
        <notification_size>-1</notification_size>
        <vpool>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool>
    </object_bucket>
    <object_bucket>
        <name>standalone-bucket</name>
        <tags/>
        <api_type>S3</api_type>
        <block_size>-1</block_size>
        <owner>wuser1@sanity.local</owner>
        <created>2015-03-02T19:44:29.283Z</created>
        <default_retention>-2</default_retention>
        <fs_access_enabled>false</fs_access_enabled>
        <is_stale_allowed>false</is_stale_allowed>
        <locked>false</locked>
        <search_metadata>
            <metadata>
                <datatype>integer</datatype>
                <name>SomeKey</name>
            </metadata>
            <metadata>
                <datatype>decimal</datatype>
                <name>SomeKey2</name>
            </metadata>
        </search_metadata>
        <namespace>s3</namespace>
        <notification_size>-1</notification_size>
        <vpool>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool>
    </object_bucket>
</object_buckets>

Request

GET https://192.168.0.0:4443/object/bucket.json HTTP/1.1 

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK 
Content-Type: application/json 
{
   "object_bucket":[
      {
         "name":"f4cb8ba2-c11e-11e4-8580-0050569c6fd7",
         "global":null,
         "remote":null,
         "vdc":null,
         "tags":[

         ],
         "namespace":"s3",
         "locked":false,
         "created":"2015-03-02T20:51:28.034Z",
         "vpool":"urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global",
         "fs_access_enabled":false,
         "is_stale_allowed":false,
         "default_retention":-2,
         "block_size":-1,
         "notification_size":-1,
         "owner":"wuser1@sanity.local",
         "api_type":"S3",
         "search_metadata":{
            "search_enabled": true,
               "metadata":[
                  {
                     "datatype": "integer",
                     "name": "x-amz-meta-custom",
                     "type": "User"
                  }
               ]
         }
      },
      {
         "name":"standalone-bucket",
         "global":null,
         "remote":null,
         "vdc":null,
         "tags":[

         ],
         "namespace":"s3",
         "locked":false,
         "created":"2015-03-02T19:44:29.283Z",
         "vpool":"urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global",
         "fs_access_enabled":false,
         "is_stale_allowed":false,
         "default_retention":-2,
         "block_size":-1,
         "notification_size":-1,
         "owner":"wuser1@sanity.local",
         "api_type":"S3",
         "search_metadata":{
            "metadata":[
               {
                  "datatype":"integer",
                  "name":"SomeKey"
               },
               {
                  "datatype":"decimal",
                  "name":"SomeKey2"
               }
            ]
         }
      }
   ]
}

Request

curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/object/bucket

Response

HTTP/1.1 200 OK
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object_buckets>
    <object_bucket>
        <name>LockedBucket82440140-c11e-11e4-8580-0050569c6fd7</name>
        <tags/>
        <api_type>S3</api_type>
        <block_size>-1</block_size>
        <owner>wuser1@sanity.local</owner>
        <created>2015-03-02T20:48:15.650Z</created>
        <default_retention>-2</default_retention>
        <fs_access_enabled>false</fs_access_enabled>
        <is_stale_allowed>false</is_stale_allowed>
        <locked>true</locked>
        <search_metadata>
        <search_enabled>true</search_enabled>
            <metadata>
                <datatype>integer</datatype>
                <name>x-amz-meta-custom</name>
                <type>User</type>
            </metadata>
        </search_metadata>
        <namespace>s3</namespace>
        <notification_size>-1</notification_size>
        <vpool>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool>
    </object_bucket>
    <object_bucket>
        <name>standalone-bucket</name>
        <tags/>
        <api_type>S3</api_type>
        <block_size>-1</block_size>
        <owner>wuser1@sanity.local</owner>
        <created>2015-03-02T19:44:29.283Z</created>
        <default_retention>-2</default_retention>
        <fs_access_enabled>false</fs_access_enabled>
        <is_stale_allowed>false</is_stale_allowed>
        <locked>false</locked>
        <search_metadata>
            <metadata>
                <datatype>integer</datatype>
                <name>SomeKey</name>
            </metadata>
            <metadata>
                <datatype>decimal</datatype>
                <name>SomeKey2</name>
            </metadata>
        </search_metadata>
        <namespace>s3</namespace>
        <notification_size>-1</notification_size>
        <vpool>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool>
    </object_bucket>
</object_buckets>