This product(
Sls/2020-12-30) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
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. |
| 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. |
| GetProject | GetProject | Queries the details of a project. |
| ListProject | ListProject | Queries the projects that meet 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. |
| 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 the raw log data in a Logstore of a project. The returned result contains the raw log data within a specific time range. The returned result is compressed before transmission. |
| PullLogs | PullLogs | Queries logs based on the specified cursors. You can call this operation to obtain raw logs. To query and analyze logs, you can call the GetLogsV2 operation. |
| PutLogs | PutLogs | Sends logs to Simple Log Service. |
| 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 metric data. |
| 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. |
| 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. |
External Storage
| API | Title | Description |
|---|---|---|
| CreateOssExternalStore | CreateOssExternalStore | Creates an Object Storage Service (OSS) external store. |
| CreateRdsExternalStore | CreateRdsExternalStore | Creates an ApsaraDB RDS external store. |
| DeleteExternalStore | DeleteExternalStore | Deletes an external storage configuration. |
| UpdateRdsExternalStore | UpdateRdsExternalStore | Updates an ApsaraDB RDS external store. |
| UpdateOssExternalStore | UpdateOssExternalStore | Updates an Object Storage Service (OSS) external store. |
| GetExternalStore | GetExternalStore | Queries the details of an external store. |
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 | Queries a list of alert rules in a project. |
Data Import
| API | Title | Description |
|---|---|---|
| ListOSSIngestions | ListOSSIngestions | Queries a list of Object Storage Service (OSS) data import jobs in a 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. |
| 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 | Queries the information about an Object Storage Service (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. |
| GetOSSHDFSExport | GetOSSHDFSExport | Queries the information about an OSS-HDFS data shipping job. |
Scheduled SQL
| API | Title | Description |
|---|---|---|
| EnableScheduledSQL | EnableScheduledSQL | Enables the Scheduled SQL feature. |
| ListScheduledSQLs | ListScheduledSQLs | Queries a list of Scheduled SQL jobs in a project. |
Machine Learning
| API | Title | Description |
|---|---|---|
| PutAnnotationData | PutAnnotationData | Adds data to a dataset for storage. |
| CreateAnnotationDataSet | CreateAnnotationDataSet | Creates a dataset. |
| DeleteAnnotationLabel | DeleteAnnotationLabel | Deletes a tag table. |
| 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. |
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 |
|---|---|---|
| DeleteCollectionPolicy | DeleteCollectionPolicy | Deletes a log collection policy from a cloud service. |
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. |
Embed Console Pages
| API | Title | Description |
|---|---|---|
| CreateTicket | CreateTicket | Creates a ticket to enable logon-free access to the Simple Log Service console or embed console pages into a third-party system. |
| RefreshToken | RefreshToken | Refreshes an access token by using a ticket to access the Simple Log Service console. |