全部產品
Search
文件中心

Simple Log Service:API 概覽

更新時間:Jun 30, 2026

API標準及多語言預置SDK

本產品(Sls/2020-12-30)的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。

在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey

自訂簽名情境

若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。

日誌庫

API

標題

API概述

GetMaxComputeExport 擷取MaxCompute投遞任務 擷取MaxCompute投遞任務資訊。
CreateMaxComputeExport 建立MaxCompute投遞任務 建立MaxCompute投遞任務。
DeleteMaxComputeExport 刪除MaxCompute投遞任務 刪除MC投遞任務。
ListMaxComputeExports 列出MaxCompute投遞任務 列出 MC 投遞任務
StartMaxComputeExport 啟動MaxCompute投遞任務 啟動MaxCompute投遞任務。
StopMaxComputeExport 停止MaxCompute投遞任務 停止MC投遞任務。
UpdateMaxComputeExport 更新MaxCompute投遞任務 更新MaxCompute投遞任務。

時序庫

API

標題

API概述

UntagResources 解除綁定標籤 為指定的資源解除綁定標籤,現僅支援記錄項目的標籤,可以一次性為單個記錄項目解除綁定多個或者全部標籤。
TagResources 綁定標籤 為Project綁定標籤,每次調用API只能為一個Project綁定標籤,可一次綁定多個標籤。
ListTagResources 列出資源標籤 列出所查詢資源的標籤列表,可以一次查詢多個同類型的資源,也可以按標籤索引值過濾查詢。

資料集

API

標題

API概述

CreateProject 建立Project 建立一個Project。
DeleteProject 刪除指定Project 刪除一個指定的Project。
GetProject 取得指定 Project 查詢目標 Project 的詳細資訊。
ListProject 列出 Project 資訊 列出符合條件的 Project 資訊。
UpdateProject 更新Project 更新一個 Project 資訊。
GetProjectLogs 擷取目標Project下的日誌 查詢目標Project下的日誌,該介面是Project層級的SQL查詢介面。

機器群組

API

標題

API概述

ApplyConfigToMachineGroup 應用Logtail配置到機器組 將Logtail配置應用到機器組。
CallAiTools 呼叫可觀測 AI 工具能力 呼叫可觀測 AI 工具,工具能力會持續更新,可透過工具列表介面取得當前支援能力。
CancelDownloadJob 取消日誌下載任務 取消下載
ChangeResourceGroup 修改資源群組 修改Project歸屬的資源群組。
ConsumerGroupHeartBeat 消費者發送心跳到服務端 消費者發送心跳到服務端。
ConsumerGroupUpdateCheckPoint 更新消費進度 更新指定消費組消費資料時Shard的checkpoint。
CreateAgentInstanceConfig 建立進程級配置 建立進程級配置
CreateAlert 建立警示規則 在指定Project下建立一個警示規則。
CreateAnnotationDataSet 建立資料集 建立資料集。
CreateAnnotationLabel 建立標籤 建立標籤表。
CreateAzureBlobIngestion CreateAzureBlobIngestion 建立Azure blob檔案匯入任務
CreateConfig 建立Logtail採集配置 建立Logtail採集配置。
CreateConsumerGroup 建立消費組 在指定的Logstore上建立一個消費組。
CreateDashboard 建立儀錶盤 建立儀錶盤。
CreateDomain 建立自訂網域名 為Project綁定新的自訂網域名。
CreateDownloadJob 建立日誌下載任務 在指定Project下建立一個日誌下載任務。
CreateETL 建立資料加工任務 在指定Project下建立一個資料加工任務。
CreateElasticsearchIngestion 建立ES/OpenSearch匯入任務 建立ES/OpenSearch匯入任務
CreateGCSIngestion 建立gcs匯入任務 建立GCP Cloud Storage檔案匯入任務
CreateIndex 建立索引 為指定Logstore建立索引。
CreateLogStore 建立LogStore 建立 LogStore。
CreateLogging 建立服務日誌 為Project建立服務日誌。
CreateLogtailPipelineConfig 建立Logtail流水線配置 建立Logtail流水線配置。
CreateMachineGroup 建立機器組 建立一個機器組。
CreateMaterializedView CreateMaterializedView 建立物化視圖
CreateMetricStore 建立時序庫 建立時序庫(MetricStore),可用於儲存時序資料。
CreateOSSExport 建立OSS投遞任務 將Logstore中的日誌投遞到OSS的Bucket。
CreateOSSHDFSExport 建立OSS-HDFS投遞任務 在指定的Project下建立一個OSS-HDFS投遞功能。
CreateOSSIngestion 建立OSS匯入任務 在指定Project下建立一個OSS匯入任務。
CreateS3Ingestion 建立S3匯入任務 建立S3檔案匯入任務
CreateSavedSearch 建立快速查詢 建立一個快速查詢。
CreateScheduledSQL 建立定時SQL任務 在指定的Project下建立一個定時SQL任務。
CreateSqlInstance 建立SQL獨享執行個體 當您使用SQL分析時,如果資料量較大,SQL普通版無法在一次查詢中完整掃描指定時間段內的所有日誌,返回的結果可能不包括所有匹配的資料,增加Shard可以提升讀寫能力,但只對新寫入的資料生效。您可以通過開啟SQL獨享版,增加計算資源,提升單次分析的資料量。
CreateStoreView 建立資料集 建立資料集。
CreateTicket 建立免登入票據 如果您需要將Log Service的查詢分析頁面、儀錶盤頁面,免密分享給其他人或者嵌入到第三方系統,可以調用CreateTicket產生ticket,然後拼接免密連結。
DeleteAgentInstanceConfig 刪除進程級配置 刪除進程級配置
DeleteAlert 刪除警示規則 刪除指定的警示規則。
DeleteAnnotationData 刪除資料 刪除資料集中的資料。
DeleteAnnotationDataSet 刪除資料集 刪除資料集。刪除資料集的前提是資料集下不存在資料結構。
DeleteAnnotationLabel 刪除標籤 刪除標籤表。刪除標籤只能刪除非內建標籤。
DeleteAzureBlobIngestion DeleteAzureBlobIngestion 建立Azure blob檔案匯入任務
DeleteCollectionPolicy 刪除雲產品日誌採集的採集規則 刪除雲產品日誌採集的採集規則。
DeleteConfig 刪除Logtail配置 刪除指定的Logtail配置。
DeleteConsumeProcessor 刪除消費處理器 刪除消費處理器
DeleteConsumerGroup 刪除消費組 刪除一個指定的消費組。
DeleteDashboard 刪除儀錶盤 刪除指定儀錶盤。
DeleteDomain 刪除自訂網域名 刪除Project綁定的自訂網域名。
DeleteDownloadJob 刪除日誌下載任務 刪除下載任務。
DeleteETL 刪除資料加工任務 刪除一個資料加工任務
DeleteElasticsearchIngestion 刪除ES/OpenSearch匯入任務 刪除ES/OpenSearch匯入任務
DeleteIndex 刪除索引 刪除指定Logstore的索引。
DeleteIngestProcessor 刪除寫入處理器 刪除寫入處理器。
DeleteLogStore 刪除LogStore 刪除指定Logstore,包括所有Shard資料和索引。
DeleteLogging 刪除指定服務日誌 刪除一個指定Project的服務日誌。
DeleteLogs 刪除日誌 刪除指定Project下某個Logstore中的日誌資料
DeleteLogtailPipelineConfig 刪除Logtail流水線配置 刪除Logtail流水線配置。
DeleteMachineGroup 刪除機器組 刪除機器組。如果機器組已應用Logtail採集配置,則刪除機器組後,會解除綁定對應的Logtail配置。
DeleteMaterializedView DeleteMaterializedView 刪除物化視圖
DeleteMetricStore 刪除時序庫 刪除一個已存在的時序庫,該時序庫所儲存的時序資料、關聯的採集配置、加工配置等關聯資源將被一併刪除。
DeleteOSSExport 刪除OSS投遞任務 刪除指定的OSS投遞任務。
DeleteOSSHDFSExport 刪除OSS-HDFS投遞任務 刪除指定的OSS-HDFS投遞任務。
DeleteOSSIngestion 刪除OSS匯入任務 刪除一個 OSS 匯入任務。
DeleteProjectPolicy 刪除Project授權策略 刪除Project的授權策略(Policy)。
DeleteS3Ingestion 刪除S3匯入任務 刪除s3匯入任務
DeleteSavedSearch 刪除快速查詢 刪除一個快速查詢。
DeleteScheduledSQL 刪除定時SQL任務 刪除指定的定時SQL任務。
DeleteStoreView 刪除資料集 根據名稱刪除指定資料集。
DescribeRegions 查詢可用性區域域 查詢可用的地區。
DisableAlert 關閉警示規則 關閉指定的警示規則。
DisableScheduledSQL 關閉定時SQL 關閉指定的定時SQL。
EnableAlert 開啟警示規則 開啟指定的警示規則。
EnableScheduledSQL 開啟定時SQL 開啟指定的定時SQL。
GetAgentInstanceConfig 擷取進程級配置 擷取進程級配置
GetAlert 擷取警示規則 擷取指定的警示規則。
GetAnnotationData 擷取資料 通過資料唯一標識得到資料集中的資料結構體。
GetAnnotationDataSet 擷取資料集 取得資料集資訊。
GetAnnotationLabel 擷取標籤 通過labelId拿到某個標籤表。
GetAppliedConfigs 擷取已應用的Logtail配置列表 擷取目標機器組上已經被應用的Logtail配置列表。
GetAppliedMachineGroups 通過Logtail配置擷取已綁定的機器組 調用GetAppliedMachineGroups介面擷取已綁定指定Logtail配置的機器組列表。
GetAsyncSql 擷取非同步SQL結果 擷取非同步SQL的狀態以及結果
GetAzureBlobIngestion 擷取AzureBlob匯入任務 擷取AzureBlob匯入任務
GetCheckPoint 擷取指定消費組的消費點 調用GetCheckPoint介面擷取指定消費組消費資料時Shard的checkpoint。
GetCollectionPolicy 擷取雲產品日誌採集的採集規則 調用GetCollectionPolicy擷取對應的規則。
GetConfig 擷取Logtail採集配置 調用GetConfig介面擷取Logtail配置的詳細資料。
GetConsumeProcessor 查詢消費處理器詳情 查詢消費處理器的詳情
GetContextLogs 查詢上下文日誌 調用GetContextLogs介面查詢指定日誌前(上文)後(下文)的若干條日誌。
GetCursor 通過時間查詢Cursor 可以根據時間擷取對應的遊標(Cursor)。
GetCursorTime 通過Cursor查詢服務器端時間 根據 Cursor 遊標擷取遊標對應的服務端時間。
GetDashboard 擷取指定儀錶盤 擷取指定儀錶盤。
GetDownloadJob 擷取日誌下載任務 擷取下載任務資訊。
GetETL 擷取資料加工任務 擷取指定的資料加工任務配置。
GetElasticsearchIngestion 擷取ES/OpenSearch匯入任務 擷取ES/OpenSearch匯入任務
GetGCSIngestion 擷取gcs匯入任務 擷取GCP Cloud Storage檔案匯入任務
GetHistograms 查詢日誌分布情況 調用GetHistograms介面查詢指定Logstore中滿足查詢文法條件的日誌分布情況。
GetIndex 擷取索引 查詢指定Logstore的索引資訊。
GetIngestProcessor 查詢寫入處理器資訊 查詢寫入處理器的資訊。
GetLogStore 查看Logstore資訊 查看Logstore的詳細資料。
GetLogStoreConfig 擷取日誌庫配置 擷取日誌庫配置
GetLogStoreMeteringMode 查詢LogStore計量模式 擷取Logstore計量模式。
GetLogging 擷取服務日誌資訊 查詢目標Project的服務日誌配置。
GetLogs 查詢日誌庫日誌 查詢指定Project下某個Logstore中的日誌資料。
GetLogsV2 查詢Logstore中的日誌資料。 查詢指定Project下某個Logstore中的原始日誌資料,返回結果顯示某時間區間中的原始日誌(返回結果壓縮後傳輸)。
GetLogtailPipelineConfig 擷取Logtail流水線配置 擷取Logtail流水線配置。
GetMLServiceResults 擷取指定情境任務的演算法分析結果 在阿里雲Log Service平台上,提供了基礎資料(Log、Metric、Trace)的智能分析能力。使用者調用相關模型,可以直接得到模型的分析結果。目前主要涉及:日誌資料的NER任務、時間序列資料的異常檢測、高延時鏈路資料的Span根因定位。
GetMachineGroup 擷取機器組配置 查看目標機器組的具體資訊。
GetMaterializedView GetMaterializedView 取得物化視圖。
GetMetricStore 查詢時序庫 查詢時序庫。
GetMetricStoreMeteringMode 查詢時序庫計費模式 查詢指定時序庫的當前計費模式。
GetOSSExport 擷取OSS投遞任務 擷取指定的 OSS 投遞任務。
GetOSSHDFSExport 擷取OSS-HDFS投遞任務 擷取指定的 OSS-HDFS 投遞任務。
GetOSSIngestion 擷取OSS匯入任務 擷取指定 OSS 匯入任務。
GetProjectPolicy 查詢Project授權策略 查詢Project權限原則(Policy)。
GetS3Ingestion 擷取S3匯入任務 擷取s3匯入任務資訊
GetSavedSearch 擷取指定快速查詢 擷取指定的快速查詢。
GetScheduledSQL 擷取定時SQL任務 擷取指定的定時SQL任務
GetSlsService 查詢Log Service的開通狀態 調用GetSlsService介面擷取Log Service的開通狀態。服務地址只能是華東2(上海)或新加坡
GetSqlInstance 查詢SQL 獨享執行個體 查詢Project的SQL獨享版本的CU數、是否為 Project 預設開啟SQL獨享版等資訊。使用該介面前,必須先調用CreateSqlInstance或UpdateSqlInstance介面建立SQL獨享版。
GetStoreView 查詢指定資料集 根據名稱查詢指定資料集配置。
GetStoreViewIndex 查詢指定資料集索引配置 根據指定名稱查詢資料集索引,只支援 logstore 類型的資料集。
ListAgentInstanceConfigs 列出進程級配置 列出進程級配置
ListAiTools 列舉可觀測 AI 工具能力 擷取可觀測提供的智慧型工具列表,包括可觀測各業務 Copilot 相關能力
ListAlerts 列出警示規則 列出指定Project下的警示規則。
ListAnnotationData 擷取資料列表 列出資料集中的所有資料。
ListAnnotationDataSets 擷取資料集列表 取得資料集結構體列表。
ListAnnotationLabels 擷取標籤列表 取得標籤表的列表。
ListAzureBlobIngestion 列出AzureBlob匯入任務 列出AzureBlob匯入任務
ListCollectionPolicies 列出雲產品日誌採集的採集規則 列出雲產品日誌採集的採集規則。
ListConfig 查詢Logtail配置列表 調用ListConfig介面查詢指定Project下所有的Logtail配置。
ListConsumeProcessors 列出消費處理器 列出符合參數條件的消費處理器。
ListConsumerGroup 查詢消費組 查詢指定Logstore的所有消費組。
ListDashboard 查詢儀錶盤 查詢儀錶盤。
ListDomains 查詢自訂網域名 列出Project綁定的自訂網域名。
ListDownloadJobs 列出日誌下載任務 列出指定Project下的日誌下載任務。
ListETLs 列出資料加工任務 列出 project 下的資料加工任務
ListElasticsearchIngestions 列出ES/OpenSearch匯入任務 列出ES/OpenSearch匯入任務
ListGCSIngestions 列出gcs匯入任務 列出GCP Cloud Storage檔案匯入任務
ListIngestProcessors 列出寫入處理器 列出符合參數條件的寫入處理器。
ListLogStores 列出LogStore 查詢指定Project下所有或匹配的LogStore列表。
ListLogtailPipelineConfig 羅列Logtail流水線配置 列舉指定條件下的Logtail流水線配置名稱。
ListMachineGroup 查詢Project下的機器組 列出目標Project下的機器組。
ListMachines 查詢機器組中的機器列表 列出目標機器組中與Log Service串連正常的機器列表。
ListMaterializedView ListMaterializedView 列舉物化視圖
ListMaterializedViews ListMaterializedViews 列舉物化視圖
ListMetricStores 列出時序庫 列出記錄項目下的時序庫,支援按照時序庫名稱模糊尋找。
ListOSSExports 列出OSS投遞任務 列出指定 Project 下的 OSS 投遞任務。
ListOSSHDFSExports 列出OSS-HDFS投遞任務 列出指定 Project 下的 OSS-HDFS 投遞任務。
ListOSSIngestions 列出OSS匯入任務 列出指定 Project 下的 OSS 匯入任務。
ListS3Ingestions 列出OSS匯入任務 列出s3匯入任務
ListSavedSearch 查詢快速查詢 查詢快速查詢列表。
ListScheduledSQLs 列出定時SQL任務 列出指定Project下的定時SQL任務。
ListShards 查詢shard列表 列出指定Logstore中所有可用的Shard。
ListStoreViews 查詢資料集列表 查詢記錄項目中的資料集列表。
MergeShard 合并shard 合并相鄰位置的讀寫Shard。
OpenSlsService 開通Log Service 開通Log Service。服務地址只能是華東2(上海)或新加坡。
PullLogs 拉取日誌 調用PullLogs介面擷取指定遊標(Cursor)位置的日誌資料。此介面擷取的是原始日誌,如要查詢或分析日誌,請使用GetLogsV2介面。
PutAnnotationData 儲存資料 向資料集中存入資料。
PutConsumeProcessor 建立或修改消費處理器 建立新的消費處理器或者更新已有的消費處理器
PutIngestProcessor 建立或修改寫入處理器 建立或修改寫入處理器。
PutLogStoreConfig 更新日誌庫配置 修改日誌庫的配置
PutLogs 寫入日誌 調用PutLogs介面向指定的Logstore中寫入日誌資料。
PutProjectPolicy 建立Project授權策略 建立Project權限原則(Policy)。
PutProjectTransferAcceleration 配置傳輸加速 開通或關閉傳輸加速。
PutWebtracking 通過WebTracking批量寫入日誌 通過 WebTracking 方式單次寫入多條日誌。
RefreshToken 重新整理權杖 通過票據重新整理存取權杖,用於存取控制台介面。
RemoveConfigFromMachineGroup 刪除機器組Logtail配置 從機器組中移除Logtail配置。
SplitShard 分裂Shard 分裂一個指定的readwrite狀態的Shard。
StartAzureBlobIngestion 啟動AzureBlob匯入任務 啟動AzureBlob匯入任務
StartETL 啟動資料加工任務 啟動指定的資料加工任務。
StartElasticsearchIngestion 啟動ES/OpenSearch匯入任務 啟動ES/OpenSearch匯入任務
StartGCSIngestion 啟動gcs匯入任務 啟動GCP Cloud Storage檔案匯入任務
StartOSSExport 啟動OSS投遞任務 啟動指定的OSS投遞任務。
StartOSSHDFSExport 啟動OSS-HDFS投遞任務 啟動指定的OSS-HDFS投遞任務。
StartOSSIngestion 啟動OSS匯入任務 啟動指定OSS匯入任務。
StopAzureBlobIngestion 停止AzureBlob匯入任務 停止AzureBlob匯入任務
StopETL 停止資料加工任務 停止指定的資料加工任務。
StopElasticsearchIngestion 停止ES/OpenSearch匯入任務 停止ES/OpenSearch匯入任務
StopGCSIngestion 停止gcs匯入任務 停止GCP Cloud Storage檔案匯入任務
StopOSSExport 停止OSS投遞任務 停止指定的OSS投遞任務。
StopOSSHDFSExport 停止OSS-HDFS投遞任務 停止指定的OSS-HDFS投遞任務。
StopOSSIngestion 停止OSS匯入任務 停止指定OSS匯入任務。
SubmitAsyncSql 提交非同步SQL請求 提交非同步SQL請求。
UpdateAgentInstanceConfig 更新進程級配置 更新進程級配置
UpdateAlert 更新警示規則 更新指定的警示規則。
UpdateAnnotationDataSet 更新資料集 更新資料集。
UpdateAnnotationLabel 更新標籤 更新標籤表。更新標籤集,只能更新標籤集中標籤的命名,其他無法更新。
UpdateAzureBlobIngestion 更新AzureBlob匯入任務 更新AzureBlob匯入任務
UpdateConfig 更新Logtail採集配置 修改指定的 Logtail 採集配置。
UpdateConsumerGroup 更新消費者組 修改指定消費組屬性。
UpdateDashboard 更新儀錶盤 更新儀錶盤。
UpdateETL 更新資料加工任務 更新指定的資料加工任務配置並重啟
UpdateElasticsearchIngestion 更新ES/OpenSearch匯入任務 更新ES/OpenSearch匯入任務
UpdateGCSIngestion 更新gcs匯入任務 更新GCP Cloud Storage檔案匯入任務
UpdateIndex 更新索引 更新Logstore的索引資訊。
UpdateLogStore 更新LogStore 更新Logstore的屬性資訊。
UpdateLogStoreEncryption 更新加密配置 更新日誌庫的加密配置。可以為日誌庫建立加密配置、開啟或關閉日誌加密功能。
UpdateLogStoreMeteringMode 更新LogStore計量模式 更新Logstore計量模式。
UpdateLogStoreProcessor 更新LogStore關聯的寫入處理器 更新LogStore關聯的寫入處理器。
UpdateLogging 更新服務日誌配置 更新一個Project的服務日誌配置。
UpdateLogs 更新日誌 更新指定 Project 下某個 Logstore 中的日誌資料。
UpdateLogtailPipelineConfig 更新Logtail流水線配置 更新Logtail流水線配置。
UpdateMachineGroup 修改機器組 修改機器組配置資訊。
UpdateMachineGroupMachine 修改機器組機器列表 修改機器組中的機器列表,支援從機器列表中增加或者刪除機器。
UpdateMaterializedView UpdateMaterializedView 更新物化視圖
UpdateMetricStore 更新時序庫 更新一個已存在的時序庫的配置,時序庫可用於儲存時序資料。
UpdateMetricStoreMeteringMode 更新時序庫計費模式 更新指定時序庫的計費模式。
UpdateMetricStoreProcessor 更新MetricStore關聯的寫入處理器 更新MetricStore關聯的寫入處理器。
UpdateOSSExport 更新OSS投遞任務 更新指定的OSS投遞任務。
UpdateOSSHDFSExport 更新OSS-HDFS投遞任務 更新指定的OSS-HDFS投遞任務。
UpdateOSSIngestion 更新OSS匯入任務 更新指定的OSS匯入任務。
UpdateSavedSearch 更新快速查詢 調用UpdateSavedSearch介面更新快速查詢。
UpdateScheduledSQL 更新定時SQL任務 更新指定的定時 SQL 任務。
UpdateSqlInstance 更新SQL 獨享執行個體 當您使用SQL分析時,如果資料量較大,SQL普通版無法在一次查詢中完整掃描指定時間段內的所有日誌,返回的結果可能不包括所有匹配的資料,增加Shard可以提升讀寫能力,但只對新寫入的資料生效。您可以通過開啟SQL獨享版,增加計算資源,提升單次分析的資料量。
UpdateStoreView 更新資料集配置 更新指定資料集配置。
UpsertCollectionPolicy 建立雲產品日誌採集的採集規則 建立雲產品日誌採集的採集規則,從而實現雲產品日誌的自動化採集。

資料匯入

API

標題

API概述

GCS匯入 GCS匯入
Elasticsearch匯入 Elasticsearch匯入
S3匯入 S3匯入
AzureBlob匯入 AzureBlob匯入
OSS匯入 OSS匯入