API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Sls/2020-12-30) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Project
| API | Title | Description |
| CreateProject | CreateProject | Creates a project. |
| CreateDomain | CreateDomain | Binds a new custom domain name to a project. |
| CreateLogging | CreateLogging | Enables the service log feature for a project. |
| DeleteProject | DeleteProject | Deletes a project. |
| DeleteLogging | DeleteLogging | Disables the service log feature for a project. |
| DeleteDomain | DeleteDomain | Deletes a custom domain name that is bound to a project. |
| UpdateProject | UpdateProject | Updates a project. |
| UpdateLogging | UpdateLogging | Updates the service log configurations of a project. |
| PutProjectTransferAcceleration | PutProjectTransferAcceleration | Enables or disables transfer acceleration. |
| GetProject | GetProject | Queries the details of a project. |
| ListProject | ListProject | Lists projects that meet the specified conditions. |
| GetProjectLogs | GetProjectLogs | Queries logs in a project. You can use this operation to query logs at the project level. |
| GetLogging | GetLogging | Queries the service log configuration of a project. |
| ListDomains | ListDomains | Queries the custom domain names that are bound to projects. |
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 attributes 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 | Queries 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 the logs of a Logstore in a 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 | Queries a cursor based on a point in time. |
| GetContextLogs | GetContextLogs | Queries the contextual logs of a specified log. |
| GetHistograms | GetHistograms | Queries the distribution of logs that meet the specified search conditions in a Logstore. |
| GetCursorTime | GetCursorTime | Queries the server time of a cursor. |
| GetLogsV2 | GetLogsV2 | Queries raw logs from a specified Logstore in a project. The response contains raw logs from a specified time range and is compressed for 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 logs to a Logstore. |
| GetLogStoreMeteringMode | GetLogStoreMeteringMode | Queries the billing mode of a Logstore. |
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 settings of an existing Metricstore. Metricstores are used to store metric data. |
| 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 | Queries 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. |
Logtail 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 | Queries 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 | Queries a list of Logtail pipeline configurations that meet the specified conditions. |
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 a list of 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 | Sends heartbeats to a server from a consumer. |
| 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. |
| ListAlerts | ListAlerts | Returns a list of alert rules in a specified project. |
Data Import
| API | Title | Description |
| CreateOSSIngestion | CreateOSSIngestion | Creates an Object Storage Service (OSS) data import job in a project. |
| DeleteOSSIngestion | DeleteOSSIngestion | Deletes an OSS import task. |
| UpdateOSSIngestion | UpdateOSSIngestion | Updates the specified OSS import job. |
| StartOSSIngestion | StartOSSIngestion | Starts a specified OSS import task. |
| StopOSSIngestion | StopOSSIngestion | Stops the specified OSS import task. |
| GetOSSIngestion | GetOSSIngestion | Retrieves a specified OSS import job. |
| ListOSSIngestions | ListOSSIngestions | Lists all OSS import tasks in a specified Project. |
Log Export
| API | Title | Description |
| CreateOSSExport | CreateOSSExport | Ships logs from a Simple Log Service Logstore to an Object Storage Service (OSS) bucket. |
| CreateOSSHDFSExport | CreateOSSHDFSExport | Creates an OSS-HDFS data shipping job in a 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 | Lists the OSS data shipping jobs in a specified project. |
| GetOSSHDFSExport | GetOSSHDFSExport | Retrieves a specified OSS-HDFS delivery job. |
| ListOSSHDFSExports | ListOSSHDFSExports | Lists the OSS-HDFS exports in a specified project. |
Data Transformation
| API | Title | Description |
| CreateETL | CreateETL | Creates a data transformation job in a 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, Load (ETL) task. |
Scheduled SQL
| API | Title | Description |
| CreateScheduledSQL | CreateScheduledSQL | Creates a Scheduled SQL task 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 SQL jobs in a specified project. |
| GetScheduledSQL | GetScheduledSQL | Retrieves a specific scheduled SQL task. |
Log Download
| API | Title | Description |
| CreateDownloadJob | CreateDownloadJob | Creates a log download job 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. |
Ingest processor
| API | Title | Description |
| PutIngestProcessor | PutIngestProcessor | Creates or modifies an ingest processor. |
| GetIngestProcessor | GetIngestProcessor | Queries the details of an ingest processor. |
| ListIngestProcessors | ListIngestProcessors | Queries a list of ingest processors that meet specific conditions. |
| DeleteIngestProcessor | DeleteIngestProcessor | Deletes an ingest processor. |
| UpdateLogStoreProcessor | UpdateLogStoreProcessor | Updates the write processor for a LogStore. |
| UpdateMetricStoreProcessor | UpdateMetricStoreProcessor | Updates the ingest processor that is associated with a Metricstore. |
Consumer Processor
| API | Title | Description |
| PutConsumeProcessor | PutConsumeProcessor | Creates or updates a consumption processor. |
| GetConsumeProcessor | GetConsumeProcessor | Query the details of a consumer processor |
| ListConsumeProcessors | ListConsumeProcessors | Queries a list of consumption processors that meet specific conditions. |
| DeleteConsumeProcessor | DeleteConsumeProcessor | Deletes a consume processor. |
Machine Learning
| API | Title | Description |
| ListAiTools | ListAiTools | Retrieves a list of AI tools. |
| CallAiTools | CallAiTools | Invokes an AI tool. |
| CreateAnnotationLabel | CreateAnnotationLabel | Creates a tag table. |
| PutAnnotationData | PutAnnotationData | Adds data to a dataset for storage. |
| CreateAnnotationDataSet | CreateAnnotationDataSet | Creates a dataset. |
| DeleteAnnotationLabel | DeleteAnnotationLabel | Deletes an annotation label. You can delete only custom labels. |
| DeleteAnnotationData | DeleteAnnotationData | Removes data from a dataset. |
| DeleteAnnotationDataSet | DeleteAnnotationDataSet | Deletes a dataset. |
| UpdateAnnotationLabel | UpdateAnnotationLabel | Updates a tag table. |
| UpdateAnnotationDataSet | UpdateAnnotationDataSet | Updates a dataset. |
| GetAnnotationLabel | GetAnnotationLabel | Queries a tag table by using a label ID. |
| ListAnnotationLabels | ListAnnotationLabels | Queries a list of tag tables. |
| GetAnnotationData | GetAnnotationData | Queries data in datasets based on the unique identifier of the data. |
| ListAnnotationData | ListAnnotationData | Queries data in datasets. |
| GetAnnotationDataSet | GetAnnotationDataSet | Queries a dataset. |
| ListAnnotationDataSets | ListAnnotationDataSets | Queries a list of datasets. |
| GetMLServiceResults | GetMLServiceResults | Simple Log Service (SLS) provides intelligent analysis for data such as logs, metrics, and traces. You can call models to obtain analysis results directly. The analysis includes Named Entity Recognition (NER) for log data, anomaly detection for time series data, and root cause analysis of spans for high-latency traces. |
Resource
| API | Title | Description |
| TagResources | TagResources | Creates and adds tags to a resource. You can add tags only to projects. |
| 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. |
| 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. |
Authorization Policy
| API | Title | Description |
| PutProjectPolicy | PutProjectPolicy | Creates a project policy. |
| DeleteProjectPolicy | DeleteProjectPolicy | Deletes a project policy. |
| GetProjectPolicy | GetProjectPolicy | Queries a project policy. |
Resource Group
| API | Title | Description |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group to which a resource belongs. |
Collection Rules Of Cloud Services
| 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 the Standard SQL feature to analyze a large amount of data, the logs within the specified time range cannot be fully scanned in a single query request. In this case, the returned results may not contain all matched data. You can increase the number of shards to improve data read and write capabilities. However, this method takes effect only for incremental data. You can enable the Dedicated SQL feature to increase computing resources and the amount of data that can be analyzed in a single query request. |
| 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 cause incomplete results. Although adding shards improves read and write performance, this applies only to new data. To analyze more data in a single query, enable Dedicated SQL and add more computing resources. |
| GetSqlInstance | GetSqlInstance | Queries 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 Opening
| 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. |
| GetSlsService | GetSlsService | Call the GetSlsService operation to retrieve the activation status of Simple Log Service. The endpoint must be China (Shanghai) or Singapore. |
Embed Console Pages
| API | Title | Description |
| 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. |
| RefreshToken | RefreshToken | Refreshes an access token using a ticket. The access token is used to call console API operations. |
Others
| API | Title | Description |
| DescribeRegions | DescribeRegions | Queries supported regions. |
| 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. |
| CreateS3Ingestion | CreateS3Ingestion | Creates a job to import files from Amazon S3. |
| DeleteS3Ingestion | DeleteS3Ingestion | Deletes an S3 import task. |
| GetS3Ingestion | GetS3Ingestion | Retrieves the information about an S3 import task. |