ProjectAlertConfig
A ProjectAlertConfig is a resource to set the alert policies for a Project.
Package : spaceone.api.monitoring.v1
ProjectAlertConfig
ProjectAlertConfig Methods:
create
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.
POST /monitoring/v1/project-alert-config/create
{{< tabs " create " >}}
{{< tab "Request Example" >}}
project_id (string)
Requiredescalation_policy_id (string)
options (AlertOptions)
{{< highlight json >}} { "project_id": "project-dee2a81d4859", "escalation_policy_id": "ep-b441abe04ca9", "options": { "notification_urgency": "ALL", "recovery_mode": "AUTO" }, "domain_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}
{{< tab "Response Example" >}}
project_id (string)
Requiredoptions (AlertOptions)
Requiredescalation_policy_info (EscalationPolicyInfo)
Requireddomain_id (string)
Requiredworkspace_id (string)
Requiredcreated_at (string)
Required
{{< highlight json >}} { "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" } {{< /highlight >}} {{< /tab >}}
{{< /tabs >}}
update
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.
POST /monitoring/v1/project-alert-config/update
{{< tabs " update " >}}
{{< tab "Request Example" >}}
project_id (string)
Requiredescalation_policy_id (string)
options (AlertOptions)
{{< highlight json >}} { "project_id": "project-dee2a81d4859", "escalation_policy_id": "ep-4ee42a9b2d96", "options": { "notification_urgency": "ALL", "recovery_mode": "MANUAL" }, "domain_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}
{{< tab "Response Example" >}}
project_id (string)
Requiredoptions (AlertOptions)
Requiredescalation_policy_info (EscalationPolicyInfo)
Requireddomain_id (string)
Requiredworkspace_id (string)
Requiredcreated_at (string)
Required
{{< highlight json >}} { "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" } {{< /highlight >}} {{< /tab >}}
{{< /tabs >}}
delete
Deletes a specific ProjectAlertConfig. Deletes alert configuration data in a Project.
POST /monitoring/v1/project-alert-config/delete
{{< tabs " delete " >}}
{{< tab "Request Example" >}}
project_id (string)
Required
{{< highlight json >}} { "project_id": "project-dee2a81d4859", "domain_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}
{{< /tabs >}}
get
Gets a specific ProjectAlertConfig. Prints detailed information about the ProjectAlertConfig, including EscalationPolicy, recovery mode, and notification urgency.
POST /monitoring/v1/project-alert-config/get
{{< tabs " get " >}}
{{< tab "Request Example" >}}
project_id (string)
Required
{{< highlight json >}} { "project_id": "project-dee2a81d4859", "domain_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}
{{< tab "Response Example" >}}
project_id (string)
Requiredoptions (AlertOptions)
Requiredescalation_policy_info (EscalationPolicyInfo)
Requireddomain_id (string)
Requiredworkspace_id (string)
Requiredcreated_at (string)
Required
{{< highlight json >}} { "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" } {{< /highlight >}} {{< /tab >}}
{{< /tabs >}}
list
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.
POST /monitoring/v1/project-alert-config/list
{{< tabs " list " >}}
{{< tab "Request Example" >}}
query (Query)
project_id (string)
escalation_policy_id (string)
{{< highlight json >}} { "query": {}, "domain_id": "domain-58010aa2e451" } {{< /highlight >}} {{< /tab >}}
{{< tab "Response Example" >}}
results (ProjectAlertConfigInfo)
RepeatedRequiredtotal_count (int32)
Required
{{< highlight json >}} { "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 } {{< /highlight >}} {{< /tab >}}
{{< /tabs >}}
stat
POST /monitoring/v1/project-alert-config/stat
Message
AlertOptions
notification_urgency (UrgencyOption)
Requiredrecovery_mode (RecoveryOption)
Required
CreateProjectAlertConfigRequest
project_id (string)
Requiredescalation_policy_id (string)
options (AlertOptions)
ProjectAlertConfigInfo
project_id (string)
Requiredoptions (AlertOptions)
Requiredescalation_policy_info (EscalationPolicyInfo)
Requireddomain_id (string)
Requiredworkspace_id (string)
Requiredcreated_at (string)
Required
ProjectAlertConfigQuery
query (Query)
project_id (string)
escalation_policy_id (string)
ProjectAlertConfigRequest
project_id (string)
Required
ProjectAlertConfigStatQuery
query (StatisticsQuery)
Required
ProjectAlertConfigsInfo
results (ProjectAlertConfigInfo)
RepeatedRequiredtotal_count (int32)
Required
UpdateProjectAlertConfigRequest
project_id (string)
Requiredescalation_policy_id (string)
options (AlertOptions)
Last updated