通知对象列表获取
更新时间：2026-06-26
通知对象列表获取
查询通知对象列表，该接口用于获取用户或用户组信息，可按名称进行模糊匹配搜索。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v3/bcm?action=DescribeReceivers HTTP/1.1
2Host: bcm.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "type": "USER",
7 "name": "zmq",
8 "pageNo": 1,
9 "pageSize": 10
10}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为v3 |
| type | String | 是 | RequestBody参数 | 对象类型，可选值：USER（单用户）/ USER_GROUP（用户组） |
| name | String | 否 | RequestBody参数 | 用户名或用户组名，支持部分匹配 |
| pageNo | Integer | 是 | RequestBody参数 | 页号，从1开始 |
| pageSize | Integer | 是 | RequestBody参数 | 页大小 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 响应码 |
| message | String | 错误信息 |
| receivers | List<Receiver> | 通知对象列表 |
请求示例
Plain Text
1POST /v3/bcm?action=DescribeReceivers HTTP/1.1
2HOST bcm.bj.baidubce.com
3Authorization bce-auth-v1/accessKeyId/2024-10-11T10:00:00Z/1800/host/signature
4
5{
6 "type": "USER",
7 "name": "zmq",
8 "pageNo": 1,
9 "pageSize": 10
10}响应示例
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 "receivers": [
13 {
14 "id": "6cc4f982fd4e4856b9eb6d46f9d829ec",
15 "domainId": "a0d04d7c202140cb80155ff7b6752ce4",
16 "name": "zhangpeng63",
17 "email": "li********3@baidu.com",
18 "phone": "*******8167"
19 }
20 ]
21}评价此篇文章