API概览

最近更新时间: 2024-06-18 14:31:27

API版本

V3

主题分区相关接口

接口名称 接口功能
DescribePartitions 获取分区列表
MergePartition 合并分区
SplitPartition 分裂主题分区

仪表盘相关接口

接口名称 接口功能
CreateDashboard 创建仪表盘
DeleteDashboard 删除仪表盘
DescribeDashboards 获取仪表盘
ModifyDashboard 修改仪表盘

原生Kafka生产及消费相关接口

接口名称 接口功能
CloseKafkaConsume 关闭Kafka消费
CloseKafkaConsumer 关闭Kafka协议消费
DescribeKafkaUser 获取kafka用户信息
ModifyKafkaConsumer 修改Kafka协议消费信息
OpenKafkaConsumer 打开Kafka协议消费

告警策略相关接口

接口名称 接口功能
CreateAlarm 创建告警策略
CreateAlarmNotice 创建告警通知模板
DeleteAlarm 删除告警策略
DeleteAlarmNotice 删除告警通知模板
DescribeAlarmNotices 获取告警通知模板列表
DescribeAlarms 获取告警策略列表
GetAlarmLog 获取告警任务历史记录
ModifyAlarm 修改告警策略
ModifyAlarmNotice 修改告警通知模板

投递COS任务相关接口

接口名称 接口功能
CreateCosRecharge 创建cos导入任务
CreateShipper 创建投递规则
DeleteShipper 删除投递规则
DescribeCosRecharges 获取cos导入配置
DescribeKafkaConsume 获取Kakfa消费信息
DescribeKafkaConsumer 获取Kafka协议消费信息
DescribeShipperTasks 获取投递任务列表
DescribeShippers 获取投递规则
ModifyCosRecharge 修改cos导入任务
ModifyShipper 修改投递规则
OpenKafkaConsume 打开kafka消费功能
RetryShipperTask 重试失败的投递任务
SearchCosRechargeInfo 预览cos导入信息

投递Ckafka任务相关接口

接口名称 接口功能
CreateConsumer 创建投递任务
DeleteConsumer 删除投递配置
DescribeConsumer 获取投递配置
ModifyConsumer 修改投递任务

投递SCF任务相关接口

接口名称 接口功能
CreateDeliverCloudFunction 创建投递SCF任务
DeleteDeliverCloudFunction 删除投递SCF任务
DescribeDeliverCloudFunction 获取投递SCF任务
ModifyDeliverCloudFunction 修改投递SCF任务
UnbindDeliverCloudFunction trigger删除投递SCF任务

控制台定制相关接口

接口名称 接口功能
CheckAlarmChannel 告警渠道检测接口
CheckAlarmRule 告警策略检测接口
CreateNonBilling 创建体验账户
DeleteUserConfig 删除用户配置
DescribeAccount 获取账户状态
DescribeAlertRecordHistory 告警历史记录
DescribeLatestJsonLog 获取json格式日志
DescribeResources 获取地域指标资源
DescribeUserConfig 获取用户配置
GenBeginRegex 生成首行正则表达式
GenKVRegex 生成提取K-V形式的正则
ModifyUserConfig 修改用户配置

数据加工相关接口

接口名称 接口功能
CheckFunction 语法校验接口
CreateDataTransform 创建数据加工任务
DeleteDataTransform 删除数据加工任务
DescribeDataTransformFailLogInfo 获取数据加工任务失败日志详请
DescribeDataTransformInfo 获取数据加工任务列表基本信息
DescribeDataTransformPreviewInfo 获取数据加工预览任务基本信息
DescribeDataTransformProcessInfo 获取数据加工任务执行进度详情
DescribeFunctions 获取可使用的函数列表
ModifyDataTransform 修改数据加工任务

日志主题相关接口

接口名称 接口功能
CreateTopic 创建日志主题
DeleteTopic 删除日志主题
DescribeTopics 获取日志主题列表
ModifyTopic 修改日志主题

日志相关接口

接口名称 接口功能
Action test
CreateAsyncContextTask 创建离线上下文任务
CreateAsyncSearchTask 创建离线检索任务
CreateExport 创建日志下载任务
DeleteAsyncContextTask 删除离线上下文任务
DeleteAsyncSearchTask 删除离线检索任务
DeleteExport 删除日志下载任务
DescribeAsyncContextResult 获取离线上下文任务的结果
DescribeAsyncContextTasks 获取离线上下文任务列表
DescribeAsyncSearchResult 获取离线检索任务的结果
DescribeAsyncSearchTasks 获取离线检索任务列表
DescribeExports 获取日志下载任务列表
DescribeLogContext 上下文检索
DescribeLogFastAnalysis 日志快速分析接口
DescribeLogHistogram 获取直方图
SearchLog 搜索日志
UploadLog 上传日志

日志集相关接口

接口名称 接口功能
CreateLogset 创建日志集
DeleteLogset 删除日志集
DescribeLogsets 获取日志集列表
ModifyLogset 修改日志集

演示示例相关接口

接口名称 接口功能
CreateDemonstration 创建演示示例
CreateDemonstrations 批量创建演示示例
DeleteDemonstration 删除演示示例
DeleteDemonstrations 批量删除演示示例
DescribeDemonstrations 获取演示示例列表
DescribeTemplates 获取模版列表
ModifyDemonstrationResources 编辑演示示例资源

索引相关接口

接口名称 接口功能
CancelRebuildIndexTask 取消重建索引任务
CreateIndex 创建索引
CreateRebuildIndexTask 创建重建索引任务
DeleteIndex 删除索引配置
DescribeIndex 获取索引配置信息
DescribeIndexs 获取索引配置列表
DescribeRebuildIndexTasks 获取重建索引任务列表
ModifyIndex 修改索引

采集相关接口

接口名称 接口功能
CreateMachineGroup 创建机器组
CreateTopicExtendConfig 创建采集配置(clb专用)
DeleteMachineGroup 删除机器组
DeleteTopicExtendConfig 删除采集配置(clb专用)
DescribeAgentConfigs 获取采集配置
DescribeMachineGroups 获取机器组列表
DescribeMachines 获取机器状态
DescribeTopicExtendConfig 获取采集配置(clb专用)
HeartBeat 上报心跳
ModifyMachineGroup 修改机器组
ModifyTopicExtendConfig 修改采集配置(clb专用)
RemoveMachine 剔除机器
UpdateAgentStatus Agent升级状态更新
UpgradeAgentNormal 启动agent升级任务
UploadServiceLog 上传服务日志

采集配置相关接口

接口名称 接口功能
AddMachineGroupInfo 添加机器组信息
ApplyConfigToMachineGroup 应用采集配置到指定机器组
CreateConfig 创建采集规则配置
CreateConfigExtra 创建特殊采集配置任务
DeleteConfig 删除采集规则配置
DeleteConfigExtra 删除特殊采集规则配置
DeleteConfigFromMachineGroup 删除应用到机器组的采集配置
DeleteMachineGroupInfo 删除机器组信息
DescribeConfigExtras 获取特殊采集配置
DescribeConfigMachineGroups 获取采集规则配置所绑定的机器组
DescribeConfigs 获取采集规则配置
DescribeMachineGroupConfigs 获取机器组绑定的采集规则配置
ModifyConfig 修改采集规则配置
ModifyConfigExtra 修改特殊采集配置任务