Alarm Management Interface V2

Last Updated：2025-11-14

Create Alarm Strategy

Request structure

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path
service	String	Cloud product name	Yes	Path
alarmConfigV2	AlarmConfigV2	Alarm configuration	Yes	RequestBody

Request example

{
    "userId": "453bf9********************9090dc",
 aliasName: Virtual Machine CPU Monitor,
    "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",  
        },
    ]
}

Response example

Successful response example

{
    "success": true,
    "msg": "",
    "result": {
 // Strategy name, a unique index for the Alarm Strategy, used for subsequent deletion and update operations
        "alarmName": "5cc380********************268123",
    }
}

Unsuccessful response example

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

Update Alarm Strategy

Request structure

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path
service	String	Cloud product name	Yes	Path
alarmConfigV2	AlarmConfigV2	Alarm configuration	Yes	RequestBody

Request example

// Request
{
 // Strategy name, returned by the strategy creation API
    "alarmName": "5cc380********************268123",
    
 // Other fields are the same as the strategy creation API
 // Note: Currently, Alarm Strategy does not support partial updates; only full updates are allowed
}

Shield Alarm Strategy

Request structure

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path
service	String	Cloud product name	Yes	Path
alarmName	String	Strategy name (refer to the value returned by the Alarm Strategy creation API)	Yes	Query

Request example

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

Enable Alarm Strategy

Request structure

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Path
service	String	Cloud product name	Yes	Path
alarmName	String	Strategy name (refer to the value returned by the Alarm Strategy creation API)	Yes	Query

Request example

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

View Alarm Strategy

Request structure

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID	Yes	Query
service	String	Cloud product name	Yes	Query
alarmName	String	Alarm name	Yes	Query

Request example

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

Response example

{
 alarmName: 5cc380********************268123,  // Unique identifier for Alarm Strategy, UUID type
 // For other fields, refer to AlarmConfigV2 in the appendix
}

View Alarm Strategy List

Request structure

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

Request parameters

Name	Types	Description	Required or not	Parameter location
userId	String	User ID is used to specify the user being queried.	Yes	Query
service	String	Cloud product for which alerts need to be queried, based on the scope parameter	Yes	Query
order	String	Sorting method (e.g., ascending or descending).	Yes	Query
pageNo	Integer	Page number for pagination queries	Yes	Query
pageSize	Integer	Number of entries returned per page	Yes	Query
scope	String	Specify cloud product for alerts	No	Query
region	String	Specify the region to which the alert belongs	No	Query
dimensions	String	Filter Alerts by specified Dimensions	No	Query
metricDimensions	String	Filter Alerts by Metric Dimensions	No	Query
actionEnabled	Boolean	Whether Alert is enabled	No	Query
typeName	String	Resource Type of Alert	No	Query
id	String	ID	Resource ID	Query
uuid	String	UUID	Resource UUID	Query
alarmNamePrefix	String	Alarm name prefix, enabling fuzzy queries	No	Query

Request example

GET    /csm/api/v2/userId/453bf**********9090dc/services/BCE_BCC/alarm/config/list?order=desc&pageNo=1&pageSize=2&region=bj&typeName=Instance&id=i-O8WtQNyQ

Response example

// Response
{
    "orderBy": "",
    "order": "",
    "pageNo": 1,
    "pageSize": 2,
    "totalCount": 455,
    "result": [
        {
            "userId": "453bf95**************090dc",
            "aliasName": "test-gz-rmq-0311",
            "alarmName": "85ffe3ee34bf4ab0bcf0958d33c461cb",
            "scope": "BCE_ROCKETMQ",
            "targetType": "TARGET_TYPE_ALL_INSTANCES",
            "resourceType": "Cluster",
            "alarmLevel": "MAJOR",
            "targetInstanceGroups": [],
            "targetInstanceTags": [],
            "callbackUrl": "",
            "callbackToken": "",
            "insufficientDataPendingPeriod": 0,
            "alarmRepeatInterval": 0,
            "alarmRepeatCount": 0,
            "source": "",
            "alarmMergeIntervalSecond": 0,
            "policies": [
                {
                    "rules": [
                        {
                            "metricName": "ClusterTopicCount",
                            "metricDimensions": [],
                            "operator": ">",
                            "statistics": "average",
                            "threshold": 50.0,
                            "window": 60
                        }
                    ],
                    "alarmPendingPeriodCount": 1
                }
            ],
            "targetInstances": [],
            "actions": []
        },
        {
            "userId": "453bf9588c9e488f9ba2c984129090dc",
            "aliasName": "sandbox_test_notify",
            "alarmName": "34cf2c7f34b447fb86ee51203931ab2c",
            "scope": "BCE_BCC",
            "targetType": "TARGET_TYPE_MULTI_INSTANCES",
            "resourceType": "Instance",
            "alarmLevel": "MAJOR",
            "targetInstanceGroups": [],
            "targetInstanceTags": [],
            "callbackUrl": "",
            "callbackToken": "",
            "insufficientDataPendingPeriod": 0,
            "alarmRepeatInterval": 0,
            "alarmRepeatCount": 0,
            "source": "",
            "alarmMergeIntervalSecond": 0,
            "policies": [
                {
                    "rules": [
                        {
                            "metricName": "CPUUsagePercent",
                            "metricDimensions": [],
                            "operator": ">",
                            "statistics": "average",
                            "threshold": 0.0,
                            "window": 60
                        }
                    ],
                    "alarmPendingPeriodCount": 1
                }
            ],
            "targetInstances": [
                {
                    "region": "bj",
                    "identifiers": [
                        {
                            "key": "InstanceId",
                            "value": "i-O8WtQNyQ"
                        }
                    ],
                    "metricDimensions": []
                },
                {
                    "region": "bj",
                    "identifiers": [
                        {
                            "key": "InstanceId",
                            "value": "i-Hk4ejWVT"
                        }
                    ],
                    "metricDimensions": []
                },
                {
                    "region": "bj",
                    "identifiers": [
                        {
                            "key": "InstanceId",
                            "value": "i-amuAeiKM"
                        }
                    ],
                    "metricDimensions": []
                },
                {
                    "region": "bj",
                    "identifiers": [
                        {
                            "key": "InstanceId",
                            "value": "i-M96hN3s1"
                        }
                    ],
                    "metricDimensions": []
                },
                {
                    "region": "bj",
                    "identifiers": [
                        {
                            "key": "InstanceId",
                            "value": "i-wAxU6sDS"
                        }
                    ],
                    "metricDimensions": []
                }
            ],
            "actions": []
        }
    ]
}

Appendix

AlarmConfigV2

Name	Types	Description
userId	String	User ID, required
aliasName	String	Alarm Strategy display name, required
region	String	Region to which the Alarm Strategy belongs, required. For multi-instance type Alarm Strategies, the Region here must be consistent with the Region to which the Instance belongs
scope	String	Cloud Product Name, required
insufficientDataPendingPeriod	int	No-data check period, unit: second, optional; if not set or set to 0, no-data alarm is disabled
alarmRepeatInterval	int	Repeated alarm period, value must be ≥ 300, unit: second, optional. If not set or set to 0, repeated alarm is disabled
alarmRepeatCount	int	Maximum number of repeated alarms, optional
resourceType	String	Sub-product type of the cloud product, optional, default value: Instance
alarmLevel	String	Alarm level, optional, default: CRITICAL, options: NOTICE (Notice), WARNING (Warning), MAJOR (Major), CRITICAL (Critical)
targetType	String	Alarm target type, required, options: TARGET_TYPE_ALL_INSTANCES (All Instances) TARGET_TYPE_INSTANCE_GROUP (Instance Group) TARGET_TYPE_MULTI_INSTANCES (Multiple Instances) TARGET_TYPE_INSTANCE_TAGS (Tags))
targetInstanceGroups	List<String>	Alarm Instance Group list, required if targetType=TARGET_TYPE_INSTANCE_GROUP
targetInstances	List<AlarmInstanceV2>	Alarm Instance list, required if targetType=TARGET_TYPE_MULTI_INSTANCES
targetInstanceTags	List<CommonKV>	Alarm tag list, required if targetType=TARGET_TYPE_INSTANCE_TAGS
policies	List<AlarmPolicyV2>	Alarm Strategy list, required. Multiple strategies are in an OR relationship
actions	List<AlarmActionV2>	Notification Template list, required. This template list will be uniformly used for anomaly notifications, recovery notifications, and repeated alarm notifications

AlarmPolicyV2

Name	Types	Description
rules	List<AlarmConfigPolicyRuleV2>	Alarm rule list, required. Multiple rules are in an AND relationship
alarmPendingPeriodCount	int	Trigger alarm after consecutive alarmPendingPeriodCount detection anomalies, required, value must be greater than 0

AlarmConfigPolicyRuleV2

Name	Types	Description
metricName	String	Metric name, required
metricDimensions	List<CommonKV>	Metric dimension, optional
operator	String	Threshold comparison method, required, options: 1. General comparison operators: >, >=, =, <, <=, != 2. MoM comparison operators: MoM increase >, MoM increase >=, MoM increase =, MoM increase <, MoM increase <=, MoM increase !=, MoM decrease >, MoM decrease >=, MoM decrease =, MoM decrease <, MoM decrease <=, MoM decrease !=
statistics	String	Metric aggregation method, required, options: average, maximum, minimum, and sum
threshold	double	Alarm threshold, required
window	int	Metric aggregation window, unit: second, optional, default value: 60

AlarmActionV2

Name	Types	Description
name	String	Notification Template name, required, Template names can be duplicated
id	String	Notification Template ID, optional

AlarmInstanceV2

Name	Types	Description
region	String	Region, required
identifiers	List<CommonKV>	Instance dimension, required
metricDimensions	List<CommonKV>	Metric dimension, optional

CommonKV

Name	Types
key	String
value	String

Alarm Management API

Application Monitor

百度智能云

Cloud Monitor

Alarm Management Interface V2

Create Alarm Strategy

Request structure

Request parameters

Request example

Response example

Update Alarm Strategy

Request structure

Request parameters

Request example

Shield Alarm Strategy

Request structure

Request parameters

Request example

Enable Alarm Strategy

Request structure

Request parameters

Request example

View Alarm Strategy

Request structure

Request parameters

Request example

Response example

View Alarm Strategy List

Request structure

Request parameters

Request example

Response example

Appendix

AlarmConfigV2

AlarmPolicyV2

AlarmConfigPolicyRuleV2

AlarmActionV2

AlarmInstanceV2

CommonKV