文档

CLI概述

更新时间:

为满足越来越多的自动化日志服务配置需求,日志服务提供命令行工具CLI(Command Line Interface)。

主要功能

日志服务命令行工具CLI的主要功能包括:
  • 支持大部分的日志服务REST接口。例如管理Project、Logstore、机器组、消费组和Logtail配置等。
  • 支持多账号,便于跨地域操作日志。
  • 支持基本查询和拉取日志。
  • 支持Elasticsearch数据迁移。
  • 支持灵活的时间配置。
  • 支持高速跨域日志复制,历史数据重新索引。

子命令列表

日志服务CLI工具支持大部分日志服务API的功能,其支持的常用子命令列表如下。
资源分类子命令描述
Project管理create_project创建Project。
delete_project删除Project。
get_project获取指定Project信息。
list_project查询所有Project信息。
copy_project复制源Project的所有Logstore、Logtail、机器组和索引配置等到目标Project中。
Logstore管理create_logstore创建Logstore。
delete_logstore删除Logstore。
get_logstore获取指定Logstore信息。
list_logstore查询所有Logstore信息。
update_logstore更新Logstore信息。
Shard管理list_shards获取Shard信息。
split_shard分裂Shard。
merge_shard合并Shard。
Logtail机器组管理create_machine_group创建机器组。
delete_machine_group删除机器组。
update_machine_group更新机器组信息。
get_machine_group获取指定机器组信息。
list_machine_group查询所有机器组信息。
list_machines查询指定机器组内的机器信息。
Logtail配置管理create_logtail_config创建Logtail配置。
update_logtail_config更新Logtail配置。
delete_logtail_config删除Logtail配置。
get_logtail_config获取指定Logtail配置信息。
list_logtail_config查询所有Logtail配置信息。
机器组与Logtail配置关联apply_config_to_machine_group将Logtail配置应用到机器组。
remove_config_to_machine_group从机器组中移除Logtail配置。
get_machine_group_applied_configs获取目标机器组上已经被应用的Logtail配置列表。
get_config_applied_machine_groups获取已应用Logtail配置的机器组列表。
索引管理create_index为指定Logstore创建索引。
delete_index删除指定Logstore的索引。
update_index更新指定Logstore的索引。
get_index_config查询指定Logstore的索引。
游标管理get_cursor根据时间获取对应的游标。
get_cursor_time根据游标获取服务端时间。
get_previous_cursor_time根据前一个游标获取服务端时间。
get_begin_cursor获取BEGIN游标。
get_end_cursor获取END游标。
日志管理get_logs查询日志。通过JSON文件配置查询请求,适用于精确查询场景。
get_log查询指定数量日志。
get_log_all查询大批量日志。
get_histograms获取日志分布情况。
pull_log获取日志。
pull_logs获取大量的日志。
pull_log_dump并发下载大量日志到本地文件。
消费组管理create_consumer_group在指定的Logstore上创建一个消费组。
delete_consumer_group删除一个指定的消费组。
update_consumer_group修改指定消费组信息。
list_consumer_group查询指定Logstore的所有消费组。
update_check_point更新指定消费组消费数据时的checkpoint。
get_check_point获取指定消费组消费数据时的checkpoint。
关联外部数据源create_external_store关联外部数据源。当前支持关联RDS MySQL、OSS、本地CSV文件作为外部数据源。
delete_external_store删除外部数据源。
get_external_store查询指定外部数据源的详细配置。
list_external_store查询已关联的外部数据源。
update_external_store修改关联的外部数据源。

支持Cloud Shell

云命令行(Cloud Shell)是网页版命令行工具。Cloud Shell已内置日志服务CLI功能,您可以在任意浏览器上运行Cloud Shell,通过日志服务CLI管理日志服务资源。更多信息,请参见使用Cloud Shell

参考信息

更多信息,请参见日志服务CLI

  • 本页导读 (1)
文档反馈