全部产品
Search
文档中心

日志服务:API概览

更新时间:Feb 01, 2024

本文罗列了日志服务API。

项目(Project)

API名称

API说明

CreateProject

创建一个Project。

DeleteProject

删除目标Project。

UpdateProject

更新某个指定Project的描述信息。

GetProject

获取某个指定Project的详细信息。

ListProject

列出符合条件的Project的详细信息。

GetProjectLogs

获取Project下的所有日志。

该接口为Project级别的SQL查询接口。

日志库(Logstore)

API名称

API说明

CreateLogStore

创建一个Logstore。

DeleteLogStore

删除某个指定的Logstore。

UpdateLogStore

更新某个指定Logstore的属性信息。

GetLogStore

获取某个指定Logstore的详细信息。

ListLogStores

列出指定Project下符合条件的Logstore。

日志管理(Log)

API名称

API说明

PutLogs

向指定的Logstore中写入日志。

PostLogStoreLogs

向指定的Logstore中写入日志。

PutWebtracking

合并多条日志并进行采集。

GetLogs

查询指定Logstore中的日志。

GetHistograms

查询指定Logstore中满足查询语法条件的日志的分布情况。

GetCursor

根据时间获取对应的游标。

GetCursorTime

获取游标对应的服务端时间。

GetContextLogs

查询指定日志前(上文)后(下文)的若干条日志。

PullData

获取指定游标位置的日志。

ClearLogStoreStorage

清空Logstore的存储内容。

Logtail机器组(Machine Group)

API名称

API说明

CreateMachineGroup

创建一个机器组。

DeleteMachineGroup

删除某个指定的机器组。

UpdateMachineGroup

更新某个指定机器组的配置信息。

GetMachineGroup

获取指定机器组的详细信息。

ListMachines

列出目标机器组中与日志服务连接正常的机器。

ListMachineGroup

列出指定Project下符合条件的机器组。

ApplyConfigToMachineGroup

将Logtail配置应用到目标机器组。

RemoveConfigFromMachineGroup

从目标机器组中移除Logtail配置。

GetAppliedConfigs

查询目标机器组上已经应用的Logtail配置。

Logtail配置(Logtail Config)

API名称

API说明

CreateConfig

创建一个Logtail配置。

DeleteConfig

删除某个指定的Logtail配置。

UpdateConfig

更新某个指定的Logtail配置。

GetConfig

获取某个指定Logtail配置的详细信息。

ListConfig

列出指定Project下所有符合条件的Logtail配置。

GetAppliedMachineGroups

获取已绑定指定Logtail配置的机器组列表。

索引(Index)

API名称

API说明

CreateIndex

为指定的Logstore创建索引。

DeleteIndex

删除指定Logstore的索引。

UpdateIndex

更新指定Logstore的索引。

GetIndex

查询指定Logstore的索引。

分区(Shard)

API名称

API说明

ListShards

列出指定Logstore中所有的Shard。

SplitShard

分裂指定的readwrite状态的Shard。

MergeShard

合并两个相邻的readwrite状态的Shard。

投递(Ship)

API名称

API说明

GetShipperStatus

查询日志投递任务状态。

RetryShipperTask

重试失败投递任务。

消费组(Consumer Group)

API名称

API说明

CreateConsumerGroup

在指定的Logstore上创建一个消费组。

DeleteConsumerGroup

删除指定的消费组。

UpdateConsumerGroup

修改指定消费组的属性信息。

GetCheckPoint

获取指定消费组消费数据时Shard的Checkpoint。

ListConsumerGroup

查询指定Logstore中的所有消费组。

ConsumerGroupUpdateCheckPoint

更新指定消费组消费数据时Shard的Checkpoint。

ConsumerGroupHeartBeat

为指定消费者发送心跳到服务端。

外部存储(ExternalStore)

API名称

API说明

CreateExternalStore

创建外部存储。

DeleteExternalStore

删除指定的外部存储。

UpdateExternalStore

修改外部存储的配置信息。

GetExternalStore

获取指定外部存储的详细信息。

ListExternalStore

列出指定Project下的外部存储。

CreateOssExternalStore

创建OSS外部存储。

UpdateOssExternalStore

更新OSS外部存储。

CreateRdsExternalStore

创建RDS外部存储。

UpdateRdsExternalStore

更新RDS外部存储。

快速查询(SavedSearch)

API名称

API说明

CreateSavedSearch

创建一个快速查询。

DeleteSavedSearch

删除一个快速查询。

UpdateSavedSearch

更新快速查询。

GetSavedSearch

获取指定的快速查询。

ListSavedSearch

列出指定Project下的快速查询。

仪表盘(Dashboard)

API名称

API说明

CreateDashboard

创建一个仪表盘。

DeleteDashboard

删除指定的仪表盘。

UpdateDashboard

更新指定的仪表盘配置。

GetDashboard

获取指定仪表盘的详细信息。

ListDashboard

列出指定Project下的仪表盘。

标签(Tag)

API名称

API说明

ListTagResources

列出目标资源的标签。

TagResources

为指定的资源创建与绑定标签。目前,仅支持为Project绑定标签。

UntagResources

为指定的资源解绑标签。

资源组(Resource Group)

API名称

API说明

ChangeResourceGroup

修改对应资源的资源组。

权限策略(Policy)

API名称

API说明

PutProjectPolicy

为Project创建一个权限策略。

DeleteProjectPolicy

删除目标Project的权限策略。

GetProjectPolicy

查询目标Project的授权策略。