文档

API概览

更新时间:
本产品(日志服务/2020-12-30)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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中的日志数据。
GetCursor通过时间查询Cursor可以根据时间获取对应的游标(Cursor)。
GetContextLogs查询上下文日志调用GetContextLogs接口查询指定日志前(上文)后(下文)的若干条日志。
GetHistograms查询日志分布情况调用GetHistograms接口查询指定Logstore中满足查询语法条件的日志分布情况。
GetCursorTime通过Cursor查询服务器端时间根据 Cursor 游标获取游标对应的服务端时间。
GetLogsV2查询Logstore中的日志数据查询指定Project下某个Logstore中的原始日志数据,返回结果显示某时间区间中的原始日志(返回结果压缩后传输)。
GetLogStoreMeteringMode查询LogStore计量模式获取Logstore计量模式。

时序库

API标题API概述
UpdateMetricStoreMeteringMode更新 MetricStore 计量模式更新指定 MetricStore 计量模式。
GetMetricStoreMeteringMode查询 MetricStore 计量模式查询指定 MetricStore 计量模式。

数据集

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采集配置获取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更新消费进度更新消费进度。
UpdateConsumerGroup更新消费者组修改指定消费组属性。
ConsumerGroupHeartBeat消费者发送心跳到服务端消费者发送心跳到服务端。
ListConsumerGroup查询消费组查询指定Logstore的所有消费组。
GetCheckPoint获取指定消费组的消费点调用GetCheckPoint接口获取指定消费组消费数据时Shard的checkpoint。

外部存储

API标题API概述
CreateOssExternalStore创建OSS外部存储调用CreateOssExternalStore接口创建OSS外部存储。
CreateRdsExternalStore创建RDS外部存储调用CreateRdsExternalStore接口创建RDS外部存储。
DeleteExternalStore删除外部存储配置删除指定外部存储配置。
UpdateRdsExternalStore更新RDS外部存储调用UpdateRdsExternalStore接口更新RDS外部存储。
UpdateOssExternalStore更新OSS外部存储调用UpdateOssExternalStore接口更新OSS外部存储。
GetExternalStore获取指定外部存储数据调用GetExternalStore接口获取指定外部存储数据的详细信息。

快速查询

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

标签

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获取云产品日志采集的采集规则获取云产品日志采集的采集规则。

SQL独享实例

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

服务开通

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

控制台内嵌

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