创建报警屏蔽
更新时间：2026-06-26
创建报警屏蔽规则
创建一条报警屏蔽规则，用于在指定时间段内屏蔽指定资源的报警通知。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v3/bcm?action=CreateAlarmMasking HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name": "masking-test",
7 "scope": "BCE_BCC",
8 "resourceType": "Instance",
9 "policyId": "policy-abc123",
10 "instances": [
11 {
12 "region": "bj",
13 "identifiers": [
14 {"name": "instanceId", "value": "i-xxx"}
15 ]
16 }
17 ],
18 "region": "bj",
19 "metricNames": ["CPUUsagePercent"],
20 "periodType": "FIXED",
21 "beginTime": "2024-10-11T10:00:00Z",
22 "endTime": "2024-10-11T12:00:00Z",
23 "tz": "Asia/Shanghai",
24 "dailyBeginTimestamp": null,
25 "dailyEndTimestamp": null
26}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为v3 |
| name | String | 是 | RequestBody参数 | 屏蔽规则名称 |
| scope | String | 是 | RequestBody参数 | 云产品命名空间 |
| resourceType | String | 是 | RequestBody参数 | 资源类型 |
| policyId | String | 否 | RequestBody参数 | 报警策略ID |
| instances | List<TargetInstance> | 是 | RequestBody参数 | 屏蔽的实例列表 |
| region | String | 是 | RequestBody参数 | 地域 |
| metricNames | List |
否 | RequestBody参数 | 屏蔽的指标名称列表 |
| periodType | String | 否 | RequestBody参数 | 屏蔽时间类型，默认FOREVER，可选FOREVER/FIXED/RELATIVE |
| beginTime | String | 否 | RequestBody参数 | 屏蔽开始时间，periodType为FIXED时必填 |
| endTime | String | 否 | RequestBody参数 | 屏蔽结束时间，periodType为FIXED时必填 |
| tz | String | 否 | RequestBody参数 | 时区 |
| dailyBeginTimestamp | Integer | 否 | RequestBody参数 | 每日屏蔽开始时间戳，periodType为RELATIVE时必填 |
| dailyEndTimestamp | Integer | 否 | RequestBody参数 | 每日屏蔽结束时间戳，periodType为RELATIVE时必填 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 状态码 |
| message | String | 描述信息 |
| id | String | 创建的屏蔽规则ID |
请求示例
Plain Text
1POST /v3/bcm?action=CreateAlarmMasking HTTP/1.1
2HOST bcm.bj.baidubce.com
3Authorization bce-auth-v1/accessKeyId/2024-10-11T10:00:00Z/1800/host/signature
4
5{
6 "name": "masking-test",
7 "scope": "BCE_BCC",
8 "resourceType": "Instance",
9 "policyId": "policy-abc123",
10 "instances": [
11 {
12 "region": "bj",
13 "identifiers": [
14 {"name": "instanceId", "value": "i-xxx"}
15 ]
16 }
17 ],
18 "region": "bj",
19 "metricNames": ["CPUUsagePercent"],
20 "periodType": "FIXED",
21 "beginTime": "2024-10-11T10:00:00Z",
22 "endTime": "2024-10-11T12:00:00Z",
23 "tz": "Asia/Shanghai"
24}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 8a3b5c7d-1234-5678-abcd-ef0123456789
3Date: Fri, 11 Oct 2024 10:10:30 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "success": true,
10 "code": "OK",
11 "message": "",
12 "id": "masking-abcdef123456"
13}评价此篇文章