Bucket:Get Bucket

Search (SHIFT+S)

API Reference


Get Bucket

GET /object/buckets/{id}

Get info for Bucket

idthe URN of a ViPR Bucket

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

Bucket details

Field Description Type Notes
<bucket>
<native_id> String
<soft_quota> SoftQuota of the bucket in GB String
<hard_quota> HardQuota of the Bucket in GB String
<vpool>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vpool>      
<varray>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
<storage_pool>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
<project>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</project>      
<protocols> Set of valid protocols S3, Swift and Atmos.
<protocol> String 0-* Elements
</protocols>
<storage_system>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_system>      
<storage_port>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_port>      
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<namespace> String
<owner> String
<retention> String
<path> String
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</bucket>
Notes: