Spectra Logic

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

Get Feature Keys

Description

Returns a list of all feature keys installed on the BlackPearl system.

Requests

Syntax

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

Request Parameters 

Parameter	Description	Required
error_message	The text of the error message.	no
expiration_date	The expiration date of the feature key.	no
key	The option of which the key enables. Values: AWS_S3_CLOUD_OUT, MICROSOFT_AZURE_CLOUD_OUT	no
last_page	If included, only the last page of results is returned.	no
page_length	The maximum number of feature keys to list. Default: all items after page_offset.	no
page_offset	The starting point for the first feature key 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

 

Responses

Response Elements

<Data>

   <FeatureKey>

     <CurrentValue>{64-bit integer}</CurrentValue>

     <ErrorMessage>{string}</ErrorMessage>

     <ExpirationDate>{YYYY-MM-DDThh:mm:ss.xxxZ}</ExpirationDate>

     <Id>{string}</Id>

     <Key>AWS_S3_CLOUD_OUT|MICROSOFT_AZURE_CLOUD_OUT</Key>

     <LimitValue>{64-bit integer}</LimitValue>

   </FeatureKey>

...

</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
FeatureKey	The container for information about one feature key.
CurrentValue	The amount of data replicated by the BlackPearl system to the Azure or Amazon S3 target. Note: If you delete data directly from the target, the CurrentValue is not updated until a full Verify Target (see Verify Amazon S3 Target, or Verify Azure Target) completes.
ErrorMessage	A description of the error.
ExpirationDate	The date and time the feature key expires in the form YYYY-MM-DDThh:mm:ss.xxxZ .
Id	The ID of the feature key.
Key	The type of feature key. Values: AWS_S3_CLOUD_OUT, MICROSOFT_AZURE_CLOUD_OUT
Limit Value	The maximum logical cloud replication capacity licensed in bytes.

Example

Sample Request

This request gets information about all feature keys installed on the BlackPearl system.

GET http[s]://datapathdnsnameofappliance/_rest_/feature_key/
HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>

   <FeatureKey>

     <CurrentValue/>

     <ErrorMessage/>

     <ExpirationDate/>

     <Id>0f6fac07-624d-4ef6-a9e0-cc802ef8a952</Id>

     <Key>AWS_S3_CLOUD_OUT</Key>

     <LimitValue>1099511627776</LimitValue>

   </FeatureKey>

</Data>