API 列表--日志服务-火山引擎

文档中心

导航

API 列表

最近更新时间：2024.09.27 16:55:38首次发布时间：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 查看指定日志的上下文信息。
DescribeHistogramV1	调用接口 DescribeHistogramV1 检索日志，查看满足条件的日志数据随时间分布的情况。
WebTracks	调用接口 WebTracks 批量上传日志到指定的日志主题中。
CreateDownloadTask	调用接口 CreateDownloadTask 创建日志下载任务。
DescribeDownloadTasks	调用接口 DescribeDownloadTasks 获取指定日志主题中的日志下载任务列表。
DescribeDownloadUrl	调用接口 DescribeDownloadUrl 获取指定任务对应的日志下载链接。
CancelDownloadTask	调用接口 CancelDownloadTask 取消日志下载任务。

机器组管理

API	说明
CreateHostGroup	调用接口 CreateHostGroup 创建机器组。
DeleteHostGroup	调用接口 DeleteHostGroup 删除机器组。
ModifyHostGroup	调用接口 ModifyHostGroup 修改机器组。
DescribeHostGroups	调用接口 DescribeHostGroups 获取所有机器组。
DescribeHostGroup	调用接口 DescribeHostGroup 查看指定机器组信息。
DescribeHosts	调用接口 DescribeHosts 获取所有机器。
DeleteHost	调用接口 DeleteHost 删除机器组指定IP的机器。
DescribeHostGroupRules	调用接口 DescribeHostGroupRules 获取机器组上已经应用的采集配置列表。
ModifyHostGroupsAutoUpdate	调用接口 ModifyHostGroupsAutoUpdate 批量修改机器组的LogCollector自动升级配置。
DeleteAbnormalHosts	调用接口 DeleteHost 删除机器组指定IP的机器。

采集配置管理

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	说明
CreateImportTask	新增 CreateImportTask 接口，用于创建数据导入任务。
DeleteImportTask	新增 DeleteImportTask 接口，用于删除指定的数据导入任务。
ModifyImportTask	新增 ModifyImportTask 接口，用于修改指定的数据导入任务。
DescribeImportTask	新增 DescribeImportTask 接口，用于获取某个数据导入任务的信息。
DescribeImportTasks	新增 DescribeImportTasks 接口，用于获取数据导入任务列表。

数据加工

API	说明
CreateETLTask	新增 CreateETLTask 接口，用于创建加工任务。
DeleteETLTask	新增 DeleteETLTask 接口，用于删除加工任务。
ModifyETLTask	新增 ModifyETLTask 接口，用于修改指定的加工任务。
DescribeETLTask	新增 DescribeETLTask 接口，用于获取指定加工任务的详细信息。
DescribeETLTasks	新增 DescribeETLTasks 接口，用于获取加工任务列表。
ModifyETLTaskStatus	新增 ModifyETLTaskStatus 接口，用于修改加工任务状态。

数据投递

API	说明
CreateShipper	新增 CreateShipper 接口，用于创建投递配置。
DeleteShipper	新增 DeleteShipper 接口，用于删除指定的投递配置。
ModifyShipper	新增 ModifyShipper 接口，用于修改指定的投递配置。
DescribeShipper	新增 DescribeShipper 接口，用于获取投递配置的详细信息。
DescribeShippers	新增 DescribeShippers 接口，用于获取投递配置列表。

告警管理

API	说明
CreateAlarmNotifyGroup	调用接口 CreateAlarmNotifyGroup 创建告警组。
DeleteAlarmNotifyGroup	调用接口 DeleteAlarmNotifyGroup 删除告警组。
ModifyAlarmNotifyGroup	调用接口 ModifyAlarmNotifyGroup 修改告警组。
DescribeAlarmNotifyGroups	调用接口 DescribeAlarmNotifyGroups 获取告警组列表。
CreateAlarm	调用接口 CreateAlarm 创建告警策略。
DeleteAlarm	调用接口 DeleteAlarm 删除告警策略。
ModifyAlarm	调用接口 ModifyAlarm 修改告警策略。
DescribeAlarms	调用接口 DescribeAlarms 查看告警策略列表。
CreateAlarmContentTemplate	调用接口 CreateAlarmContentTemplate 创建告警内容模板。
DeleteAlarmContentTemplate	调用接口 DeleteAlarmContentTemplate 删除告警内容模板。
ModifyAlarmContentTemplate	调用接口 ModifyAlarmContentTemplate 修改告警内容模板。
DescribeAlarmContentTemplates	调用接口 DescribeAlarmContentTemplates 查询告警内容模板。
CreateAlarmWebhookIntegration	调用接口 CreateAlarmWebhookIntegration 创建告警 Webhook 集成配置。
DeleteAlarmWebhookIntegration	调用接口 DeleteAlarmWebhookIntegration 删除告警 Webhook 集成配置。
DescribeAlarmWebhookIntegrations	调用接口 DescribeAlarmWebhookIntegrations 查询告警 Webhook 集成配置。
ModifyAlarmWebhookIntegration	调用接口 ModifyAlarmWebhookIntegration 修改告警 Webhook 集成配置。

消费组管理

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 为指定日志项目或者日志主题批量解绑标签。