API概览

本产品(Sls/2020-12-30)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

日志项目

API

标题

API概述

CreateProject 创建Project 创建一个Project。
CreateDomain 创建自定义域名 Project绑定新的自定义域名。
CreateLogging 创建服务日志 Project创建服务日志。
DeleteProject 删除指定Project 删除一个指定的Project。
DeleteLogging 删除指定服务日志 删除一个指定Project的服务日志。
DeleteDomain 删除自定义域名 删除Project绑定的自定义域名。
UpdateProject 更新Project 更新一个Project信息。
UpdateLogging 更新服务日志配置 更新一个Project的服务日志配置。
PutProjectTransferAcceleration 配置传输加速 开通或关闭传输加速。
GetProject 获取指定Project 查询目标Project的详细信息。
ListProject 列出Project信息 列出符合条件的Project信息。
GetProjectLogs 获取目标Project下的日志 查询目标Project下的日志,该接口是Project级别的SQL查询接口。
GetLogging 获取服务日志信息 查询目标Project的服务日志配置。
ListDomains 查询自定义域名 列出Project绑定的自定义域名。

日志库

API

标题

API概述

CreateLogStore 创建LogStore 创建 LogStore。
CreateIndex 创建索引 为指定Logstore创建索引。
DeleteLogStore 删除LogStore 删除指定Logstore,包括所有Shard数据和索引。
DeleteIndex 删除索引 删除指定Logstore的索引。
PutWebtracking 通过WebTracking批量写入日志 通过 WebTracking 方式单次写入多条日志。
UpdateLogStore 更新LogStore 更新Logstore的属性信息。
UpdateIndex 更新索引 更新Logstore的索引信息。
SplitShard 分裂Shard 分裂一个指定的readwrite状态的Shard。
UpdateLogStoreMeteringMode 更新LogStore计量模式 更新Logstore计量模式。
MergeShard 合并shard 合并相邻位置的读写Shard。
ListLogStores 列出LogStore 查询指定Project下所有或匹配的LogStore列表。
GetLogStore 查看Logstore信息 查看Logstore的详细信息。
GetIndex 获取索引 查询指定Logstore的索引信息。
ListShards 查询shard列表 列出指定Logstore中所有可用的Shard。
GetLogs 查询日志库日志 查询指定Project下某个Logstore中的日志数据。
UpdateLogStoreEncryption 更新加密配置 更新日志库的加密配置。可以为日志库创建加密配置、开启或关闭日志加密功能。
GetCursor 通过时间查询Cursor 可以根据时间获取对应的游标(Cursor)。
GetContextLogs 查询上下文日志 调用GetContextLogs接口查询指定日志前(上文)后(下文)的若干条日志。
GetHistograms 查询日志分布情况 调用GetHistograms接口查询指定Logstore中满足查询语法条件的日志分布情况。
GetCursorTime 通过Cursor查询服务器端时间 根据 Cursor 游标获取游标对应的服务端时间。
GetLogsV2 查询Logstore中的日志数据 查询指定Project下某个Logstore中的原始日志数据,返回结果显示某时间区间中的原始日志(返回结果压缩后传输)。
PullLogs 拉取日志 调用PullLogs接口获取指定游标(Cursor)位置的日志数据。此接口获取的是原始日志,如要查询或分析日志,请使用GetLogsV2接口。
PutLogs 写入日志 调用PutLogs接口向指定的Logstore中写入日志数据。
GetLogStoreMeteringMode 查询LogStore计量模式 获取Logstore计量模式。

时序库

API

标题

API概述

ListMetricStores 列出时序库 列出日志项目下的时序库,支持按照时序库名称模糊查找。
CreateMetricStore 创建时序库 创建时序库(MetricStore),可用于存储时序数据。
DeleteMetricStore 删除时序库 删除一个已存在的时序库,该时序库所存储的时序数据、关联的采集配置、加工配置等关联资源将被一并删除。
UpdateMetricStore 更新时序库 更新一个已存在的时序库的配置,时序库可用于存储时序数据。
UpdateMetricStoreMeteringMode 更新时序库计费模式 更新指定时序库的计费模式。
GetMetricStore 查询时序库 查询时序库。
GetMetricStoreMeteringMode 查询时序库计费模式 查询指定时序库的当前计费模式。

数据集

API

标题

API概述

CreateStoreView 创建数据集 创建一个数据集。
DeleteStoreView 删除数据集 根据名称删除指定数据集。
UpdateStoreView 更新数据集配置 更新指定数据集配置。
GetStoreView 查询指定数据集 根据名称查询指定数据集配置。
GetStoreViewIndex 查询指定数据集索引配置 根据指定名称查询数据集索引,只支持 logstore 类型的数据集。
ListStoreViews 查询数据集列表 查询日志项目中的数据集列表。

机器组

API

标题

API概述

CreateMachineGroup 创建机器组 创建一个机器组。
DeleteMachineGroup 删除机器组 删除机器组。如果机器组已应用Logtail采集配置,则删除机器组后,会解绑对应的Logtail配置。
RemoveConfigFromMachineGroup 删除机器组Logtail配置 从机器组中移除Logtail配置。
ApplyConfigToMachineGroup 应用Logtail配置到机器组 Logtail配置应用到机器组。
UpdateMachineGroup 修改机器组 修改机器组配置信息。
UpdateMachineGroupMachine 修改机器组机器列表 修改机器组中的机器列表,支持从机器列表中增加或者删除机器。
ListMachineGroup 查询Project下的机器组 列出目标Project下的机器组。
ListMachines 查询机器组中的机器列表 列出目标机器组中与日志服务连接正常的机器列表。
GetMachineGroup 获取机器组配置 查看目标机器组的具体信息。
GetAppliedConfigs 获取已应用的Logtail配置列表 获取目标机器组上已经被应用的Logtail配置列表。
GetAppliedMachineGroups 通过Logtail配置获取已绑定的机器组 调用GetAppliedMachineGroups接口获取已绑定指定Logtail配置的机器组列表。

采集配置

API

标题

API概述

CreateConfig 创建Logtail采集配置 创建Logtail采集配置。
CreateLogtailPipelineConfig 创建Logtail流水线配置 创建Logtail流水线配置。
DeleteConfig 删除Logtail配置 删除指定的Logtail配置。
DeleteLogtailPipelineConfig 删除Logtail流水线配置 删除Logtail流水线配置。
UpdateConfig 更新Logtail采集配置 修改指定的 Logtail 采集配置。
UpdateLogtailPipelineConfig 更新Logtail流水线配置 更新Logtail流水线配置。
GetConfig 获取Logtail采集配置 调用GetConfig接口获取Logtail配置的详细信息。
ListConfig 查询Logtail配置列表 调用ListConfig接口查询指定Project下所有的Logtail配置。
GetLogtailPipelineConfig 获取Logtail流水线配置 获取Logtail流水线配置。
ListLogtailPipelineConfig 罗列Logtail流水线配置 列举指定条件下的Logtail流水线配置名称。

仪表盘

API

标题

API概述

CreateDashboard 创建仪表盘 创建仪表盘。
DeleteDashboard 删除仪表盘 删除指定仪表盘。
UpdateDashboard 更新仪表盘 更新仪表盘。
GetDashboard 获取指定仪表盘 获取指定仪表盘。
ListDashboard 查询仪表盘 查询仪表盘。

消费组

API

标题

API概述

CreateConsumerGroup 创建消费组 在指定的Logstore上创建一个消费组。
DeleteConsumerGroup 删除消费组 删除一个指定的消费组。
ConsumerGroupUpdateCheckPoint 更新消费进度 更新指定消费组消费数据时Shardcheckpoint。
UpdateConsumerGroup 更新消费者组 修改指定消费组属性。
ConsumerGroupHeartBeat 消费者发送心跳到服务端 消费者发送心跳到服务端。
ListConsumerGroup 查询消费组 查询指定Logstore的所有消费组。
GetCheckPoint 获取指定消费组的消费点 调用GetCheckPoint接口获取指定消费组消费数据时Shardcheckpoint。

快速查询

API

标题

API概述

CreateSavedSearch 创建快速查询 创建一个快速查询。
DeleteSavedSearch 删除快速查询 删除一个快速查询。
UpdateSavedSearch 更新快速查询 调用UpdateSavedSearch接口更新快速查询。
ListSavedSearch 查询快速查询 查询快速查询列表。
GetSavedSearch 获取指定快速查询 获取指定的快速查询。

告警

API

标题

API概述

CreateAlert 创建告警规则 在指定Project下创建一个告警规则。
DeleteAlert 删除告警规则 删除指定的告警规则。
UpdateAlert 更新告警规则 更新指定的告警规则。
EnableAlert 开启告警规则 开启指定的告警规则。
DisableAlert 关闭告警规则 关闭指定的告警规则。
GetAlert 获取告警规则 获取指定的告警规则。
ListAlerts 列出告警规则 列出指定Project下的告警规则。

数据导入

API

标题

API概述

CreateOSSIngestion 创建OSS导入任务 在指定Project下创建一个OSS导入任务。
DeleteOSSIngestion 删除OSS导入任务 删除一个OSS导入任务。
UpdateOSSIngestion 更新OSS导入任务 更新指定的OSS导入任务。
StartOSSIngestion 启动OSS导入任务 启动指定OSS导入任务。
StopOSSIngestion 停止OSS导入任务 停止指定OSS导入任务。
GetOSSIngestion 获取OSS导入任务 获取指定OSS导入任务。
ListOSSIngestions 列出OSS导入任务 列出指定Project下的OSS导入任务。

日志投递

API

标题

API概述

CreateOSSExport 创建OSS投递任务 Logstore中的日志投递到OSSBucket。
CreateOSSHDFSExport 创建OSS-HDFS投递任务 在指定的Project下创建一个OSS-HDFS投递功能。
DeleteOSSExport 删除OSS投递任务 删除指定的OSS投递任务。
DeleteOSSHDFSExport 删除OSS-HDFS投递任务 删除指定的OSS-HDFS投递任务。
UpdateOSSExport 更新OSS投递任务 更新指定的OSS投递任务。
StartOSSExport 启动OSS投递任务 启动指定的OSS投递任务。
StopOSSExport 停止OSS投递任务 停止指定的OSS投递任务。
GetOSSExport 获取OSS投递任务 获取指定的OSS投递任务。
UpdateOSSHDFSExport 更新OSS-HDFS投递任务 更新指定的OSS-HDFS投递任务。
StartOSSHDFSExport 启动OSS-HDFS投递任务 启动指定的OSS-HDFS投递任务。
StopOSSHDFSExport 停止OSS-HDFS投递任务 停止指定的OSS-HDFS投递任务。
ListOSSExports 列出OSS投递任务 列出指定Project下的OSS投递任务。
GetOSSHDFSExport 获取OSS-HDFS投递任务 获取指定的OSS-HDFS投递任务。
ListOSSHDFSExports 列出OSS-HDFS投递任务 列出指定Project下的OSS-HDFS投递任务。

数据加工

API

标题

API概述

CreateETL 创建数据加工任务 在指定Project下创建一个数据加工任务。
DeleteETL 删除数据加工任务 删除一个数据加工任务。
UpdateETL 更新数据加工任务 更新指定的数据加工任务配置并重启
StartETL 启动数据加工任务 启动指定的数据加工任务。
StopETL 停止数据加工任务 停止指定的数据加工任务。
ListETLs 列出数据加工任务 列出project下的数据加工任务
GetETL 获取数据加工任务 获取指定的数据加工任务配置

定时SQL

API

标题

API概述

CreateScheduledSQL 创建定时SQL任务 在指定的Project下创建一个定时SQL任务。
DeleteScheduledSQL 删除定时SQL任务 删除指定的定时SQL任务。
UpdateScheduledSQL 更新定时SQL任务 更新指定的定时SQL任务。
EnableScheduledSQL 开启定时SQL 开启指定的定时SQL。
DisableScheduledSQL 关闭定时SQL 关闭指定的定时SQL。
ListScheduledSQLs 列出定时SQL任务 列出指定Project下的定时SQL任务。
GetScheduledSQL 获取定时SQL任务 获取指定的定时SQL任务

日志下载

API

标题

API概述

CreateDownloadJob 创建日志下载任务 在指定Project下创建一个日志下载任务。
DeleteDownloadJob 删除日志下载任务 删除下载任务。
GetDownloadJob 获取日志下载任务 获取下载任务信息。
ListDownloadJobs 列出日志下载任务 列出指定Project下的日志下载任务。

写入处理器

API

标题

API概述

PutIngestProcessor 创建或修改写入处理器 创建或修改写入处理器。
GetIngestProcessor 查询写入处理器信息 查询写入处理器信息。
ListIngestProcessors 列出写入处理器 列出符合参数条件的写入处理器。
DeleteIngestProcessor 删除写入处理器 删除写入处理器。
UpdateLogStoreProcessor 更新LogStore关联的写入处理器 更新LogStore关联的写入处理器。
UpdateMetricStoreProcessor 更新MetricStore关联的写入处理器 更新MetricStore关联的写入处理器。

消费处理器

API

标题

API概述

PutConsumeProcessor 创建或修改消费处理器 创建新的消费处理器或者更新已有的消费处理器
GetConsumeProcessor 查询消费处理器详情 查询消费处理器的详情
ListConsumeProcessors 列出消费处理器 列出符合参数条件的消费处理器。
DeleteConsumeProcessor 删除消费处理器 删除消费处理器

机器学习

API

标题

API概述

CreateAnnotationLabel 创建标签 创建标签表。
PutAnnotationData 存储数据 向数据集中存入数据。
CreateAnnotationDataSet 创建数据集 创建数据集。
DeleteAnnotationLabel 删除标签 删除标签表。
DeleteAnnotationData 删除数据 删除数据集中的数据。
DeleteAnnotationDataSet 删除数据集 删除数据集。
UpdateAnnotationLabel 更新标签 更新标签表。
UpdateAnnotationDataSet 更新数据集 更新数据集。
GetAnnotationLabel 获取标签 通过labelId拿到某个标签表。
ListAnnotationLabels 获取标签列表 取得标签表的列表。
GetAnnotationData 获取数据 通过数据唯一标识得到数据集中的数据结构体。
ListAnnotationData 获取数据列表 列出数据集中的所有数据。
GetAnnotationDataSet 获取数据集 取得数据集信息。
ListAnnotationDataSets 获取数据集列表 取得数据集结构体列表。
GetMLServiceResults 获取指定场景任务的算法分析结果 在阿里云日志服务平台上,提供了基础数据(Log、Metric、Trace)的智能分析能力。用户调用相关模型,可以直接得到模型的分析结果。目前主要涉及:日志数据的NER任务、时间序列数据的异常检测、高延时链路数据的Span根因定位。

标签

API

标题

API概述

TagResources 绑定标签 Project绑定标签,每次调用API只能为一个Project绑定标签,可一次绑定多个标签。
UntagResources 解绑标签 为指定的资源解绑标签,现仅支持日志项目的标签,可以一次性为单个日志项目解绑多个或者全部标签。
ListTagResources 列出资源标签 列出所查询资源的标签列表,可以一次查询多个同类型的资源,也可以按标签键值过滤查询。

授权策略

API

标题

API概述

PutProjectPolicy 创建Project授权策略 创建Project权限策略(Policy)。
DeleteProjectPolicy 删除Project授权策略 删除Project的授权策略(Policy)。
GetProjectPolicy 查询Project授权策略 查询Project权限策略(Policy)。

资源组

API

标题

API概述

ChangeResourceGroup 修改资源组 修改Project归属的资源组。

云产品采集规则

API

标题

API概述

UpsertCollectionPolicy 创建云产品日志采集的采集规则 创建云产品日志采集的采集规则,从而实现云产品日志的自动化采集。
DeleteCollectionPolicy 删除云产品日志采集的采集规则 删除云产品日志采集的采集规则。
ListCollectionPolicies 列出云产品日志采集的采集规则 列出云产品日志采集的采集规则。
GetCollectionPolicy 获取云产品日志采集的采集规则 调用GetCollectionPolicy获取对应的规则。

SQL独享实例

API

标题

API概述

CreateSqlInstance 创建SQL独享实例 当您使用SQL分析时,如果数据量较大,SQL普通版无法在一次查询中完整扫描指定时间段内的所有日志,返回的结果可能不包括所有匹配的数据,增加Shard可以提升读写能力,但只对新写入的数据生效。您可以通过开启SQL独享版,增加计算资源,提升单次分析的数据量。
UpdateSqlInstance 更新SQL 独享实例 当您使用SQL分析时,如果数据量较大,SQL普通版无法在一次查询中完整扫描指定时间段内的所有日志,返回的结果可能不包括所有匹配的数据,增加Shard可以提升读写能力,但只对新写入的数据生效。您可以通过开启SQL独享版,增加计算资源,提升单次分析的数据量。
GetSqlInstance 查询SQL 独享实例 查询ProjectSQL独享版本的CU数、是否为 Project 默认开启SQL独享版等信息。使用该接口前,必须先调用CreateSqlInstanceUpdateSqlInstance接口创建SQL独享版。

服务开通

API

标题

API概述

OpenSlsService 开通日志服务 开通日志服务。服务地址只能是华东2(上海)或新加坡。
GetSlsService 查询日志服务的开通状态 调用GetSlsService接口获取日志服务的开通状态。服务地址只能是华东2(上海)或新加坡

控制台内嵌

API

标题

API概述

CreateTicket 创建免登录票据 如果您需要将日志服务的查询分析页面、仪表盘页面,免密分享给其他人或者嵌入到第三方系统,可以调用CreateTicket生成ticket,然后拼接免密链接。
RefreshToken 刷新令牌 通过票据刷新访问令牌,用于访问控制台接口。

其他

API

标题

API概述

GetMaxComputeExport 获取MaxCompute投递任务 获取MaxCompute投递任务信息。
CreateMaxComputeExport 创建MaxCompute投递任务 创建MaxCompute投递任务。
DeleteMaxComputeExport 删除MaxCompute投递任务 删除MC投递任务。
ListMaxComputeExports 列出MaxCompute投递任务 列出MC投递任务
StartMaxComputeExport 启动MaxCompute投递任务 启动MaxCompute投递任务。
StopMaxComputeExport 停止MaxCompute投递任务 停止MC投递任务。
UpdateMaxComputeExport 更新MaxCompute投递任务 更新MaxCompute投递任务。