Spectra Logic

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

Get Amazon S3 Target Read Preferences

Description

Get information about the default read preference for all Amazon S3 targets. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/s3_target_read_preference/[&bucket_id={string}][&last_page][&page_length={32‑bit integer}]​[&page_offset={32‑bit integer}][&page_start_marker={string}]​[&read_preference=MINIMUM_LATENCY|AFTER_ONLINE_POOL|​ AFTER_NEARLINE_POOL|AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER][&target_id={string}]

Request Parameters 

Parameter	Description	Required
bucket_id	The bucket name, UUID, or other unique attribute.	no
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of Amazon S3 target read preferences to list. Default: all items after page_offset.	no
page_offset	The starting point for the first Amazon S3 target read preferences 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
read_preference	When it is preferable to read from the Amazon S3 target rather than the replication source. Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.	no
target_id	The UUID, name, or other unique attribute for the replication target.	no

Responses

Response Elements

<Data>
   <S3TargetReadPreference>
      <BucketId>{string}</BucketId>
      <Id>{string}</Id>
      <ReadPreference>
         MINIMUM_LATENCY|AFTER_ONLINE_POOL|AFTER_NEARLINE_POOL
         |AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER
      </ReadPreference>
      <TargetId>{string}</TargetId>
   </S3TargetReadPreference>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
S3TargetRead Preference	The container for information about the read preference for one Amazon S3 target.
BucketId	The UUID for the bucket.
Id	The UUID for the read preference.
ReadPreference	When it is preferable to read from the Amazon S3 target rather than the replication source. Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.
TargetId	The UUID for the replication target.

Example

Sample Request

This request gets information about the read preference for each Amazon S3 target registered to the source.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <S3TargetReadPreference>
      <BucketId>306e0f35-aadd-4152-90eb-7fcf42df7a15</BucketId>
      <Id>8d0aae6a-2d72-486c-9142-f0542662776f</Id>
      <ReadPreference>MINIMUM_LATENCY</ReadPreference>
      <TargetId>3e0cd533-f062-4504-8063-c59c4e478549</TargetId>
   </S3TargetReadPreference>
   </Data>