Spectra Logic

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

Create Amazon S3 Target Failure Notification Registration

Description

Create a notification registration for Amazon S3 target failures.

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/s3_target_failure_notification_registration​?notification_end_point={string}[&format=DEFAULT|JSON|XML]​[&naming_convention=CONCAT_LOWERCASE|CONSTANT|​​UNDERSCORED|​CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE|​CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE]​[&notification_http_method=POST|PUT]

Request Parameters

Parameter	Description	Required
notification_end_ point	The HTTP or HTTPS URL of a web server capable of receiving notification messages from the BlackPearl system.	yes
format	The format of the notification. Values: DEFAULT (XML), JSON, XML	no
naming_ convention	The scheme used for naming within the notification sent. Values: CONCAT_LOWERCASE, CONSTANT, UNDERSCORED, CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE (default), CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE	no
notification_http_ method	The HTTP request method type used to send the notification. Values: POST (default), PUT	no

Responses

Response Elements

<Data>
   <CreationDate>{YYYY-MM-DDThh:mm:ss.xxxZ}</CreationDate>
   <Format>DEFAULT|JSON|XML</Format>
   <Id>{string}</Id>
   <LastFailure>{string}</LastFailure>
   <LastHttpResponseCode>{32‑bit integer}</LastHttpResponseCode>
   <LastNotification>{YYYY-MM-DDThh:mm:ss.xxxZ}</LastNotification>
   <NamingConvention>
      CONCAT_LOWERCASE|CONSTANT|UNDERSCORED|
      CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE|
      CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE
   </NamingConvention>
   <NotificationEndPoint>{string}</NotificationEndPoint>
   <NotificationHttpMethod>|POST|PUT</NotificationHttpMethod>
   <NumberOfFailuresSinceLastSuccess>
      {32‑bit integer}
   </NumberOfFailuresSinceLastSuccess>
   <UserId>{string}</UserId>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
CreationDate	The date the notification registration was created in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Format	The format of the notification. Values: DEFAULT (XML), JSON, XML
ID	The UUID for the notification.
LastFailure	The exception message for the last failure to send a notification to this notification registration.
LastHttpResponseCode	The last response code returned by the notification end point.
LastNotification	Date and time of the last notification attempt by the BlackPearl system.
NamingConvention	The scheme used for naming within the notification sent. Values: CONCAT_LOWERCASE, CONSTANT, UNDERSCORED, CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE, CAMEL_CASE_WITH_FIRST_LETTER_LOWERCASE
NotificationEnd Point	The HTTP or HTTPS URL of a web server capable of receiving notification messages from the BlackPearl system.
NotificationHttp Method	The HTTP request method type. Values: POST (default), PUT
NumberOfFailuresSinceLastSuccess	Number of failed notification attempts since last successful notification.
UserId	The UUID for the user who created the notification registration.

Example

Sample Request

This request creates a registration for Amazon S3 target failure notifications to be sent to S3-client-hostname.

POST http://blackpearl-hostname/_rest_/s3_target_failure_notification_registration
?notification_end_point=Spectra-S3-client-hostname HTTP/1.1

Sample Response

HTTP/1.1 201 CREATED
<Data>

   <CreationDate>2017-02-22T00:51:00.000Z</CreationDate>

   <Format>DEFAULT</Format>

   <Id>486e5212-c4b7-43f4-b49d-3ae8b703204a</Id>

   <LastFailure/>

   <LastHttpResponseCode/>

   <LastNotification>

   <NamingConvention>

      CAMEL_CASE_WITH_FIRST_LETTER_UPPERCASE

   </NamingConvention>

   <NotificationEndPoint>a</NotificationEndPoint>

   <NotificationHttpMethod>DELETE</NotificationHttpMethod>

   <NumberOfFailuresSinceLastSuccess>

      0

   </NumberOfFailuresSinceLastSuccess>

   <UserId/>

</Data>

 

Sample Notification Payload

Below is a sample Amazon S3 target failure notification payload:

<Name>S3TargetFailureNotificationPayload</Name>

<Payload>

   <Date>2016-04-07T23:27:27.000Z</Date>
   <ErrorMessage>{text}</ErrorMessage>
   <NotificationGenerationDate/>
   <TargetId>9dea633e-f1bc-4ccd-9c5e-651bdae65f3c</TargetId>
   <Type>NOT_ONLINE</Type>

</Payload>