DescribeIndex
更新时间：2024-09-11
描述
获取指定日志集的索引信息。
请求
- 请求语法
GET /v1/logstore/{logStoreName}/index?project={project} HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String>- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| project | String | No | Query | 日志组名称，默认default |
| logStoreName | String | Yes | Path | 日志集名称 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| fulltext | Boolean | 是否开启全文索引，true 表示开启 |
| fields | Object | 字段索引的字段名称和类型信息 |
其中，fields 为 Map Object 结构，key 即为字段名称，value 为 logField 结构体，以下为 LogField 结构体的定义：
| 参数名称 | 类型 | 描述 |
|---|---|---|
| type | String | 字段的类型，支持的类型有：bool、long、text、float |
错误码
除了通用的错误码，还可能出现如下错误码：
| 错误码 | 错误消息 | 描述 | HTTP状态码 |
|---|---|---|---|
| IndexNotFound | LogStore index not exists | LogStore 不存在 | 404 |
示例
- 请求示例
GET /v1/logstore/demo/index?project=default HTTP/1.1
Host: bls-log.bj.baidubce.com
Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304- 响应示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"fulltext": false,
"fields": {
"age": {
"type": "long"
},
"salary": {
"type": "float"
}
}
}