tencentcloud-sdk-nodejs
Version:
1,432 lines (1,388 loc) • 45.5 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Client = void 0;
/* eslint-disable @typescript-eslint/no-unused-vars */
/*
* Copyright (c) 2018 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const abstract_client_1 = require("../../../common/abstract_client");
/**
* cls client
* @class
*/
class Client extends abstract_client_1.AbstractClient {
constructor(clientConfig) {
super("cls.tencentcloudapi.com", "2020-10-16", clientConfig);
}
/**
* 修改Kafka协议消费信息
*/
async ModifyKafkaConsumer(req, cb) {
return this.request("ModifyKafkaConsumer", req, cb);
}
/**
* 本接口用于创建Kafka数据订阅任务
*/
async CreateKafkaRecharge(req, cb) {
return this.request("CreateKafkaRecharge", req, cb);
}
/**
* 本接口用于创建OpenClaw依赖的资源与索引
*/
async OpenClawService(req, cb) {
return this.request("OpenClawService", req, cb);
}
/**
* 本接口用于获取日志下载任务列表
*/
async DescribeExports(req, cb) {
return this.request("DescribeExports", req, cb);
}
/**
* 修改网络应用
*/
async ModifyNetworkApplication(req, cb) {
return this.request("ModifyNetworkApplication", req, cb);
}
/**
* 修改主机指标采集配置
*/
async ModifyHostMetricConfig(req, cb) {
return this.request("ModifyHostMetricConfig", req, cb);
}
/**
* 本接口用于获取告警策略执行详情
*/
async GetAlarmLog(req, cb) {
return this.request("GetAlarmLog", req, cb);
}
/**
* 消费组心跳
*/
async CreateConsumerGroup(req, cb) {
return this.request("CreateConsumerGroup", req, cb);
}
/**
* 本接口用于创建索引
*/
async CreateIndex(req, cb) {
return this.request("CreateIndex", req, cb);
}
/**
* 查询日志服务是否开通
API 中 Region 填写任意一个地域均可，建议使用广州(ap-guangzhou)
*/
async GetClsService(req, cb) {
return this.request("GetClsService", req, cb);
}
/**
* 该接口用于获取通知渠道组列表
*/
async DescribeAlarmNotices(req, cb) {
return this.request("DescribeAlarmNotices", req, cb);
}
/**
* 查询指定时刻指标的最新值。
如果该时刻向前推5分钟内均无指标数据，则无相应的查询结果。
*/
async QueryMetric(req, cb) {
return this.request("QueryMetric", req, cb);
}
/**
* 修改DLC投递任务
*/
async ModifyDlcDeliver(req, cb) {
return this.request("ModifyDlcDeliver", req, cb);
}
/**
* 删除消费组
*/
async DeleteConsumerGroup(req, cb) {
return this.request("DeleteConsumerGroup", req, cb);
}
/**
* 获取采集规则配置
*/
async DescribeConfigs(req, cb) {
return this.request("DescribeConfigs", req, cb);
}
/**
* 本接口用于创建投递SCF任务
*/
async CreateDeliverCloudFunction(req, cb) {
return this.request("CreateDeliverCloudFunction", req, cb);
}
/**
* 本接口用于获取cos导入配置
*/
async DescribeS3Recharges(req, cb) {
return this.request("DescribeS3Recharges", req, cb);
}
/**
* 本接口用于删除日志集。
*/
async DeleteLogset(req, cb) {
return this.request("DeleteLogset", req, cb);
}
/**
* 删除应用到机器组的采集配置
*/
async DeleteConfigFromMachineGroup(req, cb) {
return this.request("DeleteConfigFromMachineGroup", req, cb);
}
/**
* 本接口用于删除数据加工任务
*/
async DeleteDataTransform(req, cb) {
return this.request("DeleteDataTransform", req, cb);
}
/**
* 本接口用于删除特殊采集规则配置，特殊采集配置应用于自建K8S环境的采集Agent
*/
async DeleteConfigExtra(req, cb) {
return this.request("DeleteConfigExtra", req, cb);
}
/**
* 获取网络应用列表
*/
async DescribeNetworkApplications(req, cb) {
return this.request("DescribeNetworkApplications", req, cb);
}
/**
* 开通日志服务
API 中 Region 填写任意一个地域均可开通所有地域的 CLS，建议使用广州(ap-guangzhou)
*/
async OpenClsService(req, cb) {
return this.request("OpenClsService", req, cb);
}
/**
* 获取es导入配置
*/
async DescribeEsRecharges(req, cb) {
return this.request("DescribeEsRecharges", req, cb);
}
/**
* 本接口用于创建日志或指标主题。
*/
async CreateTopic(req, cb) {
return this.request("CreateTopic", req, cb);
}
/**
* 云产品接入使用相关接口
*/
async DescribeCloudProductLogTasks(req, cb) {
return this.request("DescribeCloudProductLogTasks", req, cb);
}
/**
* 获取指标订阅配置
*/
async DescribeHostMetricConfigs(req, cb) {
return this.request("DescribeHostMetricConfigs", req, cb);
}
/**
* 创建指标订阅配置
*/
async CreateMetricSubscribe(req, cb) {
return this.request("CreateMetricSubscribe", req, cb);
}
/**
* kafka协议消费预览接口
*/
async DescribeKafkaConsumerPreview(req, cb) {
return this.request("DescribeKafkaConsumerPreview", req, cb);
}
/**
* 获取指标订阅配置
*/
async DescribeClusterMetricConfigs(req, cb) {
return this.request("DescribeClusterMetricConfigs", req, cb);
}
/**
* 新建查询视图
*/
async CreateSearchView(req, cb) {
return this.request("CreateSearchView", req, cb);
}
/**
* 获取告警历史，例如今天未恢复的告警
*/
async DescribeAlertRecordHistory(req, cb) {
return this.request("DescribeAlertRecordHistory", req, cb);
}
/**
* 本接口用于删除Kafka数据订阅任务
*/
async DeleteKafkaRecharge(req, cb) {
return this.request("DeleteKafkaRecharge", req, cb);
}
/**
* 创建采集规则配置
*/
async CreateConfig(req, cb) {
return this.request("CreateConfig", req, cb);
}
/**
* 获取告警渠道回调配置列表。
*/
async DescribeDlcDelivers(req, cb) {
return this.request("DescribeDlcDelivers", req, cb);
}
/**
* 本接口用于获取日志或指标主题列表，支持分页
*/
async DescribeTopics(req, cb) {
return this.request("DescribeTopics", req, cb);
}
/**
* 本接口用于修改aws导入任务
*/
async ModifyS3Recharge(req, cb) {
return this.request("ModifyS3Recharge", req, cb);
}
/**
* 取消重建索引任务
*/
async CancelRebuildIndexTask(req, cb) {
return this.request("CancelRebuildIndexTask", req, cb);
}
/**
* 预估重建索引任务
*/
async EstimateRebuildIndexTask(req, cb) {
return this.request("EstimateRebuildIndexTask", req, cb);
}
/**
* splunk投递任务预览
*/
async DescribeSplunkPreview(req, cb) {
return this.request("DescribeSplunkPreview", req, cb);
}
/**
* 内部云产品接入使用相关接口
*/
async CreateCloudProductLogCollection(req, cb) {
return this.request("CreateCloudProductLogCollection", req, cb);
}
/**
* 本接口用于创建cos导入任务
*/
async CreateCosRecharge(req, cb) {
return this.request("CreateCosRecharge", req, cb);
}
/**
* 该接口已废弃，如需修改分区数量，请使用ModifyTopic接口。
*/
async MergePartition(req, cb) {
return this.request("MergePartition", req, cb);
}
/**
* 删除主机指标采集配置
*/
async DeleteHostMetricConfig(req, cb) {
return this.request("DeleteHostMetricConfig", req, cb);
}
/**
* 本接口用于删除定时SQL分析任务
*/
async DeleteScheduledSql(req, cb) {
return this.request("DeleteScheduledSql", req, cb);
}
/**
* 本接口仅创建下载任务。任务返回的下载地址，请用户调用[DescribeExports](https://cloud.tencent.com/document/product/614/56449)查看任务列表，其中有下载地址CosPath参数。
*/
async CreateExport(req, cb) {
return this.request("CreateExport", req, cb);
}
/**
* 删除Splunk投递任务
*/
async DeleteSplunkDeliver(req, cb) {
return this.request("DeleteSplunkDeliver", req, cb);
}
/**
* 获取指标订阅配置
*/
async DescribeClusterBaseMetricConfigs(req, cb) {
return this.request("DescribeClusterBaseMetricConfigs", req, cb);
}
/**
* 获取消费组点位信息
*/
async DescribeConsumerOffsets(req, cb) {
return this.request("DescribeConsumerOffsets", req, cb);
}
/**
* 获取网络应用详情
*/
async DescribeNetworkApplicationDetail(req, cb) {
return this.request("DescribeNetworkApplicationDetail", req, cb);
}
/**
* 获取指标订阅配置
*/
async DescribeTopicMetricConfigs(req, cb) {
return this.request("DescribeTopicMetricConfigs", req, cb);
}
/**
* 修改指标订阅配置
*/
async ModifyMetricSubscribe(req, cb) {
return this.request("ModifyMetricSubscribe", req, cb);
}
/**
* 创建DLC投递任务
*/
async CreateDlcDeliver(req, cb) {
return this.request("CreateDlcDeliver", req, cb);
}
/**
* 本接口用于预览cos导入信息
*/
async SearchCosRechargeInfo(req, cb) {
return this.request("SearchCosRechargeInfo", req, cb);
}
/**
* 本接口用于修改索引配置，该接口除受默认接口请求频率限制外，针对单个日志主题，并发数不能超过1，即同一时间同一个日志主题只能有一个正在执行的索引配置修改操作。
*/
async ModifyIndex(req, cb) {
return this.request("ModifyIndex", req, cb);
}
/**
* 获取查询视图列表
*/
async DescribeSearchViews(req, cb) {
return this.request("DescribeSearchViews", req, cb);
}
/**
* 内部云产品接入使用相关接口
*/
async ModifyCloudProductLogCollection(req, cb) {
return this.request("ModifyCloudProductLogCollection", req, cb);
}
/**
* 该接口用于创建告警屏蔽规则。
*/
async CreateAlarmShield(req, cb) {
return this.request("CreateAlarmShield", req, cb);
}
/**
* 删除指标订阅配置
*/
async DeleteMetricSubscribe(req, cb) {
return this.request("DeleteMetricSubscribe", req, cb);
}
/**
* 创建es导入配置
*/
async CreateEsRecharge(req, cb) {
return this.request("CreateEsRecharge", req, cb);
}
/**
* 修改es导入配置
*/
async ModifyEsRecharge(req, cb) {
return this.request("ModifyEsRecharge", req, cb);
}
/**
* 删除DLC投递任务
*/
async DeleteDlcDeliver(req, cb) {
return this.request("DeleteDlcDeliver", req, cb);
}
/**
* 内部云产品接入使用相关接口
*/
async DeleteCloudProductLogCollection(req, cb) {
return this.request("DeleteCloudProductLogCollection", req, cb);
}
/**
* 创建指标订阅配置
*/
async DescribeMetricSubscribePreview(req, cb) {
return this.request("DescribeMetricSubscribePreview", req, cb);
}
/**
* es导入预览
*/
async DescribeEsRechargePreview(req, cb) {
return this.request("DescribeEsRechargePreview", req, cb);
}
/**
* 新建投递到COS的任务，【！！！注意】使用此接口，需要检查是否配置了投递COS的角色和权限。如果没有配置，请参考文档投递权限查看和配置https://cloud.tencent.com/document/product/614/71623。
*/
async CreateShipper(req, cb) {
return this.request("CreateShipper", req, cb);
}
/**
* 本接口用于删除Agent应用
*/
async DeleteAgentApplication(req, cb) {
return this.request("DeleteAgentApplication", req, cb);
}
/**
* 删除投递Ckafka任务
*/
async DeleteConsumer(req, cb) {
return this.request("DeleteConsumer", req, cb);
}
/**
* 本接口用于kafka投递数据预览
*/
async DescribeConsumerPreview(req, cb) {
return this.request("DescribeConsumerPreview", req, cb);
}
/**
* 删除机器组
*/
async DeleteMachineGroup(req, cb) {
return this.request("DeleteMachineGroup", req, cb);
}
/**
* 删除es导入配置
*/
async DeleteEsRecharge(req, cb) {
return this.request("DeleteEsRecharge", req, cb);
}
/**
* 消费组心跳
*/
async SendConsumerHeartbeat(req, cb) {
return this.request("SendConsumerHeartbeat", req, cb);
}
/**
* 本接口用于删除cos导入任务
*/
async DeleteCosRecharge(req, cb) {
return this.request("DeleteCosRecharge", req, cb);
}
/**
* 获取Kafka协议消费组信息列表
*/
async DescribeKafkaConsumerGroupList(req, cb) {
return this.request("DescribeKafkaConsumerGroupList", req, cb);
}
/**
* 修改splunk投递任务相关信息
*/
async ModifySplunkDeliver(req, cb) {
return this.request("ModifySplunkDeliver", req, cb);
}
/**
* 本接口用于获取Kafka数据订阅任务
*/
async DescribeKafkaRecharges(req, cb) {
return this.request("DescribeKafkaRecharges", req, cb);
}
/**
* 删除RemoteWrite任务
*/
async DeleteRemoteWriteTask(req, cb) {
return this.request("DeleteRemoteWriteTask", req, cb);
}
/**
* 本接口用于获取告警策略列表。
*/
async DescribeAlarms(req, cb) {
return this.request("DescribeAlarms", req, cb);
}
/**
* 本接口用于获取cos导入配置
*/
async DescribeCosRecharges(req, cb) {
return this.request("DescribeCosRecharges", req, cb);
}
/**
* 应用采集配置到指定机器组
*/
async ApplyConfigToMachineGroup(req, cb) {
return this.request("ApplyConfigToMachineGroup", req, cb);
}
/**
* 本接口用于创建仪表盘
*/
async CreateDashboard(req, cb) {
return this.request("CreateDashboard", req, cb);
}
/**
* 该接口用于删除告警屏蔽规则。当告警屏蔽规则在生效中或者是在失效中，无法被删除
*/
async DeleteAlarmShield(req, cb) {
return this.request("DeleteAlarmShield", req, cb);
}
/**
* 获取指标订阅配置
*/
async DescribeMetricCorrectDimension(req, cb) {
return this.request("DescribeMetricCorrectDimension", req, cb);
}
/**
* 本接口用于构建日志数量直方图
*/
async DescribeLogHistogram(req, cb) {
return this.request("DescribeLogHistogram", req, cb);
}
/**
* 该接口用于修改通知渠道组
*/
async ModifyAlarmNotice(req, cb) {
return this.request("ModifyAlarmNotice", req, cb);
}
/**
* 删除查询视图
*/
async DeleteSearchView(req, cb) {
return this.request("DeleteSearchView", req, cb);
}
/**
* 打开Kafka协议消费功能
*/
async OpenKafkaConsumer(req, cb) {
return this.request("OpenKafkaConsumer", req, cb);
}
/**
* 本接口用于删除仪表盘
*/
async DeleteDashboard(req, cb) {
return this.request("DeleteDashboard", req, cb);
}
/**
* 修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
*/
async ModifyShipper(req, cb) {
return this.request("ModifyShipper", req, cb);
}
/**
* 此接口用于修改仪表盘订阅
*/
async ModifyDashboardSubscribe(req, cb) {
return this.request("ModifyDashboardSubscribe", req, cb);
}
/**
* 本接口用于修改仪表盘
*/
async ModifyDashboard(req, cb) {
return this.request("ModifyDashboard", req, cb);
}
/**
* 创建网络应用
*/
async CreateNetworkApplication(req, cb) {
return this.request("CreateNetworkApplication", req, cb);
}
/**
* 该接口用于删除告警渠道回调配置。
*/
async DeleteWebCallback(req, cb) {
return this.request("DeleteWebCallback", req, cb);
}
/**
* 本接口用于预览Kafka数据订阅任务客户日志信息
*/
async PreviewKafkaRecharge(req, cb) {
return this.request("PreviewKafkaRecharge", req, cb);
}
/**
* 关闭Kafka协议消费
*/
async CloseKafkaConsumer(req, cb) {
return this.request("CloseKafkaConsumer", req, cb);
}
/**
* 本接口用于修改特殊采集配置任务，特殊采集配置应用于自建K8S环境的采集Agent
*/
async ModifyConfigExtra(req, cb) {
return this.request("ModifyConfigExtra", req, cb);
}
/**
* 查询DataSight控制台实例列表
*/
async DescribeConsoles(req, cb) {
return this.request("DescribeConsoles", req, cb);
}
/**
* 此接口用于预览仪表盘订阅
*/
async SearchDashboardSubscribe(req, cb) {
return this.request("SearchDashboardSubscribe", req, cb);
}
/**
* 本接口用于创建特殊采集配置任务，特殊采集配置应用于自建K8S环境的采集Agent
*/
async CreateConfigExtra(req, cb) {
return this.request("CreateConfigExtra", req, cb);
}
/**
* 创建主机指标采集配置
*/
async CreateHostMetricConfig(req, cb) {
return this.request("CreateHostMetricConfig", req, cb);
}
/**
* 获取重建索引任务列表
*/
async DescribeRebuildIndexTasks(req, cb) {
return this.request("DescribeRebuildIndexTasks", req, cb);
}
/**
* 修改采集规则配置
*/
async ModifyConfig(req, cb) {
return this.request("ModifyConfig", req, cb);
}
/**
* 获取告警屏蔽配置规则
*/
async DescribeAlarmShields(req, cb) {
return this.request("DescribeAlarmShields", req, cb);
}
/**
* 本接口用于修改定时SQL分析任务
*/
async ModifyScheduledSql(req, cb) {
return this.request("ModifyScheduledSql", req, cb);
}
/**
* 本接口用于删除预聚合分析任务
*/
async DeleteRecordingRuleTask(req, cb) {
return this.request("DeleteRecordingRuleTask", req, cb);
}
/**
* 创建机器组
*/
async CreateMachineGroup(req, cb) {
return this.request("CreateMachineGroup", req, cb);
}
/**
* 用于删除机器组信息
*/
async DeleteMachineGroupInfo(req, cb) {
return this.request("DeleteMachineGroupInfo", req, cb);
}
/**
* 批量查询控制台分享列表
*/
async DescribeConsoleSharingList(req, cb) {
return this.request("DescribeConsoleSharingList", req, cb);
}
/**
* 提交消费点位
*/
async CommitConsumerOffsets(req, cb) {
return this.request("CommitConsumerOffsets", req, cb);
}
/**
* 创建控制台分享
*/
async CreateConsoleSharing(req, cb) {
return this.request("CreateConsoleSharing", req, cb);
}
/**
* 本接口用于获取日志集信息列表。
*/
async DescribeLogsets(req, cb) {
return this.request("DescribeLogsets", req, cb);
}
/**
* 此接口用于创建仪表盘订阅
*/
async CreateDashboardSubscribe(req, cb) {
return this.request("CreateDashboardSubscribe", req, cb);
}
/**
* 获取指标订阅配置
*/
async DescribeTopicBaseMetricConfigs(req, cb) {
return this.request("DescribeTopicBaseMetricConfigs", req, cb);
}
/**
* 该接口用于修改通知内容配置
*/
async ModifyNoticeContent(req, cb) {
return this.request("ModifyNoticeContent", req, cb);
}
/**
* 创建remote write投递任务
*/
async CreateRemoteWriteTask(req, cb) {
return this.request("CreateRemoteWriteTask", req, cb);
}
/**
* 本接口用于获取索引配置信息
*/
async DescribeIndex(req, cb) {
return this.request("DescribeIndex", req, cb);
}
/**
* 通过yaml文件创建指标预聚合任务
*/
async CreateRecordingRuleYamlTask(req, cb) {
return this.request("CreateRecordingRuleYamlTask", req, cb);
}
/**
* 本接口用于删除DataSight控制台
*/
async DeleteConsole(req, cb) {
return this.request("DeleteConsole", req, cb);
}
/**
* 本接口用于修改Kafka数据订阅任务
*/
async ModifyKafkaRecharge(req, cb) {
return this.request("ModifyKafkaRecharge", req, cb);
}
/**
* 获取告警渠道回调配置列表。
*/
async DescribeWebCallbacks(req, cb) {
return this.request("DescribeWebCallbacks", req, cb);
}
/**
* 获取Splunk投递任务列表
*/
async DescribeSplunkDelivers(req, cb) {
return this.request("DescribeSplunkDelivers", req, cb);
}
/**
* 该接口用于创建通知渠道组，提供两种配置模式，二选一：
1，简易模式，提供最基本的通知渠道功能。需填写如下参数：
- Type
- NoticeReceivers
- WebCallbacks
2，高级模式，在简易模式基础上，支持设定规则，为不同类型的告警分别设定通知渠道，并支持告警升级功能。需填写如下参数：
- NoticeRules
*/
async CreateAlarmNotice(req, cb) {
return this.request("CreateAlarmNotice", req, cb);
}
/**
* 更新消费组信息
*/
async ModifyConsumerGroup(req, cb) {
return this.request("ModifyConsumerGroup", req, cb);
}
/**
* 此接口用于删除仪表盘订阅
*/
async DeleteDashboardSubscribe(req, cb) {
return this.request("DeleteDashboardSubscribe", req, cb);
}
/**
* 创建重建索引任务
注意：
- 单个日志主题同时仅允许运行一个重建索引任务，单个日志主题最多同时拥有10个重建索引任务记录，需删除不再需要的任务记录后才能新建索引任务。
- 同一时间范围内的日志，仅允许重建一次索引，需删除之前的任务记录后才能再次重建。
- 删除重建索引任务记录将恢复重建索引前的索引数据。
- 所选时间范围对应日志写流量不能超出5TB。
- 重建索引时间范围以日志时间为准，日志上传时间与重建索引时间范围有超过1小时的偏差时（例如16:00上传了一条02:00的日志到 CLS，重建00:00～12:00的日志索引）不会被重建且后续无法进行检索。新上报一条日志到已经被重建的日志时间范围时，也不会被重建且后续无法进行检索。
*/
async CreateRebuildIndexTask(req, cb) {
return this.request("CreateRebuildIndexTask", req, cb);
}
/**
* 本接口用于检索分析日志，使用该接口时请注意如下事项：
1. 该接口除受默认接口请求频率限制外，针对单个日志主题，查询并发数不能超过15。
2. API返回数据包最大49MB，建议启用 gzip 压缩（HTTP Request Header Accept-Encoding:gzip）。
*/
async SearchLog(req, cb) {
return this.request("SearchLog", req, cb);
}
/**
* 本接口用于修改日志或指标主题。
*/
async ModifyTopic(req, cb) {
return this.request("ModifyTopic", req, cb);
}
/**
* 删除指标采集配置
*/
async DeleteMetricConfig(req, cb) {
return this.request("DeleteMetricConfig", req, cb);
}
/**
* 创建Splunk投递任务
*/
async CreateSplunkDeliver(req, cb) {
return this.request("CreateSplunkDeliver", req, cb);
}
/**
* 本接口用于创建数据加工任务。
*/
async CreateDataTransform(req, cb) {
return this.request("CreateDataTransform", req, cb);
}
/**
* 用于添加机器组信息
*/
async AddMachineGroupInfo(req, cb) {
return this.request("AddMachineGroupInfo", req, cb);
}
/**
* 该接口用于删除通知内容配置
*/
async DeleteNoticeContent(req, cb) {
return this.request("DeleteNoticeContent", req, cb);
}
/**
* 删除控制台分享
*/
async DeleteConsoleSharing(req, cb) {
return this.request("DeleteConsoleSharing", req, cb);
}
/**
* 本接口用于删除日志主题的索引配置，删除索引配置后将无法检索和查询采集到的日志。
*/
async DeleteIndex(req, cb) {
return this.request("DeleteIndex", req, cb);
}
/**
* 该接口已废弃，如需获取分区数量，请使用DescribeTopics接口。
*/
async DescribePartitions(req, cb) {
return this.request("DescribePartitions", req, cb);
}
/**
* 本接口用于创建日志集，返回新创建的日志集的 ID。
*/
async CreateLogset(req, cb) {
return this.request("CreateLogset", req, cb);
}
/**
* 本接口用于数据加工DSL函数的语法校验。
*/
async CheckFunction(req, cb) {
return this.request("CheckFunction", req, cb);
}
/**
* 本接口用于编辑DataSight控制台
*/
async ModifyConsole(req, cb) {
return this.request("ModifyConsole", req, cb);
}
/**
* 本接口用于获取yaml预聚合任务列表
*/
async DescribeRecordingRuleYamlTask(req, cb) {
return this.request("DescribeRecordingRuleYamlTask", req, cb);
}
/**
* 本接口用于修改投递Ckafka任务
*/
async ModifyConsumer(req, cb) {
return this.request("ModifyConsumer", req, cb);
}
/**
* 本接口用于修改定时预聚合任务
*/
async ModifyRecordingRuleTask(req, cb) {
return this.request("ModifyRecordingRuleTask", req, cb);
}
/**
* 获取agent对应的采集配置
*/
async DescribeAgentConfigs(req, cb) {
return this.request("DescribeAgentConfigs", req, cb);
}
/**
* 删除投递COS任务
*/
async DeleteShipper(req, cb) {
return this.request("DeleteShipper", req, cb);
}
/**
* 该接口用于修改告警渠道回调配置。
*/
async ModifyWebCallback(req, cb) {
return this.request("ModifyWebCallback", req, cb);
}
/**
* 本接口用于预览aws导入信息
*/
async SearchS3RechargeInfo(req, cb) {
return this.request("SearchS3RechargeInfo", req, cb);
}
/**
* 该接口用于创建告警渠道回调配置。
*/
async CreateWebCallback(req, cb) {
return this.request("CreateWebCallback", req, cb);
}
/**
* 查询指定时间范围内指标的变化趋势
*/
async QueryRangeMetric(req, cb) {
return this.request("QueryRangeMetric", req, cb);
}
/**
* 获取采集规则配置所绑定的机器组
*/
async DescribeConfigMachineGroups(req, cb) {
return this.request("DescribeConfigMachineGroups", req, cb);
}
/**
* 本接口用于创建aws导入任务
*/
async CreateS3Recharge(req, cb) {
return this.request("CreateS3Recharge", req, cb);
}
/**
* 本接口用于删除日志下载任务
*/
async DeleteExport(req, cb) {
return this.request("DeleteExport", req, cb);
}
/**
* 调用接口，发起一次对话请求。
本接口支持智能生成检索分析语句等日志服务AI功能。
⚠️注意：通过SSE流式调用此接口时，请务必设置请求域名（Endpoint）为 cls.ai.tencentcloudapi.com (VPC内网环境可配置 cls.ai.internal.tencentcloudapi.com）。
*/
async ChatCompletions(req, cb) {
return this.request("ChatCompletions", req, cb);
}
/**
* 该接口已废弃，如需修改分区数量，请使用ModifyTopic接口。
*/
async SplitPartition(req, cb) {
return this.request("SplitPartition", req, cb);
}
/**
* 本接口用于获取数据加工任务列表基本信息
*/
async DescribeDataTransformInfo(req, cb) {
return this.request("DescribeDataTransformInfo", req, cb);
}
/**
* 获取机器组信息列表
*/
async DescribeMachineGroups(req, cb) {
return this.request("DescribeMachineGroups", req, cb);
}
/**
* 本接口用于创建投递CKafka任务
*/
async CreateConsumer(req, cb) {
return this.request("CreateConsumer", req, cb);
}
/**
* 创建指标预聚合任务
*/
async CreateRecordingRuleTask(req, cb) {
return this.request("CreateRecordingRuleTask", req, cb);
}
/**
* 本接口用于获取预聚合任务列表
*/
async DescribeRecordingRuleTask(req, cb) {
return this.request("DescribeRecordingRuleTask", req, cb);
}
/**
* 本接口用于获取仪表盘订阅列表，支持分页
*/
async DescribeDashboardSubscribes(req, cb) {
return this.request("DescribeDashboardSubscribes", req, cb);
}
/**
* 获取投递任务列表
*/
async DescribeShipperTasks(req, cb) {
return this.request("DescribeShipperTasks", req, cb);
}
/**
* 本接口用于删除aws导入任务
*/
async DeleteS3Recharge(req, cb) {
return this.request("DeleteS3Recharge", req, cb);
}
/**
* 修改机器组。
注意：修改接口直接覆盖历史数据，改为本次合法入参数据，请谨慎调用此接口。
*/
async ModifyMachineGroup(req, cb) {
return this.request("ModifyMachineGroup", req, cb);
}
/**
* 获取消费组列表
*/
async DescribeConsumerGroups(req, cb) {
return this.request("DescribeConsumerGroups", req, cb);
}
/**
* 本接口用于获取kafka协议消费主题信息列表
*/
async DescribeKafkaConsumerTopics(req, cb) {
return this.request("DescribeKafkaConsumerTopics", req, cb);
}
/**
* 本接口用于删除yaml预聚合任务
*/
async DeleteRecordingRuleYamlTask(req, cb) {
return this.request("DeleteRecordingRuleYamlTask", req, cb);
}
/**
* 该接口用于修改告警屏蔽规则。当告警屏蔽规则为失效中时，无法对其进行修改
*/
async ModifyAlarmShield(req, cb) {
return this.request("ModifyAlarmShield", req, cb);
}
/**
* 本接口用于获取定时SQL分析任务列表
*/
async DescribeScheduledSqlInfo(req, cb) {
return this.request("DescribeScheduledSqlInfo", req, cb);
}
/**
* 删除采集规则配置
*/
async DeleteConfig(req, cb) {
return this.request("DeleteConfig", req, cb);
}
/**
* 本接口用于获取特殊采集配置，特殊采集配置应用于自建K8S环境的采集Agent
*/
async DescribeConfigExtras(req, cb) {
return this.request("DescribeConfigExtras", req, cb);
}
/**
* 本接口用于校验Kafka服务集群是否可以正常访问
*/
async CheckRechargeKafkaServer(req, cb) {
return this.request("CheckRechargeKafkaServer", req, cb);
}
/**
* 通过yaml文件修改指标预聚合任务
*/
async ModifyRecordingRuleYamlTask(req, cb) {
return this.request("ModifyRecordingRuleYamlTask", req, cb);
}
/**
* 本接口用于修改告警策略。需要至少修改一项有效内容。
*/
async ModifyAlarm(req, cb) {
return this.request("ModifyAlarm", req, cb);
}
/**
* 获取投递到COS的任务配置信息
*/
async DescribeShippers(req, cb) {
return this.request("DescribeShippers", req, cb);
}
/**
* 修改Kafka协议消费组点位
*/
async ModifyKafkaConsumerGroupOffset(req, cb) {
return this.request("ModifyKafkaConsumerGroupOffset", req, cb);
}
/**
* 修改控制台分享，目前仅允许修改有效期
*/
async ModifyConsoleSharing(req, cb) {
return this.request("ModifyConsoleSharing", req, cb);
}
/**
* 本接口用于创建Agent应用
*/
async CreateAgentApplication(req, cb) {
return this.request("CreateAgentApplication", req, cb);
}
/**
* 获取指标订阅配置
*/
async DescribeMetricSubscribes(req, cb) {
return this.request("DescribeMetricSubscribes", req, cb);
}
/**
* 本接口用于修改Agent应用
*/
async ModifyAgentApplication(req, cb) {
return this.request("ModifyAgentApplication", req, cb);
}
/**
* 获取时序label values列表
*/
async GetMetricLabelValues(req, cb) {
return this.request("GetMetricLabelValues", req, cb);
}
/**
* 获取投递规则信息列表
*/
async DescribeConsumers(req, cb) {
return this.request("DescribeConsumers", req, cb);
}
/**
* 删除网络应用
*/
async DeleteNetworkApplication(req, cb) {
return this.request("DeleteNetworkApplication", req, cb);
}
/**
* 获取Agent应用列表
*/
async DescribeAgentApplications(req, cb) {
return this.request("DescribeAgentApplications", req, cb);
}
/**
* 获取Kafka协议消费组详情
*/
async DescribeKafkaConsumerGroupDetail(req, cb) {
return this.request("DescribeKafkaConsumerGroupDetail", req, cb);
}
/**
* 本接口用于获取仪表盘
*/
async DescribeDashboards(req, cb) {
return this.request("DescribeDashboards", req, cb);
}
/**
* 该接口用于删除通知渠道组
*/
async DeleteAlarmNotice(req, cb) {
return this.request("DeleteAlarmNotice", req, cb);
}
/**
* 本接口用于修改cos导入任务
*/
async ModifyCosRecharge(req, cb) {
return this.request("ModifyCosRecharge", req, cb);
}
/**
* 本接口获取RemoteWrite投递任务列表
*/
async DescribeRemoteWriteTasks(req, cb) {
return this.request("DescribeRemoteWriteTasks", req, cb);
}
/**
* ## 提示
为了保障您日志数据的可靠性以及更高效地使用日志服务，建议您使用CLS优化后的接口[上传结构化日志](https://cloud.tencent.com/document/product/614/16873)。
同时我们给此接口专门优化定制了多个语言版本的SDK供您选择，SDK提供统一的异步发送、资源控制、自动重试、优雅关闭、感知上报等功能，使上报日志功能更完善，详情请参考[SDK采集](https://cloud.tencent.com/document/product/614/67157)。
同时云API上传日志接口也支持同步上传日志数据，如果您选择继续使用此接口请参考下文。
## 功能描述
本接口用于将日志写入到指定的日志主题。
#### 输入参数(pb二进制流，位于body中)
| 字段名 | 类型 | 位置 | 必须 | 含义 |
| ------------ | ------- | ---- | ---- | ------------------------------------------------------------ |
| logGroupList | message | pb | 是 | logGroup 列表，封装好的日志组列表内容，建议 logGroup 数量不要超过5个 |
LogGroup 说明：
| 字段名 | 是否必选 | 含义 |
| ----------- | -------- | ------------------------------------------------------------ |
| logs | 是 | 日志数组，表示有多个 Log 组成的集合，一个 Log 表示一条日志，一个 LogGroup 中 Log 个数不能超过10000 |
| contextFlow | 否 | LogGroup 的唯一ID，需要使用上下文功能时传入。格式："{上下文ID}-{LogGroupID}"。<br>上下文ID：唯一标识一个上下文（连续滚动的一系列日志文件，或者是需要保序的一系列日志），16进制64位整型字符串。<br>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 头文件引入代码中，调用接口进行数据格式封装。
*/
async UploadLog(req, cb) {
return this.request("UploadLog", req, cb);
}
/**
* 本接口用于创建定时SQL分析任务
*/
async CreateScheduledSql(req, cb) {
return this.request("CreateScheduledSql", req, cb);
}
/**
* 本接口用于修改日志集信息
*/
async ModifyLogset(req, cb) {
return this.request("ModifyLogset", req, cb);
}
/**
* 该接口用于创建通知内容。
*/
async CreateNoticeContent(req, cb) {
return this.request("CreateNoticeContent", req, cb);
}
/**
* 获取机器组绑定的采集规则配置
*/
async DescribeMachineGroupConfigs(req, cb) {
return this.request("DescribeMachineGroupConfigs", req, cb);
}
/**
* 本接口用于修改数据加工任务
*/
async ModifyDataTransform(req, cb) {
return this.request("ModifyDataTransform", req, cb);
}
/**
* 本接口用于创建DataSight控制台
*/
async CreateConsole(req, cb) {
return this.request("CreateConsole", req, cb);
}
/**
* 本接口用于删除告警策略。
*/
async DeleteAlarm(req, cb) {
return this.request("DeleteAlarm", req, cb);
}
/**
* 修改查询视图
*/
async ModifySearchView(req, cb) {
return this.request("ModifySearchView", req, cb);
}
/**
* 本接口用于搜索日志上下文附近的内容，详情参考[上下文检索](https://cloud.tencent.com/document/product/614/53248)。
API返回数据包最大49MB，建议启用 gzip 压缩（HTTP Request Header Accept-Encoding:gzip）。
*/
async DescribeLogContext(req, cb) {
return this.request("DescribeLogContext", req, cb);
}
/**
* 本接口用于获取投递配置
*/
async DescribeConsumer(req, cb) {
return this.request("DescribeConsumer", req, cb);
}
/**
* 创建指标采集配置
*/
async CreateMetricConfig(req, cb) {
return this.request("CreateMetricConfig", req, cb);
}
/**
* 获取通知内容列表
*/
async DescribeNoticeContents(req, cb) {
return this.request("DescribeNoticeContents", req, cb);
}
/**
* 创建指标采集配置
*/
async ModifyMetricConfig(req, cb) {
return this.request("ModifyMetricConfig", req, cb);
}
/**
* 获取指定机器组下的机器状态
*/
async DescribeMachines(req, cb) {
return this.request("DescribeMachines", req, cb);
}
/**
* 重试失败的投递任务
*/
async RetryShipperTask(req, cb) {
return this.request("RetryShipperTask", req, cb);
}
/**
* 获取Kafka协议消费信息
*/
async DescribeKafkaConsumer(req, cb) {
return this.request("DescribeKafkaConsumer", req, cb);
}
/**
* 本接口用于创建告警策略。
*/
async CreateAlarm(req, cb) {
return this.request("CreateAlarm", req, cb);
}
/**
* 本接口用于删除日志或指标主题。
*/
async DeleteTopic(req, cb) {
return this.request("DeleteTopic", req, cb);
}
/**
* 修改RemoteWrite任务
*/
async ModifyRemoteWriteTask(req, cb) {
return this.request("ModifyRemoteWriteTask", req, cb);
}
}
exports.Client = Client;