API Overview
Last updated: 2024-12-12 16:10:36
API Overview
Last updated: 2024-12-12 16:10:36
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 |
Uploads a log to a specified log topic | |
Gets and downloads a log cursor under a specified log topic | |
Searches for a log by the specified condition | |
Downloads a log with the cursor |
Logset management
API | Description |
Creates a logset and returns the new logset ID | |
Gets the logset information | |
Gets the list of logsets | |
Modifies a logset | |
Deletes a logset |
Log topic management
API | Description |
Creates a log topic and returns the new log topic ID | |
Gets the log topic information | |
Gets the information of the machine group bound to a log topic | |
Gets the list of log topics | |
Modifies a log topic | |
Sets the machine group bound to a log topic | |
Deletes a log topic | |
Gets the list of topic partitions | |
Merges a topic partition in read/write state | |
Splits a topic partition in read/write state |
Shipping task management
API | Description |
Creates a shipping task | |
Gets the details of the specified shipping policy | |
Gets the detailed list of shipping policies under the specified log topic | |
Gets the list of shipping tasks | |
Modifies an existing shipping task | |
Retries a failed shipping task | |
Deletes the shipping configuration |
Machine group management
API | Description |
Creates a machine group and returns the new machine group ID | |
Gets the machine group information | |
Gets the status of a machine under the specified machine group | |
Gets the list of machine groups | |
Modifies a machine group | |
Deletes a machine group |
Consumption management
API | Description |
Creates a consumer group | |
Gets the consumption cursor | |
Gets the consumer group cursor | |
Consumes a log | |
Uploads consumer heartbeats | |
Gets the list of consumer groups of a log topic | |
Modifies a consumer group | |
Modifies the consumer group cursor | |
Deletes a consumer group |
Index management
API | Description |
Gets the details of the specified index policy | |
Modifies an existing index task |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback