获取索引字段列表 FieldCaps
更新时间：2025-11-14
描述
获取索引字段列表
接口限制
- 入参仅支持路径参数和fields请求体字段，不支持其他参数，如：expand_wildcards，ignore_unavailable，allow_no_indices，include_unmapped，filters，types,include_empty_fields查询参数，以及index_filter和runtime_mappings请求体参数
- 返回结果中的字段信息仅包含type，searchable，aggregatable，metadata_field四个字段，不包含其他信息
请求
- 请求语法
Text
1POST /<name>/_field_caps HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | String | Yes | Path | 索引名称，不支持模糊匹配 |
| fields | List<String> | Yes | RequestBody | 索引字段名称，支持*通配符模糊匹配 |
成功响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| indices | List<String> | 索引列表，目前只有一个元素 |
| fields | Map<String, Map<String, Field>> | 索引字段，字段名称-字段类型-字段元信息的关系 |
上表中的 Field 对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| type | String | 字段类型，取值：keyword: 关键字，boolean: bool类型，long: 整数类型，double: 浮点数类型，object: 对象类型 |
| searchable | bool | 该字段是否支持搜索 true: 支持 false: 不支持 |
| aggregatable | bool | 该字段是否支持聚合 true: 支持 false: 不支持 |
| metadata_field | bool | 该字段是否是元数据字段 true: 是 false: 不是 |
异常响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| error | Error | 错误原因 |
| status | Int | http状态码，比如：500 |
上表中的 Error 对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| root_cause | List<Error> | 根原因 |
| type | String | 错误类型 |
| reason | String | 错误原因 |
示例
- 请求示例
Text
1POST /my-index/_field_caps HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
4Content-Type: application/json; charset=utf-8
5{
6 // 字段集合，可以使用*通配符
7 "fields": ["*"]
8}- 响应示例
Text
1HTTP/1.1 204
2Content-Type: application/json; charset=utf-8
3X-Bce-Request-Id: 2eeba101-4cc7-4cfe-b5ac-a3be8d060e33
4Date: Fri, 10 Apr 2020 04:42:37 GMT
5
6// 成功示例
7{
8 // 索引名称
9 "indices": ["my-index"],
10 // 字段信息
11 "fields": {
12 // user字段
13 "user": {
14 // 字段类型是keyword类型
15 // keyword: 关键字
16 // boolean: bool类型
17 // long: 整数类型
18 // double: 浮点数类型
19 // object: 对象类型
20 "keyword": {
21 // 字段类型
22 "type": "keyword",
23 // 该字段是否搜索
24 "searchable": true,
25 // 该字段是否可以聚合
26 "aggregatable": true,
27 // 该字段是否是元数据字段
28 "metadata_field": false
29 }
30 },
31 "created_at": {
32 "date": {
33 "type": "date",
34 "searchable": true,
35 "aggregatable": true,
36 "metadata_field": false
37 }
38 },
39 "status": {
40 "keyword": {
41 "type": "keyword",
42 "searchable": true,
43 "aggregatable": true,
44 "metadata_field": false
45 }
46 }
47 }
48}
49
50// 异常实例
51{
52 "error": {
53 "root_cause": [
54 {
55 "type": "action_request_validation_exception",
56 "reason": "action_request_validation_exception",
57 }
58 ],
59 "type": "action_request_validation_exception",
60 "reason": "action_request_validation_exception"
61 },
62 "status": 500
63}