Spectra Logic

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

Get Amazon S3 Target

Description

Get information about the specified Amazon S3 target.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/s3_target/{Amazon S3 target instance UUID, name, or other unique attribute}/

To determine the UUID for an Amazon S3 target, see Get Amazon S3 Targets.

Responses

Response Elements

<Data>

   <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>
     {YYYY-MM-DDThh:mm:ss.xxxZ}

   </LastFullyVerified>

   <Name>{string}</Name>

   <OfflineDataStagingWindowInTb>

     {integer}

   </OfflineDataStagingWindowInTb>

   <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>

     {integer}

   </StagedDataExpirationInDays>

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

</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.
ProxyDomain	The domain name for the proxy server.
ProxyHost	The host name or IP address for the proxy server to 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 the Amazon S3 target with the name ‘S3Target’.

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

Sample Response

HTTP/1.1 200 OK

<Data>

   <AccessKey>Nf36Pd1f</AccessKey>

   <AutoVerifyFrequencyInDays/>

   <CloudBucketPrefix/>

   <CloudBucketSuffix/>

   <DataPathEndPoint/>

   <DefaultReadPreference>LAST_RESORT</DefaultReadPreference>

   <Https>TRUE</Https>

   <Id>8fa1e732-0b9d-4f5e-b502-a6107d28f300</Id>

   <LastFullyVerified/>

   <Name>S3Target</Name>

   <OfflineDataStagingWindowInTb>1</OfflineDataStagingWindowInTb>

   <ProxyDomain/>

   <ProxyHost/>

   <ProxyPassword/>

   <ProxyPort/>

   <ProxyUsername/>

   <Quiesced>NO</Quiesced>

   <Region>US_WEST_2</Region>

   <SecretKey>Z42st5R</SecretKey>

   <StagedDataExpirationInDays>30</StagedDataExpirationInDays>

   <State>ONLINE</State>

</Data>