为指定Logstore创建索引。
接口说明
Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
log:CreateIndex | Write |
|
| 无 |
请求语法
POST /logstores/{logstore}/index
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
logstore | string | 是 | Logstore 的名称。 | ali-logstore-test |
project | string | 是 | Project 名称。 | ali-project-test |
body | object | 否 | 请求消息体。 | |
keys | object | 否 | 字段索引配置,key 为字段名称,value 为字段索引配置。该参数和 line 必须至少指定一个,更多示例,请参见示例。 | |
object | 否 | 单个字段的索引配置。 | ||
caseSensitive | boolean | 否 | 是否大小写敏感。仅当 type 参数取值为 text 时,必须设置。
| false |
chn | boolean | 否 | 是否包含中文。仅当 type 参数取值为 text 时,必须设置。
| false |
type | string | 是 | 索引的字段类型。支持 text, json, double, long 四种类型。 | text |
alias | string | 否 | 字段别名。 | myAlias |
token | array | 否 | 分词符列表,用于分割文本。 | |
string | 否 | 分词符。 | . | |
doc_value | boolean | 否 | 是否开启字段统计。 | false |
line | object | 否 | 全文索引配置。该参数和 keys 必须至少指定一个,更多示例,请参见示例。 | |
chn | boolean | 否 | 是否包含中文。
| false |
caseSensitive | boolean | 否 | 是否大小写敏感。
| false |
token | array | 是 | 分词符列表。可以设置一个分词参数,指定这个字段按照哪一种方式分词。更多分词符,请参见示例。 | |
string | 否 | 分词符列表。可以设置一个分词参数,指定这个字段按照哪一种方式分词。更多分词符,请参见示例。 | , | |
include_keys | array | 否 | 包含的字段列表,不能与 exclude_keys 同时指定。 | |
string | 否 | 包含的字段列表,不能与 exclude_keys 同时指定。 | includeKey | |
exclude_keys | array | 否 | 排除的字段列表,不能与 include_keys 同时指定。 | |
string | 否 | 排除的字段列表,不能与 include_keys 同时指定。 | excludeKey | |
ttl | integer | 否 | 日志保存时间,单位为天。可选 7 天、30 天、90 天。 | 30 |
max_text_len | integer | 否 | 日志服务默认字段值的最大长度为 2048 字节,即 2 KB。如果您需要修改字段值的最大长度,可设置统计字段(text)最大长度,取值范围为 64~16384 字节。 | 2048 |
log_reduce | boolean | 否 | 是否开启日志聚类。开启后白名单与黑名单至多生效其中一个。 | false |
log_reduce_white_list | array | 否 | 日志聚类的聚类字段白名单。 | |
string | 否 | 日志聚类的聚类字段白名单。 | a | |
log_reduce_black_list | array | 否 | 日志聚类的聚类字段黑名单。 | |
string | 否 | 日志聚类的聚类字段黑名单。 | b |
返回参数
示例
正常返回示例
JSON
格式
{}
错误码
访问错误中心查看更多错误码。
HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |
---|---|---|---|
400 | IndexInfoInvalid | Required field token is lacking or of error format. | 缺少必要的字段标记或格式配置错误。 |
400 | IndexAlreadyExist | Logstore index is already created. | 日志索引已经创建。 |
404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
404 | LogStoreNotExist | Logstore does not exist. | Logstore 不存在。 |
500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |
更多信息,请参见通用错误码。