Client (Sls SDK for Java API Version 0.6.0 0.6.1 API)

java.lang.Object
- com.aliyun.openservices.log.Client

所有已实现的接口:

LogService
```
public class Client
extends Object
implements LogService
```
SlsClient class is the main class in the sdk, it implements the interfaces defined in LogService. It can be used to send request to the log service server to put/get data.

作者:

sls_dev

构造器概要

构造器
构造器和说明
`Client(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
`Client(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
`Client(String endpoint, String accessId, String accessKey, String sourceIp, boolean compressFlag)` Construct sls client with full parameters

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`ApplyConfigToMachineGroupResponse`	`ApplyConfigToMachineGroup(ApplyConfigToMachineGroupRequest request)` Apply config to machine group
`ApplyConfigToMachineGroupResponse`	`ApplyConfigToMachineGroup(String project, String groupName, String configName)` Apply config to machine group
`BatchGetLogResponse`	`BatchGetLog(BatchGetLogRequest request)` Batch get log
`BatchGetLogResponse`	`BatchGetLog(String project, String logStore, int shardId, int count, String cursor)` Batch get log
`void`	`ClearConsoleResources()`
`CreateConfigResponse`	`CreateConfig(CreateConfigRequest request)` Create logtail config
`CreateConfigResponse`	`CreateConfig(String project, Config config)` Create logtail config
`CreateConsumerGroupResponse`	`CreateConsumerGroup(CreateConsumerGroupRequest request)` create logstore consumer group
`CreateConsumerGroupResponse`	`CreateConsumerGroup(String project, String logStore, ConsumerGroup consumerGroup)` create logstore consumer group
`CreateIndexResponse`	`CreateIndex(CreateIndexRequest request)` create logstore index
`CreateIndexResponse`	`CreateIndex(String project, String logStore, Index index)` create logstore index
`CreateLogStoreResponse`	`CreateLogStore(CreateLogStoreRequest request)` create logstore
`CreateLogStoreResponse`	`CreateLogStore(String project, LogStore logStore)` create a logstore in a project
`CreateMachineGroupResponse`	`CreateMachineGroup(CreateMachineGroupRequest request)` Create machine group
`CreateMachineGroupResponse`	`CreateMachineGroup(String project, MachineGroup group)` Create machine group
`DeleteConfigResponse`	`DeleteConfig(DeleteConfigRequest request)` Delete logtail config
`DeleteConfigResponse`	`DeleteConfig(String project, String configName)` Delete logtail config
`DeleteConsumerGroupResponse`	`DeleteConsumerGroup(String project, String logStore, String consumerGroup)` delete logstore consumer group
`DeleteIndexResponse`	`DeleteIndex(DeleteIndexRequest request)` delete logstore index
`DeleteIndexResponse`	`DeleteIndex(String project, String logStore)` delete logstore index
`DeleteLogStoreResponse`	`DeleteLogStore(DeleteLogStoreRequest request)` Delete logstore
`DeleteLogStoreResponse`	`DeleteLogStore(String project, String logStoreName)` Delete the logstore
`DeleteMachineGroupResponse`	`DeleteMachineGroup(DeleteMachineGroupRequest request)` Delete machine group
`DeleteMachineGroupResponse`	`DeleteMachineGroup(String project, String groupName)` Delete machine group
`DeleteShardResponse`	`DeleteShard(DeleteShardRequest request)` delete a readonly shard in the logtstore
`DeleteShardResponse`	`DeleteShard(String prj, String logStore, int shardId)` delete a readonly shard in the logtstore
`protected void`	`ErrorCheck(net.sf.json.JSONObject object, String requestId)`
`protected Config`	`ExtractConfigFromResponse(net.sf.json.JSONObject dict, String requestId)`
`protected ArrayList<String>`	`ExtractConfigMachineGroupFromResponse(net.sf.json.JSONObject object, String requestId)`
`protected List<String>`	`ExtractConfigs(net.sf.json.JSONObject object, String requestId)`
`protected ArrayList<String>`	`ExtractConfigsFromResponse(net.sf.json.JSONObject object, String requestId)`
`protected MachineGroup`	`ExtractMachineGroupFromResponse(net.sf.json.JSONObject dict, String requestId)`
`protected List<String>`	`ExtractMachineGroups(net.sf.json.JSONObject object, String requestId)`
`protected ArrayList<Shard>`	`ExtractShards(net.sf.json.JSONArray array, String requestId)`
`protected void`	`ExtractShards(net.sf.json.JSONArray array, String requestId, ArrayList<Integer> shards)`
`GetAppliedConfigResponse`	`GetAppliedConfig(GetAppliedConfigsRequest request)` get applied config on a certain machine group
`GetAppliedConfigResponse`	`GetAppliedConfig(String project, String groupName)` get applied config on a certain machine group
`GetAppliedMachineGroupsResponse`	`GetAppliedMachineGroups(GetAppliedMachineGroupRequest request)` get applied machine group for a certain logtail config
`GetAppliedMachineGroupsResponse`	`GetAppliedMachineGroups(String project, String configName)` get applied machine group for a certain logtail config
`ConsumerGroupCheckPointResponse`	`GetCheckPoint(String project, String logStore, String consumerGroup)` get all of the shard checkpoints in the consumer group
`ConsumerGroupCheckPointResponse`	`GetCheckPoint(String project, String logStore, String consumerGroup, int shard)` get shard checkpoint in the consumer group
`GetConfigResponse`	`GetConfig(GetConfigRequest request)` Get logtail config
`GetConfigResponse`	`GetConfig(String project, String configName)` Get logtail config
`GetCursorResponse`	`GetCursor(GetCursorRequest request)` Get cursor from log service server
`GetCursorResponse`	`GetCursor(String project, String logStream, int shardId, Consts.CursorMode mode)` Get cursor from log service server
`GetCursorResponse`	`GetCursor(String project, String logStore, int shardId, Date fromTime)` Get cursor from log service server
`GetCursorResponse`	`GetCursor(String project, String logStore, int shardId, long fromTime)` Get cursor from log service server
`GetHistogramsResponse`	`GetHistograms(GetHistogramsRequest request)` Get The log status(histogram info) from log service 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 log service server which match input parameters.
`GetIndexResponse`	`GetIndex(GetIndexRequest request)` Get logstore index config
`GetIndexResponse`	`GetIndex(String project, String logStore)` Get logstore index config
`GetLogsResponse`	`GetLogs(GetLogsRequest request)` Get The sub set of logs data from log service 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 log service 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 log service server which match input parameters.
`GetLogStoreResponse`	`GetLogStore(GetLogStoreRequest request)` get the logstore config
`GetLogStoreResponse`	`GetLogStore(String project, String logStoreName)` Get the logstore config
`GetMachineGroupResponse`	`GetMachineGroup(GetMachineGroupRequest request)` Get machine group
`GetMachineGroupResponse`	`GetMachineGroup(String project, String groupName)` Get machine group
`String`	`getRealIpForConsole()`
`protected String`	`GetRequestId(Map<String,String> headers)`
`String`	`GetSecurityToken()`
`GetShipperTasksResponse`	`GetShipperTasks(String project, String logStore, String shipperName, int startTime, int endTime, String statusType, int offset, int size)` Get the tasks of a logstore shipper
`String`	`getUserAgent()`
`ConsumerGroupHeartBeatResponse`	`HeartBeat(String project, String logStore, String consumerGroup, String consumer, ArrayList<Integer> shards)` notify the server periodically to show that the consumer is still alive.
`boolean`	`isUseSSLForConsole()`
`ListConfigResponse`	`ListConfig(ListConfigRequest request)` List logtail configs
`ListConfigResponse`	`ListConfig(String project)` List logtail configs
`ListConfigResponse`	`ListConfig(String project, int offSet, int size)` List logtail configs
`ListConfigResponse`	`ListConfig(String project, String configName, int offSet, int size)` List logtail configs
`ListConsumerGroupResponse`	`ListConsumerGroup(String project, String logStore)` list logstore consumer groups
`ListLogStoresResponse`	`ListLogStores(ListLogStoresRequest request)` Get all the logstore of a project
`ListLogStoresResponse`	`ListLogStores(String project, int offset, int size, String logstoreName)` Get all the logstore for the user
`ListMachineGroupResponse`	`ListMachineGroup(ListMachineGroupRequest request)` List machine groups
`ListMachineGroupResponse`	`ListMachineGroup(String project)` List machine groups
`ListMachineGroupResponse`	`ListMachineGroup(String project, int offSet, int size)` List machine groups
`ListMachineGroupResponse`	`ListMachineGroup(String project, String groupName, int offSet, int size)` List machine groups
`ListMachinesResponse`	`ListMachines(String project, String machineGroup, int offset, int size)` List the real machines in the machine group
`ListShardResponse`	`ListShard(ListShardRequest request)` Get the shards in the logtstore
`ListShardResponse`	`ListShard(String prj, String logStore)` Get the shards in the logtstore
`ListShipperResponse`	`ListShipper(String project, String logStore)` List shipper of a logstore
`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
`ListShardResponse`	`MergeShards(MergeShardsRequest request)` merge two readwrite shards in the logtstore
`ListShardResponse`	`MergeShards(String prj, String logStore, int shardId)` merge two readwrite shards in the logtstore
`protected net.sf.json.JSONObject`	`ParserResponseMessage(ResponseMessage response, String requestId)`
`PutLogsResponse`	`PutLogs(PutLogsRequest request)` Send Data to log service server
`PutLogsResponse`	`PutLogs(String project, String logStore, String topic, List<LogItem> logItems, String source)` Send Data to log service server
`PutLogsResponse`	`PutLogs(String project, String logStore, String topic, List<LogItem> logItems, String source, String shardHash)`
`RemoveConfigFromMachineGroupResponse`	`RemoveConfigFromMachineGroup(RemoveConfigFromMachineGroupRequest request)` Remove config from machine group
`RemoveConfigFromMachineGroupResponse`	`RemoveConfigFromMachineGroup(String project, String groupName, String configName)` Remove config from machine group
`void`	`RemoveSecurityToken()`
`RetryShipperTasksResponse`	`RetryShipperTasks(String project, String logStore, String shipperName, List<String> taskList)` retry the failed tasks, for every time it can only retry 10 task
`protected ResponseMessage`	`SendData(String project, HttpMethod method, String resourceUri, Map<String,String> parameters, Map<String,String> headers, byte[] body)`
`void`	`setRealIpForConsole(String realIpForConsole)`
`void`	`SetSecurityToken(String securityToken)`
`void`	`setUserAgent(String userAgent)`
`void`	`setUseSSLForConsole(boolean useSSLForConsole)`
`ListShardResponse`	`SplitShard(SplitShardRequest request)` split a readwrite shard in the logtstore
`ListShardResponse`	`SplitShard(String prj, String logStore, int shardId, String midHash)` split a readwrite shard in the logtstore
`ConsumerGroupUpdateCheckPointResponse`	`UpdateCheckPoint(String project, String logStore, String consumerGroup, int shard, String checkpoint)` update consume checkpoint
`ConsumerGroupUpdateCheckPointResponse`	`UpdateCheckPoint(String project, String logStore, String consumerGroup, String consumer, int shard, String checkpoint)` update consume checkpoint
`protected ConsumerGroupUpdateCheckPointResponse`	`UpdateCheckPoint(String project, String logStore, String consumerGroup, String consumer, int shard, String checkpoint, boolean forceSuccess)`
`UpdateConfigResponse`	`UpdateConfig(String project, Config config)` Update logtail config
`UpdateConfigResponse`	`UpdateConfig(UpdateConfigRequest request)` Update logtail config
`UpdateConsumerGroupResponse`	`UpdateConsumerGroup(String project, String logStore, String consumerGroup, boolean inOrder)`
`UpdateConsumerGroupResponse`	`UpdateConsumerGroup(String project, String logStore, String consumerGroup, boolean inOrder, int timeoutInSec)` update consumer group
`protected UpdateConsumerGroupResponse`	`UpdateConsumerGroup(String project, String logStore, String consumerGroup, Boolean inOrder, Integer timeoutInSec)`
`UpdateConsumerGroupResponse`	`UpdateConsumerGroup(String project, String logStore, String consumerGroup, int timeoutInSec)` update consumer group
`UpdateIndexResponse`	`UpdateIndex(String project, String logStore, Index index)` Update logstore index config
`UpdateIndexResponse`	`UpdateIndex(UpdateIndexRequest request)` update logstore index config
`UpdateLogStoreResponse`	`UpdateLogStore(String project, LogStore logStore)` Update log store config
`UpdateLogStoreResponse`	`UpdateLogStore(UpdateLogStoreRequest request)` Update logstore config
`UpdateMachineGroupResponse`	`UpdateMachineGroup(String project, MachineGroup group)` Update machine group
`UpdateMachineGroupResponse`	`UpdateMachineGroup(UpdateMachineGroupRequest request)` Update machine group

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Client
```
public Client(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 log service server address
    
    accessId - aliyun accessId
    
    accessKey - aliyun accessKey
    
    抛出:
    
    NullPointerException - if the input parameter is null
    
    IllegalArgumentException - if the input parameter is empty
  - Client
```
public Client(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 log service 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
  - Client
```
public Client(String endpoint,
              String accessId,
              String accessKey,
              String sourceIp,
              boolean compressFlag)
```
    Construct sls client with full parameters
    
    参数:
    
    endpoint - the log service 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
- 方法详细资料
  - getUserAgent
```
public String getUserAgent()
```
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
  - getRealIpForConsole
```
public String getRealIpForConsole()
```
  - setRealIpForConsole
```
public void setRealIpForConsole(String realIpForConsole)
```
  - isUseSSLForConsole
```
public boolean isUseSSLForConsole()
```
  - setUseSSLForConsole
```
public void setUseSSLForConsole(boolean useSSLForConsole)
```
  - ClearConsoleResources
```
public void ClearConsoleResources()
```
  - GetSecurityToken
```
public String GetSecurityToken()
```
  - SetSecurityToken
```
public void SetSecurityToken(String securityToken)
```
  - RemoveSecurityToken
```
public void RemoveSecurityToken()
```
  - GetHistograms
```
public GetHistogramsResponse GetHistograms(String project,
                                           String logStore,
                                           int from,
                                           int to,
                                           String topic,
                                           String query)
                                    throws LogException
```
    从接口复制的说明: LogService
    
    Get The log status(histogram info) from log service 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 在接口中 LogService
    
    参数:
    
    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
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - GetHistograms
```
public GetHistogramsResponse GetHistograms(GetHistogramsRequest request)
                                    throws LogException
```
    从接口复制的说明: LogService
    
    Get The log status(histogram info) from log service 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 在接口中 LogService
    
    参数:
    
    request - the get histogram request
    
    返回:
    
    the histogram response of the matched logs
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - PutLogs
```
public PutLogsResponse PutLogs(String project,
                               String logStore,
                               String topic,
                               List<LogItem> logItems,
                               String source,
                               String shardHash)
                        throws LogException
```
    抛出:
    
    LogException
  - PutLogs
```
public PutLogsResponse PutLogs(String project,
                               String logStore,
                               String topic,
                               List<LogItem> logItems,
                               String source)
                        throws LogException
```
    从接口复制的说明: LogService
    
    Send Data to log service server
    
    指定者:
    
    PutLogs 在接口中 LogService
    
    参数:
    
    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
    
    抛出:
    
    LogException - if any error happen when send data to the server
  - PutLogs
```
public PutLogsResponse PutLogs(PutLogsRequest request)
                        throws LogException
```
    从接口复制的说明: LogService
    
    Send Data to log service server
    
    指定者:
    
    PutLogs 在接口中 LogService
    
    参数:
    
    request - the put log request
    
    返回:
    
    The put logs response
    
    抛出:
    
    LogException - 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 LogException
```
    从接口复制的说明: LogService
    
    Get The sub set of logs data from log service server which match input parameters. By default, it will return at most 20 lines
    
    指定者:
    
    GetLogs 在接口中 LogService
    
    参数:
    
    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
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - GetLogs
```
public GetLogsResponse GetLogs(String project,
                               String logStore,
                               int from,
                               int to,
                               String topic,
                               String query,
                               int line,
                               int offset,
                               boolean reverse)
                        throws LogException
```
    从接口复制的说明: LogService
    
    Get The sub set of logs data from log service 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 在接口中 LogService
    
    参数:
    
    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
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - GetLogs
```
public GetLogsResponse GetLogs(GetLogsRequest request)
                        throws LogException
```
    从接口复制的说明: LogService
    
    Get The sub set of logs data from log service server which match input parameters.
    
    指定者:
    
    GetLogs 在接口中 LogService
    
    参数:
    
    request - the get logs request
    
    返回:
    
    a response contains a sub set of the logs matched the input parameters
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - ListLogStores
```
public ListLogStoresResponse ListLogStores(String project,
                                           int offset,
                                           int size,
                                           String logstoreName)
                                    throws LogException
```
    从接口复制的说明: LogService
    
    Get all the logstore for the user
    
    指定者:
    
    ListLogStores 在接口中 LogService
    
    参数:
    
    project - the project name
    
    offset - the begin offset
    
    size - the query logstore name count
    
    logstoreName - part name of the logstore, only return the logstores which contains the input name
    
    返回:
    
    the user's logstore response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - ListLogStores
```
public ListLogStoresResponse ListLogStores(ListLogStoresRequest request)
                                    throws LogException
```
    从接口复制的说明: LogService
    
    Get all the logstore of a project
    
    指定者:
    
    ListLogStores 在接口中 LogService
    
    参数:
    
    request - the list log store request
    
    返回:
    
    the user's logstore response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - ListTopics
```
public ListTopicsResponse ListTopics(String project,
                                     String logStore,
                                     String token,
                                     int line)
                              throws LogException
```
    从接口复制的说明: LogService
    
    Get the topics in the logtstore
    
    指定者:
    
    ListTopics 在接口中 LogService
    
    参数:
    
    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 log service server
    
    返回:
    
    the log store's topics response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - ListTopics
```
public ListTopicsResponse ListTopics(ListTopicsRequest request)
                              throws LogException
```
    从接口复制的说明: LogService
    
    Get the topics in the logtstore
    
    指定者:
    
    ListTopics 在接口中 LogService
    
    参数:
    
    request - the list topics request
    
    返回:
    
    the log store's topics response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - GetCursor
```
public GetCursorResponse GetCursor(String project,
                                   String logStore,
                                   int shardId,
                                   long fromTime)
                            throws LogException
```
    从接口复制的说明: LogService
    
    Get cursor from log service server
    
    指定者:
    
    GetCursor 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStore - the log store name
    
    shardId - the shard where the cursor should be get
    
    fromTime - the from time of log data in unix time stamp sec
    
    返回:
    
    The get cursor response
    
    抛出:
    
    LogException - if any error happen when get cursor from the server
  - GetCursor
```
public GetCursorResponse GetCursor(String project,
                                   String logStore,
                                   int shardId,
                                   Date fromTime)
                            throws LogException
```
    从接口复制的说明: LogService
    
    Get cursor from log service server
    
    指定者:
    
    GetCursor 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStore - the log store name
    
    shardId - the shard where the cursor should be get
    
    fromTime - the from time of log data in java Date
    
    返回:
    
    The get cursor response
    
    抛出:
    
    LogException - if any error happen when get cursor from the server
  - GetCursor
```
public GetCursorResponse GetCursor(String project,
                                   String logStream,
                                   int shardId,
                                   Consts.CursorMode mode)
                            throws LogException
```
    从接口复制的说明: LogService
    
    Get cursor from log service server
    
    指定者:
    
    GetCursor 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStream - the log store name
    
    shardId - the shard where the cursor should be get
    
    mode - the mode to get cursor, include BEGIN and END
    
    返回:
    
    The get cursor response
    
    抛出:
    
    LogException - if any error happen when get cursor from the server
  - GetCursor
```
public GetCursorResponse GetCursor(GetCursorRequest request)
                            throws LogException
```
    从接口复制的说明: LogService
    
    Get cursor from log service server
    
    指定者:
    
    GetCursor 在接口中 LogService
    
    参数:
    
    request - the get cursor request
    
    返回:
    
    The get cursor response
    
    抛出:
    
    LogException - if any error happen when get cursor from the server
  - SplitShard
```
public ListShardResponse SplitShard(String prj,
                                    String logStore,
                                    int shardId,
                                    String midHash)
                             throws LogException
```
    从接口复制的说明: LogService
    
    split a readwrite shard in the logtstore
    
    指定者:
    
    SplitShard 在接口中 LogService
    
    参数:
    
    prj - the project name
    
    logStore - where the shard belongs to
    
    shardId - the shard id to split
    
    midHash - the middle md5 hash string to split the shard
    
    返回:
    
    the splited shard and two new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - SplitShard
```
public ListShardResponse SplitShard(SplitShardRequest request)
                             throws LogException
```
    从接口复制的说明: LogService
    
    split a readwrite shard in the logtstore
    
    指定者:
    
    SplitShard 在接口中 LogService
    
    参数:
    
    request - split shard request
    
    返回:
    
    the splited shard and two new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - MergeShards
```
public ListShardResponse MergeShards(String prj,
                                     String logStore,
                                     int shardId)
                              throws LogException
```
    从接口复制的说明: LogService
    
    merge two readwrite shards in the logtstore
    
    指定者:
    
    MergeShards 在接口中 LogService
    
    参数:
    
    prj - the project name
    
    logStore - where the shard belongs to
    
    shardId - the shard id to merge with right adjacent shard
    
    返回:
    
    the merges shards and new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - MergeShards
```
public ListShardResponse MergeShards(MergeShardsRequest request)
                              throws LogException
```
    从接口复制的说明: LogService
    
    merge two readwrite shards in the logtstore
    
    指定者:
    
    MergeShards 在接口中 LogService
    
    参数:
    
    request - the project name
    
    返回:
    
    the merges shards and new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - DeleteShard
```
public DeleteShardResponse DeleteShard(String prj,
                                       String logStore,
                                       int shardId)
                                throws LogException
```
    从接口复制的说明: LogService
    
    delete a readonly shard in the logtstore
    
    指定者:
    
    DeleteShard 在接口中 LogService
    
    参数:
    
    prj - the project name
    
    logStore - where the shard belongs to
    
    shardId - the shard id to delete
    
    返回:
    
    the merges shards and new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - DeleteShard
```
public DeleteShardResponse DeleteShard(DeleteShardRequest request)
                                throws LogException
```
    从接口复制的说明: LogService
    
    delete a readonly shard in the logtstore
    
    指定者:
    
    DeleteShard 在接口中 LogService
    
    参数:
    
    request - delete shard request
    
    返回:
    
    the merges shards and new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - ListShard
```
public ListShardResponse ListShard(String prj,
                                   String logStore)
                            throws LogException
```
    从接口复制的说明: LogService
    
    Get the shards in the logtstore
    
    指定者:
    
    ListShard 在接口中 LogService
    
    参数:
    
    prj - the project name
    
    logStore - where the shard belongs to
    
    返回:
    
    the log store's shards response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - ListShard
```
public ListShardResponse ListShard(ListShardRequest request)
                            throws LogException
```
    从接口复制的说明: LogService
    
    Get the shards in the logtstore
    
    指定者:
    
    ListShard 在接口中 LogService
    
    参数:
    
    request - the get cursor request
    
    返回:
    
    the log store's shards response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - GetRequestId
```
protected String GetRequestId(Map<String,String> headers)
```
  - BatchGetLog
```
public BatchGetLogResponse BatchGetLog(String project,
                                       String logStore,
                                       int shardId,
                                       int count,
                                       String cursor)
                                throws LogException
```
    从接口复制的说明: LogService
    
    Batch get log
    
    指定者:
    
    BatchGetLog 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStore - where the shard belongs to
    
    shardId - the shard to batch get log
    
    count - the logrgroup num
    
    cursor - the cursor to batch get log
    
    返回:
    
    batch get log response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - BatchGetLog
```
public BatchGetLogResponse BatchGetLog(BatchGetLogRequest request)
                                throws LogException
```
    从接口复制的说明: LogService
    
    Batch get log
    
    指定者:
    
    BatchGetLog 在接口中 LogService
    
    参数:
    
    request - the batch get log request
    
    返回:
    
    batch get log response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
  - CreateConfig
```
public CreateConfigResponse CreateConfig(String project,
                                         Config config)
                                  throws LogException
```
    从接口复制的说明: LogService
    
    Create logtail config
    
    指定者:
    
    CreateConfig 在接口中 LogService
    
    参数:
    
    project - the project name
    
    config - the full config resource
    
    返回:
    
    the create config response
    
    抛出:
    
    LogException - if any error happen when creating logtail config
  - CreateConfig
```
public CreateConfigResponse CreateConfig(CreateConfigRequest request)
                                  throws LogException
```
    从接口复制的说明: LogService
    
    Create logtail config
    
    指定者:
    
    CreateConfig 在接口中 LogService
    
    参数:
    
    request - the create config request
    
    返回:
    
    the create config response
    
    抛出:
    
    LogException - if any error happen when creating logtail config
  - UpdateConfig
```
public UpdateConfigResponse UpdateConfig(String project,
                                         Config config)
                                  throws LogException
```
    从接口复制的说明: LogService
    
    Update logtail config
    
    指定者:
    
    UpdateConfig 在接口中 LogService
    
    参数:
    
    project - the project name
    
    config - the full config resource
    
    返回:
    
    the update config response
    
    抛出:
    
    LogException - if any error happen when updating logtail config
  - UpdateConfig
```
public UpdateConfigResponse UpdateConfig(UpdateConfigRequest request)
                                  throws LogException
```
    从接口复制的说明: LogService
    
    Update logtail config
    
    指定者:
    
    UpdateConfig 在接口中 LogService
    
    参数:
    
    request - the update config request
    
    返回:
    
    the update config response
    
    抛出:
    
    LogException - if any error happen when updating logtail config
  - ExtractConfigFromResponse
```
protected Config ExtractConfigFromResponse(net.sf.json.JSONObject dict,
                                           String requestId)
                                    throws LogException
```
    抛出:
    
    LogException
  - GetConfig
```
public GetConfigResponse GetConfig(String project,
                                   String configName)
                            throws LogException
```
    从接口复制的说明: LogService
    
    Get logtail config
    
    指定者:
    
    GetConfig 在接口中 LogService
    
    参数:
    
    project - the project name
    
    configName - the config name
    
    返回:
    
    the get config response
    
    抛出:
    
    LogException - if any error happen when getting logtail config
  - GetConfig
```
public GetConfigResponse GetConfig(GetConfigRequest request)
                            throws LogException
```
    从接口复制的说明: LogService
    
    Get logtail config
    
    指定者:
    
    GetConfig 在接口中 LogService
    
    参数:
    
    request - the get config request
    
    返回:
    
    the get config response
    
    抛出:
    
    LogException - if any error happen when getting logtail config
  - DeleteConfig
```
public DeleteConfigResponse DeleteConfig(String project,
                                         String configName)
                                  throws LogException
```
    从接口复制的说明: LogService
    
    Delete logtail config
    
    指定者:
    
    DeleteConfig 在接口中 LogService
    
    参数:
    
    project - the project name
    
    configName - the config name
    
    返回:
    
    the delete config response
    
    抛出:
    
    LogException - if any error happen when deleting logtail config
  - DeleteConfig
```
public DeleteConfigResponse DeleteConfig(DeleteConfigRequest request)
                                  throws LogException
```
    从接口复制的说明: LogService
    
    Delete logtail config
    
    指定者:
    
    DeleteConfig 在接口中 LogService
    
    参数:
    
    request - the delete config request
    
    返回:
    
    the delete config response
    
    抛出:
    
    LogException - if any error happen when deleting logtail config
  - ExtractConfigs
```
protected List<String> ExtractConfigs(net.sf.json.JSONObject object,
                                      String requestId)
                               throws LogException
```
    抛出:
    
    LogException
  - ListConfig
```
public ListConfigResponse ListConfig(String project)
                              throws LogException
```
    从接口复制的说明: LogService
    
    List logtail configs
    
    指定者:
    
    ListConfig 在接口中 LogService
    
    参数:
    
    project - the project name
    
    返回:
    
    the list configs response
    
    抛出:
    
    LogException - if any error happen when listing logtail configs
  - ListConfig
```
public ListConfigResponse ListConfig(String project,
                                     int offSet,
                                     int size)
                              throws LogException
```
    从接口复制的说明: LogService
    
    List logtail configs
    
    指定者:
    
    ListConfig 在接口中 LogService
    
    参数:
    
    project - the project name
    
    offSet - the list offset
    
    size - the query size
    
    返回:
    
    the list configs response
    
    抛出:
    
    LogException - if any error happen when listing logtail configs
  - ListConfig
```
public ListConfigResponse ListConfig(String project,
                                     String configName,
                                     int offSet,
                                     int size)
                              throws LogException
```
    从接口复制的说明: LogService
    
    List logtail configs
    
    指定者:
    
    ListConfig 在接口中 LogService
    
    参数:
    
    project - the project name
    
    configName - the config name
    
    offSet - the list offset
    
    size - the query size
    
    返回:
    
    the list configs response
    
    抛出:
    
    LogException - if any error happen when listing logtail configs
  - ListConfig
```
public ListConfigResponse ListConfig(ListConfigRequest request)
                              throws LogException
```
    从接口复制的说明: LogService
    
    List logtail configs
    
    指定者:
    
    ListConfig 在接口中 LogService
    
    参数:
    
    request - the list configs request
    
    返回:
    
    the list configs response
    
    抛出:
    
    LogException - if any error happen when listing logtail configs
  - CreateMachineGroup
```
public CreateMachineGroupResponse CreateMachineGroup(String project,
                                                     MachineGroup group)
                                              throws LogException
```
    从接口复制的说明: LogService
    
    Create machine group
    
    指定者:
    
    CreateMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    group - the full machine group resource
    
    返回:
    
    the create machine group response
    
    抛出:
    
    LogException - if any error happen when creating machine group
  - CreateMachineGroup
```
public CreateMachineGroupResponse CreateMachineGroup(CreateMachineGroupRequest request)
                                              throws LogException
```
    从接口复制的说明: LogService
    
    Create machine group
    
    指定者:
    
    CreateMachineGroup 在接口中 LogService
    
    参数:
    
    request - the create machine group request
    
    返回:
    
    the create machine group response
    
    抛出:
    
    LogException - if any error happen when creating machine group
  - UpdateMachineGroup
```
public UpdateMachineGroupResponse UpdateMachineGroup(String project,
                                                     MachineGroup group)
                                              throws LogException
```
    从接口复制的说明: LogService
    
    Update machine group
    
    指定者:
    
    UpdateMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    group - the full machine group resource
    
    返回:
    
    the update machine group response
    
    抛出:
    
    LogException - if any error happen when updating machine group
  - UpdateMachineGroup
```
public UpdateMachineGroupResponse UpdateMachineGroup(UpdateMachineGroupRequest request)
                                              throws LogException
```
    从接口复制的说明: LogService
    
    Update machine group
    
    指定者:
    
    UpdateMachineGroup 在接口中 LogService
    
    参数:
    
    request - the update machine group request
    
    返回:
    
    the update machine group response
    
    抛出:
    
    LogException - if any error happen when updating machine group
  - ExtractMachineGroupFromResponse
```
protected MachineGroup ExtractMachineGroupFromResponse(net.sf.json.JSONObject dict,
                                                       String requestId)
                                                throws LogException
```
    抛出:
    
    LogException
  - ExtractConfigsFromResponse
```
protected ArrayList<String> ExtractConfigsFromResponse(net.sf.json.JSONObject object,
                                                       String requestId)
                                                throws LogException
```
    抛出:
    
    LogException
  - ExtractConfigMachineGroupFromResponse
```
protected ArrayList<String> ExtractConfigMachineGroupFromResponse(net.sf.json.JSONObject object,
                                                                  String requestId)
                                                           throws LogException
```
    抛出:
    
    LogException
  - GetAppliedConfig
```
public GetAppliedConfigResponse GetAppliedConfig(String project,
                                                 String groupName)
                                          throws LogException
```
    从接口复制的说明: LogService
    
    get applied config on a certain machine group
    
    指定者:
    
    GetAppliedConfig 在接口中 LogService
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    返回:
    
    get applied config response
    
    抛出:
    
    LogException - if any error happen when get applied config configs
  - GetAppliedConfig
```
public GetAppliedConfigResponse GetAppliedConfig(GetAppliedConfigsRequest request)
                                          throws LogException
```
    从接口复制的说明: LogService
    
    get applied config on a certain machine group
    
    指定者:
    
    GetAppliedConfig 在接口中 LogService
    
    参数:
    
    request - get applied config request
    
    返回:
    
    get applied config response
    
    抛出:
    
    LogException - if any error happen when get applied config configs
  - GetAppliedMachineGroups
```
public GetAppliedMachineGroupsResponse GetAppliedMachineGroups(String project,
                                                               String configName)
                                                        throws LogException
```
    从接口复制的说明: LogService
    
    get applied machine group for a certain logtail config
    
    指定者:
    
    GetAppliedMachineGroups 在接口中 LogService
    
    参数:
    
    project - the project name
    
    configName - the config name
    
    返回:
    
    get applied machine group response
    
    抛出:
    
    LogException - if any error happen when get applied config configs
  - GetAppliedMachineGroups
```
public GetAppliedMachineGroupsResponse GetAppliedMachineGroups(GetAppliedMachineGroupRequest request)
                                                        throws LogException
```
    从接口复制的说明: LogService
    
    get applied machine group for a certain logtail config
    
    指定者:
    
    GetAppliedMachineGroups 在接口中 LogService
    
    参数:
    
    request - get applied machine group request
    
    返回:
    
    get applied machine group response
    
    抛出:
    
    LogException - if any error happen when get applied config configs
  - GetMachineGroup
```
public GetMachineGroupResponse GetMachineGroup(String project,
                                               String groupName)
                                        throws LogException
```
    从接口复制的说明: LogService
    
    Get machine group
    
    指定者:
    
    GetMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    返回:
    
    the get machine group response
    
    抛出:
    
    LogException - if any error happen when getting machine group
  - GetMachineGroup
```
public GetMachineGroupResponse GetMachineGroup(GetMachineGroupRequest request)
                                        throws LogException
```
    从接口复制的说明: LogService
    
    Get machine group
    
    指定者:
    
    GetMachineGroup 在接口中 LogService
    
    参数:
    
    request - the get machine group request
    
    返回:
    
    the get machine group response
    
    抛出:
    
    LogException - if any error happen when getting machine group
  - ListMachines
```
public ListMachinesResponse ListMachines(String project,
                                         String machineGroup,
                                         int offset,
                                         int size)
                                  throws LogException
```
    从接口复制的说明: LogService
    
    List the real machines in the machine group
    
    指定者:
    
    ListMachines 在接口中 LogService
    
    参数:
    
    project - the project name
    
    machineGroup - the machine group name
    
    offset - the offset in the machine group
    
    size - the size to get
    
    返回:
    
    the machines in the machine group
    
    抛出:
    
    LogException - if any error happen when listing machines
  - DeleteMachineGroup
```
public DeleteMachineGroupResponse DeleteMachineGroup(String project,
                                                     String groupName)
                                              throws LogException
```
    从接口复制的说明: LogService
    
    Delete machine group
    
    指定者:
    
    DeleteMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    返回:
    
    the delete machine group response
    
    抛出:
    
    LogException - if any error happen when deleting machine group
  - DeleteMachineGroup
```
public DeleteMachineGroupResponse DeleteMachineGroup(DeleteMachineGroupRequest request)
                                              throws LogException
```
    从接口复制的说明: LogService
    
    Delete machine group
    
    指定者:
    
    DeleteMachineGroup 在接口中 LogService
    
    参数:
    
    request - the delete machine group request
    
    返回:
    
    the delete machine group response
    
    抛出:
    
    LogException - if any error happen when deleting machine group
  - ExtractMachineGroups
```
protected List<String> ExtractMachineGroups(net.sf.json.JSONObject object,
                                            String requestId)
                                     throws LogException
```
    抛出:
    
    LogException
  - ListMachineGroup
```
public ListMachineGroupResponse ListMachineGroup(String project)
                                          throws LogException
```
    从接口复制的说明: LogService
    
    List machine groups
    
    指定者:
    
    ListMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    返回:
    
    the list machine groups response
    
    抛出:
    
    LogException - if any error happen when listing machine groups
  - ListMachineGroup
```
public ListMachineGroupResponse ListMachineGroup(String project,
                                                 int offSet,
                                                 int size)
                                          throws LogException
```
    从接口复制的说明: LogService
    
    List machine groups
    
    指定者:
    
    ListMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    offSet - the list offset
    
    size - the query size
    
    返回:
    
    the list machine groups response
    
    抛出:
    
    LogException - if any error happen when listing machine groups
  - ListMachineGroup
```
public ListMachineGroupResponse ListMachineGroup(String project,
                                                 String groupName,
                                                 int offSet,
                                                 int size)
                                          throws LogException
```
    从接口复制的说明: LogService
    
    List machine groups
    
    指定者:
    
    ListMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    offSet - the list offset
    
    size - the query size
    
    返回:
    
    the list machine groups response
    
    抛出:
    
    LogException - if any error happen when listing machine groups
  - ListMachineGroup
```
public ListMachineGroupResponse ListMachineGroup(ListMachineGroupRequest request)
                                          throws LogException
```
    从接口复制的说明: LogService
    
    List machine groups
    
    指定者:
    
    ListMachineGroup 在接口中 LogService
    
    参数:
    
    request - the list machine groups request
    
    返回:
    
    the list machine groups response
    
    抛出:
    
    LogException - if any error happen when listing machine group
  - ApplyConfigToMachineGroup
```
public ApplyConfigToMachineGroupResponse ApplyConfigToMachineGroup(String project,
                                                                   String groupName,
                                                                   String configName)
                                                            throws LogException
```
    从接口复制的说明: LogService
    
    Apply config to machine group
    
    指定者:
    
    ApplyConfigToMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    configName - the logtail config name
    
    返回:
    
    the apply config to machine group response
    
    抛出:
    
    LogException - if any error happen when applying config to machine group
  - ApplyConfigToMachineGroup
```
public ApplyConfigToMachineGroupResponse ApplyConfigToMachineGroup(ApplyConfigToMachineGroupRequest request)
                                                            throws LogException
```
    从接口复制的说明: LogService
    
    Apply config to machine group
    
    指定者:
    
    ApplyConfigToMachineGroup 在接口中 LogService
    
    参数:
    
    request - apply config to machine group request
    
    返回:
    
    the apply config to machine group response
    
    抛出:
    
    LogException - if any error happen when applying config to machine group
  - RemoveConfigFromMachineGroup
```
public RemoveConfigFromMachineGroupResponse RemoveConfigFromMachineGroup(String project,
                                                                         String groupName,
                                                                         String configName)
                                                                  throws LogException
```
    从接口复制的说明: LogService
    
    Remove config from machine group
    
    指定者:
    
    RemoveConfigFromMachineGroup 在接口中 LogService
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    configName - the logtail config name
    
    返回:
    
    the remove config from machine group response
    
    抛出:
    
    LogException - if any error happen when removing config from machine group
  - RemoveConfigFromMachineGroup
```
public RemoveConfigFromMachineGroupResponse RemoveConfigFromMachineGroup(RemoveConfigFromMachineGroupRequest request)
                                                                  throws LogException
```
    从接口复制的说明: LogService
    
    Remove config from machine group
    
    指定者:
    
    RemoveConfigFromMachineGroup 在接口中 LogService
    
    参数:
    
    request - remove config from machine group request
    
    返回:
    
    the remove config from machine group response
    
    抛出:
    
    LogException - if any error happen when removing config from machine group
  - ErrorCheck
```
protected void ErrorCheck(net.sf.json.JSONObject object,
                          String requestId)
                   throws LogException
```
    抛出:
    
    LogException
  - ParserResponseMessage
```
protected net.sf.json.JSONObject ParserResponseMessage(ResponseMessage response,
                                                       String requestId)
                                                throws LogException
```
    抛出:
    
    LogException
  - SendData
```
protected ResponseMessage SendData(String project,
                                   HttpMethod method,
                                   String resourceUri,
                                   Map<String,String> parameters,
                                   Map<String,String> headers,
                                   byte[] body)
                            throws LogException
```
    抛出:
    
    LogException
  - ExtractShards
```
protected ArrayList<Shard> ExtractShards(net.sf.json.JSONArray array,
                                         String requestId)
                                  throws LogException
```
    抛出:
    
    LogException
  - CreateLogStore
```
public CreateLogStoreResponse CreateLogStore(String project,
                                             LogStore logStore)
                                      throws LogException
```
    从接口复制的说明: LogService
    
    create a logstore in a project
    
    指定者:
    
    CreateLogStore 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStore - the config
    
    返回:
    
    the create log store response
    
    抛出:
    
    LogException - if any error happen when creasting logstore
  - CreateLogStore
```
public CreateLogStoreResponse CreateLogStore(CreateLogStoreRequest request)
                                      throws LogException
```
    从接口复制的说明: LogService
    
    create logstore
    
    指定者:
    
    CreateLogStore 在接口中 LogService
    
    参数:
    
    request - logstore create request
    
    返回:
    
    the create log store response
    
    抛出:
    
    LogException - if any error happen when creasting logstore
  - DeleteLogStore
```
public DeleteLogStoreResponse DeleteLogStore(String project,
                                             String logStoreName)
                                      throws LogException
```
    从接口复制的说明: LogService
    
    Delete the logstore
    
    指定者:
    
    DeleteLogStore 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStoreName - the lostore to delete
    
    返回:
    
    delete logstore response
    
    抛出:
    
    LogException - if any error happen when deleting logstore
  - DeleteLogStore
```
public DeleteLogStoreResponse DeleteLogStore(DeleteLogStoreRequest request)
                                      throws LogException
```
    从接口复制的说明: LogService
    
    Delete logstore
    
    指定者:
    
    DeleteLogStore 在接口中 LogService
    
    参数:
    
    request - delete logstore request
    
    返回:
    
    the delete logstore response
    
    抛出:
    
    LogException - if any error happen when deleting logstore
  - UpdateLogStore
```
public UpdateLogStoreResponse UpdateLogStore(String project,
                                             LogStore logStore)
                                      throws LogException
```
    从接口复制的说明: LogService
    
    Update log store config
    
    指定者:
    
    UpdateLogStore 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStore - the logsotre config
    
    返回:
    
    update logstore response
    
    抛出:
    
    LogException - if any error happen when updating logstore
  - UpdateLogStore
```
public UpdateLogStoreResponse UpdateLogStore(UpdateLogStoreRequest request)
                                      throws LogException
```
    从接口复制的说明: LogService
    
    Update logstore config
    
    指定者:
    
    UpdateLogStore 在接口中 LogService
    
    参数:
    
    request - update logstore requst
    
    返回:
    
    Update logstore response
    
    抛出:
    
    LogException - if any error happen when updating logstore
  - GetLogStore
```
public GetLogStoreResponse GetLogStore(String project,
                                       String logStoreName)
                                throws LogException
```
    从接口复制的说明: LogService
    
    Get the logstore config
    
    指定者:
    
    GetLogStore 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStoreName - the logstore name
    
    返回:
    
    the get logstore response
    
    抛出:
    
    LogException - if any error happen when getting logstore config
  - GetLogStore
```
public GetLogStoreResponse GetLogStore(GetLogStoreRequest request)
                                throws LogException
```
    从接口复制的说明: LogService
    
    get the logstore config
    
    指定者:
    
    GetLogStore 在接口中 LogService
    
    参数:
    
    request - the get logstore config request
    
    返回:
    
    the get logstore response
    
    抛出:
    
    LogException - if any error happen when getting logstore config
  - CreateIndex
```
public CreateIndexResponse CreateIndex(String project,
                                       String logStore,
                                       Index index)
                                throws LogException
```
    从接口复制的说明: LogService
    
    create logstore index
    
    指定者:
    
    CreateIndex 在接口中 LogService
    
    参数:
    
    project - the project name
    
    logStore - the logstore name
    
    index - logstore index config
    
    返回:
    
    create index response
    
    抛出:
    
    LogException - if any error happen when creating index
  - CreateIndex
```
public CreateIndexResponse CreateIndex(CreateIndexRequest request)
                                throws LogException
```
    从接口复制的说明: LogService
    
    create logstore index
    
    指定者:
    
    CreateIndex 在接口中 LogService
    
    参数:
    
    request - the create logstore index request
    
    返回:
    
    create index response
    
    抛出:
    
    LogException - if any error happen when creating index
  - UpdateIndex
```
public UpdateIndexResponse UpdateIndex(String project,
                                       String logStore,
                                       Index index)
                                throws LogException
```
    从接口复制的说明: LogService
    
    Update logstore index config
    
    指定者:
    
    UpdateIndex 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    index - logstore index config
    
    返回:
    
    update logstore index response
    
    抛出:
    
    LogException - if any error happen when updating logstore index config
  - UpdateIndex
```
public UpdateIndexResponse UpdateIndex(UpdateIndexRequest request)
                                throws LogException
```
    从接口复制的说明: LogService
    
    update logstore index config
    
    指定者:
    
    UpdateIndex 在接口中 LogService
    
    参数:
    
    request - update logstore index request
    
    返回:
    
    update logstore index response
    
    抛出:
    
    LogException - if any error happen when update logstore index config
  - DeleteIndex
```
public DeleteIndexResponse DeleteIndex(String project,
                                       String logStore)
                                throws LogException
```
    从接口复制的说明: LogService
    
    delete logstore index
    
    指定者:
    
    DeleteIndex 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - store name
    
    返回:
    
    delete logstore index response
    
    抛出:
    
    LogException - if any error happen when deleting logstore index config
  - DeleteIndex
```
public DeleteIndexResponse DeleteIndex(DeleteIndexRequest request)
                                throws LogException
```
    从接口复制的说明: LogService
    
    delete logstore index
    
    指定者:
    
    DeleteIndex 在接口中 LogService
    
    参数:
    
    request - delete logstore index config
    
    返回:
    
    deleing index response
    
    抛出:
    
    LogException - if any error happen when deleting logstore index config
  - GetIndex
```
public GetIndexResponse GetIndex(String project,
                                 String logStore)
                          throws LogException
```
    从接口复制的说明: LogService
    
    Get logstore index config
    
    指定者:
    
    GetIndex 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    返回:
    
    get index config response
    
    抛出:
    
    LogException - if any error happen when get index config
  - GetIndex
```
public GetIndexResponse GetIndex(GetIndexRequest request)
                          throws LogException
```
    从接口复制的说明: LogService
    
    Get logstore index config
    
    指定者:
    
    GetIndex 在接口中 LogService
    
    参数:
    
    request - get logstore index request
    
    返回:
    
    get index config response
    
    抛出:
    
    LogException - if any error happen when getting index config
  - ListShipper
```
public ListShipperResponse ListShipper(String project,
                                       String logStore)
                                throws LogException
```
    从接口复制的说明: LogService
    
    List shipper of a logstore
    
    指定者:
    
    ListShipper 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    返回:
    
    ListShipperResponse if any error happened
    
    抛出:
    
    LogException - if any error happened
  - GetShipperTasks
```
public GetShipperTasksResponse GetShipperTasks(String project,
                                               String logStore,
                                               String shipperName,
                                               int startTime,
                                               int endTime,
                                               String statusType,
                                               int offset,
                                               int size)
                                        throws LogException
```
    从接口复制的说明: LogService
    
    Get the tasks of a logstore shipper
    
    指定者:
    
    GetShipperTasks 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    shipperName - shipper name
    
    startTime - the start time in timestamp (from 1970.1.1)
    
    endTime - the end time
    
    statusType - one of ['', 'success', 'running', 'fail'], if statusType is '', return all tasks
    
    offset - the offset
    
    size - the task count
    
    返回:
    
    GetShipperTasksResponse
    
    抛出:
    
    LogException - if any error happened
  - RetryShipperTasks
```
public RetryShipperTasksResponse RetryShipperTasks(String project,
                                                   String logStore,
                                                   String shipperName,
                                                   List<String> taskList)
                                            throws LogException
```
    从接口复制的说明: LogService
    
    retry the failed tasks, for every time it can only retry 10 task
    
    指定者:
    
    RetryShipperTasks 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    shipperName - shipper name
    
    taskList - failed task id list
    
    返回:
    
    RetryShipperTasksResponse
    
    抛出:
    
    LogException - if any error happened
  - CreateConsumerGroup
```
public CreateConsumerGroupResponse CreateConsumerGroup(String project,
                                                       String logStore,
                                                       ConsumerGroup consumerGroup)
                                                throws LogException
```
    从接口复制的说明: LogService
    
    create logstore consumer group
    
    指定者:
    
    CreateConsumerGroup 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - contains all of the parameters needed by consumer group
    
    返回:
    
    create logstore consumer group response
    
    抛出:
    
    LogException - if any error happened
  - CreateConsumerGroup
```
public CreateConsumerGroupResponse CreateConsumerGroup(CreateConsumerGroupRequest request)
                                                throws LogException
```
    从接口复制的说明: LogService
    
    create logstore consumer group
    
    指定者:
    
    CreateConsumerGroup 在接口中 LogService
    
    参数:
    
    request - contains all of the parameters needed
    
    返回:
    
    create logstore consumer group response
    
    抛出:
    
    LogException - if any error happened
  - UpdateConsumerGroup
```
protected UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
                                                          String logStore,
                                                          String consumerGroup,
                                                          Boolean inOrder,
                                                          Integer timeoutInSec)
                                                   throws LogException
```
    抛出:
    
    LogException
  - UpdateConsumerGroup
```
public UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
                                                       String logStore,
                                                       String consumerGroup,
                                                       boolean inOrder,
                                                       int timeoutInSec)
                                                throws LogException
```
    从接口复制的说明: LogService
    
    update consumer group
    
    指定者:
    
    UpdateConsumerGroup 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    inOrder - consume data in oder or not
    
    timeoutInSec - if the time interval of a consumer's heartbeat exceed this value in second, the consumer will be deleted.
    
    返回:
    
    update consumer group response
    
    抛出:
    
    LogException - if any error happened
  - UpdateConsumerGroup
```
public UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
                                                       String logStore,
                                                       String consumerGroup,
                                                       boolean inOrder)
                                                throws LogException
```
    指定者:
    
    UpdateConsumerGroup 在接口中 LogService
    
    抛出:
    
    LogException
  - UpdateConsumerGroup
```
public UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
                                                       String logStore,
                                                       String consumerGroup,
                                                       int timeoutInSec)
                                                throws LogException
```
    从接口复制的说明: LogService
    
    update consumer group
    
    指定者:
    
    UpdateConsumerGroup 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    timeoutInSec - if the time interval of a consumer's heartbeat exceed this value in second, the consumer will be deleted.
    
    返回:
    
    update consumer group response
    
    抛出:
    
    LogException - if any error happened
  - DeleteConsumerGroup
```
public DeleteConsumerGroupResponse DeleteConsumerGroup(String project,
                                                       String logStore,
                                                       String consumerGroup)
                                                throws LogException
```
    从接口复制的说明: LogService
    
    delete logstore consumer group
    
    指定者:
    
    DeleteConsumerGroup 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    返回:
    
    delete logstore consumer group response
    
    抛出:
    
    LogException - if any error happened
  - ListConsumerGroup
```
public ListConsumerGroupResponse ListConsumerGroup(String project,
                                                   String logStore)
                                            throws LogException
```
    从接口复制的说明: LogService
    
    list logstore consumer groups
    
    指定者:
    
    ListConsumerGroup 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    返回:
    
    list logstore consumer groups response
    
    抛出:
    
    LogException - if any error happened
  - UpdateCheckPoint
```
public ConsumerGroupUpdateCheckPointResponse UpdateCheckPoint(String project,
                                                              String logStore,
                                                              String consumerGroup,
                                                              String consumer,
                                                              int shard,
                                                              String checkpoint)
                                                       throws LogException
```
    从接口复制的说明: LogService
    
    update consume checkpoint
    
    指定者:
    
    UpdateCheckPoint 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    consumer - consumer name
    
    shard - shard id
    
    checkpoint - shard cursor
    
    返回:
    
    update consume checkpoint response
    
    抛出:
    
    LogException - if any error happened
  - UpdateCheckPoint
```
public ConsumerGroupUpdateCheckPointResponse UpdateCheckPoint(String project,
                                                              String logStore,
                                                              String consumerGroup,
                                                              int shard,
                                                              String checkpoint)
                                                       throws LogException
```
    从接口复制的说明: LogService
    
    update consume checkpoint
    
    指定者:
    
    UpdateCheckPoint 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    shard - shard id
    
    checkpoint - shard cursor
    
    返回:
    
    update consume checkpoint response
    
    抛出:
    
    LogException - if any error happened
  - UpdateCheckPoint
```
protected ConsumerGroupUpdateCheckPointResponse UpdateCheckPoint(String project,
                                                                 String logStore,
                                                                 String consumerGroup,
                                                                 String consumer,
                                                                 int shard,
                                                                 String checkpoint,
                                                                 boolean forceSuccess)
                                                          throws LogException
```
    抛出:
    
    LogException
  - HeartBeat
```
public ConsumerGroupHeartBeatResponse HeartBeat(String project,
                                                String logStore,
                                                String consumerGroup,
                                                String consumer,
                                                ArrayList<Integer> shards)
                                         throws LogException
```
    从接口复制的说明: LogService
    
    notify the server periodically to show that the consumer is still alive.
    
    指定者:
    
    HeartBeat 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    consumer - consumer name
    
    shards - shards hold by the consumer
    
    返回:
    
    heartbeat response
    
    抛出:
    
    LogException - if any error happened
  - ExtractShards
```
protected void ExtractShards(net.sf.json.JSONArray array,
                             String requestId,
                             ArrayList<Integer> shards)
                      throws LogException
```
    抛出:
    
    LogException
  - GetCheckPoint
```
public ConsumerGroupCheckPointResponse GetCheckPoint(String project,
                                                     String logStore,
                                                     String consumerGroup)
                                              throws LogException
```
    从接口复制的说明: LogService
    
    get all of the shard checkpoints in the consumer group
    
    指定者:
    
    GetCheckPoint 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    返回:
    
    get shard checkpoint response
    
    抛出:
    
    LogException - if any error happened
  - GetCheckPoint
```
public ConsumerGroupCheckPointResponse GetCheckPoint(String project,
                                                     String logStore,
                                                     String consumerGroup,
                                                     int shard)
                                              throws LogException
```
    从接口复制的说明: LogService
    
    get shard checkpoint in the consumer group
    
    指定者:
    
    GetCheckPoint 在接口中 LogService
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    shard - shard id
    
    返回:
    
    get shard checkpoint response
    
    抛出:
    
    LogException - if any error happened

类 Client

构造器概要

方法概要

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

构造器详细资料

Client

Client

Client

方法详细资料

getUserAgent

setUserAgent

getRealIpForConsole

setRealIpForConsole

isUseSSLForConsole

setUseSSLForConsole

ClearConsoleResources

GetSecurityToken

SetSecurityToken

RemoveSecurityToken

GetHistograms

GetHistograms

PutLogs

PutLogs

PutLogs

GetLogs

GetLogs

GetLogs

ListLogStores

ListLogStores

ListTopics

ListTopics

GetCursor

GetCursor

GetCursor

GetCursor

SplitShard

SplitShard

MergeShards

MergeShards

DeleteShard

DeleteShard

ListShard

ListShard

GetRequestId

BatchGetLog

BatchGetLog

CreateConfig

CreateConfig

UpdateConfig

UpdateConfig

ExtractConfigFromResponse

GetConfig

GetConfig

DeleteConfig

DeleteConfig

ExtractConfigs

ListConfig

ListConfig

ListConfig

ListConfig

CreateMachineGroup

CreateMachineGroup

UpdateMachineGroup

UpdateMachineGroup

ExtractMachineGroupFromResponse

ExtractConfigsFromResponse

ExtractConfigMachineGroupFromResponse

GetAppliedConfig

GetAppliedConfig

GetAppliedMachineGroups

GetAppliedMachineGroups

GetMachineGroup

GetMachineGroup

ListMachines

DeleteMachineGroup

DeleteMachineGroup

ExtractMachineGroups

ListMachineGroup

ListMachineGroup

ListMachineGroup