调用CLI命令创建索引

更新时间:
复制 MD 格式

调用CLI命令为指定Logstore创建索引配置。创建索引后,才能使用查询语法或SQL分析功能。

注意事项

在使用CLI命令之前,您需要注意以下事项:

  • 已开通日志服务。

  • 已安装日志服务CLI安装与配置

  • 已创建日志服务ProjectLogstore。

  • 创建索引时,至少需要配置全文索引(line)或字段索引(keys)其中之一。

  • 索引创建后约1分钟内生效,索引只对新写入的数据生效,历史数据可通过主动重建索引生效。

命令格式

aliyun sls create-index --project=<value> --logstore=<value> [--line=<value>] [--keys=<value>]

命令参数

该命令的必选和特有参数描述如下。

参数名称

数值类型

是否必选

示例值

描述

--project

String

aliyun-test-project

Project名称。

--logstore

String

aliyun-test-logstore

Logstore名称。

--line

String

见示例

全文索引配置。JSON格式,支持关键字搜索。包含以下字段:caseSensitive:是否区分大小写。chn:是否包含中文。token:分词符列表。

--keys

String

见示例

字段索引配置。JSON格式,支持字段过滤和SQL分析。每个字段包含以下属性:type:字段类型(text/long/double/json)。doc_value:是否开启分析功能,建议true。alias:字段别名。caseSensitive:是否区分大小写(text/json)。chn:是否包含中文(text/json)。token:分词符列表(text/json)。

关于该命令的全局参数,请参见全局参数。

命令示例

创建全文索引

  • 命令示例

aliyun sls create-index --project="aliyun-test-project" --logstore="aliyun-test-logstore" \
  --line '{"chn":false,"caseSensitive":false,"token":[","," ",";","=","(",")","[","]","{","}",":","\n","\t","\r"]}'
  • 返回示例

命令执行成功后,无响应消息。

创建全文索引和字段索引

对于复杂的JSON配置,建议写入文件后引用:

  • 命令示例

# 创建字段索引配置文件
cat > /tmp/keys.json << 'EOF'
{
  "region": {
    "doc_value": true,
    "alias": "",
    "type": "text",
    "caseSensitive": false,
    "chn": false,
    "token": [",", " ", ";", "=", "(", ")", "[", "]", "{", "}", ":", "\n", "\t", "\r"]
  },
  "status": {
    "doc_value": true,
    "alias": "",
    "type": "long"
  },
  "request_time": {
    "doc_value": true,
    "alias": "",
    "type": "double"
  }
}
EOF

# 创建索引
aliyun sls create-index --project="aliyun-test-project" --logstore="aliyun-test-logstore" \
  --line '{"caseSensitive":false,"chn":false}' \
  --keys "$(cat /tmp/keys.json)"
  • 返回示例

命令执行成功后,无响应消息。

相关文档

  • 在调用API接口过程中,若服务端返回结果中包含错误信息,则表示调用API接口失败。您可以参考API错误码对照表查找对应的解决方法。更多信息,请参见PutLogs

  • 阿里云OpenAPI开发者门户提供调试、SDK、示例和配套文档。通过OpenAPI,您无需手动封装请求和签名操作,就可以快速对日志服务API进行调试。更多信息,请参见OpenAPI开发者门户

API参考

创建索引