List event notifications (GET /v1.0/{tenantId}/events)

Lists information for all events.

Request URI

{tenantID}

Project ID of the owner of the instance

Data Type Cardinality
String 1..1

Request Parameters

duration

Duration in minutes of the data to search for

Default: 60

Data Type Cardinality Parent Element Child Element(s)
Integer 0..1 None None

startTime

Start time of the time interval for the event search

Example: 2009-07-08T18:00Z

Data Type Cardinality Parent Element Child Element(s)
DateTime 0..1 None None

endTime

End time of the time interval for the event search

Example: 2009-07-08T18:00Z

Note: ISO 8601 format

Data Type Cardinality Parent Element Child Element(s)
DateTime 0..1 None None

eventCategories.

List of event categories

Data Type Cardinality Parent Element Child Element(s)
String list 0..n None None

sourceType

Source type used to search for the event. Events that contain this source type only are returned.

Default: If this parameter is not specified, events for all source types are returned.

db-instance | db-snapshot

Data Type Cardinality Parent Element Child Element(s)
String 0..1 None None

sourceId

Resource ID used to search for the event. Events that contain this Resource ID only are returned.

Data Type Cardinality Parent Element Child Element(s)
String 0..1 None None

limit

Number of elements to display

20 to 100

Default:20

Data Type Cardinality Parent Element Child Element(s)
Integer 0..1 None None

marker

A pagination token used to establish the starting point for retrieving the list.

Note: Specify the last date and time returned in the previous list display.

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None None

Response Headers

Status

Returns the status of the request.

One of the following values will be returned.
401:
unauthorized
403:
forbidden
404:
itemNotFound
500:
instanceFault
501:
notImplemented
503:
serviceUnavailable
504:
gatewayTimeout
Data Type Cardinality
Int 1.1

Response Elements

events

List of events

Data Type Cardinality Parent Element Child Element(s)
Event list 1..1 None None

event

Data Type Cardinality Parent Element Child Element(s)
- 0..n None date

eventCategories

message

sourceIdentifier

sourceType

date

Date and time when the event occurred

Data Type Cardinality Parent Element Child Element(s)
DateTime 1..1 event None

eventCategories

Category of the event

Data Type Cardinality Parent Element Child Element(s)
String 1..1 event None

message

Content of the event

Data Type Cardinality Parent Element Child Element(s)
String 1..1 event None

sourceIdentifier

Resource ID where the event occurred

Data Type Cardinality Parent Element Child Element(s)
String 1..1 event None

sourceType

Type of resource

db-instance | db-snapshot

Data Type Cardinality Parent Element Child Element(s)
String 1..1 event None

CAUTION:

Events are displayed in descending order of datetime

Example of Response


       {
         "events": [
           {
             "date":  "2013-03-18T19:09:17", 
             "eventCategories":  [
               "backup"
             ], 
             "message": "Finished DB Instance backup",
             "sourceIdentifier": "dbinst_678yuhyhih",
             "sourceType": "db-instance"
           }
         ]
       }