日志服务除了通过管理控制台进行操作外,还提供了API(Application Programming Interface)方式写入、查询日志数据,管理自己的项目及日志库等。

目前开放如下 API:

对象 方法
Log(日志) 日志、日志组表示等基本概念
Project (项目) ListCreateDeleteGetUpdate
GetProjectLogs(统计Project下所有日志)
Config (配置) ListCreateDeleteGetUpdate
GetAppliedMachineGroups(查询应用到的机器组)
MachineGroup (机器组) ListCreateDeleteGetUpdate
ApplyRemove(删除配置)
GetAppliedConfigs(查询已应用配置列表)
LogStore (日志库) ListCreateDeleteGetUpdate
GetLogs(查询日志)、GetHistograms(查询日志分布)
Index(索引) CreateUpdateDeleteGetIndex
Shard (分区) ListSplitMerge
PostLogStoreLogs(写入日志)
GetCursor(定位日志位置)
PullLogs(消费日志)
Shipper(日志投递规则) GetShipperStatus(查询日志投递任务状态)
RetryShipperTask(重试失败投递任务)
ConsumerGroup(消费组) CreateUpdateDeleteList
HeartBeat(发送心跳)、GetCheckpointUpdateCheckpoint

通过API可以进行如下操作:

说明
  • 为使用API,需要了解服务入口
  • API所有请求都需要做安全验证,请求签名解释了具体的API请求签名机制及流程。
  • Log Service支持RAM、STS,RAM子用户使用API时,除需要使用子用户的密钥进行签名验证外,其他和一般云账号没有区别。STS临时身份除需要临时密钥信息外,还需要填写一个特殊的HTTP header,请参见公共请求头,这个HTTP header需要进行签名,请参见请求签名