Alert

An Alert, a set of Events, is the smallest unit to manage incidents.

Package : spaceone.api.monitoring.v1

Alert

Alert Methods:

Method	Request	Response
create	CreateAlertRequest	AlertInfo
update	UpdateAlertRequest	AlertInfo
update_state	UpdateAlertStateRequest	AlertInfo
merge	MergeAlertRequest	AlertInfo
snooze	SnoozeAlertRequest	AlertInfo
add_responder	AlertResponderRequest	AlertInfo
remove_responder	AlertResponderRequest	AlertInfo
add_project_dependency	AlertProjectDependencyRequest	AlertInfo
remove_project_dependency	AlertProjectDependencyRequest	AlertInfo
delete	AlertRequest	google.protobuf.Empty
get	GetAlertRequest	AlertInfo
list	AlertQuery	AlertsInfo
stat	AlertStatQuery	google.protobuf.Struct

create

POST /monitoring/v1/alerts

Creates a new Alert. Alerts generated with create method are made in a manual way. Manually made Alerts can be used for Notifications.

Type	Message
Request	CreateAlertRequest
Response	AlertInfo

Request Example

{
    "title": "sample test",
    "description": "This is a description of sample.",
    "urgency": "HIGH",
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "alert_number": 104053,
    "alert_id": "alert-123456789012",
    "title": "sample test",
    "state": "TRIGGERED",
    "description": "This is a description of sample.",
    "urgency": "HIGH",
    "severity": "NONE",
    "escalation_step": 1,
    "additional_info": {},
    "triggered_by": "[e-mail]",
    "escalation_policy_id": "ep-123456789012",
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T01:43:08.566Z",
    "updated_at": "2022-01-01T01:43:08.566Z",
    "escalated_at": "2022-01-01T01:43:54.464Z"
}

update

PUT /monitoring/v1/alert/{alert_id}

Updates a specific Alert. You can make changes in Alert settings, including the title, description, responder, state, and urgency. The responder of the Alert is a User who is assigned to respond to the Alert.

Type	Message
Request	UpdateAlertRequest
Response	AlertInfo

Request Example

{
    "alert_id": "alert-123456789012",
    "state": "ACKNOWLEDGED",
    "urgency": "LOW",
    "description": "[updating]This is a description of sample.",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "alert_number": 104053,
    "alert_id": "alert-123456789012",
    "title": "sample test",
    "state": "ACKNOWLEDGED",
    "description": "[updating]This is a description of sample. ",
    "urgency": "LOW",
    "severity": "NONE",
    "escalation_step": 1,
    "additional_info": {},
    "triggered_by": "[e-mail]",
    "escalation_policy_id": "ep-123456789012",
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T01:43:08.566Z",
    "updated_at": "2022-01-01T01:43:08.566Z",
    "acknowledged_at": "2022-01-01T01:48:52.799Z",
    "escalated_at": "2022-01-01T01:43:54.464Z"
}

update_state

POST /monitoring/v1/alert/{alert_id}/{access_key}/{state}

Type	Message
Request	UpdateAlertStateRequest
Response	AlertInfo

merge

POST /monitoring/v1/alerts/merge

Type	Message
Request	MergeAlertRequest
Response	AlertInfo

snooze

POST /monitoring/v1/alert/{alert_id}/snooze

Type	Message
Request	SnoozeAlertRequest
Response	AlertInfo

add_responder

POST /monitoring/v1/alert/{alert_id}/responders

Adds a responder who receives a Notification about an Alert.

Type	Message
Request	AlertResponderRequest
Response	AlertInfo

Request Example

{
    "alert_id": "alert-123456789012",
    "resource_type": "identity.User",
    "resource_id": "[e-mail]",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "alert_number": 104053,
    "alert_id": "alert-123456789012",
    "title": "sample test",
    "state": "ACKNOWLEDGED",
    "description": "[updating]This is a description of sample. ",
    "urgency": "LOW",
    "severity": "NONE",
    "escalation_step": 1,
    "responders": [
        {
            "resource_type": "identity.User",
            "resource_id": "[e-mail]"
        }
    ],
    "additional_info": {},
    "triggered_by": "[e-mail]",
    "escalation_policy_id": "ep-123456789012",
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T01:43:08.566Z",
    "updated_at": "2022-01-01T01:43:08.566Z",
    "acknowledged_at": "2022-01-01T02:24:12.051Z",
    "escalated_at": "2022-01-01T01:43:54.464Z"
}

remove_responder

DELETE /monitoring/v1/alert/{alert_id}/responders

Deletes a responder who receives a Notification about an Alert.

Type	Message
Request	AlertResponderRequest
Response	AlertInfo

Request Example

{
    "alert_id": "alert-123456789012",
    "resource_type": "identity.User",
    "resource_id": "[e-mail]",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "alert_number": 104053,
    "alert_id": "alert-123456789012",
    "title": "sample test",
    "state": "ACKNOWLEDGED",
    "description": "[updating]This is a description of sample. ",
    "urgency": "LOW",
    "severity": "NONE",
    "escalation_step": 1,
    "additional_info": {},
    "triggered_by": "[e-mail]",
    "escalation_policy_id": "ep-123456789012",
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T01:43:08.566Z",
    "updated_at": "2022-01-01T01:43:08.566Z",
    "acknowledged_at": "2022-01-01T01:48:52.799Z",
    "escalated_at": "2022-01-01T01:43:54.464Z"
}

add_project_dependency

POST /monitoring/v1/alert/{alert_id}/project-dependencies

Type	Message
Request	AlertProjectDependencyRequest
Response	AlertInfo

remove_project_dependency

DELETE /monitoring/v1/alert/{alert_id}/project-dependency/{project_id}

Type	Message
Request	AlertProjectDependencyRequest
Response	AlertInfo

delete

DELETE /monitoring/v1/alert/{alert_id}

Deletes a specific Alert and remove it from the list of Alerts. You must specify the alert_id of the Alert to delete.

Type	Message
Request	AlertRequest
Response	google.protobuf.Empty

Request Example

{
    "alert_id": "alert-123456789012",
    "domain_id": "domain-123456789012"
}

get

GET /monitoring/v1/alert/{alert_id}

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

Type	Message
Request	GetAlertRequest
Response	AlertInfo

Request Example

{
    "alert_id": "alert-123456789012",
    "domain_id": "domain-123456789012"
}

Response Example

{
    "alert_number": 104053,
    "alert_id": "alert-123456789012",
    "title": "sample test",
    "state": "ACKNOWLEDGED",
    "description": "[updating]This is a description of sample. ",
    "urgency": "LOW",
    "severity": "NONE",
    "escalation_step": 1,
    "additional_info": {},
    "triggered_by": "[e-mail]",
    "escalation_policy_id": "ep-123456789012",
    "project_id": "project-123456789012",
    "domain_id": "domain-123456789012",
    "created_at": "2022-01-01T01:43:08.566Z",
    "updated_at": "2022-01-01T01:43:08.566Z",
    "acknowledged_at": "2022-01-01T01:48:52.799Z",
    "escalated_at": "2022-01-01T01:43:54.464Z"
}

list

GET /monitoring/v1/alerts

POST /monitoring/v1/alerts/search

Gets a list of all Alerts. You can use a query to get a filtered list of Alerts.

Type	Message
Request	AlertQuery
Response	AlertsInfo

Request Example

{
    "query": {},
    "domain_id": "domain-123456789012"
}

Response Example

{
    "results": [
        {
            "alert_number": 104057,
            "alert_id": "alert-987654321098",
            "title": "Notification of access to the bastion Host",
            "state": "TRIGGERED",
            "description": "SSH Access to stargate-dev from adm",
            "urgency": "LOW",
            "severity": "INFO",
            "resource": {
                "resource_id": "server-123456789012",
                "resource_type": "inventory.Server",
                "name": "stargate-dev"
            },
            "escalation_step": 1,
            "escalation_ttl": 1,
            "additional_info": {
                "host": "[]",
                "user": "user1"
            },
            "triggered_by": "webhook-123456789012",
            "webhook_id": "webhook-123456789012",
            "escalation_policy_id": "ep-123456789012",
            "project_id": "project-123456789012",
            "domain_id": "domain-123456789012",
            "created_at": "2022-01-01T02:46:35.934Z",
            "updated_at": "2022-01-01T02:46:35.934Z",
            "escalated_at": "2022-01-01T02:46:35.979Z"
        },
        {
            "alert_number": 104056,
            "alert_id": "alert-123456789999",
            "title": "Notification of access to the bastion Host",
            "state": "TRIGGERED",
            "description": "SSH Access to stargate-dev from [e-mail]",
            "urgency": "LOW",
            "severity": "INFO",
            "resource": {
                "resource_id": "server-123456789012",
                "resource_type": "inventory.Server",
                "name": "stargate-dev"
            },
            "escalation_step": 1,
            "escalation_ttl": 1,
            "additional_info": {
                "user": "[e-mail]",
                "host": "['111.111.111.11']"
            },
            "triggered_by": "webhook-123456789012",
            "webhook_id": "webhook-123456789012",
            "escalation_policy_id": "ep-123456789012",
            "project_id": "project-123456789012",
            "domain_id": "domain-123456789012",
            "created_at": "2022-01-01T02:46:31.391Z",
            "updated_at": "2022-01-01T02:46:31.391Z",
            "escalated_at": "2022-01-01T02:46:31.553Z"
        }
    ],
    "total_count": 21283
}

stat

POST /monitoring/v1/alerts/stat

Type	Message
Request	AlertStatQuery
Response	google.protobuf.Struct

Message

AlertInfo

Field	Type	Description
alert_number	int32
alert_id	string
title	string
state	ALERT_STATE_NONE TRIGGERED ACKNOWLEDGED RESOLVED ERROR
status_message	string
description	string
assignee	string
urgency	ALERT_URGENCY_NONE HIGH LOW
severity	string
rule	string
resource	AlertResource
provider	string
account	string
is_snoozed	bool
snoozed_end_time	string
escalation_step	int32
escalation_ttl	int32
responders	list of AlertResponder
project_dependencies	list of string
image_url	string
additional_info	google.protobuf.Struct
triggered_by	string
webhook_id	string
escalation_policy_id	string
project_id	string
domain_id	string
created_at	string
updated_at	string
acknowledged_at	string
resolved_at	string
escalated_at	string

AlertProjectDependencyRequest

Field	Type	Required	Description
alert_id	string	✔
project_id	string	✔
domain_id	string	✔

AlertQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
alert_number	int32	✘
alert_id	string	✘
title	string	✘
state	ALERT_STATE_NONE TRIGGERED ACKNOWLEDGED RESOLVED ERROR	✘
assignee	string	✘
urgency	ALERT_URGENCY_NONE HIGH LOW	✘
severity	string	✘
is_snoozed	string	✘
resource_id	string	✘
provider	string	✘
account	string	✘
triggered_by	string	✘
webhook_id	string	✘
escalation_policy_id	string	✘
project_id	string	✘
domain_id	string	✔

AlertRequest

Field	Type	Required	Description
alert_id	string	✔
domain_id	string	✔

AlertResource

Field	Type	Description
resource_id	string
resource_type	string
name	string

AlertResponder

Field	Type	Description
resource_type	string
resource_id	string

AlertResponderRequest

Field	Type	Required	Description
alert_id	string	✔
resource_type	string	✔
resource_id	string	✔
domain_id	string	✔

AlertStatQuery

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

AlertsInfo

Field	Type	Description
results	list of AlertInfo
total_count	int32

CreateAlertRequest

Field	Type	Required	Description
title	string	✔
description	string	✘
assignee	string	✘
urgency	ALERT_URGENCY_NONE HIGH LOW	✘
project_id	string	✔
domain_id	string	✔

GetAlertRequest

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

MergeAlertRequest

Field	Type	Required	Description
alerts	list of string	✔
merge_to	string	✔
domain_id	string	✔

SnoozeAlertRequest

Field	Type	Required	Description
alert_id	string	✔
end_time	string	✔
domain_id	string	✔

UpdateAlertRequest

Field	Type	Required	Description
alert_id	string	✔
title	string	✘
state	string	✘
status_message	string	✘
description	string	✘
assignee	string	✘
urgency	ALERT_URGENCY_NONE HIGH LOW	✘
project_id	string	✘
reset_status_message	bool	✘
reset_description	bool	✘
reset_assignee	bool	✘
domain_id	string	✔

UpdateAlertStateRequest

Field	Type	Required	Description
alert_id	string	✔
access_key	string	✔
state	string	✘