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

目前开放如下API:

对象 方法
服务操作 OpenSlsServiceGetSlsService
Project(项目) ListProjectCreateProjectDeleteProjectGetProjectUpdateProject
GetProjectLogs(统计Project下所有日志)
Config(Logtail配置) ListConfigCreateConfigDeleteConfigGetConfigUpdateConfig
GetAppliedMachineGroups(查询应用到的机器组)
MachineGroup(机器组) ListMachineGroupCreateMachineGroupDeleteMachineGroupGetMachineGroupUpdateMachineGroup
ApplyConfigToMachineGroupRemoveConfigFromMachineGroup(删除配置)
GetAppliedConfigs(查询已应用配置列表)
Logstore(日志库) ListLogStoresCreateLogStoreDeleteLogstoreGetLogStoreUpdateLogStore
GetLogs(查询日志)、GetHistograms(查询日志分布)
Index(索引) CreateIndexUpdateIndexDeleteIndexGetIndex
Shard(分区) ListShardsSplitShardMergeShards
PutLogs(写入日志)
GetCursor(定位日志位置)
PullLogs(消费日志)
Shipper(日志投递规则) GetShipperStatus(查询日志投递任务状态)
RetryShipperTask(重试失败投递任务)
ConsumerGroup(消费组) CreateConsumerGroupUpdateConsumerGroupDeleteConsumerGroupListConsumerGroup
HeartBeat(发送心跳)、GetCheckPointUpdateCheckPoint
ExternalStore(外部存储) CreateExternalStoreDeleteExternalStoreGetExternalStoreListExternalStoreUpdateExternalStore
Alert(告警) CreateAlertUpdateAlertDeleteAlertGetAlertListAlert
Savedsearch(快速查询) CreateSavedSearchDeleteSavedSearchGetSavedSearchListSavedSearch
说明
  • 为更好的使用API,您需要了解服务入口。服务入口是访问一个Project及其内部日志数据的URL。更多信息,请参见服务入口
  • API所有请求都需要做安全验证,请求签名解释了具体的API请求签名机制及流程。更多信息,请参见请求签名
  • 日志服务支持RAM、STS,RAM用户使用API时,除需要使用RAM用户的密钥进行签名验证外,其他和一般阿里云账号没有区别。STS临时身份除需要临时密钥信息外,还需要填写一个特殊的HTTP Header。更多信息,请参见公共请求头请求签名
  • 对不同用户进行访问权限控制。更多信息,请参见访问控制