com.aliyun.openservices.sls

类 SLSClient

java.lang.Object

com.aliyun.openservices.sls.SLSClient

所有已实现的接口:

SimpleLogService

public class SLSClient
extends Object
implements SimpleLogService

SlsClient class is the main class in the sdk, it implements the interfaces defined in SimpleLogService. It can be used to send request to the sls server to put/get data.

作者:

sls_dev

构造器概要

构造器

构造器和说明
SLSClient(String endpoint, String accessId, String accessKey) Construct the sls client with accessId, accessKey and server address, all other parameters will be set to default value
SLSClient(String endpoint, String accessId, String accessKey, String SourceIp) Construct the sls client with accessId, accessKey , server address and client ip address, all other parameters will be set to default value
SLSClient(String endpoint, String accessId, String accessKey, String sourceIp, boolean compressFlag) Construct sls client with full parameters

方法概要

限定符和类型	方法和说明
GetHistogramsResponse	GetHistograms(GetHistogramsRequest request) Get The log status(histogram info) from sls server which match input parameters.
GetHistogramsResponse	GetHistograms(String project, String logStore, int from, int to, String topic, String query) Get The log status(histogram info) from sls server which match input parameters.
GetLogsResponse	GetLogs(GetLogsRequest request) Get The sub set of logs data from sls server which match input parameters.
GetLogsResponse	GetLogs(String project, String logStore, int from, int to, String topic, String query) Get The sub set of logs data from sls server which match input parameters.
GetLogsResponse	GetLogs(String project, String logStore, int from, int to, String topic, String query, int line, int offset, boolean reverse) Get The sub set of logs data from sls server which match input parameters.
ListLogStoresResponse	ListLogStores(ListLogStoresRequest request) Get all the logstore of a project
ListLogStoresResponse	ListLogStores(String project) Get all the logstore for the user
ListTopicsResponse	ListTopics(ListTopicsRequest request) Get the topics in the logtstore
ListTopicsResponse	ListTopics(String project, String logStore, String token, int line) Get the topics in the logtstore
PutLogsResponse	PutLogs(PutLogsRequest request) Send Data to sls server
PutLogsResponse	PutLogs(String project, String logStore, String topic, List<LogItem> logItems, String source) Send Data to sls server

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SLSClient

public SLSClient(String endpoint,
                 String accessId,
                 String accessKey)

Construct the sls client with accessId, accessKey and server address, all other parameters will be set to default value

参数:

endpoint - the sls server address

accessId - aliyun accessId

accessKey - aliyun accessKey

抛出:

NullPointerException - if the input parameter is null

IllegalArgumentException - if the input parameter is empty

SLSClient

public SLSClient(String endpoint,
                 String accessId,
                 String accessKey,
                 String SourceIp)

Construct the sls client with accessId, accessKey , server address and client ip address, all other parameters will be set to default value

参数:

endpoint - the sls server address

accessId - aliyun accessId

accessKey - aliyun accessKey

SourceIp - client ip address

抛出:

NullPointerException - if the input parameter is null

IllegalArgumentException - if the input parameter is empty

SLSClient

public SLSClient(String endpoint,
                 String accessId,
                 String accessKey,
                 String sourceIp,
                 boolean compressFlag)

Construct sls client with full parameters

参数:

endpoint - the sls server address

accessId - aliyun accessId

accessKey - aliyun accessKey

sourceIp - client ip address

compressFlag - a flag to determine if the send data will compressed , default is true ( data compressed)

抛出:

NullPointerException - if the input parameter is null

IllegalArgumentException - if the input parameter is empty

方法详细资料

GetHistograms

public GetHistogramsResponse GetHistograms(String project,
                                           String logStore,
                                           int from,
                                           int to,
                                           String topic,
                                           String query)
                                    throws SlsException

从接口复制的说明: SimpleLogService

Get The log status(histogram info) from sls server which match input parameters. All the logs with logstore and topic in [from, to) which contain the keys in query are the matched data.

指定者:

GetHistograms 在接口中 SimpleLogService

参数:

project - the project name

logStore - the result data logstore

from - the begin time of the result data to get

to - the end time of the result data to get

topic - the result data topic

query - If the query is not empty, it will return the logs contain the keys in query, if "all_hit" is contained in the query, only the logs contains all the keys in query are matched logs, other wise logs contain any key in query are matched logs.

返回:

the histogram response of the matched logs

抛出:

SlsException - if any error happen when get the data from sls sever

GetHistograms

public GetHistogramsResponse GetHistograms(GetHistogramsRequest request)
                                    throws SlsException

从接口复制的说明: SimpleLogService

Get The log status(histogram info) from sls server which match input parameters. All the logs with logstore and topic in [from, to) which contain the keys in query are the matched data.

指定者:

GetHistograms 在接口中 SimpleLogService

参数:

request - the get histogram request

返回:

the histogram response of the matched logs

抛出:

SlsException - if any error happen when get the data from sls sever

PutLogs

public PutLogsResponse PutLogs(String project,
                               String logStore,
                               String topic,
                               List<LogItem> logItems,
                               String source)
                        throws SlsException

从接口复制的说明: SimpleLogService

Send Data to sls server

指定者:

PutLogs 在接口中 SimpleLogService

参数:

project - the project name

logStore - the log store where the source data should be put

topic - source data topic

logItems - the log data to send

source - the source of the data, if the source is empty, it will be reset to the host ip

返回:

The put logs response

抛出:

SlsException - if any error happen when send data to the server

PutLogs

public PutLogsResponse PutLogs(PutLogsRequest request)
                        throws SlsException

从接口复制的说明: SimpleLogService

Send Data to sls server

指定者:

PutLogs 在接口中 SimpleLogService

参数:

request - the put log request

返回:

The put logs response

抛出:

SlsException - if any error happen when send data to the server

GetLogs

public GetLogsResponse GetLogs(String project,
                               String logStore,
                               int from,
                               int to,
                               String topic,
                               String query)
                        throws SlsException

从接口复制的说明: SimpleLogService

Get The sub set of logs data from sls server which match input parameters. By default, it will return at most 20 lines

指定者:

GetLogs 在接口中 SimpleLogService

参数:

project - the project name

logStore - the result data logstore

from - the begin time of the result data to get

to - the end time of the result data to get

topic - the result data topic

query - If the query is not empty, it will return the logs contain the keys in query, if "all_hit" is contained in the query, only the logs contains all the keys in query are matched logs, other wise logs contain any key in query are matched logs

返回:

a response contains a sub set of the logs matched the input parameters

抛出:

SlsException - if any error happen when get the data from sls sever

GetLogs

public GetLogsResponse GetLogs(String project,
                               String logStore,
                               int from,
                               int to,
                               String topic,
                               String query,
                               int line,
                               int offset,
                               boolean reverse)
                        throws SlsException

从接口复制的说明: SimpleLogService

Get The sub set of logs data from sls server which match input parameters. All the data with logstore and topic in [from, to) which contain the keys in query are the matched data.

指定者:

GetLogs 在接口中 SimpleLogService

参数:

project - the project name

logStore - the result data logstore

from - the begin time of the result data to get

to - the end time of the result data to get

topic - the result data topic

query - If the query is not empty, it will return the logs contain the keys in query, if "all_hit" is contained in the query, only the logs contains all the keys in query are matched logs, other wise logs contain any key in query are matched logs.

line - how many lines to get, the max lines is decided by the sls backend server

offset - the start log index in all the matched logs.

reverse - a flag to determine the return data order, if reverse is set to false, the return logs is ascending order by time, other wise, it's descending order

返回:

a response contains a sub set of the logs matched the input parameters

抛出:

SlsException - if any error happen when get the data from sls sever

GetLogs

public GetLogsResponse GetLogs(GetLogsRequest request)
                        throws SlsException

从接口复制的说明: SimpleLogService

Get The sub set of logs data from sls server which match input parameters.

指定者:

GetLogs 在接口中 SimpleLogService

参数:

request - the get logs request

返回:

a response contains a sub set of the logs matched the input parameters

抛出:

SlsException - if any error happen when get the data from sls sever

ListLogStores

public ListLogStoresResponse ListLogStores(String project)
                                    throws SlsException

从接口复制的说明: SimpleLogService

Get all the logstore for the user

指定者:

ListLogStores 在接口中 SimpleLogService

参数:

project - the project name

返回:

the user's logstore response

抛出:

SlsException - if any error happen when get the data from sls sever

ListLogStores

public ListLogStoresResponse ListLogStores(ListLogStoresRequest request)
                                    throws SlsException

从接口复制的说明: SimpleLogService

Get all the logstore of a project

指定者:

ListLogStores 在接口中 SimpleLogService

参数:

request - the list log store request

返回:

the user's logstore response

抛出:

SlsException - if any error happen when get the data from sls sever

ListTopics

public ListTopicsResponse ListTopics(String project,
                                     String logStore,
                                     String token,
                                     int line)
                              throws SlsException

从接口复制的说明: SimpleLogService

Get the topics in the logtstore

指定者:

ListTopics 在接口中 SimpleLogService

参数:

project - the project name

logStore - where the topic belongs to

token - all the returned topics are equal or larger than the given token according to topics' lexicographical order

line - the topic number from sls server

返回:

the log store's topics response

抛出:

SlsException - if any error happen when get the data from sls sever

ListTopics

public ListTopicsResponse ListTopics(ListTopicsRequest request)
                              throws SlsException

从接口复制的说明: SimpleLogService

Get the topics in the logtstore

指定者:

ListTopics 在接口中 SimpleLogService

参数:

request - the list topics request

返回:

the log store's topics response

抛出:

SlsException - if any error happen when get the data from sls sever