Spectra Logic

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

Get DS3 Targets

Description

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

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/ds3_target​[?admin_auth_id={string}][&data_path_end_point={string}]​[&data_path_https=TRUE|FALSE][&data_path_port={32‑bit integer}]​[&data_path_proxy={string}]​[&data_path_verify_certificate=TRUE|FALSE]​[&default_read_preference=MINIMUM_LATENCY|AFTER_ONLINE_POOL|​AFTER_NEARLINE_POOL|AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER]​[&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]​[&state=ONLINE|LIMITED_ACCESS|OFFLINE]

Request Parameters 

Parameter	Description	Required
admin_auth_id	The DS3 access ID assigned to an Administrator.	no
data_path_end_ point	The IPv4 address or DNS name for the data path of the DS3 target.	no
data_path_https	Whether the source BlackPearl system uses the HTTPS protocol to setup and replicate data to the target system. Values: TRUE, FALSE	no
data_path_port	The value of the port on which the target BlackPearl system’s Spectra S3 server is running.	no
data_path_proxy	The proxy server for the source BlackPearl system to use to connect to the target system.	no
data_path_verify_ certificate	Whether the data path certificate is verified. When DataPathVerifyCertificate and DataPathHttps are both TRUE, the source BlackPearl system fully validates the target system’s certificate. If the certificate is not trusted or problematic in anyway, it is not honored. Values: TRUE, FALSE	no
default_read_ preference	When it is preferable to read from the DS3 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
last_page	If included, only the last page of results is returned.	no
name	The name for the DS3 target.	no
page_length	The maximum number of DS3 targets to list. Default: all items after page_offset.	no
page_offset	The starting point for the first DS3 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.	no
quiesced	Whether the DS3 target is in a temporarily inactive state. Values: NO, PENDING, YES	no
state	The state of the DS3 target. Values: ONLINE, OFFLINE, LIMITED_ACCESS	no

Responses

Response Elements

<Data>
   <Ds3Target>
      <AccessControlReplication>
         NONE|USERS
      </AccessControlReplication>
      <AdminAuthId>{string}</AdminAuthId>
      <AdminSecretKey>{string}</AdminSecretKey>
      <DataPathEndPoint>{string}</DataPathEndPoint>
      <DataPathHttps>TRUE|FALSE</DataPathHttps>
      <DataPathPort>{16-bit integer}</DataPathPort>
      <DataPathProxy>{string}</DataPathProxy>
      <DataPathVerifyCertificate>
         TRUE|FALSE
      </DataPathVerifyCertificate>
      <DefaultReadPreference>
         MINIMUM_LATENCY|AFTER_ONLINE_POOL|AFTER_NEARLINE_POOL
         |AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER
      </DefaultReadPreference>
      <Id>{string}</Id>
      <Name>{string}</Name>
      <PermitGoingOutOfSync>TRUE|FALSE</PermitGoingOutOfSync>
      <Quiesced>NO|PENDING|YES</Quiesced>
      <ReplicatedUserDefaultDataPolicy>
         {string}
      </ReplicatedUserDefaultDataPolicy>
      <State>ONLINE|OFFLINE</State>
   </Ds3Target>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Ds3Target	The container for information about one DS3 target.
AccessControl Replication	The access control that is replicated to the DS3 target. Values: NONE — No access control is replicated. USERS — The source BlackPearl system replicates its users and passwords to the target system.
AdminAuthId	The S3 access ID assigned to an Administrator.
AdminSecretKey	The S3 secret key for the account matching the given AdminAuthId.
DataPathEndPoint	The IPv4 address or DNS name for the data path of the DS3 target.
DataPathHttps	Whether the source BlackPearl system uses the HTTPS protocol to setup and replicate data to the target system. Values: TRUE, FALSE
DataPathPort	The value of the port on which the target BlackPearl system’s S3 server is running. If null, the parameter defaults to port 80 for HTTP connections and port 443 for HTTPS connections.
DataPathProxy	The proxy server for the source BlackPearl system to use to connect to the target system.
DataPathVerify Certificate	Whether the data path certificate is verified. When DataPathVerifyCertificate and DataPathHttps are both TRUE, the source BlackPearl system fully validates the target system’s certificate. If the certificate is not trusted or problematic in anyway, it is not honored. Values: TRUE, FALSE
DefaultRead Preference	When it is preferable to read from the DS3 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.
Id	The UUID for the DS3 target instance.
Name	The name for the DS3 target.
PermitGoingOutOfSync	Whether a target is allowed to be out of sync with the source. See permit_going_out_of_sync.
Quiesced	Whether the DS3 target is in a temporarily inactive state. Values: NO, PENDING, YES
ReplicatedUser DefaultDataPolicy	The data policy the target applies as the default data policy for any users replicated to the target.
State	The state of the DS3 target. Values: ONLINE, OFFLINE, LIMITED_ACCESS

Example

Sample Request

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

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <Ds3Target>
      <AccessControlReplication>NONE</AccessControlReplication>
      <AdminAuthId>c381Y3RyYQ==</AdminAuthId>
      <AdminSecretKey>d7pJBeAN</AdminSecretKey>
      <DataPathEndPoint>192.168.15.16</DataPathEndPoint>
      <DataPathHttps>TRUE</DataPathHttps>
      <DataPathPort/>
      <DataPathProxy/>
      <DataPathVerifyCertificate>TRUE</DataPathVerifyCertificate>
      <DefaultReadPreference>LAST_RESORT</DefaultReadPreference>
      <Id>c927287a-90eb-428e-88ae-faedc3749e17</Id>
      <Name>TargetBP</Name>
      <PermitGoingOutOfSync>FALSE</PermitGoingOutOfSync>
      <Quiesced>NO</Quiesced>
      <ReplicatedUserDefaultDataPolicy/>
      <State>ONLINE</State>
   </Ds3Target>
</Data>