DescribeIndex
Last Updated：2020-10-21
Description
Get the index structure information of the specified log set.
Request
- Request syntax
GET /v1/logstore/{logStoreName}/index HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String> - Request header
Except for the public request header, there are no other special headers.
- Request parameter
| Parameter name | Type | Required or not | Parameter location | Description |
|---|---|---|---|---|
| logStoreName | String | Yes | Path | Log set name |
Response
- Response header
Except for the public response header, there are no other special headers.
- Response parameter
| Parameter name | Type | Description |
|---|---|---|
| fields | Object | Index field information |
Error Code
In addition to general error codes, the following error codes may also appear.
| Error code | Error message | Description | HTTP status code |
|---|---|---|---|
| IndexNotFound | LogStore index not exists | LogStore does not exist | 404 |
Example
- Request example
GET /v1/logstore/demo/index 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 - Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"fields": {
"age": {
"type": "long"
},
"salary": {
"type": "float"
}
}
}