查询索引列表 ResolveIndex
更新时间：2025-10-13
描述
查询索引列表
接口限制
- 入参仅支持路径参数，不支持其他参数，如：expand_wildcards，ignore_unavailable，allow_no_indices，mode
- BLS都是DataStream类型，因此返回体中只有data_streams字段可能有值，indices和aliases字段返回都是空列表
请求
- 请求语法
Text
1GET /_resolve/index/<name> HTTP/1.1
2Host: <Endpoint>
3Authorization: <Authorization String>- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| name | String | Yes | Path | 索引名称，支持模糊匹配 |
成功响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| data_streams | Object | 索引列表 |
上表中的 data_streams 对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| name | String | 项目和日志集名称 default项目只显示名称了，非default项目为 项目名$日志集名称 的格式 |
| backing_indices | List<String> | 目前和name一样，只有单个元素 |
| timestamp_field | String | 时间字段, 取值为：@timestamp |
异常响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 字段 | 类型 | 描述 |
|---|---|---|
| error | Error | 错误原因 |
| status | Int | http状态码，比如：500 |
上表中的 Error 对象的元素结构如下：
| 字段 | 类型 | 描述 |
|---|---|---|
| root_cause | List<Error> | 根原因 |
| type | String | 错误类型 |
| reason | String | 错误原因 |
示例
- 请求示例
Text
1GET /_resolve/index/* 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- 响应示例
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 "indices": [],
9 "aliases": [],
10 "data_streams": [
11 {
12 // 项目和日志集名称 default项目只显示名称了，非default项目为 项目名$日志集名称 的格式
13 "name": "project$logStoreName", // default项目格式为：logStoreName
14 // 对于BLS，和name一样
15 "backing_indices": ["project$logStoreName"],
16 // 时间字段
17 "timestamp_field": "@timestamp"
18 }
19 ]
20}
21
22// 异常实例
23{
24 "error": {
25 "root_cause": [
26 {
27 "type": "invalid_index_name_exception",
28 "reason": "invalid_index_name_exception",
29 }
30 ],
31 "type": "invalid_index_name_exception",
32 "reason": "invalid_index_name_exception"
33 },
34 "status": 500
35}