Event

An Event is an alarm raised by an external monitoring system and collected by a Cloudforet plugin.

Package : spaceone.api.monitoring.v1

Event

Event Methods:

Method	Request	Response
create	CreateEventRequest	google.protobuf.Empty
get	GetEventRequest	EventInfo
list	EventQuery	EventsInfo
stat	EventStatQuery	google.protobuf.Struct

create

POST /monitoring/v1/webhook/{webhook_id}/{access_key}/events

Creates a new Event. The Event creation process starts with validation checking whether the input data is from a webhook or not. After the input data is validated, the data is processed and used to create the Event.

Type	Message
Request	CreateEventRequest
Response	google.protobuf.Empty

get

GET /monitoring/v1/event/{event_id}

Gets a specific Event matching the input parameters, event_id and domain_id. Prints detailed information about the Event.

Type	Message
Request	GetEventRequest
Response	EventInfo

Request Example

{
    "event_id": "event-4e16ba3bd384",
    "domain_id": "domain-58010aa2e451"
}

Response Example

list

GET /monitoring/v1/events

POST /monitoring/v1/events/search

Gets a list of all Events. You must specify the domain_id. You can use a query to get a filtered list of Events.

Type	Message
Request	EventQuery
Response	EventsInfo

Request Example

{
    "query": {},
    "domain_id": "domain-58010aa2e451"
}

Response Example

stat

POST /monitoring/v1/events/stat

Type	Message
Request	EventStatQuery
Response	google.protobuf.Struct

Message

CreateEventRequest

Field	Type	Required	Description
webhook_id	string	✔
access_key	string	✔
data	google.protobuf.Struct	✔

EventInfo

Field	Type	Description
event_id	string
event_key	string
event_type	string
title	string
description	string
severity	string
rule	string
resource	EventResource
provider	string
account	string
image_url	string
raw_data	google.protobuf.Struct
additional_info	google.protobuf.Struct
alert_id	string
webhook_id	string
project_id	string
domain_id	string
created_at	string
occurred_at	string

EventQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
event_id	string	✘
event_key	string	✘
event_type	string	✘
severity	string	✘
resource_id	string	✘
provider	string	✘
account	string	✘
alert_id	string	✘
webhook_id	string	✘
project_id	string	✘
domain_id	string	✘

EventResource

Field	Type	Description
resource_id	string
resource_type	string
name	string

EventStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔

EventsInfo

Field	Type	Description
results	list of EventInfo
total_count	int32

GetEventRequest

Field	Type	Required	Description
event_id	string	✔
domain_id	string	✔
only	list of string	✘