tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
1,537 lines (1,438 loc) • 213 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 高级过滤规则 */
declare interface AdvanceFilterRuleInfo {
/** 过滤字段 */
Key: string;
/** 过滤规则,0:等于,1:字段存在,2:字段不存在 */
Rule: number;
/** 过滤值 */
Value?: 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;
/** 关联的告警通知模板列表。 */
AlarmNoticeIds?: string[];
/** 开启状态。 */
Status?: boolean;
/** 告警策略ID。 */
AlarmId?: string;
/** 创建时间。 */
CreateTime?: string;
/** 最近更新时间。 */
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[];
}
/** 告警通知渠道组详细配置 */
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;
/** 创建时间。 */
CreateTime?: string;
/** 最近更新时间。 */
UpdateTime?: string;
}
/** 通知渠道投递日志配置信息 */
declare interface AlarmNoticeDeliverConfig {
/** 通知渠道投递日志配置信息。 */
DeliverConfig?: DeliverConfig;
/** 投递失败原因。 */
ErrMsg?: string;
}
/** 告警屏蔽任务配置 */
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;
/** 规则创建时间。 */
CreateTime?: number;
/** 规则更新时间。 */
UpdateTime?: number;
}
/** 告警对象 */
declare interface AlarmTarget {
/** 日志主题ID。 */
TopicId: string;
/** 查询语句。 */
Query: string;
/** 告警对象序号;从1开始递增。 */
Number: number;
/** 查询范围起始时间相对于告警执行时间的偏移,单位为分钟,取值为非正,最大值为0,最小值为-1440。 */
StartTimeOffset: number;
/** 查询范围终止时间相对于告警执行时间的偏移,单位为分钟,取值为非正,须大于StartTimeOffset,最大值为0,最小值为-1440。 */
EndTimeOffset: number;
/** 日志集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;
/** 告警通知发送频率,单位为分钟 */
AlarmPeriod: number;
/** 通知渠道组 */
Notices: AlertHistoryNotice[];
/** 告警持续时间,单位为分钟 */
Duration: number;
/** 告警状态,0代表未恢复,1代表已恢复,2代表已失效 */
Status: number;
/** 告警发生时间,毫秒级Unix时间戳 */
CreateTime: number;
/** 告警分组触发时对应的分组信息 */
GroupTriggerCondition?: GroupTriggerConditionInfo[];
/** 告警级别,0代表警告(Warn),1代表提醒(Info),2代表紧急 (Critical) */
AlarmLevel?: number;
/** 监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。 */
MonitorObjectType?: number;
}
/** 多维分析的分析维度 */
declare interface AnalysisDimensional {
/** 分析名称 */
Name: string;
/** 分析类型:query,field ,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[];
}
/** 回调配置 */
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 */
InstanceId: string;
/** Ckafka 的 TopicName */
TopicName: string;
/** Ckafka 的 Vip */
Vip?: string;
/** Ckafka 的 Vport */
Vport?: string;
/** Ckafka 的 InstanceName */
InstanceName?: string;
/** Ckafka 的 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;
/** 类型: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;
/** 更新时间 */
UpdateTime?: string;
/** 创建时间 */
CreateTime?: string;
/** 用户自定义解析字符串 */
UserDefineRule?: string;
/** 机器组ID */
GroupId?: string;
/** 自建采集配置标 */
ConfigFlag?: string;
/** 日志集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;
/** 更新时间 */
UpdateTime?: string;
/** 创建时间 */
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;
}
/** 控制台分享配置 */
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;
}
/** 控制台分享链接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;
}
/** 自建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 {
/** 工作负载的类型 */
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 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:腾讯云用户组Email:自定义EmailWeCom: 企业微信回调 */
ReceiverType: string;
/** 知方式对应的值。 当ReceiverType不是 WeCom 时,Values必填。 */
Values?: string[];
/** 仪表盘通知渠道。 支持:["Email","Sms","WeChat","Phone"]。 当ReceiverType是 Email 或 WeCom 时,ReceiverChannels不能赋值。 */
ReceiverChannels?: string[] | null;
/** 回调Url。 当ReceiverType是 WeCom 时,Url必填。 当ReceiverType不是 WeCom 时,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 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 */
TopicId: string;
/** 别名 */
Alias: string;
}
/** 数据加工任务基本详情 */
declare interface DataTransformTaskInfo {
/** 数据加工任务名称 */
Name?: string;
/** 数据加工任务id */
TaskId?: string;
/** 任务启用状态,默认为1,正常开启, 2关闭 */
EnableFlag?: number;
/** 加工任务类型,1: DSL, 2:SQL */
Type?: number;
/** 源日志主题 */
SrcTopicId?: string;
/** 当前加工任务状态(1准备中/2运行中/3停止中/4已停止) */
Status?: number;
/** 加工任务创建时间 */
CreateTime?: string;
/** 最近修改时间 */
UpdateTime?: string;
/** 最后启用时间,如果需要重建集群,修改该时间 */
LastEnableTime?: string;
/** 日志主题名称 */
SrcTopicName?: string;
/** 日志集id */
LogsetId?: string;
/** 加工任务目的topic_id以及别名 */
DstResources?: DataTransformResouceInfo[];
/** 加工逻辑函数。 */
EtlContent?: string;
/** 数据加工类型。0:标准加工任务;1:前置加工任务。 */
DataTransformType?: number;
/** 保留失败日志状态。 1:不保留,2:保留 */
KeepFailureLog?: number;
/** 失败日志的字段名称 */
FailureLogKey?: string;
}
/** 投递配置入参 */
declare interface DeliverConfig {
/** 地域信息。示例: ap-guangzhou 广州地域;ap-nanjing 南京地域。详细信息请查看官网:https://cloud.tencent.com/document/product/614/18940 */
Region: string;
/** 日志主题ID。 */
TopicId: string;
/** 投递数据范围。0: 全部日志, 包括告警策略日常周期执行的所有日志,也包括告警策略变更产生的日志,默认值1:仅告警触发及恢复日志 */
Scope: number;
}
/** 键值索引自动配置,启用后自动将日志内的字段添加到键值索引中,包括日志中后续新增的字段。 */
declare interface DynamicIndex {
/** 键值索引自动配置开关 */
Status?: boolean;
}
/** 升级通知 */
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;
/** 时间类型,1:用户自定义,2:当前时间 */
TimeType: number;
/** 时间,用户选择自定义时间类型时,需要指定时间 */
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;
/** 日志导出创建时间 */
CreateTime?: string;
/** 语法规则。 默认值为0。0:Lucene语法,1:CQL语法。 */
SyntaxRule?: number;
/** 导出字段 */
DerivedFields?: string[];
}
/** 日志提取规则 */
declare interface ExtractRuleInfo {
/** 时间字段的key名字,TikeKey和TimeFormat必须成对出现 */
TimeKey?: string;
/** 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数 */
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 FullTextInfo {
/** 是否大小写敏感 */
CaseSensitive: boolean;
/** 全文索引的分词符,其中的每个字符代表一个分词符;仅支持英文符号、\n\t\r及转义符\;注意:\n\t\r本身已被转义,直接使用双引号包裹即可作为入参,无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式,以避免\n\t\r被重复转义 */
Tokenizer: string;
/** 是否包含中文 */
ContainZH?: boolean;
}
/** 分组触发条件 */
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;
}
/** 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,此协议会进行连接加密同时需要用户认证。入参必填 */
Protocol?: string;
/** 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。当Protocol为sasl_plaintext或sasl_ssl时必填 */
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;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 日志导入规则 */
LogRechargeRule?: LogRechargeRuleInfo;
}
/** 需要过滤日志的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 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:开启(默认值), flase:关闭 */
DefaultTimeSwitch: boolean;
/** 整条日志匹配规则,只有RechargeType为fullregex_log时有效 */
LogRegex?: string;
/** 解析失败日志是否上传,true表示上传,false表示不上传 */
UnMatchLogSwitch?: boolean;
/** 解析失败日志的键名称 */
UnMatchLogKey?: string;
/** 解析失败日志时间来源,0: 系统当前时间,1: Kafka消息时间戳 */
UnMatchLogTimeSrc?: number;
/** 默认时间来源,0: 系统当前时间,1: Kafka消息时间戳 */
DefaultTimeSrc?: number;
/** 时间字段 */
TimeKey?: string;
/** 时间提取正则表达式 */
TimeRegex?: string;
/** 时间字段格式 */
TimeFormat?: string;
/** 时间字段时区 */
TimeZone?: string;
/** 元数据信息,Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp */
Metadata?: string[];
/** 日志Key列表,RechargeType为full_regex_log时必填 */
Keys?: string[];
/** json解析模式,开启首层数据解析 */
ParseArray?: boolean;
}
/** 日志集相关信息 */
declare interface LogsetInfo {
/** 日志集ID */
LogsetId?: string;
/** 日志集名称 */
LogsetName?: string;
/** 创建时间 */
CreateTime?: string;
/** 云产品标识,日志集由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE */
AssumerName?: string;
/** 日志集绑定的标签 */
Tags?: Tag[];
/** 日志集下日志主题的数目 */
TopicCount?: number;
/** 若AssumerName非空,则表示创建该日志集的服务方角色 */
RoleName?: string;
}
/** 机器组信息 */
declare interface MachineGroupInfo {
/** 机器组ID */
GroupId?: string;
/** 机器组名称 */
GroupName?: string;
/** 机器组类型 */
MachineGroupType?: MachineGroupTypeInfo;
/** 创建时间 */
CreateTime?: string;
/** 机器组绑定的标签列表 */
Tags?: Tag[];
/** 是否开启机器组自动更新 */
AutoUpdate?: string;
/** 升级开始时间,建议业务低峰期升级LogListener */
UpdateStartTime?: string;
/** 升级结束时间,建议业务低峰期升级LogListener */
UpdateEndTime?: string;
/** 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费 */
ServiceLogging?: boolean;
/** 机器组中机器离线定期清理时间 */
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;
}
/** 过滤器 */
declare interface MetricLabel {
/** 指标名称 */
Key: string;
/** 指标内容 */
Value: string;
}
/** 告警策略中监控任务的执行时间点 */
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;
}
/** 通知内容模板详细配置 */
declare interface NoticeContent {
/** 渠道类型Email:邮件;Sms:短信;WeChat:微信;Phone:电话;WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调; */
Type: string;
/** 告警触发通知内容模板。 */
TriggerContent?: NoticeContentInfo;
/** 告警恢复通知内容模板。 */
RecoveryContent?: NoticeContentInfo;
}
/** 通知模板内容 */
declare interface NoticeContentInfo {
/** 通知内容模板标题信息。部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。 */
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;
/** 创建时间 秒级时间戳。 */
CreateTime?: number;
/** 更新时间 秒级时间戳。 */
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)。 */
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;
/** 分区创建时间 */
CreateTime?: string;
/** 只读分区数据停止写入时间 */
LastWriteTime?: string | null;
}
/** 预览数据详情 */
declare interface PreviewLogStatistic {
/** 日志内容 */
LogContent: string;
/** 行号。从0开始 */
LineNum: number;
/** 目标日志主题 */
DstTopicId?: string;
/** 失败错误信息, 空字符串""表示正常 */
FailReason?: string;
/** 日志时间,格式:`2024-05-07 17:13:17.105`- 入参时无效- 出参时有效,为日志中的时间格式 */
Time?: string;
/** 目标topic-name */
DstTopicName?: string | 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 {
/** 目标主题id */
TopicId: string;
/** 主题的地域信息 */
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;
/** 任务创建时间 */
CreateTime?: string;
/** 任务更新时间 */
UpdateTime?: string;
/** 任务状态,1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题5: 访问权限问题 6:内部故障 7:其他故障 */
Status?: number;
/** 任务启用状态,1开启, 2关闭 */
EnableFlag?: number;
/** 查询语句 */
ScheduledSqlContent?: string;
/** 调度开始时间 */
ProcessStartTime?: string;
/** 调度类型,1:持续运行 2:指定时间范围 */
ProcessType?: number;
/** 调度结束时间,当process_type=2时为必传字段 */
ProcessEndTime?: string;
/** 调度周期(分钟) */
ProcessPeriod?: number;
/** 查询的时间窗口. @m-15m, @m,意为近15分钟 */
ProcessTimeWindow?: string;
/** 执行延迟(秒) */
ProcessDelay?: number;
/** 源topicId的地域信息 */
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;
}
/** 投递任务信息 */
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;
}
/** 创建资源实例时同时绑定的标签对说明 */
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;