Spectra Logic

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

Get DS3 Target Failures

Description

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

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/ds3_target_failure​[?error_message={string}][&last_page][&page_length={32‑bit integer}]​[&page_offset={32‑bit integer}]​[&page_start_marker={string}][&target_id={string}]​[&type=IMPORT_FAILED|IMPORT_INCOMPLETE| NOT_ONLINE| READ_FAILED|READ_INITIATE_FAILED

|VERIFY_FAILED|WRITE_FAILED|WRITE_INITIATE_FAILED]

Request Parameters 

Parameter	Description	Required
error_message	The text of the error message.	no
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of DS3 target failures to list. Default: all items after page_offset.	no
page_offset	The starting point for the first DS3 target failure 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	DS3 target UUID, name, or other unique attribute. To determine the UUID for a DS3 target, see Get DS3 Targets.	no
type	The type of error message. Values: Values: IMPORT_FAILED, IMPORT_INCOMPLETE, NOT_ONLINE, READ_FAILED, READ_INITIATE_FAILED, VERIFY_FAILED, WRITE_FAILED, WRITE_INITIATE_FAILED	no

Responses

Response Elements

<Data>
   <Ds3TargetFailure>
      <Date>YYYY-MM-DDThh:mm:ss.xxxZ</Date>
      <ErrorMessage>{string}</ErrorMessage>
      <Id>{string}</Id>
      <TargetId>{string}</TargetId>
      <Type>
         IMPORT_FAILED|IMPORT_INCOMPLETE|NOT_ONLINE|READ_FAILED|          READ_INITIATE_FAILED

         |VERIFY_FAILED|WRITE_FAILED|WRITE_INITIATE_FAILED
      </Type>
   </Ds3TargetFailure>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Ds3TargetFailure	The container for information about one DS3 target failure.
Date	The date and time the error occurred in the format YYYY-MM-DDThh:mm:ss.xxxZ
ErrorMessage	A description of the error.
Id	The UUID for the error message.
TargetId	The UUID for the DS3 target that had the failure.
Type	The type of error message. Values: Values: IMPORT_FAILED, IMPORT_INCOMPLETE, NOT_ONLINE, READ_FAILED, READ_INITIATE_FAILED, VERIFY_FAILED, WRITE_FAILED, WRITE_INITIATE_FAILED

Example

Sample Request

This request gets information about all DS3 target failures.

GET http://blackpearl-hostname/_rest_/ds3_target_failure​/ HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>
   <Ds3TargetFailure>
   <Date>2016-05-17T14:18:01.000Z</Date>
   <ErrorMessage>{error text}</ErrorMessage>
   <Id>df53ea38-a582-4c04-99ef-e5d8071fe188</Id>
   <TargetId>aa584aa1-f2dd-4064-8db3-f6f07810dc89</TargetId>
   <Type>NOT_ONLINE</Type>
   </Ds3TargetFailure>
</Data>