Spectra Logic

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

Get Pool Failures

Description

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

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/pool_failure/[?error_message={string}][&last_page]
[&page_length={32-bit integer}] [&page_offset={32-bit integer}] [&page_start_marker={string}] [&pool_id={string}] [&type=BLOB_READ_FAILED|DATA_CHECKPOINT_FAILURE| DATA_CHECKPOINT_MISSING|FORMAT_FAILED|IMPORT_FAILED| IMPORT_FAILED_DUE_TO_DATA_INTEGRITY| IMPORT_FAILED_DUE_TO_TAKE_OWNERSHIP_FAILURE|INSPECT_FAILED| QUIESCED|READ_FAILED|VERIFY_FAILED|WRITE_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
pool_id	The UUID or other unique attribute for the error pool.	no
type	The type of error message. Values: BLOB_READ_FAILED, DATA_CHECKPOINT_FAILURE, DATA_CHECKPOINT_MISSING, FORMAT_FAILED, IMPORT_FAILED, IMPORT_FAILED_DUE_TO_DATA_INTEGRITY, IMPORT_FAILED_DUE_TO_TAKE_OWNERSHIP_FAILURE, INSPECT_FAILED, QUIESCED, READ_FAILED, VERIFY_FAILED, WRITE_FAILED	no

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

Responses

Response Elements

<Data>
   <PoolFailure>
      <Date>{YYYY-MM-DDThh:mm:ss.xxxZ}</Date>
      <ErrorMessage>{string}</ErrorMessage>
      <Id>{string}</Id>
      <PoolId>{string}</PoolId>
      <Type>
         BLOB_READ_FAILED|DATA_CHECKPOINT_FAILURE|
         DATA_CHECKPOINT_MISSING|FORMAT_FAILED|IMPORT_FAILED|          IMPORT_FAILED_DUE_TO_DATA_INTEGRITY|
         IMPORT_FAILED_DUE_TO_TAKE_OWNERSHIP_FAILURE|
         INSPECT_FAILED|QUIESCED|READ_FAILED|VERIFY_FAILED|
         WRITE_FAILED
      </Type>
   </PoolFailure>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	A container for the response.
PoolFailure	A container for information about a single pool 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.
PoolId	The UUID for the pool.
Type	The type of pool error message. Values: BLOB_READ_FAILED, DATA_CHECKPOINT_FAILURE, DATA_CHECKPOINT_MISSING, FORMAT_FAILED, IMPORT_FAILED, IMPORT_FAILED_DUE_TO_DATA_INTEGRITY, IMPORT_FAILED_DUE_TO_TAKE_OWNERSHIP_FAILURE, INSPECT_FAILED, QUIESCED, READ_FAILED, VERIFY_FAILED, WRITE_FAILED

Example

Sample Request

This request retrieves a list of all pool failures.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <PoolFailure>
      <Date>2015-08-28 12:39:50.307</Date>
      <ErrorMessage>
         Could not read object from pool.
      </ErrorMessage>
      <Id>6a702949-9408-43a1-b743-aa410256f109</Id>
      <PoolId>650da9c3-5a7a-41e0-b8c0-b7219e70cce4</PoolId>
      <Type>BLOB_READ_FAILED</Type>
   </PoolFailure>
</Data>