查询可绑定消费者列表
更新时间：2026-09-21
该接口用于分页查询指定 Service 或 API 可绑定的消费者，并返回每个消费者的绑定状态和对应认证凭证持有状态。
查询范围包含当前账号下已禁用的消费者。
请求结构
Plain Text
1POST /?action=DescribeBindableConsumers HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "keyword": keyword,
7 "keywordType": keywordType,
8 "pageNo": pageNo,
9 "pageSize": pageSize,
10 "order": order,
11 "orderBy": orderBy,
12 "orders" : [order],
13 "filters" : [filter],
14 "serviceId": serviceId,
15 "apiId": apiId
16}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| keyword | String | 否 | RequestBody参数 | 关键字 |
| keywordType | String | 否 | RequestBody参数 | 关键字类型 |
| pageNo | int | 否 | RequestBody参数 | 页码 |
| pageSize | int | 否 | RequestBody参数 | 每页数据项数目 |
| order | String | 否 | RequestBody参数 | 排序方向 |
| orderBy | String | 否 | RequestBody参数 | 排序字段 |
| orders | List<OrderModel> | 否 | RequestBody参数 | 多重排序 |
| filters | List<FilterModel> | 否 | RequestBody参数 | 过滤字段 |
| serviceId | String | 否 | RequestBody参数 | 服务 ID；与 apiId 二选一 |
| apiId | String | 否 | RequestBody参数 | API ID；与 serviceId 二选一 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 排序字段 |
| order | String | 排序方向 |
| pageNo | int | 页码 |
| pageSize | int | 每页数据项数目 |
| totalCount | long | 数据总条数 |
| result | List<DescribeBindableConsumersResp> | 当前页的消费者列表 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON，无法解析，请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源，请确认使用正确的账号凭证且资源属于当前账号 |
| ServiceNotExist | Service not exist. | 404 | serviceId 对应的服务不存在、不属于当前账号或已删除 |
| ApiNotExist | Api not exist. | 404 | apiId 对应的路由不存在、不属于当前账号或已删除 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持，请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribeBindableConsumers HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "serviceId": "sg-a1b2c3d4",
7 "pageNo": 1,
8 "pageSize": 20
9}返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "pageNo": 1,
9 "pageSize": 20,
10 "totalCount": 2,
11 "result": [
12 {
13 "consumerId": "consumer-a1b2c3d4",
14 "name": "生产消费者",
15 "status": "Enable",
16 "bound": true,
17 "hasCredential": true
18 },
19 {
20 "consumerId": "consumer-e5f6g7h8",
21 "name": "测试消费者",
22 "status": "Enable",
23 "bound": false,
24 "hasCredential": false
25 }
26 ]
27}评价此篇文章