Abiquo 2.6


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+xml; version=2.4; 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
Retrieve a EventsDto entity. example
curl -X GET http://example.com/api/events?datefrom=1343052402064&volume=JC-3972c0f8-28b\
     -H 'Accept: application/vnd.abiquo.events+xml;version=2.4' \
     -u user:password --verbose
 
 
GET http://example.com/api/events?datefrom=1343052402064&volume=JC-3972c0f8-28b HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.events+xml;version=2.4
 
 
HTTP/1.1 200 OK
Date: Mon, 23 Jan 2013 14:07:26 GMT
Set-Cookie: JSESSIONID=01951ED65B92A67C7333327AB6E92126; Path=/api
Set-Cookie: auth=YWRtaW46MTM0MzA1NDI0NjE2NDpiOWJkMWEyMWFmNjJmN2ZkMTU5NTQ0YzI4M2E3ZjhiOTpBQklRVU8; Expires=Mon, 23-Jan-2013 14:37:26 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.events+xml;version=2.4
Content-Length: 1270
 
<?xml version="1.0" encoding="UTF-8"?>
<events>
  <link href="http://example.com/api/events" rel="first"/>
  <link href="http://example.com/api/events?startwith=0" rel="last"/>
  <totalSize>2</totalSize>
  <event>
    <actionPerformed>VOLUME_DELETE</actionPerformed>
    <component>VOLUME</component>
    <enterprise>Abiquo</enterprise>
    <id>109</id>
    <idEnterprise>1</idEnterprise>
    <idUser>1</idUser>
    <idVirtualDatacenter>1</idVirtualDatacenter>
    <idVolume>1786</idVolume>
    <performedBy>admin</performedBy>
    <severity>INFO</severity>
    <stacktrace>Deleting volume &apos;JC-3972c0f8-28b&apos;</stacktrace>
    <timestamp>2013-01-23T14:07:14Z</timestamp>
    <user>admin</user>
    <virtualDatacenter>JC-d0cf5cd6-67b</virtualDatacenter>
    <volume>JC-3972c0f8-28b</volume>
  </event>
  <event>
    <actionPerformed>VOLUME_MODIFY</actionPerformed>
    <component>VOLUME</component>
    <enterprise>Abiquo</enterprise>
    <id>108</id>
    <idEnterprise>1</idEnterprise>
    <idUser>1</idUser>
    <idVirtualDatacenter>1</idVirtualDatacenter>
    <idVolume>1786</idVolume>
    <performedBy>admin</performedBy>
    <severity>INFO</severity>
    <stacktrace>Updated size of volume &apos;JC-Event vol&apos; to
      &apos;32&apos; MB</stacktrace>
    <timestamp>2013-01-23T14:07:12Z</timestamp>
    <user>admin</user>
    <virtualDatacenter>JC-d0cf5cd6-67b</virtualDatacenter>
    <volume>JC-3972c0f8-28b</volume>
  </event>
</events>

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+xml; version=2.4; 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
Retrieve a EventDto entity. example
curl -X GET http://example.com/api/events/108\
     -H 'Accept: application/vnd.abiquo.event+xml;version=2.2'  \
     -u user:password --verbose
 
 
GET http://example.com/api/events/108 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.event+xml;version=2.2
 
 
HTTP/1.1 200 OK
Date: Mon, 23 Jan 2013 14:07:26 GMT
Set-Cookie: JSESSIONID=01951ED65B92A67C7333327AB6E92126; Path=/api
Set-Cookie: auth=YWRtaW46MTM0MzA1NDI0NjE2NDpiOWJkMWEyMWFmNjJmN2ZkMTU5NTQ0YzI4M2E3ZjhiOTpBQklRVU8; Expires=Mon, 23-Jan-2013 14:37:26 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.event+xml;version=2.2
Content-Length: 1270
 
<?xml version="1.0" encoding="UTF-8"?>
<event>
  <actionPerformed>VOLUME_MODIFY</actionPerformed>
  <component>VOLUME</component>
  <enterprise>Abiquo</enterprise>
  <id>108</id>
  <idEnterprise>1</idEnterprise>
  <idUser>1</idUser>
  <idVirtualDatacenter>1</idVirtualDatacenter>
  <idVolume>1786</idVolume>
  <performedBy>admin</performedBy>
  <severity>INFO</severity>
  <stacktrace>Updated size of volume &apos;JC-Event vol&apos; to
    &apos;32&apos; MB</stacktrace>
  <timestamp>2013-01-23T14:07:12Z</timestamp>
  <user>admin</user>
  <virtualDatacenter>JC-d0cf5cd6-67b</virtualDatacenter>
  <volume>JC-3972c0f8-28b</volume>
</event>