- Release Notes and Announcements
- User Guide
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Resource Management
- Permission Management
- Log Collection
- Collection Overview
- Collecting Logs in Self-Built Kubernetes Cluster
- Collecting Syslog
- Collection by LogListener
- Collecting Text Log
- Uploading Log over Kafka
- Uploading Logs via Anonymous Write
- Uploading Logs via Logback Appender
- Uploading Logs via Log4j Appender
- Uploading Log via SDK
- Uploading Log via API
- Importing Data
- Tencent Cloud Service Log Access
- Metric Collection
- Log Storage
- Metric Storage
- Search and Analysis (Log Topic)
- Syntax and Rules
- Statistical Analysis (SQL)
- Quick Analysis
- SQL Syntax
- SQL Functions
- String Function
- Date and Time Functions
- IP Geographic Function
- URL Function
- Mathematical Calculation Functions
- Mathematical Statistical Function
- General Aggregate Function
- Geospatial Function
- Binary String Function
- Estimation Function
- Type Conversion Function
- Logical Function
- Operators
- Bitwise Operation
- Regular Expression Function
- Lambda Function
- Conditional Expressions
- Array Functions
- Interval-Valued Comparison and Periodicity-Valued Comparison Functions
- JSON Functions
- Window Functions
- Sampling Analysis
- Configuring Indexes
- Reindexing
- Context Search and Analysis
- Downloading Log
- Search and Analysis (Metric Topic)
- Dashboard
- Data Processing documents
- Data Processing
- Creating Processing Task
- Viewing Data Processing Details
- Data Processing Functions
- Function Overview
- Key-Value Extraction Functions
- Enrichment Functions
- Flow Control
- Row Processing Functions
- Field Processing Functions
- Value Structuring Functions
- Regular Expression Processing Functions
- Time Value Processing Functions
- String Processing Functions
- Type Conversion Functions
- Logical and Mathematical Functions
- Encoding and Decoding Functions
- IP Parsing Functions
- Processing Cases
- Scheduled SQL Analysis
- SCF
- Data Processing
- Shipping and Consumption
- Monitoring Alarm
- Historical Documentation
- Practical Tutorial
- Developer Guide
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Topic Management APIs
- Log Set Management APIs
- Index APIs
- Topic Partition APIs
- Machine Group APIs
- Collection Configuration APIs
- Log APIs
- Metric APIs
- Alarm Policy APIs
- Data Processing APIs
- Kafka Protocol Consumption APIs
- CKafka Shipping Task APIs
- Kafka Data Subscription APIs
- COS Shipping Task APIs
- SCF Delivery Task APIs
- Scheduled SQL Analysis APIs
- COS Data Import Task APIs
- Data Types
- Error Codes
- FAQs
- CLS Service Level Agreement
- CLS Policy
- Contact Us
- Glossary
- Release Notes and Announcements
- User Guide
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Resource Management
- Permission Management
- Log Collection
- Collection Overview
- Collecting Logs in Self-Built Kubernetes Cluster
- Collecting Syslog
- Collection by LogListener
- Collecting Text Log
- Uploading Log over Kafka
- Uploading Logs via Anonymous Write
- Uploading Logs via Logback Appender
- Uploading Logs via Log4j Appender
- Uploading Log via SDK
- Uploading Log via API
- Importing Data
- Tencent Cloud Service Log Access
- Metric Collection
- Log Storage
- Metric Storage
- Search and Analysis (Log Topic)
- Syntax and Rules
- Statistical Analysis (SQL)
- Quick Analysis
- SQL Syntax
- SQL Functions
- String Function
- Date and Time Functions
- IP Geographic Function
- URL Function
- Mathematical Calculation Functions
- Mathematical Statistical Function
- General Aggregate Function
- Geospatial Function
- Binary String Function
- Estimation Function
- Type Conversion Function
- Logical Function
- Operators
- Bitwise Operation
- Regular Expression Function
- Lambda Function
- Conditional Expressions
- Array Functions
- Interval-Valued Comparison and Periodicity-Valued Comparison Functions
- JSON Functions
- Window Functions
- Sampling Analysis
- Configuring Indexes
- Reindexing
- Context Search and Analysis
- Downloading Log
- Search and Analysis (Metric Topic)
- Dashboard
- Data Processing documents
- Data Processing
- Creating Processing Task
- Viewing Data Processing Details
- Data Processing Functions
- Function Overview
- Key-Value Extraction Functions
- Enrichment Functions
- Flow Control
- Row Processing Functions
- Field Processing Functions
- Value Structuring Functions
- Regular Expression Processing Functions
- Time Value Processing Functions
- String Processing Functions
- Type Conversion Functions
- Logical and Mathematical Functions
- Encoding and Decoding Functions
- IP Parsing Functions
- Processing Cases
- Scheduled SQL Analysis
- SCF
- Data Processing
- Shipping and Consumption
- Monitoring Alarm
- Historical Documentation
- Practical Tutorial
- Developer Guide
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Topic Management APIs
- Log Set Management APIs
- Index APIs
- Topic Partition APIs
- Machine Group APIs
- Collection Configuration APIs
- Log APIs
- Metric APIs
- Alarm Policy APIs
- Data Processing APIs
- Kafka Protocol Consumption APIs
- CKafka Shipping Task APIs
- Kafka Data Subscription APIs
- COS Shipping Task APIs
- SCF Delivery Task APIs
- Scheduled SQL Analysis APIs
- COS Data Import Task APIs
- Data Types
- Error Codes
- FAQs
- CLS Service Level Agreement
- CLS Policy
- Contact Us
- Glossary
API Overview
Last updated: 2022-10-17 15:50:53
Note：
- CLS APIs in this document are legacy and not updated any more. They are not supported by new CLS features, so we strongly recommend you use CLS API 3.0.
- To create log topics or modify index configurations, use CLS API 3.0. To collect logs, use the SDK specially optimized for log collection.
Log management
| API | Description |
|---|---|
| Uploading a structured log | Uploads a log to a specified log topic |
| Getting a log cursor | Gets and downloads a log cursor under a specified log topic |
| Searching for a log | Searches for a log by the specified condition |
| Downloading a log | Downloads a log with the cursor |
Logset management
| API | Description |
|---|---|
| Creating a logset | Creates a logset and returns the new logset ID |
| Getting the logset information | Gets the logset information |
| Getting the list of logsets | Gets the list of logsets |
| Modifying a logset | Modifies a logset |
| Deleting a logset | Deletes a logset |
Log topic management
| API | Description |
|---|---|
| Creating a log topic | Creates a log topic and returns the new log topic ID |
| Getting the log topic information | Gets the log topic information |
| Getting the machine group bound to a log topic | Gets the information of the machine group bound to a log topic |
| Getting the list of log topics | Gets the list of log topics |
| Modifying a log topic | Modifies a log topic |
| Setting the machine group bound to a log topic | Sets the machine group bound to a log topic |
| Deleting a log topic | Deletes a log topic |
| Getting the list of topic partitions | Gets the list of topic partitions |
| Merging a topic partition | Merges a topic partition in read/write state |
| Splitting a topic partition | Splits a topic partition in read/write state |
Shipping task management
| API | Description |
|---|---|
| Creating a shipping task | Creates a shipping task |
| Getting the shipping configuration | Gets the details of the specified shipping policy |
| Getting the list of log topic shipping policies | Gets the detailed list of shipping policies under the specified log topic |
| Getting the list of shipping tasks | Gets the list of shipping tasks |
| Modifying a shipping task | Modifies an existing shipping task |
| Retrying a failed task | Retries a failed shipping task |
| Deleting the shipping configuration | Deletes the shipping configuration |
Machine group management
| API | Description |
|---|---|
| Creating a machine group | Creates a machine group and returns the new machine group ID |
| Getting the machine group information | Gets the machine group information |
| Getting the machine status | Gets the status of a machine under the specified machine group |
| Getting the list of machine group | Gets the list of machine groups |
| Modifying a machine group | Modifies a machine group |
| Deleting a machine group | Deletes a machine group |
Consumption management
| API | Description |
|---|---|
| Creating a consumer group | Creates a consumer group |
| Getting the consumption cursor | Gets the consumption cursor |
| Getting the consumer group cursor | Gets the consumer group cursor |
| Consuming data | Consumes a log |
| Uploading consumer heartbeats | Uploads consumer heartbeats |
| Getting the list of consumer groups | Gets the list of consumer groups of a log topic |
| Modifying a consumer group | Modifies a consumer group |
| Modifying the consumer group cursor | Modifies the consumer group cursor |
| Deleting a consumer group | Deletes a consumer group |
Index management
| API | Description |
|---|---|
| Getting the index information | Gets the details of the specified index policy |
| Modifying an index task | Modifies an existing index task |
Yes
No
Was this page helpful?