ValidateAlarmPolicySQL
Updated at：2025-11-03
Description
Verify whether the query statement of the alarm policy is correct
Request
- Request syntax
Text
1POST /v1/logstore/validate HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>
4Content-Type: application/json; charset=utf-8
5{
6 "query": "<SQL>",
7}- Request headers
No additional headers are required beyond the standard request headers.
- Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| logStores | List<LogStore> | Yes | RequestBody | Monitor Object list |
| query | string | Yes | RequestBody | Execution statement |
Each LogStore element structure in the objects array is as follows:
| Field | Types | Description |
|---|---|---|
| project | String | Logstore project, defaulting to "default" |
| logStoreName | String | Logstore name |
Response
- Response headers
No additional headers are required beyond the standard response headers.
- Response parameters
| Field | Types | Description |
|---|---|---|
| success | Boolean | Whether the request succeeded |
| code | String | Request code, OK for success, or a specific error code for failure |
| message | String | Empty for request success, or a specific error message for request failure |
| result | Result | Test result |
Result element results are as follows:
| Field | Types | Description |
|---|---|---|
| logStore | LogStore | Monitor Object |
| valid | Bool | Whether the verification is passed, true: Passed, false: Failed |
| reason | String | If verification failed, return the failure reason |
| columns | List<String> | If the verification is passed, return the list of column names |
| columnTypes | List<String> | If the verification is passed, return the list of column types |
Error code
No special error codes are returned beyond standard error codes.
Example
- Request example
Text
1POST /v1/logstore/validate 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
5{
6 // Logstore list, support batch verification, required
7 "logStores": [
8 {
9 "name": "log-store-1",
10 }
11 ],
12
13 // Execution statement, required
14 "query": "select *",
15}- Response example
Text
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 "result": [
10 {
11 // Logstore name
12 "logStore": {
13 "name": "log-store-1",
14 },
15 // Whether the verification is passed
16 "valid": true,
17 // If verification failed, return the failure reason
18 "reason": "",
19 // If verification is passed, return the list of column names
20 "columns": ["pv", "count"],
21 // If verification is passed, return the list of column types
22 "columnTypes": ["int", "int"],
23 }
24 ]
25}