API概览
本文罗列了日志服务API。
项目（Project）
API名称 | API说明 |
创建一个Project。 | |
删除目标Project。 | |
更新某个指定Project的描述信息。 | |
获取某个指定Project的详细信息。 | |
列出符合条件的Project的详细信息。 | |
获取Project下的所有日志。 该接口为Project级别的SQL查询接口。 |
日志库（Logstore）
API名称 | API说明 |
创建一个Logstore。 | |
删除某个指定的Logstore。 | |
更新某个指定Logstore的属性信息。 | |
获取某个指定Logstore的详细信息。 | |
列出指定Project下符合条件的Logstore。 |
日志管理（Log）
API名称 | API说明 |
向指定的Logstore中写入日志。 | |
向指定的Logstore中写入日志。 | |
合并多条日志并进行采集。 | |
查询指定Logstore中的日志。 | |
查询指定Logstore中满足查询语法条件的日志的分布情况。 | |
根据时间获取对应的游标。 | |
获取游标对应的服务端时间。 | |
查询指定日志前（上文）后（下文）的若干条日志。 | |
获取指定游标位置的日志。 |
Logtail机器组（Machine Group）
API名称 | API说明 |
创建一个机器组。 | |
删除某个指定的机器组。 | |
更新某个指定机器组的配置信息。 | |
获取指定机器组的详细信息。 | |
列出目标机器组中与日志服务连接正常的机器。 | |
列出指定Project下符合条件的机器组。 | |
将Logtail配置应用到目标机器组。 | |
从目标机器组中移除Logtail配置。 | |
查询目标机器组上已经应用的Logtail配置。 |
Logtail配置（Logtail Config）
API名称 | API说明 |
创建一个Logtail配置。 | |
删除某个指定的Logtail配置。 | |
更新某个指定的Logtail配置。 | |
获取某个指定Logtail配置的详细信息。 | |
列出指定Project下所有符合条件的Logtail配置。 | |
获取已绑定指定Logtail配置的机器组列表。 |
索引（Index）
API名称 | API说明 |
为指定的Logstore创建索引。 | |
删除指定Logstore的索引。 | |
更新指定Logstore的索引。 | |
查询指定Logstore的索引。 |
分区（Shard）
API名称 | API说明 |
列出指定Logstore中所有的Shard。 | |
分裂指定的readwrite状态的Shard。 | |
合并两个相邻的readwrite状态的Shard。 |
投递（Ship）
API名称 | API说明 |
查询日志投递任务状态。 | |
重试失败投递任务。 |
消费组（Consumer Group）
API名称 | API说明 |
在指定的Logstore上创建一个消费组。 | |
删除指定的消费组。 | |
修改指定消费组的属性信息。 | |
获取指定消费组消费数据时Shard的Checkpoint。 | |
查询指定Logstore中的所有消费组。 | |
更新指定消费组消费数据时Shard的Checkpoint。 | |
为指定消费者发送心跳到服务端。 |
外部存储（ExternalStore）
API名称 | API说明 |
创建外部存储。 | |
删除指定的外部存储。 | |
修改外部存储的配置信息。 | |
获取指定外部存储的详细信息。 | |
列出指定Project下的外部存储。 |
快速查询（SavedSearch）
API名称 | API说明 |
创建一个快速查询。 | |
删除一个快速查询。 | |
更新快速查询。 | |
获取指定的快速查询。 | |
列出指定Project下的快速查询。 |
仪表盘（Dashboard）
API名称 | API说明 |
创建一个仪表盘。 | |
删除指定的仪表盘。 | |
更新指定的仪表盘配置。 | |
获取指定仪表盘的详细信息。 | |
列出指定Project下的仪表盘。 |
标签（Tag）
API名称 | API说明 |
列出目标资源的标签。 | |
为指定的资源创建与绑定标签。目前，仅支持为Project绑定标签。 | |
为指定的资源解绑标签。 |
资源组（Resource Group）
API名称 | API说明 |
修改对应资源的资源组。 |
权限策略（Policy）
API名称 | API说明 |
为Project创建一个权限策略。 | |
删除目标Project的权限策略。 | |
查询目标Project的授权策略。 |
