Spectra Logic

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

Get Storage Domain Failures

Description

Get information about all storage domain failures, such as not having enough media to allocate to the storage domain to complete a PUT job. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/storage_domain_failure​[?error_message={string}][&last_page][&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}][&storage_domain_id={string}]​[&type=ILLEGAL_EJECTION_OCCURRED|LAST_FREE_MEDIA_ALLOCATED|​MEMBER_BECAME_READ_ONLY​|WRITES_STALLED_DUE_TO_NO_FREE_MEDIA_REMAINING]

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 storage domain failures to list. Default: all items after page_offset.	no
page_offset	The starting point for the first storage domain 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
storage_domain_id	Storage domain UUID, name, or other unique attribute. To determine the UUID for a storage domain, see Get Storage Domains.	no
type	The type of tape error message. Values: ILLEGAL_EJECTION_OCCURRED, LAST_FREE_MEDIA_ALLOCATED, MEMBER_BECAME_READ_ONLY, WRITES_STALLED_DUE_TO_NO_FREE_MEDIA_REMAINING	no

Responses

Response Elements

<Data>
   <StorageDomainFailure>
      <Date>YYYY-MM-DDThh:mm:ss.xxxZ</Date>
      <ErrorMessage>{string}</ErrorMessage>
      <Id>{string}</Id>
      <StorageDomainId>{string}</StorageDomainId>
      <Type>
         ILLEGAL_EJECTION_OCCURRED|LAST_FREE_MEDIA_ALLOCATED|
         MEMBER_BECAME_READ_ONLY|
         WRITES_STALLED_DUE_TO_NO_FREE_MEDIA_REMAINING
      </Type>
   </StorageDomainFailure>
   ...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
StorageDomain Failure	The container for information about one storage domain 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.
StorageDomainId	The UUID for the storage domain that had the failure.
Type	The type of tape error message. Values: ILLEGAL_EJECTION_OCCURRED, LAST_FREE_MEDIA_ALLOCATED, MEMBER_BECAME_READ_ONLY, WRITES_STALLED_DUE_TO_NO_FREE_MEDIA_REMAINING

Example

Sample Request

This request gets information about all storage domain failures.

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

Sample Response

HTTP/1.1 200 OK
<Data>
   <StorageDomainFailure>
   <Date>2016-05-17T14:18:01.000Z</Date>
   <ErrorMessage>{error text}</ErrorMessage>
   <Id>4b4aebcd-a5e7-4157-8de1-7598f01b9ed9</Id>
   <StorageDomainId>
      d479e099-6cf7-4f92-9add-1122b7467769
   </StorageDomainId>
   <Type>ILLEGAL_EJECTION_OCCURRED</Type>
   </StorageDomainFailure>
   ...
</Data>