Bucket:Get Bucket Info

Search (SHIFT+S)




New in this release

Get Bucket Info

GET /object/bucket/{bucketName}/info

Gets bucket information for the specified bucket.

bucketNameBucket name for which information will be retrieved

Query Parameters

namespaceNamespace associated. If it is null, then current user's namespace is used.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR


Prerequisites

The following conditions must be met in order to call this operation.

  • Bucket name should not be null or empty.

  • Bucket must exist.


Response Body

Response contains the following bucket information

Field Description Type Notes
<bucket_info>
<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_encryption_enabled> D@RE Bucket isEncryptionEnabled flag String
<default_retention> Default bucket retention Long
<block_size> Block size in GB 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
</Tag>      
</TagSet>
<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
</metadata>      
<isEnabled> Getter for the enabled flag. Boolean
</search_metadata>      
<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
<creation_time> Timestamp that shows when this resource was created in ECS DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<inactive> Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database. Boolean Valid Values:
  •  true
  •  false
<global> Indicates whether the resource is global. Boolean Valid Values:
  •  true
  •  false
<remote> Indicates whether the resource is remote. Boolean Valid Values:
  •  true
  •  false
<vdc>    
<id> ECS Id of the related object URI
<link> Hyperlink to the related object
</vdc>      
<internal> Indicated whether the resource is an internal resource Boolean Valid Values:
  •  true
  •  false
</bucket_info>

Examples

Request
GET https://192.168.0.0:4443/object/bucket/standalone-bucket/info

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"?>
<bucket_info>
    <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>
    <compliance_enabled>false</compliance_enabled>
    <locked>false</locked>
    <namespace>s3</namespace>
    <notification_size>-1</notification_size>
    <vpool>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</vpool>
</bucket_info>
Notes: