全部文档
当前文档
最近更新时间：2023-03-30 11:36:36
用于获取告警策略列表。
该接口无特有请求头。获取更多信息，请参见公共请求头
参数详情具体如下表。
| 参数名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| pageIndex | Long | 是 | 分页的偏移量 |
| pageSize | Long | 是 | 分页单页限制数目 |
| enabled | Integer | 否 | 状态标识 |
| projectName | String | 否 | 工程名称 |
| dashboardId | Long | 否 | 仪表盘id，如果不指定输出工程下所有仪表盘 |
参数详情具体如下表。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | Integer | 状态码 |
| message | String | 状态信息 |
| totalCount | Integer | 返回数据条数 |
| data | Map | 具体内容 |
| logPolicyList | List | 策略列表 |
logPolicy字段说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | Integer | 策略id |
| name | String | 告警名称 |
| projectName | String | 工程名称 |
| dashboardId | String | 仪表盘id |
| dashboardName | String | 仪表盘名称 |
| queries | List | 查询 |
| condition | String | 触发条件 |
| scheduleType | Long | 频率类型：0：间隔时间 4：cron |
| fixInterval | String | 间隔时间 |
| cronExpr | String | 频率为cron的表达式 |
| notifyInterval | Long | 通知间隔 |
| notifyThreshold | Long | 触发次数阈值 |
| enabled | Integer | 是否启用 0：不启用 1： 启用 |
| channelParam | Map | 报警渠道配置 |
querie字段说明：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| logPoolName | String | 日志池名称 |
| graphName | String | 图表名称 |
| start | String | 查开始区间 |
| end | String | 查询结束区间 |
| query | String | 查询语句 |
channelParam字段说明：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| usrgrpId | Integer | 告警接收组id，需要在云监控查询 |
| channelType | Integer | 报警类型 1：邮件 2: 短信 3：邮件和短信 |
| emailContent | String | 邮件报警内容格式 |
| smsContent | String | 短信报警内容格式 |
Authorization: <AuthorizationString>
x-klog-api-version: 0.1.0
Host:klog.api.ksyun.com
x-klog-signature-method: hmac-sha1
Date: <GMT Date>
Content-Type: application/json
Content-MD5: <Content-MD5>
Content-Length: <ContentLength>
Connection: Keep-Alive
GET /DescribeLogPolicy?pageIndex=1&pageSize=10&projectName=test1111&dashboardId=231&enabled=1
HTTP/1.1 200
Server: nginx
Content-Length: 0
Connection: close
Access-Control-Allow-Origin: *
Date: Sun, 27 May 2018 07:43:27 GMT
x-klog-requestid: 5B0A619F205DC3F30EDA9322
{
"status": 0,
"message": "成功",
"totalCount": 1,
"data": {
"logPolicyList": [
{
"requestId": "11111",
"accountId": 11111,
"id": 272,
"name": "test",
"projectName": "test1111",
"dashboardId": "231",
"dashboardName": "tes",
"queries": [
{
"id": 752.0,
"policyId": 272.0,
"graphId": 0.0,
"graphName": "ttt",
"query": "select count (*) as c where type='Warning'",
"start": "-300s",
"end": "now",
"logPoolName": "asdasd",
"timeSpanType": "",
"Optype": 0.0
}
],
"channelParam": {
"usrgrpId": 766.0,
"usrgrpName": "",
"channelType": 3.0,
"callbackUrl": "",
"smsContent": "",
"emailContent": "Warning警示事件,发生告警,请排查相关问题",
"emailSubject": ""
},
"channelParams": "{\"usrgrpId\":766,\"usrgrpName\":\"\",\"channelType\":3,\"callbackUrl\":\"\",\"smsContent\":\"\",\"emailContent\":\"Warning警示事件,发生告警,请排查相关问题\",\"emailSubject\":\"\"}",
"condition": "$0.c>0",
"scheduleType": 0,
"fixInterval": "5m",
"dayOfWeek": 0,
"hour": 0,
"cronExpr": "",
"notifyThreshold": 1,
"notifyInterval": 0,
"remarks": "",
"enabled": 1,
"idc": "",
"createTime": 1676546765
}
],
"totalCount": 1,
"code": "Success",
"msg": "DescribeLogPolicy Success"
}
}
纯净模式