API Overview

Last updated: 2020-05-21 14:20:21

PDF

Log Management

API Name Feature Description
Uploading structured log Uploads log to specified log topic
Getting log download cursor Gets and downloads log cursor under specified log topic
Searching for log Searches for log content by specified criteria
Downloading logs Downloads logs by using cursor

Logset Management

API Name Feature Description
Creating logset Creates logset and returns its ID
Getting logset information Gets logset information
Getting logset list Gets logset list
Modifying logset Modifies logset
Deleting logset Deletes logset

Log Topic Management

API Name Feature Description
Creating log topic Creates log topic and returns its ID
Getting log topic information Gets log topic information
Getting server group bound to log topic Gets the information of server group bound to log topic
Getting log topic list Gets log topic list
Modifying log topic Modifies log topic
Setting server group bound to log topic Sets server group information bound to log topic
Delete log topic Deletes log topic
Getting topic partition list Gets topic partition list
Merging topic partition Merges topic partition in read/write state
Splitting topic partition Splits topic partition in read/write state

Shipping Task Management

API Name Feature Description
Creating shipping task Creates shipping task
Getting shipping configuration Getting the detailed information of specified shipping policy
Getting log topic shipping list Gets the detailed list of shipping policies of specified log topic
Getting shipping task list Gets shipping task list
Modifying shipping task Modifies shipping task
Retrying failed task Retries failed task
Deleting shipping configuration Deletes shipping configuration

Server Group Management

API Name Feature Description
Creating server group Creates server group and returns its ID
Getting server group information Gets server group information
Getting server status Gets server status in specified server group
Getting server group list Gets server group information list
Modifying server group Modifies server group
Deleting server group Deletes server group

Consumption Management

API Name Feature Description
Creating consumer group Creates consumer group
Getting consumption cursor Gets consumption cursor
Getting consumer group cursor Gets consumer group cursor
Consuming data Consumes log
Uploading consumer heartbeats Uploads consumer heartbeats
Getting consumer group list Gets the consumer group list of log topic
Modifying consumer group Modifies consumer group
Modifying consumer group cursor Modifies consumer group cursor
Deleting consumer group Deletes consumer group

Index Management

API Name Feature Description
Getting index information Gets the detailed information of specified index policy
Modifying index task Modifies existing index task