ClsClient (tencentcloud-sdk-java 3.1.300 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.cls.v20201016.ClsClient

public class ClsClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`ClsClient(Credential credential, String region)`
`ClsClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateAlarmResponse`	`CreateAlarm(CreateAlarmRequest req)` 本接口用于创建告警策略。
`CreateAlarmNoticeResponse`	`CreateAlarmNotice(CreateAlarmNoticeRequest req)` 该接口用户创建告警通知模板。
`CreateExportResponse`	`CreateExport(CreateExportRequest req)` 本接口用于创建日志导出
`CreateIndexResponse`	`CreateIndex(CreateIndexRequest req)` 本接口用于创建索引
`CreateMachineGroupResponse`	`CreateMachineGroup(CreateMachineGroupRequest req)` 创建机器组
`CreateTopicResponse`	`CreateTopic(CreateTopicRequest req)` 本接口用于创建日志主题。
`DeleteAlarmResponse`	`DeleteAlarm(DeleteAlarmRequest req)` 本接口用于删除告警策略。
`DeleteAlarmNoticeResponse`	`DeleteAlarmNotice(DeleteAlarmNoticeRequest req)` 该接口用于删除告警通知模板
`DeleteExportResponse`	`DeleteExport(DeleteExportRequest req)` 本接口用于删除日志导出
`DeleteIndexResponse`	`DeleteIndex(DeleteIndexRequest req)` 本接口用于日志主题的索引配置
`DeleteMachineGroupResponse`	`DeleteMachineGroup(DeleteMachineGroupRequest req)` 删除机器组
`DeleteTopicResponse`	`DeleteTopic(DeleteTopicRequest req)` 本接口用于删除日志主题。
`DescribeAlarmNoticesResponse`	`DescribeAlarmNotices(DescribeAlarmNoticesRequest req)` 该接口用于获取告警通知模板列表
`DescribeAlarmsResponse`	`DescribeAlarms(DescribeAlarmsRequest req)` 本接口用于获取告警策略。
`DescribeExportsResponse`	`DescribeExports(DescribeExportsRequest req)` 本接口用于获取日志导出列表
`DescribeIndexResponse`	`DescribeIndex(DescribeIndexRequest req)` 本接口用于获取索引配置信息
`DescribeLogContextResponse`	`DescribeLogContext(DescribeLogContextRequest req)` 本接口用于搜索日志上下文附近的内容
`DescribeMachineGroupsResponse`	`DescribeMachineGroups(DescribeMachineGroupsRequest req)` 获取机器组信息列表
`DescribeMachinesResponse`	`DescribeMachines(DescribeMachinesRequest req)` 获取制定机器组下的机器状态
`DescribePartitionsResponse`	`DescribePartitions(DescribePartitionsRequest req)` 本接口用于获取主题分区列表。
`DescribeTopicsResponse`	`DescribeTopics(DescribeTopicsRequest req)` 本接口用于获取日志主题列表，支持分页
`GetAlarmLogResponse`	`GetAlarmLog(GetAlarmLogRequest req)` 本接口用于获取告警任务历史
`MergePartitionResponse`	`MergePartition(MergePartitionRequest req)` 本接口用于合并一个读写态的主题分区，合并时指定一个主题分区 ID，日志服务会自动合并范围右相邻的分区。
`ModifyAlarmResponse`	`ModifyAlarm(ModifyAlarmRequest req)` 本接口用于修改告警策略。需要至少修改一项有效内容。
`ModifyAlarmNoticeResponse`	`ModifyAlarmNotice(ModifyAlarmNoticeRequest req)` 该接口用于修改告警通知模板。
`ModifyIndexResponse`	`ModifyIndex(ModifyIndexRequest req)` 本接口用于修改索引配置
`ModifyMachineGroupResponse`	`ModifyMachineGroup(ModifyMachineGroupRequest req)` 修改机器组
`ModifyTopicResponse`	`ModifyTopic(ModifyTopicRequest req)` 本接口用于修改日志主题。
`SearchLogResponse`	`SearchLog(SearchLogRequest req)` 本接口用于搜索日志
`SplitPartitionResponse`	`SplitPartition(SplitPartitionRequest req)` 本接口用于分裂主题分区

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClsClient

public ClsClient(Credential credential,
                 String region)

ClsClient

public ClsClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail
- CreateAlarm
```
public CreateAlarmResponse CreateAlarm(CreateAlarmRequest req)
                                throws TencentCloudSDKException
```
  本接口用于创建告警策略。
  
  Parameters:
  
  req - CreateAlarmRequest
  
  Returns:
  
  CreateAlarmResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateAlarmNotice
```
public CreateAlarmNoticeResponse CreateAlarmNotice(CreateAlarmNoticeRequest req)
                                            throws TencentCloudSDKException
```
  该接口用户创建告警通知模板。
  
  Parameters:
  
  req - CreateAlarmNoticeRequest
  
  Returns:
  
  CreateAlarmNoticeResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateExport
```
public CreateExportResponse CreateExport(CreateExportRequest req)
                                  throws TencentCloudSDKException
```
  本接口用于创建日志导出
  
  Parameters:
  
  req - CreateExportRequest
  
  Returns:
  
  CreateExportResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateIndex
```
public CreateIndexResponse CreateIndex(CreateIndexRequest req)
                                throws TencentCloudSDKException
```
  本接口用于创建索引
  
  Parameters:
  
  req - CreateIndexRequest
  
  Returns:
  
  CreateIndexResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateMachineGroup
```
public CreateMachineGroupResponse CreateMachineGroup(CreateMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
  创建机器组
  
  Parameters:
  
  req - CreateMachineGroupRequest
  
  Returns:
  
  CreateMachineGroupResponse
  
  Throws:
  
  TencentCloudSDKException
- CreateTopic
```
public CreateTopicResponse CreateTopic(CreateTopicRequest req)
                                throws TencentCloudSDKException
```
  本接口用于创建日志主题。
  
  Parameters:
  
  req - CreateTopicRequest
  
  Returns:
  
  CreateTopicResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteAlarm
```
public DeleteAlarmResponse DeleteAlarm(DeleteAlarmRequest req)
                                throws TencentCloudSDKException
```
  本接口用于删除告警策略。
  
  Parameters:
  
  req - DeleteAlarmRequest
  
  Returns:
  
  DeleteAlarmResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteAlarmNotice
```
public DeleteAlarmNoticeResponse DeleteAlarmNotice(DeleteAlarmNoticeRequest req)
                                            throws TencentCloudSDKException
```
  该接口用于删除告警通知模板
  
  Parameters:
  
  req - DeleteAlarmNoticeRequest
  
  Returns:
  
  DeleteAlarmNoticeResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteExport
```
public DeleteExportResponse DeleteExport(DeleteExportRequest req)
                                  throws TencentCloudSDKException
```
  本接口用于删除日志导出
  
  Parameters:
  
  req - DeleteExportRequest
  
  Returns:
  
  DeleteExportResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteIndex
```
public DeleteIndexResponse DeleteIndex(DeleteIndexRequest req)
                                throws TencentCloudSDKException
```
  本接口用于日志主题的索引配置
  
  Parameters:
  
  req - DeleteIndexRequest
  
  Returns:
  
  DeleteIndexResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteMachineGroup
```
public DeleteMachineGroupResponse DeleteMachineGroup(DeleteMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
  删除机器组
  
  Parameters:
  
  req - DeleteMachineGroupRequest
  
  Returns:
  
  DeleteMachineGroupResponse
  
  Throws:
  
  TencentCloudSDKException
- DeleteTopic
```
public DeleteTopicResponse DeleteTopic(DeleteTopicRequest req)
                                throws TencentCloudSDKException
```
  本接口用于删除日志主题。
  
  Parameters:
  
  req - DeleteTopicRequest
  
  Returns:
  
  DeleteTopicResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeAlarmNotices
```
public DescribeAlarmNoticesResponse DescribeAlarmNotices(DescribeAlarmNoticesRequest req)
                                                  throws TencentCloudSDKException
```
  该接口用于获取告警通知模板列表
  
  Parameters:
  
  req - DescribeAlarmNoticesRequest
  
  Returns:
  
  DescribeAlarmNoticesResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeAlarms
```
public DescribeAlarmsResponse DescribeAlarms(DescribeAlarmsRequest req)
                                      throws TencentCloudSDKException
```
  本接口用于获取告警策略。
  
  Parameters:
  
  req - DescribeAlarmsRequest
  
  Returns:
  
  DescribeAlarmsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeExports
```
public DescribeExportsResponse DescribeExports(DescribeExportsRequest req)
                                        throws TencentCloudSDKException
```
  本接口用于获取日志导出列表
  
  Parameters:
  
  req - DescribeExportsRequest
  
  Returns:
  
  DescribeExportsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeIndex
```
public DescribeIndexResponse DescribeIndex(DescribeIndexRequest req)
                                    throws TencentCloudSDKException
```
  本接口用于获取索引配置信息
  
  Parameters:
  
  req - DescribeIndexRequest
  
  Returns:
  
  DescribeIndexResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeLogContext
```
public DescribeLogContextResponse DescribeLogContext(DescribeLogContextRequest req)
                                              throws TencentCloudSDKException
```
  本接口用于搜索日志上下文附近的内容
  
  Parameters:
  
  req - DescribeLogContextRequest
  
  Returns:
  
  DescribeLogContextResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeMachineGroups
```
public DescribeMachineGroupsResponse DescribeMachineGroups(DescribeMachineGroupsRequest req)
                                                    throws TencentCloudSDKException
```
  获取机器组信息列表
  
  Parameters:
  
  req - DescribeMachineGroupsRequest
  
  Returns:
  
  DescribeMachineGroupsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeMachines
```
public DescribeMachinesResponse DescribeMachines(DescribeMachinesRequest req)
                                          throws TencentCloudSDKException
```
  获取制定机器组下的机器状态
  
  Parameters:
  
  req - DescribeMachinesRequest
  
  Returns:
  
  DescribeMachinesResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribePartitions
```
public DescribePartitionsResponse DescribePartitions(DescribePartitionsRequest req)
                                              throws TencentCloudSDKException
```
  本接口用于获取主题分区列表。
  
  Parameters:
  
  req - DescribePartitionsRequest
  
  Returns:
  
  DescribePartitionsResponse
  
  Throws:
  
  TencentCloudSDKException
- DescribeTopics
```
public DescribeTopicsResponse DescribeTopics(DescribeTopicsRequest req)
                                      throws TencentCloudSDKException
```
  本接口用于获取日志主题列表，支持分页
  
  Parameters:
  
  req - DescribeTopicsRequest
  
  Returns:
  
  DescribeTopicsResponse
  
  Throws:
  
  TencentCloudSDKException
- GetAlarmLog
```
public GetAlarmLogResponse GetAlarmLog(GetAlarmLogRequest req)
                                throws TencentCloudSDKException
```
  本接口用于获取告警任务历史
  
  Parameters:
  
  req - GetAlarmLogRequest
  
  Returns:
  
  GetAlarmLogResponse
  
  Throws:
  
  TencentCloudSDKException
- MergePartition
```
public MergePartitionResponse MergePartition(MergePartitionRequest req)
                                      throws TencentCloudSDKException
```
  本接口用于合并一个读写态的主题分区，合并时指定一个主题分区 ID，日志服务会自动合并范围右相邻的分区。
  
  Parameters:
  
  req - MergePartitionRequest
  
  Returns:
  
  MergePartitionResponse
  
  Throws:
  
  TencentCloudSDKException
- ModifyAlarm
```
public ModifyAlarmResponse ModifyAlarm(ModifyAlarmRequest req)
                                throws TencentCloudSDKException
```
  本接口用于修改告警策略。需要至少修改一项有效内容。
  
  Parameters:
  
  req - ModifyAlarmRequest
  
  Returns:
  
  ModifyAlarmResponse
  
  Throws:
  
  TencentCloudSDKException
- ModifyAlarmNotice
```
public ModifyAlarmNoticeResponse ModifyAlarmNotice(ModifyAlarmNoticeRequest req)
                                            throws TencentCloudSDKException
```
  该接口用于修改告警通知模板。
  
  Parameters:
  
  req - ModifyAlarmNoticeRequest
  
  Returns:
  
  ModifyAlarmNoticeResponse
  
  Throws:
  
  TencentCloudSDKException
- ModifyIndex
```
public ModifyIndexResponse ModifyIndex(ModifyIndexRequest req)
                                throws TencentCloudSDKException
```
  本接口用于修改索引配置
  
  Parameters:
  
  req - ModifyIndexRequest
  
  Returns:
  
  ModifyIndexResponse
  
  Throws:
  
  TencentCloudSDKException
- ModifyMachineGroup
```
public ModifyMachineGroupResponse ModifyMachineGroup(ModifyMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
  修改机器组
  
  Parameters:
  
  req - ModifyMachineGroupRequest
  
  Returns:
  
  ModifyMachineGroupResponse
  
  Throws:
  
  TencentCloudSDKException
- ModifyTopic
```
public ModifyTopicResponse ModifyTopic(ModifyTopicRequest req)
                                throws TencentCloudSDKException
```
  本接口用于修改日志主题。
  
  Parameters:
  
  req - ModifyTopicRequest
  
  Returns:
  
  ModifyTopicResponse
  
  Throws:
  
  TencentCloudSDKException
- SearchLog
```
public SearchLogResponse SearchLog(SearchLogRequest req)
                            throws TencentCloudSDKException
```
  本接口用于搜索日志
  
  Parameters:
  
  req - SearchLogRequest
  
  Returns:
  
  SearchLogResponse
  
  Throws:
  
  TencentCloudSDKException
- SplitPartition
```
public SplitPartitionResponse SplitPartition(SplitPartitionRequest req)
                                      throws TencentCloudSDKException
```
  本接口用于分裂主题分区
  
  Parameters:
  
  req - SplitPartitionRequest
  
  Returns:
  
  SplitPartitionResponse
  
  Throws:
  
  TencentCloudSDKException

Class ClsClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

ClsClient

ClsClient

Method Detail

CreateAlarm

CreateAlarmNotice

CreateExport

CreateIndex

CreateMachineGroup

CreateTopic

DeleteAlarm

DeleteAlarmNotice

DeleteExport

DeleteIndex

DeleteMachineGroup

DeleteTopic

DescribeAlarmNotices

DescribeAlarms

DescribeExports

DescribeIndex

DescribeLogContext

DescribeMachineGroups

DescribeMachines

DescribePartitions

DescribeTopics

GetAlarmLog

MergePartition

ModifyAlarm

ModifyAlarmNotice

ModifyIndex

ModifyMachineGroup

ModifyTopic

SearchLog

SplitPartition