tencent cloud

Cloud Log Service

Release Notes and Announcements
Release Notes
Announcements
User Guide
Product Introduction
Overview
Features
Available Regions
Limits
Concepts
Service Regions and Service Providers
Purchase Guide
Billing Overview
Product Pricing
Pay-as-You-Go
Billing
Cleaning up CLS resources
Cost Optimization
FAQs
Getting Started
Getting Started in 1 Minute
Getting Started Guide
Quickly Trying out CLS with Demo
Operation Guide
Resource Management
Permission Management
Log Collection
Metric Collection
Log Storage
Metric Storage
Search and Analysis (Log Topic)
Search and Analysis (Metric Topic)
Dashboard
Data Processing documents
Shipping and Consumption
Monitoring Alarm
Cloud Insight
Independent DataSight console
Historical Documentation
Practical Tutorial
Log Collection
Search and Analysis
Dashboard
Monitoring Alarm
Shipping and Consumption
Cost Optimization
Developer Guide
Embedding CLS Console
CLS Connection to Grafana
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
Health Check
Collection
Log Search
Others
CLS Service Level Agreement
CLS Policy
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentationCloud Log ServiceAPI DocumentationAPI Category

API Category

PDF
Focus Mode
Font Size
Last updated: 2025-11-13 20:46:59

Topic Management APIs

API Name Feature Frequency Limit (maximum requests per second)
DeleteTopic Deletes a log topic 20
DescribeTopics Gets the list of log topics 50
CreateTopic Creates a log topic 100
ModifyTopic Modifies a log topic 20

Log Set Management APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateLogset Creates a logset 20
DeleteLogset Deletes a logset 20
ModifyLogset Modifies a logset 20
DescribeLogsets Gets the list of logsets 100

Index APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateIndex Creates an index 20
DeleteIndex Deletes index configuration 20
ModifyIndex Modifies index 20
DescribeIndex Gets index configuration information 20

Topic Partition APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribePartitions Gets the list of partitions 20
SplitPartition Splits a topic partition 20
MergePartition Merges partitions 20

Machine Group APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateMachineGroup Creates a machine group 20
DeleteMachineGroup Deletes a machine group 20
ModifyMachineGroup Modifies a machine group 20
DescribeMachineGroups Gets the list of machine groups 20
DescribeMachines Gets machine status 20
AddMachineGroupInfo Adds machine group information 20
DeleteMachineGroupInfo Deletes machine group information 20

Collection Configuration APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateConfig Creates collection rule configuration 30
DeleteConfig Deletes collection rule configuration 20
ModifyConfig Modifies collection rule configuration 20
DescribeConfigs Gets collection rule configuration 20
ApplyConfigToMachineGroup Applies collection configuration to a specified machine group 20
DeleteConfigFromMachineGroup Deletes collection configuration applied to a machine group 20
DescribeConfigMachineGroups Gets the machine group bound to collection rule configuration 1000
DescribeMachineGroupConfigs Gets collection rule configuration bound to a machine group 20

Log APIs

API Name Feature Frequency Limit (maximum requests per second)
SearchLog Searches and analyzes logs 10000
DescribeLogHistogram Gets a log count histogram 10000
DescribeLogContext Searches in context 20
UploadLog Uploads logs 100000
CreateExport Creates a log download task 20
DeleteExport Deletes a log download task 20
DescribeExports Gets the list of log download tasks 20

Metric APIs

API Name Feature Frequency Limit (maximum requests per second)
QueryMetric Queries a metric (latest value query) 20
QueryRangeMetric Queries metrics (range query) 20

Alarm Policy APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateAlarm Creates alarm policy 20
DeleteAlarm Deletes an alarm policy 20
ModifyAlarm Modifies an alarm policy 20
DescribeAlarms Gets the list of alarm policies 30
CreateAlarmNotice Creates a notification group 20
CreateAlarmShield Creates an alarm blocking rule 20
DeleteAlarmShield Deletes an alarm blocking rule 20
ModifyAlarmShield Modifies alarm blocking rules 20
DeleteAlarmNotice Deletes a notification group 20
ModifyAlarmNotice Modifies a notification group 20
DescribeAlarmNotices Gets the notification group list 20
DescribeAlertRecordHistory Gets alarm records 40
GetAlarmLog Accesses alarm policy execution details 30
DescribeAlarmShields Accesses alarm blocking configuration rules 20

Data Processing APIs

API Name Feature Frequency Limit (maximum requests per second)
DeleteDataTransform Deletes a data processing task 20
CheckFunction Verifies the syntax 20
CreateDataTransform Creates a data processing task 20
DescribeDataTransformInfo Gets the basic information of data processing tasks 20
ModifyDataTransform Modifies a data processing task 20

Kafka Protocol Consumption APIs

API Name Feature Frequency Limit (maximum requests per second)
CloseKafkaConsumer Disables Kafka consumption 20
ModifyKafkaConsumer Modifies Kafka protocol consumption information 20
OpenKafkaConsumer Enables Kafka consumption 20
DescribeKafkaConsumer Accesses Kafka protocol consumption information 20

CKafka Shipping Task APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateConsumer Creates a CKafka delivery task 20
DeleteConsumer Deletes a shipping task 20
ModifyConsumer Modifies a CKafka delivery task 20
DescribeConsumer Queries a shipping task 20

Kafka Data Subscription APIs

API Name Feature Frequency Limit (maximum requests per second)
DescribeKafkaRecharges Gets the list of Kafka data subscription tasks 20
CreateKafkaRecharge Creates a Kafka data subscription task 20
ModifyKafkaRecharge Modifies a Kafka data subscription task 20
DeleteKafkaRecharge Deletes a Kafka data subscription task 20
PreviewKafkaRecharge Previews the logs of Kafka data subscription tasks 20
CheckRechargeKafkaServer Checks the connectivity of the Kafka service cluster 20

COS Shipping Task APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateShipper Creates a task to ship to COS 20
DeleteShipper Deletes a COS shipping task 20
DescribeShipperTasks Gets the list of shipping tasks 20
DescribeShippers Gets the configuration of the task shipped to COS 20
ModifyShipper Modifies a COS shipping task 20
RetryShipperTask Retries a failed shipping task 20

SCF Delivery Task APIs

API Name Feature Frequency Limit (maximum requests per second)
CreateDeliverCloudFunction Creates a delivery SCF task 20

Scheduled SQL Analysis APIs

API Name Feature Frequency Limit (maximum requests per second)
DeleteScheduledSql Deletes a scheduled SQL analysis task 20
DescribeScheduledSqlInfo Accesses the scheduled SQL analysis task list 20
CreateScheduledSql Creates a scheduled SQL analysis task 20
ModifyScheduledSql Modifies a scheduled SQL analysis task 20

COS Data Import Task APIs

API Name Feature Frequency Limit (maximum requests per second)
SearchCosRechargeInfo Previews COS import information 20
CreateCosRecharge Creates a COS import task 20
ModifyCosRecharge Modifies a COS import task 20
DescribeCosRecharges Gets COS import configuration 20
Previous Topic: IntroductionNext Topic: Request Structure

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback