告警相关接口

更新时间：2024-09-24

查询告警模板列表

请求方法 GET

请求路径：/v2/alerting_rule_template

请求结构

GET /v2/alerting_rule_template HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

无

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
ruleTemplates	List< RuleTemplate>	告警模板列表

RuleTemplate：

字段	类型	说明
alertName	String	告警名称
expr	String	告警规则，promQL查询语句
for	String	告警持续时间
description	String	告警内容

请求示例

GET /v2/alerting_rules/templates?instanceId=cprom-sfdjf*****  HTTP/1.1
Host: cprom.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8
{
    "ruleTemplates": [
        {
            "alertName": "CCE-节点不可用报警",
            "expr": "sum(kube_node_status_condition{condition=\"Ready\",status=\"false\",region=\"\", clusterID=~\"\"}) \u003e 0",
            "for": "2m",
            "description": "cluster: {{ $labels.clusterID }}, region: {{ $labels.region }} SUM of node not Ready \u003e 0, current: {{ $value | printf \"%.2f\" }}"
        },
        {
            "alertName": "CCE-节点不可调度报警",
            "expr": "sum(kube_node_spec_unschedulable{region=\"\", clusterID=~\"\"}) \u003e 0",
            "for": "2m",
            "description": "cluster: {{ $labels.clusterID }}, region: {{ $labels.region }} SUM of node unschedulable \u003e 0, current: {{ $value | printf \"%.2f\" }}"
        }
      ]

}

查询通知策略列表

请求方法 GET

请求路径：/v2/notify_rule

请求结构

GET /v2/notify_rule?pageNo=1&pageSize=10  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
pageSize	Integer	否	QueryString	分页查询监控实例列表每页监控实例个数，范围为1-100，缺省值为10
pageNo	Integer	否	QueryString	分页查询监控实例列表分页页码数，缺省值为1
keywordType	String	否	QueryString	筛选条件类型，默认为notifyRuleName，只支持notifyRuleName
keyword	String	否	QueryString	筛选条件关键字

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
keywordType	String	筛选条件类型
keyword	String	筛选条件关键字
orderBy	String	通知策略列表排序依据字段
order	String	通知策略列表排序方式：desc倒序，asc升序
pageNo	Integer	通知策略分页当前页码数
pageSize	Integer	当前页页通知策略个数
totalCount	Integer	通知策略总个数
items	List< NotifyRule >	通知策略列表

NotifyRule：

字段	类型	说明
notifyRuleId	String	通知策略ID
notifyRuleName	String	通知名称
startTime	String	通知时段开始时间
endTime	String	通知时段终止时间
channel	List< String >	通知渠道，phone:电话 , sms: 短信, email: 邮件
receiverType	String	接收者类型，user：用户，userGroup：用户组
users	List< User >	用户列表
userGroups	List< UserGroup >	用户组列表
webhookConfigList	List< CallbackConfig >	webhook 回调配置信息列表
escalateConfigList	List< EscalateParam >	通知策略升级参数列表
createTime	String	创建时间
updateTime	String	更新时间

User：

字段	类型	说明
userId	String	用户ID
userName	String	用户名称
userType	String	用户类型, 默认identity
phoneNumber	String	用户手机号码
email	String	用户邮箱

UserGroup：

字段	类型	说明
groupId	String	用户组ID
groupName	String	用户组名称
description	String	用户组描述

CallbackConfig：

字段	类型	说明
webhookType	String	回调类型，weCom:企业微信，dingTalk:钉钉，lark:飞书，custom:自定义webhook
webhookList	List< WebhookDetail >	webhook配置详情列表

WebhookDetail：

字段	类型	说明
hookName	String	机器人名称
hookMethod	String	webhook请求的HTTP方法，默认post
hookUrl	String	机器人地址
headers	Map<String,String>	webhook请求的HTTP头部信息
params	Map<String,String>	webhook请求参数

EscalateParam：

字段	类型	说明
rank	Integer	升级通知策略级别，1，2，3, xx时间未响应升级到1级->2级->3级
Condition.stayInUnclaimTime	String	超过多长时间未认领
Condition.stayInClaimTime	String	认领后多久未恢复
notifyAction.channel	List< String >	通知渠道，phone:电话 , sms: 短信, email: 邮件
notifyAction.receiverType	String	接受者类型，user：用户，userGroup：用户组
notifyAction.users	List< User >	用户列表
notifyAction.userGroups	List< UserGroup>	用户组列表
notifyAction.webhookConfigList	List< CallbackConfig >	webhook 回调配置信息列表

请求示例

GET /v2/notify_rule/templates?pageNo=1&pageSize=10  HTTP/1.1
Host: cprom.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8
{
    "orderBy": "updateTime",
    "order": "decs",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 2,
    "items": [
        {
            "notifyRuleId": "notify-********",
            "notifyRuleName": "d-test",
            "startTime": "00:00:00",
            "endTime": "23:59:59",
            "channel": [
                "email"
            ],
            "receiverType": "user",
            "users": [
                {
                    "userId": "2e*************************",
                    "userName": "d*******",
                    "userType": "",
                    "phoneNumber": "",
                    "email": ""
                }
            ],
            "userGroups": [],
            "webhookConfigList": [],
            "createTime": "2024-05-14T14:22:21Z",
            "updateTime": "2024-05-14T14:22:21Z"
        },
        {
            "notifyRuleId": "notify-b*********",
            "notifyRuleName": "d**",
            "startTime": "00:00:00",
            "endTime": "23:59:59",
            "channel": [
                "email"
            ],
            "receiverType": "userGroup",
            "users": [],
            "userGroups": [
                {
                    "groupId": "c************************",
                    "groupName": "d-****",
                    "description": ""
                }
            ],
            "webhookConfigList": [],
            "createTime": "2024-05-14T14:15:08Z",
            "updateTime": "2024-05-14T14:15:09Z"
        }
    ]
}

创建通知策略

请求方法 POST

请求路径：/v2/notify_rule

请求结构

POST /v2/notify_rule  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
notifyRuleName	String	是	Body参数	通知策略名称
startTime	String	是	Body参数	通知开始时间，时间格式 00：00：00
endTime	String	是	Body参数	通知结束时间，时间格式 23：59：59
channel	List< String >	否	Body参数	通知渠道，phone:电话 , sms: 短信, email: 邮件。若选择phone:电话 , sms: 短信, email: 邮件这三种方式通知则必选，webhook为非必选。
receiverType	String	否	Body参数	接受者类型，user：用户，userGroup：用户组，若选择phone:电话 , sms: 短信, email: 邮件这三种方式receiverType为必选参数，webhook为非必选。
users	List< User >	receiverType=user时必需	Body参数	用户列表
userGroups	List< UserGroup >	receiverType=userGroup时必需	Body参数	用户组列表
webhookConfigList	List< CallbackConfig >	否	Body参数	webhook 回调配置信息列表
escalateConfigList	List< EscalateParam >	否	Body参数	通知策略升级参数列表

User：

字段	类型	是否必需
userId	String	是
userName	String	是
userType	String	是
phoneNumber	String	否
email	String	否

UserGroup：

字段	类型	是否必需
groupId	String	是
groupName	String	是
description	String	否

CallbackConfig：

字段	类型	是否必需
webhookType	String	是
webhookList	List< WebhookDetail >	是

WebhookDetail：

字段	类型	是否必需
hookName	String	是
hookMethod	String	是
hookUrl	String	是
headers	Map<String,String>	否
params	Map<String,String>	否

EscalateParam：

字段	类型	是否必需	说明
rank	Integer	是	升级通知策略级别，1，2，3, xx时间未响应升级到1级->2级->3级
Condition.stayInUnclaimTime	String	是	超过多长时间未认领
Condition.stayInClaimTime	String	是	认领后多久未恢复
notifyAction.channel	List< String >	否	通知渠道，phone:电话 , sms: 短信, email: 邮件，若选择phone:电话 , sms: 短信, email: 邮件这三种方式通知则必选，webhook为非必选。
notifyAction.receiverType	String	否	接受者类型，user：用户，userGroup：用户组，若选择phone:电话 , sms: 短信, email: 邮件这三种方式receiverType为必选参数，webhook为非必选。
notifyAction.users	List< User >	receiverType=user时必需	用户列表
notifyAction.userGroups	List< UserGroup >	receiverType=userGroup时必需	用户组列表
notifyAction.webhookConfigList	List< CallbackConfig >	否	webhook 回调配置信息列表

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
notifyRuleId	String	通知策略ID

请求示例

POST /v2/notify_rule  HTTP/1.1
Host: cprom.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
  "notifyRuleName": "test",
  "startTime": "00:00:00",
  "endTime": "23:59:59",
  "receiverType": "user",
  "channel": [
    "email","phone",
  ],
  "users": [
    {
      "userId": "6***********************",
      "userName": "w****25",
      "userType": "identity",
      "phoneNumber": "***********",
      "email": "w****25@baidu.com"
    }
  ],
  "userGroups": [],
  "webhookConfigList": [
        {
            "webhookType": "custom",
            "webhookList": [
                {
                    "hookName": "test",
                    "hookMethod": "post",
                    "hookUrl": "http://apiin.im.baidu.com/api/msg/groupmsgsend?access_token=dec67******************",
                    "headers": null,
                    "params": null
                }
            ]
        }
  ],
  "escalateConfigList": [
          {
            "rank": 1,
            "condition": {
                "stayInUnclaimTime": 10
            },
            "notifyAction": {
                "channel": [
                    "phone"
                ],
                "receiverType": "userGroup",
                "users": [],
                "userGroups": [
                    {
                        "description": "",
                        "groupId": "a0d*******************6",
                        "groupName": "userGroupTest"
                    }
                ]
            }
        }
   ]
}

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8
{
    "notifyRuleID": "notify-*********"
}

更新通知策略

请求方法 PUT

请求路径：/v2/notify_rule/{notifyRuleId}

请求结构

POST /v2/notify_rule/{notifyRuleId}  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
notifyRuleId	String	是	Path参数	通知策略ID
notifyRuleName	String	是	Body参数	通知策略名称
startTime	String	是	Body参数	通知开始时间，时间格式 00：00：00
endTime	String	是	Body参数	通知结束时间，时间格式 23：59：59
channel	List< String >	是	Body参数	通知渠道，phone:电话 , sms: 短信, email: 邮件
receiverType	String	是	Body参数	接受者类型，user：用户，userGroup：用户组
users	List< User >	receiverType=user时必需	Body参数	用户列表
userGroups	List< UserGroup >	receiverType=userGroup时必需	Body参数	用户组列表
webhookConfigList	List< CallbackConfig >	否	Body参数	webhook 回调配置信息列表
escalateConfigList	List< EscalateParam >	否	Body参数	通知策略升级参数列表

返回头域

除公共头域，无其它特殊头域。

返回参数

无

请求示例

POST /v2/notify_rule/notify-q9s*****  HTTP/1.1
Host: cprom.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
  "notifyRuleName": "test",
  "startTime": "00:00:00",
  "endTime": "23:59:59",
  "receiverType": "user",
  "channel": [
    "email"， "phone"
  ],
  "users": [
    {
      "userId": "6***************************",
      "userName": "test25",
      "userType": "identity",
      "phoneNumber": "***********",
      "email": "test25@baidu.com"
    }
  ]
}

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8

查看通知策略

请求方法 GET

请求路径：/v2/notify_rule/{notifyRuleId}

请求结构

GET /v2/notify_rule/{notifyRuleId}  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
notifyRuleId	String	是	Path参数	通知策略ID

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
notifyRuleId	String	通知策略ID
notifyRuleName	String	通知策略名称
startTime	String	通知开始时间，时间格式 00：00：00
endTime	String	通知结束时间，时间格式 23：59：59
channel	List< String >	通知渠道，phone:电话 , sms: 短信, email: 邮件
receiverType	String	接受者类型，user：用户，userGroup：用户组
users	List< User >	用户列表
userGroups	List< UserGroup >	用户组列表
webhookConfigList	List< CallbackConfig >	webhook 回调配置信息列表
escalateConfigList	List< EscalateParam >	通知策略升级参数列表
createTime	String	创建时间
updateTime	String	更新时间

请求示例

GET /v2/notify_rule/notify-q9sie****  HTTP/1.1
Host: cprom.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8
{
    "notifyRuleId": "notify-q9si*****",
    "notifyRuleName": "test",
    "startTime": "00:00:00",
    "endTime": "23:59:59",
    "channel": [
        "email"
    ],
    "receiverType": "user",
    "users": [
        {
            "userId": "6****************************",
            "userName": "test25",
            "userType": "",
            "phoneNumber": "168********",
            "email": ""
        }
    ],
    "userGroups": [],
    "webhookConfigList": [],
    "createTime": "2024-05-22T08:08:44Z",
    "updateTime": "2024-05-22T08:08:44Z"
}

删除通知策略

请求方法 DELETE

请求路径：/v2/notify_rule/{notifyRuleId}

请求结构

DELETE /v2/notify_rule/{notifyRuleId}  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
notifyRuleId	String	是	Path参数	通知策略ID

返回头域

除公共头域，无其它特殊头域。

返回参数

无

请求示例

DELETE /v2/notify_rule/notify-q9sie****  HTTP/1.1
Host: cprom.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8

创建告警

请求方法 POST

请求路径：/v2/alerting_rule

请求结构

POST /v2/alerting_rule?instanceId={instanceId}  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

字段	类型	是否必需	参数位置	描述
instanceId	String	是	QueryString	Cprom实例ID
alertName	String	是	Body参数	告警名称
expr	String	是	Body参数	告警规则，promQL查询语句
for	String	是	Body参数	告警持续时间
description	String	是	Body参数	告警内容
notifyRuleId	String	是	Body参数	通知策略ID
enable	Boolen	否	Body参数	是否开启告警，创建时默认为true
severity	String	否	Body参数	告警级别，notice/warning/major/critical
labels	Map<Stirng,String>	否	Body参数	自定义label键值对
annotations	Map<Stirng,String>	否	Body参数	自定义注解键值对

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
alertId	String	告警规则ID

请求示例

POST /v2/alerting_rule?instanceID=cprom-djskf******  HTTP/1.1
Host: cprom.bj.baidubce.comContentType: application/jsonAuthorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{  
    "alertName": "CCE-节点不可用报警",
    "expr": "sum(kube_node_status_condition{condition=\"Ready\",status=\"false\",region=\"\", clusterID=~\"\"}) > 0",
    "for": "2m",
    "notifyRuleId": "notify-lv8c2ornb",
    "severity": "notice",
    "description": "cluster: {{ $labels.clusterID }}, region: {{ $labels.region }} SUM of node not Ready > 0, current: {{ $value | printf \"%.2f\" }}"
}

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8
{
    "alertId": "alerting-*********"
}

更新告警

请求方法 PUT

请求路径：/v2/alerting_rule/{alertingRuleId}

请求结构

PUT /v2/alerting_rule/{alertingRuleId}?instanceID={instanceId}  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

字段	类型	是否必需	参数位置	描述
alertingRuleId	String	是	Path参数	告警ID
instanceId	String	是	QueryString	Cprom实例ID
alertName	String	是	Body参数	告警名称
expr	String	是	Body参数	告警规则，promQL查询语句
for	String	是	Body参数	告警持续时间
description	String	是	Body参数	告警内容
notifyRuleId	String	是	Body参数	通知策略ID
severity	String	否	Body参数	告警级别，notice/warning/major/critical
enable	Boolen	否	Body参数	是否开启告警，开启为true，关闭为false
labels	Map<Stirng,String>	否	Body参数	自定义label键值对
annotations	Map<Stirng,String>	否	Body参数	自定义注解键值对

返回头域

除公共头域，无其它特殊头域。

返回参数

无

请求示例

PUT /v2/alerting_rule/alerting-sfo*****?instanceID=cprom-sdffjdk*****   HTTP/1.1
Host: cprom.bj.baidubce.comContentType: application/jsonAuthorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
    "alertName": "CCE-节点不可用报警",
    "expr": "sum(kube_node_status_condition{condition=\"Ready\",status=\"false\",region=\"\", clusterID=~\"\"}) > 0",
    "for": "2m",
    "enable": false,
    "notifyRuleId": "notify-lv8c2ornb",
    "severity": "notice",
    "description": "cluster: {{ $labels.clusterID }}, region: {{ $labels.region }} SUM of node not Ready > 0, current: {{ $value | printf \"%.2f\" }}"
}

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8

查看告警

请求方法 GET

请求路径：/v2/alerting_rule/{alertingRuleId}

请求结构

GET /v2/alerting_rule/{alertingRuleId}?instanceId={instanceId}  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
alertingRuleId	String	是	Path参数	告警ID
instanceId	String	是	QueryString	Cprom实例ID

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
alertId	String	告警ID
alertName	String	告警名称
expr	String	告警规则，promQL查询语句
for	String	告警持续时间
description	String	告警内容
enable	Boolen	是否开启告警
notifyRuleId	String	通知策略ID
labels	Map<Stirng,String>	标签列表, 如：告警级别，notice/warning/major/critical
annotations	Map<Stirng,String>	注解列表，支持自定义注解

请求示例

GET /v2/alerting_rule/alerting-sfo*****?instanceId=cprom-sdffjdk*****   HTTP/1.1
Host: cprom.bj.baidubce.comContentType: application/jsonAuthorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8
{
    "alertId": "alerting-*********",
    "alertName": "CCE-节点不可用报警2",
    "expr": "sum(kube_node_status_condition{condition=\"Ready\",status=\"false\",region=\"\", clusterID=~\"\"}) > 0",
    "for": "2m",
    "description": "cluster: {{ $labels.clusterID }}, region: {{ $labels.region }} SUM of node not Ready > 0, current: {{ $value | printf \"%.2f\" }}",
    "notifyRuleId": "notify-lv8c2ornb",
    "labels": {
        "cprom_severity": "notice"
    }
}

删除告警

请求方法 DELETE

请求路径：/v2/alerting_rule/{alertingRuleId}

请求结构

DELETE /v2/alerting_rule/{alertingRuleId}?instanceId={instanceId}  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
alertingRuleId	String	是	Path参数	告警ID
instanceId	String	是	QueryString	Cprom实例ID

返回头域

除公共头域，无其它特殊头域。

返回参数

无

请求示例

DELETE /v2/alerting_rule/alerting-sfo5*****?instanceId=cprom-u02*****  HTTP/1.1
Host: cprom.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8

查看告警列表

请求方法 GET

请求路径：/v2/alerting_rule

请求结构

GET /v2/alerting_rule?instanceId={instanceId}  HTTP/1.1
Host: cprom.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
instanceId	String	是	QueryString	Cprom实例ID
pageSize	Integer	否	QueryString	分页查询监控实例列表每页监控实例个数，范围为1-100，缺省值为10
pageNo	Integer	否	QueryString	分页查询监控实例列表分页页码数，缺省值为1
keywordType	String	否	QueryString	筛选条件类型，默认为alertName，只支持alertName
keyword	String	否	QueryString	筛选条件关键字

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
keywordType	String	筛选条件类型
keyword	String	筛选条件关键字
orderBy	String	告警列表排序依据字段
order	String	告警列表排序方式：desc倒序，asc升序
pageNo	Integer	分页当前页码数
pageSize	Integer	当前页告警个数
totalCount	Integer	告警总个数
items	List< RuleDetail >	告警列表

RuleDetail：

字段	类型	描述
alertId	String	告警ID
alertName	String	告警名称
expr	String	告警规则，promQL查询语句
for	String	告警持续时间
description	String	告警内容
enable	Boolen	是否开启告警
notifyRuleId	String	通知策略ID
labels	Map<Stirng,String>	标签列表, 告警级别等
annotations	Map<Stirng,String>	注解列表

请求示例

GET /v2/alerting_rule?instanceId=cprom-sdffjdk*****&keywordType=AlertName&keyword=scrapejob-exidjf-cce-esfsf  HTTP/1.1
Host: cprom.bj.baidubce.comContentType: application/jsonAuthorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2019-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1200 OK     
x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
Date: Fri,20 May 202208:23:14 GMT    
Content Type: application/json;charset=UTF-8
{
    "keywordType": "AlertName",
    "keyword": "scrapejob-cce-*****",
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 1,
    "items": [
        {
            "alertId": "alerting-********",
            "alertName": "scrapejob-cce-*****",
            "expr": "sum(kube_node_status_condition{condition=\"Ready\",status=\"false\",region=\"\", clusterID=~\"\"}) > 0",
            "for": "2m",
            "description": "cluster: {{ $labels.clusterID }}, region: {{ $labels.region }} SUM of node not Ready > 0, current: {{ $value | printf \"%.2f\" }}",
            "notifyRuleId": "notify-********",
            "labels": {
                "cprom_severity": "notice"
            }
        }
    ]        
}

创建采集任务接口

错误返回

百度智能云

Prometheus监控服务 CProm

Prometheus监控服务 CProm

告警相关接口

查询告警模板列表

查询通知策略列表

NotifyRule：

User：

UserGroup：

CallbackConfig：

WebhookDetail：

EscalateParam：

创建通知策略

User：

UserGroup：

CallbackConfig：

WebhookDetail：

EscalateParam：

更新通知策略

查看通知策略

删除通知策略

创建告警

更新告警

查看告警

删除告警

查看告警列表