Get Events

This API provides the functionality to retrieve events based on certain filter criteria.

The API enables you to retrieve a list of events that have been logged because of the operations and actions performed in vCenter Chargeback Manager by a user. The API returns a chronological list of the most recent events logged. The number of events returned can be limited by the optional query parameter eventFetchSize. Also, you can apply filter to limit the events to be retrieved. The idea behind having the filter types is to allow the API user to limit the number of events retrieved, for example, the API user can retrieve all the events that are of severity INFO.


User Privilege

To call this API, the user only needs to be logged in to vCenter Chargeback Manager.

Syntax

The syntax for calling this API is:

GET <Base_URL>/events?eventFetchSize=<value>&filterType=<value>&filterValue=<value>

A sample API call is as follows:

GET https://123.123.123.123/vCenter-CB/api/events?eventFetchSize=<value>&filterType=<value>&filterValue=<value>

Request Query Parameters

Name Data Type Required/Optional Description Sample Value
eventFetchSize int Optional The number of events to be retrieved from the database. 30
filterType int Optional

The type of filter to be applied while fetching the events. It could be one of  the following:

FILTER_CATEGORY: Specified with integer 1, this filter type screens the events retrieved on the basis of event categories. For example, if you specify event_filter_type as FILTER_CATEGORY and the event_filter_value passed in the API as Hierarchy_Life_Cycle, the API retrieves all the events belonging to the category Hierarchy_Life_Cycle.

FILTER_SEVERITY: Specified with integer 2, this filter type screens the events retrieved on the basis of event severities. For example, if you specify the event_filter_type as FILTER_SEVERITY and the event_filter_value passed in the API as INFO, the API retrieves all the events with severity INFO. The supported event filter values are INFO, ERROR, and FATAL.

FILTER_EVENT_TYPE: Specified with integer 3, this filter type screens the events retrieved on the basis of event types. For example, if you specify event_filter_type as FILTER_EVENT_TYPE and the event_filter_value passed in the API as Task_Created, the API retrieves all events belonging to this type.

1
filterValue string Optional The value of the filter. For example, if the filter type is ‘CATEGORY’, the value could be ‘Hierarchy_Life_Cycle.' Hierarchy_Life_Cycle

Request Body Parameters

This API call does not require any request body parameter inputs.

Response Type

The API, on successful execution, returns a list of logged events.

XPath

Type

Min Occurs

Max occurs

Description

Events/Event

 

 

 

Represents the event retrieved.

Events/Event/@id

xs:string

1

1

ID of the event.

Events/Event/Type

xs:string

0

1

Type of the event.

Events/Event/Message

xs:string

0

1

Message logged by the event.

Events/Event/UserName

xs:string

0

1

User name of the user who generated this event.

Events/Event/CreateTime

xs:string

1

1

Time when the event was created.

Events/Event/Category

xs:long

1

1

Category of the event.

A sample response is available here.

Error Response

The API displays errors if inputs are incorrect or if the operation is unsuccessful for any reason. The following table explains the error codes displayed by the API.

Error code

Description

VCB_ERR_INVALID_EVENT_FILTER_TYPE

Returned when the filter type integer value passed does not match any of the prescribed filter types (‘CATEGORY’,’SEVERITY’, and  ‘EVENT_TYPE’)

VCB_ERR_INVALID_EVENT_FILTER_VALUE

Returned when the filter value does not match the corresponding filter type. For example, if INFO is passed as filter_value with filter_type = category

VCB_ERR_INVALID_EVENT_FILTER_FETCH_SIZE

Returned when the fetch size is not valid. For example, if the fetch size is less than 0.

List of Supported Filter Values

The following table provides the complete list of filter values available for each filter type.

Event Category

Event Type

Event Severity

AdminConsole_Life_Cycle

LogLevel_Modified

INFO

AdminConsole_Life_Cycle

LogLevel_Modify_Failed

ERROR

AdminConsole_Life_Cycle

Locale_Modified

INFO

AdminConsole_Life_Cycle

Locale_Modify_Failed

ERROR

AdminConsole_Life_Cycle

Currency_Modified

INFO

AdminConsole_Life_Cycle

Currency_Modify_Failed

ERROR

AdminConsole_Life_Cycle

Ldap_Modified

INFO

AdminConsole_Life_Cycle

Ldap_Modify_Failed

ERROR

AdminConsole_Life_Cycle

Email_Modified

INFO

AdminConsole_Life_Cycle

Email_Modify_Failed

ERROR

AdminConsole_Life_Cycle

Email_Deleted

INFO

AdminConsole_Life_Cycle

Email_Delete_Failed

ERROR

Attribute_Life_Cycle

Attribute_Created

INFO

Attribute_Life_Cycle

Attribute_Deleted

INFO

Attribute_Life_Cycle

Attribute_Modified

INFO

Automatic_Report_Scheduler_Life_Cycle

Report_Policy_Created

INFO

Automatic_Report_Scheduler_Life_Cycle

Report_Policy_Deleted

INFO

Automatic_Report_Scheduler_Life_Cycle

Report_Policy_Modified

INFO

Cost_Calculation_Life_Cycle

Cost_Calculation_Started

INFO

Cost_Calculation_Life_Cycle

Cost_Calculation_Finished

INFO

Cost_Calculation_Life_Cycle

Cost_Calculation_Failed

ERROR

Cpu_Tracker

Host_Cpu_Count_Started

INFO

Cpu_Tracker

Host_Cpu_Count_Failed

ERROR

Cpu_Tracker

Host_Cpu_Count

INFO

Cpu_Tracker

Host_Cpu_Count_Updated

INFO

DC_Life_Cycle

DC_Registered

INFO

DC_Life_Cycle

DC_Register_Failed

ERROR

DC_Life_Cycle

DC_Deleted

INFO

DC_Life_Cycle

DC_Delete_Failed

ERROR

DC_Life_Cycle

No_Working_Dc

INFO

DC_Life_Cycle

DcManagement_Failed

FATAL

Datacollector_Life_Cycle

DataCollector_Started

INFO

Datacollector_Life_Cycle

DataCollector_Stopped

INFO

Datacollector_Job_Life_Cycle

DataCollector_Job_Started

INFO

Datacollector_Job_Life_Cycle

DataCollector_Job_Succeeded

INFO

Datacollector_Job_Life_Cycle

DataCollector_Job_Failed

ERROR

Entity_Configuration_Change

Entity_Imported_VC_Attributes

INFO

Entity_Configuration_Change

Entity_Imported_CB_Attributes

INFO

Entity_Configuration_Change

Entity_Share_Added

INFO

Entity_Configuration_Change

Entity_Share_Removed

INFO

Entity_Configuration_Change

Entity_Modified

INFO

Entity_Configuration_Change

Entity_Attribute_Created

INFO

Entity_Configuration_Change

Entity_Attribute_Deleted

INFO

Entity_Configuration_Change

Entity_Attribute_Modified

INFO

Entity_Configuration_Change

Entity_Share_Modified

INFO

Entity_Configuration_Change

Entity_Resource_Allocation_Updated

FATAL

Entity_Configuration_Change

Entity_Resource_Allocation_Cleared

FATAL

Entity_Cost_Configuration

Rate_Factors_Updated

INFO

Entity_Cost_Configuration

Fixed_Costs_Updated

INFO

Entity_Cost_Configuration

Billing_Disabled

INFO

Entity_Cost_Configuration

Billing_Enabled

INFO

Entity_Cost_Configuration

Entity_Configuration_Updated

INFO

Entity_Life_Cycle

Entity_Added

INFO

Entity_Life_Cycle

Entity_Deleted

INFO

Entity_Life_Cycle

CB_Entity_Added

INFO

Entity_Life_Cycle

CB_Entity_Added_With_Children

INFO

Entity_Life_Cycle

Entity_Moved

INFO

Entity_Life_Cycle

VC_Entity_Mapping_Changed

INFO

Entity_Life_Cycle

Entity_Add_Operation_Reverted

INFO

Entity_Life_Cycle

Entity_Move_Operation_Reverted

INFO

Global_Cost_Configuration

Global_Fixed_Cost_Created

INFO

Global_Cost_Configuration

Global_Fixed_Cost_Updated

INFO

Global_Cost_Configuration

Global_Fixed_Cost_Deleted

INFO

Global_Cost_Configuration

Cost_Template_Created

INFO

Global_Cost_Configuration

Cost_Template_Updated

INFO

Global_Cost_Configuration

Cost_Template_Deleted

INFO

Global_Cost_Configuration

Cost_Model_Created

INFO

Global_Cost_Configuration

Cost_Model_Updated

INFO

Global_Cost_Configuration

Cost_Model_Deleted

INFO

Global_Cost_Configuration

Base_Rates_Updated

INFO

Global_Cost_Configuration

Billing_Policy_Created

INFO

Global_Cost_Configuration

Billing_Policy_Modified

INFO

Global_Cost_Configuration

Billing_Policy_Deleted

INFO

Global_Cost_Configuration

Computing_Resource_Created

INFO

Global_Cost_Configuration

Computing_Resource_Updated

INFO

Global_Cost_Configuration

Computing_Resource_Deleted

INFO

Global_Cost_Configuration

Cost_Template_Applied

INFO

Health_Monitor_Updates

Health_Monitor_New_Entity_Monitored

INFO

Health_Monitor_Updates

Health_Monitor_New_Entity_Monitored_Response_Time_Also

INFO

Health_Monitor_Updates

Health_Monitor_Status_Change

INFO

Health_Monitor_Updates

Health_Monitor_Status_Change_Response_Time_Also

INFO

Health_Monitor_Updates

Health_Monitor_Response_Time_Change

INFO

Health_Monitor_Updates

Health_Monitor_No_Information_Present

INFO

Hierarchy_Configuration_Change

Hierarchy_Modified

INFO

Hierarchy_Configuration_Change

Hierarchy_Sync_Started

INFO

Hierarchy_Configuration_Change

Hierarchy_Sync_Stopped

INFO

Hierarchy_Life_Cycle

Hierarchy_Created

INFO

Hierarchy_Life_Cycle

Hierarchy_Created_From_VCenter

INFO

Hierarchy_Life_Cycle

Hierarchy_Created_From_CSV

INFO

Hierarchy_Life_Cycle

Hierarchy_Deleted

INFO

Hierarchy_Life_Cycle

Hierarchy_Populated_From_CSV

INFO

Hierarchy_VC_Inventory_Change

Hierarchy_Updated

INFO

Hierarchy_VC_Inventory_Change

Hierarchy_Update_Failed

ERROR

License_Key

License_Key_Added

INFO

License_Key

License_Key_Deleted

INFO

Reporting_Life_Cycle

Reporting_Archive_Success

INFO

Reporting_Life_Cycle

Reporting_Archive_Failure

ERROR

Reporting_Life_Cycle

Reporting_Schedule_Success

INFO

Reporting_Life_Cycle

Reporting_Schedule_Failure

ERROR

Reporting_Life_Cycle

Reporting_ReSchedule_Success

INFO

Reporting_Life_Cycle

Reporting_ReSchedule_Failure

ERROR

Reporting_Life_Cycle

Reporting_Email_Success

INFO

Reporting_Life_Cycle

Reporting_Email_Failure

ERROR

Reporting_Life_Cycle

Reporting_Export_RTF_Success

INFO

Reporting_Life_Cycle

Reporting_Export_RTF_Failure

ERROR

Reporting_Life_Cycle

Reporting_Export_PDF_Success

INFO

Reporting_Life_Cycle

Reporting_Export_PDF_Failure

ERROR

Reporting_Life_Cycle

Reporting_Export_CSV_Success

INFO

Reporting_Life_Cycle

Reporting_Export_CSV_Failure

ERROR

Reporting_Life_Cycle

Reporting_Delete_Success

INFO

Reporting_Life_Cycle

Reporting_Delete_Failure

ERROR

Reporting_Life_Cycle

Reporting_DeleteSchedule_Success

INFO

Reporting_Life_Cycle

Reporting_DeleteSchedule_Failure

ERROR

Reporting_Life_Cycle

Reporting_ScheduleReportRun_Success

INFO

Reporting_Life_Cycle

Reporting_ScheduleReportRun_Failure

ERROR

Reporting_Life_Cycle

Reporting_TemplateConfigured_Success

INFO

Reporting_Life_Cycle

Reporting_TemplateConfigured_Failure

ERROR

Reporting_Life_Cycle

Reporting_ReportRunStart_Success

INFO

Reporting_Life_Cycle

Reporting_ReportRunStart_Failure

ERROR

Reporting_Life_Cycle

Reporting_ReportRunEnd_Success

INFO

Reporting_Life_Cycle

Reporting_ReportRunEnd_Failure

ERROR

Role_Life_Cycle

Role_Add_Success

INFO

Role_Life_Cycle

Role_Add_Failure

ERROR

Role_Life_Cycle

Role_Modify_Success

INFO

Role_Life_Cycle

Role_Modify_Failure

ERROR

Role_Life_Cycle

Role_Delete_Success

INFO

Role_Life_Cycle

Role_Delete_Failure

ERROR

Task_Life_Cycle

Task_Created

INFO

Task_Life_Cycle

Task_Started

INFO

Task_Life_Cycle

Task_Executed

INFO

Task_Life_Cycle

Task_Failed

INFO

Task_Life_Cycle

Task_Updated

INFO

Task_Life_Cycle

Task_Misfired

INFO

Task_Life_Cycle

Task_Deleted

INFO

Task_Life_Cycle

Task_Rescheduled

INFO

Tier_Life_Cycle

Tier_Created

INFO

Tier_Life_Cycle

Tier_Deleted

INFO

Tier_Life_Cycle

Tier_Modified

INFO

Tier_Resource_Life_Cycle

Tier_Resource_Added

INFO

Tier_Resource_Life_Cycle

Tier_Resource_Deleted

INFO

User_Life_Cycle

User_Add_Success

INFO

User_Life_Cycle

User_Add_Failure

ERROR

User_Life_Cycle

User_Modify_Success

INFO

User_Life_Cycle

User_Modify_Failure

ERROR

User_Life_Cycle

User_Delete_Success

INFO

User_Life_Cycle

User_Delete_Failure

ERROR

User_Permissions

SuperUser_Role_Add_Success

INFO

User_Permissions

SuperUser_Role_Add_Failure

ERROR

User_Permissions

SuperUser_Role_Delete_Success

INFO

User_Permissions

SuperUser_Role_Delete_Failure

ERROR

User_Permissions

User_Role_On_A_Hierarchy_Modify_Success

INFO

User_Permissions

User_Role_On_A_Hierarchy_Modify_Failure

ERROR

User_Permissions

User_Role_On_A_Hierarchy_Delete_Success

INFO

User_Permissions

User_Role_On_A_Hierarchy_Delete_Failure

ERROR

User_Permissions

User_Privilege_On_A_Entity_Modify_Success

INFO

User_Permissions

User_Privilege_On_A_Entity_Modify_Failure

ERROR

User_Permissions

User_Role_On_A_Resource_Modify_Success

INFO

User_Permissions

User_Role_On_A_Resource_Modify_Failure

ERROR

User_Permissions

User_Role_On_A_Resource_Delete_Success

INFO

User_Permissions

User_Role_On_A_Resource_Delete_Failure

ERROR

User_Session_Life_Cycle

User_Login_Success

INFO

User_Session_Life_Cycle

User_Login_Failure

ERROR

User_Session_Life_Cycle

User_Logout_Success

INFO

User_Session_Life_Cycle

User_Logout_Failure

ERROR

VC_Life_Cycle

VC_Added

INFO

VC_Life_Cycle

VC_Add_Failed

ERROR

VC_Life_Cycle

VC_Modified

INFO

VC_Life_Cycle

VC_Version_Modified

INFO

VC_Life_Cycle

VC_Modify_Failed

ERROR

VC_Life_Cycle

VC_Deleted

INFO

VC_Life_Cycle

VC_Delete_Failed

ERROR

VC_Life_Cycle

VC_SyncInterval_Modified

INFO

VC_Life_Cycle

VC_SyncInterval_Modify_Failed

ERROR