报警管理接口V2

更新时间：2023-12-20

创建报警策略

请求结构

method：POST
URL：/csm/api/v2/userId/{userId}/services/{service}/alarm/config/create

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	Path参数
service	String	云产品名称	是	Path参数
alarmConfigV2	AlarmConfigV2	报警配置	是	RequestBody参数

请求示例

{
    "userId": "453bf9********************9090dc",
    "aliasName": "虚机CPU监控",
    "region": "bj",
    "scope": "BCE_BCC",
    "policies": [
        {
            "rules": [
                {
                    "metricName": "CpuUsage",
                    "metricDimensions": [],
                    "operator": ">",
                    "statistics": "average",
                    "threshold": 80,
                    "window": 60,                   
                },
            ],
            "alarmPendingPeriodCount": 3
        }
    ],
    
    "insufficientDataPendingPeriod": 300,
    "alarmRepeatInterval": 300,
    "alarmRepeatCount": 10,
    "targetType": "TARGET_TYPE_MULTI_INSTANCES",
    "targetInstances": [
        {
            "region": "bj",
            "identifiers": [
                {
                    "key": "InstanceId",
                    "value": "i-FYc6EU**"
                }
            ]
        }
    ],
    "resourceType": "Instance",
    "alarmLevel": "NOTICE",
    "actions": [
        {
            "name": "notifyRdTeam",
            "id": "0262f103-****-****-****-078d0f2d80c5",  
        },
    ]
}

响应示例

成功响应示例

{
    "success": true,
    "msg": "",
    "result": {
        // 策略名，唯一索引报警策略，用于后续的删除和更新操作
        "alarmName": "5cc380********************268123",
    }
}

失败响应示例

{
    "success": false,
    "msg": "Invalid parameter, aliasName is empty!",
    "result": {
        "alarmName": null
    }
}

更新报警策略

请求结构

method：PUT
URL：/csm/api/v2/userId/{userId}/services/{service}/alarm/config/update

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	Path参数
service	String	云产品名称	是	Path参数
alarmConfigV2	AlarmConfigV2	报警配置	是	RequestBody参数

请求示例

// Request
{
    // 策略名，由策略创建接口返回
    "alarmName": "5cc380********************268123",
    
    // 其余字段同策略创建接口
    // 注意，目前报警策略不支持部分更新，只能全量更新
}

屏蔽报警策略

请求结构

method：POST
URL：/csm/api/v2/userId/{userId}/services/{service}/alarm/config/block?{Query参数}

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	Path参数
service	String	云产品名称	是	Path参数
alarmName	String	策略名（参考创建报警策略接口返回值）	是	Query参数

请求示例

POST    /csm/api/v2/userId/453bf9********************9090dc/services/BCE_BCC/alarm/config/block?
alarmName=5cc380********************268123

开启报警策略

请求结构

method：POST
URL：/csm/api/v2/userId/{userId}/services/{service}/alarm/config/unblock?{Query参数}

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户ID	是	Path参数
service	String	云产品名称	是	Path参数
alarmName	String	策略名（参考创建报警策略接口返回值）	是	Query参数

请求示例

POST    /csm/api/v2/userId/453bf9********************9090dc/services/BCE_BCC/alarm/config/unblock?
alarmName=5cc380********************268123

查看报警策略

请求结构

Method：GET
URL：/csm/api/v2/userId/{userId}/services/{service}/alarm/config?{Query参数}

请求参数

名称	类型	描述	是否必须	参数位置
userId	String	用户id	是	Query参数
service	String	云产品名称	是	Query参数
alarmName	String	报警名	是	Query参数

请求示例

GET    /csm/api/v2/userId/453bf9********************9090dc/services/BCE_BCC/alarm/config?
alarmName=5cc380********************268123

响应示例

{
    "alarmName": "5cc380********************268123",  // 报警策略唯一标识，UUID类型 
    // 其余字段参考附录中的AlarmConfigV2
}

附录

AlarmConfigV2

名称	类型	描述
userId	String	用户id，必填
aliasName	String	报警策略展示名，必填
region	String	报警策略所属地域，必填，针对多实例类型报警策略此处region必须和实例所属region保持一致
scope	String	云产品名称，必填
insufficientDataPendingPeriod	int	无数据检查周期，单位：秒，选填，若未设置或设置为0，表示不进行无数据报警
alarmRepeatInterval	int	重复报警周期，取值必须大于或等于300，单位：秒，选填，若未设置或设置为0，表示不进行重复报警
alarmRepeatCount	int	重复报警最大次数，选填
resourceType	String	云产品的子产品类型，选填，默认值Instance
alarmLevel	String	报警级别，选填，默认CRITICAL，可选项：NOTICE（通知）、WARNING（警告）、MAJOR（重要）、CRITICAL（严重）
targetType	String	报警目标类型，必填，可选项： TARGET_TYPE_ALL_INSTANCES（全部实例） TARGET_TYPE_INSTANCE_GROUP（实例组） TARGET_TYPE_MULTI_INSTANCES（多实例） TARGET_TYPE_INSTANCE_TAGS（标签）
targetInstanceGroups	List<String>	报警实例组列表，若targetType=TARGET_TYPE_INSTANCE_GROUP，该字段必填
targetInstances	List<AlarmInstanceV2>	报警实例列表，若targetType=TARGET_TYPE_MULTI_INSTANCES，该字段必填
targetInstanceTags	List<CommonKV>	报警标签列表，若targetType=TARGET_TYPE_INSTANCE_TAGS，该字段必填
policies	List<AlarmPolicyV2>	报警策略列表，必填，多个策略之间是或关系
actions	List<AlarmActionV2>	通知模板列表，必填，该模板列表将被统一用于异常通知，恢复正常通知，重复报警通知

AlarmPolicyV2

名称	类型	描述
rules	List<AlarmConfigPolicyRuleV2>	报警规则列表，必填，多个规则之间是且关系
alarmPendingPeriodCount	int	连续发生alarmPendingPeriodCount次检测异常后，触发警报，必填，取值必须大于0

AlarmConfigPolicyRuleV2

名称	类型	描述
metricName	String	监控项名称，必填
metricDimensions	List<CommonKV>	指标维度，选填
operator	String	阈值比较方式，必填，可选值： 1. 一般比较符：>、>=、=、<、<=、!= 2. 环比比较符：环比增长>、环比增长>=、环比增长=、环比增长<、环比增长<=、环比增长!=、环比减少>、环比减少>=、环比减少=、环比减少<、环比减少<=、环比减少!=
statistics	String	指标聚合方式，必填，可选值：average（平均值）、maximum（最大值）、minimum（最小值）、sum（和值）
threshold	double	报警阈值，必填
window	int	指标聚合窗口，单位：秒，选填，默认值：60

AlarmActionV2

名称	类型	描述
name	String	通知模板名称，必填，模板名称是可以重复的
id	String	通知模板id，选填

AlarmInstanceV2

名称	类型	描述
region	String	地域，必填
identifiers	List<CommonKV>	实例维度，必填
metricDimensions	List<CommonKV>	指标维度，选填

CommonKV

名称	类型
key	String
value	String

报警管理接口

通知模版

百度智能云

云监控 BCM

云监控 BCM

报警管理接口V2

创建报警策略

请求结构

请求参数

请求示例

响应示例

更新报警策略

请求结构

请求参数

请求示例

屏蔽报警策略

请求结构

请求参数

请求示例

开启报警策略

请求结构

请求参数

请求示例

查看报警策略

请求结构

请求参数

请求示例

响应示例

附录

AlarmConfigV2

AlarmPolicyV2

AlarmConfigPolicyRuleV2

AlarmActionV2

AlarmInstanceV2

CommonKV