Create v2¶

POST /api/v1/alert_policy/add_v2

Overview¶

Create an alert policy, v2 supports synchronous update of associated monitors/intelligent monitors/intelligent inspections/slo, security monitoring.

Body Request Parameters¶

Parameter Additional Notes¶

Data Description.

1. alertOpt Parameter Description

1.1 alertOpt.aggType Parameter Description 2024-12-25
Alert aggregation type:
　null: no aggregation
　byFields: rule aggregation
　byCluster: intelligent aggregation
　byAI: AI aggregation

In the old version data structure, since there is no aggType field, but the aggregation type is determined by the aggFields content, therefore, after adding the aggType field, it will be compatible in the following way:
When aggType is specified, aggregate according to the aggregation method specified by aggType
When aggType is not specified or aggType=None (follow old version logic)
When aggFields contains "CLUSTER", aggregate according to intelligent aggregation method
When aggFields does not contain "CLUSTER", aggregate according to rule aggregation method

Derived rules: Specifying aggInterval=0 or aggInterval=null still means "no aggregation"
When specifying aggType="byCluster", "CLUSTER" can no longer be passed in aggFields (whether passed or not does not affect)
When specifying aggType="byFields", but aggFields contains "CLUSTER", "CLUSTER" will be ignored (i.e., aggType has higher priority)

2. When the alert policy is of type level, alertOpt.alertTarget Parameter Description

key	Type	Required	Description
name	string		Configuration name
targets	Array[dict]	Required	Notification object configuration (note the position of this field when the alert policy is of type level/member)
crontab	String		When selecting a repeated time period, start Crontab (Crontab syntax)
crontabDuration	integer		When selecting a repeated time, from Crontab start, duration (seconds)
customDateUUIDs	Array[String]		When selecting a custom time, custom notification date UUID list, example: ['ndate_xxxx32', 'ndate_xxxx32'], custom notification date reference (monitoring - alert policy - custom notification date, interface)
customStartTime	String		When selecting a custom time, daily start time, format: HHss
customDuration	integer		When selecting a custom time period, from customStartTime custom start time, duration (seconds)

3. When the alert policy is of type member, alertOpt.alertTarget Parameter Description

key	Type	Required	Description
name	string		Configuration name
crontab	String		When selecting a repeated time period, start Crontab (Crontab syntax)
crontabDuration	integer		When selecting a repeated time, from Crontab start, duration (seconds)
customDateUUIDs	Array[String]		When selecting a custom time, custom notification date UUID list, example: ['ndate_xxxx32', 'ndate_xxxx32'], custom notification date reference (monitoring - alert policy - custom notification date, interface)
customStartTime	String		When selecting a custom time, daily start time, format: HHss
customDuration	integer		When selecting a custom time period, from customStartTime custom start time, duration (seconds)
alertInfo	Array[dict]	Required	When the alert policy is of type member, notification related information configuration 2024-11-27 iteration added

4. When the alert policy is of type member, alertOpt.alertTarget.alertInfo Parameter Description

5. Time Configuration Related Notes

If selecting a repeated time period, crontab, crontabDuration fields are required parameters
If selecting a custom time period, customDateUUIDs, customDuration, customStartTime fields are required parameters
If selecting other times, crontab, crontabDuration, customDateUUIDs, customStartTime, customDuration are not required
Note: Each alert policy will have a notification rule for other times, i.e., those without time configuration are the fallback notification objects

6. Notification Object Field targets Description
When alertType is status, targets position alertOpt.alertTarget.targets
When alertType is member, targets position alertOpt.alertTarget.alertInfo.targets

targets is a list, internal elements are dict, internal field descriptions are as follows:

7. Notification Object Field upgradeTargets Description

  <br/>

When alertType is status, targets position alertOpt.alertTarget.targets.upgradeTargets
When alertType is member, targets position alertOpt.alertTarget.alertInfo.targets.upgradeTargets

7.1 upgradeTargets is a list, internal elements are dict, internal field descriptions are as follows:

8. Operation Permission Configuration Parameter Description

8.1permissionSet, openPermissionSet Field Description (2024-06-26 iteration added fields):

When openPermissionSet is enabled, only the workspace owner and roles, teams, members belonging to the permissionSet configuration can edit/enable/disable/delete

When openPermissionSet is disabled (default), then delete/enable/disable/edit permissions follow the original interface edit/enable/disable/delete permissions

permissionSet field can configure, role UUID (wsAdmin,general, readOnly, role_xxxxx ), team UUID (group_yyyy), member UUID (acnt_xxx)

permissionSet field example:

  ["wsAdmin", "general", "group_yyyy", "acnt_xxxx"]    

Request Example¶

curl 'https://openapi.guance.com/api/v1/alert_policy/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"jj_test","ruleTimezone":"Asia/Shanghai","alertOpt":{"alertTarget":[{"name":"Notification Configuration1","targets":[{"status":"critical","tags":{"pod_name":["coredns-7769b554cf-w95fk"]},"to":["acnt_xxxx32"]}],"crontabDuration":600,"crontab":"0 9 * * 0,1,2,3,4"},{"name":"Notification Configuration2","targets":[{"status":"error","to":["group_xxxx32"]}],"customDateUUIDs":["ndate_xxxx32"],"customStartTime":"09:30:10","customDuration":600},{"targets":[{"status":"warning","to":["notify_xxxx32"]}]}],"silentTimeout":21600,"aggInterval":120,"aggFields":["df_monitor_checker_id"]}}' \
--compressed

Response¶

{
    "code": 200,
    "content": {
        "alertOpt": {
            "aggFields": [
                "df_monitor_checker_id"
            ],
            "aggInterval": 120,
            "alertTarget": [
                {
                    "crontab": "0 9 * * 0,1,2,3,4",
                    "crontabDuration": 600,
                    "name": "Notification Configuration1",
                    "targets": [
                        {
                            "status": "critical",
                            "tags": {
                                "pod_name": [
                                    "coredns-7769b554cf-w95fk"
                                ]
                            },
                            "to": [
                                "acnt_xxxx32"
                            ]
                        }
                    ]
                },
                {
                    "customDateUUIDs": [
                        "ndate_xxxx32"
                    ],
                    "customDuration": 600,
                    "customStartTime": "09:30:10",
                    "name": "Notification Configuration2",
                    "targets": [
                        {
                            "status": "error",
                            "to": [
                                "group_xxxx32"
                            ]
                        }
                    ]
                },
                {
                    "targets": [
                        {
                            "status": "warning",
                            "to": [
                                "notify_xxxx32"
                            ]
                        }
                    ]
                }
            ],
            "silentTimeout": 21600
        },
        "createAt": 1719373984,
        "creator": "wsak_xxxx32",
        "declaration": {
            "asd": "aa,bb,cc,1,True",
            "asdasd": "dawdawd",
            "business": "aaa",
            "fawf": "afawf",
            "organization": "64fe7b4062f74d0007b46676"
        },
        "deleteAt": -1,
        "id": null,
        "name": "jj_test",
        "ruleTimezone": "Asia/Shanghai",
        "score": 0,
        "status": 0,
        "updateAt": 1719373984,
        "updator": "wsak_xxxx32",
        "uuid": "altpl_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-148B6846-6180-4594-BD26-8A2077F0E911"
}