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

Get Amazon S3 Target Bucket Names

Description

Gets all Amazon S3 bucket name mappings between the local BlackPearl buckets and their Amazon S3 target buckets.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/s3_target​bucket_name [&bucket_id={string}]​[&last_page]​[&name={string}]​[&page_length={32‑bit integer}]​[&page_offset={32‑bit integer}]​[&page_start_marker={string}]​[&target_id={string}]

Responses

Request Parameters 

Parameter	Description	Required
bucket_id	Bucket UUID, name, or other unique attribute.	no
last_page	If included, only the last page of results is returned.	no
name	The name of the bucket on the Amazon S3 target.	no
page_length	The maximum number of Amazon S3 target buckets to list. Default: all items after page_offset.	no
page_offset	The starting point for the first Amazon S3 target bucket to list. Default: 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
target_id	Amazon S3 target UUID, name, or other unique attribute.	no

Responses

Response Elements

<Data>

   <S3TargetBucketName>

      <BucketId>{string}</BucketId>

      <Id>{string}</Id>

      <Name>{string}/Name>

      <TargetId>{string}</TargetId>
   </S3TargetBucketName>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
S3TargetBucket Name	The name of the bucket on the Amazon S3 target,
BucketId	The UUID for the bucket.
Id	The UUID for the bucket mapping.
Name	The name of the Amazon S3 bucket.
TargetId	The UUID for the Amazon S3 replication target.

Example

Sample Request

This request gets a list of all buckets on the Amazon S3 target.

GET http://blackpearl-hostname/_rest_/s3_target_bucket_name

Sample Response

<Data>

   <S3TargetBucketName>

      <BucketId>220e62e0-c869-479c-a729-7f02316d6317</BucketId>

      <Id>9c3c3732-fab1-4a9c-88da-1fb6c0a6ff3f</Id>

      <Name>custombucketname</Name>

      <TargetId>c14ce94a-9c99-4f19-8373-5000b72313f0</TargetId>

   </S3TargetBucketName>

   <S3TargetBucketName>

      <BucketId>220e62e0-c869-479c-a729-7f02316d6317</BucketId>

      <Id>b7524215-aaac-4286-9098-12a3066567b9</Id>

      <Name>custombucketname</Name>

      <TargetId>d5c4ce07-dba9-4b2c-89c1-605d2dd6a4c0</TargetId>

   </S3TargetBucketName>

</Data>