Dell Technologies ECS REST API

Search (SHIFT+S)




Changes to Get Bucket Info

Gets bucket information for the specified bucket.


Response Payload Changes

Field Description Type Notes
<bucket_info>
<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> String
<default_object_lock_retention_years> Integer
<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
</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
<mdTokens> Getter for the mdTokens flag. Boolean
<maxKeys> Getter for maxKeys. Integer
</search_metadata>      
<min_max_governor>    
<enforce_retention> Boolean
<minimum_fixed_retention> Long
<maximum_fixed_retention> Long
<minimum_variable_retention> Long
<maximum_variable_retention> Long
</min_max_governor>      
<audit_delete_expiration> 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
</bucket_info>