API overview

Updated at:
Copy as MD

API standards and multilingual preset SDKs

The OpenAPI of this product (Sls/2020-12-30) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Logstore

API

Title

Description

CreateLogStore CreateLogStore Creates a Logstore.
CreateIndex CreateIndex Creates indexes for a Logstore.
DeleteLogStore DeleteLogStore Deletes a Logstore, including all shards and indexes in the Logstore.
DeleteIndex DeleteIndex Deletes an index of a Logstore.
PutWebtracking PutWebtracking Sends multiple logs to Simple Log Service in one request.
UpdateLogStore UpdateLogStore Updates the properties of a Logstore.
UpdateIndex UpdateIndex Updates the indexes of a Logstore.
SplitShard SplitShard Splits a shard in the readwrite state.
UpdateLogStoreMeteringMode UpdateLogStoreMeteringMode Changes the billing mode of a Logstore.
MergeShard MergeShard Merges adjacent read/write shards.
ListLogStores ListLogStores Queries all Logstores or Logstores that match specific conditions in a project.
GetLogStore GetLogStore Retrieves the details of a Logstore.
GetIndex GetIndex Queries the index of a Logstore.
ListShards ListShards Queries a list of shards in a Logstore.
GetLogs GetLogs Queries log data from a Logstore in the specified project.
UpdateLogStoreEncryption UpdateLogStoreEncryption Updates the encryption configuration of a Logstore. You can create encryption configurations for the Logstore and enable or disable the encryption feature.
GetCursor GetCursor Retrieves a cursor based on a specified time.
GetContextLogs GetContextLogs Queries the contextual logs of a specified log.
GetHistograms GetHistograms You can call the GetHistograms operation to query the distribution of logs that meet the search criteria in a specified Logstore.
GetCursorTime GetCursorTime Retrieves the server time that corresponds to a cursor.
GetLogsV2 Query log data in a logstore Queries raw log data from a specified Logstore in a project and returns raw logs within a specified time range. The results are compressed before transmission.
PullLogs PullLogs Call the PullLogs operation to retrieve log data from a specified cursor position. This operation retrieves raw logs. To query or analyze logs, call the GetLogsV2 operation.
PutLogs PutLogs Writes log data to a specified logstore.
GetLogStoreMeteringMode GetLogStoreMeteringMode Queries the billing mode of a Logstore.
SubmitAsyncSql SubmitAsyncSql Submits an asynchronous SQL request.
GetAsyncSql GetAsyncSql Retrieves the status and results of an asynchronous SQL query.

Metricstore

API

Title

Description

ListMetricStores ListMetricStores Queries the list of Metricstores in a project. You can use fuzzy search to query the Metricstores by Metricstore name.
CreateMetricStore CreateMetricStore Creates a Metricstore to store metrics.
DeleteMetricStore DeleteMetricStore Deletes an existing Metricstore. When you delete a Metricstore, the metric data stored in the Metricstore and associated resources such as associated collection settings and transformation settings are also deleted.
UpdateMetricStore UpdateMetricStore Updates the configuration of an existing Metricstore. A Metricstore is used to store metrics.
UpdateMetricStoreMeteringMode UpdateMetricStoreMeteringMode Updates the billing mode of a specified Metricstore.
GetMetricStore GetMetricStore Queries a Metricstore.
GetMetricStoreMeteringMode GetMetricStoreMeteringMode Queries the billing mode of a Metricstore.

Storeview

API

Title

Description

CreateStoreView CreateStoreView Creates a dataset.
DeleteStoreView DeleteStoreView Deletes a dataset by using the name of the dataset.
UpdateStoreView UpdateStoreView Updates the configurations of a dataset.
GetStoreView GetStoreView Queries the configurations of a dataset by using the name of the dataset.
GetStoreViewIndex GetStoreViewIndex Queries the indexes of a dataset by using the name of the dataset. Only datasets of the logstore type are supported.
ListStoreViews ListStoreViews Queries datasets in a project.

Machine group

API

Title

Description

CreateMachineGroup CreateMachineGroup Creates a machine group.
DeleteMachineGroup DeleteMachineGroup Deletes a machine group. If the Logtail configurations for log collection are applied to a machine group, the configurations are disassociated from the machine group after the machine group is deleted.
RemoveConfigFromMachineGroup RemoveConfigFromMachineGroup Removes a Logtail configuration from a machine group.
ApplyConfigToMachineGroup ApplyConfigToMachineGroup Applies a Logtail configuration to a machine group.
UpdateMachineGroup UpdateMachineGroup Modifies the configuration of a machine group.
UpdateMachineGroupMachine UpdateMachineGroupMachine Modifies the machines in a machine group. You can add machine to or remove machines from the machine group.
ListMachineGroup ListMachineGroup Queries the machine groups of a project.
ListMachines ListMachines Queries a list of machines that are connected to Simple Log Service in a specified machine group.
GetMachineGroup GetMachineGroup Gets the details of a machine group.
GetAppliedConfigs GetAppliedConfigs Queries the Logtail configurations that are applied to a machine group.
GetAppliedMachineGroups GetAppliedMachineGroups Queries the machine groups to which a Logtail configuration is bound.

Collection configuration

API

Title

Description

CreateConfig CreateConfig Creates a Logtail configuration.
CreateLogtailPipelineConfig CreateLogtailPipelineConfig Creates a Logtail pipeline configuration.
DeleteConfig DeleteConfig Deletes a Logtail configuration.
DeleteLogtailPipelineConfig DeleteLogtailPipelineConfig Deletes a Logtail pipeline configuration.
UpdateConfig UpdateConfig Modifies a Logtail configuration.
UpdateLogtailPipelineConfig UpdateLogtailPipelineConfig Updates a Logtail pipeline configuration.
GetConfig GetConfig Gets the details of a Logtail configuration.
ListConfig ListConfig Queries all Logtail configurations in a project.
GetLogtailPipelineConfig GetLogtailPipelineConfig Queries the information about a Logtail pipeline configuration.
ListLogtailPipelineConfig ListLogtailPipelineConfig Lists the names of Logtail pipeline configurations that meet specified criteria.

Dashboard

API

Title

Description

CreateDashboard CreateDashboard Creates a dashboard.
DeleteDashboard DeleteDashboard Deletes a dashboard.
UpdateDashboard UpdateDashboard Updates a dashboard.
GetDashboard GetDashboard Queries a dashboard.
ListDashboard ListDashboard Queries dashboards.

Consumer group

API

Title

Description

CreateConsumerGroup CreateConsumerGroup Creates a consumer group for a Logstore.
DeleteConsumerGroup DeleteConsumerGroup Deletes a consumer group.
ConsumerGroupUpdateCheckPoint ConsumerGroupUpdateCheckPoint Updates the checkpoint of a shard for a consumer group.
UpdateConsumerGroup UpdateConsumerGroup Updates the attributes of a consumer group.
ConsumerGroupHeartBeat ConsumerGroupHeartBeat A consumer sends a heartbeat to the server to maintain its active status.
ListConsumerGroup ListConsumerGroup Queries all consumer groups of a Logstore.
GetCheckPoint GetCheckPoint Queries the checkpoints of a shard from which data is consumed by a consumer group.

Saved search

API

Title

Description

CreateSavedSearch CreateSavedSearch Creates a saved search.
DeleteSavedSearch DeleteSavedSearch Deletes a saved search.
UpdateSavedSearch UpdateSavedSearch Updates a saved search.
ListSavedSearch ListSavedSearch Queries a list of saved searches.
GetSavedSearch GetSavedSearch Queries a saved search.

Alerting

API

Title

Description

CreateAlert CreateAlert Creates an alert rule in a project.
DeleteAlert DeleteAlert Deletes an alert rule.
UpdateAlert UpdateAlert Updates an alert rule.
EnableAlert EnableAlert Enables an alert rule.
DisableAlert DisableAlert Disables an alert rule.
GetAlert GetAlert Queries the information about an alert rule.

Data import

API

Title

Description

GCS import GCS import
UpdateGCSIngestion UpdateGCSIngestion Updates a GCP Cloud Storage file ingestion task.
StopGCSIngestion StopGCSIngestion Stops a GCP Cloud Storage file import task.
StartGCSIngestion StartGCSIngestion Starts a GCS file import task.
ListGCSIngestions ListGCSIngestions Lists Google Cloud Storage (GCS) file import jobs.
GetGCSIngestion GetGCSIngestion Retrieves a Google Cloud Storage (GCS) file import task.
CreateGCSIngestion CreateGCSIngestion Creates a GCS file import task.
Elasticsearch import Elasticsearch import
UpdateElasticsearchIngestion UpdateElasticsearchIngestion Updates an ES or OpenSearch ingestion task.
StopElasticsearchIngestion StopElasticsearchIngestion Stops an ES or OpenSearch import job.
StartElasticsearchIngestion StartElasticsearchIngestion Starts an ES or OpenSearch ingestion task.
CreateElasticsearchIngestion CreateElasticsearchIngestion Creates an ES or OpenSearch import job.
ListElasticsearchIngestions ListElasticsearchIngestions Lists the Elasticsearch and OpenSearch ingestion jobs.
GetElasticsearchIngestion GetElasticsearchIngestion Retrieves information about an ES/OpenSearch import job.
DeleteElasticsearchIngestion DeleteElasticsearchIngestion Deletes an ES/OpenSearch ingestion task.
S3 import S3 import
CreateS3Ingestion CreateS3Ingestion Creates an S3 file import job.
ListS3Ingestions ListS3Ingestions Lists S3 import tasks.
GetS3Ingestion GetS3Ingestion Retrieves information about an S3 import task.
DeleteS3Ingestion DeleteS3Ingestion Deletes an S3 ingestion task.
AzureBlob import AzureBlob import
StopAzureBlobIngestion StopAzureBlobIngestion Stops an Azure Blob ingestion task.
StartAzureBlobIngestion StartAzureBlobIngestion Starts an Azure Blob ingestion task.
DeleteAzureBlobIngestion DeleteAzureBlobIngestion Create a file import task from Azure Blob
UpdateAzureBlobIngestion UpdateAzureBlobIngestion Updates an Azure Blob ingestion.
ListAzureBlobIngestion ListAzureBlobIngestion Lists Azure Blob ingestion tasks.
CreateAzureBlobIngestion CreateAzureBlobIngestion Creates an Azure BLOB ingestion task.
GetAzureBlobIngestion GetAzureBlobIngestion Gets the details of an Azure Blob ingestion.
OSS import OSS import
CreateOSSIngestion CreateOSSIngestion Creates an OSS import task in a specified project.
GetOSSIngestion GetOSSIngestion Retrieves a specified OSS import job.
ListOSSIngestions ListOSSIngestions Lists OSS import tasks in a specified Project.
StopOSSIngestion StopOSSIngestion Stops the specified OSS import task.
StartOSSIngestion StartOSSIngestion Starts a specified OSS import task.
UpdateOSSIngestion UpdateOSSIngestion Updates the specified OSS import task.
DeleteOSSIngestion DeleteOSSIngestion Deletes an OSS import task.

Data shipping

API

Title

Description

CreateOSSExport CreateOSSExport Exports logs from a Logstore to an OSS bucket.
CreateOSSHDFSExport CreateOSSHDFSExport Creates an export job from OSS to HDFS in a specified project.
DeleteOSSExport DeleteOSSExport Deletes a specified OSS data shipping job.
DeleteOSSHDFSExport DeleteOSSHDFSExport Deletes an OSS-HDFS data shipping job.
UpdateOSSExport UpdateOSSExport Updates an Object Storage Service (OSS) data shipping job.
StartOSSExport StartOSSExport Starts an Object Storage Service (OSS) data shipping job.
StopOSSExport StopOSSExport Stops an Object Storage Service (OSS) data shipping job.
GetOSSExport GetOSSExport Retrieves the specified OSS data shipping job.
UpdateOSSHDFSExport UpdateOSSHDFSExport Updates an OSS-HDFS data shipping job.
StartOSSHDFSExport StartOSSHDFSExport Starts an OSS-HDFS data shipping job.
StopOSSHDFSExport StopOSSHDFSExport Stops an OSS-HDFS data shipping job.
ListOSSExports ListOSSExports Queries the OSS shipping jobs in a specified project.
GetOSSHDFSExport GetOSSHDFSExport Retrieves the details of a specified OSS-HDFS delivery job.
ListOSSHDFSExports ListOSSHDFSExports Lists the OSS-HDFS export tasks in a specified project.

Data transformation

API

Title

Description

CreateETL CreateETL Creates a data transformation job in a specified project.
DeleteETL DeleteETL Deletes a data transformation job.
UpdateETL UpdateETL Updates the configuration of a specified data transformation task and restarts it.
StartETL StartETL Starts a data transformation task.
StopETL StopETL Stops a specified data transformation task.
ListETLs ListETLs Lists the data transformation jobs in a project.
GetETL GetETL Retrieves the configuration of a specified extract, transform, and load (ETL) job.

Scheduled query

API

Title

Description

CreateScheduledSQL CreateScheduledSQL Creates a scheduled SQL job in a specified project.
DeleteScheduledSQL DeleteScheduledSQL Deletes a Scheduled SQL job.
UpdateScheduledSQL UpdateScheduledSQL Updates the specified scheduled SQL task.
EnableScheduledSQL EnableScheduledSQL Enables the Scheduled SQL feature.
DisableScheduledSQL DisableScheduledSQL Disables the Scheduled SQL feature.
ListScheduledSQLs ListScheduledSQLs Lists the Scheduled SQLs in a specified project.
GetScheduledSQL GetScheduledSQL Retrieves the specified Scheduled SQL job.

Log download

API

Title

Description

CreateDownloadJob CreateDownloadJob Creates a log download task in a specified project.
DeleteDownloadJob DeleteDownloadJob Deletes a download job.
GetDownloadJob GetDownloadJob Retrieves information about a download task.
ListDownloadJobs ListDownloadJobs Lists the log download jobs in a specified project.

Write processor

API

Title

Description

PutIngestProcessor PutIngestProcessor Creates or modifies an ingest processor.
GetIngestProcessor GetIngestProcessor Retrieves information about an ingest processor.
ListIngestProcessors ListIngestProcessors Lists ingest processors that meet the specified conditions.
DeleteIngestProcessor DeleteIngestProcessor Deletes an ingest processor.
UpdateLogStoreProcessor UpdateLogStoreProcessor Updates the ingest processor for a Logstore.
UpdateMetricStoreProcessor UpdateMetricStoreProcessor Updates the ingest processor that is associated with a Metricstore.

Consum processor

API

Title

Description

PutConsumeProcessor PutConsumeProcessor Creates or updates a consume processor.
GetConsumeProcessor GetConsumeProcessor Retrieves the details of a consume processor.
ListConsumeProcessors ListConsumeProcessors Retrieves a list of consume processors that match the specified parameters.
DeleteConsumeProcessor DeleteConsumeProcessor Deletes a consume processor.

Machine learning

API

Title

Description

ListAiTools ListAiTools Lists the AI tools provided by the observability service, including Copilot capabilities for various services.
CallAiTools Invoke an observability AI tool capability Invokes an observability AI tool. Tool capabilities are continuously updated. You can call the tool list operation to retrieve the currently supported capabilities.
CreateAnnotationLabel CreateAnnotationLabel Creates an annotation label table.
PutAnnotationData PutAnnotationData Stores annotation data in a dataset.
CreateAnnotationDataSet Create a dataset Creates a dataset.
DeleteAnnotationLabel DeleteAnnotationLabel Deletes a custom annotation label.
DeleteAnnotationData DeleteAnnotationData Deletes data from a dataset.
DeleteAnnotationDataSet DeleteAnnotationDataSet Deletes a dataset. You can delete a dataset only if it contains no data structures.
UpdateAnnotationLabel UpdateAnnotationLabel Updates a label table. You can update only the names of labels in a label set.
UpdateAnnotationDataSet UpdateAnnotationDataSet Updates a dataset.
GetAnnotationLabel GetAnnotationLabel Retrieves a label table by its ID.
ListAnnotationLabels ListAnnotationLabels Lists annotation label tables.
GetAnnotationData GetAnnotationData Retrieves a data struct from a dataset by its unique identity.
ListAnnotationData ListAnnotationData Lists the data records in a specified dataset.
GetAnnotationDataSet GetAnnotationDataSet Retrieves information about a dataset.
ListAnnotationDataSets ListAnnotationDataSets Returns a list of dataset structs.
GetMLServiceResults GetMLServiceResults Alibaba Cloud Simple Log Service (SLS) provides intelligent analysis for data such as logs, metrics, and traces. You can call models to obtain analysis results directly. Its main features include Named Entity Recognition (NER) for log data, anomaly detection for time series data, and root cause analysis for high-latency trace spans.

Authorization policy

API

Title

Description

PutProjectPolicy PutProjectPolicy Creates a project access policy.
DeleteProjectPolicy DeleteProjectPolicy Deletes a project policy.
GetProjectPolicy GetProjectPolicy Queries a project policy.

Cloud service collection rule

API

Title

Description

UpsertCollectionPolicy UpsertCollectionPolicy Creates a log collection policy for a cloud service. This way, logs can be automatically collected from the service.
DeleteCollectionPolicy DeleteCollectionPolicy Deletes a log collection rule for an Alibaba Cloud product.
ListCollectionPolicies ListCollectionPolicies Lists the collection rules for logs from Alibaba Cloud services.
GetCollectionPolicy GetCollectionPolicy You can call the GetCollectionPolicy operation to retrieve the details of a specific rule.

Dedicated SQL instance

API

Title

Description

CreateSqlInstance CreateSqlInstance If you use Standard SQL to analyze a large volume of data, a single query may not be able to scan all logs within a specified time range, which can result in incomplete data. Adding shards improves read and write performance, but this change applies only to new data. To analyze a larger volume of data in a single query, you can enable Dedicated SQL and increase its compute resources.
UpdateSqlInstance UpdateSqlInstance When you use Standard SQL to analyze large amounts of data, a single query may not scan all logs within a specific time range, which can result in incomplete data. Although adding shards improves read and write performance, this improvement applies only to new data. To analyze more data in a single query, enable Dedicated SQL and add more compute resources.
GetSqlInstance GetSqlInstance Gets information about the Dedicated SQL instance of a project, such as the number of compute units (CUs) and whether the Dedicated SQL instance is enabled by default. Before you call this operation, you must create a Dedicated SQL instance by calling the CreateSqlInstance or UpdateSqlInstance operation.

Service activation

API

Title

Description

OpenSlsService OpenSlsService Activates Simple Log Service. You must use the endpoint for Simple Log Service only in the China (Shanghai) or Singapore region.

Console embedding

API

Title

Description

RefreshToken RefreshToken Refreshes an access token using a ticket. The access token is used to call console API operations.

Process-level configuration

API

Title

Description

CreateAgentInstanceConfig CreateAgentInstanceConfig Creates a process-level configuration.
DeleteAgentInstanceConfig DeleteAgentInstanceConfig Deletes a process configuration.
GetAgentInstanceConfig GetAgentInstanceConfig Retrieves a process-level configuration.
ListAgentInstanceConfigs ListAgentInstanceConfigs This operation lists process-level configurations.
UpdateAgentInstanceConfig UpdateAgentInstanceConfig Updates process-level configurations.

MaxCompute shipping

API

Title

Description

GetMaxComputeExport GetMaxComputeExport Queries a MaxCompute data shipping job.
CreateMaxComputeExport CreateMaxComputeExport Creates a MaxCompute data shipping job.
DeleteMaxComputeExport DeleteMaxComputeExport Deletes a MaxCompute data shipping job.
ListMaxComputeExports ListMaxComputeExports Lists MaxCompute delivery tasks.
StartMaxComputeExport StartMaxComputeExport Starts a MaxCompute data shipping job.
StopMaxComputeExport StopMaxComputeExport Stops a MaxCompute data shipping job.
UpdateMaxComputeExport UpdateMaxComputeExport Updates a MaxCompute data shipping job.

Tag

API

Title

Description

UntagResources UntagResources Detaches one or more tags from a resource. You can detach tags only from Simple Log Service projects. You can detach multiple or all tags from a Simple Log Service project at a time.
TagResources TagResources Creates and adds tags to a resource. You can add tags only to projects.
ListTagResources ListTagResources Queries a list of tags for one or more resources. You can query tags for resources by resource type or filter resources by tag. Each tag is a key-value pair.

Project

API

Title

Description

CreateProject CreateProject Creates a project.
DeleteProject DeleteProject Deletes a specified project.
GetProject Get a specified project Queries the details of a specified project.
ListProject List project information Lists project information that meets the specified conditions.
UpdateProject UpdateProject Updates project information.
GetProjectLogs GetProjectLogs Queries logs in a project. You can use this operation to query logs at the project level.

Others

API

Title

Description

CancelDownloadJob Cancel Log Download Job Cancel Download
CreateDomain CreateDomain Binds a new custom domain name to a project.
CreateLogging CreateLogging Enables the service log feature for a project.
DeleteDomain DeleteDomain Deletes a custom domain name that is bound to a project.
DeleteLogging DeleteLogging Deletes the service log for a specified project.
GetLogging GetLogging Queries the service log configuration of a project.
ListDomains ListDomains Queries the custom domain names that are bound to projects.
PutProjectTransferAcceleration PutProjectTransferAcceleration Enables or disables transfer acceleration.
UpdateLogging UpdateLogging Updates the service log configurations of a project.
GetLogStoreConfig GetLogStoreConfig Retrieves the configuration of a Logstore.
PutLogStoreConfig PutLogStoreConfig Updates the configuration of a Logstore.
ChangeResourceGroup ChangeResourceGroup Changes the resource group to which a resource belongs.
CreateTicket CreateTicket Obtains a ticket. Simple Log Service allows you to share the query and analysis pages and dashboard pages with other users and embed the console pages into third-party systems. This way, other users can view your logs in password-free mode. The URLs of the shared pages are referred to as password-free URLs. You can call the CreateTicket operation to obtain a ticket and generate a password-free URL based on the ticket and the URL of the console page that you want to share.
DescribeRegions DescribeRegions Queries the available regions.
GetSlsService GetSlsService Call the GetSlsService operation to retrieve the activation status of Simple Log Service. The endpoint must be China (Shanghai) or Singapore.
ListAlerts ListAlerts Lists the alert rules in a specified project.
CreateMaterializedView CreateMaterializedView Creates a materialized view.
DeleteMaterializedView DeleteMaterializedView Deletes a materialized view.
GetMaterializedView GetMaterializedView Retrieves a materialized view.
ListMaterializedView ListMaterializedView Lists the materialized views in a project.
ListMaterializedViews ListMaterializedViews Lists materialized views.
UpdateMaterializedView UpdateMaterializedView Updates a materialized view.
DeleteLogs Delete logs Deletes log data from a Logstore under a specified project
UpdateLogs Update Logs Updates log data in a specified Logstore under the specified Project.