调用UpdateIndex接口更新指定Logstore的索引配置信息。该操作不会重建索引。
接口说明
- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。
-
已创建并获取AccessKey。更多信息，请参见访问密钥。
阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见创建RAM用户及授权。
- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见管理Project和管理Logstore。
- 索引配置（新增、编辑、删除字段，修改配置项等操作）只对新写入的日志生效。如果您要查询和分析历史日志，请重建索引。具体操作，请参见重建索引。
- 不同的索引配置，会产生不同的查询和分析结果，请根据您的需求，合理创建索引。如果您同时创建了全文索引和字段索引，以字段索引的配置为准。
- 控制台界面支持界面化配置索引，操作更便捷。具体操作，请参见创建索引。
鉴权资源
下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。
|
动作（Action） |
授权策略中的资源描述方式（Resource） |
log:UpdateIndex | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName} |
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。
请求语法
PUT /logstores/{logstore}/index HTTP/1.1请求参数
| 名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
| project | String | Host | 是 | ali-test-project |
Project名称。 |
| logstore | String | Path | 是 | test-logstore |
Logstore名称。 |
| Object | Body | 是 |
请求体。 |
||
| keys | Map | Body | 否 |
字段索引配置，key为字段名称，value为字段索引配置。 |
|
| Object | Body | 是 |
字段索引配置。 |
||
| caseSensitive | Boolean | Body | 否 | false |
是否大小写敏感。
|
| chn | Boolean | Body | 否 | false |
是否包含中文。仅当type参数取值为text时，必须设置。
|
| type | String | Body | 是 | text |
索引的字段类型。支持 text, json, double, long 四种类型。 |
| alias | String | Body | 否 | myAlias |
字段别名。 |
| token | Array of String | Body | 是 | . |
分词符列表，用于分割文本。 |
| doc_value | Boolean | Body | 是 | false |
是否开启字段统计。 |
| line | Object | Body | 否 |
全文索引配置。 |
|
| chn | Boolean | Body | 是 | false |
是否包含中文。
|
| caseSensitive | Boolean | Body | 是 | true |
是否大小写敏感。
|
| token | Array of String | Body | 是 | , |
分词符列表，用于分割文本。 |
| include_keys | Array of String | Body | 否 | includeField |
包含的字段列表。 |
| exclude_keys | Array of String | Body | 否 | excludeField |
排除的字段列表。 |
| ttl | Integer | Body | 是 | 30 |
数据的保存时间，单位为天。支持 7天、30天、90天。 |
| max_text_len | Integer | Body | 否 | 2048 |
统计字段的最大长度。 |
| log_reduce | Boolean | Body | 否 | false |
是否开启日志聚类，开启后白名单 |
| log_reduce_white_list | Array of String | Body | 否 | user |
白名单字段。 |
| log_reduce_black_list | Array of String | Body | 否 | time |
黑名单字段。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
| Server | String | nginx |
服务器名称。 |
| Content-Type | String | application/json |
返回的响应体的内容格式。 |
| Content-Length | String | 0 |
响应内容长度。 |
| Connection | String | close |
是否长链接。取值包括：
|
| Date | String | Sun, 27 May 2018 08:25:04 GMT |
返回响应的时间。 |
| x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 |
服务端产生的标识，该请求的唯一ID。 |
示例
请求示例
PUT /logstores/test-logstore/index HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
{
"keys" : {
"key" : {
"caseSensitive" : false,
"chn" : false,
"type" : "text",
"alias" : "myAlias",
"token" : [ "." ],
"doc_value" : false
}
},
"line" : {
"chn" : false,
"caseSensitive" : true,
"token" : [ "," ],
"include_keys" : [ "includeField" ],
"exclude_keys" : [ "excludeField" ]
},
"ttl" : 30,
"max_text_len" : 2048,
"log_reduce" : false,
"log_reduce_white_list" : [ "user" ],
"log_reduce_black_list" : [ "time" ]
}正常返回示例
JSON格式
HTTP/1.1 200 OK错误码
访问错误中心查看更多错误码。
|
HttpStatusCode |
ErrorCode |
ErrorMessage |
错误码描述 |
404 |
ProjectNotExist |
Project does not exist. |
Project不存在。 |
|
404 |
LogStoreNotExist |
Logstore does not exist. |
Logstore不存在。 |
|
400 |
ParameterInvalid |
Index detail too long, should be less or equal than 65535. |
索引配置过长。 |
|
500 |
InternalServerError |
Specified Server Error Message. |
内部服务调用错误。 |
更多信息，请参见通用错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/160409.html