Spectra Logic

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

Get Suspect Objects

Get a list of all objects that the BlackPearl system suspects are degraded. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/suspect_object​[?bucket_id={string}][&last_page][&page_length={32‑bit integer}][&page_offset={32‑bit integer}]​[&page_start_marker={string}]

Request Parameters 

Parameter	Description	Required
bucket_id a	The UUID, name, or other unique identifier for the bucket on which the job is operating.	no
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of buckets to list. The default is all items after page_offset.	no
page_offset	The starting point for the first bucket 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

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

Responses

Response Elements

<Data>
   <S3Object>
      <BucketId>{string}</BucketId>
      <CreationDate/>
      <Id>{string}</Id>
      <Latest>TRUE|FALSE</Latest>
      <Name>{string}</Name>
      <Type>DATA|FOLDER</Type>
      <Version>1</Version>
   </S3Object>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
Data	A container for the response.
S3Object	The container for information about one object.
BucketId	The UUID for the bucket to which the object is assigned.
CreationDate	The date and time the bucket was created in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Id	The UUID for the Object
Latest	Whether this version of the object is the latest. Values: TRUE, FALSE
Name	The name of the object.
Type	The type of object. Values: DATA, FOLDER
Version	The version number of the object.

Example

Sample Request

This request gets information about all objects that the BlackPearl system suspects are degraded.

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

Sample Response

<Data>
   <S3Object>
      <BucketId>d8299ae8-1be9-4a80-94a3-918a7846457b</BucketId>
      <CreationDate/>
      <Id>7a84ae35-d0e8-4d6d-baa6-f773065986f6</Id>
      <Latest>true</Latest>
      <Name>object1</Name>
      <Type>DATA</Type>
      <Version>1</Version>
   </S3Object>
</Data>