Spectra Logic

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

Get Amazon S3 Targets

Description

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

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/s3_target​[?access_key={string}][&data_path_end_point={string}]​[&default_read_preference=MINIMUM_LATENCY|AFTER_ONLINE_POOL|​AFTER_NEARLINE_POOL|AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER][&https=TRUE|FASLE][&last_page][&name={string}][&page_length={32‑bit integer}][&page_offset={32‑bit integer}][&page_start_marker={string}]​[&permit_going_out_of_sync=TRUE|FALSE]​[&quiesced=NO|PENDING|YES]​[&region={string}][&state=ONLINE|LIMITED_ACCESS|OFFLINE]

Request Parameters 

Parameter	Description	Required
access_key	The access key of user for the Amazon S3 account.	no
data_path_end_ point	The IPv4 address or DNS name for the data path of the Amazon S3 target.	no
default_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
https	Whether the BlackPearl system uses the HTTPS protocol to setup and replicate data to the target. Values: TRUE, FALSE	no
last_page	If included, only the last page of results is returned.	no
name	The name for the Amazon S3 target.	no
page_length	The maximum number of Amazon S3 targets to list. Default: all items after page_offset.	no
page_offset	The starting point for the first Amazon S3 target 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
permit_going_out_of_sync	Whether a target is allowed to be out of sync with the source. See permit_going_out_of_sync. Note: This parameter is deprecated.	no
quiesced	Whether the Amazon S3 target is in a temporarily inactive state. Values: NO, PENDING, YES	no
region	The world region where the Amazon S3 target is physically located. Values: US_EAST_1, US_WEST_1, US_WEST_2, EU_WEST_1, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, GOV_CLOUD	no
state	The state of the Amazon S3 target. Values: ONLINE, OFFLINE, LIMITED_ACCESS	no

Responses

Response Elements

<Data>

   <S3Target>

      <AccessKey>{string}</AccessKey>

      <AutoVerifyFrequencyInDays>
        {integer}
      </AutoVerifyFrequencyInDays>

      <CloudBucketPrefix>{string}</CloudBucketPrefix>

      <CloudBucketSuffix>{string}</CloudBucketSuffix>

      <DataPathEndPoint>{string}</DataPathEndPoint>

      <DefaultReadPreference>
        MINIMUM_LATENCY|AFTER_ONLINE_POOL|AFTER_NEARLINE_POOL
        |AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER
      </DefaultReadPreference>

      <Https>TRUE|FASLE</Https>

      <Id>{string}</Id>

      <LastFullyVerified>{string}</LastFullyVerified>

      <Name>{string}</Name>

      <OfflineDataStagingWindowInTb>

     {64-bit integer}

      </OfflineDataStagingWindowInTb>

      <PermitGoingOutOfSync>TRUE|FALSE</PermitGoingOutOfSync>

      <ProxyDomain>{string}</ProxyDomain>

      <ProxyHost>{string}</ProxyHost>

      <ProxyPassword>{string}</ProxyPassword>

      <ProxyPort>{64-bit integer}</ProxyPort>

      <ProxyUsername>{string}</ProxyUsername>

      <Quiesced>NO|PENDING|YES</Quiesced>

      <Region>{string}</Region>

      <SecretKey>{string}</SecretKey>

      <StagedDataExpirationInDays>

        {64-bit integer}

      </StagedDataExpirationInDays>

      <State>ONLINE|OFFLINE|LIMITED_ACCESS</State>

   </S3Target>

</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
AccessKey	The the S3 Access Key of the user for the Amazon S3 account.
AutoVerify FrequencyInDays	The frequency at which a full verify of the data on the target is scheduled. If null, no full verify is scheduled. It is useful to schedule auto verify when the target is a storage domain in a data policy using replicate deletes. The verify ensures that deletes replicate in a timely manner.
CloudBucketPrefix	The Amazon S3 target bucket prefix. Bucket names on the BlackPearl system must be unique within the BlackPearl system, but bucket names in Amazon S3 must be unique across the world. To permit friendlier, shorter local bucket names on the BlackPearl system while avoiding naming conflicts with Amazon S3, the BlackPearl system optionally adds the defined Cloud Bucket Prefix to the BlackPearl bucket name when it replicates the bucket.
CloudBucketSuffix	The Amazon S3 target bucket suffix. Bucket names on the BlackPearl system must be unique within the BlackPearl system, but bucket names in Amazon S3 must be unique across the world. To permit friendlier, shorter local bucket names on the BlackPearl system while avoiding naming conflicts with Amazon S3, the BlackPearl system optionally adds the defined Cloud Bucket Suffix to the BlackPearl bucket name when it replicates the bucket.
DataPathEndpoint	The IPv4 address or DNS name for the data path of the AWS cloud service.
DefaultRead 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.
Https	Whether the BlackPearl system uses the HTTPS protocol to setup and replicate data to the target. Values: TRUE, FALSE.
Id	The UUID for the Amazon S3 target instance.
LastFullyVerified	The date and time data on the target was last fully verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Name	The name for the Amazon S3 target.
OfflineDataStagingWindowInTb	The maximum size, in TB, of the window available for staging data that is offline (in Glacier) so that it can be read.
PermitGoingOutOfSync	Whether a target is allowed to be out of sync with the source. See permit_going_out_of_sync. Note: This parameter is deprecated.
ProxyDomain	The domain name for the proxy server.
ProxyHost	The host name or IP address for the proxy server which the BlackPearl system connects.
ProxyPassword	The password used when connecting through the proxy server.
ProxyPort	The proxy server port through which the BlackPearl system connects.
ProxyUsername	The username used when connecting through the proxy server.
Quiesced	Whether the Amazon S3 target is in a temporarily inactive state. Values: NO, PENDING, YES
Region	The world region where the Amazon S3 target is physically located. Values: US_EAST_1, US_WEST_1, US_WEST_2, EU_WEST_1, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, GOV_CLOUD
SecretKey	The secret key associated with the AccessKey.
StagedData ExpirationInDays	The number of days before the pre‐staged copy of data can expire. If the BlackPearl system does not retrieve all of the data before the copy expires, it has to go through the process of pre‐staging it again, incurring additional delays and costs.
State	The state of the Amazon S3 target. Values: ONLINE, OFFLINE, LIMITED_ACCESS

Example

Sample Request

This request gets information about all Amazon S3 targets registered to the source BlackPearl system.

GET http[s]://blackpearl-hostname/_rest_/s3_target HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <S3Target>
     <AccessKey>5sLpd33z</AccessKey>

     <AutoVerifyFrequencyInDays/>

     <CloudBucketPrefix/>

     <CloudBucketSuffix/>

     <DataPathEndPoint/>

     <DefaultReadPreference>LAST_RESORT</DefaultReadPreference>

     <Https>TRUE</Https>

     <Id>7a50b0f1-f78d-49a8-bd15-898bdd02a756</Id>

     <LastFullyVerified/>

     <Name>S3Target-32c68e61-07e3-4093-a906-14796239e37d</Name>

     <OfflineDataStagingWindowInTb>

        1

     </OfflineDataStagingWindowInTb>

     <PermitGoingOutOfSync>FALSE</PermitGoingOutOfSync>

     <ProxyDomain/>

     <ProxyHost/>

     <ProxyPassword/>

     <ProxyPort/>

     <ProxyUsername/>

     <Quiesced>NO</Quiesced>

     <Region>US_WEST_2</Region>

     <SecretKey>7dm2wWn</SecretKey>

     <StagedDataExpirationInDays>30</StagedDataExpirationInDays>

     <State>ONLINE</State>
   </S3Target>
</Data>