DescribeAlarmPolicy

1GET /v1/alarm/policy?name=${PolicyName} HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8

1GET /v1/alarm/policy?name=policy-name HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
4Content-Type: application/json; charset=utf-8

1HTTP/1.1 201
2Content-Type: application/json; charset=utf-8
3X-Bce-Request-Id: 2eeba101-4cc7-4cfe-b5ac-a3be8d060e33
4Date: Fri, 10 Apr 2020 04:42:37 GMT
5{
6    "success": true,
7    "code": "OK",  // Error code
8    "message": "",  // Error details
9    "policy": {
10        // Alarm policy name, unique under the same user
11        "name": "policy-name",
12        
13            // Policy ID, unique under the same user
14        "id": "p-nRyKJOpr",
15        
16            // policy enabled status, options:
17            // ENABLED  - enabled
18            // DISABLED - disabled
19        "state": "ENABLED",
20        
21            // Notification enabled status, options:
22            // ENABLED  - enabled
23            // DISABLED - disabled
24        "noticeState": "ENABLED",
25        
26            // Notification enabled status, options
27            // ENABLED  - enabled
28            // DISABLED - disabled
29        "noticeState": "ENABLED",
30        
31            "createdTime": "20240410T10:12:30Z",  // Creation time, UTC time
32            "updatedTime": "20240410T10:12:30Z",  // Update time, UTC time
33    
34        // List of monitor objects. When all logstores share the target logstore, this field is populated
35        "objects": [
36            {
37                    "logStoreName": "test-logstore-52"  // Logstore name
38            },
39        ],
40    
41            // List of execution statements
42        "targets": [
43            {
44                    // Execution statement
45                "query": "select sum(age) as age",
46                    // Query start time offset, required, value range: [-1440, 0)
47                "startTimeOffsetMinute": -1440,
48            // Query end time offset, required, value range: (startTimeOffsetMinute, 0]
49                "endTimeOffsetMinute": 0,
50            
51            // Target logstore. When each execution statement specifies a logstore separately, this field is filled in
52                "object": {
53                "logStoreName": "test-logstore-52"  // Logstore name
54                }
55            }
56        ],
57    
58    // List of trigger conditions
59        "triggerConditions": [
60            {
61            // Alarm level, options:
62            // INFO     - Notification,
63            // WARN     - Warning
64            // CRITICAL - Critical
65                "level": "WARN",
66            
67            // Trigger condition expression
68                "condition": "$1.age > 1"
69            }
70        ],
71    
72    // Group trigger
73        "groups": ["$1.age", "$1.salary"],
74    
75    // Execution cycle. Either fixed interval or specified time must be set, but not both
76        "schedule": {
77        // Fixed interval, unit: minutes, value range [1, 1440]
78            "intervalMinute": 1，
79        
80        // Specified time, minutes of the day, value range [0, 1440)
81        "fixTimeMinute": 120, // In the example, 120 represents the 120th minute of the day, i.e., 2:00 AM
82            
83        // Fixed time frequency; 0: Daily 1~7 represents Monday to Sunday in a week
84            "dayOfWeek": 3,
85        },
86    
87            // Continuous trigger threshold, number of consecutive times the threshold is triggered before an alarm is raised
88        "pendingCount": 1,
89    
90            // Repeat alarm interval, unit: minutes, default value: 0, which means repeat alarm is disabled
91        "repeatIntervalMinute": 5,
92        
93            // Whether to notify after recovery, true: notify, false: do not notify, default
94        "recoverAlarmNotice": true,
95    
96            // Alarm notification template list
97        "notices": [
98            {
99                    // BCM alarm template ID
100                "id": "testNotice"  
101            }
102        ],
103        
104             // Whether to include the original log in the alarm content, false: do not include, default true: include
105        "noticeWithRawLog" : true,
106        
107            // Alarm notification content configuration
108        "noticeRawConfigs" : [
109            {    
110                    // Configuration type, required
111                    // REF  Automatically associate execution statements
112                    // CUSTOM   Custom search statement
113                "type" : "CUSTOM",
114                
115                    // If type is REF, it represents the execution statement sequence number
116                "refTarget" : 1,
117                
118                    // If type is AUTO_ASSOCIATED, it represents a custom search statement
119                "query" : "match *",
120                
121                    // If each execution statement selects a logstore separately and is configured as a custom search statement, this represents the logstore
122                "object" : {
123                        // Logstore project, required
124                    "project" : "default",
125                        // Logstore name, required
126                    "logStoreName" : "bls-ng-log"
127                },
128                    // Display fields, required
129                    // All - All fields
130                    // SpecifiedFields - Specified fields
131                "displayType" : "ALL",
132                
133                    // Specified field name list, optional
134                "display_fields" : ["requestid", "status"],
135                    // Number of logs to display, maximum value is 5
136                "limit" : 4,
137            }
138        ]
139    }
140}