Create v2¶

POST /api/v1/alert_policy/add_v2

Overview¶

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

Body Request Parameters¶

Parameter Supplementary Description¶

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 data structure, since the aggType field did not exist, the aggregation type was determined by the content of aggFields. Therefore, after adding the aggType field, compatibility is handled as follows:
When aggType is specified, aggregate according to the method specified by aggType.
When aggType is not specified or aggType=None (follows old logic):
If aggFields contains "CLUSTER", aggregate using intelligent aggregation.
If aggFields does not contain "CLUSTER", aggregate using rule aggregation.

Derived rules: Specifying aggInterval=0 or aggInterval=null still means "No aggregation".
When aggType="byCluster" is specified, "CLUSTER" can be omitted from aggFields (passing it or not does not affect).
When aggType="byFields" is specified but aggFields contains "CLUSTER", "CLUSTER" is ignored (i.e., aggType has higher priority).
When aggType="byCustom" is specified, aggregate according to the custom fields in aggFields.

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 target configuration (Note the position of this field for level/member type alert policies)
crontab	String		When selecting a recurring time period, start Crontab (Crontab syntax)
crontabDuration	integer		When selecting a recurring time, duration from Crontab start (seconds)
customDateUUIDs	Array[String]		When selecting custom time, UUID list of custom notification dates. Example: ['ndate_xxxx32', 'ndate_xxxx32']. Refer to (Monitoring - Alert Policy - Custom Notification Date, interface) for custom notification dates.
customStartTime	String		When selecting custom time, daily start time, format: HHss
customDuration	integer		When selecting a custom time period, duration from customStartTime custom start time (seconds)

3. When the alert policy is of type member, alertOpt.alertTarget parameter description

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

4. When the alert policy is of type member, alertOpt.alertTarget.alertInfo parameter description

5. Time Configuration Related Description

If selecting a recurring time period, crontab and crontabDuration fields are required parameters.
If selecting a custom time period, customDateUUIDs, customDuration, and 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., the fallback notification target without time configuration.

6. Notification target field targets description
When alertType is status, targets location is alertOpt.alertTarget.targets.
When alertType is member, targets location is alertOpt.alertTarget.alertInfo.targets.

targets is a list, internal elements are dicts. Internal field description is as follows:

7. Notification target field upgradeTargets description

  <br/>

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

7.1 upgradeTargets is a list, internal elements are dicts. Internal field description is as follows:

8. Operation Permission Configuration Parameter Description

8.1 permissionSet, openPermissionSet field description (fields added in 2024-06-26 iteration):

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), 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), member UUIDs (acnt_xxx).

permissionSet field example:

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

9. alertOpt[#].silentTimeoutByStatus Parameter Description

silentTimeoutByStatus field example:

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

Request Example¶

curl 'https://openapi.truewatch.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"
}