Create v2¶

POST /api/v1/alert_policy/add_v2

Overview¶

Create an alert strategy, v2 supports synchronous updates of associated monitors/intelligent monitors/intelligent inspections/slo, security monitoring

Body Request Parameters¶

Additional Parameter Explanation¶

Data Explanation.

1. alertOpt Parameter Explanation

1.1 alertOpt.aggType Parameter Explanation 2024-12-25 Alert aggregation type 　null: no aggregation 　"byFields": rule aggregation 　"byCluster": intelligent aggregation 　"byAI": AI aggregation
Since there was no aggType field in the old data structure, and the aggregation type was determined by the contents of aggFields, after adding the aggType field, compatibility will be handled as follows:
Aggregate according to the aggregation method specified by aggType if aggType is specified
Aggregate according to the old logic if aggType is not specified or aggType=None
Aggregate according to intelligent aggregation if "CLUSTER" is included in aggFields
Aggregate according to rule aggregation if "CLUSTER" is not included in aggFields
Derived rules:

Specify aggInterval=0 or aggInterval=null still indicates "no aggregation"
Specify aggType="byCluster" where aggFields can omit "CLUSTER" (whether passing it does not affect)
Specify aggType="byFields", but aggFields also include "CLUSTER", ignore "CLUSTER" (i.e., higher priority for aggType)

2. When the alert strategy is of type level, alertOpt.alertTarget Parameter Explanation

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

3. When the alert strategy is of type member, alertOpt.alertTarget Parameter Explanation

key	Type	Required	Description
name	string		Configuration name
crontab	String		Select repeat time period, start Crontab (Crontab syntax)
crontabDuration	integer		Select repeat time, duration from Crontab start (seconds)
customDateUUIDs	Array[String]		Select custom time, UUID list of custom notification dates, example: ['ndate_xxxx32', 'ndate_xxxx32'], reference custom notification date (Monitoring - Alert Strategy - Custom Notification Date, interface)
customStartTime	String		Select custom time, daily start time, format: HHss
customDuration	integer		Select custom time period, duration from customStartTime custom start time (seconds)
alertInfo	Array[dict]	Required	Notification related information configuration for member-type alert strategies added in iteration on 2024-11-27

4. When the alert strategy is of type member, alertOpt.alertTarget.alertInfo Parameter Explanation

5. Time Configuration Related Explanations

If select repeated time period, crontab, crontabDuration fields are required parameters
If select custom time period, customDateUUIDs, customDuration, customStartTime fields are required parameters
If select other moments, crontab, crontabDuration, customDateUUIDs, customStartTime, customDuration are not required
Note: Each alert strategy will have a fallback notification rule with no time configuration

6. Notification Object Field targets Explanation When alertType is status, targets location alertOpt.alertTarget.targets
When alertType is member, targets location alertOpt.alertTarget.alertInfo.targets
targets is a list, internal elements are dicts, internal field explanations as follows

7. Notification Object Field upgradeTargets Explanation When alertType is status, targets location alertOpt.alertTarget.targets.upgradeTargets
When alertType is member, targets location alertOpt.alertTarget.alertInfo.targets.upgradeTargets
upgradeTargets is a list, internal elements are dicts, internal field explanations as follows

8. Operation Permission Configuration Parameter Explanation

**permissionSet, openPermissionSet Field Explanation(Added in iteration on 2024-06-26): **

After enabling openPermissionSet configuration, only space owners and roles, teams, members configured in permissionSet can perform edit/enable/disable/delete operations
When openPermissionSet is disabled (default), delete/enable/disable/edit permissions follow the original interface edit/enable/disable/delete permissions

The permissionSet field can be configured with role UUIDs(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 Configuration 1","targets":[{"status":"critical","tags":{"pod_name":["coredns-7769b554cf-w95fk"]},"to":["acnt_xxxx32"]}],"crontabDuration":600,"crontab":"0 9 * * 0,1,2,3,4"},{"name":"Notification Configuration 2","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 Configuration 1",
                    "targets": [
                        {
                            "status": "critical",
                            "tags": {
                                "pod_name": [
                                    "coredns-7769b554cf-w95fk"
                                ]
                            },
                            "to": [
                                "acnt_xxxx32"
                            ]
                        }
                    ]
                },
                {
                    "customDateUUIDs": [
                        "ndate_xxxx32"
                    ],
                    "customDuration": 600,
                    "customStartTime": "09:30:10",
                    "name": "Notification Configuration 2",
                    "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"
}