/events
GET
Available Since: 4.0
Return a list of Events that match the selection criteria provided in the query parameters.
Parameters
| name | description | type | default |
|---|---|---|---|
| type | If specified, only events with matching types will be returned. To select events of multiple types include this parameter multiple times. If not specified events of all types are returned. A list of valid event types will be returned in an error message if an invalid type is specified. | query | |
| severity | If specified, only events with matching severity will be returned. To select events of multiple severities include this parameter multiple times. If not specified events of all severities are returned. A list of valid event severities will be returned in an error message if an invalid severity is specified. | query | |
| instance | The specific product instance IDs to match. If not specified all instances are used. Valid instance IDs are contained in the id attribute of the result from resource InstancesResource. | query | |
| instanceType | The product instance types to match. If not specified all instance types are matched. To match more than one instance type, specify this parameter multiple times. A list of valid instance types will be returned in an error message if an invalid value is provided. | query | |
| instanceGroup | The product instance groups to match. If not specified all instance groups are matched. This parameter is currently not implemented. | query | |
| instanceLocation | The product instance locations to match. If not specified all instance locations are matched. To match more than one location, specify this parameter multiple times. Valid locations are contained in the location attribute of the result from resource InstancesResource. | query | |
| instanceHostname | The product instance hostnames to match. If not specified all instance hostnames are matched. To matched more than one hostname, specify this parameter multiple times. Valid hostnames are contained in the hostname attribute of the result from resource InstancesResource. | query | |
| instanceVersion | The product instance versions to match or null to match all instance versions. Valid version strings are contained in the version attribute of the result from resource InstancesResource. | query | |
| startTime |
The start time for the requested data. This value may be in a relative form which will be calculated relative to endTime, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: -N[mhdwMy] which is interpreted to mean N time-units before endTime. Absolute form uses the ISO8601 syntax of YYYY-MM-DDThh:mm:ss where you can specify a partial date by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013. |
query | -24h |
| endTime |
The end time for the requested data. If not specified, an endTime of 'now' is used. This value may be in a relative form which will be calculated relative to now, or it may be in an absolute form using ISO8601 format. Relative form uses the syntax: -N[mhdwMy] which is interpreted to mean N time-units before now where now is the current time on the Metrics Engine server. Absolute form uses the ISO8601 syntax of YYYY-MM-DDThh:mm:ss where you can specify a partial string by omitting fields on the right (without skipping any fields). For example, 2013-01-01 is a valid timestamp that mean midnight on January 1st 2013. |
query | |
| limit | Specifies how many results should be returned. The default is to return all results. This is used in conjunction with the offset parameter to page through a large result set. | query | 0 |
| offset | Specifies how many results to skip for the first returned result. This is used in conjunction with the limit parameter to page through a large result set. | query | 0 |
Response Body
| result: | eventsResponse |
| media types: | application/xml application/json |
A list of Event objects in a EventsResponse.
Status Codes
| code | description |
|---|---|
| 200 | Success |
| 400 | Invalid parameter |
| 500 | Internal error |