获取索引字段列表 FieldCaps
更新时间：2026-06-23
- 获取索引字段列表。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /{name}/_field_caps HTTP/1.1
2Host: xxx.bj.baidubce.com
3Authorization: authorization string
4
5{
6 // 字段集合，可以使用*通配符
7 "fields": ["*"]
8}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | String | 是 | URL参数 | 索引名称，不支持模糊匹配 |
| fields | List<String> | 是 | RequestBody参数 | 索引字段名称，支持*通配符模糊匹配 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| indices | List<String> | 索引列表，目前只有一个元素 |
| fields | Map<String, Map<String, Field>> | 索引字段，字段名称-字段类型-字段元信息的关系 |
| error | Error | 错误原因 |
| status | Int | http状态码，比如：500 |
请求示例
Plain Text
1POST /my-index/_field_caps HTTP/1.1
2HOST bls-log.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 // 字段集合，可以使用*通配符
7 "fields": ["*"]
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8// 成功示例
9{
10 // 索引名称
11 "indices": ["my-index"],
12 // 字段信息
13 "fields": {
14 // user字段
15 "user": {
16 // 字段类型是keyword类型
17 // keyword: 关键字
18 // boolean: bool类型
19 // long: 整数类型
20 // double: 浮点数类型
21 // object: 对象类型
22 "keyword": {
23 // 字段类型
24 "type": "keyword",
25 // 该字段是否搜索
26 "searchable": true,
27 // 该字段是否可以聚合
28 "aggregatable": true,
29 // 该字段是否是元数据字段
30 "metadata_field": false
31 }
32 },
33 "created_at": {
34 "date": {
35 "type": "date",
36 "searchable": true,
37 "aggregatable": true,
38 "metadata_field": false
39 }
40 },
41 "status": {
42 "keyword": {
43 "type": "keyword",
44 "searchable": true,
45 "aggregatable": true,
46 "metadata_field": false
47 }
48 }
49 }
50}
51
52// 异常示例
53{
54 "error": {
55 "root_cause": [
56 {
57 "type": "action_request_validation_exception",
58 "reason": "action_request_validation_exception",
59 }
60 ],
61 "type": "action_request_validation_exception",
62 "reason": "action_request_validation_exception"
63 },
64 "status": 500
65}评价此篇文章