Project Alert Config

A ProjectAlertConfig is a resource to set the alert policies for a Project.

Package : spaceone.api.monitoring.v1

ProjectAlertConfig

ProjectAlertConfig Methods:

Method	Request	Response
create	CreateProjectAlertConfigRequest	ProjectAlertConfigInfo
update	UpdateProjectAlertConfigRequest	ProjectAlertConfigInfo
delete	ProjectAlertConfigRequest	google.protobuf.Empty
get	GetProjectAlertConfigRequest	ProjectAlertConfigInfo
list	ProjectAlertConfigQuery	ProjectAlertConfigsInfo
stat	ProjectAlertConfigStatQuery	google.protobuf.Struct

create

POST /monitoring/v1/project-alert-configs

Creates a new ProjectAlertConfig in a specific Project. When creating a ProjectAlertConfig, validation of the Project is preceded. After the validation is done, ProjectAlertConfig enables EscalationPolicy to be set in the Project, or enables enum type recovery_mode and notification_urgency to be set through the options parameter. The parameter recovery_mode is for changing the state of the Alert to resolved if the external monitoring solution sends the resolved Alert. The parameter notification_urgency is used to choose whether you will get all Alerts or only urgent ones.

Type	Message
Request	CreateProjectAlertConfigRequest
Response	ProjectAlertConfigInfo

Request Example

{
    "project_id": "project-dee2a81d4859",
    "escalation_policy_id": "ep-b441abe04ca9",
    "options": {
        "notification_urgency": "ALL",
        "recovery_mode": "AUTO"
    },
    "domain_id": "domain-58010aa2e451"
}

Response Example

{
    "project_id": "project-dee2a81d4859",
    "options": {
        "notification_urgency": "ALL",
        "recovery_mode": "AUTO"
    },
    "escalation_policy_info": {
        "escalation_policy_id": "ep-b441abe04ca9",
        "name": "Global New Policy"
    },
    "domain_id": "domain-58010aa2e451",
    "created_at": "2022-06-27T05:12:22.998Z"
}

update

PUT /monitoring/v1/project-alert-config/{project_alert_config_id}

Updates a specific ProjectAlertConfig. You can make changes in ProjectAlertConfig settings, including the EscalationPolicy to apply. You can also change notification_urgency and recovery_mode by modifying the options parameter.

Type	Message
Request	UpdateProjectAlertConfigRequest
Response	ProjectAlertConfigInfo

Request Example

{
    "project_id": "project-dee2a81d4859",
    "escalation_policy_id": "ep-4ee42a9b2d96",
    "options": {
        "notification_urgency": "ALL",
        "recovery_mode": "MANUAL"
    },
    "domain_id": "domain-58010aa2e451"
}

Response Example

{
    "project_id": "project-dee2a81d4859",
    "options": {
        "notification_urgency": "ALL",
        "recovery_mode": "MANUAL"
    },
    "escalation_policy_info": {
        "escalation_policy_id": "ep-4ee42a9b2d96",
        "name": "HAHA",
        "is_default": true
    },
    "domain_id": "domain-58010aa2e451",
    "created_at": "2022-06-27T05:15:02.697Z"
}

delete

DELETE /monitoring/v1/project-alert-config/{project_alert_config_id}

Deletes a specific ProjectAlertConfig. Deletes alert configuration data in a Project.

Type	Message
Request	ProjectAlertConfigRequest
Response	google.protobuf.Empty

Request Example

{
    "project_id": "project-dee2a81d4859",
    "domain_id": "domain-58010aa2e451"
}

get

GET /monitoring/v1/project-alert-config/{project_alert_config_id}

Gets a specific ProjectAlertConfig. Prints detailed information about the ProjectAlertConfig, including EscalationPolicy, recovery mode, and notification urgency.

Type	Message
Request	GetProjectAlertConfigRequest
Response	ProjectAlertConfigInfo

Request Example

{
    "project_id": "project-430bf6ab1e6d",
    "domain_id": "domain-58010aa2e451"
}

Response Example

{
    "project_id": "project-430bf6ab1e6d",
    "options": {
        "notification_urgency": "ALL",
        "recovery_mode": "AUTO"
    },
    "escalation_policy_info": {
        "escalation_policy_id": "ep-4ee42a9b2d96",
        "name": "HAHA",
        "is_default": true
    },
    "domain_id": "domain-58010aa2e451",
    "created_at": "2022-05-03T08:17:11.715Z"
}

list

GET /monitoring/v1/project-alert-configs

POST /monitoring/v1/project-alert-configs/search

Gets a list of all ProjectAlertConfigs from all projects configured in the same domain. You can use a query to get a filtered list of ProjectAlertConfigs.

Type	Message
Request	ProjectAlertConfigQuery
Response	ProjectAlertConfigsInfo

Request Example

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

Response Example

{
    "results": [
        {
            "project_id": "project-18655561c535",
            "options": {
                "notification_urgency": "ALL",
                "recovery_mode": "MANUAL"
            },
            "escalation_policy_info": {
                "escalation_policy_id": "ep-4ee42a9b2d96",
                "name": "HAHA",
                "is_default": true
            },
            "domain_id": "domain-58010aa2e451",
            "created_at": "2022-05-17T02:09:19.839Z"
        },
        {
            "project_id": "project-9074eea97d7e",
            "options": {
                "notification_urgency": "ALL",
                "recovery_mode": "MANUAL"
            },
            "escalation_policy_info": {
                "escalation_policy_id": "ep-b441abe04ca9",
                "name": "Global New Policy"
            },
            "domain_id": "domain-58010aa2e451",
            "created_at": "2021-06-24T02:50:50.535Z"
        }
    ],
    "total_count": 2
}

stat

POST /monitoring/v1/project-alert-configs/stat

Type	Message
Request	ProjectAlertConfigStatQuery
Response	google.protobuf.Struct

Message

AlertOptions

Field	Type	Description
notification_urgency	URGENCY_NONE ALL HIGH_ONLY
recovery_mode	RECOVERY_NONE AUTO MANUAL

CreateProjectAlertConfigRequest

Field	Type	Required	Description
project_id	string	✔
escalation_policy_id	string	✘
options	AlertOptions	✘
domain_id	string	✔

GetProjectAlertConfigRequest

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

ProjectAlertConfigInfo

Field	Type	Description
project_id	string
options	AlertOptions
escalation_policy_info	EscalationPolicyInfo
domain_id	string
created_at	string

ProjectAlertConfigQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
project_id	string	✘
escalation_policy_id	string	✘
domain_id	string	✔

ProjectAlertConfigRequest

Field	Type	Required	Description
project_id	string	✔
domain_id	string	✔

ProjectAlertConfigStatQuery

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

ProjectAlertConfigsInfo

Field	Type	Description
results	list of ProjectAlertConfigInfo
total_count	int32

UpdateProjectAlertConfigRequest

Field	Type	Required	Description
project_id	string	✔
escalation_policy_id	string	✘
options	AlertOptions	✘
domain_id	string	✔