You need to enable JavaScript to run this app.
导航

API 概览

最近更新时间2024.02.22 14:29:07

首次发布时间2022.05.11 11:26:47

日志服务提供以下 API 接口。

日志项目管理

API
说明

CreateProject

调用 CreateProject 接口创建一个日志项目。

DeleteProject

调用 DeleteProject 接口删除一个日志项目。

ModifyProject

调用 ModifyProject 接口修改日志项目。

DescribeProject

调用 DescribeProject 接口查询指定日志项目信息。

DescribeProjects

调用 DescribeProjects 接口查看所有日志项目信息。

日志主题管理

API
说明

CreateTopic

调用 CreateTopic 接口创建日志主题。

DeleteTopic

调用 DeleteTopic 接口删除日志主题。

ModifyTopic

调用 ModifyTopic 接口修改日志主题信息。

DescribeTopic

调用 DescribeTopic 接口获取指定日志主题基本信息。

DescribeTopics

调用 DescribeTopics 接口获取日志项目的所有日志主题信息。

分区管理

API
说明

DescribeShards

调用 DescribeShards 接口获取日志主题的分区列表。

ManualShardSplit

调用 ManualShardSplit 接口手动分裂指定分区。

索引管理

API
说明

CreateIndex

调用 CreateIndex 接口创建索引。

DeleteIndex

调用 DeleteIndex 接口删除索引配置。

ModifyIndex

调用 ModifyIndex 接口修改索引配置。

DescribeIndex

调用 DescribeIndex 接口获取索引配置信息。

日志管理

API
说明

PutLogs

调用 PutLogs 接口上传日志到指定的日志主题中。

DescribeCursor

调用 DescribeCursor 接口获取日志下载游标。

ConsumeLogs

通过ConsumeLogs 接口消费日志。

SearchLogs

调用 SearchLogs 接口检索日志。

DescribeLogContext

调用 接口DescribeLogContext查看指定日志的上下文信息。

DescribeHistogram

调用 DescribeHistogram 接口检索日志,查看满足条件的日志数据随时间分布的情况。

WebTracks

调用 接口批量上传日志到指定的日志主题中。

CreateDownloadTask

调用 接口CreateDownloadTask创建日志下载任务。

DescribeDownloadTasks

调用 接口DescribeDownloadTasks获取指定日志主题中的日志下载任务列表。

DescribeDownloadUrl

调用 接口DescribeDownloadUrl获取指定任务对应的日志下载链接。

机器组管理

API
说明

CreateHostGroup

调用 CreateHostGroup 接口创建机器组。

DeleteHostGroup

调用 DeleteHostGroup 接口删除机器组。

ModifyHostGroup

调用 ModifyHostGroup 接口修改机器组。

DescribeHostGroups

调用 DescribeHostGroups 接口获取所有机器组。

DescribeHostGroup

调用 DescribeHostGroup 接口查看指定机器组信息。

DeleteHost

调用 DeleteHost 接口删除机器组指定IP的机器。

DescribeHostGroupRules

调用 DescribeHostGroupRules 接口获取机器组上已经应用的采集配置列表。

ModifyHostGroupsAutoUpdate

调用 ModifyHostGroupsAutoUpdate 接口批量修改机器组的LogCollector自动升级配置。

采集配置管理

API
说明

CreateRule

调用 CreateRule 接口创建采集配置。

DeleteRule

调用 DeleteRule 接口删除采集配置。

ModifyRule

调用 ModifyRule 接口修改采集配置。

DescribeRule

调用 DescribeRule 接口查看指定的采集配置信息。

DescribeRules

调用 DescribeRules 接口查看指定日志项目中的采集配置列表。

ApplyRuleToHostGroups

调用 ApplyRuleToHostGroups 接口将采集配置绑定到机器组列表。

DeleteRuleFromHostGroups

调用 DeleteRuleFromHostGroups 接口将采集配置解绑机器组列表。

定时 SQL 分析

API
说明

CreateScheduleSqlTask

调用 CreateScheduleSqlTask 接口创建定时 SQL 分析任务。

ModifyScheduleSqlTask

调用 ModifyScheduleSqlTask 接口修改定时 SQL 分析任务。

DeleteScheduleSqlTask

调用 DeleteScheduleSqlTask 接口删除定时 SQL 分析任务。

DescribeScheduleSqlTask

调用 DescribeScheduleSqlTask 接口查看某个指定的定时 SQL 分析任务的详情。

DescribeScheduleSqlTasks

调用 DescribeScheduleSqlTasks 接口查看指定地域下所有定时 SQL 分析任务的详情。

告警管理

API
说明

CreateAlarmNotifyGroup

调用 CreateAlarmNotifyGroup 接口创建告警组。

DeleteAlarmNotifyGroup

调用 DeleteAlarmNotifyGroup 接口删除告警组。

ModifyAlarmNotifyGroup

调用 ModifyAlarmNotifyGroup 接口修改告警组。

DescribeAlarmNotifyGroups

调用 DescribeAlarmNotifyGroups 接口获取告警组列表。

CreateAlarm

调用 CreateAlarm 接口创建告警策略。

DeleteAlarm

调用 DeleteAlarm 接口删除告警策略。

ModifyAlarm

调用 ModifyAlarm 接口修改告警策略。

DescribeAlarms

调用 DescribeAlarms 接口查看告警策略列表。

消费组管理

API

说明

CreateConsumerGroup

调用 CreateConsumerGroup 接口创建日志服务消费组(ConsumerGroup)。

DeleteConsumerGroup

调用 DeleteConsumerGroup 接口删除日志服务消费组。

DescribeConsumerGroups

调用 DescribeConsumerGroups 接口获取一个日志项目下的所有消费组信息。

ModifyConsumerGroup

调用 ModifyConsumerGroup 接口修改日志服务消费组的配置。

ConsumerHeartbeat

调用 ConsumerHeartbeat 接口向日志服务发送消费组中的一个消费者的心跳信息。

DescribeCheckPoint

调用 DescribeCheckPoint 接口查看指定消费组在指定日志分区上的当前消费位点。

ModifyCheckPoint

调用 ModifyCheckPoint 接口为指定消费组重置指定分区的消费位点。

ResetCheckPoint

调用 ResetCheckPoint 接口为指定消费组重置全部消费位点。

Kafka 协议消费

API
说明

OpenKafkaConsumer

调用 OpenKafkaConsumer 接口为指定日志主题开启 Kafka 协议消费功能。

CloseKafkaConsumer

调用 CloseKafkaConsumer 接口关闭指定日志主题的 Kafka 协议消费功能。

DescribeKafkaConsumer

调用 DescribeKafkaConsumer 接口查看指定日志主题的 Kafka 消费功能状态。

标签管理

API
说明

AddTagsToResource

调用 AddTagsToResource 接口为指定日志项目或者日志主题批量绑定标签。

RemoveTagsFromResource

调用 RemoveTagsFromResource 接口为指定日志项目或者日志主题批量解绑标签。