ClsClient (tencentcloud-sdk-java-intl-en 3.0.488 API)

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

public class ClsClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明

ClsClient(Credential credential, String region)

ClsClient(Credential credential, String region, ClientProfile profile)

构造器
构造器和说明
`ClsClient(Credential credential, String region)`
`ClsClient(Credential credential, String region, ClientProfile profile)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ApplyConfigToMachineGroupResponse`	`ApplyConfigToMachineGroup(ApplyConfigToMachineGroupRequest req)` This API is used to apply the collection configuration to the specified machine group.
`CloseKafkaConsumerResponse`	`CloseKafkaConsumer(CloseKafkaConsumerRequest req)` This API is used to disable Kafka consumption.
`CreateAlarmResponse`	`CreateAlarm(CreateAlarmRequest req)` This API is used to create an alarm policy.
`CreateAlarmNoticeResponse`	`CreateAlarmNotice(CreateAlarmNoticeRequest req)` This API is used to create a notification group.
`CreateConfigResponse`	`CreateConfig(CreateConfigRequest req)` This API is used to create a collection rule configuration.
`CreateConsumerResponse`	`CreateConsumer(CreateConsumerRequest req)` This API is used to create a shipping task.
`CreateExportResponse`	`CreateExport(CreateExportRequest req)` This API is used to create a download task.
`CreateIndexResponse`	`CreateIndex(CreateIndexRequest req)` This API is used to create an index.
`CreateLogsetResponse`	`CreateLogset(CreateLogsetRequest req)` This API is used to create a logset.
`CreateMachineGroupResponse`	`CreateMachineGroup(CreateMachineGroupRequest req)` This API is used to create a machine group.
`CreateShipperResponse`	`CreateShipper(CreateShipperRequest req)` This API is used to create a shipping rule.
`CreateTopicResponse`	`CreateTopic(CreateTopicRequest req)` This API is used to create a log topic.
`DeleteAlarmResponse`	`DeleteAlarm(DeleteAlarmRequest req)` This API is used to delete an alarm policy.
`DeleteAlarmNoticeResponse`	`DeleteAlarmNotice(DeleteAlarmNoticeRequest req)` This API is used to delete a notification group.
`DeleteConfigResponse`	`DeleteConfig(DeleteConfigRequest req)` This API is used to delete a collection rule configuration.
`DeleteConfigFromMachineGroupResponse`	`DeleteConfigFromMachineGroup(DeleteConfigFromMachineGroupRequest req)` This API is used to delete the collection configuration applied to a machine group.
`DeleteConsumerResponse`	`DeleteConsumer(DeleteConsumerRequest req)` This API is used to delete a shipping task.
`DeleteExportResponse`	`DeleteExport(DeleteExportRequest req)` This API is used to delete a log download task.
`DeleteIndexResponse`	`DeleteIndex(DeleteIndexRequest req)` This API is used to delete the index configuration of a log topic.
`DeleteLogsetResponse`	`DeleteLogset(DeleteLogsetRequest req)` This API is used to delete a logset.
`DeleteMachineGroupResponse`	`DeleteMachineGroup(DeleteMachineGroupRequest req)` This API is used to delete a machine group.
`DeleteShipperResponse`	`DeleteShipper(DeleteShipperRequest req)` This API is used to delete a shipping rule.
`DeleteTopicResponse`	`DeleteTopic(DeleteTopicRequest req)` This API is used to delete a log topic.
`DescribeAlarmNoticesResponse`	`DescribeAlarmNotices(DescribeAlarmNoticesRequest req)` This API is used to get the notification group list.
`DescribeAlarmsResponse`	`DescribeAlarms(DescribeAlarmsRequest req)` This API is used to get the alarm policy list.
`DescribeConfigMachineGroupsResponse`	`DescribeConfigMachineGroups(DescribeConfigMachineGroupsRequest req)` This API is used to get the machine group bound to a collection rule configuration.
`DescribeConfigsResponse`	`DescribeConfigs(DescribeConfigsRequest req)` This API is used to get a collection rule configuration.
`DescribeConsumerResponse`	`DescribeConsumer(DescribeConsumerRequest req)` This API is used to query a shipping task.
`DescribeExportsResponse`	`DescribeExports(DescribeExportsRequest req)` This API is used to get the list of log download tasks.
`DescribeIndexResponse`	`DescribeIndex(DescribeIndexRequest req)` This API is used to get the index configuration information.
`DescribeLogContextResponse`	`DescribeLogContext(DescribeLogContextRequest req)` This API is used to search for content in the log context.
`DescribeLogHistogramResponse`	`DescribeLogHistogram(DescribeLogHistogramRequest req)` This API is used to build a histogram.
`DescribeLogsetsResponse`	`DescribeLogsets(DescribeLogsetsRequest req)` This API is used to get the list of logsets.
`DescribeMachineGroupConfigsResponse`	`DescribeMachineGroupConfigs(DescribeMachineGroupConfigsRequest req)` This API is used to get the collection rule configuration bound to a machine group.
`DescribeMachineGroupsResponse`	`DescribeMachineGroups(DescribeMachineGroupsRequest req)` This API is used to get the list of machine groups.
`DescribeMachinesResponse`	`DescribeMachines(DescribeMachinesRequest req)` This API is used to get the machine status in the specified machine group.
`DescribePartitionsResponse`	`DescribePartitions(DescribePartitionsRequest req)` This API is used to get the list of topic partitions.
`DescribeShippersResponse`	`DescribeShippers(DescribeShippersRequest req)` This API is used to get the list of shipping rules.
`DescribeShipperTasksResponse`	`DescribeShipperTasks(DescribeShipperTasksRequest req)` This API is used to get the list of shipping tasks.
`DescribeTopicsResponse`	`DescribeTopics(DescribeTopicsRequest req)` This API is used to get the list of log topics and supports pagination.
`GetAlarmLogResponse`	`GetAlarmLog(GetAlarmLogRequest req)` This API is used to get the records of alarm tasks.
`MergePartitionResponse`	`MergePartition(MergePartitionRequest req)` This API is used to merge a topic partition in read/write state.
`ModifyAlarmResponse`	`ModifyAlarm(ModifyAlarmRequest req)` This API is used to modify an alarm policy.
`ModifyAlarmNoticeResponse`	`ModifyAlarmNotice(ModifyAlarmNoticeRequest req)` This API is used to modify a notification group.
`ModifyConfigResponse`	`ModifyConfig(ModifyConfigRequest req)` This API is used to modify a collection rule configuration.
`ModifyConsumerResponse`	`ModifyConsumer(ModifyConsumerRequest req)` This API is used to modify a shipping task.
`ModifyIndexResponse`	`ModifyIndex(ModifyIndexRequest req)` This API is used to modify the index configuration.
`ModifyLogsetResponse`	`ModifyLogset(ModifyLogsetRequest req)` This API is used to modify a logset.
`ModifyMachineGroupResponse`	`ModifyMachineGroup(ModifyMachineGroupRequest req)` This API is used to modify a machine group.
`ModifyShipperResponse`	`ModifyShipper(ModifyShipperRequest req)` This API is used to modify an existing shipping rule.
`ModifyTopicResponse`	`ModifyTopic(ModifyTopicRequest req)` This API is used to modify a log topic.
`OpenKafkaConsumerResponse`	`OpenKafkaConsumer(OpenKafkaConsumerRequest req)` This API is used to enable the Kafka consumption feature.
`RetryShipperTaskResponse`	`RetryShipperTask(RetryShipperTaskRequest req)` This API is used to retry a failed shipping task.
`SearchLogResponse`	`SearchLog(SearchLogRequest req)` This API is used to search logs.
`SplitPartitionResponse`	`SplitPartition(SplitPartitionRequest req)` This API is used to split a topic partition.
`UploadLogResponse`	`UploadLog(UploadLogRequest req)` ## Note To ensure log data reliability and help you use CLS more efficiently, we recommend you use the optimized API [Uploading Structured Logs](https://intl.cloud.tencent.com/document/api/614/16873?

从类继承的方法 com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

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

- 构造器详细资料
  - ClsClient
```
public ClsClient(Credential credential,
                 String region)
```
  - ClsClient
```
public ClsClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- 方法详细资料
  - ApplyConfigToMachineGroup
```
public ApplyConfigToMachineGroupResponse ApplyConfigToMachineGroup(ApplyConfigToMachineGroupRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to apply the collection configuration to the specified machine group.
    
    参数:
    
    req - ApplyConfigToMachineGroupRequest
    
    返回:
    
    ApplyConfigToMachineGroupResponse
    
    抛出:
    
    TencentCloudSDKException
  - CloseKafkaConsumer
```
public CloseKafkaConsumerResponse CloseKafkaConsumer(CloseKafkaConsumerRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to disable Kafka consumption.
    
    参数:
    
    req - CloseKafkaConsumerRequest
    
    返回:
    
    CloseKafkaConsumerResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateAlarm
```
public CreateAlarmResponse CreateAlarm(CreateAlarmRequest req)
                                throws TencentCloudSDKException
```
    This API is used to create an alarm policy.
    
    参数:
    
    req - CreateAlarmRequest
    
    返回:
    
    CreateAlarmResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateAlarmNotice
```
public CreateAlarmNoticeResponse CreateAlarmNotice(CreateAlarmNoticeRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to create a notification group.
    
    参数:
    
    req - CreateAlarmNoticeRequest
    
    返回:
    
    CreateAlarmNoticeResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateConfig
```
public CreateConfigResponse CreateConfig(CreateConfigRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to create a collection rule configuration.
    
    参数:
    
    req - CreateConfigRequest
    
    返回:
    
    CreateConfigResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateConsumer
```
public CreateConsumerResponse CreateConsumer(CreateConsumerRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to create a shipping task.
    
    参数:
    
    req - CreateConsumerRequest
    
    返回:
    
    CreateConsumerResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateExport
```
public CreateExportResponse CreateExport(CreateExportRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to create a download task. To get the returned download address, call `DescribeExports` to view the task list. The `CosPath` parameter is also included for download address. For more information, visit https://intl.cloud.tencent.com/document/product/614/56449.?from_cn_redirect=1
    
    参数:
    
    req - CreateExportRequest
    
    返回:
    
    CreateExportResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateIndex
```
public CreateIndexResponse CreateIndex(CreateIndexRequest req)
                                throws TencentCloudSDKException
```
    This API is used to create an index.
    
    参数:
    
    req - CreateIndexRequest
    
    返回:
    
    CreateIndexResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateLogset
```
public CreateLogsetResponse CreateLogset(CreateLogsetRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to create a logset. The ID of the created logset is returned.
    
    参数:
    
    req - CreateLogsetRequest
    
    返回:
    
    CreateLogsetResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateMachineGroup
```
public CreateMachineGroupResponse CreateMachineGroup(CreateMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to create a machine group.
    
    参数:
    
    req - CreateMachineGroupRequest
    
    返回:
    
    CreateMachineGroupResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateShipper
```
public CreateShipperResponse CreateShipper(CreateShipperRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to create a shipping rule. Note: To use this API, you need to check whether you have configured the role and permission for COS shipping tasks. If not, see **Viewing and Configuring Shipping Authorization** at https://intl.cloud.tencent.com/document/product/614/71623.?from_cn_redirect=1
    
    参数:
    
    req - CreateShipperRequest
    
    返回:
    
    CreateShipperResponse
    
    抛出:
    
    TencentCloudSDKException
  - CreateTopic
```
public CreateTopicResponse CreateTopic(CreateTopicRequest req)
                                throws TencentCloudSDKException
```
    This API is used to create a log topic.
    
    参数:
    
    req - CreateTopicRequest
    
    返回:
    
    CreateTopicResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteAlarm
```
public DeleteAlarmResponse DeleteAlarm(DeleteAlarmRequest req)
                                throws TencentCloudSDKException
```
    This API is used to delete an alarm policy.
    
    参数:
    
    req - DeleteAlarmRequest
    
    返回:
    
    DeleteAlarmResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteAlarmNotice
```
public DeleteAlarmNoticeResponse DeleteAlarmNotice(DeleteAlarmNoticeRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to delete a notification group.
    
    参数:
    
    req - DeleteAlarmNoticeRequest
    
    返回:
    
    DeleteAlarmNoticeResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteConfig
```
public DeleteConfigResponse DeleteConfig(DeleteConfigRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to delete a collection rule configuration.
    
    参数:
    
    req - DeleteConfigRequest
    
    返回:
    
    DeleteConfigResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteConfigFromMachineGroup
```
public DeleteConfigFromMachineGroupResponse DeleteConfigFromMachineGroup(DeleteConfigFromMachineGroupRequest req)
                                                                  throws TencentCloudSDKException
```
    This API is used to delete the collection configuration applied to a machine group.
    
    参数:
    
    req - DeleteConfigFromMachineGroupRequest
    
    返回:
    
    DeleteConfigFromMachineGroupResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteConsumer
```
public DeleteConsumerResponse DeleteConsumer(DeleteConsumerRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to delete a shipping task.
    
    参数:
    
    req - DeleteConsumerRequest
    
    返回:
    
    DeleteConsumerResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteExport
```
public DeleteExportResponse DeleteExport(DeleteExportRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to delete a log download task.
    
    参数:
    
    req - DeleteExportRequest
    
    返回:
    
    DeleteExportResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteIndex
```
public DeleteIndexResponse DeleteIndex(DeleteIndexRequest req)
                                throws TencentCloudSDKException
```
    This API is used to delete the index configuration of a log topic. After deleting, you cannot retrieve or query the collected logs.
    
    参数:
    
    req - DeleteIndexRequest
    
    返回:
    
    DeleteIndexResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteLogset
```
public DeleteLogsetResponse DeleteLogset(DeleteLogsetRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to delete a logset.
    
    参数:
    
    req - DeleteLogsetRequest
    
    返回:
    
    DeleteLogsetResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteMachineGroup
```
public DeleteMachineGroupResponse DeleteMachineGroup(DeleteMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to delete a machine group.
    
    参数:
    
    req - DeleteMachineGroupRequest
    
    返回:
    
    DeleteMachineGroupResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteShipper
```
public DeleteShipperResponse DeleteShipper(DeleteShipperRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to delete a shipping rule.
    
    参数:
    
    req - DeleteShipperRequest
    
    返回:
    
    DeleteShipperResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteTopic
```
public DeleteTopicResponse DeleteTopic(DeleteTopicRequest req)
                                throws TencentCloudSDKException
```
    This API is used to delete a log topic.
    
    参数:
    
    req - DeleteTopicRequest
    
    返回:
    
    DeleteTopicResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeAlarmNotices
```
public DescribeAlarmNoticesResponse DescribeAlarmNotices(DescribeAlarmNoticesRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to get the notification group list.
    
    参数:
    
    req - DescribeAlarmNoticesRequest
    
    返回:
    
    DescribeAlarmNoticesResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeAlarms
```
public DescribeAlarmsResponse DescribeAlarms(DescribeAlarmsRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to get the alarm policy list.
    
    参数:
    
    req - DescribeAlarmsRequest
    
    返回:
    
    DescribeAlarmsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeConfigMachineGroups
```
public DescribeConfigMachineGroupsResponse DescribeConfigMachineGroups(DescribeConfigMachineGroupsRequest req)
                                                                throws TencentCloudSDKException
```
    This API is used to get the machine group bound to a collection rule configuration.
    
    参数:
    
    req - DescribeConfigMachineGroupsRequest
    
    返回:
    
    DescribeConfigMachineGroupsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeConfigs
```
public DescribeConfigsResponse DescribeConfigs(DescribeConfigsRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to get a collection rule configuration.
    
    参数:
    
    req - DescribeConfigsRequest
    
    返回:
    
    DescribeConfigsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeConsumer
```
public DescribeConsumerResponse DescribeConsumer(DescribeConsumerRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to query a shipping task.
    
    参数:
    
    req - DescribeConsumerRequest
    
    返回:
    
    DescribeConsumerResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeExports
```
public DescribeExportsResponse DescribeExports(DescribeExportsRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to get the list of log download tasks.
    
    参数:
    
    req - DescribeExportsRequest
    
    返回:
    
    DescribeExportsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeIndex
```
public DescribeIndexResponse DescribeIndex(DescribeIndexRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to get the index configuration information.
    
    参数:
    
    req - DescribeIndexRequest
    
    返回:
    
    DescribeIndexResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeLogContext
```
public DescribeLogContextResponse DescribeLogContext(DescribeLogContextRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to search for content in the log context.
    
    参数:
    
    req - DescribeLogContextRequest
    
    返回:
    
    DescribeLogContextResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeLogHistogram
```
public DescribeLogHistogramResponse DescribeLogHistogram(DescribeLogHistogramRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to build a histogram.
    
    参数:
    
    req - DescribeLogHistogramRequest
    
    返回:
    
    DescribeLogHistogramResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeLogsets
```
public DescribeLogsetsResponse DescribeLogsets(DescribeLogsetsRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to get the list of logsets.
    
    参数:
    
    req - DescribeLogsetsRequest
    
    返回:
    
    DescribeLogsetsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeMachineGroupConfigs
```
public DescribeMachineGroupConfigsResponse DescribeMachineGroupConfigs(DescribeMachineGroupConfigsRequest req)
                                                                throws TencentCloudSDKException
```
    This API is used to get the collection rule configuration bound to a machine group.
    
    参数:
    
    req - DescribeMachineGroupConfigsRequest
    
    返回:
    
    DescribeMachineGroupConfigsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeMachineGroups
```
public DescribeMachineGroupsResponse DescribeMachineGroups(DescribeMachineGroupsRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to get the list of machine groups.
    
    参数:
    
    req - DescribeMachineGroupsRequest
    
    返回:
    
    DescribeMachineGroupsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeMachines
```
public DescribeMachinesResponse DescribeMachines(DescribeMachinesRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to get the machine status in the specified machine group.
    
    参数:
    
    req - DescribeMachinesRequest
    
    返回:
    
    DescribeMachinesResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribePartitions
```
public DescribePartitionsResponse DescribePartitions(DescribePartitionsRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to get the list of topic partitions.
    
    参数:
    
    req - DescribePartitionsRequest
    
    返回:
    
    DescribePartitionsResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeShipperTasks
```
public DescribeShipperTasksResponse DescribeShipperTasks(DescribeShipperTasksRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to get the list of shipping tasks.
    
    参数:
    
    req - DescribeShipperTasksRequest
    
    返回:
    
    DescribeShipperTasksResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeShippers
```
public DescribeShippersResponse DescribeShippers(DescribeShippersRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to get the list of shipping rules.
    
    参数:
    
    req - DescribeShippersRequest
    
    返回:
    
    DescribeShippersResponse
    
    抛出:
    
    TencentCloudSDKException
  - DescribeTopics
```
public DescribeTopicsResponse DescribeTopics(DescribeTopicsRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to get the list of log topics and supports pagination.
    
    参数:
    
    req - DescribeTopicsRequest
    
    返回:
    
    DescribeTopicsResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetAlarmLog
```
public GetAlarmLogResponse GetAlarmLog(GetAlarmLogRequest req)
                                throws TencentCloudSDKException
```
    This API is used to get the records of alarm tasks.
    
    参数:
    
    req - GetAlarmLogRequest
    
    返回:
    
    GetAlarmLogResponse
    
    抛出:
    
    TencentCloudSDKException
  - MergePartition
```
public MergePartitionResponse MergePartition(MergePartitionRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to merge a topic partition in read/write state. During merge, a topic partition ID can be specified, and CLS will automatically merge the partition adjacent to the right of the range.
    
    参数:
    
    req - MergePartitionRequest
    
    返回:
    
    MergePartitionResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyAlarm
```
public ModifyAlarmResponse ModifyAlarm(ModifyAlarmRequest req)
                                throws TencentCloudSDKException
```
    This API is used to modify an alarm policy. At least one valid configuration item needs to be modified.
    
    参数:
    
    req - ModifyAlarmRequest
    
    返回:
    
    ModifyAlarmResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyAlarmNotice
```
public ModifyAlarmNoticeResponse ModifyAlarmNotice(ModifyAlarmNoticeRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to modify a notification group.
    
    参数:
    
    req - ModifyAlarmNoticeRequest
    
    返回:
    
    ModifyAlarmNoticeResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyConfig
```
public ModifyConfigResponse ModifyConfig(ModifyConfigRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to modify a collection rule configuration.
    
    参数:
    
    req - ModifyConfigRequest
    
    返回:
    
    ModifyConfigResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyConsumer
```
public ModifyConsumerResponse ModifyConsumer(ModifyConsumerRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to modify a shipping task.
    
    参数:
    
    req - ModifyConsumerRequest
    
    返回:
    
    ModifyConsumerResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyIndex
```
public ModifyIndexResponse ModifyIndex(ModifyIndexRequest req)
                                throws TencentCloudSDKException
```
    This API is used to modify the index configuration.
    
    参数:
    
    req - ModifyIndexRequest
    
    返回:
    
    ModifyIndexResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyLogset
```
public ModifyLogsetResponse ModifyLogset(ModifyLogsetRequest req)
                                  throws TencentCloudSDKException
```
    This API is used to modify a logset.
    
    参数:
    
    req - ModifyLogsetRequest
    
    返回:
    
    ModifyLogsetResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyMachineGroup
```
public ModifyMachineGroupResponse ModifyMachineGroup(ModifyMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to modify a machine group.
    
    参数:
    
    req - ModifyMachineGroupRequest
    
    返回:
    
    ModifyMachineGroupResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyShipper
```
public ModifyShipperResponse ModifyShipper(ModifyShipperRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to modify an existing shipping rule. To use this API, you need to grant CLS the write permission of the specified bucket.
    
    参数:
    
    req - ModifyShipperRequest
    
    返回:
    
    ModifyShipperResponse
    
    抛出:
    
    TencentCloudSDKException
  - ModifyTopic
```
public ModifyTopicResponse ModifyTopic(ModifyTopicRequest req)
                                throws TencentCloudSDKException
```
    This API is used to modify a log topic.
    
    参数:
    
    req - ModifyTopicRequest
    
    返回:
    
    ModifyTopicResponse
    
    抛出:
    
    TencentCloudSDKException
  - OpenKafkaConsumer
```
public OpenKafkaConsumerResponse OpenKafkaConsumer(OpenKafkaConsumerRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to enable the Kafka consumption feature.
    
    参数:
    
    req - OpenKafkaConsumerRequest
    
    返回:
    
    OpenKafkaConsumerResponse
    
    抛出:
    
    TencentCloudSDKException
  - RetryShipperTask
```
public RetryShipperTaskResponse RetryShipperTask(RetryShipperTaskRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to retry a failed shipping task.
    
    参数:
    
    req - RetryShipperTaskRequest
    
    返回:
    
    RetryShipperTaskResponse
    
    抛出:
    
    TencentCloudSDKException
  - SearchLog
```
public SearchLogResponse SearchLog(SearchLogRequest req)
                            throws TencentCloudSDKException
```
    This API is used to search logs. It is subject to the default API rate limit, and the number of concurrent queries to the same log topic cannot exceed 15.
    
    参数:
    
    req - SearchLogRequest
    
    返回:
    
    SearchLogResponse
    
    抛出:
    
    TencentCloudSDKException
  - SplitPartition
```
public SplitPartitionResponse SplitPartition(SplitPartitionRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to split a topic partition.
    
    参数:
    
    req - SplitPartitionRequest
    
    返回:
    
    SplitPartitionResponse
    
    抛出:
    
    TencentCloudSDKException
  - UploadLog
```
public UploadLogResponse UploadLog(UploadLogRequest req)
                            throws TencentCloudSDKException
```
    ## Note To ensure log data reliability and help you use CLS more efficiently, we recommend you use the optimized API [Uploading Structured Logs](https://intl.cloud.tencent.com/document/api/614/16873?from_cn_redirect=1) to upload logs. For the optimized API, we have developed an SDK (available in multiple languages) that provides features including async sending, resource control, automatic retry, graceful shutdown, and detection-based reporting. For details, see [Collection via SDK](https://intl.cloud.tencent.com/document/product/614/45006). `UploadLog` allows you to synchronously upload log data. If you still want to continue to use this API instead of the optimized one, read this document. ## Feature Description This API is used to write logs to a specified log topic. CLS provides the following two modes: #### Load balancing mode In this mode, logs will be automatically written to a target partition among all readable/writable partitions under the current log topic based on the load balancing principle. This mode is suitable for scenarios where sequential consumption is not needed. #### Hash routing mode In this mode, data will be written to a target partition that meets the range requirements based on the carried hash value (`X-CLS-HashKey`). For example, a log source can be bound to a topic partition through `HashKey`, strictly guaranteeing the sequence of the data written to and consumed in this partition. #### Input parameters (pb binary streams in `body`) | Parameter | Type | Location | Required | Description | | ------------ | ------- | ---- | ---- | ------------------------------------------------------------ | | logGroupList | message | pb | Yes | The `logGroup` list, which describes the encapsulated log groups. We recommend you enter up to five `logGroup` values. | `LogGroup` description: | Parameter | Required | Description | | ----------- | -------- | ------------------------------------------------------------ | | logs | Yes | Log array consisting of multiple `Log` values. The `Log` indicates a log, and a `LogGroup` can contain up to 10,000 `Log` values. | | contextFlow | No | Unique `LogGroup` ID, which should be passed in if the context feature needs to be used. Format: "{context ID}-{LogGroupID}".
    Context ID: Uniquely identifies the context (a series of log files that are continuously scrolling or a series of logs that need to be sequenced), which is a 64-bit integer hex string.
    LogGroupID: A 64-bit integer hex string that continuously increases, such as `102700A66102516A-59F59`. | | filename | No | Log filename | | source | No | Log source, which is generally the machine IP | | logTags | No | Tag list of logs | `Log` description: | Parameter | Required | Description | | -------- | -------- | ------------------------------------------------------------ | | time | Yes | Unix timestamp of log time in seconds or milliseconds (recommended) | | contents | No | Log content in key-value format. A log can contain multiple key-value pairs. | `Content` description: | Parameter | Required | Description | | ------ | -------- | ------------------------------------------------------------ | | key | Yes | Key of a field group in one log, which cannot start with `_`. | | value | Yes | Value of a field group. The `value` of one log cannot exceed 1 MB and the total `value` in `LogGroup` cannot exceed 5 MB. | `LogTag` description: | Parameter | Required | Description | | ------ | -------- | -------------------------------- | | key | Yes | Key of a custom tag | | value | Yes | Value corresponding to the custom tag key | ## pb Compilation Sample This sample describes how to use the protoc compiler to compile the pb description file into a log upload API in C++. > ?Currently, protoc supports compilation in multiple programming languages such as Java, C++, and Python. For more information, see [protoc](https://github.com/protocolbuffers/protobuf). #### 1. Install Protocol Buffers Download [Protocol Buffers](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz), decompress the package, and install the tool. The version used in the sample is protobuf 2.6.1 running on CentOS 7.3. Run the following command to decompress the `protobuf-2.6.1.tar.gz` package to the `/usr/local` directory and go to the directory: ``` tar -zxvf protobuf-2.6.1.tar.gz -C /usr/local/ && cd /usr/local/protobuf-2.6.1 ``` Run the following commands to start compilation and installation, and configure the environment variables: ``` [root@VM_0_8_centos protobuf-2.6.1]# ./configure [root@VM_0_8_centos protobuf-2.6.1]# make && make install [root@VM_0_8_centos protobuf-2.6.1]# export PATH=$PATH:/usr/local/protobuf-2.6.1/bin ``` After the compilation succeeds, run the following command to check the version: ``` [root@VM_0_8_centos protobuf-2.6.1]# protoc --version liprotoc 2.6.1 ``` #### 2. Create a pb description file A pb description file is an agreed-on data interchange format for communication. To upload logs, compile the specified protocol format to an API in the target programming language and add the API to the project code. For more information, see [protoc](https://github.com/protocolbuffers/protobuf). Create a pb message description file `cls.proto` based on the pb data format content specified by CLS. > !The pb description file content cannot be modified, and the filename must end with `.proto`. The content of `cls.proto` (pb description file) is as follows: ``` package cls; message Log { message Content { required string key = 1; // Key of each field group required string value = 2; // Value of each field group } required int64 time = 1; // Unix timestamp repeated Content contents = 2; // Multiple key-value pairs in one log } message LogTag { required string key = 1; required string value = 2; } message LogGroup { repeated Log logs = 1; // Log array consisting of multiple logs optional string contextFlow = 2; // This parameter does not take effect currently optional string filename = 3; // Log filename optional string source = 4; // Log source, which is generally the machine IP repeated LogTag logTags = 5; } message LogGroupList { repeated LogGroup logGroupList = 1; // Log group list } ``` #### 3. Compile and generate the API This sample uses the proto compiler to generate a C++ file in the same directory as the `cls.proto` file. Run the following compilation command: ``` protoc --cpp_out=./ ./cls.proto ``` > ?`--cpp_out=./ ` indicates that the file will be compiled in cpp format and output to the current directory. `./cls.proto` indicates the `cls.proto` description file in the current directory. After the compilation succeeds, the code file in the corresponding programming language will be generated. This sample generates the `cls.pb.h` header file and [cls.pb.cc](http://cls.pb.cc) code implementation file as shown below: ``` [root@VM_0_8_centos protobuf-2.6.1]# protoc --cpp_out=./ ./cls.proto [root@VM_0_8_centos protobuf-2.6.1]# ls cls.pb.cc cls.pb.h cls.proto ``` #### 4. Call the API Import the generated `cls.pb.h` header file into the code and call the API for data encapsulation.
    
    参数:
    
    req - UploadLogRequest
    
    返回:
    
    UploadLogResponse
    
    抛出:
    
    TencentCloudSDKException

类 ClsClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

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

构造器详细资料

ClsClient

ClsClient

方法详细资料

ApplyConfigToMachineGroup

CloseKafkaConsumer

CreateAlarm

CreateAlarmNotice

CreateConfig

CreateConsumer

CreateExport

CreateIndex

CreateLogset

CreateMachineGroup

CreateShipper

CreateTopic

DeleteAlarm

DeleteAlarmNotice

DeleteConfig

DeleteConfigFromMachineGroup

DeleteConsumer

DeleteExport

DeleteIndex

DeleteLogset

DeleteMachineGroup

DeleteShipper

DeleteTopic

DescribeAlarmNotices

DescribeAlarms

DescribeConfigMachineGroups

DescribeConfigs

DescribeConsumer

DescribeExports

DescribeIndex

DescribeLogContext

DescribeLogHistogram

DescribeLogsets

DescribeMachineGroupConfigs

DescribeMachineGroups

DescribeMachines

DescribePartitions

DescribeShipperTasks

DescribeShippers

DescribeTopics

GetAlarmLog

MergePartition

ModifyAlarm

ModifyAlarmNotice

ModifyConfig

ModifyConsumer

ModifyIndex

ModifyLogset

ModifyMachineGroup

ModifyShipper

ModifyTopic

OpenKafkaConsumer

RetryShipperTask

SearchLog

SplitPartition

UploadLog