Create v2¶

POST /api/v1/alert_policy/add_v2

Overview¶

Create an alert strategy. v2 supports synchronously updating associated monitors/intelligent monitors/intelligent inspections/SLOs, and security checks.

Body Request Parameters¶

Supplementary Parameter Description¶

Data Description.

1. alertOpt Parameter Description

1.1 alertOpt.aggType Parameter Description 2024-12-25
Alert aggregation types:
　null: No aggregation
　byFields: Rule aggregation
　byCluster: Intelligent aggregation
　byAI: AI aggregation

Since the old data structure does not have the aggType field and instead determines the aggregation type based on the aggFields content, the following compatibility handling will be performed after adding the aggType field:
When aggType is specified, aggregation is performed according to the method specified by aggType.
When aggType is not specified or aggType is None (following the old logic):
If aggFields contains "CLUSTER", aggregation is performed using the intelligent aggregation method.
If aggFields does not contain "CLUSTER", aggregation is performed using the rule aggregation method.

Derived rules: Specifying aggInterval=0 or aggInterval=null still means "no aggregation".
When aggType="byCluster" is specified, it is no longer necessary to pass "CLUSTER" in aggFields (whether passed or not has no effect).
When aggType="byFields" is specified but aggFields contains "CLUSTER", "CLUSTER" will be ignored (i.e., aggType has higher priority).
When aggType="byCustom" is specified, aggregation is performed according to the custom fields in aggFields.

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

key	Type	Required	Description
name	string		Configuration name
targets	Array[dict]	Required	Notification target configuration (Note the position of this field when the alert strategy is of level/member type)
crontab	String		When selecting a recurring time period, the start Crontab (Crontab syntax)
crontabDuration	integer		When selecting a recurring time period, the duration from the start of the Crontab (in seconds)
customDateUUIDs	Array[String]		When selecting a custom time period, the UUID list of custom notification dates. Example: ['ndate_xxxx32', 'ndate_xxxx32']. Refer to (Monitoring - Alert Strategies - Custom Notification Dates API) for custom notification dates.
customStartTime	String		When selecting a custom time period, the daily start time, format: HHss
customDuration	integer		When selecting a custom time period, the duration from the customStartTime (in seconds)

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

key	Type	Required	Description
alertTarget[#]	dict		Element of the alertTarget list
alertTarget[#].name	string		Configuration name
alertTarget[#].crontab	String		When selecting a recurring time period, the start Crontab (Crontab syntax)
alertTarget[#].crontabDuration	integer		When selecting a recurring time period, the duration from the start of the Crontab (in seconds)
alertTarget[#].customDateUUIDs	Array[String]		When selecting a custom time period, the UUID list of custom notification dates. Example: ['ndate_xxxx32', 'ndate_xxxx32']. Refer to (Monitoring - Alert Strategies - Custom Notification Dates API) for custom notification dates.
alertTarget[#].customStartTime	String		When selecting a custom time period, the daily start time, format: HHss
alertTarget[#].customDuration	integer		When selecting a custom time period, the duration from the customStartTime (in seconds)
alertTarget[#].alertInfo	Array[dict]	Required	Notification-related information configuration for the member-type alert strategy. (Newly added in the 2024-11-27 iteration)

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

5. Time Configuration Related Notes

If selecting a recurring time period, the crontab and crontabDuration fields are required.
If selecting a custom time period, the customDateUUIDs, customDuration, and customStartTime fields are required.
If selecting other times, the crontab, crontabDuration, customDateUUIDs, customStartTime, and customDuration fields should not be passed.
Note: Each alert strategy will have one notification rule for other times, i.e., the fallback notification target without time configuration.

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

targets is a list, with each internal element being a dict. The internal field descriptions are as follows:

7. Notification Target Field upgradeTargets Description

  <br/>

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

7.1 upgradeTargets is a list, with each internal element being a dict. The internal field descriptions are as follows:

8. Operational Permission Configuration Parameter Description

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

When openPermissionSet is enabled, only the workspace owner and the roles, teams, and members configured in the permissionSet can edit/enable/disable/delete.

When openPermissionSet is disabled (default), the 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 UUIDs (group_yyyy), and member UUIDs (acnt_xxx).

Example of the permissionSet field:

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

9. alertOpt[#].silentTimeoutByStatus Parameter Description

Example of the silentTimeoutByStatus field:

  [
      {
          "status": "fatal",
          "silentTimeout": 600
      },
      {
          "status": "critical,error",
          "silentTimeout": 900
      },
      {
          "status": "security_high",
          "silentTimeout": 600
      },
  ]

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"
}