///
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 高级过滤规则 */
declare interface AdvanceFilterRuleInfo {
/** 过滤字段 */
Key: string;
/** 过滤规则,0:等于,1:字段存在,2:字段不存在 */
Rule: number;
/** 过滤值 */
Value?: string;
}
/** 投递Ckafka 高级配置 */
declare interface AdvancedConsumerConfiguration {
/** Ckafka分区hash状态。 默认 false- true:开启根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区- false:关闭根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区 */
PartitionHashStatus?: boolean;
/** 需要计算 hash 的字段列表。最大支持5个字段。 */
PartitionFields?: string[];
}
/** 告警多维分析一些配置信息 */
declare interface AlarmAnalysisConfig {
/** 键。支持以下key:SyntaxRule:语法规则,value支持 0:Lucene语法;1: CQL语法。QueryIndex:执行语句序号。value支持 -1:自定义; 1:执行语句1; 2:执行语句2。CustomQuery:检索语句。 QueryIndex为-1时有效且必填,value示例: "* | select count(*) as count"。Fields:字段。value支持 __SOURCE__;__FILENAME__;__HOSTNAME__;__TIMESTAMP__;__INDEX_STATUS__;__PKG_LOGID__;__TOPIC__。Format:显示形式。value支持 1:每条日志一行;2:每条日志每个字段一行。Limit:最大日志条数。 value示例: 5。 */
Key: string;
/** 值。键对应值如下:SyntaxRule:语法规则,value支持 0:Lucene语法;1: CQL语法。QueryIndex:执行语句序号。value支持 -1:自定义; 1:执行语句1; 2:执行语句2。CustomQuery:检索语句。 QueryIndex为-1时有效且必填,value示例: "* | select count(*) as count"。Fields:字段。value支持 __SOURCE__;__FILENAME__;__HOSTNAME__;__TIMESTAMP__;__INDEX_STATUS__;__PKG_LOGID__;__TOPIC__。Format:显示形式。value支持 1:每条日志一行;2:每条日志每个字段一行。Limit:最大日志条数。 value示例: 5。 */
Value: string;
}
/** 告警分类信息 */
declare interface AlarmClassification {
/** 分类键 */
Key: string;
/** 分类值 */
Value: string;
}
/** 告警策略描述 */
declare interface AlarmInfo {
/** 告警策略名称。 */
Name?: string;
/** 监控对象列表。 */
AlarmTargets?: AlarmTargetInfo[];
/** 监控任务运行时间点。 */
MonitorTime?: MonitorTime;
/** 是否触发告警的单触发条件。与MultiConditions参数互斥。 */
Condition?: string;
/** 持续周期。持续满足触发条件TriggerCount个周期后,再进行告警;最小值为1,最大值为10。 */
TriggerCount?: number;
/** 告警重复的周期。单位是min。取值范围是0~1440。 */
AlarmPeriod?: number;
/** 关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表,和MonitorNotice互斥 */
AlarmNoticeIds?: string[];
/** 开启状态。 */
Status?: boolean;
/** 告警策略ID。 */
AlarmId?: string;
/** 创建时间。格式: YYYY-MM-DD HH:MM:SS */
CreateTime?: string;
/** 最近更新时间。格式: YYYY-MM-DD HH:MM:SS */
UpdateTime?: string;
/** 自定义通知模板 */
MessageTemplate?: string | null;
/** 自定义回调模板 */
CallBack?: CallBackInfo;
/** 多维分析设置 */
Analysis?: AnalysisDimensional[];
/** 分组触发状态。true:开启,false:关闭(默认) */
GroupTriggerStatus?: boolean;
/** 分组触发条件。 */
GroupTriggerCondition?: string[];
/** 告警策略绑定的标签信息。 */
Tags?: Tag[];
/** 监控对象类型。0:执行语句共用监控对象;1:每个执行语句单独选择监控对象。 */
MonitorObjectType?: number;
/** 告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)。 */
AlarmLevel?: number;
/** 告警附加分类字段。 */
Classifications?: AlarmClassification[];
/** 多触发条件。与Condition互斥。 */
MultiConditions?: MultiCondition[];
/** 腾讯云可观测平台通知渠道相关信息,和AlarmNoticeIds互斥 */
MonitorNotice?: MonitorNotice;
}
/** 告警通知渠道组详细配置 */
declare interface AlarmNotice {
/** 告警通知渠道组名称。 */
Name?: string;
/** 告警通知渠道组绑定的标签信息。 */
Tags?: Tag[];
/** 告警模板的类型。可选值: Trigger - 告警触发 Recovery - 告警恢复 All - 告警触发和告警恢复 */
Type?: string;
/** 告警通知模板接收者信息。 */
NoticeReceivers?: NoticeReceiver[];
/** 告警通知模板回调信息。 */
WebCallbacks?: WebCallback[];
/** 告警通知模板ID。 */
AlarmNoticeId?: string;
/** 通知规则。 */
NoticeRules?: NoticeRule[];
/** 免登录操作告警开关。参数值: 1:关闭 2:开启(默认开启) */
AlarmShieldStatus?: number;
/** 调用链接域名。http:// 或者 https:// 开头,不能/结尾 */
JumpDomain?: string;
/** 投递相关信息。 */
AlarmNoticeDeliverConfig?: AlarmNoticeDeliverConfig | null;
/** 创建时间。格式: YYYY-MM-DD HH:MM:SS */
CreateTime?: string;
/** 最近更新时间。格式: YYYY-MM-DD HH:MM:SS */
UpdateTime?: string;
/** 投递日志开关。参数值:1:关闭2:开启 */
DeliverStatus?: number;
/** 投递日志标识。参数值:1:未启用2:已启用3:投递异常 */
DeliverFlag?: number;
/** 通知渠道组配置的告警屏蔽统计状态数量信息。 */
AlarmShieldCount?: AlarmShieldCount | null;
/** 统一设定自定义回调参数。- true: 使用通知内容模板中的自定义回调参数覆盖告警策略中单独配置的请求头及请求内容。- false:优先使用告警策略中单独配置的请求头及请求内容。 */
CallbackPrioritize?: boolean;
}
/** 通知渠道投递日志配置信息 */
declare interface AlarmNoticeDeliverConfig {
/** 通知渠道投递日志配置信息。 */
DeliverConfig?: DeliverConfig;
/** 投递失败原因。 */
ErrMsg?: string;
}
/** 告警屏蔽统计信息 */
declare interface AlarmShieldCount {
/** 符合检索条件的告警屏蔽总数量 */
TotalCount?: number;
/** 告警屏蔽未生效数量 */
InvalidCount?: number;
/** 告警屏蔽生效中数量 */
ValidCount?: number;
/** 告警屏蔽已过期数量 */
ExpireCount?: number;
}
/** 告警屏蔽任务配置 */
declare interface AlarmShieldInfo {
/** 通知渠道组Id */
AlarmNoticeId?: string;
/** 屏蔽规则id */
TaskId?: string;
/** 屏蔽开始时间(秒级时间戳)。 */
StartTime?: number;
/** 屏蔽结束时间(秒级时间戳)。 */
EndTime?: number;
/** 屏蔽类型。1:屏蔽所有通知,2:按照Rule参数屏蔽匹配规则的通知。 */
Type?: number;
/** 屏蔽规则,当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178)。 */
Rule?: string;
/** 屏蔽原因。 */
Reason?: string;
/** 规则创建来源。1. 控制台,2.api,3.告警通知 */
Source?: number;
/** 操作者。 */
Operator?: string;
/** 规则状态。0:暂未生效,1:生效中,2:已失效 */
Status?: number;
/** 规则创建时间。秒级时间戳(s) */
CreateTime?: number;
/** 规则更新时间。秒级时间戳(s) */
UpdateTime?: number;
}
/** 告警对象 */
declare interface AlarmTarget {
/** 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID */
TopicId: string;
/** 查询语句。 */
Query: string;
/** 告警对象序号;从1开始递增。 */
Number: number;
/** 查询范围起始时间相对于告警执行时间的偏移,单位为分钟,取值为非正,最大值为0,最小值为-1440。 */
StartTimeOffset: number;
/** 查询范围终止时间相对于告警执行时间的偏移,单位为分钟,取值为非正,须大于StartTimeOffset,最大值为0,最小值为-1440。 */
EndTimeOffset: number;
/** 日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID */
LogsetId: string;
/** 检索语法规则,默认值为0。0:Lucene语法,1:CQL语法。详细说明参见检索条件语法规则 */
SyntaxRule?: number;
}
/** 告警对象 */
declare interface AlarmTargetInfo {
/** 日志集ID。 */
LogsetId?: string;
/** 日志集名称。 */
LogsetName?: string;
/** 日志主题ID。 */
TopicId?: string;
/** 日志主题名称。 */
TopicName?: string;
/** 查询语句。 */
Query?: string;
/** 告警对象序号。 */
Number?: number;
/** 查询范围起始时间相对于告警执行时间的偏移,单位为分钟,取值为非正,最大值为0,最小值为-1440。 */
StartTimeOffset?: number;
/** 查询范围终止时间相对于告警执行时间的偏移,单位为分钟,取值为非正,须大于StartTimeOffset,最大值为0,最小值为-1440。 */
EndTimeOffset?: number;
/** 检索语法规则,默认值为0。0:Lucene语法,1:CQL语法。详细说明参见检索条件语法规则 */
SyntaxRule?: number;
/** 主题类型。0: 日志主题,1: 指标主题 */
BizType?: number;
}
/** 告警通知渠道组详情 */
declare interface AlertHistoryNotice {
/** 通知渠道组名称 */
Name: string;
/** 通知渠道组ID */
AlarmNoticeId: string;
}
/** 告警历史详情 */
declare interface AlertHistoryRecord {
/** 告警历史ID */
RecordId: string;
/** 告警策略ID */
AlarmId: string;
/** 告警策略名称 */
AlarmName: string;
/** 监控对象ID */
TopicId: string;
/** 监控对象名称 */
TopicName: string;
/** 监控对象所属地域 */
Region: string;
/** 触发条件 */
Trigger: string;
/** 持续周期,持续满足触发条件TriggerCount个周期后,再进行告警 */
TriggerCount: number;
/** 告警通知发送频率,单位为分钟(min) */
AlarmPeriod: number;
/** 通知渠道组 */
Notices: AlertHistoryNotice[];
/** 告警持续时间,单位为分钟(min) */
Duration: number;
/** 告警状态,0代表未恢复,1代表已恢复,2代表已失效 */
Status: number;
/** 告警发生时间,毫秒级Unix时间戳(ms) */
CreateTime: number;
/** 告警分组触发时对应的分组信息 */
GroupTriggerCondition?: GroupTriggerConditionInfo[];
/** 告警级别,0代表警告(Warn),1代表提醒(Info),2代表紧急 (Critical) */
AlarmLevel?: number;
/** 监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。 */
MonitorObjectType?: number;
/** 通知渠道类型,0默认代表cls内部通知渠道,1代表腾讯云可观测平台通知渠道 */
SendType?: number;
}
/** 多维分析的分析维度 */
declare interface AnalysisDimensional {
/** 分析名称 */
Name: string;
/** 分析类型:query(自定义检索分析),field(字段TOP5及占比统计) ,original(相关原始日志) */
Type: string;
/** 分析内容 */
Content: string;
/** 多维分析配置。当Analysis的Type字段为query(自定义)时,支持{"Key": "SyntaxRule", // 语法规则"Value": "1" //0:Lucene语法 ,1: CQL语法}当Analysis的Type字段为field(top5)时, 支持 { "Key": "QueryIndex", "Value": "-1" // -1:自定义, 1:执行语句1, 2:执行语句2},{ "Key": "CustomQuery", //检索语句。 QueryIndex为-1时有效且必填 "Value": "* | select count(*) as count"},{ "Key": "SyntaxRule", // 查不到这个字段也是老语法(Lucene) "Value": "0"//0:Lucene, 1:CQL} 当Analysis的Type字段为original(原始日志)时, 支持{ "Key": "Fields", "Value": "__SOURCE__,__HOSTNAME__,__TIMESTAMP__,__PKG_LOGID__,__TAG__.pod_ip"}, { "Key": "QueryIndex", "Value": "-1" // -1:自定义, 1:执行语句1, 2:执行语句2},{ "Key": "CustomQuery", // //检索语句。 QueryIndex为-1时有效且必填 "Value": "* | select count(*) as count"},{ "Key": "Format", //显示形式。1:每条日志一行,2:每条日志每个字段一行 "Value": "2"},{ "Key": "Limit", //最大日志条数 "Value": "5"},{ "Key": "SyntaxRule", // 查不到这个字段也是老语法 "Value": "0"//0:Lucene, 1:CQL} */
ConfigInfo?: AlarmAnalysisConfig[];
}
/** 免鉴权信息 */
declare interface AnonymousInfo {
/** 操作列表,支持trackLog(JS/HTTP上传日志 )和realtimeProducer(kafka协议上传日志) */
Operations?: string[];
/** 条件列表 */
Conditions?: ConditionInfo[];
}
/** 元数据Pod label标签结构体 */
declare interface AppointLabel {
/** 指定标签类型。- 0:所有Pod label,Keys字段无效- 1:指定Pod label,Keys字段不能为空 */
Type: number | null;
/** 元数据Pod标签的键。有效标签键有两个部分:可选前缀和名称,以斜杠 (/) 分隔。名称部分是必需的,并且必须不超过 63 个字符,以字母数字字符 ([a-z0-9A-Z]) 开头和结尾,中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定,前缀必须是 DNS 子域:一系列以点 (.) 分隔的 DNS 标签,总长度不超过 253 个字符,后跟斜杠 ( /)。- prefix 格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`- name 格式 `([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]`- key不能重复 */
Keys?: string[] | null;
}
/** 指标采集配置 */
declare interface BaseMetricCollectConfig {
/** 机器组id */
GroupId?: string | null;
/** 基础监控采集配置信息 */
Configs?: MetricCollectConfig[] | null;
}
/** 回调配置 */
declare interface CallBackInfo {
/** 回调时的Body。可将各类告警变量放在请求内容中,详见[帮助文档](https://cloud.tencent.com/document/product/614/74718)。如下示例:```{"TopicId": "{{ .QueryLog[0][0].topicId }}","key": "{{.Alarm}}","time": "{{ .QueryLog[0][0].time }}","log": "{{ .QueryLog[0][0].content.__CONTENT__ }}","namespace": "{{ .QueryLog[0][0].content.__TAG__.namespace }}"}``` */
Body: string;
/** 回调时的HTTP请求头部字段。例如:下面请求头部字段来告知服务器请求主体的内容类型为JSON。```"Content-Type: application/json"``` */
Headers?: string[];
}
/** CKafka的描述-需要投递到的kafka信息 */
declare interface Ckafka {
/** Ckafka 的 InstanceId。- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。- 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。 */
InstanceId: string;
/** Ckafka 的 TopicName。- 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。- 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。 */
TopicName: string;
/** Ckafka 的 Vip。- 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。- 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。 */
Vip?: string;
/** Ckafka 的 Vport。- 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。- 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。 */
Vport?: string;
/** Ckafka 的 InstanceName。- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。- 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。- 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。 */
InstanceName?: string;
/** Ckafka 的 TopicId。- 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。- 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。- 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。 */
TopicId?: string;
}
/** 云产品日志投递任务信息 */
declare interface CloudProductLogTaskInfo {
/** 日志服务地域 */
ClsRegion?: string;
/** 实例ID */
InstanceId?: string;
/** 日志集ID */
LogsetId?: string;
/** 日志主题ID */
TopicId?: string;
/** 日志配置拓展信息, 一般用于存储额外的日志投递配置 */
Extend?: string;
/** 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS */
LogType?: string;
/** 任务状态, 0创建中 1创建完成 2 删除中 */
Status?: number;
}
/** 采集配置信息 */
declare interface CollectConfig {
/** 指定采集类型的采集配置名称信息。当CollectInfo中Type为0:表示元数据配置,name为元数据名称。目前支持"container_id","container_name","image_name","namespace","pod_uid","pod_name","pod_ip"。当CollectInfo中Type为1:指定pod label,name为指定pod label名称。 */
Name: string;
}
/** 采集配置信息 */
declare interface CollectInfo {
/** 采集类型,必填字段。0:元数据配置。1:指定Pod Label。 */
Type: number;
/** 指定采集类型的采集配置信息。当Type为0时,CollectConfigs不允许为空。当Type为1时,CollectConfigs为空时,表示选择所有Pod Label;否则CollectConfigs为指定Pod Label。 */
CollectConfigs?: CollectConfig[];
}
/** 日志分析的列属性 */
declare interface Column {
/** 列的名字 */
Name?: string;
/** 列的属性 */
Type?: string;
}
/** 投递日志的压缩配置 */
declare interface CompressInfo {
/** 压缩格式,支持gzip、lzop、snappy和none不压缩 */
Format: string;
}
/** 免鉴权条件信息 */
declare interface ConditionInfo {
/** 条件属性,目前只支持VpcID */
Attributes?: string;
/** 条件规则,1:等于,2:不等于 */
Rule?: number;
/** 对应条件属性的值 */
ConditionValue?: string;
}
/** 特殊采集规则配置信息 */
declare interface ConfigExtraInfo {
/** 采集规则扩展配置ID */
ConfigExtraId?: string;
/** 采集规则名称 */
Name?: string;
/** 日志主题ID */
TopicId?: string;
/** 自建k8s集群日志采集类型,支持- container_stdout 标准输出- container_file 标准文件- host_file 节点文件 */
Type?: string;
/** 节点文件配置信息 */
HostFile?: HostFileInfo;
/** 容器文件路径信息 */
ContainerFile?: ContainerFileInfo;
/** 容器标准输出信息 */
ContainerStdout?: ContainerStdoutInfo;
/** 日志格式化方式 */
LogFormat?: string;
/** 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log */
LogType?: string;
/** 提取规则,如果设置了ExtractRule,则必须设置LogType */
ExtractRule?: ExtractRuleInfo;
/** 采集黑名单路径列表 */
ExcludePaths?: ExcludePathInfo[] | null;
/** 更新时间- 时间格式:yyyy-MM-dd HH:mm:ss */
UpdateTime?: string;
/** 创建时间- 时间格式:yyyy-MM-dd HH:mm:ss */
CreateTime?: string;
/** 用户自定义解析字符串 */
UserDefineRule?: string;
/** 机器组ID- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。 */
GroupId?: string;
/** 自建采集配置标 */
ConfigFlag?: string;
/** 日志集ID- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。 */
LogsetId?: string;
/** 日志集name */
LogsetName?: string;
/** 日志主题name */
TopicName?: string;
/** 采集相关配置信息。详情见 CollectInfo复杂类型配置。 */
CollectInfos?: CollectInfo[];
/** 高级采集配置。 Json字符串, Key/Value定义为如下:- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true} */
AdvancedConfig?: string;
}
/** 采集规则配置信息 */
declare interface ConfigInfo {
/** 采集规则配置ID */
ConfigId?: string;
/** 采集规则配置名称 */
Name?: string;
/** 日志格式化方式 */
LogFormat?: string;
/** 日志采集路径 */
Path?: string;
/** 采集的日志类型。- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310));- service_syslog代表:syslog 采集(详见[采集 Syslog](https://cloud.tencent.com/document/product/614/81454));- windows_event_log代表:Windows事件日志(详见[采集 Windows 事件日志](https://cloud.tencent.com/document/product/614/96678))。 */
LogType?: string;
/** 提取规则,如果设置了ExtractRule,则必须设置LogType */
ExtractRule?: ExtractRuleInfo;
/** 采集黑名单路径列表 */
ExcludePaths?: ExcludePathInfo[] | null;
/** 采集配置所属日志主题ID即TopicId */
Output?: string;
/** 更新时间- 时间格式:yyyy-MM-dd HH:mm:ss */
UpdateTime?: string;
/** 创建时间- 时间格式:yyyy-MM-dd HH:mm:ss */
CreateTime?: string;
/** 用户自定义解析字符串,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310)。 */
UserDefineRule?: string;
/** 高级采集配置。 Json字符串, Key/Value定义为如下:- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false样例:`{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}`控制台默认占位值:`{\"ClsAgentDefault\":0}` */
AdvancedConfig?: string;
/** 日志输入类型(注:windows场景必填且仅支持file和windows_event类型)- file: 文件类型采集- windows_event:windows事件采集- syslog:系统日志采集 */
InputType?: string;
}
/** 控制台分享配置 */
declare interface ConsoleSharingConfig {
/** 分享链接名称 */
Name: string;
/** 仪表盘: 1; 检索页:2 */
Type: number;
/** 分享链接有效期,单位:毫秒,最长支持30天 */
DurationMilliseconds: number;
/** 允许访问的资源列表,目前仅支持一个Resource */
Resources: string[];
/** 分享链接域名,可选范围- 公网匿名分享:填写clsshare.com- datasight内网匿名分享(若开启):datasight内网域名 */
Domain?: string | null;
/** 分享链接加密访问验证码。支持0-9和a-z(不区分大小写)在内的6个字符,可为空,代表免验证码访问 */
VerifyCode?: string | null;
/** 默认查询范围的开始时间点,支持绝对时间(13位Unix时间戳)或相对时间表达式 */
StartTime?: string;
/** 默认查询范围的结束时间点,支持绝对时间(13位Unix时间戳)或相对时间表达式。注意,结束时间点要大于开始时间点 */
EndTime?: string;
/** 仅当StartTime/EndTime为相对时间时使用,基于NowTime计算绝对时间,默认为创建时间 */
NowTime?: number | null;
/** 默认的检索分析语句,仅当Type为2时使用 */
Params?: ConsoleSharingParam[] | null;
/** 是否允许访问者自行修改检索分析时间范围。默认不锁定(false) */
IsLockTimeRange?: boolean;
/** 是否允许访问者自行修改日志检索语句。在检索页分享中表示检索语句锁定状态;在仪表盘中表示过滤变量锁定状态。默认不锁定(false) */
IsLockQuery?: boolean;
/** 检索页分享是否允许访问者下载日志,默认不允许(false) */
IsSupportLogExport?: boolean | null;
}
/** 控制台分享信息 */
declare interface ConsoleSharingInfo {
/** 分享ID */
SharingId: string;
/** 分享链接 */
SharingUrl?: string | null;
/** 匿名分享配置信息 */
SharingConfig?: ConsoleSharingConfig | null;
/** 过期时间 */
ExpiredTime?: number | null;
/** 创建时间 */
CreateTime?: number | null;
/** 修改时间 */
UpdateTime?: number | null;
/** 分享链接状态1: 正常 -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时) */
Status?: number | null;
/** 10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,24005-社会 */
ContentSafetyCode?: number | null;
}
/** 控制台分享链接params参数 */
declare interface ConsoleSharingParam {
/** 名称 */
Name?: string | null;
/** 值 */
Value?: string | null;
}
/** 投递任务出入参 Content */
declare interface ConsumerContent {
/** 是否投递 TAG 信息。当EnableTag为true时,表示投递TAG元信息。 */
EnableTag: boolean;
/** 需要投递的元数据列表,目前仅支持:\_\_SOURCE\_\_,\_\_FILENAME\_\_,\_\_TIMESTAMP\_\_,\_\_HOSTNAME\_\_和\_\_PKGID\_\_ */
MetaFields: string[];
/** 当EnableTag为true时,必须填写TagJsonNotTiled字段。TagJsonNotTiled用于标识tag信息是否json平铺。TagJsonNotTiled为true时不平铺,示例:TAG信息:`{"__TAG__":{"fieldA":200,"fieldB":"text"}}`不平铺:`{"__TAG__":{"fieldA":200,"fieldB":"text"}}`TagJsonNotTiled为false时平铺,示例:TAG信息:`{"__TAG__":{"fieldA":200,"fieldB":"text"}}`平铺:`{"__TAG__.fieldA":200,"__TAG__.fieldB":"text"}` */
TagJsonNotTiled?: boolean;
/** 投递时间戳精度,可选项 [1:秒;2:毫秒] ,默认是1。 */
TimestampAccuracy?: number;
/** 投递Json格式。JsonType为0:和原始日志一致,不转义。示例:日志原文:`{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}`投递到Ckafka:`{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}`JsonType为1:转义。示例:日志原文:`{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}`投递到Ckafka:`{"a":"aa","b":"{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}"}` */
JsonType?: number;
}
/** kafka协议消费组信息 */
declare interface ConsumerGroup {
/** 消费组名称 */
Group?: string;
/** 状态。- Empty:组内没有成员,但存在已提交的偏移量。所有消费者都离开但保留了偏移量- Dead:组内没有成员,且没有已提交的偏移量。组被删除或长时间无活动- Stable:组内成员正常消费,分区分配平衡。正常运行状态- PreparingRebalance:组正在准备重新平衡。有新成员加入或现有成员离开- CompletingRebalance:组正在准备重新平衡。有新成员加入或现有成员离开 */
State?: string;
/** 分区分配策略均衡算法名称。- 常见均衡算法如下: - range:按分区范围分配 - roundrobin:轮询式分配 - sticky:粘性分配(避免不必要的重平衡) */
ProtocolName?: string;
}
/** 消费组信息 */
declare interface ConsumerGroupInfo {
/** 消费组标识 */
ConsumerGroup?: string;
/** 消费者心跳超时时间(秒) */
Timeout?: number;
/** topic列表 */
Topics?: string[];
}
/** 投递规则 */
declare interface ConsumerInfo {
/** 投递规则ID */
ConsumerId?: string;
/** 日志主题ID */
TopicId?: string;
/** 投递任务是否生效 */
Effective?: boolean;
/** CKafka的描述 */
Ckafka?: Ckafka;
/** 是否投递日志的元数据信息 */
NeedContent?: boolean;
/** 如果需要投递元数据信息,元数据信息的描述 */
Content?: ConsumerContent | null;
/** 压缩方式[0:NONE;2:SNAPPY;3:LZ4] */
Compression?: number | null;
/** 投递任务创建毫秒时间戳 */
CreateTime?: number | null;
/** 角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381) */
RoleArn?: string | null;
/** 外部ID */
ExternalId?: string | null;
/** 任务运行状态。支持`0`,`1`,`2` - `0`: 停止 - `1`: 运行中 - `2`: 异常 */
TaskStatus?: number | null;
/** 高级配置 */
AdvancedConfig?: AdvancedConsumerConfiguration;
}
/** 自建k8s-容器文件路径信息 */
declare interface ContainerFileInfo {
/** namespace可以多个,用分隔号分割,例如A,B */
Namespace: string;
/** 容器名称 */
Container: string;
/** 日志文件夹 */
LogPath: string;
/** 日志名称 */
FilePattern: string;
/** 日志文件信息 */
FilePaths?: FilePathInfo[];
/** pod标签信息 */
IncludeLabels?: string[] | null;
/** 工作负载信息 */
WorkLoad?: ContainerWorkLoadInfo;
/** 需要排除的namespace可以多个,用分隔号分割,例如A,B */
ExcludeNamespace?: string;
/** 需要排除的pod标签信息 */
ExcludeLabels?: string[] | null;
/** metadata信息 */
CustomLabels?: string[] | null;
}
/** 自建k8s-容器标准输出信息 */
declare interface ContainerStdoutInfo {
/** 是否所有容器 */
AllContainers: boolean;
/** container为空表所有的,不为空采集指定的容器 */
Container?: string;
/** namespace可以多个,用分隔号分割,例如A,B;为空或者没有这个字段,表示所有namespace */
Namespace?: string;
/** pod标签信息 */
IncludeLabels?: string[] | null;
/** 工作负载信息 */
WorkLoads?: ContainerWorkLoadInfo[] | null;
/** 需要排除的namespace可以多个,用分隔号分割,例如A,B */
ExcludeNamespace?: string;
/** 需要排除的pod标签信息 */
ExcludeLabels?: string[] | null;
/** metadata信息 */
CustomLabels?: string[] | null;
}
/** 自建k8s-工作负载信息 */
declare interface ContainerWorkLoadInfo {
/** 工作负载的类型,支持的取值如下:- deployment:无状态应用部署控制器。可管理无状态应用的多副本 Pod;支持滚动更新和回滚,实现无缝发布;通过 ReplicaSet 确保指定数量的 Pod 副本持续运行。适合 Web 服务、API 服务、微服务等不需要持久化存储或唯一标识的应用。- statefulset:用于管理有状态应用的控制器。可以为每个 Pod 提供稳定的、唯一的标识(有序的主机名和网络标识);能提供稳定的持久化存储(PVC 随 Pod 的迁移而保留);Pod 的创建、扩展、删除和更新都遵循确定的顺序。适合数据库(MySQL、MongoDB)、消息队列(Kafka、RabbitMQ)、集群应用等需要稳定网络标识和持久化存储的应用。- daemonset:确保所有(或特定)节点上都运行一个 Pod 副本的控制器。会在每个符合条件的 Node 上自动部署并运行一个 Pod;当新节点加入集群时,会自动在新节点上创建 Pod;适合运行节点级别的后台任务或服务,例如日志收集(Fluentd、Filebeat)、节点监控(Node Exporter)、网络插件(Calico、Weave Net)等场景。- job:用于运行一次性任务的控制器。可创建一个或多个 Pod 来执行任务,直到成功完成;当任务完成后,Pod 不会重启(除非配置了重启策略);可以指定任务的并行度和重试次数。适合数据处理、批量任务、数据库迁移、离线计算等一次性执行完成后就退出的任务。- cronjob:基于时间调度的 Job 控制器。类似于 Linux 的 cron,按照预定的时间表周期性地创建并运行 Job。每个调度周期都会创建一个新的 Job 来执行任务。适合定期备份、发送报告、数据清理、定时同步等需要周期性执行的任务。 */
Kind: string;
/** 工作负载的名称 */
Name: string;
/** 容器名 */
Container?: string;
/** 命名空间 */
Namespace?: string;
}
/** 投递日志的内容格式配置 */
declare interface ContentInfo {
/** 内容格式,支持json,csv,parquet */
Format: string;
/** csv格式内容描述 */
Csv?: CsvInfo | null;
/** json格式内容描述 */
Json?: JsonInfo | null;
/** parquet格式内容描述 */
Parquet?: ParquetInfo | null;
}
/** cos导入配置信息 */
declare interface CosRechargeInfo {
/** COS导入配置ID */
Id?: string;
/** 日志主题ID */
TopicId?: string;
/** 日志集ID */
LogsetId?: string;
/** COS导入任务名称 */
Name?: string;
/** COS存储桶 */
Bucket?: string;
/** COS存储桶所在地域。- 通过[地域和访问域名](https://cloud.tencent.com/document/product/436/6224)获取地域信息。 */
BucketRegion?: string;
/** COS文件所在文件夹的前缀 */
Prefix?: string;
/** 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文;默认为minimalist_log */
LogType?: string;
/** 状态 status 0: 已创建, 1: 运行中, 2: 已停止, 3: 已完成, 4: 运行失败。 */
Status?: number;
/** 是否启用: 0: 未启用 , 1:启用 */
Enable?: number;
/** 创建时间。时间格式:YYYY-MM-DD HH:mm:ss */
CreateTime?: string;
/** 更新时间。时间格式:YYYY-MM-DD HH:mm:ss */
UpdateTime?: string;
/** 进度条百分值 */
Progress?: number;
/** 压缩方式supported: "", "gzip", "lzop", "snappy”; 默认空不压缩 */
Compress?: string;
/** 见: ExtractRuleInfo 结构描述 */
ExtractRuleInfo?: ExtractRuleInfo;
/** COS导入任务类型。1:一次性导入任务;2:持续性导入任务。 */
TaskType?: number;
/** 元数据。支持 bucket,object。 */
Metadata?: string[];
}
/** csv内容描述 */
declare interface CsvInfo {
/** csv首行是否打印key */
PrintKey: boolean;
/** 每列key的名字 */
Keys: string[] | null;
/** 各字段间的分隔符 */
Delimiter: string;
/** 若字段内容中包含分隔符,则使用该转义符包裹改字段,只能填写单引号、双引号、空字符串 */
EscapeChar: string;
/** 对于上面指定的不存在字段使用该内容填充 */
NonExistingField: string;
}
/** 自定义标签结构体 */
declare interface CustomLabel {
/** 标签的键。- 必须以字母或下划线开头,但不可以双下划线(__)开头,后面可以跟任意字母,数字或下划线。- 最大支持256个字符。- key不能重复 */
Key: string | null;
/** 标签的值。- 最大支持256个字符。 */
Value: string | null;
}
/** 自定义指标采集对象 */
declare interface CustomMetricSpec {
/** 端口。取值范围 [1,65535] */
Port: string | null;
/** Metric地址。校验格式:`^/[a-zA-Z0-9-_./]*$` */
Path: string | null;
/** 命名空间列表。- 最大支持100个- namespace 校验格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?` , 长度不能超过63- namespace 不能重复 */
Namespaces?: string[] | null;
/** Pod标签。- 最大支持100个 */
PodLabel?: Label[] | null;
}
/** 仪表盘信息 */
declare interface DashboardInfo {
/** 仪表盘id */
DashboardId?: string;
/** 仪表盘名字 */
DashboardName?: string;
/** 仪表盘数据 */
Data?: string;
/** 创建仪表盘的时间。格式:YYYY-MM-DD HH:MM:SS */
CreateTime?: string;
/** AssumerUin非空则表示创建该日志主题的服务方Uin */
AssumerUin?: number;
/** RoleName非空则表示创建该日志主题的服务方使用的角色 */
RoleName?: string;
/** AssumerName非空则表示创建该日志主题的服务方名称 */
AssumerName?: string;
/** 日志主题绑定的标签信息 */
Tags?: Tag[];
/** 仪表盘所在地域: 为了兼容老的地域。 */
DashboardRegion?: string;
/** 修改仪表盘的时间。格式:YYYY-MM-DD HH:MM:SS */
UpdateTime?: string;
/** 仪表盘对应的topic相关信息 */
DashboardTopicInfos?: DashboardTopicInfo[];
}
/** 仪表盘订阅通知方式 */
declare interface DashboardNoticeMode {
/** 仪表盘通知方式。- Uin:腾讯云用户- Group:腾讯云用户组- WeCom:企业微信回调- Email:自定义邮件- DingTalk:钉钉- Lark:飞书 */
ReceiverType: string;
/** 知方式对应的值。- 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Values必须为空,且Url字段必填。- 当ReceiverType为:`Uin`、`Group`、`Email` 时,Values必填,且Url字段必须为空。- 当ReceiverType为:`Uin ` 时,Values为用户id,通过 [拉取子用户](https://cloud.tencent.com/document/product/598/34587) 获取子用户 UID 。- 当ReceiverType为:`Group` 时,Values为用户组id,通过 [查询用户组列表](https://cloud.tencent.com/document/product/598/34589) 获取用户组 ID 。- 当ReceiverType为:`Email` 时,Values为用户邮箱信息。 */
Values?: string[];
/** 仪表盘通知渠道。- 支持:["Email","Sms","WeChat","Phone"]。- 当ReceiverType为 `Email` 或 `WeCom` 时,ReceiverChannels无效。 */
ReceiverChannels?: string[] | null;
/** 订阅方式 - 回调地址。- 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Url字段必填为各渠道的回调地址。 - 为:`WeCom` 时,Url为 企业微信回调地址。 - 为:`DingTalk` 时,Url为 钉钉机器人Webhook地址。 - 为:`Lark` 时,Url为 飞书机器人Webhook地址。- 当ReceiverType为:`Uin`、`Group`、`Email` 时,Url字段必须为空。 */
Url?: string;
}
/** 仪表盘订阅相关数据 */
declare interface DashboardSubscribeData {
/** 仪表盘订阅通知方式。 */
NoticeModes: DashboardNoticeMode[];
/** 仪表盘订阅时间,为空标识取仪表盘默认的时间。 */
DashboardTime?: string[] | null;
/** 仪表盘订阅模板变量。 */
TemplateVariables?: DashboardTemplateVariable[] | null;
/** 时区。参考:https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#SHANGHAI */
Timezone?: string;
/** 语言。 zh 中文、en`英文。 */
SubscribeLanguage?: string;
/** 调用链接域名。http:// 或者 https:// 开头,不能/结尾 */
JumpDomain?: string;
/** 自定义跳转链接。 */
JumpUrl?: string;
}
/** 仪表盘订阅信息 */
declare interface DashboardSubscribeInfo {
/** 仪表盘订阅id。 */
Id?: number;
/** 仪表盘订阅名称。 */
Name?: string;
/** 仪表盘id。 */
DashboardId?: string;
/** 仪表盘订阅时间。 */
Cron?: string;
/** 仪表盘订阅数据。 */
SubscribeData?: DashboardSubscribeData;
/** 仪表盘订阅记录创建时间。格式:`YYYY-MM-DD HH:MM:SS` */
CreateTime?: string;
/** 仪表盘订阅记录更新时间。格式:`YYYY-MM-DD HH:MM:SS` */
UpdateTime?: string;
/** 仪表盘订阅记录最后一次发送成功时间。格式:`YYYY-MM-DD HH:MM:SS` */
LastTime?: string;
/** 腾讯云主账号Id。 */
Uin?: number;
/** 腾讯云主账号下的子账号Id。 */
SubUin?: number;
/** 仪表盘订阅记录最后一次发送的状态。success:全部发送成功,fail:未发送, partialSuccess:部分发送成功。 */
LastStatus?: string;
}
/** 仪表盘订阅模板变量 */
declare interface DashboardTemplateVariable {
/** key的值 */
Key: string;
/** key对应的values取值values */
Values: string[];
}
/** 仪表盘关联的topic信息 */
declare interface DashboardTopicInfo {
/** 主题id */
TopicId: string;
/** topic所在的地域。- 1:广州- 4:上海- 5:中国香港- 7:上海金融- 8:北京- 9:新加坡- 11:深圳金融- 15:硅谷- 16:成都- 17:法兰克福- 18:首尔- 19:重庆- 22:弗吉尼亚- 23:曼谷- 25:东京- 33:南京- 36:天津- 39:台北- 46:北京金融- 72:雅加达- 74:圣保罗- 78:上海自动驾驶云 */
Region: string;
}
/** 数据加工的资源信息 */
declare interface DataTransformResouceInfo {
/** 日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 别名限制:不能包含字符 |。 */
Alias?: string;
}
/** 外部表SQL信息 */
declare interface DataTransformSqlDataSource {
/** 数据源类型 1:MySql;2:自建mysql;3:pgsql */
DataSource: number;
/** InstanceId所属地域。例如:ap-guangzhou */
Region: string;
/** 实例Id。- 当DataSource为1时,表示云数据库Mysql 实例id,如:cdb-zxcvbnm */
InstanceId: string;
/** mysql访问用户名 */
User: string;
/** 别名。数据加工语句中使用 */
AliasName: string;
/** mysql访问密码。 */
Password?: string;
}
/** 数据加工任务基本详情 */
declare interface DataTransformTaskInfo {
/** 数据加工任务名称 */
Name?: string;
/** 数据加工任务id */
TaskId?: string;
/** 任务启用状态,默认为1,正常开启, 2关闭 */
EnableFlag?: number;
/** 加工任务类型,1: DSL(使用自定义加工语言的加工任务), 2:SQL(使用sql的加工任务) */
Type?: number;
/** 源日志主题 */
SrcTopicId?: string;
/** 当前加工任务状态(1准备中/2运行中/3停止中/4已停止) */
Status?: number;
/** 创建时间时间格式:yyyy-MM-dd HH:mm:ss */
CreateTime?: string;
/** 最近修改时间时间格式:yyyy-MM-dd HH:mm:ss */
UpdateTime?: string;
/** 最后启用时间,如果需要重建集群,修改该时间时间格式:yyyy-MM-dd HH:mm:ss */
LastEnableTime?: string;
/** 日志主题名称 */
SrcTopicName?: string;
/** 日志集id */
LogsetId?: string;
/** 加工任务目的topic_id以及别名 */
DstResources?: DataTransformResouceInfo[];
/** 加工逻辑函数。 */
EtlContent?: string;
/** 兜底topic_id */
BackupTopicID?: string;
/** 超限之后是否丢弃日志数据 */
BackupGiveUpData?: boolean;
/** 是否开启投递服务日志。 1关闭,2开启 */
HasServicesLog?: number;
/** 任务目标日志主题数量 */
TaskDstCount?: number;
/** 数据加工类型。0:标准加工任务;1:前置加工任务。 */
DataTransformType?: number;
/** 保留失败日志状态。 1:不保留,2:保留 */
KeepFailureLog?: number;
/** 失败日志的字段名称 */
FailureLogKey?: string;
/** 指定加工数据的开始时间,秒级时间戳。- 日志主题生命周期内的任意时间范围,如果超出了生命周期,只处理生命周期内有数据的部分。 */
ProcessFromTimestamp?: number;
/** 指定加工数据的结束时间,秒级时间戳。1. 不可指定未来的时间2. 不填则表示持续执行 */
ProcessToTimestamp?: number;
/** sql数据源信息 */
DataTransformSqlDataSources?: DataTransformSqlDataSource[];
/** 环境变量 */
EnvInfos?: EnvInfo[];
}
/** 投递配置入参 */
declare interface DeliverConfig {
/** 地域信息。示例: ap-guangzhou 广州地域;ap-nanjing 南京地域。详细信息请查看官网[地域和访问域名](https://cloud.tencent.com/document/product/614/18940) */
Region: string;
/** 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID */
TopicId: string;
/** 投递数据范围。0: 全部日志, 包括告警策略日常周期执行的所有日志,也包括告警策略变更产生的日志,默认值1:仅告警触发及恢复日志 */
Scope: number;
}
/** 云产品实例维度信息 */
declare interface Dimension {
/** 实例维度名称,此字段可能返回 null,表示取不到有效值。 */
Name?: string | null;
/** 实例维度值,此字段可能返回 null,表示取不到有效值。 */
Value?: string | null;
}
/** 投递DLC任务配置信息 */
declare interface DlcDeliverInfo {
/** 任务id。 */
TaskId?: string;
/** 账号id。 */
Uin?: number;
/** 日志主题id。 */
TopicId?: string;
/** 任务名称。 */
Name?: string;
/** 投递类型,0:实时投递,1:历史投递 */
DeliverType?: number;
/** 投递文件大小,单位MB */
MaxSize?: number;
/** 投递间隔 单位秒 */
Interval?: number;
/** 投递时间范围的开始时间 */
StartTime?: number;
/** 投递时间范围的结束时间 */
EndTime?: number;
/** dlc配置信息 */
DlcInfo?: DlcInfo;
/** 是否开启投递服务日志。1关闭,2开启 */
HasServicesLog?: number;
/** 任务状态。 */
Status?: number;
/** 任务进度。历史投递任务生效。 */
Progress?: number;
/** 日志主题类型。0:标准主题,1:指标主题 */
BizType?: number;
/** 任务创建时间。 */
CreateTime?: number;
/** 任务修改时间。 */
UpdateTime?: number;
}
/** 数据湖计算服务(Data Lake Compute,简称DLC)数据字段配置信息 */
declare interface DlcFiledInfo {
/** cls日志中的字段名 */
ClsField: string;
/** 数据湖计算服务表的列名 */
DlcField: string;
/** 数据湖计算服务字段类型 */
DlcFieldType: string;
/** 解析失败填充字段 */
FillField?: string;
/** 是否禁用 */
Disable?: boolean;
}
/** 数据湖计算服务(Data Lake Compute,简称DLC)导入配置信息 */
declare interface DlcInfo {
/** dlc表信息 */
TableInfo: DlcTableInfo;
/** dlc数据字段信息 */
FieldInfos: DlcFiledInfo[];
/** dlc分区信息 */
PartitionInfos: DlcPartitionInfo[];
/** dlc分区额外信息 */
PartitionExtra?: DlcPartitionExtra;
}
/** 数据湖计算服务(Data Lake Compute,简称DLC)数据分区额外信息 */
declare interface DlcPartitionExtra {
/** 时间格式 eg: %Y-%m-%d %H:%M:%S.%f */
TimeFormat?: string;
/** 时间时区 */
TimeZone?: string;
}
/** 数据湖计算服务(Data Lake Compute,简称DLC)数据分区配置 */
declare interface DlcPartitionInfo {
/** cls日志中的字段名 */
ClsField: string;
/** dlc表的列名 */
DlcField: string;
/** dlc字段类型 */
DlcFieldType: string;
}
/** 数据湖计算服务(Data Lake Compute,简称DLC)数据表配置信息 */
declare interface DlcTableInfo {
/** 数据目录 */
DataDirectory: string;
/** 数据库 */
DatabaseName: string;
/** 数据表 */
TableName: string;
}
/** 键值索引自动配置,启用后自动将日志内的字段添加到键值索引中,包括日志中后续新增的字段。 */
declare interface DynamicIndex {
/** 键值索引自动配置开关 */
Status?: boolean;
}
/** 数据加工-高级设置-环境变量 */
declare interface EnvInfo {
/** 环境变量名 */
Key: string;
/** 环境变量值 */
Value?: string;
}
/** Es导入信息 */
declare interface EsImportInfo {
/** 导入模式。1. 导入历史数据2. 导入实时数据 */
Type: number;
/** 开始时间。 单位:秒级时间戳。 */
StartTime?: number;
/** 结束时间。 单位:秒级时间戳。 */
EndTime?: number;
/** 最大延迟时间。单位:s导入模式为 2: 导入实时数据时必填 */
MaxDelay?: number;
/** 检查间隔。单位:s导入模式为 2: 导入实时数据时必填 */
CheckInterval?: number;
}
/** es集群配置信息 */
declare interface EsInfo {
/** es类型。 1:云es, 2:自建es */
EsType: number;
/** 访问方式 1:内网, 2:外网。自建es必填 */
AccessMode?: number;
/** 实例id。云es实例必填 */
InstanceId?: string;
/** 用户名。 */
User?: string;
/** 访问地址。自建es必填 */
Address?: string;
/** 访问端口。自建es必填 */
Port?: number;
/** 所属网络。自建es且访问方式为内网访问时必填 */
VpcId?: string;
/** 网络服务类型。自建es且访问方式为内网访问时必填。负载均衡 CLB:1025 云服务器CVM:0 */
VirtualGatewayType?: number;
/** 密码。 */
Password?: string;
}
/** es导入配置信息 */
declare interface EsRechargeInfo {
/** 任务id。 */
TaskId?: string;
/** 主账号id。 */
Uin?: number;
/** 日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId?: string;
/** 配置名称。 */
Name?: string;
/** es索引。 */
Index?: string;
/** es查询语句。 */
Query?: string;
/** es集群信息。 */
EsInfo?: EsInfo;
/** es导入信息。 */
ImportInfo?: EsImportInfo;
/** es导入时间配置信息。 */
TimeInfo?: EsTimeInfo;
/** 任务状态。1. 运行中2. 暂停3. 完成4. 异常 */
Status?: number;
/** 任务进度 0~100 百分比。100:表示完成。 */
Progress?: number;
/** 子账号id。 */
SubUin?: number;
/** 创建时间。 */
CreateTime?: number;
/** 修改时间。 */
UpdateTime?: number;
/** 是否开启投递服务日志。1:关闭,2:开启。 */
HasServicesLog?: number;
}
/** Es导入时间字段信息 */
declare interface EsTimeInfo {
/** 时间类型 1: 日志采集时间 2: 指定日志字段 */
Type: number;
/** 日志时间字段。时间类型为 2: 指定日志字段时必填 */
TimeKey?: string;
/** 日志时间格式。时间类型为 2: 指定日志字段时必填 */
TimeFormat?: string;
/** 时间字段时区。时间类型为 2: 指定日志字段时必填 */
TimeZone?: string;
}
/** 升级通知 */
declare interface EscalateNoticeInfo {
/** 告警通知模板接收者信息。 */
NoticeReceivers: NoticeReceiver[];
/** 告警通知模板回调信息。 */
WebCallbacks: WebCallback[];
/** 告警升级开关。`true`:开启告警升级、`false`:关闭告警升级,默认:false */
Escalate?: boolean;
/** 告警升级间隔。单位:分钟,范围`[1,14400]` */
Interval?: number;
/** 升级条件。`1`:无人认领且未恢复、`2`:未恢复,默认为1- 无人认领且未恢复:告警没有恢复并且没有人认领则升级- 未恢复:当前告警持续未恢复则升级 */
Type?: number;
/** 告警升级后下一个环节的通知渠道配置,最多可配置5个环节。 */
EscalateNotice?: EscalateNoticeInfo;
}
/** Windows事件日志采集配置 */
declare interface EventLog {
/** 事件通道,支持- Application 应用日志- Security 安全日志- Setup 启动日志- System 系统日志- ALL 所有日志 */
EventChannel: string;
/** 时间字段(Timestamp)支持的类型- 1(用户自定义时间)- 2(当前时间) */
TimeType: number;
/** 时间,用户选择自定义时间类型时,需要指定时间,单位秒格式:时间戳,1754897446 */
Timestamp?: number;
/** 事件ID过滤列表 选填,为空表示不做过滤支持正向过滤单个值(例:20)或范围(例:0-20),也支持反向过滤单个值(例:-20)多个过滤项之间可由逗号隔开,例:1-200,-100表示采集1-200范围内除了100以外的事件日志 */
EventIDs?: string[];
}
/** 黑名单path信息 */
declare interface ExcludePathInfo {
/** 类型,选填File或Path */
Type: string;
/** Type对应的具体内容 */
Value: string;
}
/** 日志导出信息 */
declare interface ExportInfo {
/** 日志主题ID */
TopicId?: string;
/** 日志导出任务ID */
ExportId?: string;
/** 日志导出查询语句 */
Query?: string;
/** 日志导出文件名 */
FileName?: string;
/** 日志文件大小 */
FileSize?: number;
/** 日志导出时间排序 */
Order?: string;
/** 日志导出格式 */
Format?: string;
/** 日志导出数量 */
Count?: number;
/** 日志下载状态。Processing:导出正在进行中,Completed:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期), Queuing 排队中 */
Status?: string;
/** 日志导出起始时间,毫秒时间戳 */
From?: number;
/** 日志导出结束时间,毫秒时间戳 */
To?: number;
/** 日志导出路径,有效期一个小时,请尽快使用该路径下载。 */
CosPath?: string;
/** 日志导出创建时间时间格式:yyyy-MM-dd HH:mm:ss */
CreateTime?: string;
/** 语法规则。 默认值为0。0:Lucene语法,1:CQL语法。 */
SyntaxRule?: number;
/** 导出字段 */
DerivedFields?: string[];
}
/** 日志提取规则 */
declare interface ExtractRuleInfo {
/** 时间字段的key名字,TimeKey和TimeFormat必须成对出现 */
TimeKey?: string;
/** 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数- 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档 */
TimeFormat?: string;
/** 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效 */
Delimiter?: string;
/** 整条日志匹配规则,只有LogType为fullregex_log时有效 */
LogRegex?: string;
/** 行首匹配规则,只有LogType为multiline_log或fullregex_log时有效 */
BeginRegex?: string;
/** 取的每个字段的key名字,为空的key代表丢弃这个字段,只有LogType为delimiter_log时有效,json_log的日志使用json本身的key。限制100个。 */
Keys?: string[] | null;
/** 日志过滤规则列表(旧版),需要过滤日志的key,及其对应的regex。 注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。 */
FilterKeyRegex?: KeyRegexInfo[];
/** 解析失败日志是否上传,true表示上传,false表示不上传 */
UnMatchUpLoadSwitch?: boolean | null;
/** 失败日志的key,当UnMatchUpLoadSwitch为true时必填 */
UnMatchLogKey?: string | null;
/** 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。注意:- COS导入不支持此字段。 */
Backtracking?: number | null;
/** 是否为Gbk编码。 0:否;1:是。注意- 目前取0值时,表示UTF-8编码- COS导入不支持此字段。 */
IsGBK?: number;
/** 是否为标准json。 0:否; 1:是。- 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。 */
JsonStandard?: number | null;
/** syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。注意:- 该字段适用于:创建采集规则配置、修改采集规则配置。- COS导入不支持此字段。 */
Protocol?: string;
/** syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。注意:- 该字段适用于:创建采集规则配置、修改采集规则配置。- COS导入不支持此字段。 */
Address?: string;
/** rfc3164:指定系统日志采集使用RFC3164协议解析日志。rfc5424:指定系统日志采集使用RFC5424协议解析日志。auto:自动匹配rfc3164或者rfc5424其中一种协议。只有在LogType为service_syslog时生效,其余类型无需填写。注意:- 该字段适用于:创建采集规则配置、修改采集规则配置- COS导入不支持此字段。 */
ParseProtocol?: string;
/** 元数据类型。0: 不使用元数据信息;1:使用机器组元数据;2:使用用户自定义元数据;3:使用采集配置路径。注意:- COS导入不支持此字段。 */
MetadataType?: number;
/** 采集配置路径正则表达式。```请用"()"标识路径中目标字段对应的正则表达式,解析时将"()"视为捕获组,并以__TAG__.{i}:{目标字段}的形式与日志一起上报,其中i为捕获组的序号。若不希望以序号为键名,可以通过命名捕获组"(?<{键名}>{正则})"自定义键名,并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组```注意:- MetadataType为3时必填。- COS导入不支持此字段。 */
PathRegex?: string;
/** 用户自定义元数据信息。注意:- MetadataType为2时必填。- COS导入不支持此字段。 */
MetaTags?: MetaTagInfo[];
/** Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。 */
EventLogRules?: EventLog[];
/** 日志过滤规则列表(新版)。注意:- 2.9.3以下版本LogListener不支持, 请使用FilterKeyRegex配置日志过滤规则。- 自建k8s采集配置(CreateConfigExtra、ModifyConfigExtra)不支持此字段。 */
AdvanceFilterRules?: AdvanceFilterRuleInfo[] | null;
}
/** 文件路径信息 */
declare interface FilePathInfo {
/** 文件路径 */
Path?: string;
/** 文件名称 */
File?: string;
}
/** 过滤器 */
declare interface Filter {
/** 需要过滤的字段。 */
Key: string;
/** 需要过滤的值。 */
Values: string[];
}
/** 投递日志的过滤规则 */
declare interface FilterRuleInfo {
/** 过滤规则Key */
Key: string;
/** 过滤规则 */
Regex: string;
/** 过滤规则Value */
Value: string;
}
/** 投递类任务数据过滤统计信息 */
declare interface FilterStatistics {
/** 原始日志数 */
OriginalCount?: number;
/** 过滤后日志数 */
FilteredCount?: number;
/** 过滤后结果 */
FilteredResult?: string[];
}
/** 全文索引配置 */
declare interface FullTextInfo {
/** 是否大小写敏感 */
CaseSensitive: boolean;
/** 全文索引的分词符,其中的每个字符代表一个分词符;仅支持英文符号、\n\t\r及转义符\;注意:\n\t\r本身已被转义,直接使用双引号包裹即可作为入参,无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式,以避免\n\t\r被重复转义 */
Tokenizer: string;
/** 是否包含中文 */
ContainZH?: boolean;
}
/** kafka协议消费组区分信息 */
declare interface GroupPartitionInfo {
/** 分区id */
PartitionId?: number;
/** 分区最新数据时间戳,单位:s */
CommitTimestamp?: number;
/** 消费者 */
Consumer?: string;
}
/** 分组触发条件 */
declare interface GroupTriggerConditionInfo {
/** 分组触发字段名称 */
Key: string;
/** 分组触发字段值 */
Value: string;
}
/** 符合检索条件的关键词,一般用于高亮显示。仅支持键值检索,不支持全文检索 */
declare interface HighLightItem {
/** 高亮的日志字段名称 */
Key?: string;
/** 高亮的关键词 */
Values?: string[];
}
/** 直方图详细信息 */
declare interface HistogramInfo {
/** 统计周期内的日志条数 */
Count?: number;
/** 按 period 取整后的 unix timestamp: 单位毫秒 */
BTime?: number;
}
/** 自建k8s-节点文件配置信息 */
declare interface HostFileInfo {
/** 日志文件夹 */
LogPath: string;
/** 日志文件名 */
FilePattern: string;
/** metadata信息 */
CustomLabels?: string[] | null;
}
/** 主机指标采集配置 */
declare interface HostMetricConfig {
/** 采集配置 id */
ConfigId?: string;
/** 采集配置名称 */
Name?: string;
/** 采集频率,单位ms */
Interval?: number;
/** 采集项. */
HostMetricItems?: HostMetricItem[];
/** 机器组 id 列表 */
MachineGroupIds?: string[];
/** 创建时间 */
CreateTime?: number;
/** 修改时间 */
UpdateTime?: number;
}
/** 主机指标采集项 */
declare interface HostMetricItem {
/** 主机指标采集项类型。支持"cpu","mem","net","disk","system"。- cpu:CPU- mem:内存- net:网络- disk:磁盘- system:系统 */
Type: string;
}
/** 实例信息 */
declare interface Instance {
/** 实例信息 */
Values: string[];
}
/** 实例配置信息 */
declare interface InstanceConfig {
/** 实例维度 */
InstanceDimension: string[];
/** 实例值 */
Instances: Instance[];
}
/** 云产品指标订阅预览结果实例信息 */
declare interface InstanceData {
/** 云监控指标名称 */
MetricName?: string | null;
/** CLS指标名称 */
CLSMetricName?: string | null;
/** 云产品命名空间 */
Namespace?: string | null;
/** 实例信息 */
Dimensions?: Dimension[] | null;
/** 周期,单位:秒 */
Period?: number | null;
/** 指标统计值 */
Value?: number | null;
/** 错误信息 */
ErrMsg?: string | null;
}
/** JSON类型描述 */
declare interface JsonInfo {
/** 启用标志 */
EnableTag: boolean;
/** 元数据信息列表, 可选值为 __SOURCE__、__FILENAME__、__TIMESTAMP__、__HOSTNAME__。- __SOURCE__:日志采集的源 IP,示例:10.0.1.2- __FILENAME__:日志采集的文件名,示例:/data/log/nginx/access.log- __TIMESTAMP__:日志时间戳(毫秒级别 Unix 时间戳),按时间范围检索日志时,将自动使用该时间对日志进行检索,在控制台显示为“日志时间”,示例:1640005601188- __HOSTNAME__:日志来源机器名称,需使用2.7.4及以上版本的 Loglistener 才会采集该字段,示例:localhost */
MetaFields: string[] | null;
/** 投递Json格式,0:字符串方式投递;1:以结构化方式投递 */
JsonType?: number;
}
/** kafka协议消费内容 */
declare interface KafkaConsumerContent {
/** 消费数据格式。 0:原始内容;1:JSON。 */
Format: number;
/** 是否投递 TAG 信息Format为0时,此字段不需要赋值 */
EnableTag: boolean;
/** 元数据信息列表, 可选值为:\_\_SOURCE\_\_、\_\_FILENAME\_\_、\_\_TIMESTAMP\_\_、\_\_HOSTNAME\_\_、\_\_PKGID\_\_Format为0时,此字段不需要赋值 */
MetaFields: string[];
/** tag数据处理方式:1:不平铺(默认值);2:平铺。不平铺示例:TAG信息:`{"__TAG__":{"fieldA":200,"fieldB":"text"}}`不平铺:`{"__TAG__":{"fieldA":200,"fieldB":"text"}}`平铺示例:TAG信息:`{"__TAG__":{"fieldA":200,"fieldB":"text"}}`平铺:`{"__TAG__.fieldA":200,"__TAG__.fieldB":"text"}` */
TagTransaction?: number;
/** 消费数据Json格式:1:不转义(默认格式)2:转义投递Json格式。JsonType为1:和原始日志一致,不转义。示例:日志原文:`{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}`投递到Ckafka:`{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}`JsonType为2:转义。示例:日志原文:`{"a":"aa", "b":{"b1":"b1b1", "c1":"c1c1"}}`投递到Ckafka:`{"a":"aa","b":"{\"b1\":\"b1b1\", \"c1\":\"c1c1\"}"}` */
JsonType?: number;
}
/** Kafka访问协议 */
declare interface KafkaProtocolInfo {
/** 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。- 当IsEncryptionAddr为true时,Protocol必填。- 支持的协议类型如下: - plaintext:纯文本无加密协议 - sasl_ssl:SASL 认证 + SSL 加密 - ssl:纯 SSL/TLS 加密协议 - sasl_plaintext:SASL 认证 + 非加密通道 */
Protocol?: string;
/** 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。- 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。- 支持加密类型如下 - PLAIN:明文认证 - SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法 - SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法 */
Mechanism?: string;
/** 用户名。当Protocol为sasl_plaintext或sasl_ssl时必填 */
UserName?: string;
/** 用户密码。当Protocol为sasl_plaintext或sasl_ssl时必填 */
Password?: string;
}
/** Kafka导入配置信息 */
declare interface KafkaRechargeInfo {
/** Kafka数据订阅配置的ID。 */
Id?: string;
/** 日志主题ID */
TopicId?: string;
/** Kafka导入任务名称 */
Name?: string;
/** 导入Kafka类型,0: 腾讯云CKafka,1: 用户自建Kafka */
KafkaType?: number;
/** 腾讯云CKafka实例ID,KafkaType为0时必填 */
KafkaInstance?: string;
/** 服务地址 */
ServerAddr?: string;
/** ServerAddr是否为加密连接 */
IsEncryptionAddr?: boolean;
/** 加密访问协议,IsEncryptionAddr参数为true时必填 */
Protocol?: KafkaProtocolInfo;
/** 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开 */
UserKafkaTopics?: string;
/** 用户Kafka消费组名称 */
ConsumerGroupName?: string;
/** 状态 ,1:运行中;2:暂停。 */
Status?: number;
/** 导入数据位置,-2:最早(默认),-1:最晚 */
Offset?: number;
/** 创建时间。格式`YYYY-MM-DD HH:MM:SS` */
CreateTime?: string;
/** 更新时间。格式`YYYY-MM-DD HH:MM:SS` */
UpdateTime?: string;
/** 日志导入规则 */
LogRechargeRule?: LogRechargeRuleInfo;
/** 用户kafka拓展信息 */
UserKafkaMeta?: UserKafkaMeta;
}
/** 需要过滤日志的key,及其对应的regex */
declare interface KeyRegexInfo {
/** 需要过滤日志的key */
Key: string;
/** key对应的过滤规则regex */
Regex: string;
}
/** 键值或者元字段索引的字段信息 */
declare interface KeyValueInfo {
/** 需要配置键值或者元字段索引的字段名称,仅支持字母、数字、下划线和-./@,且不能以下划线开头注意:1,元字段(tag)的Key无需额外添加`__TAG__.`前缀,与上传日志时对应的字段Key一致即可,腾讯云控制台展示时将自动添加`__TAG__.`前缀2,键值索引(KeyValue)及元字段索引(Tag)中的Key总数不能超过3003,Key的层级不能超过10层,例如a.b.c.d.e.f.g.h.j.k4,不允许同时包含json父子级字段,例如a及a.b */
Key: string;
/** 字段的索引描述信息 */
Value: ValueInfo;
}
/** 标签结构体 */
declare interface Label {
/** 标签的键。有效标签键有两个部分:可选前缀和名称,以斜杠 (/) 分隔。名称部分是必需的,并且必须不超过 63 个字符,以字母数字字符 ([a-z0-9A-Z]) 开头和结尾,中间有破折号(-)、下划线(_)、点(.) 和字母数字。前缀是可选的。如果指定,前缀必须是 DNS 子域:一系列以点 (.) 分隔的 DNS 标签,总长度不超过 253 个字符,后跟斜杠 ( /)。- prefix 格式 `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`- name 格式 `([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]`- key不能重复 */
Key: string | null;
/** 标签键值直接的比较关系。 不同业务场景支持的比较符不同,具体支持那些参考接口业务描述。例如:`in`、`notin` */
Operate: string | null;
/** 标签的值.- 最大支持63个字符。- 格式:`([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]` */
Values?: string[] | null;
}
/** 日志上下文信息 */
declare interface LogContextInfo {
/** 日志来源设备 */
Source?: string;
/** 采集路径 */
Filename?: string;
/** 日志内容 */
Content?: string;
/** 日志包序号 */
PkgId?: string;
/** 日志包内一条日志的序号 */
PkgLogId?: number;
/** 日志时间戳 */
BTime?: number;
/** 日志来源主机名称 */
HostName?: string;
/** 原始日志(仅在日志创建索引异常时有值) */
RawLog?: string;
/** 日志创建索引异常原因(仅在日志创建索引异常时有值) */
IndexStatus?: string;
/** 日志内容的高亮描述信息 */
HighLights?: HighLightItem[];
}
/** 日志结果信息 */
declare interface LogInfo {
/** 日志时间,单位ms */
Time?: number;
/** 日志主题ID */
TopicId?: string;
/** 日志主题名称 */
TopicName?: string;
/** 日志来源IP */
Source?: string;
/** 日志文件名称 */
FileName?: string;
/** 日志上报请求包的ID */
PkgId?: string;
/** 请求包内日志的ID */
PkgLogId?: string;
/** 符合检索条件的关键词,一般用于高亮显示。仅支持键值检索,不支持全文检索 */
HighLights?: HighLightItem[];
/** 日志内容的Json序列化字符串 */
LogJson?: string;
/** 日志来源主机名称 */
HostName?: string;
/** 原始日志(仅在日志创建索引异常时有值) */
RawLog?: string;
/** 日志创建索引异常原因(仅在日志创建索引异常时有值) */
IndexStatus?: string;
}
/** 日志中的KV对 */
declare interface LogItem {
/** 日志Key */
Key?: string;
/** 日志Value */
Value?: string;
}
/** LogItem的数组 */
declare interface LogItems {
/** 分析结果返回的KV数据对 */
Data: LogItem[];
}
/** 日志导入规则 */
declare interface LogRechargeRuleInfo {
/** 导入类型,支持json_log:json格式日志,minimalist_log: 单行全文,fullregex_log: 单行完全正则 */
RechargeType: string;
/** 解析编码格式,0: UTF-8(默认值),1: GBK */
EncodingFormat: number;
/** 使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true */
DefaultTimeSwitch: boolean;
/** 整条日志匹配规则,只有RechargeType为fullregex_log时有效 */
LogRegex?: string;
/** 解析失败日志是否上传,true表示上传,false表示不上传 */
UnMatchLogSwitch?: boolean;
/** 解析失败日志的键名称 */
UnMatchLogKey?: string;
/** 解析失败日志时间来源,0: 系统当前时间,1: Kafka消息时间戳 */
UnMatchLogTimeSrc?: number;
/** 默认时间来源,0: 系统当前时间,1: Kafka消息时间戳 */
DefaultTimeSrc?: number;
/** 时间字段,日志中代表时间的字段名。- 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。 */
TimeKey?: string;
/** 时间提取正则表达式。- 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时, TimeRegex不能为空。- 仅需输入日志中代表时间的字段的正则表达式即可;若匹配到多个字段,将使用第一个。 例:日志原文为:message with time 2022-08-08 14:20:20,则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d */
TimeRegex?: string;
/** 时间字段格式。- 当DefaultTimeSwitch为false时, TimeFormat不能为空。 */
TimeFormat?: string;
/** 时间字段时区。- 当DefaultTimeSwitch为false时, TimeZone不能为空。- 时区格式规则前缀:使用 GMT 或 UTC 作为时区基准偏移量: - `-` 表示西时区(比基准时间晚) - `+` 表示东时区(比基准时间早) - 格式为 ±HH:MM(小时:分钟)- 当前支持:```"GMT-12:00" "GMT-11:00" "GMT-10:00" "GMT-09:30" "GMT-09:00" "GMT-08:00" "GMT-07:00" "GMT-06:00" "GMT-05:00" "GMT-04:00" "GMT-03:30" "GMT-03:00" "GMT-02:00" "GMT-01:00" "GMT+00:00""GMT+01:00""GMT+02:00""GMT+03:30""GMT+04:00""GMT+04:30""GMT+05:00""GMT+05:30""GMT+05:45""GMT+06:00""GMT+06:30""GMT+07:00""GMT+08:00""GMT+09:00""GMT+09:30""GMT+10:00""GMT+10:30""GMT+11:00""GMT+11:30""GMT+12:00""GMT+12:45""GMT+13:00""GMT+14:00""UTC-11:00""UTC-10:00""UTC-09:00""UTC-08:00""UTC-12:00""UTC-07:00""UTC-06:00""UTC-05:00""UTC-04:30""UTC-04:00""UTC-03:30""UTC-03:00""UTC-02:00""UTC-01:00""UTC+00:00""UTC+01:00""UTC+02:00""UTC+03:00""UTC+03:30""UTC+04:00""UTC+04:30""UTC+05:00""UTC+05:45""UTC+06:00""UTC+06:30""UTC+07:00""UTC+08:00""UTC+09:00""UTC+09:30""UTC+10:00""UTC+11:00""UTC+12:00""UTC+13:00"``` */
TimeZone?: string;
/** 元数据信息,Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp */
Metadata?: string[];
/** 日志Key列表,RechargeType为full_regex_log、delimiter_log时必填 */
Keys?: string[];
/** json解析模式,开启首层数据解析 */
ParseArray?: boolean;
/** 分隔符解析模式-分隔符当解析格式为分隔符提取时,该字段必填 */
Delimiter?: string;
}
/** 日志集相关信息 */
declare interface LogsetInfo {
/** 日志集ID */
LogsetId?: string;
/** 日志集名称 */
LogsetName?: string;
/** 创建时间。格式 `YYYY-MM-DD HH:MM:SS` */
CreateTime?: string;
/** 若AssumerUin非空,则表示创建该日志集的服务方Uin */
AssumerUin?: number;
/** 云产品标识,日志集由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE */
AssumerName?: string;
/** 日志集绑定的标签 */
Tags?: Tag[];
/** 日志集下日志主题的数目 */
TopicCount?: number;
/** 若AssumerName非空,则表示创建该日志集的服务方角色 */
RoleName?: string;
/** 日志集下指标主题的数目 */
MetricTopicCount?: number;
}
/** 机器组信息 */
declare interface MachineGroupInfo {
/** 机器组ID */
GroupId?: string;
/** 机器组名称 */
GroupName?: string;
/** 机器组类型 */
MachineGroupType?: MachineGroupTypeInfo;
/** 创建时间时间格式:yyyy-MM-dd HH:mm:ss */
CreateTime?: string;
/** 机器组绑定的标签列表 */
Tags?: Tag[];
/** 是否开启机器组自动更新 */
AutoUpdate?: string;
/** 升级开始时间,建议业务低峰期升级LogListener时间格式:HH:mm:ss */
UpdateStartTime?: string;
/** 升级结束时间,建议业务低峰期升级LogListener时间格式:HH:mm:ss */
UpdateEndTime?: string;
/** 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费 */
ServiceLogging?: boolean;
/** 机器组中机器离线定期清理时间,单位天,默认设置30天。 */
DelayCleanupTime?: number;
/** 机器组元数据信息列表 */
MetaTags?: MetaTagInfo[];
/** 操作系统类型,0: Linux,1: windows */
OSType?: number;
}
/** 机器组类型描述 */
declare interface MachineGroupTypeInfo {
/** 机器组类型。支持 ip 和 label。- ip:表示该机器组Values中存的是采集机器的ip地址- label:表示该机器组Values中存储的是机器的标签 */
Type: string;
/** 机器描述列表。 */
Values?: string[];
}
/** 机器状态信息 */
declare interface MachineInfo {
/** 机器的IP */
Ip?: string;
/** 机器实例ID */
InstanceID?: string;
/** 机器状态,0:异常,1:正常 */
Status?: number;
/** 机器离线时间,空为正常,异常返回具体时间。时间格式:YYYY-MM-DD HH:mm:ss */
OfflineTime?: string;
/** 机器是否开启自动升级。0:关闭,1:开启 */
AutoUpdate?: number;
/** 机器当前版本号。 */
Version?: string;
/** 机器升级功能状态。 0:升级成功;1:升级中;-1:升级失败。 */
UpdateStatus?: number;
/** 机器升级结果标识。0:成功;1200:升级成功;其他值表示异常。 */
ErrCode?: number;
/** 机器升级结果信息。“ok”:成功;“update success”:升级成功;其他值为失败原因。 */
ErrMsg?: string;
}
/** 元数据信息 */
declare interface MetaTagInfo {
/** 元数据key */
Key?: string;
/** 元数据value */
Value?: string;
}
/** Splunk任务投递元信息 */
declare interface MetadataInfo {
/** 数据格式,rawlog/json */
Format: string;
/** 投递字段,包括\_\_SOURCE\_\_、\_\_FILENAME\_\_、\_\_TIMESTAMP\_\_、\_\_HOSTNAME\_\_、\_\_PKG\_ID\_\_ */
MetaFields?: string[];
/** 是否投递__TAG__字段 */
EnableTag?: boolean;
/** JSON是否平铺,投递__TAG__字段时必填 */
TagJsonTiled?: boolean;
}
/** 指标采集配置 */
declare interface MetricCollectConfig {
/** 采集配置id */
ConfigId?: string;
/** 日志主题id。 */
TopicIds?: string[];
/** 采集配置来源。支持 :`0`、`1`- 0:自建k8s- 1:TKE */
Source?: number;
/** 机器组id。 */
GroupIds?: string[];
/** 监控类型。支持 :`0`、`1`,不支持修改- 0:基础监控- 1:自定义监控, */
Type?: number;
/** 采集配置方式。支持 :`0`、`1`,不支持修改- 0:普通配置方式,Type字段只能为:`1`- 1:YAML导入方式,Type 可以是:`0`或者`1` */
Flag?: number;
/** 名称:长度不超过253字符,校验格式 ` [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`。 */
Name?: string | null;
/** 采集对象, Flag=0时生效 */
Spec?: MetricSpec | null;
/** 标签处理, Flag=0时生效 */
MetricRelabels?: Relabeling[] | null;
/** 自定义元数据, Flag=0时生效 */
MetricLabel?: MetricConfigLabel | null;
/** 通信协议 `http`、`https`;Flag=0时生效 */
Scheme?: string | null;
/** 采集频率, Flag=0时生效- 校验格式:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$` */
ScrapeInterval?: string | null;
/** 采集超时时间。 Flag=0 && Type=1时生效- format:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$` */
ScrapeTimeout?: string | null;
/** Prometheus如何处理标签之间的冲突。当Flag=0生效,支持`true`,`false`- `false`:配置数据中冲突的标签重命名- `true`:忽略冲突的服务器端标签 */
HonorLabels?: boolean | null;
/** 采集配置yaml格式字符串, Flag=1时必填 */
YamlSpec?: MetricYamlSpec | null;
/** 操作状态,0:应用,1:暂停 */
Operate?: number;
/** 创建时间戳 秒级 */
CreateTime?: number;
/** 更新时间戳 秒级 */
UpdateTime?: number;
}
/** 指标配置信息 */
declare interface MetricConfig {
/** 指标名称 */
MetricName: string;
/** 统计周期,单位:秒(s) */
Periods: number[];
/** 自定义指标标签 */
MetricLabels?: MetricLabel[];
}
/** 指标采集label配置信息 */
declare interface MetricConfigLabel {
/** 元数据。支持- `namespace`- `pod_name`- `pod_ip`- `pod_uid`- `container_name`- `container_id`- `image_name`- `cluster_id`- `node_id`- `node_ip` */
Metadata?: string[] | null;
/** 元数据Pod Label信息。 */
Label?: AppointLabel | null;
/** 自定义label信息。 */
CustomLabels?: CustomLabel[] | null;
}
/** 过滤器 */
declare interface MetricLabel {
/** 指标名称 */
Key: string;
/** 指标内容 */
Value: string;
}
/** 采集对象 */
declare interface MetricSpec {
/** 自定义指标采集配置项 */
CustomSpecs?: CustomMetricSpec[] | null;
}
/** 指标订阅配置信息 */
declare interface MetricSubscribeInfo {
/** 订阅任务id。 */
TaskId?: string;
/** 日志主题id。 */
TopicId?: string;
/** 订阅任务名称。 */
Name?: string;
/** 云产品命名空间。 */
Namespace?: string;
/** 指标配置信息。 */
Metrics?: MetricConfig[];
/** 实例配置信息。 */
InstanceInfo?: InstanceConfig;
/** 订阅任务开关。1:暂停 2:启用 */
Enable?: number;
/** 订阅任务运行状态。0:创建中 1:暂停 2:运行中 3:异常 */
Status?: number;
/** 订阅任务运行异常时的错误信息。 */
ErrMsg?: string | null;
/** 创建时间(秒级时间戳) */
CreateTime?: number | null;
/** 更新时间(秒级时间戳) */
UpdateTime?: number | null;
}
/** 指标采集yaml格式配置 */
declare interface MetricYamlSpec {
/** yaml监控类型。支持:- PodMonitor- ServiceMonitor- ScrapeConfig- ScrapeConfig-prometheus`PodMonitor `,`ServiceMonitor `,`ScrapeConfig ` 属于prometheus-operator`ScrapeConfig-prometheus` 属于prometheus */
Type: string | null;
/** 配置yaml格式。例如:Type: ServiceMonitor```apiVersion: monitoring.coreos.com/v1kind: ServiceMonitormetadata: name: test namespace: test labels: k8s-app1: test k8s-app2: testspec: endpoints: - interval: 15s port: 8080-8080-tcp path: /metrics relabelings: - action: replace sourceLabels: - __meta_kubernetes_pod_label_app targetLabel: application namespaceSelector: matchNames: - test selector: matchLabels: app: test``` */
Spec: string | null;
}
/** 提供多个Notice信息 */
declare interface MonitorNotice {
/** 以数组的形式提供MonitorNoticeRule */
Notices?: MonitorNoticeRule[];
}
/** 腾讯云可观测平台通知渠道组信息 */
declare interface MonitorNoticeRule {
/** 腾讯云可观测平台通知模板 ID */
NoticeId?: string;
/** 腾讯云可观测平台内容模板ID,不传默认内容模板 */
ContentTmplId?: string | null;
/** 告警级别,0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical) */
AlarmLevels?: number[];
}
/** 告警策略中监控任务的执行时间点 */
declare interface MonitorTime {
/** 执行周期, 可选值:`Period`、`Fixed`、`Cron`。- Period:固定频率- Fixed:固定时间- Cron:Cron表达式 */
Type: string;
/** 执行的周期,或者定制执行的时间节点。单位为分钟,取值范围为1~1440。当type为`Period`,`Fixed`时,time字段生效。 */
Time?: number;
/** 执行的周期cron表达式。示例:`"1 * * * *"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期), 不支持秒级别。当type为`Cron`时,CronExpression字段生效。 */
CronExpression?: string;
}
/** 多触发条件。 */
declare interface MultiCondition {
/** 触发条件。 */
Condition?: string;
/** 告警级别。0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。- 不填则默认为0。 */
AlarmLevel?: number;
}
/** 多日志主题检索相关信息 */
declare interface MultiTopicSearchInformation {
/** 要检索分析的日志主题ID */
TopicId?: string;
/** 透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时 */
Context?: string;
}
/** Splunk投递任务-目标配置网络信息相关 */
declare interface NetInfo {
/** 网络地址 */
Host: string;
/** 端口 */
Port: number;
/** 认证token */
Token: string;
/** 网络类型;1:内网;2:外网 */
NetType: number;
/** 所属网络;如果网络类型为内网,该字段必填 */
VpcId?: string;
/** 网络服务类型;如果网络类型为内网,该字段必填- 0:云上cvm- 3:云上专线网关- 11:云联网- 1025:云上clb */
VirtualGatewayType?: number;
/** 认证机制,是否使用SSL,默认不使用 */
IsSSL?: boolean;
}
/** 通知内容模板详细配置 */
declare interface NoticeContent {
/** 渠道类型Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调; */
Type: string;
/** 告警触发通知内容模板。 */
TriggerContent?: NoticeContentInfo;
/** 告警恢复通知内容模板。 */
RecoveryContent?: NoticeContentInfo;
}
/** 通知模板内容 */
declare interface NoticeContentInfo {
/** 通知内容模板标题信息。部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。 */
Title?: string;
/** 通知内容模板正文信息。 */
Content?: string;
/** 请求头(Request Headers):在HTTP请求中,请求头包含了客户端向服务器发送的附加信息,如用户代理、授权凭证、期望的响应格式等。仅“自定义回调”支持该配置。 */
Headers?: string[];
}
/** 通知内容模板信息 */
declare interface NoticeContentTemplate {
/** 通知内容模板ID。 */
NoticeContentId?: string;
/** 通知内容模板名称 */
Name?: string;
/** 语言类型。0: 中文1: 英文 */
Type?: number;
/** 通知内容模板信息。 */
NoticeContents?: NoticeContent[];
/** 通知内容模板标记。0: 用户自定义1: 系统内置 */
Flag?: number;
/** 创建者主账号。 */
Uin?: number;
/** 创建/修改者子账号。 */
SubUin?: number;
/** 创建时间 秒级(s)时间戳。 */
CreateTime?: number;
/** 更新时间 秒级(s)时间戳。 */
UpdateTime?: number;
}
/** 告警通知接收者信息 */
declare interface NoticeReceiver {
/** 接受者类型。可选值:- Uin - 用户ID- Group - 用户组ID暂不支持其余接收者类型。 */
ReceiverType: string;
/** 接收者。当ReceiverType为Uin时,ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486)当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589) */
ReceiverIds: number[];
/** 通知接收渠道。- Email - 邮件- Sms - 短信- WeChat - 微信- Phone - 电话 */
ReceiverChannels: string[];
/** 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID */
NoticeContentId?: string;
/** 允许接收信息的开始时间。格式:`15:04:05`。必填 */
StartTime?: string;
/** 允许接收信息的结束时间。格式:`15:04:05`。必填 */
EndTime?: string;
/** 位序。- 入参时无效。- 出参时有效。 */
Index?: number;
}
/** 通知规则 */
declare interface NoticeRule {
/** 匹配规则 JSON串。**rule规则树格式为嵌套结构体JSON字符串**`{"Value":"AND","Type":"Operation","Children":[{"Value":"OR","Type":"Operation","Children":[{"Type":"Condition","Value":"Level","Children":[{"Value":"In","Type":"Compare"},{"Value":"[1,0]","Type":"Value"}]},{"Type":"Condition","Value":"Level","Children":[{"Value":"NotIn","Type":"Compare"},{"Value":"[2]","Type":"Value"}]}]}]}`**rule规则树限制规则如下**:- 顶层rule中Type可取值:`Condition`,`Operation`- Type为`Operation`的子节点支持的Type可取值:`Condition`,`Operation`- Type为`Condition`的子节点支持的Type可取值:`String`,`Compare`,`Array`,`TimeRange`,`Value`,`Key`- 其他Type无子节点- 当rule Type为`Operation`时,value可取值:`AND`,`OR`- 当rule Type为`Condition`时,value不可为空,子节点个数不能小于2 - 当子节点Type为 `Compare` 时,value可取值:`>`,`<`,`>=`,`<=`,`=`,`!=`,`Between`,`NotBetween`,`=~`,`!=~`,`In`,`NotIn` - value为`Between`,`NotBetween`时,下一个子节点value必须是长度为2的数组 - value为`=~`,`!=~`时,下一个子节点value必须是一个正则表达式 - value为`In`,`NotIn`时, 下一个子节点value必须是一个数组**业务参数含义**:- Type:Condition 表示是规则条件,Value:Level 表示告警等级 - 子节点Type支持`Compare`,Value支持`In`,`NotIn` - 下一个子节点value支持的值:0(警告),1(提醒),2 (紧急)以下示例表示:告警等级属于提醒`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]}]}`- Type:Condition 表示是规则条件,Value:NotifyType 表示通知类型 - 子节点Type支持`Compare`,Value支持`In`,`NotIn` - 下一个子节点value支持的值:1(告警通知),2 (恢复通知)以下示例表示:通知类型属于告警通知或通知类型不属于恢复通知`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[2]\",\"Type\":\"Value\"}]}]}]}`- Type:Condition 表示是规则条件,Value:AlarmID 表示告警策略 - 子节点Type支持`Compare`,Value支持`In`,`NotIn` - 下一个子节点value支持的值:告警策略id数组以下示例表示:告警策略属于alarm-53af048c-254b-4c73-bb48-xxx,alarm-6dfa8bc5-08da-4d64-b6cb-xxx或告警策略不属于alarm-1036314c-1e49-4cee-a8fb-xxx`"{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-53af048c-254b-4c73-bb48-xxx\\\",\\\"alarm-6dfa8bc5-08da-4d64-b6cb-xxx\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-1036314c-1e49-4cee-a8fb-xxx\\\"]\",\"Type\":\"Value\"}]}]}]}"`- Type:Condition 表示是规则条件,Value:AlarmName 表示告警策略名称 - 子节点Type支持`Compare`,Value支持`=~`,`!=~` - 下一个子节点value支持的值:必须是正则表达式以下示例表示:告警策略名称正则匹配^test$或告警策略名称正则不匹配^hahaha$`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}`- Type:Condition 表示是规则条件,Value:Label 表示告警分类字段 - 子节点Type支持`Compare`,Value支持`In`,`NotIn`,`=~`,`!=~` - 下一个子节点value支持的值:`In`,`NotIn` 时value是数组,`=~`,`!=~`时value是正则表达式以下示例表示:告警分类字段key1属于v1或告警分类字段key2不属于v2或告警分类字段key3正则匹配^test$或告警分类字段key4正则不匹配^hahaha$`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key1\",\"Type\":\"Key\"},{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v1\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key2\",\"Type\":\"Key\"},{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v2\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key3\",\"Type\":\"Key\"},{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key4\",\"Type\":\"Key\"},{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}`- Type:Condition 表示是规则条件,Value:NotifyTime 表示通知时间 - 子节点Type支持`Compare`,Value支持`Between `,`NotBetween ` - 下一个子节点value支持的值:长度为2,格式为`14:20:36`的字符串数组以下示例表示:通知时间在指定范围内14:18:36至14:33:36或通知时间不在指定范围内14:20:36至14:30:36`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"Between\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:18:36\\\",\\\"14:33:36\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"NotBetween\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:20:36\\\",\\\"14:30:36\\\"]\",\"Type\":\"Value\"}]}]}]}`- Type:Condition 表示是规则条件,Value:Duration 表示告警持续时间 - 子节点Type支持`Compare`,Value支持`>`,`<`,`>=`,`<=` - 下一个子节点value支持的值:整型值单位分钟以下示例表示:告警持续时间大于1分钟或告警持续时间大于等于2分钟或告警持续时间小于3分钟或告警持续时间小于等于4分钟`{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">\",\"Type\":\"Compare\"},{\"Value\":1,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">=\",\"Type\":\"Compare\"},{\"Value\":2,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<\",\"Type\":\"Compare\"},{\"Value\":3,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<=\",\"Type\":\"Compare\"},{\"Value\":4,\"Type\":\"Value\"}]}]}]}` */
Rule?: string;
/** 告警通知接收者信息。 */
NoticeReceivers?: NoticeReceiver[];
/** 告警通知模板回调信息,包括企业微信、钉钉、飞书。 */
WebCallbacks?: WebCallback[];
/** 告警升级开关。`true`:开启告警升级、`false`:关闭告警升级,默认:false */
Escalate?: boolean;
/** 告警升级条件。`1`:无人认领且未恢复、`2`:未恢复,默认为1- 无人认领且未恢复:告警没有恢复并且没有人认领则升级- 未恢复:当前告警持续未恢复则升级 */
Type?: number;
/** 告警升级间隔。单位:分钟,范围`[1,14400]` */
Interval?: number;
/** 告警升级后下一个环节的通知渠道配置 */
EscalateNotice?: EscalateNoticeInfo;
}
/** Parquet内容 */
declare interface ParquetInfo {
/** ParquetKeyInfo数组 */
ParquetKeyInfo: ParquetKeyInfo[];
}
/** Parquet内容描述 */
declare interface ParquetKeyInfo {
/** 键值名称 */
KeyName: string;
/** 数据类型,目前支持6种类型:string、boolean、int32、int64、float、double */
KeyType: string;
/** 解析失败赋值信息 */
KeyNonExistingField: string;
}
/** 日志主题分区信息 */
declare interface PartitionInfo {
/** 分区ID */
PartitionId?: number;
/** 分区的状态(readwrite或者是readonly) */
Status?: string;
/** 分区哈希键起始key */
InclusiveBeginKey?: string;
/** 分区哈希键结束key */
ExclusiveEndKey?: string;
/** 分区创建时间时间格式:yyyy-MM-dd HH:mm:ss */
CreateTime?: string;
/** 只读分区数据停止写入时间时间格式:yyyy-MM-dd HH:mm:ss */
LastWriteTime?: string | null;
}
/** PartitionOffsetInfo */
declare interface PartitionOffsetInfo {
/** 分区id */
PartitionId: number | null;
/** offset点位 */
Offset?: number | null;
}
/** 预览数据详情 */
declare interface PreviewLogStatistic {
/** 日志内容 */
LogContent: string;
/** 行号。从0开始 */
LineNum: number;
/** 目标日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
DstTopicId?: string;
/** 失败错误信息, 空字符串""表示正常 */
FailReason?: string;
/** 日志时间,格式:`2024-05-07 17:13:17.105`- 入参时无效- 出参时有效,为日志中的时间格式 */
Time?: string;
/** 目标topic-name */
DstTopicName?: string | null;
}
/** 索引重建任务信息 */
declare interface RebuildIndexTaskInfo {
/** 索引重建任务ID */
TaskId: string;
/** 索引重建任务当前状态,0:索引重建任务已创建,1:创建索引重建资源,2:索引重建资源创建完成,3:重建中,4:暂停,5:重建索引成功,6:重建成功(可检索),7:重建失败,8:撤销,9:删除元数据和索引 */
Status: number;
/** 重建任务开始时间戳 */
StartTime: number;
/** 重建任务结束时间戳 */
EndTime: number;
/** 重投预估剩余时间,单位秒 */
RemainTime: number;
/** 重建任务创建时间戳 */
CreateTime: number;
/** 重投完成度,百分比 */
Progress: number;
/** 重建任务更新时间 */
UpdateTime: number;
/** 附加状态描述信息(目前仅描述失败时失败原因) */
StatusMessage: string;
}
/** 标签重新标记配置。允许动态重写目标、警报、抓取样本和远程写入样本的标签集。 */
declare interface Relabeling {
/** 基于正则表达式匹配执行的动作。- replace: Label替换, 必填: SourceLabels, Separator, Regex, TargetLabel, Replacement- labeldrop: 丢弃Label, 必填: Regex- labelkeep: 保留Label, 必填: Regex- lowercase: 小写化, 必填: SourceLabels, Separator, TargetLabel- uppercase: 大写化, 必填: SourceLabels, Separator, TargetLabel- dropequal: 丢弃指标-完全匹配, 必填: SourceLabels, Separator, TargetLabel- keepequal: 保留指标-完全匹配, 必填: SourceLabels, Separator, TargetLabel- drop: 丢弃指标-正则匹配, 必填: SourceLabels, Separator, Regex- keep: 保留指标-正则匹配, 必填: SourceLabels, Separator, Regex- hashmod:哈希取模, 必填: SourceLabels, Separator, TargetLabel, Modulus- labelmap:Label映射, 必填: Regex, Replacement */
Action: string | null;
/** 原始label */
SourceLabels?: string[] | null;
/** 原始label连接符。 必填时不能为空串, 长度不能超过256 */
Separator?: string | null;
/** 目标label。必填时不能为空串,校验格式:`^[a-zA-Z_][a-zA-Z0-9_]*$` , 长度不能超过256 */
TargetLabel?: string | null;
/** 替换值。如果正则表达式匹配,则对其执行替换操作。- 必填时不能为空串,长度不能超过256- 当action为LabelMap时, Replacement 校验格式:`^(?:(?:[a-zA-Z_]|\$(?:\{\w+\}|\w+))+\w*)+$` */
Replacement?: string | null;
/** 正则表达式。提取与之匹配值。必填时不能为空串,校验必须是一个合法的 RE2 */
Regex?: string | null;
/** 获取源标签值的哈希值。必填时不能为空,不能为0 */
Modulus?: number | null;
}
/** 索引规则,FullText、KeyValue、Tag参数必须输入一个有效参数 */
declare interface RuleInfo {
/** 全文索引配置, 为空时代表未开启全文索引 */
FullText?: FullTextInfo | null;
/** 键值索引配置,为空时代表未开启键值索引 */
KeyValue?: RuleKeyValueInfo | null;
/** 元字段索引配置,为空时代表未开启元字段索引 */
Tag?: RuleTagInfo | null;
/** 键值索引自动配置,为空时代表未开启该功能。启用后自动将日志内的字段添加到键值索引中,包括日志中后续新增的字段。 */
DynamicIndex?: DynamicIndex | null;
}
/** 键值索引配置 */
declare interface RuleKeyValueInfo {
/** 是否大小写敏感 */
CaseSensitive: boolean;
/** 需要建立索引的键值对信息 */
KeyValues?: KeyValueInfo[];
}
/** 元字段索引配置 */
declare interface RuleTagInfo {
/** 是否大小写敏感 */
CaseSensitive: boolean;
/** 元字段索引配置中的字段信息 */
KeyValues: KeyValueInfo[];
}
/** ScheduledSql的资源信息 */
declare interface ScheduledSqlResouceInfo {
/** 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。 */
TopicId: string;
/** 主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474) 文档。 */
Region?: string;
/** 主题类型:0为日志主题,1为指标主题 */
BizType?: number;
/** 指标名称。当BizType为1时,MetricName需要填写 */
MetricName?: string;
/** 指标名称BizType为1时,优先使用MetricNames字段多指标只能填充到MetricNames字段,单指标建议填充到MetricName字段 */
MetricNames?: string[];
/** 指标维度,不接受时间类型。 */
MetricLabels?: string[];
/** 指标时间戳,默认值为SQL查询时间范围的左侧时间点,您也可以指定其他字段(类型为uinx时间、TimeStamp,精度毫秒)为指标时间戳。 */
CustomTime?: string;
/** 除了MetricLabels,您还可以使用该参数,为指标补充静态的维度。维度名以字母或下划线开头,后面可以跟字母、数字或下划线,长度小于等于1024 字节 */
CustomMetricLabels?: MetricLabel[];
}
/** ScheduledSql任务详情 */
declare interface ScheduledSqlTaskInfo {
/** ScheduledSql任务id */
TaskId?: string;
/** ScheduledSql任务名称 */
Name?: string;
/** 源日志主题id */
SrcTopicId?: string;
/** 源日志主题名称 */
SrcTopicName?: string;
/** 定时SQL分析目标主题 */
DstResource?: ScheduledSqlResouceInfo;
/** 任务创建时间。格式:yyyy-MM-dd HH:mm:ss */
CreateTime?: string;
/** 任务更新时间,格式:yyyy-MM-dd HH:mm:ss */
UpdateTime?: string;
/** 任务状态,1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题5: 访问权限问题 6:内部故障 7:其他故障 */
Status?: number;
/** 任务启用状态,1开启, 2关闭 */
EnableFlag?: number;
/** 查询语句 */
ScheduledSqlContent?: string;
/** 调度开始时间,格式:yyyy-MM-dd HH:mm:ss */
ProcessStartTime?: string;
/** 调度类型,1:持续运行 2:指定时间范围 */
ProcessType?: number;
/** 调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段 */
ProcessEndTime?: string;
/** 调度周期(分钟),1~1440分钟 */
ProcessPeriod?: number;
/** 查询的时间窗口. @m-15m, @m,意为近15分钟 */
ProcessTimeWindow?: string;
/** 执行延迟(秒),0~120秒,默认60秒 */
ProcessDelay?: number;
/** 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474) 文档。 */
SrcTopicRegion?: string;
/** 语法规则,0:Lucene语法,1:CQL语法 */
SyntaxRule?: number;
/** 是否开启投递服务日志。1:关闭,2:开启。 */
HasServicesLog?: number;
/** 全文检索标记。1:关闭,2:打开。 */
FullQuery?: number;
}
/** 多日志主题检索错误信息 */
declare interface SearchLogErrors {
/** 日志主题ID */
TopicId?: string;
/** 错误信息 */
ErrorMsg?: string;
/** 错误码 */
ErrorCodeStr?: string;
}
/** 多日志主题检索topic信息 */
declare interface SearchLogInfos {
/** 日志主题ID */
TopicId?: string;
/** 日志存储生命周期 */
Period?: number;
/** 透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时 */
Context?: string;
}
/** 多主题检索返回信息 */
declare interface SearchLogTopics {
/** 多日志主题检索对应的错误信息 */
Errors?: SearchLogErrors[];
/** 多日志主题检索各日志主题信息 */
Infos?: SearchLogInfos[];
}
/** 投递规则 */
declare interface ShipperInfo {
/** 投递规则ID */
ShipperId?: string;
/** 日志主题ID */
TopicId?: string;
/** 投递的bucket地址 */
Bucket?: string;
/** 投递的前缀目录 */
Prefix?: string;
/** 投递规则的名字 */
ShipperName?: string;
/** 投递的时间间隔,单位 秒 */
Interval?: number;
/** 投递的文件的最大值,单位 MB */
MaxSize?: number;
/** 是否生效 */
Status?: boolean;
/** 投递日志的过滤规则 */
FilterRules?: FilterRuleInfo[];
/** 投递日志的分区规则,支持strftime的时间格式表示 */
Partition?: string;
/** 投递日志的压缩配置 */
Compress?: CompressInfo;
/** 投递日志的内容格式配置 */
Content?: ContentInfo;
/** 投递日志的创建时间。格式:YYYY-MM-DD HH:MM:SS */
CreateTime?: string;
/** 投递文件命名配置,0:随机数命名,1:投递时间命名,默认0(随机数命名) */
FilenameMode?: number;
/** 投递数据范围的开始时间点 */
StartTime?: number;
/** 投递数据范围的结束时间点 */
EndTime?: number;
/** 历史数据投递的进度(仅当用户选择的数据内中历史数据时才有效) */
Progress?: number;
/** 历史数据全部投递完成剩余的时间(仅当用户选择的数据中有历史数据时才有效) */
RemainTime?: number;
/** 历史任务状态:0:实时任务1:任务准备中2:任务运行中3:任务运行异常4:任务运行结束 */
HistoryStatus?: number;
/** 对象存储类型,默认值为 STANDARD。枚举值请参见[ 存储类型概述](https://cloud.tencent.com/document/product/436/33417) 文档。参考值有:STANDARD:标准存储STANDARD_IA:低频存储ARCHIVE:归档存储DEEP_ARCHIVE:深度归档存储MAZ_STANDARD:标准存储(多 AZ)MAZ_STANDARD_IA:低频存储(多 AZ)INTELLIGENT_TIERING:智能分层存储MAZ_INTELLIGENT_TIERING:智能分层存储(多 AZ) */
StorageType?: string;
/** 角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381) */
RoleArn?: string;
/** 外部ID */
ExternalId?: string;
/** 任务运行状态。支持`0`,`1`,`2`- `0`: 停止- `1`: 运行中- `2`: 异常 */
TaskStatus?: number;
}
/** 投递任务信息 */
declare interface ShipperTaskInfo {
/** 投递任务ID */
TaskId?: string;
/** 投递信息ID */
ShipperId?: string;
/** 日志主题ID */
TopicId?: string;
/** 本批投递的日志的开始时间戳,毫秒 */
RangeStart?: number;
/** 本批投递的日志的结束时间戳, 毫秒 */
RangeEnd?: number;
/** 本次投递任务的开始时间戳, 毫秒 */
StartTime?: number;
/** 本次投递任务的结束时间戳, 毫秒 */
EndTime?: number;
/** 本次投递的结果。"success","running","failed"- success:任务成功。- running:任务处理中。- failed:任务失败。 */
Status?: string;
/** 结果的详细信息 */
Message?: string;
}
/** Splunk投递任务信息 */
declare interface SplunkDeliverInfo {
/** 任务id */
TaskId?: string;
/** 任务名称 */
Name?: string;
/** 用户id */
Uin?: number;
/** 日志主题id */
TopicId?: string;
/** 任务状态;1.运行中;2:暂停;3:异常 */
Status?: number;
/** 启用状态;0:禁用;1:启用 */
Enable?: number;
/** 创建时间;单位:秒 */
CreateTime?: number;
/** 更新时间;单位:秒 */
UpdateTime?: number;
/** splunk投递任务-目标配置 */
NetInfo?: NetInfo;
/** splunk投递任务元信息 */
Metadata?: MetadataInfo;
/** 是否启用服务日志;1:关闭;2:开启 */
HasServiceLog?: number;
/** 高级配置-数据来源; */
Source?: string;
/** 高级配置-数据来源类型; */
SourceType?: string;
/** 高级配置-Splunk写入的索引 */
Index?: string;
/** 高级配置-是否启用索引器;1-不开启;2-开启; */
IndexAck?: number;
/** 高级配置-通道 */
Channel?: string;
/** 预过滤处理-对写入 Splunk 原始数据进行预过滤处理语句 */
DSLFilter?: string;
}
/** 创建资源实例时同时绑定的标签对说明 */
declare interface Tag {
/** 标签键 */
Key: string;
/** 标签值 */
Value: string;
}
/** 日志主题扩展信息 */
declare interface TopicExtendInfo {
/** 日志主题免鉴权配置信息 */
AnonymousAccess?: AnonymousInfo | null;
}
/** 仪表盘 topic与地域信息 */
declare interface TopicIdAndRegion {
/** 日志主题id */
TopicId: string;
/** 日志主题id所在的地域id。id,地域,简称信息如下:- 1, 广州,ap-guangzhou- 4, 上海,ap-shanghai- 5, 中国香港,ap-hongkong- 7, 上海金融,ap-shanghai-fsi- 8, 北京,ap-beijing- 9, 新加坡,ap-singapore- 11, 深圳金融,ap-shenzhen-fsi- 15, 硅谷,na-siliconvalley- 16, 成都,ap-chengdu- 17, 法兰克福,eu-frankfurt- 18, 首尔,ap-seoul- 19, 重庆,ap-chongqing- 22, 弗吉尼亚,na-ashburn- 23, 曼谷,ap-bangkok- 25, 东京,ap-tokyo- 33, 南京,ap-nanjing- 46, 北京金融,ap-beijing-fsi- 72, 雅加达,ap-jakarta- 74, 圣保罗,sa-saopaulo */
RegionId: number;
}
/** 主题基本信息 */
declare interface TopicInfo {
/** 日志集ID */
LogsetId?: string;
/** 主题ID */
TopicId?: string;
/** 主题名称 */
TopicName?: string;
/** 主题分区个数 */
PartitionCount?: number;
/** 主题是否开启索引(主题类型需为日志主题) */
Index?: boolean;
/** AssumerUin非空则表示创建该日志主题的服务方Uin */
AssumerUin?: number;
/** 云产品标识,主题由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE */
AssumerName?: string;
/** 创建时间。格式:yyyy-MM-dd HH:mm:ss */
CreateTime?: string;
/** 主题是否开启采集,true:开启采集;false:关闭采集。创建日志主题时默认开启,可通过SDK调用ModifyTopic修改此字段。控制台目前不支持修改此参数。 */
Status?: boolean;
/** 主题绑定的标签信息 */
Tags?: Tag[];
/** RoleName非空则表示创建该日志主题的服务方使用的角色 */
RoleName?: string;
/** 该主题是否开启自动分裂 */
AutoSplit?: boolean;
/** 若开启自动分裂的话,该主题能够允许的最大分区数 */
MaxSplitPartitions?: number;
/** 主题的存储类型- hot: 标准存储- cold: 低频存储 */
StorageType?: string;
/** 生命周期,单位天,可取值范围1~3600。取值为3640时代表永久保存 */
Period?: number;
/** 云产品二级标识,日志主题由其它云产品创建时,该字段会显示云产品名称及其日志类型的二级分类,例如TKE-Audit、TKE-Event。部分云产品仅有云产品标识(AssumerName),无该字段。 */
SubAssumerName?: string;
/** 主题描述 */
Describes?: string;
/** 开启日志沉降,标准存储的生命周期, hotPeriod < Period。标准存储为 hotPeriod, 低频存储则为 Period-hotPeriod。(主题类型需为日志主题)HotPeriod=0为没有开启日志沉降。 */
HotPeriod?: number;
/** kms-cls服务秘钥id */
KeyId?: string;
/** 主题类型。- 0: 日志主题 - 1: 指标主题 */
BizType?: number;
/** 免鉴权开关。 false:关闭; true:开启。开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。 */
IsWebTracking?: boolean;
/** 日志主题扩展信息 */
Extends?: TopicExtendInfo;
/** 异步迁移任务ID */
TopicAsyncTaskID?: string;
/** 异步迁移状态- 1:进行中- 2:已完成- 3:失败- 4:已取消 */
MigrationStatus?: number;
/** 异步迁移完成后,预计生效日期时间格式:yyyy-MM-dd HH:mm:ss */
EffectiveDate?: string;
/** IsSourceFrom 开启记录公网来源ip和服务端接收时间 */
IsSourceFrom?: boolean;
}
/** Partitions */
declare interface TopicPartitionInfo {
/** 日志主题ID */
TopicID: string | null;
/** 分区id列表 */
Partitions: number[] | null;
}
/** TopicPartitionOffsetInfo */
declare interface TopicPartitionOffsetInfo {
/** 日志主题id */
TopicID: string | null;
/** 分区点位信息 */
PartitionOffsets: PartitionOffsetInfo[] | null;
}
/** 用户kafka扩展信息 */
declare interface UserKafkaMeta {
/** 用户kafka version支持如下版本: - 0.10.2.0 - 1.0.0 - 2.0.0 - 2.2.0 - 2.4.0 - 2.6.0 - 2.7.0 - 2.8.0 - 3.0.0 - 3.2.0 */
KafkaVersion: string;
}
/** 需要开启键值索引的字段的索引描述信息 */
declare interface ValueInfo {
/** 字段类型,支持的类型有:long、text、double、json注意:json 类型目前仅部分用户或日志主题支持,如需使用请联系我们开启功能白名单 */
Type: string;
/** 字段的分词符,其中的每个字符代表一个分词符;仅支持英文符号、\n\t\r及转义符\;long及double类型字段需为空;注意:\n\t\r本身已被转义,直接使用双引号包裹即可作为入参,无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式,以避免\n\t\r被重复转义 */
Tokenizer?: string;
/** 字段是否开启分析功能 */
SqlFlag?: boolean;
/** 是否包含中文,long及double类型字段需为false */
ContainZH?: boolean;
/** 字段别名 */
Alias?: string;
/** 仅为子节点开启索引,本字段不开启。注意:仅json类型字段可配置该参数 */
OpenIndexForChildOnly?: boolean;
/** json子节点列表注意:仅json类型字段可配置该参数 */
ChildNode?: KeyValueInfo[];
}
/** 回调地址 */
declare interface WebCallback {
/** 回调的类型。可选值:- Http(自定义接口回调)- WeCom(企业微信)- DingTalk(钉钉)- Lark(飞书) */
CallbackType: string;
/** 回调地址,最大支持1024个字节。也可使用WebCallbackId引用集成配置中的URL,此时该字段请填写为空字符串。 */
Url: string;
/** 集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID */
WebCallbackId?: string;
/** 回调方法。可选值:- POST(默认值)- PUT注意:- 参数CallbackType为Http时为必选,其它回调方式无需填写。 */
Method?: string;
/** 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。 */
NoticeContentId?: string;
/** 提醒类型。0:不提醒;1:指定人;2:所有人 */
RemindType?: number;
/** 电话列表。 */
Mobiles?: string[];
/** 用户ID列表。 */
UserIds?: string[];
/** 该参数已废弃,请使用NoticeContentId。 */
Headers?: string[];
/** 该参数已废弃,请使用NoticeContentId。 */
Body?: string | null;
/** 序号。- 入参无效。- 出参有效。 */
Index?: number;
}
/** 告警渠道回调配置信息 */
declare interface WebCallbackInfo {
/** 告警渠道回调配置id。 */
WebCallbackId?: string;
/** 告警渠道回调配置名称。 */
Name?: string;
/** 渠道类型WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调; */
Type?: string;
/** 回调地址。 */
Webhook?: string;
/** 请求方式。 */
Method?: string;
/** 秘钥信息。 */
Key?: string;
/** 主账号。 */
Uin?: number;
/** 子账号。 */
SubUin?: number;
/** 创建时间。秒(s)级时间戳 */
CreateTime?: number;
/** 更新时间。秒(s)级时间戳 */
UpdateTime?: number;
}
declare interface AddMachineGroupInfoRequest {
/** 机器组Id- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。 */
GroupId: string;
/** 机器组类型目前type支持 ip 和 label */
MachineGroupType: MachineGroupTypeInfo;
}
declare interface AddMachineGroupInfoResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ApplyConfigToMachineGroupRequest {
/** 采集配置ID - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。 */
ConfigId: string;
/** 机器组ID- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。 */
GroupId: string;
}
declare interface ApplyConfigToMachineGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CancelRebuildIndexTaskRequest {
/** 日志主题ID */
TopicId: string;
/** 索引重建任务ID */
TaskId: string;
}
declare interface CancelRebuildIndexTaskResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CheckFunctionRequest {
/** 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733) 其他参考文档:- [创建加工任务](https://cloud.tencent.com/document/product/614/63940) - [函数总览](https://cloud.tencent.com/document/product/614/70395) */
EtlContent: string;
/** 加工任务目标topic_id以及别名,当 FuncType 为 1 时,必填。目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
DstResources?: DataTransformResouceInfo[];
/** 数据加工目标主题的类型. 1 固定主题 2动态创建 */
FuncType?: number;
}
declare interface CheckFunctionResponse {
/** 失败错误码 */
ErrorCode?: number;
/** 失败错误信息 */
ErrorMsg?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CheckRechargeKafkaServerRequest {
/** 导入Kafka类型,0: 腾讯云CKafka;1: 用户自建Kafka。 */
KafkaType: number;
/** 腾讯云CKafka实例ID。KafkaType为0时,KafkaInstance必填- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。 */
KafkaInstance?: string;
/** 服务地址。KafkaType为1时,ServerAddr必填 */
ServerAddr?: string;
/** ServerAddr是否为加密连接,默认值false。当KafkaType为1用户自建kafka时生效。 */
IsEncryptionAddr?: boolean;
/** 加密访问协议。KafkaType参数为1并且IsEncryptionAddr参数为true时必填。 */
Protocol?: KafkaProtocolInfo;
/** 用户kafka拓展信息 */
UserKafkaMeta?: UserKafkaMeta;
}
declare interface CheckRechargeKafkaServerResponse {
/** Kafka集群可访问状态。- 0:可正常访问 - -1:broker 连接失败- -2:sasl 鉴权失败- -3:ckafka 角色未授权- -4:topic 列表不存在- -5:topic 内暂无数据- -6:用户没有 ckafka 权限- -7:消费组已经存在- -8:kafka 实例不存在或已销毁- -9:Broker 列表为空- -10:Broker 地址格式不正确- -11:Broker 端口非整型 */
Status?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CloseKafkaConsumerRequest {
/** 日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
FromTopicId: string;
}
declare interface CloseKafkaConsumerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CommitConsumerOffsetsRequest {
/** 消费组标识 */
ConsumerGroup: string;
/** 消费机器名称 */
Consumer: string;
/** 日志集id */
LogsetId: string;
/** topic分区点位信息 */
TopicPartitionOffsetsInfo: TopicPartitionOffsetInfo[];
}
declare interface CommitConsumerOffsetsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAlarmNoticeRequest {
/** 通知渠道组名称。最大支持255个字节。 不支持 '|'。 */
Name: string;
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持50个标签键值对,并且不能有重复的键值对。 */
Tags?: Tag[];
/** 【简易模式】(简易模式/告警模式二选一,分别配置相应参数)需要发送通知的告警类型。可选值:- Trigger - 告警触发- Recovery - 告警恢复- All - 告警触发和告警恢复 */
Type?: string;
/** 【简易模式】(简易模式/告警模式二选一,分别配置相应参数)通知接收对象。 */
NoticeReceivers?: NoticeReceiver[];
/** 【简易模式】(简易模式/告警模式二选一,分别配置相应参数)接口回调信息(包括企业微信、钉钉、飞书)。 */
WebCallbacks?: WebCallback[];
/** 【高级模式】(简易模式/告警模式二选一,分别配置相应参数)通知规则。 */
NoticeRules?: NoticeRule[];
/** 查询数据链接。http:// 或者 https:// 开头,不能/结尾 */
JumpDomain?: string;
/** 投递日志开关。可取值如下:1:关闭(默认值);2:开启 投递日志开关开启时, DeliverConfig参数必填。 */
DeliverStatus?: number;
/** 投递日志配置参数。当DeliverStatus开启时,必填。 */
DeliverConfig?: DeliverConfig;
/** 免登录操作告警开关。可取值如下:- 1:关闭- 2:开启(默认值) */
AlarmShieldStatus?: number;
/** 统一设定自定义回调参数。- true: 使用通知内容模板中的自定义回调参数覆盖告警策略中单独配置的请求头及请求内容。- false:优先使用告警策略中单独配置的请求头及请求内容。 */
CallbackPrioritize?: boolean;
}
declare interface CreateAlarmNoticeResponse {
/** 告警模板ID */
AlarmNoticeId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAlarmRequest {
/** 告警策略名称。最大支持255个字节。 不支持 '|'。 */
Name: string;
/** 监控对象列表。 */
AlarmTargets: AlarmTarget[];
/** 监控任务运行时间点。 */
MonitorTime: MonitorTime;
/** 持续周期。持续满足触发条件TriggerCount个周期后,再进行告警;最小值为1,最大值为2000。 */
TriggerCount: number;
/** 告警重复的周期,单位是分钟。取值范围是0~1440。 */
AlarmPeriod: number;
/** 关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表,和MonitorNotice互斥 */
AlarmNoticeIds?: string[];
/** 告警发送通知的触发条件 注意: - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。 */
Condition?: string;
/** 告警级别0:警告(Warn); 1:提醒(Info); 2:紧急 (Critical)。注意: - 不填则默认为0。- Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。 */
AlarmLevel?: number;
/** 多触发条件 注意: - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。 */
MultiConditions?: MultiCondition[];
/** 是否开启告警策略。默认值为true */
Status?: boolean;
/** 请使用Status参数控制是否开启告警策略。 */
Enable?: boolean;
/** 用户自定义告警内容 */
MessageTemplate?: string;
/** 用户自定义回调 */
CallBack?: CallBackInfo;
/** 多维分析 */
Analysis?: AnalysisDimensional[];
/** 分组触发状态。默认值false */
GroupTriggerStatus?: boolean;
/** 分组触发条件。 */
GroupTriggerCondition?: string[];
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的告警策略。最大支持10个标签键值对,并且不能有重复的键值对。 */
Tags?: Tag[];
/** 监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。 不填则默认为0。当值为1时,AlarmTargets元素个数不能超过10个,AlarmTargets中的Number必须是从1开始的连续正整数,不能重复。 */
MonitorObjectType?: number;
/** 告警附加分类信息列表。Classifications元素个数不能超过20个。Classifications元素的Key不能为空,不能重复,长度不能超过50个字符,符合正则 `^[a-z]([a-z0-9_]{0,49})$`。Classifications元素的Value长度不能超过200个字符。 */
Classifications?: AlarmClassification[];
}
declare interface CreateAlarmResponse {
/** 告警策略ID。 */
AlarmId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAlarmShieldRequest {
/** 通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取通知渠道组id */
AlarmNoticeId: string;
/** 屏蔽规则开始时间,秒级(s)时间戳。 */
StartTime: number;
/** 屏蔽规则结束时间,秒级(s)时间戳。结束时间需要大于当前时间 */
EndTime: number;
/** 屏蔽类型。1:屏蔽所有通知,2:按照Rule参数屏蔽匹配规则的通知。 */
Type: number;
/** 屏蔽原因。 */
Reason: string;
/** 屏蔽规则,当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178)。 */
Rule?: string;
}
declare interface CreateAlarmShieldResponse {
/** 屏蔽规则ID。 */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCloudProductLogCollectionRequest {
/** 实例ID- 通过各个接入云产品官方文档获取 */
InstanceId: string;
/** 云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS */
AssumerName: string;
/** 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS */
LogType: string;
/** 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:- CDS所有日志类型:ap-guangzhou- CDB-AUDIT: gz- TDSQL-C-AUDIT: gz- MongoDB-AUDIT: gz- MongoDB-SlowLog:ap-guangzhou- MongoDB-ErrorLog:ap-guangzhou- TDMYSQL-SLOW:gz- DCDB所有日志类型:gz- MariaDB所有日志类型:gz- PostgreSQL所有日志类型:gz- BH所有日志类型:overseas-polaris(中国香港地区和其他)/fsi-polaris(金融区)/general-polaris(普通区)/intl-sg-prod(国际站)- APIS所有日志类型:gz */
CloudProductRegion: string;
/** CLS目标地域- 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474) 文档 */
ClsRegion: string;
/** 日志集名称,未填LogsetId时必填。若日志集不存在, 将自动创建 */
LogsetName?: string;
/** 日志主题名称,在未填TopicId时必填。 若日志主题不存在,将自动创建 */
TopicName?: string;
/** 日志配置扩展信息, 一般用于存储额外的日志投递配置 */
Extend?: string;
/** 日志集id- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。 */
LogsetId?: string;
/** 日志主题id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId?: string;
}
declare interface CreateCloudProductLogCollectionResponse {
/** 日志主题ID */
TopicId?: string;
/** 日志主题名称 */
TopicName?: string;
/** 日志集ID */
LogsetId?: string;
/** 日志集名称 */
LogsetName?: string;
/** -1 创建中,1创建完成 */
Status?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateConfigExtraRequest {
/** 采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾 */
Name: string;
/** 日志主题id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。 */
Type: string;
/** 采集的日志类型,默认为minimalist_log。支持以下类型:- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。 */
LogType: string;
/** 采集配置标记。- 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置 */
ConfigFlag: string;
/** 日志集id- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。 */
LogsetId: string;
/** 日志集名称- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。 */
LogsetName: string;
/** 日志主题名称- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。 */
TopicName: string;
/** 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。- 详细参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471) 信息。 */
HostFile?: HostFileInfo;
/** 容器文件路径类型配置。 */
ContainerFile?: ContainerFileInfo;
/** 自建k8s-容器标准输出信息,包括容器、命名空间等。- 详细参考 [ContainerStdoutInfo](https://cloud.tencent.com/document/api/614/56471) 信息。 */
ContainerStdout?: ContainerStdoutInfo;
/** 日志格式化方式,用于容器采集场景。- stdout-docker-json:用于docker容器采集场景- stdout-containerd:用于containerd容器采集场景 */
LogFormat?: string;
/** 提取规则,如果设置了ExtractRule,则必须设置LogType */
ExtractRule?: ExtractRuleInfo;
/** 采集黑名单路径列表 */
ExcludePaths?: ExcludePathInfo[];
/** 组合解析采集规则,用于复杂场景下的日志采集。- 取值参考:[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310) */
UserDefineRule?: string;
/** 绑定的机器组ID- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。- GroupId 与 GroupIds 选择其一即可,不可同时为空。 */
GroupId?: string;
/** 绑定的机器组ID列表- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id信息。- GroupId 与 GroupIds 选择其一即可,不可同时为空。 */
GroupIds?: string[];
/** 采集相关配置信息。详细参考 [CollectInfo](https://cloud.tencent.com/document/api/614/56471) 信息。 */
CollectInfos?: CollectInfo[];
/** 高级采集配置。 Json字符串, Key/Value定义为如下:- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false- ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0 */
AdvancedConfig?: string;
}
declare interface CreateConfigExtraResponse {
/** 采集配置扩展信息ID */
ConfigExtraId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateConfigRequest {
/** 采集配置名称- 名称种不得包含特殊字符|- 名称最长255字符,超过截断 */
Name: string;
/** 采集配置所属日志主题ID即TopicId- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
Output: string;
/** 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填 */
Path?: string;
/** 采集的日志类型,默认为minimalist_log。支持以下类型:- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310));- service_syslog代表:syslog 采集(详见[采集 Syslog](https://cloud.tencent.com/document/product/614/81454));- windows_event_log代表:Windows事件日志(详见[采集 Windows 事件日志](https://cloud.tencent.com/document/product/614/96678))。 */
LogType?: string;
/** 提取规则,如果设置了ExtractRule,则必须设置LogType */
ExtractRule?: ExtractRuleInfo;
/** 采集黑名单路径列表 */
ExcludePaths?: ExcludePathInfo[];
/** 用户自定义采集规则,Json格式序列化的字符串。当LogType为user_define_log时,必填。 */
UserDefineRule?: string;
/** 高级采集配置。 Json字符串, Key/Value定义为如下:- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false样例:`{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}`控制台默认占位值:`{\"ClsAgentDefault\":0}` */
AdvancedConfig?: string;
/** 日志输入类型(注:windows场景必填且仅支持file和windows_event类型)- file: 文件类型采集- windows_event:windows事件采集- syslog:系统日志采集 */
InputType?: string;
}
declare interface CreateConfigResponse {
/** 采集配置ID */
ConfigId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateConsoleSharingRequest {
/** 免密分享配置 */
SharingConfig: ConsoleSharingConfig;
}
declare interface CreateConsoleSharingResponse {
/** 免密分享链接 */
SharingUrl?: string;
/** 免密分享链接ID */
SharingId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateConsumerGroupRequest {
/** 创建的消费者组标识限制: 字母数字下划线,不允许数字开头,长度限制256 */
ConsumerGroup: string;
/** 消费者心跳超时时间(秒) */
Timeout: number;
/** 创建的消费者组包含的日志主题列表 */
Topics: string[];
/** 日志集Id(日志主题所属的日志集) */
LogsetId: string;
}
declare interface CreateConsumerGroupResponse {
/** 消费组标识 */
ConsumerGroup?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateConsumerRequest {
/** 投递任务绑定的日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** 是否投递日志的元数据信息,默认为 true。当NeedContent为true时:字段Content有效。当NeedContent为false时:字段Content无效。 */
NeedContent?: boolean;
/** 如果需要投递元数据信息,元数据信息的描述 */
Content?: ConsumerContent;
/** CKafka的描述 */
Ckafka?: Ckafka;
/** 投递时压缩方式,取值0,2,3。[0:NONE;2:SNAPPY;3:LZ4] */
Compression?: number;
/** 角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381) */
RoleArn?: string;
/** 外部ID */
ExternalId?: string;
/** 高级配置项 */
AdvancedConfig?: AdvancedConsumerConfiguration;
}
declare interface CreateConsumerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateCosRechargeRequest {
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 日志集Id。- 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。 */
LogsetId: string;
/** COS导入任务名称,最大支持128个字节。 */
Name: string;
/** COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。 */
Bucket: string;
/** COS存储桶所在地域,详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。 */
BucketRegion: string;
/** 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文;默认为minimalist_log */
LogType: string;
/** COS文件所在文件夹的前缀。默认为空,投递存储桶下所有的文件。 */
Prefix?: string;
/** supported: "", "gzip", "lzop", "snappy"。默认空,不压缩。 */
Compress?: string;
/** 提取规则,如果设置了ExtractRule,则必须设置LogType */
ExtractRuleInfo?: ExtractRuleInfo;
/** COS导入任务类型。1:一次性导入任务;2:持续性导入任务。默认为1:一次性导入任务 */
TaskType?: number;
/** 元数据。 */
Metadata?: string[];
}
declare interface CreateCosRechargeResponse {
/** COS导入任务id */
Id?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDashboardRequest {
/** 仪表盘名称 */
DashboardName: string;
/** 仪表盘配置数据 */
Data?: string;
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。 */
Tags?: Tag[];
}
declare interface CreateDashboardResponse {
/** 仪表盘id */
DashboardId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDashboardSubscribeRequest {
/** 仪表盘订阅名称。输入限制:- 不能为空- 长度不能超过128字节- 不能包含字符'|' */
Name: string;
/** 仪表盘Id。- 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。 */
DashboardId: string;
/** 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。- {秒数} 取值范围: 0 ~ 59 - {分钟} 取值范围: 0 ~ 59 - {小时} 取值范围: 0 ~ 23 - {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L) - {月份} 取值范围: 1 ~ 12 - {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】 */
Cron: string;
/** 仪表盘订阅数据。 */
SubscribeData: DashboardSubscribeData;
}
declare interface CreateDashboardSubscribeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDataTransformRequest {
/** 任务类型. 1: 指定主题;2:动态创建。详情请参考[创建加工任务文档](https://cloud.tencent.com/document/product/614/63940)。 */
FuncType: number;
/** 日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
SrcTopicId: string;
/** 加工任务名称名称限制- 不能为空字符串- 不能包含字符'|'- 最长 255 个字符 */
Name: string;
/** 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733) 其他参考文档:- [创建加工任务](https://cloud.tencent.com/document/product/614/63940) - [函数总览](https://cloud.tencent.com/document/product/614/70395) */
EtlContent: string;
/** 加工类型。1:使用源日志主题中的随机数据,进行加工预览;2:使用用户自定义测试数据,进行加工预览;3:创建真实加工任务。 */
TaskType: number;
/** 加工任务目标topic_id以及别名,当FuncType=1时,该参数必填,当FuncType=2时,无需填写。目标topic_id,通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。别名限制 1.不能为空字符串,2. 不能包含字符'|'。 */
DstResources?: DataTransformResouceInfo[];
/** 任务启动状态. 默认为1:开启, 2:关闭 */
EnableFlag?: number;
/** 用于预览加工结果的测试数据目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
PreviewLogStatistics?: PreviewLogStatistic[];
/** 当FuncType为2时,动态创建的日志集、日志主题的个数超出产品规格限制是否丢弃数据, 默认为false。false:创建兜底日志集、日志主题并将日志写入兜底主题;true:丢弃日志数据。 */
BackupGiveUpData?: boolean;
/** 是否开启投递服务日志。1:关闭,2:开启。 */
HasServicesLog?: number;
/** 数据加工类型。0:标准加工任务; 1:前置加工任务。前置加工任务将采集的日志处理完成后,再写入日志主题。 */
DataTransformType?: number;
/** 保留失败日志状态,1:不保留(默认),2:保留。 */
KeepFailureLog?: number;
/** 失败日志的字段名称 */
FailureLogKey?: string;
/** 指定加工数据的开始时间, 秒级时间戳。 - 日志主题生命周期内的任意时间范围,如果超出了生命周期,只处理生命周期内有数据的部分。 */
ProcessFromTimestamp?: number;
/** 指定加工数据的结束时间,秒级时间戳。- 不可指定未来的时间- 不填则表示持续执行 */
ProcessToTimestamp?: number;
/** 对已经创建的并且使用了关联外部数据库能力的任务预览(TaskType 为 1 或 2)时,该值必传数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。 */
TaskId?: string;
/** 关联的数据源信息 */
DataTransformSqlDataSources?: DataTransformSqlDataSource[];
/** 设置的环境变量 */
EnvInfos?: EnvInfo[];
}
declare interface CreateDataTransformResponse {
/** 任务id */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDeliverCloudFunctionRequest {
/** 投递规则属于的TopicId。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** 投递的云函数名字。仅支持[事件函数](https://cloud.tencent.com/document/product/583/9694) ([函数类型选型](https://cloud.tencent.com/document/product/583/73483))通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。 */
FunctionName: string;
/** 命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)- 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。 */
Namespace: string;
/** 函数版本。- 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。 */
Qualifier: string;
/** 投递最长等待时间,单位:秒。 默认:60 */
Timeout?: number;
/** 投递最大消息数。默认为100。支持范围[1,10000] */
MaxMsgNum?: number;
}
declare interface CreateDeliverCloudFunctionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateDlcDeliverRequest {
/** 日志主题id。通过获取日志主题列表获取日志主题Id。 */
TopicId: string;
/** 名称:长度不超过64字符,以字母开头,接受0-9,a-z,A-Z, _,-,中文字符。 */
Name: string;
/** 投递类型。0:批投递,1:实时投递 */
DeliverType: number;
/** 投递时间范围的开始时间 */
StartTime: number;
/** dlc配置信息 */
DlcInfo: DlcInfo;
/** 投递文件大小,单位MB。 DeliverType=0时必填,范围 5<= MaxSize <= 256。 */
MaxSize?: number;
/** 投递间隔,单位秒。 DeliverType=0时必填,范围 300<= Interval <=900。 */
Interval?: number;
/** 投递时间范围的结束时间。 如果为空,则表示不限时。EndTime不为空时,需要大于StartTime。 */
EndTime?: number;
/** 是否开启投递服务日志。1关闭,2开启。默认开启 */
HasServicesLog?: number;
}
declare interface CreateDlcDeliverResponse {
/** 配置id */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateEsRechargeRequest {
/** 日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** 名称:长度不超过64字符。 */
Name: string;
/** 索引信息。不同索引可以通过英文逗号分隔,支持*通配符 */
Index: string;
/** es查询语句。 */
Query: string;
/** es集群配置信息。 */
EsInfo: EsInfo;
/** es导入信息。 */
ImportInfo: EsImportInfo;
/** es导入时间字段信息。 */
TimeInfo: EsTimeInfo;
/** 是否开启投递服务日志。1:关闭,2:开启。默认开启。 */
HasServicesLog?: number;
}
declare interface CreateEsRechargeResponse {
/** 配置id */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateExportRequest {
/** 日志主题Id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 日志导出数量, 最大值5000万 */
Count: number;
/** 日志导出检索语句,不支持[SQL语句] */
Query: string;
/** 日志导出起始时间,毫秒时间戳 */
From: number;
/** 日志导出结束时间,毫秒时间戳 */
To: number;
/** 日志导出时间排序。desc,asc,默认为desc */
Order?: string;
/** 日志导出数据格式。json,csv,默认为json */
Format?: string;
/** 语法规则, 默认值为0。0:Lucene语法,1:CQL语法。 */
SyntaxRule?: number;
/** 导出字段 */
DerivedFields?: string[];
}
declare interface CreateExportResponse {
/** 日志导出ID。 */
ExportId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateHostMetricConfigRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** 名称。- 长度不超过 64字符。 */
Name: string;
/** 机器组id列表。最多支持100个机器组。 */
MachineGroupIds: string[];
/** 采集频率。单位:ms。 最小支持5000ms */
Interval: number;
/** 采集项。支持"cpu","mem","net","disk","system"。**目前仅支持:所有采集项都需配置**。- cpu:CPU- mem:内存- net:网络- disk:磁盘- system:系统 */
HostMetricItems: HostMetricItem[];
}
declare interface CreateHostMetricConfigResponse {
/** 主机指标采集配置id */
ConfigId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateIndexRequest {
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 索引规则 */
Rule: RuleInfo;
/** 是否生效,默认为true */
Status?: boolean;
/** 内置保留字段(`__FILENAME__`,`__HOSTNAME__`及`__SOURCE__`)是否包含至全文索引,默认为false,推荐设置为true* false:不包含* true:包含 */
IncludeInternalFields?: boolean;
/** 元数据字段(前缀为`__TAG__`的字段)是否包含至全文索引,默认为0,推荐设置为1* 0:仅包含开启键值索引的元数据字段* 1:包含所有元数据字段* 2:不包含任何元数据字段 */
MetadataFlag?: number;
/** 自定义日志解析异常存储字段。 */
CoverageField?: string;
}
declare interface CreateIndexResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateKafkaRechargeRequest {
/** 导入CLS目标TopicId。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** Kafka导入配置名称 */
Name: string;
/** 导入Kafka类型,0: 腾讯云CKafka,1: 用户自建Kafka */
KafkaType: number;
/** 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开 */
UserKafkaTopics: string;
/** 导入数据位置,-2:最早(默认),-1:最晚 */
Offset: number;
/** 日志导入规则。 */
LogRechargeRule: LogRechargeRuleInfo;
/** 腾讯云CKafka实例ID,KafkaType为0时必填。- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。 */
KafkaInstance?: string;
/** 服务地址,KafkaType为1时必填。 */
ServerAddr?: string;
/** ServerAddr是否为加密连接,KafkaType为1时必填。 */
IsEncryptionAddr?: boolean;
/** 加密访问协议。KafkaType为1并且IsEncryptionAddr为true时Protocol必填。 */
Protocol?: KafkaProtocolInfo;
/** 用户Kafka消费组名称。- 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。 */
ConsumerGroupName?: string;
/** 用户kafka拓展信息 */
UserKafkaMeta?: UserKafkaMeta;
}
declare interface CreateKafkaRechargeResponse {
/** Kafka导入配置ID */
Id?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateLogsetRequest {
/** 日志集名字。- 最大支持255个字符。不支持`|`字符。 */
LogsetName: string;
/** 标签描述列表。最大支持10个标签键值对,并且不能有重复的键值对 */
Tags?: Tag[];
/** 日志集ID,格式为:用户自定义部分-用户APPID。未填写该参数时将自动生成ID。- 用户自定义部分仅支持小写字母、数字和-,且不能以-开头和结尾,长度为3至40字符。- 尾部需要使用-拼接用户APPID,APPID可在https://console.cloud.tencent.com/developer页面查询。- 如果指定该字段,需保证全地域唯一 */
LogsetId?: string;
}
declare interface CreateLogsetResponse {
/** 日志集ID */
LogsetId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateMachineGroupRequest {
/** 机器组名字。输入限制:- 最大支持255个字符,不能为空字符串- 不能包含字符'|' */
GroupName: string;
/** 创建机器组类型。取值如下:- Type:ip,Values中为ip字符串列表创建机器组- Type:label,Values中为标签字符串列表创建机器组 */
MachineGroupType: MachineGroupTypeInfo;
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的机器组。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。 */
Tags?: Tag[];
/** 是否开启机器组自动更新。默认false */
AutoUpdate?: boolean;
/** 升级开始时间,建议业务低峰期升级LogListener时间格式:HH:mm:ss */
UpdateStartTime?: string;
/** 升级结束时间,建议业务低峰期升级LogListener时间格式:HH:mm:ss */
UpdateEndTime?: string;
/** 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费。默认false */
ServiceLogging?: boolean;
/** 机器组中机器离线清理时间。单位:天- 大于0时生效。 */
DelayCleanupTime?: number;
/** 机器组元数据信息列表 */
MetaTags?: MetaTagInfo[];
/** 系统类型,取值如下:- 0:Linux (默认值)- 1:Windows */
OSType?: number;
}
declare interface CreateMachineGroupResponse {
/** 机器组ID */
GroupId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateMetricConfigRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** 采集配置来源。支持 :`0`、`1`- 0:自建k8s- 1:TKE */
Source: number;
/** 机器组id。 */
GroupIds: string[];
/** 监控类型。支持 :`0`、`1`,不支持修改- 0:基础监控- 1:自定义监控, */
Type: number;
/** 采集配置方式。支持 :`0`、`1`,不支持修改- 0:普通配置方式,Type字段只能为:``1`- 1:YAML导入方式, Type 可以是:`0`或者`1` */
Flag: number;
/** 名称:长度不超过253字符,校验格式 ` [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`。 */
Name?: string;
/** 采集对象, Flag=0时生效 */
Spec?: MetricSpec;
/** 标签处理, Flag=0时生效 */
MetricRelabels?: Relabeling[];
/** 自定义元数据, Flag=0时生效 */
MetricLabel?: MetricConfigLabel;
/** 通信协议 http、https; Flag=0时生效 */
Scheme?: string;
/** 采集频率, Flag=0时生效- 校验格式:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$`- 默认:60s */
ScrapeInterval?: string;
/** 采集超时时间, Flag=0时生效- 校验格式:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$`- 默认:30s */
ScrapeTimeout?: string;
/** Prometheus如何处理标签之间的冲突。当Flag=0时生效,支持`true`,`false`- `false`:配置数据中冲突的标签重命名- `true`:忽略冲突的服务器端标签 */
HonorLabels?: boolean;
/** 采集配置yaml格式字符串, Flag=1时必填 */
YamlSpec?: MetricYamlSpec;
}
declare interface CreateMetricConfigResponse {
/** 指标采集配置id列表。 */
ConfigIds?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateMetricSubscribeRequest {
/** 名称:长度不超过64字符,以字母开头,接受0-9,a-z,A-Z, _,-,中文字符。 */
Name: string;
/** 日志主题id。 */
TopicId: string;
/** 云产品命名空间。 */
Namespace: string;
/** 数据库配置信息。 */
Metrics: MetricConfig[];
/** 实例配置配置。 */
InstanceInfo: InstanceConfig;
}
declare interface CreateMetricSubscribeResponse {
/** 配置id */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateNoticeContentRequest {
/** 模板名称。最大支持255个字节 */
Name: string;
/** 模板内容语言。0:中文1:英文 */
Type?: number;
/** 模板详细配置。 */
NoticeContents?: NoticeContent[];
}
declare interface CreateNoticeContentResponse {
/** 通知内容配置ID */
NoticeContentId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateRebuildIndexTaskRequest {
/** 日志主题ID */
TopicId: string;
/** 重建起始时间戳,毫秒起始时间不允许超过日志生命周期 */
StartTime: number;
/** 重建结束时间戳,毫秒结束时间不晚于当前时间往前推15分钟注意:建议提前使用“预估重建索引任务(EstimateRebuildIndexTask)”接口评估该时间范围重建索引涉及到的数据量及耗时,避免因数据量过大导致费用成本过高或耗时过长 */
EndTime: number;
}
declare interface CreateRebuildIndexTaskResponse {
/** 索引重建任务ID */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateScheduledSqlRequest {
/** 源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
SrcTopicId: string;
/** 任务名称,0~255字符 */
Name: string;
/** 任务启动状态. 1开启, 2关闭 */
EnableFlag: number;
/** 定时SQL分析目标日志主题 */
DstResource: ScheduledSqlResouceInfo;
/** 查询语句 */
ScheduledSqlContent: string;
/** 调度开始时间,Unix时间戳,单位ms */
ProcessStartTime: number;
/** 调度类型,1:持续运行 2:指定时间范围 */
ProcessType: number;
/** 调度周期(分钟),1~1440分钟 */
ProcessPeriod: number;
/** 单次查询的时间窗口,如果您的目标主题为指标主题,建议该参数的大小不超过30分钟,否则可能转指标失败。 */
ProcessTimeWindow: string;
/** 执行延迟(秒),0~120秒,默认60秒 */
ProcessDelay: number;
/** 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474) 文档 */
SrcTopicRegion: string;
/** 调度结束时间,当ProcessType=2时为必传字段, Unix时间戳,单位ms */
ProcessEndTime?: number;
/** 查询语法规则。 默认值为0。0:Lucene语法,1:CQL语法 */
SyntaxRule?: number;
}
declare interface CreateScheduledSqlResponse {
/** 任务id */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateShipperRequest {
/** 创建的投递规则所属的日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。 */
Bucket: string;
/** 投递规则投递的新的目录前缀。- 仅支持0-9A-Za-z-_/- 最大支持256个字符 */
Prefix: string;
/** 投递规则的名字。最大支持255个字符 */
ShipperName: string;
/** 投递的时间间隔,单位 秒,默认300,范围 300-900 */
Interval?: number;
/** 投递的文件的最大值,单位 MB,默认256,范围 5-256 */
MaxSize?: number;
/** 投递日志的过滤规则,匹配的日志进行投递,各rule之间是and关系,最多5个,数组为空则表示不过滤而全部投递 */
FilterRules?: FilterRuleInfo[];
/** 投递日志的分区规则,支持strftime的时间格式表示 */
Partition?: string;
/** 投递日志的压缩配置 */
Compress?: CompressInfo;
/** 投递日志的内容格式配置 */
Content?: ContentInfo;
/** 投递文件命名配置,0:随机数命名,1:投递时间命名,默认0(随机数命名) */
FilenameMode?: number;
/** 投递数据范围的开始时间点(秒级时间戳),不能超出日志主题的生命周期起点。如果用户不填写,默认为用户新建投递任务的时间。 */
StartTime?: number;
/** 投递数据范围的结束时间点(秒级时间戳),不能填写未来时间。如果用户不填写,默认为持续投递,即无限。 */
EndTime?: number;
/** 对象存储类型,默认值为 STANDARD。枚举值请参见[ 存储类型概述](https://cloud.tencent.com/document/product/436/33417) 文档。参考值有:- STANDARD:标准存储- STANDARD_IA:低频存储- ARCHIVE:归档存储- DEEP_ARCHIVE:深度归档存储- MAZ_STANDARD:标准存储(多 AZ)- MAZ_STANDARD_IA:低频存储(多 AZ)- INTELLIGENT_TIERING:智能分层存储- MAZ_INTELLIGENT_TIERING:智能分层存储(多 AZ) */
StorageType?: string;
/** 角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381) */
RoleArn?: string;
/** 外部ID */
ExternalId?: string;
}
declare interface CreateShipperResponse {
/** 投递任务ID */
ShipperId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateSplunkDeliverRequest {
/** 日志主题id- 通过获取日志主题列表获取日志主题Id。 */
TopicId: string;
/** splunk投递任务名称;name有如下限制:- 不能为空- 长度不大于64- 只能包含aA-zZ、下划线、-、0-9 */
Name: string;
/** Splunk投递任务-目标配置-网络信息 */
NetInfo: NetInfo;
/** Splunk投递任务元信息 */
MetadataInfo: MetadataInfo;
/** 是否开启服务日志 1:关闭;2:开启 ;默认开启 */
HasServiceLog?: number;
/** 高级配置-是否启用索引器;1-不启用;2-启用;默认:1 */
IndexAck?: number;
/** 高级配置-数据来源;不超过64个字符 */
Source?: string;
/** 高级配置-数据来源类型;不超过64个字符 */
SourceType?: string;
/** 高级配置-Splunk写入的索引;不超过64个字符 */
Index?: string;
/** 高级配置-通道需满足限制:如果启用索引器,那么Channel必填 */
Channel?: string;
/** 日志预过滤-数据写入 Splunk 的原始数据进行预过滤处理 */
DSLFilter?: string;
}
declare interface CreateSplunkDeliverResponse {
/** splunk投递任务id */
TaskId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateTopicRequest {
/** 日志集ID- 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。 */
LogsetId: string;
/** 主题名称名称限制- 不能为空字符串- 不能包含字符'|'- 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"] */
TopicName: string;
/** 主题分区个数。默认创建1个,最大支持创建10个分区。 */
PartitionCount?: number;
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的主题。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。 */
Tags?: Tag[];
/** 是否开启自动分裂,默认值为true */
AutoSplit?: boolean;
/** 开启自动分裂后,每个主题能够允许的最大分区数,默认值为50 */
MaxSplitPartitions?: number;
/** 日志主题的存储类型,可选值 hot(标准存储),cold(低频存储);默认为hot。指标主题不支持该配置。 */
StorageType?: string;
/** 存储时间,单位天。- 日志主题:日志接入标准存储时,支持1至3600天,值为3640时代表永久保存。- 日志主题:日志接入低频存储时,支持7至3600天,值为3640时代表永久保存。- 指标主题:支持1至3600天,值为3640时代表永久保存。 */
Period?: number;
/** 主题描述 */
Describes?: string;
/** 0:日志主题关闭日志沉降。非0:日志主题开启日志沉降后标准存储的天数,HotPeriod需要大于等于7,且小于Period。仅在StorageType为 hot 时生效,指标主题不支持该配置。 */
HotPeriod?: number;
/** 加密相关参数。 支持加密地域并且开白用户可以传此参数,其他场景不能传递该参数。0或者不传: 不加密1:kms-cls 云产品密钥加密支持地域:ap-beijing,ap-guangzhou,ap-shanghai,ap-singapore,ap-bangkok,ap-jakarta,eu-frankfurt,ap-seoul,ap-tokyo */
Encryption?: number;
/** 主题类型- 0:日志主题,默认值- 1:指标主题 */
BizType?: number;
/** 主题自定义ID,格式为:用户自定义部分-用户APPID。未填写该参数时将自动生成ID。- 用户自定义部分仅支持小写字母、数字和-,且不能以-开头和结尾,长度为3至40字符- 尾部需要使用-拼接用户APPID,APPID可在https://console.cloud.tencent.com/developer页面查询。- 如果指定该字段,需保证全地域唯一 */
TopicId?: string;
/** 免鉴权开关。 false:关闭; true:开启。默认为false。开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。指标主题不支持该配置。 */
IsWebTracking?: boolean;
/** 主题扩展信息 */
Extends?: TopicExtendInfo;
/** 开启记录公网来源ip和服务端接收时间 */
IsSourceFrom?: boolean;
}
declare interface CreateTopicResponse {
/** 主题ID */
TopicId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateWebCallbackRequest {
/** 通知内容名称。最大支持255个字节 */
Name: string;
/** 渠道类型。WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调。 */
Type: string;
/** Webhook地址。 */
Webhook: string;
/** 请求方式。 支持POST、PUT。当Type为Http时,必填。 */
Method?: string;
/** 秘钥。最大支持1024个字节 */
Key?: string;
}
declare interface CreateWebCallbackResponse {
/** 回调配置ID。 */
WebCallbackId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteAlarmNoticeRequest {
/** 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID */
AlarmNoticeId: string;
}
declare interface DeleteAlarmNoticeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteAlarmRequest {
/** 告警策略ID。 */
AlarmId: string;
}
declare interface DeleteAlarmResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteAlarmShieldRequest {
/** 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID */
TaskId: string;
/** 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id */
AlarmNoticeId: string;
}
declare interface DeleteAlarmShieldResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteCloudProductLogCollectionRequest {
/** 实例ID */
InstanceId: string;
/** 云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS */
AssumerName: string;
/** 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS */
LogType: string;
/** 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:- CDS所有日志类型:ap-guangzhou- CDB-AUDIT: gz- TDSQL-C-AUDIT: gz- MongoDB-AUDIT: gz- MongoDB-SlowLog:ap-guangzhou- MongoDB-ErrorLog:ap-guangzhou- TDMYSQL-SLOW:gz- DCDB所有日志类型:gz- MariaDB所有日志类型:gz- PostgreSQL所有日志类型:gz- BH所有日志类型:overseas-polaris(中国香港地区和其他)/fsi-polaris(金融区)/general-polaris(普通区)/intl-sg-prod(国际站)- APIS所有日志类型:gz */
CloudProductRegion: string;
}
declare interface DeleteCloudProductLogCollectionResponse {
/** 枚举值,0创建中 1创建完成 2删除中 3删除完成 */
Status?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteConfigExtraRequest {
/** 特殊采集规则扩展配置ID- 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。 */
ConfigExtraId: string;
}
declare interface DeleteConfigExtraResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteConfigFromMachineGroupRequest {
/** 机器组ID- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。 */
GroupId: string;
/** 采集配置ID - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。 */
ConfigId: string;
}
declare interface DeleteConfigFromMachineGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteConfigRequest {
/** 采集配置ID - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。 */
ConfigId: string;
}
declare interface DeleteConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteConsoleSharingRequest {
/** 免密分享Id。- 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。 - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。 */
SharingId: string;
}
declare interface DeleteConsoleSharingResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteConsumerGroupRequest {
/** 需要删除的消费者组标识 */
ConsumerGroup: string;
/** 日志集id */
LogsetId: string;
}
declare interface DeleteConsumerGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteConsumerRequest {
/** 投递任务绑定的日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
}
declare interface DeleteConsumerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteCosRechargeRequest {
/** COS导入配置Id。- 通过 [获取cos导入配置](https://cloud.tencent.com/document/product/614/88099) 获取COS导入配置Id。 */
Id: string;
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/api/614/56454)获取日志主题Id。 */
TopicId: string;
}
declare interface DeleteCosRechargeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDashboardRequest {
/** 仪表盘id */
DashboardId: string;
}
declare interface DeleteDashboardResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDashboardSubscribeRequest {
/** 仪表盘订阅记录id。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Id。 */
Id: number;
}
declare interface DeleteDashboardSubscribeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDataTransformRequest {
/** 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。 */
TaskId: string;
}
declare interface DeleteDataTransformResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteDlcDeliverRequest {
/** 日志主题id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 任务id。 */
TaskId: string;
}
declare interface DeleteDlcDeliverResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteEsRechargeRequest {
/** 任务id */
TaskId: string;
/** 任务配置的日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
}
declare interface DeleteEsRechargeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteExportRequest {
/** 日志导出任务Id- 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。 */
ExportId: string;
}
declare interface DeleteExportResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteHostMetricConfigRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** 采集配置id。 */
ConfigId: string;
}
declare interface DeleteHostMetricConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteIndexRequest {
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
}
declare interface DeleteIndexResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteKafkaRechargeRequest {
/** Kafka导入配置Id。- 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。- 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。 */
Id: string;
/** 导入CLS目标日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
}
declare interface DeleteKafkaRechargeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteLogsetRequest {
/** 日志集Id。通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。 */
LogsetId: string;
}
declare interface DeleteLogsetResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteMachineGroupInfoRequest {
/** 机器组Id- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。 */
GroupId: string;
/** 机器组类型目前type支持 ip 和 label */
MachineGroupType: MachineGroupTypeInfo;
}
declare interface DeleteMachineGroupInfoResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteMachineGroupRequest {
/** 机器组Id- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。 */
GroupId: string;
}
declare interface DeleteMachineGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteMetricConfigRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** 指标采集配置id。 */
ConfigId: string;
}
declare interface DeleteMetricConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteMetricSubscribeRequest {
/** 指标采集任务id */
TaskId: string;
/** 指标采集任务配置的日志主题id。 */
TopicId: string;
}
declare interface DeleteMetricSubscribeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteNoticeContentRequest {
/** 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID */
NoticeContentId: string;
}
declare interface DeleteNoticeContentResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteScheduledSqlRequest {
/** 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取 */
TaskId: string;
/** 源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取 */
SrcTopicId: string;
}
declare interface DeleteScheduledSqlResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteShipperRequest {
/** 投递规则Id。- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。 */
ShipperId: string;
}
declare interface DeleteShipperResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteSplunkDeliverRequest {
/** 任务id */
TaskId: string;
/** 日志主题id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
}
declare interface DeleteSplunkDeliverResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteTopicRequest {
/** 主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
}
declare interface DeleteTopicResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteWebCallbackRequest {
/** 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID */
WebCallbackId: string;
}
declare interface DeleteWebCallbackResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAlarmNoticesRequest {
/** name按照【通知渠道组名称】进行过滤。类型:String示例:"Filters":[{"Key":"name","Values":["test-notice"]}]必选:否alarmNoticeId按照【通知渠道组ID】进行过滤。类型:String示例:"Filters": [{Key: "alarmNoticeId", Values: ["notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f"]}]必选:否uid按照【接收用户ID】进行过滤。类型:String示例:"Filters": [{Key: "uid", Values: ["1137546"]}]必选:否groupId按照【接收用户组ID】进行过滤。类型:String示例:"Filters": [{Key: "groupId", Values: ["344098"]}]必选:否deliverFlag按照【投递状态】进行过滤。类型:String必选:否可选值: "1":未启用, "2": 已启用, "3":投递异常示例:"Filters":[{"Key":"deliverFlag","Values":["2"]}]每次请求的Filters的上限为10,Filter.Values的上限为5。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
/** 是否需要返回通知渠道组配置的告警屏蔽统计状态数量信息。- true:需要返回;- false:不返回(默认false)。 */
HasAlarmShieldCount?: boolean;
}
declare interface DescribeAlarmNoticesResponse {
/** 告警通知模板列表。 */
AlarmNotices?: AlarmNotice[];
/** 符合条件的告警通知模板总数。 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAlarmShieldsRequest {
/** 通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组id */
AlarmNoticeId: string;
/** - taskId:按照【规则id】进行过滤。类型:String 必选:否- status:按照【规则状态】进行过滤。类型:String。 支持 0:暂未生效,1:生效中,2:已失效。 必选:否每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeAlarmShieldsResponse {
/** 符合条件的规则总数目 */
TotalCount?: number;
/** 告警屏蔽规则详情 */
AlarmShields?: AlarmShieldInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAlarmsRequest {
/** name- 按照【告警策略名称】进行过滤。- 类型:String- 必选:否- 示例:test-alarmalarmId- 按照【告警策略ID】进行过滤。- 类型:String- 必选:否- 示例:alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751topicId- 按照【监控对象的日志主题ID】进行过滤。- 类型:String- 必选:否- 示例:6766f83d-659e-xxxx-a8f7-9104a1012743enable- 按照【启用状态】进行过滤。- 类型:String- 备注:enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.- 必选:否- 示例:true每次请求的Filters的上限为10,Filter.Values的上限为5。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeAlarmsResponse {
/** 告警策略列表。 */
Alarms?: AlarmInfo[];
/** 符合查询条件的告警策略数目。 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeAlertRecordHistoryRequest {
/** 查询时间范围启始时间,毫秒级unix时间戳(ms) */
From: number;
/** 查询时间范围结束时间,毫秒级unix时间戳(ms) */
To: number;
/** 分页的偏移量,默认值为0。 */
Offset: number;
/** 分页单页限制数目,最大值100。 */
Limit: number;
/** - alertId:按照告警策略ID进行过滤。类型:String 必选:否- topicId:按照监控对象ID进行过滤。类型:String 必选:否- status:按照告警状态进行过滤。类型:String 必选:否,0代表未恢复,1代表已恢复,2代表已失效- alarmLevel:按照告警等级进行过滤。类型:String 必选:否,0代表警告,1代表提醒,2代表紧急每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
}
declare interface DescribeAlertRecordHistoryResponse {
/** 告警历史总数 */
TotalCount?: number;
/** 告警历史详情 */
Records?: AlertHistoryRecord[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCloudProductLogTasksRequest {
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为100,最大值100。 */
Limit?: number;
/** - assumerName - 按照【云产品标识】进行过滤。 - 类型:String - 必选:否 - 枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS- logType - 按照【日志类型】进行过滤。 - 类型:String - 必选:否 - 枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS- instanceId - 按照【实例ID】进行过滤。 - 类型:String - 必选:否 */
Filters?: Filter[];
}
declare interface DescribeCloudProductLogTasksResponse {
/** 日志配置详情列表 */
Tasks?: CloudProductLogTaskInfo[];
/** 日志配置总数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeClusterBaseMetricConfigsRequest {
/** 机器组id */
GroupId: string;
/** topicId按照【指标主题id】进行过滤。类型:String 必选:否 每次请求的Filters的上限为10,所有Filter.Values总和上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeClusterBaseMetricConfigsResponse {
/** 总数目 */
TotalCount?: number;
/** 指标采集配置列表 */
Datas?: BaseMetricCollectConfig[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeClusterMetricConfigsRequest {
/** 机器组id */
GroupId: string;
/** configId按照【指标采集配置id】进行过滤。类型:String 必选:否 name按照【配置名称】进行过滤。类型:String 必选:否 每次请求的Filters的上限为10,所有Filter.Values总和上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeClusterMetricConfigsResponse {
/** 总数目 */
TotalCount?: number;
/** 指标采集配置列表 */
Datas?: MetricCollectConfig[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConfigExtrasRequest {
/** 过滤器,支持如下选项:name- 按照【特殊采集配置名称】进行模糊匹配过滤。- 类型:String- 示例:test-configconfigExtraId- 按照【特殊采集配置ID】进行过滤。- 类型:String- 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9atopicId- 按照【日志主题】进行过滤。- 类型:String- 示例:3581a3be-aa41-423b-995a-54ec84da6264machineGroupId- 按照【机器组ID】进行过滤。- 类型:String- 示例:f948972f-a063-408c-a59f-8c3230bddaf6每次请求的Filters的上限为10,Filter.Values的上限为5。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0 */
Offset?: number;
/** 分页单页的限制数目,默认值为20,最大值100 */
Limit?: number;
}
declare interface DescribeConfigExtrasResponse {
/** 采集配置列表 */
Configs?: ConfigExtraInfo[] | null;
/** 过滤到的总数目 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConfigMachineGroupsRequest {
/** 采集配置ID- 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。 */
ConfigId: string;
}
declare interface DescribeConfigMachineGroupsResponse {
/** 采集规则配置绑定的机器组列表 */
MachineGroups?: MachineGroupInfo[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConfigsRequest {
/** configName- 按照【采集配置名称】进行模糊匹配过滤。- 类型:String- 必选:否- 示例:test-configconfigId- 按照【采集配置ID】进行过滤。- 类型:String- 必选:否- 示例:3581a3be-aa41-423b-995a-54ec84da6264topicId- 按照【日志主题】进行过滤。- 类型:String- 必选:否- 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。每次请求的Filters的上限为10,Filter.Values的上限为5。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0 */
Offset?: number;
/** 分页单页的限制数目,默认值为20,最大值100 */
Limit?: number;
}
declare interface DescribeConfigsResponse {
/** 采集配置列表 */
Configs?: ConfigInfo[] | null;
/** 过滤到的总数目 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConsoleSharingListRequest {
}
declare interface DescribeConsoleSharingListResponse {
/** 分页的总数目 */
TotalCount?: number;
/** 控制台免密分享列表 */
ConsoleSharingInfos?: ConsoleSharingInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConsumerGroupsRequest {
/** 日志集Id(日志主题所属的日志集) */
LogsetId: string;
/** topic列表 */
Topics?: string[];
}
declare interface DescribeConsumerGroupsResponse {
/** 消费组详情列表 */
ConsumerGroupsInfo?: ConsumerGroupInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConsumerOffsetsRequest {
/** 日志主题对应的消费组标识 */
ConsumerGroup: string;
/** 时间戳(秒级时间戳) */
From: string;
/** 日志集id(日志主题对应的id) */
LogsetId: string;
/** 日志主题id */
TopicId?: string;
/** 分区id */
PartitionId?: string;
}
declare interface DescribeConsumerOffsetsResponse {
/** 消费者组标识 */
ConsumerGroup?: string;
/** 消费点位信息 */
TopicPartitionOffsetsInfo?: TopicPartitionOffsetInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConsumerPreviewRequest {
}
declare interface DescribeConsumerPreviewResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConsumerRequest {
/** 投递任务绑定的日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
}
declare interface DescribeConsumerResponse {
/** 投递任务是否生效 */
Effective?: boolean;
/** 是否投递日志的元数据信息 */
NeedContent?: boolean;
/** 如果需要投递元数据信息,元数据信息的描述 */
Content?: ConsumerContent | null;
/** CKafka的描述 */
Ckafka?: Ckafka;
/** 压缩方式[0:NONE;2:SNAPPY;3:LZ4] */
Compression?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeConsumersRequest {
/** - consumerId按照【投递规则ID】进行过滤。类型:String必选:否- topicId按照【日志主题】进行过滤。类型:String必选:否- taskStatus按照【任务运行状态】进行过滤。 支持`0`:停止,`1`:运行中,`2`:异常类型:String必选:否每次请求的Filters的上限为10,Filter.Values的上限为10。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0 */
Offset?: number;
/** 分页单页的限制数目,默认值为20,最大值100 */
Limit?: number;
}
declare interface DescribeConsumersResponse {
/** 投递规则列表 */
Consumers?: ConsumerInfo[] | null;
/** 本次查询获取到的总数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeCosRechargesRequest {
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/api/614/56454)获取日志主题Id。 */
TopicId: string;
/** 状态 status 0: 已创建, 1: 运行中, 2: 已停止, 3: 已完成, 4: 运行失败。 */
Status?: number;
/** 是否启用: 0: 未启用 , 1:启用 */
Enable?: number;
}
declare interface DescribeCosRechargesResponse {
/** 见: CosRechargeInfo 结构描述 */
Data?: CosRechargeInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDashboardSubscribesRequest {
/** dashboardId:按照【仪表盘id】进行过滤。类型:String必选:否- 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。- 入参示例:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeDashboardSubscribesResponse {
/** 仪表盘订阅列表 */
DashboardSubscribeInfos?: DashboardSubscribeInfo[];
/** 总数目 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDashboardsRequest {
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
/** - dashboardId 按照【仪表盘id】进行过滤,类型:String, 必选:否。 - 示例值:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5- dashboardName 按照【仪表盘名字】进行模糊搜索过滤,类型:String,必选:否。 - 示例值:业务大盘- dashboardRegion 按照【仪表盘地域】进行过滤(兼容老的仪表盘),通过云API创建的仪表盘该属性,类型:String,必选:否。 - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940) - 示例:ap-guangzhou- tagKey 按照【标签键】进行过滤,类型:String,必选:否。 - 示例值: ``` "Filters":[ { "Key": "tagKey", "Values": [ "tag-key-test" ] } ] ```- tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,类型:String,必选:否, - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636) 使用。 ``` "Filters": [ { "Key": "tag:tag-key-test", "Values": [ "12" ] } ] ```每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 按照topicId和regionId过滤。- topicId:日志主题Id。 - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 - 示例值:439a5304-08f9-484b-9c4d-46ff57133816- regionId - 1:广州 - 4:上海 - 5:中国香港 - 7:上海金融 - 8:北京 - 9:新加坡 - 11:深圳金融 - 15:硅谷 - 16:成都 - 17:法兰克福 - 18:首尔 - 19:重庆 - 22:弗吉尼亚 - 23:曼谷 - 25:东京 - 33:南京 - 36:天津 - 39:台北 - 46:北京金融 - 72:雅加达 - 74:圣保罗 - 78:上海自动驾驶云 */
TopicIdRegionFilter?: TopicIdAndRegion[];
}
declare interface DescribeDashboardsResponse {
/** 仪表盘的数量 */
TotalCount?: number;
/** 仪表盘详细明细 */
DashboardInfos?: DashboardInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDataTransformInfoRequest {
/** - taskName按照【加工任务名称】进行过滤。类型:String必选:否示例:test-task- taskId按照【加工任务id】进行过滤。类型:String必选:否示例:a3622556-6402-4942-b4ff-5ae32ec29810数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。- topicId按照【源topicId】进行过滤。类型:String必选:否示例:756cec3e-a0a5-44c3-85a8-090870582000日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。- status按照【 任务运行状态】进行过滤。 1:准备中,2:运行中,3:停止中,4:已停止类型:String必选:否示例:1- hasServiceLog按照【是否开启服务日志】进行过滤。 1:未开启,2:已开启类型:String必选:否示例:1- dstTopicType按照【目标topic类型】进行过滤。 1:固定,2:动态类型:String必选:否示例:1每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
/** 默认值为2. 1: 获取单个任务的详细信息 2:获取任务列表 */
Type?: number;
/** Type为1, 此参数必填数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。 */
TaskId?: string;
}
declare interface DescribeDataTransformInfoResponse {
/** 数据加工任务列表信息 */
DataTransformTaskInfos?: DataTransformTaskInfo[];
/** 任务总次数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeDlcDeliversRequest {
/** 日志主题id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** - taskId按照【任务id】进行过滤。类型:String必选:否- name按照【任务名称】进行过滤。类型:String必选:否- tableName按照【数据表】进行过滤。类型:String必选:否- statusFlag按照【状态】进行过滤。支持:"1","2","3","4"。含义:1:RUNNING,2:STOPPED,3:FINISHED,4:FAILED类型:String必选:否每次请求的Filters的上限为10,Filter.Values的上限为10。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeDlcDeliversResponse {
/** 告警渠道回调配置列表。 */
Infos?: DlcDeliverInfo[];
/** 符合条件的通知内容配置总数。 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeEsRechargePreviewRequest {
/** 名称:长度不超过64字符。 */
Name: string;
/** 日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** 索引信息。不同索引可以通过英文逗号分隔,支持*通配符 */
Index: string;
/** es查询语句。 */
Query: string;
/** es集群配置信息。 */
EsInfo: EsInfo;
/** es导入信息。 */
ImportInfo: EsImportInfo;
/** es导入时间字段信息。 */
TimeInfo: EsTimeInfo;
}
declare interface DescribeEsRechargePreviewResponse {
/** 预览数据信息 */
Data?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeEsRechargesRequest {
/** 日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** - taskId按照【配置id】进行过滤。类型:String 必选:否- name按照【配置名称】进行过滤。类型:String 必选:否- statusFlag按照【配置状态标记】进行过滤。类型:String 必选:否- 每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeEsRechargesResponse {
/** 总数目 */
TotalCount?: number;
/** es导入配置信息 */
Infos?: EsRechargeInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeExportsRequest {
/** 日志主题Id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 分页的偏移量,默认值为0 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100 */
Limit?: number;
}
declare interface DescribeExportsResponse {
/** 日志导出列表 */
Exports?: ExportInfo[];
/** 总数目 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeHostMetricConfigsRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** - configId按照【配置id】进行过滤。类型:String 必选:否- name按照【配置名称】进行过滤。类型:String 必选:否每次请求的Filters的上限为10,Filter.Values的上限为10。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeHostMetricConfigsResponse {
/** 总数目 */
TotalCount?: number;
/** 指标订阅配置信息 */
Infos?: HostMetricConfig[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeIndexRequest {
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
}
declare interface DescribeIndexResponse {
/** 日志主题Id */
TopicId?: string;
/** 索引状态。true:开启状态,false:关闭状态开启后可对日志进行检索分析,将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802) */
Status?: boolean;
/** 索引配置信息 */
Rule?: RuleInfo | null;
/** 索引修改时间,初始值为索引创建时间。格式 `YYYY-MM-DD HH:MM:SS` */
ModifyTime?: string;
/** 内置保留字段(`__FILENAME__`,`__HOSTNAME__`及`__SOURCE__`)是否包含至全文索引* false:不包含* true:包含 */
IncludeInternalFields?: boolean;
/** 元数据字段(前缀为`__TAG__`的字段)是否包含至全文索引* 0:仅包含开启键值索引的元数据字段* 1:包含所有元数据字段* 2:不包含任何元数据字段 */
MetadataFlag?: number;
/** 自定义日志解析异常存储字段。 */
CoverageField?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeKafkaConsumerGroupDetailRequest {
/** 日志主题id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 消费组名称 */
Group: string;
}
declare interface DescribeKafkaConsumerGroupDetailResponse {
/** 日志集id */
LogsetId?: string;
/** 消费组名称 */
Group?: string;
/** 消费组信息列表 */
PartitionInfos?: GroupPartitionInfo[];
/** Empty:组内没有成员,但存在已提交的偏移量。所有消费者都离开但保留了偏移量Dead:组内没有成员,且没有已提交的偏移量。组被删除或长时间无活动Stable:组内成员正常消费,分区分配平衡。正常运行状态PreparingRebalance:组正在准备重新平衡。有新成员加入或现有成员离开CompletingRebalance:组正在准备重新平衡。有新成员加入或现有成员离开 */
State?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeKafkaConsumerGroupListRequest {
/** 日志主题id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** - group按照【消费组名称】进行过滤。类型:String必选:否示例:消费组1每次请求的Filters的上限为10,Filter.Values的上限为10。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeKafkaConsumerGroupListResponse {
/** 日志主题名称 */
TopicName?: string;
/** 日志集id */
LogsetId?: string;
/** 总个数 */
Total?: number;
/** 消费组信息列表 */
Groups?: ConsumerGroup[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeKafkaConsumerPreviewRequest {
}
declare interface DescribeKafkaConsumerPreviewResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeKafkaConsumerRequest {
/** 日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
FromTopicId: string;
}
declare interface DescribeKafkaConsumerResponse {
/** Kafka协议消费是否打开 */
Status?: boolean;
/** KafkaConsumer 消费时使用的Topic参数 */
TopicID?: string;
/** 压缩方式[0:NONE;2:SNAPPY;3:LZ4] */
Compression?: number;
/** kafka协议消费数据格式 */
ConsumerContent?: KafkaConsumerContent;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeKafkaConsumerTopicsRequest {
}
declare interface DescribeKafkaConsumerTopicsResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeKafkaRechargesRequest {
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 导入配置Id。- 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。- 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。 */
Id?: string;
/** 状态。1: 运行中,2: 暂停,3:错误 */
Status?: number;
}
declare interface DescribeKafkaRechargesResponse {
/** KafkaRechargeInfo 信息列表 */
Infos?: KafkaRechargeInfo[];
/** Kafka导入信息总条数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeLogContextRequest {
/** 要查询的日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** 日志时间, 即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构体中的Time,需按照 UTC+8 时区将该毫秒级Unix时间戳转换为 YYYY-mm-dd HH:MM:SS.FFF 格式的字符串。 */
BTime: string;
/** 日志包序号,即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构体中的PkgId。 */
PkgId: string;
/** 日志包内一条日志的序号,即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构中的PkgLogId。 */
PkgLogId: number;
/** 前${PrevLogs}条日志,默认值10。 */
PrevLogs?: number;
/** 后${NextLogs}条日志,默认值10。 */
NextLogs?: number;
/** 检索语句,对日志上下文进行过滤,最大长度为12KB语句由 [检索条件]构成,不支持SQL语句 */
Query?: string;
/** 上下文检索的开始时间,单位:毫秒级时间戳注意:- From为空时,表示上下文检索的开始时间不做限制- From和To非空时,From < To- 暂时仅支持上海 / 弗吉尼亚/ 新加坡地域 */
From?: number;
/** 上下文检索的结束时间,单位:毫秒级时间戳。注意:- To为空时,表示上下文检索的结束时间不做限制- From和To非空时,From < To- 暂时仅支持上海 / 弗吉尼亚/ 新加坡地域 */
To?: number;
}
declare interface DescribeLogContextResponse {
/** 日志上下文信息集合 */
LogContextInfos?: LogContextInfo[];
/** 上文日志是否已经返回完成(当PrevOver为false,表示有上文日志还未全部返回)。 */
PrevOver?: boolean;
/** 下文日志是否已经返回完成(当NextOver为false,表示有下文日志还未全部返回)。 */
NextOver?: boolean;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeLogHistogramRequest {
/** 要查询的日志的起始时间,Unix时间戳,单位ms */
From: number;
/** 要查询的日志的结束时间,Unix时间戳,单位ms */
To: number;
/** 检索分析语句。语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。使用*或空字符串可查询所有日志。 */
Query: string;
/** 要查询的日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId?: string;
/** 时间间隔: 单位ms 限制性条件:(To-From) / interval <= 200 */
Interval?: number;
/** 检索语法规则,默认值为0。0:Lucene语法,1:CQL语法。详细说明参见检索条件语法规则 */
SyntaxRule?: number;
}
declare interface DescribeLogHistogramResponse {
/** 统计周期: 单位ms */
Interval?: number;
/** 命中关键字的日志总条数 */
TotalCount?: number;
/** 周期内统计结果详情 */
HistogramInfos?: HistogramInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeLogsetsRequest {
/** logsetName- 按照【日志集名称】进行过滤。- 类型:String- 必选:否- 通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集名称。logsetId- 按照【日志集ID】进行过滤。- 类型:String- 必选:否- 通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。tagKey- 按照【标签键】进行过滤。- 类型:String- 必选:否tag:tagKey- 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。- 类型:String- 必选:否每次请求的Filters的上限为10,Filter.Values的上限为5。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0 */
Offset?: number;
/** 分页单页的限制数目,默认值为20,最大值100 */
Limit?: number;
}
declare interface DescribeLogsetsResponse {
/** 分页的总数目 */
TotalCount?: number;
/** 日志集列表 */
Logsets?: LogsetInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeMachineGroupConfigsRequest {
/** 机器组ID- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。 */
GroupId: string;
}
declare interface DescribeMachineGroupConfigsResponse {
/** 采集规则配置列表 */
Configs?: ConfigInfo[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeMachineGroupsRequest {
/** 过滤条件machineGroupName- 按照【机器组名称】进行过滤。- 类型:String- 必选:否machineGroupId- 按照【机器组ID】进行过滤。- 类型:String- 必选:否osType- 按照【操作系统类型】进行过滤。0: Linux;1: Windows- 类型:Int- 必选:否tagKey- 按照【标签键】进行过滤。- 类型:String- 必选:否tag:tagKey- 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。- 类型:String- 必选:否每次请求的Filters的上限为10,Filter.Values的上限为5。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0 */
Offset?: number;
/** 分页单页的限制数目,默认值为20,最大值100 */
Limit?: number;
}
declare interface DescribeMachineGroupsResponse {
/** 机器组信息列表 */
MachineGroups?: MachineGroupInfo[];
/** 分页的总数目 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeMachinesRequest {
/** 查询的机器组ID。- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组ID。 */
GroupId: string;
/** ip- 按照ip进行过滤。- 类型:String- 必选:否instance- 按照实例id进行过滤。- 类型:String- 必选:否version- 按照LogListener版本进行过滤。- 类型:String- 必选:否status- 按照机器状态进行过滤。- 类型:String- 必选:否- 可选值:0:离线,1:正常offlineTime- 按照机器离线时间进行过滤。- 类型:String- 必选:否- -可选值:0:无离线时间,12:12小时内,24:一天内,48:两天内,99:两天前每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量。 */
Offset?: number;
/** 分页单页限制数目。最大支持100 */
Limit?: number;
}
declare interface DescribeMachinesResponse {
/** 机器状态信息组 */
Machines?: MachineInfo[];
/** 机器组是否开启自动升级功能。 0:未开启自动升级;1:开启了自动升级。 */
AutoUpdate?: number;
/** 机器组自动升级功能预设开始时间 */
UpdateStartTime?: string;
/** 机器组自动升级功能预设结束时间 */
UpdateEndTime?: string;
/** 当前用户可用最新的Loglistener版本 */
LatestAgentVersion?: string;
/** 是否开启服务日志 */
ServiceLogging?: boolean;
/** 总数目 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeMetricCorrectDimensionRequest {
}
declare interface DescribeMetricCorrectDimensionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeMetricSubscribePreviewRequest {
/** 云产品命名空间。 */
Namespace: string;
/** 数据库配置信息。 */
Metrics: MetricConfig[];
/** 实例配置配置。 */
InstanceInfo: InstanceConfig;
}
declare interface DescribeMetricSubscribePreviewResponse {
/** 总数量 */
TotalCount?: number;
/** 成功数量 */
SuccessCount?: number;
/** 失败数量 */
FailCount?: number;
/** 成功实例数据 */
SuccessInstances?: InstanceData[];
/** 失败实例数据 */
FailInstances?: InstanceData[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeMetricSubscribesRequest {
/** 日志主题id */
TopicId: string;
/** taskId按照【配置id】进行过滤。类型:String 必选:否 name按照【配置名称】进行过滤。类型:String 必选:否 status按照【配置状态标记】进行过滤。类型:String 必选:否 每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeMetricSubscribesResponse {
/** 总数目 */
TotalCount?: number;
/** 指标订阅配置信息 */
Datas?: MetricSubscribeInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeNoticeContentsRequest {
/** name按照【通知内容模板名称】进行过滤。类型:String必选:否 noticeContentId按照【通知内容模板ID】进行过滤。类型:String必选:否每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeNoticeContentsResponse {
/** 通知内容模板列表。 */
NoticeContents?: NoticeContentTemplate[];
/** 符合条件的通知内容模板总数。 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribePartitionsRequest {
/** 日志主题Id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
}
declare interface DescribePartitionsResponse {
/** 分区列表 */
Partitions?: PartitionInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeRebuildIndexTasksRequest {
/** 日志主题ID */
TopicId: string;
/** 索引重建任务ID */
TaskId?: string;
/** 索引重建任务状态,不填返回所有状态任务列表,多种状态之间用逗号分隔。枚举值:0: 索引重建任务已创建1: 正在创建索引重建资源2: 已创建索引重建资源3: 重建中4: 暂停5: 重建完成6: 重建成功(可检索)7: 重建失败8: 任务取消9: 元数据和索引已删除 */
Status?: string;
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为10,最大值20。 */
Limit?: number;
}
declare interface DescribeRebuildIndexTasksResponse {
/** 索引重建任务列表 */
RebuildTasks?: RebuildIndexTaskInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeScheduledSqlInfoRequest {
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
/** 任务名称。 */
Name?: string;
/** 任务id。 */
TaskId?: string;
/** - srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题1 ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。- dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题 2,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。- srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否。示例:a4478687-2382-4486-9692-de7986350f6b ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。- dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否。示例:bd4d3375-d72a-4cd2-988d-d8eda2bd62b0,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。- bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否- status按照【任务状态】进行过滤,1:运行;2:停止;3:异常。类型:String。必选:否- taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否。示例:metricTask ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。- taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否。示例:9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。 */
Filters?: Filter[];
}
declare interface DescribeScheduledSqlInfoResponse {
/** ScheduledSQL任务列表信息 */
ScheduledSqlTaskInfos?: ScheduledSqlTaskInfo[];
/** 任务总次数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeShipperTasksRequest {
/** 投递规则Id。- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。 */
ShipperId: string;
/** 查询的开始时间戳,支持最近3天的查询, 毫秒。StartTime必须小于EndTime */
StartTime: number;
/** 查询的结束时间戳, 毫秒。StartTime必须小于EndTime */
EndTime: number;
}
declare interface DescribeShipperTasksResponse {
/** 投递任务列表 */
Tasks?: ShipperTaskInfo[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeShippersRequest {
/** - shipperName:按照【投递规则名称】进行过滤。 类型:String。 必选:否- shipperId:按照【投递规则ID】进行过滤。 类型:String。 必选:否- topicId:按照【日志主题】进行过滤。 类型:String。 必选:否- taskStatus:按照【任务运行状态】进行过滤。 支持`0`:停止,`1`:运行中,`2`:异常 类型:String 必选:否每次请求的Filters的上限为10,Filter.Values的上限为10。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0 */
Offset?: number;
/** 分页单页的限制数目,默认值为20,最大值100 */
Limit?: number;
/** 控制Filters相关字段是否为精确匹配。 0: 默认值,shipperName模糊匹配 1: shipperName 精确匹配 */
PreciseSearch?: number;
}
declare interface DescribeShippersResponse {
/** 投递规则列表 */
Shippers?: ShipperInfo[];
/** 本次查询获取到的总数 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSplunkDeliversRequest {
/** 日志主题Id- 通过获取日志主题列表获取日志主题Id。 */
TopicId: string;
/** taskId 按照【任务id】进行过滤。 类型:String 必选:否 name 按照【任务名称】进行过滤。 类型:String 必选:否 statusFlag 按照【状态】进行过滤。 类型:String 必选:否 每次请求的Filters的上限为10,Filter.Values的上限为10。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeSplunkDeliversResponse {
/** Splunk投递任务信息列表 */
Infos?: SplunkDeliverInfo[];
/** 符合条件的任务总数。 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSplunkPreviewRequest {
/** 日志主题id。- 通过获取日志主题列表获取日志主题Id。 */
TopicId: string;
/** splunk投递任务-元信息 */
MetadataInfo: MetadataInfo;
/** splunk投递任务-投递 splunk过滤原始日志语句 */
DSLFilter?: string;
}
declare interface DescribeSplunkPreviewResponse {
/** 预览结果 */
PreviewInfos?: string[];
/** 数据过滤结果 */
FilterStats?: FilterStatistics;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTopicBaseMetricConfigsRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** groupId按照【机器组id】进行过滤。类型:String 必选:否每次请求的Filters的上限为10,所有Filter.Values总和上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeTopicBaseMetricConfigsResponse {
/** 总数目 */
TotalCount?: number;
/** 指标采集配置列表 */
Datas?: BaseMetricCollectConfig[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTopicMetricConfigsRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** configId按照【指标采集配置id】进行过滤。类型:String 必选:否name按照【配置名称】进行过滤。类型:String 必选:否每次请求的Filters的上限为10,所有Filter.Values总和上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeTopicMetricConfigsResponse {
/** 总数目 */
TotalCount?: number;
/** 指标采集配置列表 */
Datas?: MetricCollectConfig[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeTopicsRequest {
/** topicName 按照【主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否topicId 按照【主题ID】进行过滤。类型:String。必选:否logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用CreateLogset 创建新的日志集。类型:String。必选:否tagKey 按照【标签键】进行过滤。类型:String。必选:否tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否storageType 按照【主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否注意:每次请求的 Filters 的上限为10,Filter.Values 的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
/** 控制Filters相关字段是否为精确匹配。0: 默认值,topicName 和 logsetName 模糊匹配1: topicName 精确匹配2: logsetName精确匹配3: topicName 和logsetName 都精确匹配 */
PreciseSearch?: number;
/** 主题类型- 0:日志主题,默认值- 1:指标主题 */
BizType?: number;
}
declare interface DescribeTopicsResponse {
/** 主题列表 */
Topics?: TopicInfo[];
/** 总数目 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeWebCallbacksRequest {
/** - name按照【告警渠道回调配置名称】进行过滤。类型:String必选:否- webCallbackId按照【告警渠道回调配置ID】进行过滤。类型:String必选:否- type按照【告警渠道回调配置渠道类型】进行过滤。类型:String必选:否枚举值:WeCom,DingTalk,Lark,Http每次请求的Filters的上限为10,Filter.Values的上限为100。 */
Filters?: Filter[];
/** 分页的偏移量,默认值为0。 */
Offset?: number;
/** 分页单页限制数目,默认值为20,最大值100。 */
Limit?: number;
}
declare interface DescribeWebCallbacksResponse {
/** 告警渠道回调配置列表。 */
WebCallbacks?: WebCallbackInfo[];
/** 符合条件的通知内容配置总数。 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface EstimateRebuildIndexTaskRequest {
/** 日志主题ID */
TopicId: string;
/** 预估任务起始时间,毫秒 */
StartTime: number;
/** 预估任务结束时间,毫秒 */
EndTime: number;
}
declare interface EstimateRebuildIndexTaskResponse {
/** 预估索引重建需要时间,单位秒 */
RemainTime?: number;
/** 预估写流量大小,单位MB */
WriteTraffic?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetAlarmLogRequest {
/** 要查询的执行详情的起始时间,Unix时间戳,单位ms。 */
From: number;
/** 要查询的执行详情的结束时间,Unix时间戳,单位ms。 */
To: number;
/** 查询过滤条件,例如:- 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"` - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID- 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" ` - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID- 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`- 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c") AND (monitored_object:"3c514e84-6f1f-46ec-xxxx-05de6163f7fe") AND NOT condition_evaluate_result: "Skip" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1` */
Query: string;
/** 单次查询返回的执行详情条数,最大值为1000 */
Limit?: number;
/** 透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时。注意:* 透传该参数时,请勿修改除该参数外的其它参数* 仅当检索分析语句(Query)不包含SQL时有效,SQL获取后续结果参考SQL LIMIT语法 */
Context?: string;
/** 原始日志是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc注意:* 仅当检索分析语句(Query)不包含SQL时有效* SQL结果排序方式参考SQL ORDER BY语法 */
Sort?: string;
/** true:代表使用新的检索结果返回方式,输出参数AnalysisRecords和Columns有效;false:代表使用老的检索结果返回方式,输出AnalysisResults和ColNames有效;两种返回方式在编码格式上有少量区别,建议使用true。 */
UseNewAnalysis?: boolean;
}
declare interface GetAlarmLogResponse {
/** 加载后续详情的Context */
Context?: string;
/** 指定时间范围内的告警执行详情是否完整返回 */
ListOver?: boolean;
/** 返回的结果是否为SQL分析结果 */
Analysis?: boolean;
/** 分析结果的列名,如果Query语句有SQL查询,则返回查询字段的列名;否则为空。 */
ColNames?: string[] | null;
/** 执行详情查询结果。当Query字段无SQL语句时,返回查询结果。当Query字段有SQL语句时,可能返回null。 */
Results?: LogInfo[] | null;
/** 执行详情统计分析结果。当Query字段有SQL语句时,返回SQL统计结果,否则可能返回null。 */
AnalysisResults?: LogItems[] | null;
/** 执行详情统计分析结果;UseNewAnalysis为true有效。 */
AnalysisRecords?: string[] | null;
/** 分析结果的列名, UseNewAnalysis为true有效 */
Columns?: Column[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetMetricLabelValuesRequest {
}
declare interface GetMetricLabelValuesResponse {
/** 时序metric label values */
Values?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface MergePartitionRequest {
/** 日志主题Id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Status:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);3. topic的分区数量是有限制的(默认50个),合并之后不能超过最大分区,否则不能合并。 */
PartitionId: number;
}
declare interface MergePartitionResponse {
/** 合并结果集 */
Partitions?: PartitionInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyAlarmNoticeRequest {
/** 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID */
AlarmNoticeId: string;
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持10个标签键值对,并且不能有重复的键值对。 */
Tags?: Tag[];
/** 通知渠道组名称。 */
Name?: string;
/** 通知类型。可选值: Trigger - 告警触发 Recovery - 告警恢复 All - 告警触发和告警恢复 */
Type?: string;
/** 通知接收对象。 */
NoticeReceivers?: NoticeReceiver[];
/** 接口回调信息(包括企业微信等)。 */
WebCallbacks?: WebCallback[];
/** 通知规则。注意: - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。- 传其中一组数据,则另一组数据置空。 */
NoticeRules?: NoticeRule[];
/** 调用链接域名。http:// 或者 https:// 开头,不能/结尾 */
JumpDomain?: string;
/** 投递日志开关。参数值:1:关闭;2:开启 */
DeliverStatus?: number;
/** 投递日志配置。 */
DeliverConfig?: DeliverConfig;
/** 免登录操作告警开关。参数值: 1:关闭 2:开启(默认开启) */
AlarmShieldStatus?: number;
/** 统一设定自定义回调参数。- true: 使用通知内容模板中的自定义回调参数覆盖告警策略中单独配置的请求头及请求内容。- false:优先使用告警策略中单独配置的请求头及请求内容。 */
CallbackPrioritize?: boolean;
}
declare interface ModifyAlarmNoticeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyAlarmRequest {
/** 告警策略ID。-通过[获取告警策略列表](https://cloud.tencent.com/document/product/614/56461)获取告警策略ID */
AlarmId: string;
/** 告警策略名称。最大支持255个字节,不支持 '|'。 */
Name?: string;
/** 监控任务运行时间点。 */
MonitorTime?: MonitorTime;
/** 告警信息发送的触发条件。注意: - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。 */
Condition?: string;
/** 告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)注意: - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。 */
AlarmLevel?: number;
/** 多触发条件。 注意: - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。 */
MultiConditions?: MultiCondition[];
/** 持续周期。持续满足触发条件TriggerCount个周期后,再进行告警;最小值为1,最大值为2000。 */
TriggerCount?: number;
/** 告警重复的周期。单位是分钟。取值范围是0~1440。 */
AlarmPeriod?: number;
/** 关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表,和MonitorNotice互斥 */
AlarmNoticeIds?: string[];
/** 监控对象列表。 */
AlarmTargets?: AlarmTarget[];
/** 是否开启告警策略。 */
Status?: boolean;
/** 该参数已废弃,请使用Status参数控制是否开启告警策略。 */
Enable?: boolean;
/** 用户自定义告警内容 */
MessageTemplate?: string;
/** 用户自定义回调 */
CallBack?: CallBackInfo;
/** 多维分析 */
Analysis?: AnalysisDimensional[];
/** 分组触发状态。true:开启,false:关闭(默认) */
GroupTriggerStatus?: boolean;
/** 分组触发条件。 */
GroupTriggerCondition?: string[];
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的告警策略。最大支持10个标签键值对,并且不能有重复的键值对。 */
Tags?: Tag[];
/** 监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。 当值为1时,AlarmTargets元素个数不能超过10个,AlarmTargets中的Number必须是从1开始的连续正整数,不能重复。 */
MonitorObjectType?: number;
/** 告警附加分类信息列表。Classifications元素个数不能超过20个。Classifications元素的Key不能为空,不能重复,长度不能超过50个字符,符合正则 `^[a-z]([a-z0-9_]{0,49})$`。Classifications元素的Value长度不能超过200个字符。 */
Classifications?: AlarmClassification[];
}
declare interface ModifyAlarmResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyAlarmShieldRequest {
/** 屏蔽规则ID。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID */
TaskId: string;
/** 通知渠道组id。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id */
AlarmNoticeId: string;
/** 屏蔽开始时间,秒级(s)时间戳。 */
StartTime?: number;
/** 屏蔽结束时间,秒级(s)时间戳。 */
EndTime?: number;
/** 屏蔽类型。1:屏蔽所有通知,2:按照Rule参数屏蔽匹配规则的通知。 */
Type?: number;
/** 屏蔽规则,当Type为2时必填。规则填写方式详见[产品文档](https://cloud.tencent.com/document/product/614/103178)。 */
Rule?: string;
/** 屏蔽原因。 */
Reason?: string;
/** 规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2)。枚举:0(未生效),1(生效中),2(已失效) */
Status?: number;
}
declare interface ModifyAlarmShieldResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyCloudProductLogCollectionRequest {
/** 实例ID */
InstanceId: string;
/** 云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS */
AssumerName: string;
/** 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS */
LogType: string;
/** 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:- CDS所有日志类型:ap-guangzhou- CDB-AUDIT: gz- TDSQL-C-AUDIT: gz- MongoDB-AUDIT: gz- MongoDB-SlowLog:ap-guangzhou- MongoDB-ErrorLog:ap-guangzhou- TDMYSQL-SLOW:gz- DCDB所有日志类型:gz- MariaDB所有日志类型:gz- PostgreSQL所有日志类型:gz- BH所有日志类型:overseas-polaris(中国香港地区和其他)/fsi-polaris(金融区)/general-polaris(普通区)/intl-sg-prod(国际站)- APIS所有日志类型:gz */
CloudProductRegion: string;
/** 日志配置拓展信息, 一般用于存储额外的日志投递配置 */
Extend?: string;
}
declare interface ModifyCloudProductLogCollectionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyConfigExtraRequest {
/** 采集配置扩展信息id- 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)获取采集配置扩展信息id。 */
ConfigExtraId: string;
/** 采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾 */
Name?: string;
/** 日志主题id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId?: string;
/** 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。- 详情参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471) 文档。 */
HostFile?: HostFileInfo;
/** 采集配置标记。- 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置- 详情参考 [ ContainerFileInfo](https://cloud.tencent.com/document/api/614/56471) 文档 */
ContainerFile?: ContainerFileInfo;
/** 自建k8s-容器标准输出信息,包括容器、命名空间等,- 详情参考 [ContainerStdoutInfo]( https://cloud.tencent.com/document/api/614/56471) 文档 */
ContainerStdout?: ContainerStdoutInfo;
/** 采集的日志类型,默认为minimalist_log。支持以下类型:- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。 */
LogType?: string;
/** 日志格式化方式,用于容器采集场景。- stdout-docker-json:用于docker容器采集场景- stdout-containerd:用于containerd容器采集场景 */
LogFormat?: string;
/** 提取规则,如果设置了ExtractRule,则必须设置LogType。 */
ExtractRule?: ExtractRuleInfo;
/** 采集黑名单路径列表 */
ExcludePaths?: ExcludePathInfo[];
/** 组合解析采集规则,用于复杂场景下的日志采集。- 取值参考:[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310) */
UserDefineRule?: string;
/** 容器场景,日志采集输入类型,支持以下三种类型- container_stdout 标准输出- container_file 容器文件- host_file 主机节点文件 */
Type?: string;
/** 机器组ID- 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。 */
GroupId?: string;
/** 自建采集配置标 */
ConfigFlag?: string;
/** 日志集ID- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。 */
LogsetId?: string;
/** 日志集名称- 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。 */
LogsetName?: string;
/** 日志主题名称- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。 */
TopicName?: string;
/** 高级采集配置。 Json字符串, Key/Value定义为如下:- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false- ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0 */
AdvancedConfig?: string;
}
declare interface ModifyConfigExtraResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyConfigRequest {
/** 采集规则配置ID,通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)返回信息获取。 */
ConfigId: string;
/** 采集规则配置名称- 不能包含特殊字符|- 长度不能超过255字符,超过会被截断 */
Name?: string;
/** 日志采集路径,包含文件名 */
Path?: string;
/** 采集的日志类型。支持以下类型:- json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));- delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));- minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));- fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));- multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));- multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310));- service_syslog代表:syslog 采集(详见[采集 Syslog](https://cloud.tencent.com/document/product/614/81454));- windows_event_log代表:Windows事件日志(详见[采集 Windows 事件日志](https://cloud.tencent.com/document/product/614/96678))。 */
LogType?: string;
/** 提取规则,如果设置了ExtractRule,则必须设置LogType */
ExtractRule?: ExtractRuleInfo;
/** 采集黑名单路径列表 */
ExcludePaths?: ExcludePathInfo[];
/** 采集配置关联的日志主题(TopicId)- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
Output?: string;
/** 用户自定义解析字符串,Json格式序列化的字符串。 */
UserDefineRule?: string;
/** 高级采集配置。 Json字符串, Key/Value定义为如下:- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false样例:`{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}` */
AdvancedConfig?: string;
/** 日志输入类型(注:windows场景必填且仅支持file和windows_event类型)- file: 文件类型采集- windows_event:windows事件采集- syslog:系统日志采集 */
InputType?: string;
}
declare interface ModifyConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyConsoleSharingRequest {
/** 免密分享Id。- 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。 - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。 */
SharingId: string;
/** 指定分享链接有效期,单位:毫秒,最长可设定有效期为30天 */
DurationMilliseconds: number;
}
declare interface ModifyConsoleSharingResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyConsumerGroupRequest {
/** 更新的目标消费者组标识 */
ConsumerGroup: string;
/** 消费者心跳超时时间(秒) */
Timeout: number;
/** 更新的消费者组包含的日志主题列表 */
Topics: string[];
/** 日志集Id(日志主题所属的日志集) */
LogsetId: string;
}
declare interface ModifyConsumerGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyConsumerRequest {
/** 投递任务绑定的日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** 投递任务是否生效,默认不生效 */
Effective?: boolean;
/** 是否投递日志的元数据信息,默认为 true。当NeedContent为true时:字段Content有效。当NeedContent为false时:字段Content无效。 */
NeedContent?: boolean;
/** 如果需要投递元数据信息,元数据信息的描述 */
Content?: ConsumerContent;
/** CKafka的描述 */
Ckafka?: Ckafka;
/** 投递时压缩方式,取值0,2,3。[0:NONE;2:SNAPPY;3:LZ4] */
Compression?: number;
/** 角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381) */
RoleArn?: string;
/** 外部ID */
ExternalId?: string;
/** 高级配置 */
AdvancedConfig?: AdvancedConsumerConfiguration;
}
declare interface ModifyConsumerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyCosRechargeRequest {
/** COS导入配置Id。- 通过[获取cos导入配置](https://cloud.tencent.com/document/product/614/88099)接口获取COS导入配置Id。 */
Id: string;
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** COS导入任务名称,最大支持128个字节。 */
Name?: string;
/** 任务状态 0: 停用 , 1:启用 */
Enable?: number;
/** COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。 */
Bucket?: string;
/** COS存储桶所在地域,详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。 */
BucketRegion?: string;
/** COS文件所在文件夹的前缀。为空串时投递存储桶下所有的文件。 */
Prefix?: string;
/** 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文; 默认为minimalist_log */
LogType?: string;
/** 解析格式。supported: "", "gzip", "lzop", "snappy"。空串表示不压缩。 */
Compress?: string;
/** 提取规则,如果设置了ExtractRule,则必须设置LogType */
ExtractRuleInfo?: ExtractRuleInfo;
/** COS导入任务类型。1:一次性导入任务;2:持续性导入任务。 */
TaskType?: number;
/** 元数据。支持 bucket,object。 */
Metadata?: string[];
}
declare interface ModifyCosRechargeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDashboardRequest {
/** 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。 */
DashboardId: string;
/** 仪表盘名称 */
DashboardName?: string;
/** 仪表盘配置数据 */
Data?: string;
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。 */
Tags?: Tag[];
}
declare interface ModifyDashboardResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDashboardSubscribeRequest {
/** 仪表盘订阅id。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Id。 */
Id: number;
/** 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。 */
DashboardId?: string;
/** 仪表盘订阅名称。最大支持128个字符,且不支持'|'字符。 */
Name?: string;
/** 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。 */
Cron?: string;
/** 仪表盘订阅数据。 */
SubscribeData?: DashboardSubscribeData;
}
declare interface ModifyDashboardSubscribeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDataTransformRequest {
/** 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。 */
TaskId: string;
/** 加工任务名称- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务名称。名称限制- 不能为空字符串- 不能包含字符'|'- 最长 255 个字符 */
Name?: string;
/** 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733) 其他参考文档:- [创建加工任务](https://cloud.tencent.com/document/product/614/63940) - [函数总览](https://cloud.tencent.com/document/product/614/70395) */
EtlContent?: string;
/** 任务启动状态. 默认为1,开启, 2关闭 */
EnableFlag?: number;
/** 加工任务目的topic_id以及别名 */
DstResources?: DataTransformResouceInfo[];
/** 超限之后是否丢弃日志数据 */
BackupGiveUpData?: boolean;
/** 是否开启投递服务日志。1关闭,2开启 */
HasServicesLog?: number;
/** 保留失败日志状态。 1:不保留,2:保留 */
KeepFailureLog?: number;
/** 失败日志的字段名称 */
FailureLogKey?: string;
/** 外部数据源信息 */
DataTransformSqlDataSources?: DataTransformSqlDataSource[];
/** 设置的环境变量 */
EnvInfos?: EnvInfo[];
}
declare interface ModifyDataTransformResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyDlcDeliverRequest {
/** 日志主题id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 任务id。 */
TaskId: string;
/** 名称:长度不超过64字符,以字母开头,接受0-9,a-z,A-Z, _,-,中文字符。 */
Name?: string;
/** 投递类型。0:批投递,1:实时投递 */
DeliverType?: number;
/** 投递时间范围的开始时间 */
StartTime?: number;
/** 投递时间范围的结束时间。 如果为空,则表示不限时 */
EndTime?: number;
/** 投递文件大小,单位MB。 DeliverType=0时必填,范围 5<= MaxSize <= 256。 */
MaxSize?: number;
/** 投递间隔,单位秒。 DeliverType=0时必填,范围 300<= Interval <=900。 */
Interval?: number;
/** dlc配置信息 */
DlcInfo?: DlcInfo;
/** 是否开启投递服务日志。1关闭,2开启。默认开启 */
HasServicesLog?: number;
/** 任务状态。 */
Status?: number;
}
declare interface ModifyDlcDeliverResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyEsRechargeRequest {
/** 导入任务id。 */
TaskId: string;
/** 日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
TopicId: string;
/** 名称:长度不超过64字符。 */
Name?: string;
/** 索引信息。不同索引可以通过英文逗号分隔,支持*通配符 */
Index?: string;
/** es查询语句。 */
Query?: string;
/** es集群配置信息。 */
EsInfo?: EsInfo;
/** es导入信息。 */
ImportInfo?: EsImportInfo;
/** es导入时间字段信息。 */
TimeInfo?: EsTimeInfo;
/** 任务状态。1:运行, 2:暂停 */
Status?: number;
/** 是否开启投递服务日志。1:关闭,2:开启。 */
HasServicesLog?: number;
}
declare interface ModifyEsRechargeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyHostMetricConfigRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** 采集配置id */
ConfigId: string;
/** 名称。- 长度不超过 64字符。 */
Name?: string;
/** 机器组id列表。最多支持100个机器组。 */
MachineGroupIds?: string[];
/** 采集频率。单位:ms。 最小支持5000ms */
Interval?: number;
/** 采集项。支持"cpu","mem","net","disk","system"。**目前仅支持:所有采集项都需配置**。- cpu:CPU- mem:内存- net:网络- disk:磁盘- system:系统 */
HostMetricItems?: HostMetricItem[];
}
declare interface ModifyHostMetricConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyIndexRequest {
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 索引状态。false:关闭索引, true:开启索引开启后可对日志进行检索分析,将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802) */
Status?: boolean;
/** 索引规则 */
Rule?: RuleInfo;
/** 内置保留字段(`__FILENAME__`,`__HOSTNAME__`及`__SOURCE__`)是否包含至全文索引,默认为false,推荐设置为true* false:不包含* true:包含 */
IncludeInternalFields?: boolean;
/** 元数据字段(前缀为`__TAG__`的字段)是否包含至全文索引,默认为0,推荐设置为1* 0:仅包含开启键值索引的元数据字段* 1:包含所有元数据字段* 2:不包含任何元数据字段 */
MetadataFlag?: number;
/** 自定义日志解析异常存储字段。 */
CoverageField?: string;
}
declare interface ModifyIndexResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyKafkaConsumerGroupOffsetRequest {
}
declare interface ModifyKafkaConsumerGroupOffsetResponse {
/** 状态码。0:成功,-1:失败 */
Code?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyKafkaConsumerRequest {
/** 日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
FromTopicId: string;
/** 压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩 */
Compression?: number;
/** kafka协议消费数据格式 */
ConsumerContent?: KafkaConsumerContent;
}
declare interface ModifyKafkaConsumerResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyKafkaRechargeRequest {
/** 导入配置Id。- 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。- 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。 */
Id: string;
/** 导入CLS目标TopicId。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。 */
TopicId: string;
/** Kafka导入配置名称 */
Name?: string;
/** 导入Kafka类型,0:腾讯云CKafka:1:用户自建Kafka。 */
KafkaType?: number;
/** 腾讯云CKafka实例ID,KafkaType为0时必填。- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。 */
KafkaInstance?: string;
/** 服务地址,KafkaType为1时必填。 */
ServerAddr?: string;
/** ServerAddr是否为加密连接,KafkaType为1时必填。 */
IsEncryptionAddr?: boolean;
/** 加密访问协议,KafkaType参数为1并且IsEncryptionAddr参数为true时必填。 */
Protocol?: KafkaProtocolInfo;
/** 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。- Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。 */
UserKafkaTopics?: string;
/** 用户Kafka消费组名称 */
ConsumerGroupName?: string;
/** 日志导入规则 */
LogRechargeRule?: LogRechargeRuleInfo;
/** 导入控制,1:暂停;2:启动。 */
StatusControl?: number;
/** 用户kafka拓展信息 */
UserKafkaMeta?: UserKafkaMeta;
}
declare interface ModifyKafkaRechargeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyLogsetRequest {
/** 日志集Id。通过 [获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。 */
LogsetId: string;
/** 日志集名字。- 最大支持255个字符。不支持`|`字符。 */
LogsetName?: string;
/** 日志集的绑定的标签键值对。最大支持10个标签键值对,同一个资源只能同时绑定一个标签键。 */
Tags?: Tag[];
}
declare interface ModifyLogsetResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyMachineGroupRequest {
/** 机器组Id- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。 */
GroupId: string;
/** 机器组名称输入限制:- 不能为空字符串- 不能包含字符'|' */
GroupName?: string;
/** 机器组类型。 Type:ip,Values中为ip字符串列表机器组;Type:label,Values中为标签字符串列表机器组。 */
MachineGroupType?: MachineGroupTypeInfo;
/** 标签列表 */
Tags?: Tag[];
/** 是否开启机器组自动更新 */
AutoUpdate?: boolean;
/** 升级开始时间,建议业务低峰期升级LogListener时间格式:HH:mm:ss */
UpdateStartTime?: string;
/** 升级结束时间,建议业务低峰期升级LogListener时间格式:HH:mm:ss */
UpdateEndTime?: string;
/** 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费 */
ServiceLogging?: boolean;
/** 机器组中机器定期离线清理时间。单位:天 */
DelayCleanupTime?: number;
/** 机器组元数据信息列表 */
MetaTags?: MetaTagInfo[];
}
declare interface ModifyMachineGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyMetricConfigRequest {
/** 指标日志主题id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。注意BizType 0:日志主题(默认值), 1:指标主题 */
TopicId: string;
/** 指标采集配置id */
ConfigId: string;
/** 采集配置来源。支持 :`0`、`1`- 0:自建k8s- 1:TKE */
Source?: number;
/** 机器组id。 */
GroupIds?: string[];
/** 操作状态,0:应用,1:暂停 */
Operate?: number;
/** 采集对象, Flag=0时生效 */
Spec?: MetricSpec;
/** 标签处理, Flag=0时生效 */
MetricRelabels?: Relabeling[];
/** 自定义元数据, Flag=0时生效 */
MetricLabel?: MetricConfigLabel;
/** 通信协议 `http`、`https`;Flag=0时生效 */
Scheme?: string;
/** 采集频率, Flag=0时生效- 校验格式:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$`- 默认:60s */
ScrapeInterval?: string;
/** 采集超时时间。 Flag=0时生效- 校验格式:`^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$` */
ScrapeTimeout?: string;
/** Prometheus如何处理标签之间的冲突。当Flag=0 && Type=1时生效,支持`true`,`false`- `false`:配置数据中冲突的标签重命名- `true`:忽略冲突的服务器端标签 */
HonorLabels?: boolean;
/** 采集配置yaml格式字符串, Flag=1时必填 */
YamlSpec?: MetricYamlSpec;
}
declare interface ModifyMetricConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyMetricSubscribeRequest {
/** 指标采集任务的日志主题id。必填字段 */
TopicId: string;
/** 指标采集任务id。必填字段 */
TaskId: string;
/** 名称:长度不超过64字符,以字母开头,接受0-9,a-z,A-Z, _,-,中文字符。 */
Name?: string;
/** 云产品命名空间。 */
Namespace?: string;
/** 指标配置信息。 */
Metrics?: MetricConfig[];
/** 实例配置信息。 */
InstanceInfo?: InstanceConfig;
/** 任务状态。1: 未启用2: 启用 */
Enable?: number;
}
declare interface ModifyMetricSubscribeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyNoticeContentRequest {
/** 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模板ID */
NoticeContentId: string;
/** 通知内容模板名称。 */
Name?: string;
/** 通知内容语言。0:中文 1:英文 */
Type?: number;
/** 通知内容模板详细信息。 */
NoticeContents?: NoticeContent[];
}
declare interface ModifyNoticeContentResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyScheduledSqlRequest {
/** 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取 */
TaskId: string;
/** 源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取 */
SrcTopicId?: string;
/** 任务启动状态. 1开启, 2关闭 */
EnableFlag?: number;
/** 定时SQL分析的目标日志主题 */
DstResource?: ScheduledSqlResouceInfo;
/** 查询语句 */
ScheduledSqlContent?: string;
/** 调度周期(分钟),1~1440分钟 */
ProcessPeriod?: number;
/** 单次查询的时间窗口. 例子中为近15分钟 */
ProcessTimeWindow?: string;
/** 执行延迟(秒),0~120秒,默认60秒 */
ProcessDelay?: number;
/** 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474) 文档 */
SrcTopicRegion?: string;
/** 任务名称,0~255字符 */
Name?: string;
/** 语法规则。 默认值为0。 0:Lucene语法,1:CQL语法 */
SyntaxRule?: number;
}
declare interface ModifyScheduledSqlResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyShipperRequest {
/** 投递规则Id。- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。 */
ShipperId: string;
/** COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。 */
Bucket?: string;
/** 投递规则投递的新的目录前缀。- 仅支持0-9A-Za-z-_/- 最大支持256个字符 */
Prefix?: string;
/** 投递规则的开关状态。true:开启投递任务;false:关闭投递任务。 */
Status?: boolean;
/** 投递规则的名字 */
ShipperName?: string;
/** 投递的时间间隔,单位 秒,默认300,范围 300-900 */
Interval?: number;
/** 投递的文件的最大值,单位 MB,默认256,范围 5-256 */
MaxSize?: number;
/** 投递日志的过滤规则,匹配的日志进行投递,各rule之间是and关系,最多5个,数组为空则表示不过滤而全部投递 */
FilterRules?: FilterRuleInfo[];
/** 投递日志的分区规则,支持strftime的时间格式表示 */
Partition?: string;
/** 投递日志的压缩配置 */
Compress?: CompressInfo;
/** 投递日志的内容格式配置 */
Content?: ContentInfo;
/** 投递文件命名配置,0:随机数命名,1:投递时间命名。 */
FilenameMode?: number;
/** 对象存储类型,默认值为 STANDARD。枚举值请参见[ 存储类型概述](https://cloud.tencent.com/document/product/436/33417) 文档。参考值有:- STANDARD:标准存储- STANDARD_IA:低频存储- ARCHIVE:归档存储- DEEP_ARCHIVE:深度归档存储- MAZ_STANDARD:标准存储(多 AZ)- MAZ_STANDARD_IA:低频存储(多 AZ)- INTELLIGENT_TIERING:智能分层存储- MAZ_INTELLIGENT_TIERING:智能分层存储(多 AZ) */
StorageType?: string;
/** 角色访问描述名 [创建角色](https://cloud.tencent.com/document/product/598/19381) */
RoleArn?: string;
/** 外部ID */
ExternalId?: string;
}
declare interface ModifyShipperResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifySplunkDeliverRequest {
/** 任务id */
TaskId: string;
/** 日志主题id- 通过获取日志主题列表获取日志主题Id。 */
TopicId: string;
/** 投递任务名称name有以下限制:- 不能为空- 长度不大于64- 只能包含aA-zZ、下划线、-、0-9 */
Name?: string;
/** 投递任务启用状态;0:禁用;1:启用 */
Enable?: number;
/** splunk投递任务-目标配置 */
NetInfo?: NetInfo;
/** splunk投递任务元信息 */
MetadataInfo?: MetadataInfo;
/** 是否启用服务日志;1:关闭;2:开启 */
HasServiceLog?: number;
/** 高级配置-是否启用索引器;1-不开启;2-开启;默认为:1 */
IndexAck?: number;
/** 高级配置-数据来源;不超过64个字符 */
Source?: string;
/** 高级配置-数据来源类型;不超过64个字符 */
SourceType?: string;
/** 高级配置-Splunk写入的索引;不超过64个字符 */
Index?: string;
/** 高级配置-通道。需满足限制:如果启用索引器,该值不能为空 */
Channel?: string;
/** 预过滤处理-对写入 Splunk 原始数据进行预过滤处理 */
DSLFilter?: string;
}
declare interface ModifySplunkDeliverResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyTopicRequest {
/** 主题ID- 通过[获取主题列表](https://cloud.tencent.com/document/product/614/56454)获取主题Id。 */
TopicId: string;
/** 主题名称输入限制:- 不能为空字符串- 不能包含字符'|'- 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"] */
TopicName?: string;
/** 标签描述列表,通过指定该参数可以同时绑定标签到相应的主题。最大支持10个标签键值对,并且不能有重复的键值对。 */
Tags?: Tag[];
/** 主题是否开启采集,true:开启采集;false:关闭采集。控制台目前不支持修改此参数。 */
Status?: boolean;
/** 是否开启自动分裂 */
AutoSplit?: boolean;
/** 若开启最大分裂,该主题能够允许的最大分区数;默认为50;必须为正数 */
MaxSplitPartitions?: number;
/** 生命周期,单位天,标准存储取值范围1\~3600,低频存储取值范围7\~3600。取值为3640时代表永久保存 */
Period?: number;
/** 存储类型:cold 低频存储,hot 标准存储 */
StorageType?: string;
/** 主题描述 */
Describes?: string;
/** 0:日志主题关闭日志沉降。非0:日志主题开启日志沉降后标准存储的天数。HotPeriod需要大于等于7,且小于Period。仅在StorageType为 hot 时生效,指标主题不支持该配置。 */
HotPeriod?: number;
/** 免鉴权开关。 false:关闭; true:开启。开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。 */
IsWebTracking?: boolean;
/** 主题扩展信息 */
Extends?: TopicExtendInfo;
/** 主题分区数量。默认为1;取值范围及约束:- 当输入值<=0,系统自动调整为1。- 如果未传MaxSplitPartitions,需要PartitionCount<=50;- 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions; */
PartitionCount?: number;
/** 取消切换存储任务的id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id【Topics中的TopicAsyncTaskID字段】。 */
CancelTopicAsyncTaskID?: string;
/** 加密相关参数。 支持加密地域并且开白用户可以传此参数,其他场景不能传递该参数。只支持传入1:kms-cls 云产品秘钥加密 */
Encryption?: number;
/** 开启记录公网来源ip和服务端接收时间 */
IsSourceFrom?: boolean;
}
declare interface ModifyTopicResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ModifyWebCallbackRequest {
/** 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID */
WebCallbackId: string;
/** 告警渠道回调配置名称。最大支持255个字节 */
Name?: string;
/** 渠道类型WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调; */
Type?: string;
/** 回调地址。 */
Webhook?: string;
/** 请求方式。支持POST、PUT。注意:当Type为Http时,必填。 */
Method?: string;
/** 秘钥信息。最大支持1024个字节 */
Key?: string;
}
declare interface ModifyWebCallbackResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface OpenKafkaConsumerRequest {
/** 日志主题Id。- 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。- 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。 */
FromTopicId: string;
/** 压缩方式[0:NONE;2:SNAPPY;3:LZ4],默认:0 */
Compression?: number;
/** kafka协议消费数据格式 */
ConsumerContent?: KafkaConsumerContent;
}
declare interface OpenKafkaConsumerResponse {
/** KafkaConsumer 消费时使用的Topic参数 */
TopicID?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface PreviewKafkaRechargeRequest {
/** 预览类型,1:源数据预览;2:导出结果预览。 */
PreviewType: number;
/** 导入Kafka类型,0:腾讯云CKafka;1:用户自建Kafka。 */
KafkaType: number;
/** 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。最多支持100个。 */
UserKafkaTopics: string;
/** 导入数据位置,-2:最早;-1:最晚。 */
Offset: number;
/** 腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。- 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。 */
KafkaInstance?: string;
/** 服务地址。KafkaType为1时ServerAddr必填。 */
ServerAddr?: string;
/** ServerAddr是否为加密连接。KafkaType为1时有效。 */
IsEncryptionAddr?: boolean;
/** 加密访问协议。KafkaType为1并且IsEncryptionAddr为true时Protocol必填。 */
Protocol?: KafkaProtocolInfo;
/** 用户Kafka消费组。- 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。 */
ConsumerGroupName?: string;
/** 日志导入规则 */
LogRechargeRule?: LogRechargeRuleInfo;
/** 用户kafka拓展信息 */
UserKafkaMeta?: UserKafkaMeta;
}
declare interface PreviewKafkaRechargeResponse {
/** 日志样例,PreviewType为2时返回 */
LogSample?: string;
/** 日志预览结果 */
LogData?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface QueryMetricRequest {
/** 查询语句,使用PromQL语法 - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档 */
Query: string;
/** 指标主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 查询时间,秒级Unix时间戳。为空时代表当前时间戳。 */
Time?: number;
}
declare interface QueryMetricResponse {
/** 指标查询结果类型,支持- scalar 标量值- string 字符串值- vector 瞬时向量- matrix 区间向量 */
ResultType?: string;
/** 指标查询结果 */
Result?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface QueryRangeMetricRequest {
/** 指标主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 查询语句,使用PromQL语法- 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档 */
Query: string;
/** 查询起始时间,秒级Unix时间戳 */
Start: number;
/** 查询结束时间,秒级Unix时间戳 */
End: number;
/** 查询时间间隔,单位秒 */
Step: number;
}
declare interface QueryRangeMetricResponse {
/** 指标查询结果类型,支持- scalar 标量值- string 字符串值- vector 瞬时向量- matrix 区间向量 */
ResultType?: string;
/** 指标查询结果 */
Result?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface RetryShipperTaskRequest {
/** 投递规则Id。- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。 */
ShipperId: string;
/** 投递任务Id。- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745) 获取TaskId。 */
TaskId: string;
}
declare interface RetryShipperTaskResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface SearchCosRechargeInfoRequest {
/** 日志主题Id。- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 日志集Id。- 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。 */
LogsetId: string;
/** COS导入任务名称,最大支持128个字节。 */
Name: string;
/** COS存储桶,详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 - 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。 */
Bucket: string;
/** COS存储桶所在地域,详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。 */
BucketRegion: string;
/** COS文件所在文件夹的前缀。默认为空,投递存储桶下所有的文件。 */
Prefix?: string;
/** 压缩模式: "", "gzip", "lzop", "snappy"。 默认:"" 不压缩 */
Compress?: string;
}
declare interface SearchCosRechargeInfoResponse {
/** 匹配到的存储桶下的某个文件的前几行数据 */
Data?: string[];
/** 匹配到的存储桶下的文件个数 */
Sum?: number;
/** 当前预览文件路径 */
Path?: string;
/** 预览获取数据失败原因 */
Msg?: string;
/** 状态。- 0:成功- 10000:参数错误,请确认参数- 10001:授权失败,请确认授权- 10002:获取文件列表失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。- 10003:桶内无相应前缀文件,请使用正确的桶、文件前缀和压缩方式- 10004:文件下载失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。- 10005:文件解压缩失败,请选择正确的压缩方式然后再试- 10006:读取文件内容失败,请确认文件可读- 10007:文件预览失败,请稍后再试。若无法解决,请咨询 [在线支持](https://cloud.tencent.com/online-service) 或 [提交工单](https://console.cloud.tencent.com/workorder/category?level1_id=83&level2_id=469&source=14&data_title=%E6%97%A5%E5%BF%97%E6%9C%8D%E5%8A%A1&step=1) 处理。 */
Status?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface SearchDashboardSubscribeRequest {
/** 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。 */
DashboardId: string;
/** 仪表盘订阅数据。 */
SubscribeData: DashboardSubscribeData;
/** 仪表盘订阅Id。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Id。 */
Id?: number;
/** 仪表盘订阅名称。通过 [获取仪表盘订阅列表](https://cloud.tencent.com/document/api/614/105779)接口获取Name。 */
Name?: string;
}
declare interface SearchDashboardSubscribeResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface SearchLogRequest {
/** 要检索分析的日志的起始时间,**Unix时间戳(毫秒)** */
From: number;
/** 要检索分析的日志的结束时间,**Unix时间戳(毫秒)** */
To: number;
/** 检索分析语句,最大长度为12KB语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句使用*或空字符串可查询所有日志 */
Query: string;
/** 检索语法规则,默认值为0,推荐使用1 。- 0:Lucene语法- 1:CQL语法(CLS Query Language,日志服务专用检索语法) ⚠️⚠️ **注意** **该参数值建议设置为 1,使用 CQL 语法规则,控制台日志检索及仪表盘默认均使用该语法规则。** 该参数值未指定或者为 0 时,将使用 Lucene 语法,语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见检索条件语法规则。 */
SyntaxRule?: number;
/** - 要检索分析的日志主题ID,仅能指定一个日志主题。- 如需同时检索多个日志主题,请使用Topics参数。- TopicId 和 Topics 不能同时使用,在一次请求中有且只能选择一个。 */
TopicId?: string;
/** - 要检索分析的日志主题列表,最大支持50个日志主题。- 检索单个日志主题时请使用TopicId。- TopicId 和 Topics 不能同时使用,在一次请求中有且只能选择一个。 */
Topics?: MultiTopicSearchInformation[];
/** 原始日志是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc注意:* 仅当检索分析语句(Query)不包含SQL时有效* SQL结果排序方式参考SQL ORDER BY语法 */
Sort?: string;
/** 表示单次查询返回的原始日志条数,默认为100,最大值为1000。注意:* 仅当检索分析语句(Query)不包含SQL时有效* SQL结果条数指定方式参考SQL LIMIT语法可通过两种方式获取后续更多日志:* Context:透传上次接口返回的Context值,获取后续更多日志,总计最多可获取1万条原始日志* Offset:偏移量,表示从第几行开始返回原始日志,无日志条数限制 */
Limit?: number;
/** 查询原始日志的偏移量,表示从第几行开始返回原始日志,默认为0。 注意:* 仅当检索分析语句(Query)不包含SQL时有效* 不能与Context参数同时使用* 仅适用于单日志主题检索 */
Offset?: number;
/** 透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时。注意:* 透传该参数时,请勿修改除该参数外的其它参数* 仅适用于单日志主题检索,检索多个日志主题时,请使用Topics中的Context* 仅当检索分析语句(Query)不包含SQL时有效,SQL获取后续结果参考SQL LIMIT语法 */
Context?: string;
/** 执行统计分析(Query中包含SQL)时,是否对原始日志先进行采样,再进行统计分析。0:自动采样;0~1:按指定采样率采样,例如0.02;1:不采样,即精确分析默认值为1 */
SamplingRate?: number;
/** 为true代表使用新的检索结果返回方式,输出参数AnalysisRecords和Columns有效为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效两种返回方式在编码格式上有少量区别,建议使用true */
UseNewAnalysis?: boolean;
/** 是否高亮符合检索条件的关键词,一般用于高亮显示。仅支持键值检索,不支持全文检索 */
HighLight?: boolean;
}
declare interface SearchLogResponse {
/** 透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时。注意:* 仅适用于单日志主题检索,检索多个日志主题时,请使用Topics中的Context */
Context?: string;
/** 符合检索条件的日志是否已全部返回,如未全部返回可使用Context参数获取后续更多日志注意:仅当检索分析语句(Query)不包含SQL时有效 */
ListOver?: boolean;
/** 返回的是否为统计分析(即SQL)结果 */
Analysis?: boolean;
/** 匹配检索条件的原始日志 */
Results?: LogInfo[] | null;
/** 日志统计分析结果的列名当UseNewAnalysis为false时生效 */
ColNames?: string[] | null;
/** 日志统计分析结果当UseNewAnalysis为false时生效 */
AnalysisResults?: LogItems[] | null;
/** 日志统计分析结果当UseNewAnalysis为true时生效 */
AnalysisRecords?: string[] | null;
/** 日志统计分析结果的列属性当UseNewAnalysis为true时生效 */
Columns?: Column[] | null;
/** 本次统计分析使用的采样率 */
SamplingRate?: number;
/** 使用多日志主题检索时,各个日志主题的基本信息,例如报错信息。 */
Topics?: SearchLogTopics | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface SendConsumerHeartbeatRequest {
/** 上报心跳的消费组标识 */
ConsumerGroup: string;
/** 上报心跳的消费者名称(字母数字下划线,不允许数字、_开头, 长度小于256) */
Consumer: string;
/** 日志集ID */
LogsetId: string;
/** topic 分区信息 */
TopicPartitionsInfo: TopicPartitionInfo[];
}
declare interface SendConsumerHeartbeatResponse {
/** 日志主题对应的消费组标识 */
ConsumerGroup?: string;
/** 分区信息 */
TopicPartitionsInfo?: TopicPartitionInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface SplitPartitionRequest {
/** 日志主题Id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 待分裂分区Id- 通过[获取分区列表](https://cloud.tencent.com/document/product/614/56470)获取待分裂分区Id。 */
PartitionId: number;
/** 分区切分的哈希key的位置,只在Number=2时有意义 */
SplitKey?: string;
/** 分区分裂个数(可选),默认等于2 */
Number?: number;
}
declare interface SplitPartitionResponse {
/** 分裂结果集 */
Partitions?: PartitionInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UploadLogRequest {
/** 日志主题id- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。 */
TopicId: string;
/** 该参数已废弃,请勿使用 */
HashKey?: string;
/** 压缩方法,目前支持- lz4- zstd */
CompressType?: string;
}
declare interface UploadLogResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
/** {@link Cls 日志服务} */
declare interface Cls {
(): Versions;
/** 添加机器组信息 {@link AddMachineGroupInfoRequest} {@link AddMachineGroupInfoResponse} */
AddMachineGroupInfo(data: AddMachineGroupInfoRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 应用采集配置到指定机器组 {@link ApplyConfigToMachineGroupRequest} {@link ApplyConfigToMachineGroupResponse} */
ApplyConfigToMachineGroup(data: ApplyConfigToMachineGroupRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 取消重建索引任务 {@link CancelRebuildIndexTaskRequest} {@link CancelRebuildIndexTaskResponse} */
CancelRebuildIndexTask(data: CancelRebuildIndexTaskRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 语法校验接口 {@link CheckFunctionRequest} {@link CheckFunctionResponse} */
CheckFunction(data: CheckFunctionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** Kafka服务集群连通性校验 {@link CheckRechargeKafkaServerRequest} {@link CheckRechargeKafkaServerResponse} */
CheckRechargeKafkaServer(data: CheckRechargeKafkaServerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 关闭Kafka协议消费 {@link CloseKafkaConsumerRequest} {@link CloseKafkaConsumerResponse} */
CloseKafkaConsumer(data: CloseKafkaConsumerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 提交消费点位 {@link CommitConsumerOffsetsRequest} {@link CommitConsumerOffsetsResponse} */
CommitConsumerOffsets(data: CommitConsumerOffsetsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建告警策略 {@link CreateAlarmRequest} {@link CreateAlarmResponse} */
CreateAlarm(data: CreateAlarmRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建通知渠道组 {@link CreateAlarmNoticeRequest} {@link CreateAlarmNoticeResponse} */
CreateAlarmNotice(data: CreateAlarmNoticeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建告警屏蔽规则 {@link CreateAlarmShieldRequest} {@link CreateAlarmShieldResponse} */
CreateAlarmShield(data: CreateAlarmShieldRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建云产品日志投递 {@link CreateCloudProductLogCollectionRequest} {@link CreateCloudProductLogCollectionResponse} */
CreateCloudProductLogCollection(data: CreateCloudProductLogCollectionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建采集规则配置 {@link CreateConfigRequest} {@link CreateConfigResponse} */
CreateConfig(data: CreateConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建特殊采集配置任务 {@link CreateConfigExtraRequest} {@link CreateConfigExtraResponse} */
CreateConfigExtra(data: CreateConfigExtraRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建免密分享 {@link CreateConsoleSharingRequest} {@link CreateConsoleSharingResponse} */
CreateConsoleSharing(data: CreateConsoleSharingRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建投递Ckafka任务 {@link CreateConsumerRequest} {@link CreateConsumerResponse} */
CreateConsumer(data: CreateConsumerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建消费组 {@link CreateConsumerGroupRequest} {@link CreateConsumerGroupResponse} */
CreateConsumerGroup(data: CreateConsumerGroupRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建cos导入任务 {@link CreateCosRechargeRequest} {@link CreateCosRechargeResponse} */
CreateCosRecharge(data: CreateCosRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建仪表盘 {@link CreateDashboardRequest} {@link CreateDashboardResponse} */
CreateDashboard(data: CreateDashboardRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建仪表盘订阅 {@link CreateDashboardSubscribeRequest} {@link CreateDashboardSubscribeResponse} */
CreateDashboardSubscribe(data: CreateDashboardSubscribeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建数据加工任务 {@link CreateDataTransformRequest} {@link CreateDataTransformResponse} */
CreateDataTransform(data: CreateDataTransformRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建投递SCF任务 {@link CreateDeliverCloudFunctionRequest} {@link CreateDeliverCloudFunctionResponse} */
CreateDeliverCloudFunction(data: CreateDeliverCloudFunctionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建DLC投递任务 {@link CreateDlcDeliverRequest} {@link CreateDlcDeliverResponse} */
CreateDlcDeliver(data: CreateDlcDeliverRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建es导入任务 {@link CreateEsRechargeRequest} {@link CreateEsRechargeResponse} */
CreateEsRecharge(data: CreateEsRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建日志下载任务 {@link CreateExportRequest} {@link CreateExportResponse} */
CreateExport(data: CreateExportRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建主机指标采集配置 {@link CreateHostMetricConfigRequest} {@link CreateHostMetricConfigResponse} */
CreateHostMetricConfig(data: CreateHostMetricConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建索引 {@link CreateIndexRequest} {@link CreateIndexResponse} */
CreateIndex(data: CreateIndexRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建Kafka数据订阅任务 {@link CreateKafkaRechargeRequest} {@link CreateKafkaRechargeResponse} */
CreateKafkaRecharge(data: CreateKafkaRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建日志集 {@link CreateLogsetRequest} {@link CreateLogsetResponse} */
CreateLogset(data: CreateLogsetRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建机器组 {@link CreateMachineGroupRequest} {@link CreateMachineGroupResponse} */
CreateMachineGroup(data: CreateMachineGroupRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建指标采集配置 {@link CreateMetricConfigRequest} {@link CreateMetricConfigResponse} */
CreateMetricConfig(data: CreateMetricConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建指标订阅配置 {@link CreateMetricSubscribeRequest} {@link CreateMetricSubscribeResponse} */
CreateMetricSubscribe(data: CreateMetricSubscribeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建通知内容模板 {@link CreateNoticeContentRequest} {@link CreateNoticeContentResponse} */
CreateNoticeContent(data: CreateNoticeContentRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建重建索引任务 {@link CreateRebuildIndexTaskRequest} {@link CreateRebuildIndexTaskResponse} */
CreateRebuildIndexTask(data: CreateRebuildIndexTaskRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建定时SQL分析任务 {@link CreateScheduledSqlRequest} {@link CreateScheduledSqlResponse} */
CreateScheduledSql(data: CreateScheduledSqlRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 新建投递到COS的任务 {@link CreateShipperRequest} {@link CreateShipperResponse} */
CreateShipper(data: CreateShipperRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建Splunk投递任务 {@link CreateSplunkDeliverRequest} {@link CreateSplunkDeliverResponse} */
CreateSplunkDeliver(data: CreateSplunkDeliverRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建主题 {@link CreateTopicRequest} {@link CreateTopicResponse} */
CreateTopic(data: CreateTopicRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 创建告警渠道回调配置 {@link CreateWebCallbackRequest} {@link CreateWebCallbackResponse} */
CreateWebCallback(data: CreateWebCallbackRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除告警策略 {@link DeleteAlarmRequest} {@link DeleteAlarmResponse} */
DeleteAlarm(data: DeleteAlarmRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除通知渠道组 {@link DeleteAlarmNoticeRequest} {@link DeleteAlarmNoticeResponse} */
DeleteAlarmNotice(data: DeleteAlarmNoticeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除告警屏蔽规则 {@link DeleteAlarmShieldRequest} {@link DeleteAlarmShieldResponse} */
DeleteAlarmShield(data: DeleteAlarmShieldRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除云产品日志投递 {@link DeleteCloudProductLogCollectionRequest} {@link DeleteCloudProductLogCollectionResponse} */
DeleteCloudProductLogCollection(data: DeleteCloudProductLogCollectionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除采集规则配置 {@link DeleteConfigRequest} {@link DeleteConfigResponse} */
DeleteConfig(data: DeleteConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除特殊采集规则配置 {@link DeleteConfigExtraRequest} {@link DeleteConfigExtraResponse} */
DeleteConfigExtra(data: DeleteConfigExtraRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除应用到机器组的采集配置 {@link DeleteConfigFromMachineGroupRequest} {@link DeleteConfigFromMachineGroupResponse} */
DeleteConfigFromMachineGroup(data: DeleteConfigFromMachineGroupRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除免密分享 {@link DeleteConsoleSharingRequest} {@link DeleteConsoleSharingResponse} */
DeleteConsoleSharing(data: DeleteConsoleSharingRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除投递Ckafka任务 {@link DeleteConsumerRequest} {@link DeleteConsumerResponse} */
DeleteConsumer(data: DeleteConsumerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除消费组 {@link DeleteConsumerGroupRequest} {@link DeleteConsumerGroupResponse} */
DeleteConsumerGroup(data: DeleteConsumerGroupRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除cos导入任务 {@link DeleteCosRechargeRequest} {@link DeleteCosRechargeResponse} */
DeleteCosRecharge(data: DeleteCosRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除仪表盘 {@link DeleteDashboardRequest} {@link DeleteDashboardResponse} */
DeleteDashboard(data: DeleteDashboardRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除仪表盘订阅 {@link DeleteDashboardSubscribeRequest} {@link DeleteDashboardSubscribeResponse} */
DeleteDashboardSubscribe(data: DeleteDashboardSubscribeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除数据加工任务 {@link DeleteDataTransformRequest} {@link DeleteDataTransformResponse} */
DeleteDataTransform(data: DeleteDataTransformRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除DLC投递任务 {@link DeleteDlcDeliverRequest} {@link DeleteDlcDeliverResponse} */
DeleteDlcDeliver(data: DeleteDlcDeliverRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除es导入配置 {@link DeleteEsRechargeRequest} {@link DeleteEsRechargeResponse} */
DeleteEsRecharge(data: DeleteEsRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除日志下载任务 {@link DeleteExportRequest} {@link DeleteExportResponse} */
DeleteExport(data: DeleteExportRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除主机指标采集配置 {@link DeleteHostMetricConfigRequest} {@link DeleteHostMetricConfigResponse} */
DeleteHostMetricConfig(data: DeleteHostMetricConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除索引配置 {@link DeleteIndexRequest} {@link DeleteIndexResponse} */
DeleteIndex(data: DeleteIndexRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除Kafka数据订阅任务 {@link DeleteKafkaRechargeRequest} {@link DeleteKafkaRechargeResponse} */
DeleteKafkaRecharge(data: DeleteKafkaRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除日志集 {@link DeleteLogsetRequest} {@link DeleteLogsetResponse} */
DeleteLogset(data: DeleteLogsetRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除机器组 {@link DeleteMachineGroupRequest} {@link DeleteMachineGroupResponse} */
DeleteMachineGroup(data: DeleteMachineGroupRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除机器组信息 {@link DeleteMachineGroupInfoRequest} {@link DeleteMachineGroupInfoResponse} */
DeleteMachineGroupInfo(data: DeleteMachineGroupInfoRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除指标采集配置 {@link DeleteMetricConfigRequest} {@link DeleteMetricConfigResponse} */
DeleteMetricConfig(data: DeleteMetricConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除指标订阅配置 {@link DeleteMetricSubscribeRequest} {@link DeleteMetricSubscribeResponse} */
DeleteMetricSubscribe(data: DeleteMetricSubscribeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除通知内容模板 {@link DeleteNoticeContentRequest} {@link DeleteNoticeContentResponse} */
DeleteNoticeContent(data: DeleteNoticeContentRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除定时SQL分析任务 {@link DeleteScheduledSqlRequest} {@link DeleteScheduledSqlResponse} */
DeleteScheduledSql(data: DeleteScheduledSqlRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除投递COS任务 {@link DeleteShipperRequest} {@link DeleteShipperResponse} */
DeleteShipper(data: DeleteShipperRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除Splunk投递任务 {@link DeleteSplunkDeliverRequest} {@link DeleteSplunkDeliverResponse} */
DeleteSplunkDeliver(data: DeleteSplunkDeliverRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除主题 {@link DeleteTopicRequest} {@link DeleteTopicResponse} */
DeleteTopic(data: DeleteTopicRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 删除告警渠道回调配置 {@link DeleteWebCallbackRequest} {@link DeleteWebCallbackResponse} */
DeleteWebCallback(data: DeleteWebCallbackRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取通知渠道组列表 {@link DescribeAlarmNoticesRequest} {@link DescribeAlarmNoticesResponse} */
DescribeAlarmNotices(data?: DescribeAlarmNoticesRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取告警屏蔽配置规则 {@link DescribeAlarmShieldsRequest} {@link DescribeAlarmShieldsResponse} */
DescribeAlarmShields(data: DescribeAlarmShieldsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取告警策略列表 {@link DescribeAlarmsRequest} {@link DescribeAlarmsResponse} */
DescribeAlarms(data?: DescribeAlarmsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取告警历史 {@link DescribeAlertRecordHistoryRequest} {@link DescribeAlertRecordHistoryResponse} */
DescribeAlertRecordHistory(data: DescribeAlertRecordHistoryRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 查看云产品日志投递任务列表 {@link DescribeCloudProductLogTasksRequest} {@link DescribeCloudProductLogTasksResponse} */
DescribeCloudProductLogTasks(data?: DescribeCloudProductLogTasksRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取集群指标基础监控采集配置 {@link DescribeClusterBaseMetricConfigsRequest} {@link DescribeClusterBaseMetricConfigsResponse} */
DescribeClusterBaseMetricConfigs(data: DescribeClusterBaseMetricConfigsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取集群指标采集配置 {@link DescribeClusterMetricConfigsRequest} {@link DescribeClusterMetricConfigsResponse} */
DescribeClusterMetricConfigs(data: DescribeClusterMetricConfigsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取特殊采集配置 {@link DescribeConfigExtrasRequest} {@link DescribeConfigExtrasResponse} */
DescribeConfigExtras(data?: DescribeConfigExtrasRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取采集规则配置所绑定的机器组 {@link DescribeConfigMachineGroupsRequest} {@link DescribeConfigMachineGroupsResponse} */
DescribeConfigMachineGroups(data: DescribeConfigMachineGroupsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取采集规则配置 {@link DescribeConfigsRequest} {@link DescribeConfigsResponse} */
DescribeConfigs(data?: DescribeConfigsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取免密分享列表 {@link DescribeConsoleSharingListRequest} {@link DescribeConsoleSharingListResponse} */
DescribeConsoleSharingList(data?: DescribeConsoleSharingListRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取投递配置 {@link DescribeConsumerRequest} {@link DescribeConsumerResponse} */
DescribeConsumer(data: DescribeConsumerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取消费组列表 {@link DescribeConsumerGroupsRequest} {@link DescribeConsumerGroupsResponse} */
DescribeConsumerGroups(data: DescribeConsumerGroupsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取消费组点位信息 {@link DescribeConsumerOffsetsRequest} {@link DescribeConsumerOffsetsResponse} */
DescribeConsumerOffsets(data: DescribeConsumerOffsetsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 投递kafka数据预览 {@link DescribeConsumerPreviewRequest} {@link DescribeConsumerPreviewResponse} */
DescribeConsumerPreview(data?: DescribeConsumerPreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取投递到Ckafka的任务配置列表 {@link DescribeConsumersRequest} {@link DescribeConsumersResponse} */
DescribeConsumers(data?: DescribeConsumersRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取cos导入配置 {@link DescribeCosRechargesRequest} {@link DescribeCosRechargesResponse} */
DescribeCosRecharges(data: DescribeCosRechargesRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取仪表盘订阅列表 {@link DescribeDashboardSubscribesRequest} {@link DescribeDashboardSubscribesResponse} */
DescribeDashboardSubscribes(data?: DescribeDashboardSubscribesRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取仪表盘 {@link DescribeDashboardsRequest} {@link DescribeDashboardsResponse} */
DescribeDashboards(data?: DescribeDashboardsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取数据加工任务列表基本信息 {@link DescribeDataTransformInfoRequest} {@link DescribeDataTransformInfoResponse} */
DescribeDataTransformInfo(data?: DescribeDataTransformInfoRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取DLC投递任务列表 {@link DescribeDlcDeliversRequest} {@link DescribeDlcDeliversResponse} */
DescribeDlcDelivers(data: DescribeDlcDeliversRequest, config?: AxiosRequestConfig): AxiosPromise;
/** es导入预览 {@link DescribeEsRechargePreviewRequest} {@link DescribeEsRechargePreviewResponse} */
DescribeEsRechargePreview(data: DescribeEsRechargePreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取es导入配置 {@link DescribeEsRechargesRequest} {@link DescribeEsRechargesResponse} */
DescribeEsRecharges(data: DescribeEsRechargesRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取日志下载任务列表 {@link DescribeExportsRequest} {@link DescribeExportsResponse} */
DescribeExports(data: DescribeExportsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取主机指标采集配置列表 {@link DescribeHostMetricConfigsRequest} {@link DescribeHostMetricConfigsResponse} */
DescribeHostMetricConfigs(data: DescribeHostMetricConfigsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取索引配置信息 {@link DescribeIndexRequest} {@link DescribeIndexResponse} */
DescribeIndex(data: DescribeIndexRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取Kafka协议消费信息 {@link DescribeKafkaConsumerRequest} {@link DescribeKafkaConsumerResponse} */
DescribeKafkaConsumer(data: DescribeKafkaConsumerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取Kafka协议消费组详情 {@link DescribeKafkaConsumerGroupDetailRequest} {@link DescribeKafkaConsumerGroupDetailResponse} */
DescribeKafkaConsumerGroupDetail(data: DescribeKafkaConsumerGroupDetailRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取Kafka协议消费组列表 {@link DescribeKafkaConsumerGroupListRequest} {@link DescribeKafkaConsumerGroupListResponse} */
DescribeKafkaConsumerGroupList(data: DescribeKafkaConsumerGroupListRequest, config?: AxiosRequestConfig): AxiosPromise;
/** kafka协议消费预览接口 {@link DescribeKafkaConsumerPreviewRequest} {@link DescribeKafkaConsumerPreviewResponse} */
DescribeKafkaConsumerPreview(data?: DescribeKafkaConsumerPreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取kafka协议消费主题信息列表 {@link DescribeKafkaConsumerTopicsRequest} {@link DescribeKafkaConsumerTopicsResponse} */
DescribeKafkaConsumerTopics(data?: DescribeKafkaConsumerTopicsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取Kafka数据订阅任务列表 {@link DescribeKafkaRechargesRequest} {@link DescribeKafkaRechargesResponse} */
DescribeKafkaRecharges(data: DescribeKafkaRechargesRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 上下文检索 {@link DescribeLogContextRequest} {@link DescribeLogContextResponse} */
DescribeLogContext(data: DescribeLogContextRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取日志数量直方图 {@link DescribeLogHistogramRequest} {@link DescribeLogHistogramResponse} */
DescribeLogHistogram(data: DescribeLogHistogramRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取日志集列表 {@link DescribeLogsetsRequest} {@link DescribeLogsetsResponse} */
DescribeLogsets(data?: DescribeLogsetsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取机器组绑定的采集规则配置 {@link DescribeMachineGroupConfigsRequest} {@link DescribeMachineGroupConfigsResponse} */
DescribeMachineGroupConfigs(data: DescribeMachineGroupConfigsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取机器组列表 {@link DescribeMachineGroupsRequest} {@link DescribeMachineGroupsResponse} */
DescribeMachineGroups(data?: DescribeMachineGroupsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取机器状态 {@link DescribeMachinesRequest} {@link DescribeMachinesResponse} */
DescribeMachines(data: DescribeMachinesRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取指标校准维度信息 {@link DescribeMetricCorrectDimensionRequest} {@link DescribeMetricCorrectDimensionResponse} */
DescribeMetricCorrectDimension(data?: DescribeMetricCorrectDimensionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 指标订阅数据预览 {@link DescribeMetricSubscribePreviewRequest} {@link DescribeMetricSubscribePreviewResponse} */
DescribeMetricSubscribePreview(data: DescribeMetricSubscribePreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取指标订阅配置 {@link DescribeMetricSubscribesRequest} {@link DescribeMetricSubscribesResponse} */
DescribeMetricSubscribes(data: DescribeMetricSubscribesRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取通知内容模板 {@link DescribeNoticeContentsRequest} {@link DescribeNoticeContentsResponse} */
DescribeNoticeContents(data?: DescribeNoticeContentsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取分区列表 {@link DescribePartitionsRequest} {@link DescribePartitionsResponse} */
DescribePartitions(data: DescribePartitionsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取重建索引任务列表 {@link DescribeRebuildIndexTasksRequest} {@link DescribeRebuildIndexTasksResponse} */
DescribeRebuildIndexTasks(data: DescribeRebuildIndexTasksRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取定时SQL分析任务列表 {@link DescribeScheduledSqlInfoRequest} {@link DescribeScheduledSqlInfoResponse} */
DescribeScheduledSqlInfo(data?: DescribeScheduledSqlInfoRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取投递任务列表 {@link DescribeShipperTasksRequest} {@link DescribeShipperTasksResponse} */
DescribeShipperTasks(data: DescribeShipperTasksRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取投递到COS的任务配置信息 {@link DescribeShippersRequest} {@link DescribeShippersResponse} */
DescribeShippers(data?: DescribeShippersRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取Splunk投递任务列表 {@link DescribeSplunkDeliversRequest} {@link DescribeSplunkDeliversResponse} */
DescribeSplunkDelivers(data: DescribeSplunkDeliversRequest, config?: AxiosRequestConfig): AxiosPromise;
/** Splunk投递任务预览 {@link DescribeSplunkPreviewRequest} {@link DescribeSplunkPreviewResponse} */
DescribeSplunkPreview(data: DescribeSplunkPreviewRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取指标基础监控采集配置 {@link DescribeTopicBaseMetricConfigsRequest} {@link DescribeTopicBaseMetricConfigsResponse} */
DescribeTopicBaseMetricConfigs(data: DescribeTopicBaseMetricConfigsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取指标采集配置 {@link DescribeTopicMetricConfigsRequest} {@link DescribeTopicMetricConfigsResponse} */
DescribeTopicMetricConfigs(data: DescribeTopicMetricConfigsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取主题列表 {@link DescribeTopicsRequest} {@link DescribeTopicsResponse} */
DescribeTopics(data?: DescribeTopicsRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取告警渠道回调配置列表 {@link DescribeWebCallbacksRequest} {@link DescribeWebCallbacksResponse} */
DescribeWebCallbacks(data?: DescribeWebCallbacksRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 预估重建索引任务 {@link EstimateRebuildIndexTaskRequest} {@link EstimateRebuildIndexTaskResponse} */
EstimateRebuildIndexTask(data: EstimateRebuildIndexTaskRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取告警策略执行详情 {@link GetAlarmLogRequest} {@link GetAlarmLogResponse} */
GetAlarmLog(data: GetAlarmLogRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 获取指标标签列表 {@link GetMetricLabelValuesRequest} {@link GetMetricLabelValuesResponse} */
GetMetricLabelValues(data?: GetMetricLabelValuesRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 合并分区 {@link MergePartitionRequest} {@link MergePartitionResponse} */
MergePartition(data: MergePartitionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改告警策略 {@link ModifyAlarmRequest} {@link ModifyAlarmResponse} */
ModifyAlarm(data: ModifyAlarmRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改通知渠道组 {@link ModifyAlarmNoticeRequest} {@link ModifyAlarmNoticeResponse} */
ModifyAlarmNotice(data: ModifyAlarmNoticeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改告警屏蔽规则 {@link ModifyAlarmShieldRequest} {@link ModifyAlarmShieldResponse} */
ModifyAlarmShield(data: ModifyAlarmShieldRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改云产品日志投递 {@link ModifyCloudProductLogCollectionRequest} {@link ModifyCloudProductLogCollectionResponse} */
ModifyCloudProductLogCollection(data: ModifyCloudProductLogCollectionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改采集规则配置 {@link ModifyConfigRequest} {@link ModifyConfigResponse} */
ModifyConfig(data: ModifyConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改特殊采集配置任务 {@link ModifyConfigExtraRequest} {@link ModifyConfigExtraResponse} */
ModifyConfigExtra(data: ModifyConfigExtraRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改免密分享 {@link ModifyConsoleSharingRequest} {@link ModifyConsoleSharingResponse} */
ModifyConsoleSharing(data: ModifyConsoleSharingRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改投递Ckafka任务 {@link ModifyConsumerRequest} {@link ModifyConsumerResponse} */
ModifyConsumer(data: ModifyConsumerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 更新消费组信息 {@link ModifyConsumerGroupRequest} {@link ModifyConsumerGroupResponse} */
ModifyConsumerGroup(data: ModifyConsumerGroupRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改cos导入任务 {@link ModifyCosRechargeRequest} {@link ModifyCosRechargeResponse} */
ModifyCosRecharge(data: ModifyCosRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改仪表盘 {@link ModifyDashboardRequest} {@link ModifyDashboardResponse} */
ModifyDashboard(data: ModifyDashboardRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改仪表盘订阅 {@link ModifyDashboardSubscribeRequest} {@link ModifyDashboardSubscribeResponse} */
ModifyDashboardSubscribe(data: ModifyDashboardSubscribeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改数据加工任务 {@link ModifyDataTransformRequest} {@link ModifyDataTransformResponse} */
ModifyDataTransform(data: ModifyDataTransformRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改DLC投递任务 {@link ModifyDlcDeliverRequest} {@link ModifyDlcDeliverResponse} */
ModifyDlcDeliver(data: ModifyDlcDeliverRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改es导入任务 {@link ModifyEsRechargeRequest} {@link ModifyEsRechargeResponse} */
ModifyEsRecharge(data: ModifyEsRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改主机指标采集配置 {@link ModifyHostMetricConfigRequest} {@link ModifyHostMetricConfigResponse} */
ModifyHostMetricConfig(data: ModifyHostMetricConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改索引 {@link ModifyIndexRequest} {@link ModifyIndexResponse} */
ModifyIndex(data: ModifyIndexRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改Kafka协议消费信息 {@link ModifyKafkaConsumerRequest} {@link ModifyKafkaConsumerResponse} */
ModifyKafkaConsumer(data: ModifyKafkaConsumerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改Kafka协议消费组点位 {@link ModifyKafkaConsumerGroupOffsetRequest} {@link ModifyKafkaConsumerGroupOffsetResponse} */
ModifyKafkaConsumerGroupOffset(data?: ModifyKafkaConsumerGroupOffsetRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改Kafka数据订阅任务 {@link ModifyKafkaRechargeRequest} {@link ModifyKafkaRechargeResponse} */
ModifyKafkaRecharge(data: ModifyKafkaRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改日志集 {@link ModifyLogsetRequest} {@link ModifyLogsetResponse} */
ModifyLogset(data: ModifyLogsetRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改机器组 {@link ModifyMachineGroupRequest} {@link ModifyMachineGroupResponse} */
ModifyMachineGroup(data: ModifyMachineGroupRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改指标采集配置 {@link ModifyMetricConfigRequest} {@link ModifyMetricConfigResponse} */
ModifyMetricConfig(data: ModifyMetricConfigRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改指标订阅配置 {@link ModifyMetricSubscribeRequest} {@link ModifyMetricSubscribeResponse} */
ModifyMetricSubscribe(data: ModifyMetricSubscribeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改通知内容模板 {@link ModifyNoticeContentRequest} {@link ModifyNoticeContentResponse} */
ModifyNoticeContent(data: ModifyNoticeContentRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改定时SQL分析任务 {@link ModifyScheduledSqlRequest} {@link ModifyScheduledSqlResponse} */
ModifyScheduledSql(data: ModifyScheduledSqlRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改投递COS任务 {@link ModifyShipperRequest} {@link ModifyShipperResponse} */
ModifyShipper(data: ModifyShipperRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改splunk任务投递信息 {@link ModifySplunkDeliverRequest} {@link ModifySplunkDeliverResponse} */
ModifySplunkDeliver(data: ModifySplunkDeliverRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改主题 {@link ModifyTopicRequest} {@link ModifyTopicResponse} */
ModifyTopic(data: ModifyTopicRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 修改告警渠道回调配置 {@link ModifyWebCallbackRequest} {@link ModifyWebCallbackResponse} */
ModifyWebCallback(data: ModifyWebCallbackRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 打开Kafka协议消费 {@link OpenKafkaConsumerRequest} {@link OpenKafkaConsumerResponse} */
OpenKafkaConsumer(data: OpenKafkaConsumerRequest, config?: AxiosRequestConfig): AxiosPromise;
/** Kafka数据订阅日志预览 {@link PreviewKafkaRechargeRequest} {@link PreviewKafkaRechargeResponse} */
PreviewKafkaRecharge(data: PreviewKafkaRechargeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 指标查询(最新值查询) {@link QueryMetricRequest} {@link QueryMetricResponse} */
QueryMetric(data: QueryMetricRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 指标查询(范围查询) {@link QueryRangeMetricRequest} {@link QueryRangeMetricResponse} */
QueryRangeMetric(data: QueryRangeMetricRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 重试失败的投递任务 {@link RetryShipperTaskRequest} {@link RetryShipperTaskResponse} */
RetryShipperTask(data: RetryShipperTaskRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 预览cos导入信息 {@link SearchCosRechargeInfoRequest} {@link SearchCosRechargeInfoResponse} */
SearchCosRechargeInfo(data: SearchCosRechargeInfoRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 预览仪表盘订阅 {@link SearchDashboardSubscribeRequest} {@link SearchDashboardSubscribeResponse} */
SearchDashboardSubscribe(data: SearchDashboardSubscribeRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 检索分析日志 {@link SearchLogRequest} {@link SearchLogResponse} */
SearchLog(data: SearchLogRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 消费组心跳 {@link SendConsumerHeartbeatRequest} {@link SendConsumerHeartbeatResponse} */
SendConsumerHeartbeat(data: SendConsumerHeartbeatRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 分裂主题分区 {@link SplitPartitionRequest} {@link SplitPartitionResponse} */
SplitPartition(data: SplitPartitionRequest, config?: AxiosRequestConfig): AxiosPromise;
/** 上传日志 {@link UploadLogRequest} {@link UploadLogResponse} */
UploadLog(data: UploadLogRequest, config?: AxiosRequestConfig): AxiosPromise;
}
export declare type Versions = ["2020-10-16"];
export default Cls;