为满足越来越多的自动化日志服务配置需求,日志服务提供命令行工具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游标。
日志管理 put_logs 写入日志。
get_logs 查询日志。
get_log_all 查询大量的日志。
get_histograms 获取日志分布情况。
pull_log 获取日志。
pull_logs 获取大量的日志。
pull_log_dump 并发下载大量日志到本地文件。
投递管理 create_shipper 创建日志投递任务。
delete_shipper 删除日志投递任务。
update_shipper 更新日志投递任务。
list_shipper 查询日志投递任务。
get_shipper_tasks 获取日志投递任务状态。
retry_shipper_tasks 重试失败的日志投递任务。
消费组管理 create_consumer_group 在指定的Logstore上创建一个消费组。
delete_consumer_group 删除一个指定的消费组。
update_consumer_group 修改指定消费组信息。
list_consumer_group 查询指定Logstore的所有消费组。
update_check_point 更新指定消费组消费数据时的checkpoint。
get_check_point 获取指定消费组消费数据时的checkpoint。

支持Cloud Shell

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

参考信息

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