Spectra Logic

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

Get System Failures

Description

Get a list of all system failures. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/system_failure/[?error_message={string}][&last_page]
[&page_length={32-bit integer}][&page_offset={32-bit integer}] [&page_start_marker={string}] [&type=RECONCILE_TAPE_ENVIRONMENT_FAILED| RECONCILE_POOL_ENVIRONMENT_FAILED]

Request Parameters

Parameter	Description	Required
error_message a	The description of an error.	no
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of failures to list. The default is all items after page_offset.	no
page_offset	The starting point for the first failure to list. The default is 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
type	The type of system error message. Values: RECONCILE_TAPE_ENVIRONMENT_FAILED, RECONCILE_POOL_ENVIRONMENT_FAILED	no

a.	Parameter values can use wild cards (see Wild Card Syntax).

Responses

Response Elements

<Data>
   <SystemFailure>
      <Date>{YYYY-MM-DDThh:mm:ss.xxxZ}</Date>
      <ErrorMessage>{string}</ErrorMessage>
      <Id>{string}</Id>
      <Type>
         RECONCILE_TAPE_ENVIRONMENT_FAILED|
         RECONCILE_POOL_ENVIRONMENT_FAILED
      </Type>
   </SystemFailure>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
SystemFailure	A container for information about a single system 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.
Type	The type of tape error message. Values: RECONCILE_TAPE_ENVIRONMENT_FAILED, RECONCILE_POOL_ENVIRONMENT_FAILED

Example

Sample Request

This request retrieves a list of all system failures.

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

Sample Response

HTTP/1.1 200 OK

<Data>
   <SystemFailure>
      <Date>2015-12-07T03:20:39.000Z</Date>
      <ErrorMessage>{Error Message}</ErrorMessage>
      <Id>da981d00-d090-41d8-8921-3f14224dac16</Id>
      <Type>RECONCILE_POOL_ENVIRONMENT_FAILED</Type>
   </SystemFailure>

   ...

</Data>