Event Rule

An EventRule is a rule to transform the request data when an Event is generated.

Package : spaceone.api.monitoring.v1

EventRule

EventRule Methods:

Method	Request	Response
create	CreateEventRuleRequest	EventRuleInfo
update	UpdateEventRuleRequest	EventRuleInfo
change_order	ChangeEventRuleOrderRequest	EventRuleInfo
delete	EventRuleRequest	google.protobuf.Empty
get	GetEventRuleRequest	EventRuleInfo
list	EventRuleQuery	EventRulesInfo
stat	EventRuleStatQuery	google.protobuf.Struct

create

POST /monitoring/v1/event-rules

Type	Message
Request	CreateEventRuleRequest
Response	EventRuleInfo

update

PUT /monitoring/v1/event-rule/{event_rule_id}

Changes a priority order between EventRules to apply. EventRules are filtered by the order configured.

Type	Message
Request	UpdateEventRuleRequest
Response	EventRuleInfo

Request Example

{
    "event_rule_id": "er-123456789012",
    "conditions": [
        {
            "key": "description",
            "value": "ELB",
            "operator": "contain"
        }
    ],
    "conditions_policy": "ALL",
    "actions": {
        "change_assignee": "[e-mail]",
        "change_urgency": "HIGH",
        "change_project": "project-123456789012",
        "add_additional_info": {
            "type": "personal rule"
        },
        "no_notification": true
    },
    "options": {},
    "domain_id": "domain-123456789012"
}

Response Example

{
    "event_rule_id": "er-123456789012",
    "order": 2,
    "conditions": [
        {
            "key": "description",
            "value": "ELB",
            "operator": "contain"
        }
    ],
    "conditions_policy": "ALL",
    "actions": {
        "change_assignee": "[e-mail]",
        "change_urgency": "HIGH",
        "change_project": "project-123456789012",
        "add_additional_info": {
            "type": "personal rule"
        },
        "no_notification": true
    },
    "options": {},
    "scope": "PROJECT",
    "project_id": "project-123456789012",
    "tags": {},
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T06:02:31.517Z"
}

change_order

PUT /monitoring/v1/event-rule/{event_rule_id}/order

Updates a specific EventRule. You can make changes in EventRule settings.

Type	Message
Request	ChangeEventRuleOrderRequest
Response	EventRuleInfo

Request Example

{
    "event_rule_id": "er-123456789012",
    "order": 2,
    "domain_id": "domain-123456789012"
}

Response Example

{
    "event_rule_id": "er-123456789012",
    "order": 2,
    "conditions": [
        {
            "key": "description",
            "value": "API",
            "operator": "contain"
        }
    ],
    "conditions_policy": "ALL",
    "actions": {
        "change_assignee": "[e-mail]",
        "change_urgency": "LOW",
        "change_project": "project-123456789012",
        "add_additional_info": {
            "type": "personal rule"
        },
        "no_notification": true
    },
    "options": {},
    "scope": "PROJECT",
    "project_id": "project-123456789012",
    "tags": {},
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-02T06:02:31.517Z"
}

delete

DELETE /monitoring/v1/event-rule/{event_rule_id}

Deletes a specific EventRule. You must assign an EventRule resource to delete by specifying event_rule_id.

Type	Message
Request	EventRuleRequest
Response	google.protobuf.Empty

Request Example

{
    "event_rule_id": "er-123456789012",
    "domain_id": "domain-123456789012"
}

get

GET /monitoring/v1/event-rule/{event_rule_id}

Gets a specific EventRule. Prints detailed information about the EventRule.

Type	Message
Request	GetEventRuleRequest
Response	EventRuleInfo

Request Example

{
    "event_rule_id": "er-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "event_rule_id": "er-123456789012",
    "order": 2,
    "conditions": [
        {
            "key": "title",
            "value": "ELB",
            "operator": "contain"
        }
    ],
    "conditions_policy": "ALL",
    "actions": {
        "change_assignee": "[e-mail]",
        "change_urgency": "LOW",
        "change_project": "project-123456789012",
        "add_additional_info": {},
        "no_notification": true
    },
    "options": {},
    "scope": "PROJECT",
    "project_id": "project-123456789012",
    "tags": {},
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T06:12:30.226Z"
}

list

GET /monitoring/v1/event-rules

POST /monitoring/v1/event-rules/search

Gets a list of all EventRules. You can use a query to get a filtered list of EventRules. For example, you can adjust the scope of the list to a certain Project or Domain.

Type	Message
Request	EventRuleQuery
Response	EventRulesInfo

Request Example

{
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "results": [
        {
            "event_rule_id": "er-123456789012",
            "order": 1,
            "conditions": [
                {
                    "key": "title",
                    "value": "AWS",
                    "operator": "contain"
                }
            ],
            "conditions_policy": "ALL",
            "actions": {
                "change_assignee": "[e-mail]",
                "change_urgency": "HIGH",
                "add_additional_info": {},
                "no_notification": true
            },
            "options": {},
            "scope": "PROJECT",
            "project_id": "project-123456789012",
            "tags": {},
            "domain_id": "domain-123456789012",
            "created_at": "2022-01-01T06:33:58.388Z"
        },
        {
            "event_rule_id": "er-123456789012",
            "order": 2,
            "conditions": [
                {
                    "key": "title",
                    "value": "ELB",
                    "operator": "contain"
                }
            ],
            "conditions_policy": "ALL",
            "actions": {
                "change_assignee": "[e-mail]",
                "change_urgency": "LOW",
                "change_project": "project-123456789012",
                "add_additional_info": {},
                "no_notification": true
            },
            "options": {},
            "scope": "PROJECT",
            "project_id": "project-123456789012",
            "tags": {},
            "domain_id": "domain-123456789012",
            "created_at": "2022-01-01T06:12:30.226Z"
        }
    ],
    "total_count": 2
}

stat

POST /monitoring/v1/event-rules/stat

Type	Message
Request	EventRuleStatQuery
Response	google.protobuf.Struct

Message

ChangeEventRuleOrderRequest

Field	Type	Required	Description
event_rule_id	string	✔
order	int32	✔
domain_id	string	✔

CreateEventRuleRequest

Field	Type	Required	Description
name	string	✔
conditions	list of EventRuleCondition	✔
conditions_policy	NONE ALL ANY ALWAYS	✔
actions	EventRuleActions	✔
options	EventRuleOptions	✘
project_id	string	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔

EventRuleActionResponder

Field	Type	Description
resource_type	string
resource_id	string

EventRuleActions

Field	Type	Description
change_assignee	string
change_urgency	string
change_project	string
add_project_dependency	list of string
add_responder	list of EventRuleActionResponder
match_service_account	MatchRule
add_additional_info	google.protobuf.Struct
no_notification	bool

EventRuleCondition

Field	Type	Description
key	string
value	string
operator	string

EventRuleInfo

Field	Type	Description
event_rule_id	string
name	string
order	int32
conditions	list of EventRuleCondition
conditions_policy	NONE ALL ANY ALWAYS
actions	EventRuleActions
options	EventRuleOptions
scope	SCOPE_NONE GLOBAL PROJECT
project_id	string
tags	google.protobuf.Struct
domain_id	string
created_at	string

EventRuleOptions

Field	Type	Description
stop_processing	bool

EventRuleQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
event_rule_id	string	✘
name	string	✘
scope	SCOPE_NONE GLOBAL PROJECT	✘
project_id	string	✘
domain_id	string	✔

EventRuleRequest

Field	Type	Required	Description
event_rule_id	string	✔
domain_id	string	✔

EventRuleStatQuery

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

EventRulesInfo

Field	Type	Description
results	list of EventRuleInfo
total_count	int32

GetEventRuleRequest

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

MatchRule

Field	Type	Description
source	string
target	string

UpdateEventRuleRequest

Field	Type	Required	Description
event_rule_id	string	✔
name	string	✘
conditions	list of EventRuleCondition	✘
conditions_policy	NONE ALL ANY ALWAYS	✘
actions	EventRuleActions	✘
options	EventRuleOptions	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔