ClsClient (tencentcloud-sdk-java 3.1.650 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
`AddMachineGroupInfoResponse`	`AddMachineGroupInfo(AddMachineGroupInfoRequest req)` 用于添加机器组信息
`ApplyConfigToMachineGroupResponse`	`ApplyConfigToMachineGroup(ApplyConfigToMachineGroupRequest req)` 应用采集配置到指定机器组
`CloseKafkaConsumerResponse`	`CloseKafkaConsumer(CloseKafkaConsumerRequest req)` 关闭Kafka协议消费
`CreateAlarmResponse`	`CreateAlarm(CreateAlarmRequest req)` 本接口用于创建告警策略。
`CreateAlarmNoticeResponse`	`CreateAlarmNotice(CreateAlarmNoticeRequest req)` 该接口用于创建通知渠道组。
`CreateConfigResponse`	`CreateConfig(CreateConfigRequest req)` 创建采集规则配置
`CreateConfigExtraResponse`	`CreateConfigExtra(CreateConfigExtraRequest req)` 本接口用于创建特殊采集配置任务，特殊采集配置应用于自建K8S环境的采集Agent
`CreateConsumerResponse`	`CreateConsumer(CreateConsumerRequest req)` 本接口用于创建投递任务
`CreateExportResponse`	`CreateExport(CreateExportRequest req)` 本接口仅创建下载任务，任务返回的下载地址，请用户调用DescribeExports查看任务列表。其中有下载地址CosPath参数。参考文档https://cloud.tencent.com/document/product/614/56449
`CreateIndexResponse`	`CreateIndex(CreateIndexRequest req)` 本接口用于创建索引
`CreateLogsetResponse`	`CreateLogset(CreateLogsetRequest req)` 本接口用于创建日志集，返回新创建的日志集的 ID。
`CreateMachineGroupResponse`	`CreateMachineGroup(CreateMachineGroupRequest req)` 创建机器组
`CreateShipperResponse`	`CreateShipper(CreateShipperRequest req)` 创建新的投递规则，【！！！注意】使用此接口，需要检查是否配置了投递COS的角色和权限。如果没有配置，请参考文档投递权限查看和配置https://cloud.tencent.com/document/product/614/71623。
`CreateTopicResponse`	`CreateTopic(CreateTopicRequest req)` 本接口用于创建日志主题。
`DeleteAlarmResponse`	`DeleteAlarm(DeleteAlarmRequest req)` 本接口用于删除告警策略。
`DeleteAlarmNoticeResponse`	`DeleteAlarmNotice(DeleteAlarmNoticeRequest req)` 该接口用于删除通知渠道组
`DeleteConfigResponse`	`DeleteConfig(DeleteConfigRequest req)` 删除采集规则配置
`DeleteConfigExtraResponse`	`DeleteConfigExtra(DeleteConfigExtraRequest req)` 本接口用于删除特殊采集规则配置，特殊采集配置应用于自建K8S环境的采集Agent
`DeleteConfigFromMachineGroupResponse`	`DeleteConfigFromMachineGroup(DeleteConfigFromMachineGroupRequest req)` 删除应用到机器组的采集配置
`DeleteConsumerResponse`	`DeleteConsumer(DeleteConsumerRequest req)` 本接口用于删除投递配置
`DeleteExportResponse`	`DeleteExport(DeleteExportRequest req)` 本接口用于删除日志下载任务
`DeleteIndexResponse`	`DeleteIndex(DeleteIndexRequest req)` 本接口用于删除日志主题的索引配置，删除索引配置后将无法检索和查询采集到的日志。
`DeleteLogsetResponse`	`DeleteLogset(DeleteLogsetRequest req)` 本接口用于删除日志集。
`DeleteMachineGroupResponse`	`DeleteMachineGroup(DeleteMachineGroupRequest req)` 删除机器组
`DeleteMachineGroupInfoResponse`	`DeleteMachineGroupInfo(DeleteMachineGroupInfoRequest req)` 用于删除机器组信息
`DeleteShipperResponse`	`DeleteShipper(DeleteShipperRequest req)` 删除投递规则
`DeleteTopicResponse`	`DeleteTopic(DeleteTopicRequest req)` 本接口用于删除日志主题。
`DescribeAlarmNoticesResponse`	`DescribeAlarmNotices(DescribeAlarmNoticesRequest req)` 该接口用于获取通知渠道组列表
`DescribeAlarmsResponse`	`DescribeAlarms(DescribeAlarmsRequest req)` 本接口用于获取告警策略列表。
`DescribeConfigExtrasResponse`	`DescribeConfigExtras(DescribeConfigExtrasRequest req)` 本接口用于获取特殊采集配置，特殊采集配置应用于自建K8S环境的采集Agent
`DescribeConfigMachineGroupsResponse`	`DescribeConfigMachineGroups(DescribeConfigMachineGroupsRequest req)` 获取采集规则配置所绑定的机器组
`DescribeConfigsResponse`	`DescribeConfigs(DescribeConfigsRequest req)` 获取采集规则配置
`DescribeConsumerResponse`	`DescribeConsumer(DescribeConsumerRequest req)` 本接口用于获取投递配置
`DescribeExportsResponse`	`DescribeExports(DescribeExportsRequest req)` 本接口用于获取日志下载任务列表
`DescribeIndexResponse`	`DescribeIndex(DescribeIndexRequest req)` 本接口用于获取索引配置信息
`DescribeLogContextResponse`	`DescribeLogContext(DescribeLogContextRequest req)` 本接口用于搜索日志上下文附近的内容
`DescribeLogHistogramResponse`	`DescribeLogHistogram(DescribeLogHistogramRequest req)` 本接口用于构建日志数量直方图
`DescribeLogsetsResponse`	`DescribeLogsets(DescribeLogsetsRequest req)` 本接口用于获取日志集信息列表。
`DescribeMachineGroupConfigsResponse`	`DescribeMachineGroupConfigs(DescribeMachineGroupConfigsRequest req)` 获取机器组绑定的采集规则配置
`DescribeMachineGroupsResponse`	`DescribeMachineGroups(DescribeMachineGroupsRequest req)` 获取机器组信息列表
`DescribeMachinesResponse`	`DescribeMachines(DescribeMachinesRequest req)` 获取制定机器组下的机器状态
`DescribePartitionsResponse`	`DescribePartitions(DescribePartitionsRequest req)` 本接口用于获取主题分区列表。
`DescribeShippersResponse`	`DescribeShippers(DescribeShippersRequest req)` 获取投递规则信息列表
`DescribeShipperTasksResponse`	`DescribeShipperTasks(DescribeShipperTasksRequest req)` 获取投递任务列表
`DescribeTopicsResponse`	`DescribeTopics(DescribeTopicsRequest req)` 本接口用于获取日志主题列表，支持分页
`GetAlarmLogResponse`	`GetAlarmLog(GetAlarmLogRequest req)` 本接口用于获取告警任务历史
`MergePartitionResponse`	`MergePartition(MergePartitionRequest req)` 本接口用于合并一个读写态的主题分区，合并时指定一个主题分区 ID，日志服务会自动合并范围右相邻的分区。
`ModifyAlarmResponse`	`ModifyAlarm(ModifyAlarmRequest req)` 本接口用于修改告警策略。需要至少修改一项有效内容。
`ModifyAlarmNoticeResponse`	`ModifyAlarmNotice(ModifyAlarmNoticeRequest req)` 该接口用于修改通知渠道组
`ModifyConfigResponse`	`ModifyConfig(ModifyConfigRequest req)` 修改采集规则配置
`ModifyConfigExtraResponse`	`ModifyConfigExtra(ModifyConfigExtraRequest req)` 本接口用于修改特殊采集配置任务，特殊采集配置应用于自建K8S环境的采集Agent
`ModifyConsumerResponse`	`ModifyConsumer(ModifyConsumerRequest req)` 本接口用于修改投递任务
`ModifyIndexResponse`	`ModifyIndex(ModifyIndexRequest req)` 本接口用于修改索引配置
`ModifyLogsetResponse`	`ModifyLogset(ModifyLogsetRequest req)` 本接口用于修改日志集信息
`ModifyMachineGroupResponse`	`ModifyMachineGroup(ModifyMachineGroupRequest req)` 修改机器组
`ModifyShipperResponse`	`ModifyShipper(ModifyShipperRequest req)` 修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
`ModifyTopicResponse`	`ModifyTopic(ModifyTopicRequest req)` 本接口用于修改日志主题。
`OpenKafkaConsumerResponse`	`OpenKafkaConsumer(OpenKafkaConsumerRequest req)` 打开Kafka协议消费功能
`RetryShipperTaskResponse`	`RetryShipperTask(RetryShipperTaskRequest req)` 重试失败的投递任务
`SearchLogResponse`	`SearchLog(SearchLogRequest req)` 本接口用于检索分析日志, 该接口除受默认接口请求频率限制外，针对单个日志主题，查询并发数不能超过15。
`SplitPartitionResponse`	`SplitPartition(SplitPartitionRequest req)` 本接口用于分裂主题分区
`UploadLogResponse`	`UploadLog(UploadLogRequest req)` ## 提示为了保障您日志数据的可靠性以及更高效地使用日志服务，建议您使用CLS优化后的接口[上传结构化日志](https://cloud.tencent.com/document/api/614/16873)上传日志。同时我们给此接口专门优化定制了多个语言版本的SDK供您选择，SDK提供统一的异步发送、资源控制、自动重试、优雅关闭、感知上报等功能，使上报日志功能更完善，详情请参考[SDK采集](https://cloud.tencent.com/document/product/614/67157)。同时云API上传日志接口也支持同步上传日志数据，如果您选继续使用此接口请参考下文。 ## 功能描述本接口用于将日志写入到指定的日志主题。日志服务提供以下两种模式： #### 负载均衡模式系统根据当前日志主题下所有可读写的分区，遵循负载均衡原则自动分配写入的目标分区。该模式适合消费不保序的场景。 #### 哈希路由模式系统根据携带的哈希值（X-CLS-HashKey）将数据写入到符合范围要求的目标分区。例如，可以将某个日志源端通过 hashkey 与某个主题分区强绑定，这样可以保证数据在该分区上写入和消费是严格保序的。 #### 输入参数(pb二进制流，位于body中) \| 字段名 \| 类型 \| 位置 \| 必须 \| 含义 \| \| ------------ \| ------- \| ---- \| ---- \| ------------------------------------------------------------ \| \| logGroupList \| message \| pb \| 是 \| logGroup 列表，封装好的日志组列表内容，建议 logGroup 数量不要超过5个 \| LogGroup 说明： \| 字段名 \| 是否必选 \| 含义 \| \| ----------- \| -------- \| ------------------------------------------------------------ \| \| logs \| 是 \| 日志数组，表示有多个 Log 组成的集合，一个 Log 表示一条日志，一个 LogGroup 中 Log 个数不能超过10000 \| \| contextFlow \| 否 \| LogGroup 的唯一ID，需要使用上下文功能时传入。格式："{上下文ID}-{LogGroupID}"。上下文ID：唯一标识一个上下文（连续滚动的一系列日志文件，或者是需要保序的一系列日志），16进制64位整型字符串。 LogGroupID：连续递增的一串整型，16进制64位整型字符串。样例："102700A66102516A-59F59"。 \| \| filename \| 否 \| 日志文件名 \| \| source \| 否 \| 日志来源，一般使用机器 IP 作为标识 \| \| logTags \| 否 \| 日志的标签列表 \| Log 说明： \| 字段名 \| 是否必选 \| 含义 \| \| -------- \| -------- \| ------------------------------------------------------------ \| \| time \| 是 \| 日志时间（Unix 格式时间戳），支持秒、毫秒，建议采用毫秒 \| \| contents \| 否 \| key-value 格式的日志内容，表示一条日志里的多个 key-value 组合 \| Content 说明： \| 字段名 \| 是否必选 \| 含义 \| \| ------ \| -------- \| ------------------------------------------------------------ \| \| key \| 是 \| 单条日志里某个字段组的 key 值，不能以`_`开头 \| \| value \| 是 \| 单条日志某个字段组的 value 值，单条日志 value 不能超过1MB，LogGroup 中所有 value 总和不能超过5MB \| LogTag 说明： \| 字段名 \| 是否必选 \| 含义 \| \| ------ \| -------- \| -------------------------------- \| \| key \| 是 \| 自定义的标签 key \| \| value \| 是 \| 自定义的标签 key 对应的 value 值 \| ## PB 编译示例本示例将说明如何使用官方 protoc 编译工具将 PB 描述文件编译生成为 C++ 语言可调用的上传日志接口。 > ?目前 protoc 官方支持 Java、C++、Python 等语言的编译，详情请参见 [protoc](https://github.com/protocolbuffers/protobuf)。 #### 1.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, internalRequest, retry, 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
  - AddMachineGroupInfo
```
public AddMachineGroupInfoResponse AddMachineGroupInfo(AddMachineGroupInfoRequest req)
                                                throws TencentCloudSDKException
```
    用于添加机器组信息
    
    Parameters:
    
    req - AddMachineGroupInfoRequest
    
    Returns:
    
    AddMachineGroupInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - ApplyConfigToMachineGroup
```
public ApplyConfigToMachineGroupResponse ApplyConfigToMachineGroup(ApplyConfigToMachineGroupRequest req)
                                                            throws TencentCloudSDKException
```
    应用采集配置到指定机器组
    
    Parameters:
    
    req - ApplyConfigToMachineGroupRequest
    
    Returns:
    
    ApplyConfigToMachineGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - CloseKafkaConsumer
```
public CloseKafkaConsumerResponse CloseKafkaConsumer(CloseKafkaConsumerRequest req)
                                              throws TencentCloudSDKException
```
    关闭Kafka协议消费
    
    Parameters:
    
    req - CloseKafkaConsumerRequest
    
    Returns:
    
    CloseKafkaConsumerResponse
    
    Throws:
    
    TencentCloudSDKException
  - 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
  - CreateConfig
```
public CreateConfigResponse CreateConfig(CreateConfigRequest req)
                                  throws TencentCloudSDKException
```
    创建采集规则配置
    
    Parameters:
    
    req - CreateConfigRequest
    
    Returns:
    
    CreateConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateConfigExtra
```
public CreateConfigExtraResponse CreateConfigExtra(CreateConfigExtraRequest req)
                                            throws TencentCloudSDKException
```
    本接口用于创建特殊采集配置任务，特殊采集配置应用于自建K8S环境的采集Agent
    
    Parameters:
    
    req - CreateConfigExtraRequest
    
    Returns:
    
    CreateConfigExtraResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateConsumer
```
public CreateConsumerResponse CreateConsumer(CreateConsumerRequest req)
                                      throws TencentCloudSDKException
```
    本接口用于创建投递任务
    
    Parameters:
    
    req - CreateConsumerRequest
    
    Returns:
    
    CreateConsumerResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateExport
```
public CreateExportResponse CreateExport(CreateExportRequest req)
                                  throws TencentCloudSDKException
```
    本接口仅创建下载任务，任务返回的下载地址，请用户调用DescribeExports查看任务列表。其中有下载地址CosPath参数。参考文档https://cloud.tencent.com/document/product/614/56449
    
    Parameters:
    
    req - CreateExportRequest
    
    Returns:
    
    CreateExportResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateIndex
```
public CreateIndexResponse CreateIndex(CreateIndexRequest req)
                                throws TencentCloudSDKException
```
    本接口用于创建索引
    
    Parameters:
    
    req - CreateIndexRequest
    
    Returns:
    
    CreateIndexResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateLogset
```
public CreateLogsetResponse CreateLogset(CreateLogsetRequest req)
                                  throws TencentCloudSDKException
```
    本接口用于创建日志集，返回新创建的日志集的 ID。
    
    Parameters:
    
    req - CreateLogsetRequest
    
    Returns:
    
    CreateLogsetResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateMachineGroup
```
public CreateMachineGroupResponse CreateMachineGroup(CreateMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
    创建机器组
    
    Parameters:
    
    req - CreateMachineGroupRequest
    
    Returns:
    
    CreateMachineGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateShipper
```
public CreateShipperResponse CreateShipper(CreateShipperRequest req)
                                    throws TencentCloudSDKException
```
    创建新的投递规则，【！！！注意】使用此接口，需要检查是否配置了投递COS的角色和权限。如果没有配置，请参考文档投递权限查看和配置https://cloud.tencent.com/document/product/614/71623。
    
    Parameters:
    
    req - CreateShipperRequest
    
    Returns:
    
    CreateShipperResponse
    
    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
  - DeleteConfig
```
public DeleteConfigResponse DeleteConfig(DeleteConfigRequest req)
                                  throws TencentCloudSDKException
```
    删除采集规则配置
    
    Parameters:
    
    req - DeleteConfigRequest
    
    Returns:
    
    DeleteConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteConfigExtra
```
public DeleteConfigExtraResponse DeleteConfigExtra(DeleteConfigExtraRequest req)
                                            throws TencentCloudSDKException
```
    本接口用于删除特殊采集规则配置，特殊采集配置应用于自建K8S环境的采集Agent
    
    Parameters:
    
    req - DeleteConfigExtraRequest
    
    Returns:
    
    DeleteConfigExtraResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteConfigFromMachineGroup
```
public DeleteConfigFromMachineGroupResponse DeleteConfigFromMachineGroup(DeleteConfigFromMachineGroupRequest req)
                                                                  throws TencentCloudSDKException
```
    删除应用到机器组的采集配置
    
    Parameters:
    
    req - DeleteConfigFromMachineGroupRequest
    
    Returns:
    
    DeleteConfigFromMachineGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteConsumer
```
public DeleteConsumerResponse DeleteConsumer(DeleteConsumerRequest req)
                                      throws TencentCloudSDKException
```
    本接口用于删除投递配置
    
    Parameters:
    
    req - DeleteConsumerRequest
    
    Returns:
    
    DeleteConsumerResponse
    
    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
  - DeleteLogset
```
public DeleteLogsetResponse DeleteLogset(DeleteLogsetRequest req)
                                  throws TencentCloudSDKException
```
    本接口用于删除日志集。
    
    Parameters:
    
    req - DeleteLogsetRequest
    
    Returns:
    
    DeleteLogsetResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteMachineGroup
```
public DeleteMachineGroupResponse DeleteMachineGroup(DeleteMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
    删除机器组
    
    Parameters:
    
    req - DeleteMachineGroupRequest
    
    Returns:
    
    DeleteMachineGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteMachineGroupInfo
```
public DeleteMachineGroupInfoResponse DeleteMachineGroupInfo(DeleteMachineGroupInfoRequest req)
                                                      throws TencentCloudSDKException
```
    用于删除机器组信息
    
    Parameters:
    
    req - DeleteMachineGroupInfoRequest
    
    Returns:
    
    DeleteMachineGroupInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteShipper
```
public DeleteShipperResponse DeleteShipper(DeleteShipperRequest req)
                                    throws TencentCloudSDKException
```
    删除投递规则
    
    Parameters:
    
    req - DeleteShipperRequest
    
    Returns:
    
    DeleteShipperResponse
    
    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
  - DescribeConfigExtras
```
public DescribeConfigExtrasResponse DescribeConfigExtras(DescribeConfigExtrasRequest req)
                                                  throws TencentCloudSDKException
```
    本接口用于获取特殊采集配置，特殊采集配置应用于自建K8S环境的采集Agent
    
    Parameters:
    
    req - DescribeConfigExtrasRequest
    
    Returns:
    
    DescribeConfigExtrasResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeConfigMachineGroups
```
public DescribeConfigMachineGroupsResponse DescribeConfigMachineGroups(DescribeConfigMachineGroupsRequest req)
                                                                throws TencentCloudSDKException
```
    获取采集规则配置所绑定的机器组
    
    Parameters:
    
    req - DescribeConfigMachineGroupsRequest
    
    Returns:
    
    DescribeConfigMachineGroupsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeConfigs
```
public DescribeConfigsResponse DescribeConfigs(DescribeConfigsRequest req)
                                        throws TencentCloudSDKException
```
    获取采集规则配置
    
    Parameters:
    
    req - DescribeConfigsRequest
    
    Returns:
    
    DescribeConfigsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeConsumer
```
public DescribeConsumerResponse DescribeConsumer(DescribeConsumerRequest req)
                                          throws TencentCloudSDKException
```
    本接口用于获取投递配置
    
    Parameters:
    
    req - DescribeConsumerRequest
    
    Returns:
    
    DescribeConsumerResponse
    
    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
  - DescribeLogHistogram
```
public DescribeLogHistogramResponse DescribeLogHistogram(DescribeLogHistogramRequest req)
                                                  throws TencentCloudSDKException
```
    本接口用于构建日志数量直方图
    
    Parameters:
    
    req - DescribeLogHistogramRequest
    
    Returns:
    
    DescribeLogHistogramResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLogsets
```
public DescribeLogsetsResponse DescribeLogsets(DescribeLogsetsRequest req)
                                        throws TencentCloudSDKException
```
    本接口用于获取日志集信息列表。
    
    Parameters:
    
    req - DescribeLogsetsRequest
    
    Returns:
    
    DescribeLogsetsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMachineGroupConfigs
```
public DescribeMachineGroupConfigsResponse DescribeMachineGroupConfigs(DescribeMachineGroupConfigsRequest req)
                                                                throws TencentCloudSDKException
```
    获取机器组绑定的采集规则配置
    
    Parameters:
    
    req - DescribeMachineGroupConfigsRequest
    
    Returns:
    
    DescribeMachineGroupConfigsResponse
    
    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
  - DescribeShipperTasks
```
public DescribeShipperTasksResponse DescribeShipperTasks(DescribeShipperTasksRequest req)
                                                  throws TencentCloudSDKException
```
    获取投递任务列表
    
    Parameters:
    
    req - DescribeShipperTasksRequest
    
    Returns:
    
    DescribeShipperTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeShippers
```
public DescribeShippersResponse DescribeShippers(DescribeShippersRequest req)
                                          throws TencentCloudSDKException
```
    获取投递规则信息列表
    
    Parameters:
    
    req - DescribeShippersRequest
    
    Returns:
    
    DescribeShippersResponse
    
    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
  - ModifyConfig
```
public ModifyConfigResponse ModifyConfig(ModifyConfigRequest req)
                                  throws TencentCloudSDKException
```
    修改采集规则配置
    
    Parameters:
    
    req - ModifyConfigRequest
    
    Returns:
    
    ModifyConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyConfigExtra
```
public ModifyConfigExtraResponse ModifyConfigExtra(ModifyConfigExtraRequest req)
                                            throws TencentCloudSDKException
```
    本接口用于修改特殊采集配置任务，特殊采集配置应用于自建K8S环境的采集Agent
    
    Parameters:
    
    req - ModifyConfigExtraRequest
    
    Returns:
    
    ModifyConfigExtraResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyConsumer
```
public ModifyConsumerResponse ModifyConsumer(ModifyConsumerRequest req)
                                      throws TencentCloudSDKException
```
    本接口用于修改投递任务
    
    Parameters:
    
    req - ModifyConsumerRequest
    
    Returns:
    
    ModifyConsumerResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyIndex
```
public ModifyIndexResponse ModifyIndex(ModifyIndexRequest req)
                                throws TencentCloudSDKException
```
    本接口用于修改索引配置
    
    Parameters:
    
    req - ModifyIndexRequest
    
    Returns:
    
    ModifyIndexResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyLogset
```
public ModifyLogsetResponse ModifyLogset(ModifyLogsetRequest req)
                                  throws TencentCloudSDKException
```
    本接口用于修改日志集信息
    
    Parameters:
    
    req - ModifyLogsetRequest
    
    Returns:
    
    ModifyLogsetResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyMachineGroup
```
public ModifyMachineGroupResponse ModifyMachineGroup(ModifyMachineGroupRequest req)
                                              throws TencentCloudSDKException
```
    修改机器组
    
    Parameters:
    
    req - ModifyMachineGroupRequest
    
    Returns:
    
    ModifyMachineGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyShipper
```
public ModifyShipperResponse ModifyShipper(ModifyShipperRequest req)
                                    throws TencentCloudSDKException
```
    修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
    
    Parameters:
    
    req - ModifyShipperRequest
    
    Returns:
    
    ModifyShipperResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyTopic
```
public ModifyTopicResponse ModifyTopic(ModifyTopicRequest req)
                                throws TencentCloudSDKException
```
    本接口用于修改日志主题。
    
    Parameters:
    
    req - ModifyTopicRequest
    
    Returns:
    
    ModifyTopicResponse
    
    Throws:
    
    TencentCloudSDKException
  - OpenKafkaConsumer
```
public OpenKafkaConsumerResponse OpenKafkaConsumer(OpenKafkaConsumerRequest req)
                                            throws TencentCloudSDKException
```
    打开Kafka协议消费功能
    
    Parameters:
    
    req - OpenKafkaConsumerRequest
    
    Returns:
    
    OpenKafkaConsumerResponse
    
    Throws:
    
    TencentCloudSDKException
  - RetryShipperTask
```
public RetryShipperTaskResponse RetryShipperTask(RetryShipperTaskRequest req)
                                          throws TencentCloudSDKException
```
    重试失败的投递任务
    
    Parameters:
    
    req - RetryShipperTaskRequest
    
    Returns:
    
    RetryShipperTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - SearchLog
```
public SearchLogResponse SearchLog(SearchLogRequest req)
                            throws TencentCloudSDKException
```
    本接口用于检索分析日志, 该接口除受默认接口请求频率限制外，针对单个日志主题，查询并发数不能超过15。
    
    Parameters:
    
    req - SearchLogRequest
    
    Returns:
    
    SearchLogResponse
    
    Throws:
    
    TencentCloudSDKException
  - SplitPartition
```
public SplitPartitionResponse SplitPartition(SplitPartitionRequest req)
                                      throws TencentCloudSDKException
```
    本接口用于分裂主题分区
    
    Parameters:
    
    req - SplitPartitionRequest
    
    Returns:
    
    SplitPartitionResponse
    
    Throws:
    
    TencentCloudSDKException
  - UploadLog
```
public UploadLogResponse UploadLog(UploadLogRequest req)
                            throws TencentCloudSDKException
```
    ## 提示为了保障您日志数据的可靠性以及更高效地使用日志服务，建议您使用CLS优化后的接口[上传结构化日志](https://cloud.tencent.com/document/api/614/16873)上传日志。同时我们给此接口专门优化定制了多个语言版本的SDK供您选择，SDK提供统一的异步发送、资源控制、自动重试、优雅关闭、感知上报等功能，使上报日志功能更完善，详情请参考[SDK采集](https://cloud.tencent.com/document/product/614/67157)。同时云API上传日志接口也支持同步上传日志数据，如果您选继续使用此接口请参考下文。 ## 功能描述本接口用于将日志写入到指定的日志主题。日志服务提供以下两种模式： #### 负载均衡模式系统根据当前日志主题下所有可读写的分区，遵循负载均衡原则自动分配写入的目标分区。该模式适合消费不保序的场景。 #### 哈希路由模式系统根据携带的哈希值（X-CLS-HashKey）将数据写入到符合范围要求的目标分区。例如，可以将某个日志源端通过 hashkey 与某个主题分区强绑定，这样可以保证数据在该分区上写入和消费是严格保序的。 #### 输入参数(pb二进制流，位于body中) | 字段名 | 类型 | 位置 | 必须 | 含义 | | ------------ | ------- | ---- | ---- | ------------------------------------------------------------ | | logGroupList | message | pb | 是 | logGroup 列表，封装好的日志组列表内容，建议 logGroup 数量不要超过5个 | LogGroup 说明： | 字段名 | 是否必选 | 含义 | | ----------- | -------- | ------------------------------------------------------------ | | logs | 是 | 日志数组，表示有多个 Log 组成的集合，一个 Log 表示一条日志，一个 LogGroup 中 Log 个数不能超过10000 | | contextFlow | 否 | LogGroup 的唯一ID，需要使用上下文功能时传入。格式："{上下文ID}-{LogGroupID}"。
    上下文ID：唯一标识一个上下文（连续滚动的一系列日志文件，或者是需要保序的一系列日志），16进制64位整型字符串。
    LogGroupID：连续递增的一串整型，16进制64位整型字符串。样例："102700A66102516A-59F59"。 | | filename | 否 | 日志文件名 | | source | 否 | 日志来源，一般使用机器 IP 作为标识 | | logTags | 否 | 日志的标签列表 | Log 说明： | 字段名 | 是否必选 | 含义 | | -------- | -------- | ------------------------------------------------------------ | | time | 是 | 日志时间（Unix 格式时间戳），支持秒、毫秒，建议采用毫秒 | | contents | 否 | key-value 格式的日志内容，表示一条日志里的多个 key-value 组合 | Content 说明： | 字段名 | 是否必选 | 含义 | | ------ | -------- | ------------------------------------------------------------ | | key | 是 | 单条日志里某个字段组的 key 值，不能以`_`开头 | | value | 是 | 单条日志某个字段组的 value 值，单条日志 value 不能超过1MB，LogGroup 中所有 value 总和不能超过5MB | LogTag 说明： | 字段名 | 是否必选 | 含义 | | ------ | -------- | -------------------------------- | | key | 是 | 自定义的标签 key | | value | 是 | 自定义的标签 key 对应的 value 值 | ## PB 编译示例本示例将说明如何使用官方 protoc 编译工具将 PB 描述文件编译生成为 C++ 语言可调用的上传日志接口。 > ?目前 protoc 官方支持 Java、C++、Python 等语言的编译，详情请参见 [protoc](https://github.com/protocolbuffers/protobuf)。 #### 1. 安装 Protocol Buffer 下载 [Protocol Buffer](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz) ，解压并安装。示例版本为 protobuf 2.6.1，环境为 Centos 7.3 系统。解压`protobuf-2.6.1.tar.gz`压缩包至`/usr/local`目录并进入该目录，执行命令如下： ``` tar -zxvf protobuf-2.6.1.tar.gz -C /usr/local/ && cd /usr/local/protobuf-2.6.1 ``` 开始编译和安装，配置环境变量，执行命令如下： ``` [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 ``` 编译成功后，您可以使用以下命令查看版本： ``` [root@VM_0_8_centos protobuf-2.6.1]# protoc --version liprotoc 2.6.1 ``` #### 2. 创建 PB 描述文件 PB 描述文件是通信双方约定的数据交换格式，上传日志时须将规定的协议格式编译成对应语言版本的调用接口，然后添加到工程代码里，详情请参见 [protoc](https://github.com/protocolbuffers/protobuf) 。以日志服务所规定的 PB 数据格式内容为准，在本地创建 PB 消息描述文件 cls.proto。 > !PB 描述文件内容不可更改，且文件名须以`.proto`结尾。 cls.proto 内容（PB 描述文件）如下： ``` package cls; message Log { message Content { required string key = 1; // 每组字段的 key required string value = 2; // 每组字段的 value } required int64 time = 1; // 时间戳，UNIX时间格式 repeated Content contents = 2; // 一条日志里的多个kv组合 } message LogTag { required string key = 1; required string value = 2; } message LogGroup { repeated Log logs = 1; // 多条日志合成的日志数组 optional string contextFlow = 2; // 目前暂无效用 optional string filename = 3; // 日志文件名 optional string source = 4; // 日志来源，一般使用机器IP repeated LogTag logTags = 5; } message LogGroupList { repeated LogGroup logGroupList = 1; // 日志组列表 } ``` #### 3. 编译生成此例中，使用 proto 编译器生成 C++ 语言的文件，在 cls.proto 文件的同一目录下，执行如下编译命令： ``` protoc --cpp_out=./ ./cls.proto ``` > ?`--cpp_out=./`表示编译成 cpp 格式并输出当前目录下，`./cls.proto`表示位于当前目录下的 cls.proto 描述文件。编译成功后，会输出对应语言的代码文件。此例会生成 cls.pb.h 头文件和 [cls.pb.cc](http://cls.pb.cc) 代码实现文件，如下所示： ``` [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. 调用将生成的 cls.pb.h 头文件引入代码中，调用接口进行数据格式封装。
    
    Parameters:
    
    req - UploadLogRequest
    
    Returns:
    
    UploadLogResponse
    
    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

AddMachineGroupInfo

ApplyConfigToMachineGroup

CloseKafkaConsumer

CreateAlarm

CreateAlarmNotice

CreateConfig

CreateConfigExtra

CreateConsumer

CreateExport

CreateIndex

CreateLogset

CreateMachineGroup

CreateShipper

CreateTopic

DeleteAlarm

DeleteAlarmNotice

DeleteConfig

DeleteConfigExtra

DeleteConfigFromMachineGroup

DeleteConsumer

DeleteExport

DeleteIndex

DeleteLogset

DeleteMachineGroup

DeleteMachineGroupInfo

DeleteShipper

DeleteTopic

DescribeAlarmNotices

DescribeAlarms

DescribeConfigExtras

DescribeConfigMachineGroups

DescribeConfigs

DescribeConsumer

DescribeExports

DescribeIndex

DescribeLogContext

DescribeLogHistogram

DescribeLogsets

DescribeMachineGroupConfigs

DescribeMachineGroups

DescribeMachines

DescribePartitions

DescribeShipperTasks

DescribeShippers

DescribeTopics

GetAlarmLog

MergePartition

ModifyAlarm

ModifyAlarmNotice

ModifyConfig

ModifyConfigExtra

ModifyConsumer

ModifyIndex

ModifyLogset

ModifyMachineGroup

ModifyShipper

ModifyTopic

OpenKafkaConsumer

RetryShipperTask

SearchLog

SplitPartition

UploadLog