全部產品
Search
文件中心

Simple Log Service:CLI概述

更新時間:Jun 30, 2024

為滿足越來越多的自動化Log Service配置需求,Log Service提供命令列工具CLI(Command Line Interface)。

主要功能

Log Service命令列工具CLI的主要功能包括:

  • 支援大部分的Log ServiceREST介面。例如管理Project、Logstore、機器組、消費組和Logtail配置等。

  • 支援多帳號,便於跨地區動作記錄。

  • 支援基本查詢和拉取日誌。

  • 支援Elasticsearch資料移轉。

  • 支援靈活的時間配置。

  • 支援高速跨域日誌複製,歷史資料重新索引。

子命令列表

Log ServiceCLI工具支援大部分Log ServiceAPI的功能,其支援的常用子命令列表如下。

資源分類

子命令

描述

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已內建Log ServiceCLI功能,您可以在任意瀏覽器上運行Cloud Shell,通過Log ServiceCLI管理Log Service資源。更多資訊,請參見使用Cloud Shell

參考資訊

更多資訊,請參見Log ServiceCLI