Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Buckets - Spectra S3

Description

Shows information, such as logical used capacity and data policy, about all buckets configured on the BlackPearl system. Use parameters as selection criteria to return information for a subset of all buckets.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/bucket​[?data_policy_id={string}][&last_page][&name={string}][&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}][&user_id={string}]

Request Parameters 

Parameter	Description	Required
data_policy_id	The UUID, name, or other unique attribute for the data policy.	no
last_page	If included, only the last page of results is returned.	no
name a	The name of the bucket.	no
page_length	The maximum number of buckets to list. The default is all items after page_offset.	no
page_offset	The starting point for the first bucket to list. The default is 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no
user_id a	The UUID, username, or a unique attribute for the bucket owner.	no

a.	Parameter values can use wild cards (see Wild Card Syntax).

Responses

Response Elements

<Data>
   <Bucket>
      <CreationDate>{YYYY-MM-DDThh:mm:ss.xxxZ}</CreationDate>
      <DataPolicyId>{string}</DataPolicyId>
      <Id>{string}</Id>
      <LastPreferredChunkSizeInBytes>
         {64‑bit integer}
      </LastPreferredChunkSizeInBytes>

      <LogicalUsedCapacity>{64‑bit integer}</LogicalUsedCapacity>
      <Name>{string}</Name>
      <UserId>{string}</UserId>
   </Bucket>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Bucket	The container for information about a single bucket.
CreationDate	The date and time the bucket was created in the format YYYY-MM-DDThh:mm:ss.xxxZ
DataPolicyId	The UUID for the assigned data policy.
Id	The UUID for the bucket.
LastPreferred ChunkSizeInBytes	The last preferred chunk size computed for a PUT job for this bucket.
LogicalUsed Capacity	The logical capacity used in bytes.
Name	The name of the bucket.
UserId	The UUID for the bucket owner.

Example

Sample Request

This request gets data policy and logical used capacity information for all buckets.

GET http://blackpearl-hostname/_rest_/bucket/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <Bucket>
      <CreationDate>2015-07-22 14:22:50.284</CreationDate>
      <DataPolicyId>
         704401b4-03a1-4752-9329-08e8c77fce23
      </DataPolicyId>
      <Id>ccef9b22-aa77-449e-9f4f-3fe6ecc4be03</Id>
      <LastPreferredChunkSizeInBytes/>
      <LogicalUsedCapacity>1024</LogicalUsedCapacity>
      <Name>bucket1</Name>
      <UserId>7bd66b10-1d8e-49ce-b7ef-c680432dbfc8</UserId>
   </Bucket>
   ...
</Data>