Spectra Logic

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

Create Bucket - Spectra S3

Description

Create a bucket using a specific data policy. The data policy must have at least one permanent persistence rule configured.

§

Also see Create Bucket (Put Bucket).

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/bucket​?name={string}​[&data_policy_id={string}][&user_id={string}][&id={string}]

To determine the UUID for a data policy, see Get Data Policies.

Request Parameters 

Parameter	Description	Required
name	The name for the new bucket. Important: When creating a bucket for use with a data policy including an Amazon S3 or Microsoft Azure replication target, the bucket name must adhere to the cloud target naming requirements. § For BlackPearl software version 3.5.2 or earlier, the BlackPearl system changes bucket names with upper case letters to all lower case letters when needed. If you are using bucket names that only differ by case, the buckets are combined on the cloud target causing possible data collision and bucket ownership/permission problems. § For BlueScale software version 4.0 or later, if the bucket name is incompatible with the naming requirements of the cloud target provider, bucket creation fails and an error is returned. Notes:   § The bucket name cannot contain a colon (:), forward slash (/), or space. § The bucket name cannot exceed 255 characters.	yes
data_policy_id	The UUID, name, or other unique attribute for the data policy. Default: § If only one data policy exists, that is the default data policy. § If the user has a default data policy assigned, that is the default data policy. § If more than one data policy exists and the user does not have a default data policy assigned, then the data_policy_id parameter is required or the operation fails.	in some cases
Id	The UUID for the bucket.	no
user_id	The UUID, username, or other unique attribute for the bucket owner. Default: The user creating the bucket.	no

Responses

Response Elements

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

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
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.
Name	The name of the bucket.
UserId	The UUID for the bucket owner.

Example

Sample Request

This request creates the bucket named “new_bucket” using the data policy with the UUID 22bdea46-4b7f-4f70-873c-ff953fa97b3b:

POST http://blackpearl-hostname/_rest_/bucket?name=new_bucket​&data_policy_id=22bdea46-4b7f-4f70-873c-ff953fa97b3b HTTP/1.1

Sample Response

HTTP/1.1 201 CREATED
<Data>
   <CreationDate>2015-07-22T14:22:49.224Z</CreationDate>
   <DataPolicyId>
      22bdea46-4b7f-4f70-873c-ff953fa97b3b
   </DataPolicyId>
   <Id>1acb4e56-ae93-49a0-b288-db93f0a70ea4</Id>
   <LastPreferredChunkSizeInBytes/>
   <Name>new_bucket</Name>
   <UserId>c0a80d43-c1ae-4ee1-87d5-12ca632e8205</UserId>
</Data>