通知模版列表
更新时间：2026-06-26
通知模板列表
分页查询通知模板列表，该接口支持按名称、策略ID筛选和排序。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
Plain Text
1POST /v3/bcm?action=DescribeNotifyTemplates HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name": "全体报警",
7 "order": "desc",
8 "orderBy": "createdTime",
9 "pageNo": 1,
10 "pageSize": 10
11}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为v3 |
| name | String | 否 | RequestBody参数 | 按通知模板名称筛选，支持部分匹配 |
| policyId | String | 否 | RequestBody参数 | 策略ID，查询被该策略使用的通知模板 |
| order | String | 否 | RequestBody参数 | 排序顺序，默认值：desc，可选值：desc / asc |
| orderBy | String | 否 | RequestBody参数 | 排序字段，默认值：updatedTime，可选值：updatedTime / createdTime |
| pageNo | Integer | 是 | RequestBody参数 | 页号，从1开始 |
| pageSize | Integer | 是 | RequestBody参数 | 页大小，取值范围：[1, 100] |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 响应码 |
| message | String | 错误信息 |
| notifyTemplates | List<NotifyTemplate> | 通知模板列表 |
| notifyTemplates.id | String | 通知模板ID |
| notifyTemplates.name | String | 通知模板名称 |
| notifyTemplates.source | String | 模板来源，可选值：SYSTEM（默认通知模板）/ CUSTOM（用户自定义创建） |
| notifyTemplates.silencePeriods | List<SilencePeriod> | 静默时间段列表 |
| notifyTemplates.receivers | List<NotifyReceiver> | 通知接收者列表 |
| notifyTemplates.callbacks | List<Callback> | 回调配置列表 |
请求示例
Plain Text
1POST /v3/bcm?action=DescribeNotifyTemplates 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": "全体报警",
7 "order": "desc",
8 "orderBy": "createdTime",
9 "pageNo": 1,
10 "pageSize": 10
11}响应示例
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 "notifyTemplates": [
13 {
14 "id": "e797d96f-9ffc-4e93-8022-f53a68de7f98",
15 "name": "测试1",
16 "source": "CUSTOM",
17 "silencePeriods": [{"from": "01:00:00", "to": "05:00:00"}],
18 "receivers": [{"id": "b9ede384b5b049c7b95a95e8438e341b", "name": "liuhuan26", "receiverType": "USER", "channels": ["SMS", "EMAIL"]}],
19 "callbacks": [{"url": "http://apiin.im.baidu.com/api/msg/groupmsgsend", "mention": {"type": "USERS", "userIds": ["u_12345"]}}]
20 }
21 ]
22}评价此篇文章