Documentation

Skip to end of metadata
Go to start of metadata

Exposed Resources Hierarchy

Contents:

The Events Resource allows you to get Abiquo events depending on your Abiquo role, for example, CLOUD_ADMIN, ENTERPRISE_ADMIN, USER.

Main URI of the Resource

This class operates mainly over the Resource URI: /events

Exposed Methods

Retrieve a EventsDto entity.

Retrieve the list of Abiquo events that can be accessed by your role, for example, CLOUD_ADMIN, ENTERPRISE_ADMIN, USER.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

Synopsis: GET http://example.com/api/events
Roles Required: ROLE_AUTHENTICATED
Request Headers: Accept: application/vnd.abiquo.events+json; version=3.8; application/vnd.abiquo.events+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

startwith

false

0

First element to retrieve

by

false

timestamp

Search to retrieve. Available values are: {DATACENTER, RACK,
PHYSICALMACHINE, STORAGESYSTEM, STORAGEPOOL, VOLUME, NETWORK, SUBNET, ENTERPRISE,
USER, VIRTUALDATACENTER, VIRTUALAPP, VIRTUALMACHINE, SEVERITY, PERFORMEDBY,
ACTIONPERFORMED, COMPONENT, STACKTRACE, DATEFROM, DATETO}

has

false

 

A value to filter the search.

limit

false

25

Number of elements to retrieve.

asc

false

false

The order of the elements retrieved (ascending -> true, descending -> false). Ascending by default.

datacenter

false

 

Filter from events list by datacenter name.

rack

false

 

Filter from events list by rack name. (eg: rack=JC-1542992d-309).

physicalMachinefalse Filter from events list by physical machine name. (eg: physicalMachine=JC-70211e79-980).
storageSystemfalse 

Filter from events list by storage system name.

storagePoolfalse Filter from events list by storage pool name (eg: storagePool=abiquo).
volumefalse Filter from events list by volume name (eg: volume=abiquovol).
networkfalse Filter from events list by network name (eg: network=myprivatenetwork1).
subnetfalse Filter from events list by subnetwork name
enterprisefalse Filter from events list by enterprise name (eg: enterprise=myfirstenterprise).
userfalse Filter from events list by user name (eg: user=mycustomer).
virtualDatacenterfalse Filter from events list by virtual datacenter name (eg: virtualDatacenter=BCNvirtualdatacenter).
virtualAppfalse Filter from events list by virtual appliance name (eg: virtualApp=JC-29d17bd8-81e).
virtualMachinefalse Filter from events list by virtual machine name
severityfalse Severity level filter to filter from event list (eg: severity=INFO).
performedByfalse Filter from events list by name of user who performed the action (eg: performedBy=customer1).
actionPerformedfalse Filter from event list by the actions performed (eg: actionperformed=VM_DELETE).
componentfalse Show only events from the component specified (eg: component=VIRTUAL_MACHINE).
stacktracefalse Filter from event list by words matching the stack trace (eg: stacktrace=moved).
datefromfalse Retrieve events from the date specified as the number of seconds since 00:00 1/1/1970 UTC in string format (eg: datefrom=1359370517)
datetofalse Retrieve events to the date specified as the number of seconds since 00:00 1/1/1970 UTC in string format (eg: dateto=1359370517)

Request Message Body Entity:
Response Message Body Entity: Events Media Type
Request Example:

 Click here to show or hide the request example

API example removed: GET_evts_AC_evts_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Get events by component

 Click here to expand...

API example removed: GET_evts_AC_evts_j_COMPONENT
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

Get events by dates

 Click here to expand...

API example removed: GET_evts_AC_evts_j_DATEFROM_DATETO
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip

 

Retrieve a EventDto entity.

Retrieve a single Abiquo event if it can be accessed by your Abiquo role, for example, CLOUD_ADMIN, ENTERPRISE_ADMIN, USER.

Synopsis: GET http://example.com/api/events/{event}
Roles Required: ROLE_AUTHENTICATED
Request Headers: Accept: application/vnd.abiquo.event+json; version=3.8; application/vnd.abiquo.event+xml; version=3.8;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Event Media Type
Request Example:

 Click here to show or hide the request example

API example removed: GET_evts_X_AC_evt_j
You can download the API examples archive from ABI38Confluence-space-export-152334-314.html.zip