获取索引详情DescribeIndex
更新时间:2026-06-23
- 获取指定日志集的索引信息。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1GET /v{version}/logstore/{logStoreName}/index?project={project} HTTP/1.1
2Host: xxx.bj.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号,当前取值为1 |
| project | String | 否 | Query参数 | 日志组名称,默认default |
| logStoreName | String | 是 | URL参数 | 日志集名称 |
返回状态码
成功返回200,失败返回见错误码
返回头域
除公共头域外,无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码,成功为OK,错误为具体的错误码 |
| fulltext | Boolean | 是否开启全文索引,true 表示开启 |
| fields | map<string,IndexField> | 字段索引的字段名称和类型信息 |
| caseSensitive | Boolean | 全文索引是否开启大小写敏感,true表示开启大小写敏感 |
| includeChinese | Boolean | 是否包含中文,true表示包含中文 |
| separators | String | 全文分词符 |
请求示例
Plain Text
1GET /v1/logstore/demo/index?project=default 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 "name":"eip-for-test"
7}
响应示例
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 "success": true
10 "code": "OK"
11 "fulltext": true,
12 "caseSensitive" : true,
13 "includeChinese" : true,
14 "separators" : "@&?",
15 "fields": {
16 "age": {
17 "type": "long",
18 "caseSensitive" : true,
19 "includeChinese" : true,
20 "separators" : "@&?",
21 "dynamicMapping" : false
22 },
23 "salary": {
24 "type": "float",
25 "caseSensitive" : true,
26 "includeChinese" : false,
27 "separators" : "@&?|#()='\",;:<>[]{}/ \n\t\r\\",
28 "dynamicMapping" : false
29 }
30 }
31}
评价此篇文章
