Escalation Policy

An EscalationPolicy is a set of rules to deliver an alert to assigned members.

Package : spaceone.api.monitoring.v1

EscalationPolicy

EscalationPolicy Methods:

Method	Request	Response
create	CreateEscalationPolicyRequest	EscalationPolicyInfo
update	UpdateEscalationPolicyRequest	EscalationPolicyInfo
set_default	EscalationPolicyRequest	EscalationPolicyInfo
delete	EscalationPolicyRequest	google.protobuf.Empty
get	GetEscalationPolicyRequest	EscalationPolicyInfo
list	EscalationPolicyQuery	EscalationPoliciesInfo
stat	EscalationPolicyStatQuery	google.protobuf.Struct

create

POST /monitoring/v1/escalation-policies

Creates a new EscalationPolicy. When creating an EscalationPolicy, if the project_id is assigned, the EscalationPolicy is applied to the Project with the same project_id. If an EscalationPolicy is set as a global policy, all Projects in the same domain can apply the policy.

Type	Message
Request	CreateEscalationPolicyRequest
Response	EscalationPolicyInfo

Request Example

{
    "name": "es-test",
    "rules": [
        {
            "notification_level": "LV1",
            "escalate_minutes": 30
        },
        {
            "notification_level": "LV2",
            "escalate_minutes": 30
        }
    ],
    "repeat_count": 2,
    "finish_condition": "ACKNOWLEDGED",
    "domain_id": "domain-58010aa2e451"
}

Response Example

{
    "escalation_policy_id": "ep-526e536fdca9",
    "name": "es-test",
    "rules": [
        {
            "notification_level": "LV1",
            "escalate_minutes": 30
        },
        {
            "notification_level": "LV2",
            "escalate_minutes": 30
        }
    ],
    "repeat_count": 2,
    "finish_condition": "ACKNOWLEDGED",
    "scope": "GLOBAL",
    "tags": {},
    "domain_id": "domain-58010aa2e451",
    "created_at": "2022-06-21T09:22:45.340Z"
}

update

PUT /monitoring/v1/escalation-policy/{escalation_policy_id}

Updates a specific EscalationPolicy. You can make changes in EscalationPolicy settings, including the name, the escalation process, and the number of iterations.

Type	Message
Request	UpdateEscalationPolicyRequest
Response	EscalationPolicyInfo

Request Example

{
    "escalation_policy_id": "ep-526e536fdca9",
    "name": "es-test2",
    "rules": [
        {
            "notification_level": "LV1",
            "escalate_minutes": 15
        },
        {
            "notification_level": "LV2",
            "escalate_minutes": 15
        },
        {
            "notification_level": "LV3",
            "escalate_minutes": 15
        }
    ],
    "repeat_count": 1,
    "finish_condition": "RESOLVED",
    "domain_id": "domain-58010aa2e451"
}

Response Example

{
    "escalation_policy_id": "ep-526e536fdca9",
    "name": "es-test2",
    "rules": [
        {
            "notification_level": "LV1",
            "escalate_minutes": 15
        },
        {
            "notification_level": "LV2",
            "escalate_minutes": 15
        },
        {
            "notification_level": "LV3",
            "escalate_minutes": 15
        }
    ],
    "repeat_count": 1,
    "finish_condition": "RESOLVED",
    "scope": "GLOBAL",
    "tags": {},
    "domain_id": "domain-58010aa2e451",
    "created_at": "2022-06-21T09:22:45.340Z"
}

set_default

PUT /monitoring/v1/escalation-policy/{escalation_policy_id}/set-default

Sets a specific EscalationPolicy as default. Only policies configured as global can be set as default. When a Project is created, even if you did not configure any policy to the Project, the default policy set by this api method is applied.

Type	Message
Request	EscalationPolicyRequest
Response	EscalationPolicyInfo

Request Example

{
    "escalation_policy_id": "ep-526e536fdca9",
    "domain_id": "domain-58010aa2e451"
}

Response Example

{
    "escalation_policy_id": "ep-526e536fdca9",
    "name": "es-test2",
    "is_default": true,
    "rules": [
        {
            "notification_level": "LV1",
            "escalate_minutes": 15
        },
        {
            "notification_level": "LV2",
            "escalate_minutes": 15
        },
        {
            "notification_level": "LV3",
            "escalate_minutes": 15
        }
    ],
    "repeat_count": 1,
    "finish_condition": "RESOLVED",
    "scope": "GLOBAL",
    "tags": {},
    "domain_id": "domain-58010aa2e451",
    "created_at": "2022-06-21T09:22:45.340Z"
}

delete

DELETE /monitoring/v1/escalation-policy/{escalation_policy_id}

Deletes a specific EscalationPolicy. Deletes the EscalationPolicy with the escalation_policy_id from the deletion request.

Type	Message
Request	EscalationPolicyRequest
Response	google.protobuf.Empty

Request Example

{
    "escalation_policy_id": "ep-d75670166af4",
    "domain_id": "domain-58010aa2e451"
}

get

GET /monitoring/v1/escalation-policy/{escalation_policy_id}

Gets a specific EscalationPolicy. Prints detailed information about the EscalationPolicy, including the name, rules, and termination conditions.

Type	Message
Request	GetEscalationPolicyRequest
Response	EscalationPolicyInfo

Request Example

{
    "escalation_policy_id": "ep-d75670166af4",
    "domain_id": "domain-58010aa2e451"
}

Response Example

{
    "escalation_policy_id": "ep-d75670166af4",
    "name": "0525-ms-test-2",
    "rules": [
        {
            "notification_level": "LV2",
            "escalate_minutes": 30
        },
        {
            "notification_level": "LV2"
        }
    ],
    "finish_condition": "ACKNOWLEDGED",
    "scope": "GLOBAL",
    "tags": {},
    "domain_id": "domain-58010aa2e451",
    "created_at": "2022-05-25T09:31:38.573Z"
}

list

GET /monitoring/v1/escalation-policies

POST /monitoring/v1/escalation-policies/search

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

Type	Message
Request	EscalationPolicyQuery
Response	EscalationPoliciesInfo

Request Example

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

Response Example

{
    "results": [
        {
            "escalation_policy_id": "ep-7c9745003372",
            "name": "0525-ms-test-1",
            "rules": [
                {
                    "notification_level": "LV1"
                }
            ],
            "finish_condition": "ACKNOWLEDGED",
            "scope": "GLOBAL",
            "tags": {},
            "domain_id": "domain-58010aa2e451",
            "created_at": "2022-05-25T09:31:15.150Z"
        },
        {
            "escalation_policy_id": "ep-d75670166af4",
            "name": "0525-ms-test-2",
            "rules": [
                {
                    "notification_level": "LV2",
                    "escalate_minutes": 30
                },
                {
                    "notification_level": "LV2"
                }
            ],
            "finish_condition": "ACKNOWLEDGED",
            "scope": "GLOBAL",
            "tags": {},
            "domain_id": "domain-58010aa2e451",
            "created_at": "2022-05-25T09:31:38.573Z"
        }
    ],
    "total_count": 2
}

stat

POST /monitoring/v1/escalation-policies/stat

Type	Message
Request	EscalationPolicyStatQuery
Response	google.protobuf.Struct

Message

CreateEscalationPolicyRequest

Field	Type	Required	Description
name	string	✔
rules	list of EscalationPolicyRule	✔
repeat_count	int32	✘
finish_condition	NONE ACKNOWLEDGED RESOLVED	✘
project_id	string	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔

EscalationPoliciesInfo

Field	Type	Description
results	list of EscalationPolicyInfo
total_count	int32

EscalationPolicyInfo

Field	Type	Description
escalation_policy_id	string
name	string
is_default	bool
rules	list of EscalationPolicyRule
repeat_count	int32
finish_condition	NONE ACKNOWLEDGED RESOLVED
scope	SCOPE_NONE GLOBAL PROJECT
project_id	string
tags	google.protobuf.Struct
domain_id	string
created_at	string

EscalationPolicyQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
escalation_policy_id	string	✘
name	string	✘
is_default	bool	✘
finish_condition	NONE ACKNOWLEDGED RESOLVED	✘
scope	SCOPE_NONE GLOBAL PROJECT	✘
project_id	string	✘
domain_id	string	✔

EscalationPolicyRequest

Field	Type	Required	Description
escalation_policy_id	string	✔
domain_id	string	✔

EscalationPolicyRule

Field	Type	Description
notification_level	NONE ALL LV1 LV2 LV3 LV4 LV5
escalate_minutes	int32

EscalationPolicyStatQuery

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

GetEscalationPolicyRequest

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

UpdateEscalationPolicyRequest

Field	Type	Required	Description
escalation_policy_id	string	✔
name	string	✘
rules	list of EscalationPolicyRule	✘
repeat_count	int32	✘
finish_condition	NONE ACKNOWLEDGED RESOLVED	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔