@nocobase/plugin-verification

/** * UploadLog返回参数结构体 */ export interface UploadLogResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAlarm返回参数结构体 */ export interface CreateAlarmResponse { /** * 告警策略ID。 */ AlarmId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 告警策略描述 */ export interface AlarmInfo { /** * 告警策略名称。 */ Name?: string; /** * 监控对象列表。 */ AlarmTargets?: Array<AlarmTargetInfo>; /** * 监控任务运行时间点。 */ MonitorTime?: MonitorTime; /** * 触发条件。 */ Condition?: string; /** * 持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为10。 */ TriggerCount?: number; /** * 告警重复的周期。单位是min。取值范围是0~1440。 */ AlarmPeriod?: number; /** * 关联的告警通知模板列表。 */ AlarmNoticeIds?: Array<string>; /** * 开启状态。 */ Status?: boolean; /** * 告警策略ID。 */ AlarmId?: string; /** * 创建时间。 */ CreateTime?: string; /** * 最近更新时间。 */ UpdateTime?: string; /** * 自定义通知模板注意：此字段可能返回 null，表示取不到有效值。 */ MessageTemplate?: string; /** * 自定义回调模板注意：此字段可能返回 null，表示取不到有效值。 */ CallBack?: CallBackInfo; /** * 多维分析设置注意：此字段可能返回 null，表示取不到有效值。 */ Analysis?: Array<AnalysisDimensional>; /** * 分组触发状态。1：开启，0：关闭（默认）注意：此字段可能返回 null，表示取不到有效值。 */ GroupTriggerStatus?: boolean; /** * 分组触发条件。注意：此字段可能返回 null，表示取不到有效值。 */ GroupTriggerCondition?: Array<string>; /** * 监控对象类型。0:执行语句共用监控对象;1:每个执行语句单独选择监控对象。注意：此字段可能返回 null，表示取不到有效值。 */ MonitorObjectType?: number; /** * 告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)。注意：此字段可能返回 null，表示取不到有效值。 */ AlarmLevel?: number; /** * 多触发条件。注意：此字段可能返回 null，表示取不到有效值。 */ MultiConditions?: Array<MultiCondition>; } /** * 日志结果信息 */ export interface LogInfo { /** * 日志时间，单位ms */ Time: number; /** * 日志主题ID */ TopicId: string; /** * 日志主题名称 */ TopicName: string; /** * 日志来源IP */ Source: string; /** * 日志文件名称 */ FileName: string; /** * 日志上报请求包的ID */ PkgId: string; /** * 请求包内日志的ID */ PkgLogId: string; /** * 日志内容的Json序列化字符串注意：此字段可能返回 null，表示取不到有效值。 */ LogJson: string; /** * 日志来源主机名称注意：此字段可能返回 null，表示取不到有效值。 */ HostName: string; /** * 原始日志(仅在日志创建索引异常时有值) 注意：此字段可能返回 null，表示取不到有效值。 */ RawLog?: string; /** * 日志创建索引异常原因(仅在日志创建索引异常时有值) 注意：此字段可能返回 null，表示取不到有效值。 */ IndexStatus?: string; } /** * DeleteAlarmNotice返回参数结构体 */ export interface DeleteAlarmNoticeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLogHistogram请求参数结构体 */ export interface DescribeLogHistogramRequest { /** * 要查询的日志的起始时间，Unix时间戳，单位ms */ From: number; /** * 要查询的日志的结束时间，Unix时间戳，单位ms */ To: number; /** * 查询语句 */ Query: string; /** * 要查询的日志主题ID */ TopicId?: string; /** * 时间间隔: 单位ms 限制性条件：(To-From) / interval <= 200 */ Interval?: number; /** * 检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a> */ SyntaxRule?: number; } /** * DescribeLogContext请求参数结构体 */ export interface DescribeLogContextRequest { /** * 要查询的日志主题ID */ TopicId: string; /** * 日志时间, 格式: YYYY-mm-dd HH:MM:SS.FFF */ BTime: string; /** * 日志包序号 */ PkgId: string; /** * 日志包内一条日志的序号 */ PkgLogId: number; /** * 上文日志条数, 默认值10 */ PrevLogs?: number; /** * 下文日志条数, 默认值10 */ NextLogs?: number; } /** * DeleteShipper请求参数结构体 */ export interface DeleteShipperRequest { /** * 投递规则ID */ ShipperId: string; } /** * DeleteScheduledSql请求参数结构体 */ export interface DeleteScheduledSqlRequest { /** * 任务ID */ TaskId: string; /** * 源日志主题ID */ SrcTopicId: string; } /** * 动态索引配置，启用后将自动把日志内的字段添加到键值索引字段列表中，包括日志中新增的字段。 */ export interface DynamicIndex { /** * 动态索引配置开关注意：此字段可能返回 null，表示取不到有效值。 */ Status?: boolean; } /** * DeleteLogset返回参数结构体 */ export interface DeleteLogsetResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Parquet内容描述 */ export interface ParquetKeyInfo { /** * 键值名称 */ KeyName: string; /** * 数据类型，目前支持6种类型：string、boolean、int32、int64、float、double */ KeyType: string; /** * 解析失败赋值信息注意：此字段可能返回 null，表示取不到有效值。 */ KeyNonExistingField: string; } /** * DescribeCosRecharges返回参数结构体 */ export interface DescribeCosRechargesResponse { /** * 见: CosRechargeInfo 结构描述注意：此字段可能返回 null，表示取不到有效值。 */ Data?: Array<CosRechargeInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeShipperTasks返回参数结构体 */ export interface DescribeShipperTasksResponse { /** * 投递任务列表注意：此字段可能返回 null，表示取不到有效值。 */ Tasks: Array<ShipperTaskInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckFunction请求参数结构体 */ export interface CheckFunctionRequest { /** * 用户输入的加工语句 */ EtlContent: string; /** * 加工任务目的topic_id以及别名 */ DstResources?: Array<DataTransformResouceInfo>; /** * 数据加工目标主题的类型. 1 固定主题 2动态创建 */ FuncType?: number; } /** * 过滤器 */ export interface Filter { /** * 需要过滤的字段。 */ Key: string; /** * 需要过滤的值。 */ Values: Array<string>; } /** * DescribeConfigMachineGroups请求参数结构体 */ export interface DescribeConfigMachineGroupsRequest { /** * 采集配置ID */ ConfigId: string; } /** * ModifyConfigExtra返回参数结构体 */ export interface ModifyConfigExtraResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SearchCosRechargeInfo请求参数结构体 */ export interface SearchCosRechargeInfoRequest { /** * 日志主题 ID */ TopicId: string; /** * 日志集ID */ LogsetId: string; /** * 投递任务名称 */ Name: string; /** * 存储桶 */ Bucket: string; /** * 存储桶所在地域 */ BucketRegion: string; /** * cos文件所在文件夹的前缀 */ Prefix: string; /** * 压缩模式: "", "gzip", "lzop", "snappy”; 默认"" */ Compress?: string; } /** * Kafka导入配置信息 */ export interface KafkaRechargeInfo { /** * 主键ID 注意：此字段可能返回 null，表示取不到有效值。 */ Id?: string; /** * 日志主题ID 注意：此字段可能返回 null，表示取不到有效值。 */ TopicId?: string; /** * Kafka导入任务名称注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 导入Kafka类型，0: 腾讯云CKafka，1: 用户自建Kafka 注意：此字段可能返回 null，表示取不到有效值。 */ KafkaType?: number; /** * 腾讯云CKafka实例ID，KafkaType为0时必填注意：此字段可能返回 null，表示取不到有效值。 */ KafkaInstance?: string; /** * 服务地址注意：此字段可能返回 null，表示取不到有效值。 */ ServerAddr?: string; /** * ServerAddr是否为加密连接注意：此字段可能返回 null，表示取不到有效值。 */ IsEncryptionAddr?: boolean; /** * 加密访问协议，IsEncryptionAddr参数为true时必填 */ Protocol?: KafkaProtocolInfo; /** * 用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开注意：此字段可能返回 null，表示取不到有效值。 */ UserKafkaTopics?: string; /** * 用户Kafka消费组名称注意：此字段可能返回 null，表示取不到有效值。 */ ConsumerGroupName?: string; /** * 状态 status 1: 运行中, 2: 暂停 ... 注意：此字段可能返回 null，表示取不到有效值。 */ Status?: number; /** * 导入数据位置，-2:最早（默认），-1：最晚注意：此字段可能返回 null，表示取不到有效值。 */ Offset?: number; /** * 创建时间注意：此字段可能返回 null，表示取不到有效值。 */ CreateTime?: string; /** * 更新时间注意：此字段可能返回 null，表示取不到有效值。 */ UpdateTime?: string; /** * 日志导入规则注意：此字段可能返回 null，表示取不到有效值。 */ LogRechargeRule?: LogRechargeRuleInfo; } /** * ModifyLogset请求参数结构体 */ export interface ModifyLogsetRequest { /** * 日志集ID */ LogsetId: string; /** * 日志集名称 */ LogsetName?: string; /** * 日志集的绑定的标签键值对。最大支持10个标签键值对，同一个资源只能同时绑定一个标签键。 */ Tags?: Array<Tag>; } /** * UploadLog请求参数结构体 */ export interface UploadLogRequest { /** * 主题id */ TopicId: string; /** * 根据 hashkey 写入相应范围的主题分区 */ HashKey?: string; /** * 压缩方法 */ CompressType?: string; } /** * CreateLogset请求参数结构体 */ export interface CreateLogsetRequest { /** * 日志集名字，不能重名 */ LogsetName: string; /** * 标签描述列表。最大支持10个标签键值对，并且不能有重复的键值对 */ Tags?: Array<Tag>; } /** * DescribeShippers请求参数结构体 */ export interface DescribeShippersRequest { /** * - shipperName：按照【投递规则名称】进行过滤。类型：String。必选：否 - shipperId：按照【投递规则ID】进行过滤。类型：String。必选：否 - topicId：按照【日志主题】进行过滤。类型：String。必选：否每次请求的Filters的上限为10，Filter.Values的上限为5。 */ Filters?: Array<Filter>; /** * 分页的偏移量，默认值为0 */ Offset?: number; /** * 分页单页的限制数目，默认值为20，最大值100 */ Limit?: number; } /** * CreateScheduledSql返回参数结构体 */ export interface CreateScheduledSqlResponse { /** * 任务id */ TaskId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDashboards请求参数结构体 */ export interface DescribeDashboardsRequest { /** * 分页的偏移量，默认值为0。 */ Offset?: number; /** * 分页单页限制数目，默认值为20，最大值100。 */ Limit?: number; /** * <li>dashboardId 按照【仪表盘id】进行过滤。类型：String 必选：否</li> <li> dashboardName 按照【仪表盘名字】进行模糊搜索过滤。类型：String 必选：否</li> <li> dashboardRegion 按照【仪表盘地域】进行过滤，为了兼容老的仪表盘，通过云API创建的仪表盘没有地域属性类型：String 必选：否</li> <li> tagKey 按照【标签键】进行过滤。类型：String 必选：否</li> <li> tag:tagKey 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。类型：String 必选：否</li> 每次请求的Filters的上限为10，Filter.Values的上限为100。 */ Filters?: Array<Filter>; /** * 按照topicId和regionId过滤。 */ TopicIdRegionFilter?: Array<TopicIdAndRegion>; } /** * QueryMetric请求参数结构体 */ export interface QueryMetricRequest { /** * 查询语句，使用PromQL语法 */ Query: string; /** * 指标主题ID */ TopicId: string; /** * 查询时间，秒级Unix时间戳 */ Time?: number; } /** * 日志中的KV对 */ export interface LogItem { /** * 日志Key */ Key: string; /** * 日志Value */ Value: string; } /** * SearchLog返回参数结构体 */ export interface SearchLogResponse { /** * 透传本次接口返回的Context值，可获取后续更多日志，过期时间1小时。注意： * 仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context */ Context?: string; /** * 符合检索条件的日志是否已全部返回，如未全部返回可使用Context参数获取后续更多日志注意：仅当检索分析语句(Query)不包含SQL时有效 */ ListOver?: boolean; /** * 返回的是否为统计分析（即SQL）结果 */ Analysis?: boolean; /** * 匹配检索条件的原始日志注意：此字段可能返回 null，表示取不到有效值。 */ Results?: Array<LogInfo>; /** * 日志统计分析结果的列名当UseNewAnalysis为false时生效注意：此字段可能返回 null，表示取不到有效值。 */ ColNames?: Array<string>; /** * 日志统计分析结果当UseNewAnalysis为false时生效注意：此字段可能返回 null，表示取不到有效值。 */ AnalysisResults?: Array<LogItems>; /** * 日志统计分析结果当UseNewAnalysis为true时生效注意：此字段可能返回 null，表示取不到有效值。 */ AnalysisRecords?: Array<string>; /** * 日志统计分析结果的列属性当UseNewAnalysis为true时生效注意：此字段可能返回 null，表示取不到有效值。 */ Columns?: Array<Column>; /** * 本次统计分析使用的采样率注意：此字段可能返回 null，表示取不到有效值。 */ SamplingRate?: number; /** * 使用多日志主题检索时，各个日志主题的基本信息，例如报错信息。注意：此字段可能返回 null，表示取不到有效值。 */ Topics?: SearchLogTopics; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteTopic请求参数结构体 */ export interface DeleteTopicRequest { /** * 日志主题ID */ TopicId: string; } /** * DescribePartitions请求参数结构体 */ export interface DescribePartitionsRequest { /** * 日志主题ID */ TopicId: string; } /** * 自建k8s-容器标准输出信息 */ export interface ContainerStdoutInfo { /** * 是否所有容器 */ AllContainers: boolean; /** * container为空表所有的，不为空采集指定的容器注意：此字段可能返回 null，表示取不到有效值。 */ Container?: string; /** * namespace可以多个，用分隔号分割,例如A,B；为空或者没有这个字段，表示所有namespace 注意：此字段可能返回 null，表示取不到有效值。 */ Namespace?: string; /** * pod标签信息注意：此字段可能返回 null，表示取不到有效值。 */ IncludeLabels?: Array<string>; /** * 工作负载信息注意：此字段可能返回 null，表示取不到有效值。 */ WorkLoads?: Array<ContainerWorkLoadInfo>; /** * 需要排除的namespace可以多个，用分隔号分割,例如A,B 注意：此字段可能返回 null，表示取不到有效值。 */ ExcludeNamespace?: string; /** * 需要排除的pod标签信息注意：此字段可能返回 null，表示取不到有效值。 */ ExcludeLabels?: Array<string>; /** * metadata信息注意：此字段可能返回 null，表示取不到有效值。 */ CustomLabels?: Array<string>; } /** * 采集规则配置信息 */ export interface ConfigInfo { /** * 采集规则配置ID */ ConfigId?: string; /** * 采集规则配置名称注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 日志格式化方式注意：此字段可能返回 null，表示取不到有效值。 */ LogFormat?: string; /** * 日志采集路径注意：此字段可能返回 null，表示取不到有效值。 */ Path?: string; /** * 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志，multiline_log代表多行日志，fullregex_log代表完整正则，默认为minimalist_log 注意：此字段可能返回 null，表示取不到有效值。 */ LogType?: string; /** * 提取规则，如果设置了ExtractRule，则必须设置LogType 注意：此字段可能返回 null，表示取不到有效值。 */ ExtractRule?: ExtractRuleInfo; /** * 采集黑名单路径列表注意：此字段可能返回 null，表示取不到有效值。 */ ExcludePaths?: Array<ExcludePathInfo>; /** * 采集配置所属日志主题ID即TopicId */ Output?: string; /** * 更新时间注意：此字段可能返回 null，表示取不到有效值。 */ UpdateTime?: string; /** * 创建时间 */ CreateTime?: string; /** * 用户自定义解析字符串注意：此字段可能返回 null，表示取不到有效值。 */ UserDefineRule?: string; /** * 高级采集配置。 Json字符串， Key/Value定义为如下： - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 - ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 - ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false 样例：{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true} 注意：此字段可能返回 null，表示取不到有效值。 */ AdvancedConfig?: string; } /** * ModifyAlarm返回参数结构体 */ export interface ModifyAlarmResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeShipperTasks请求参数结构体 */ export interface DescribeShipperTasksRequest { /** * 投递规则ID */ ShipperId: string; /** * 查询的开始时间戳，支持最近3天的查询，毫秒 */ StartTime: number; /** * 查询的结束时间戳，毫秒 */ EndTime: number; } /** * DescribeAlarms请求参数结构体 */ export interface DescribeAlarmsRequest { /** * name - 按照【告警策略名称】进行过滤。 - 类型：String - 必选：否 alarmId - 按照【告警策略ID】进行过滤。 - 类型：String - 必选：否 topicId - 按照【监控对象的日志主题ID】进行过滤。 - 类型：String - 必选：否 enable - 按照【启用状态】进行过滤。 - 类型：String - 备注：enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。其它值将返回参数错误信息. - 必选：否每次请求的Filters的上限为10，Filter.Values的上限为5。 */ Filters?: Array<Filter>; /** * 分页的偏移量，默认值为0。 */ Offset?: number; /** * 分页单页限制数目，默认值为20，最大值100。 */ Limit?: number; } /** * MergePartition请求参数结构体 */ export interface MergePartitionRequest { /** * 日志主题ID */ TopicId: string; /** * 合并的PartitionId */ PartitionId: number; } /** * DescribeShippers返回参数结构体 */ export interface DescribeShippersResponse { /** * 投递规则列表注意：此字段可能返回 null，表示取不到有效值。 */ Shippers?: Array<ShipperInfo>; /** * 本次查询获取到的总数 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 仪表盘 topic与地域信息 */ export interface TopicIdAndRegion { /** * 日志主题id */ TopicId: string; /** * 日志主题id 所在的地域id 地域ID - 访问链接查看详情：https://iwiki.woa.com/pages/viewpage.action?pageId=780556968#id-地域码表-一.region大区（标准地域） */ RegionId: number; } /** * DescribeKafkaConsumer返回参数结构体 */ export interface DescribeKafkaConsumerResponse { /** * Kafka协议消费是否打开 */ Status?: boolean; /** * KafkaConsumer 消费时使用的Topic参数 */ TopicID?: string; /** * 压缩方式[0:NONE；2:SNAPPY；3:LZ4] */ Compression?: number; /** * kafka协议消费数据格式 */ ConsumerContent?: KafkaConsumerContent; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateConfigExtra返回参数结构体 */ export interface CreateConfigExtraResponse { /** * 采集配置扩展信息ID */ ConfigExtraId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyShipper返回参数结构体 */ export interface ModifyShipperResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteKafkaRecharge返回参数结构体 */ export interface DeleteKafkaRechargeResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自建k8s-工作负载信息 */ export interface ContainerWorkLoadInfo { /** * 工作负载的类型 */ Kind: string; /** * 工作负载的名称 */ Name: string; /** * 容器名注意：此字段可能返回 null，表示取不到有效值。 */ Container?: string; /** * 命名空间注意：此字段可能返回 null，表示取不到有效值。 */ Namespace?: string; } /** * DescribeConfigExtras返回参数结构体 */ export interface DescribeConfigExtrasResponse { /** * 采集配置列表注意：此字段可能返回 null，表示取不到有效值。 */ Configs?: Array<ConfigExtraInfo>; /** * 过滤到的总数目 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDataTransform请求参数结构体 */ export interface ModifyDataTransformRequest { /** * 加工任务id */ TaskId: string; /** * 加工任务名称 */ Name?: string; /** * 加工语句 */ EtlContent?: string; /** * 任务启动状态. 默认为1，开启, 2关闭 */ EnableFlag?: number; /** * 加工任务目的topic_id以及别名 */ DstResources?: Array<DataTransformResouceInfo>; /** * 是否开启投递服务日志。1关闭，2开启 */ HasServicesLog?: number; } /** * DescribeScheduledSqlInfo返回参数结构体 */ export interface DescribeScheduledSqlInfoResponse { /** * ScheduledSQL任务列表信息 */ ScheduledSqlTaskInfos?: Array<ScheduledSqlTaskInfo>; /** * 任务总次数 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 回调配置 */ export interface CallBackInfo { /** * 回调时的Body */ Body: string; /** * 回调时的Headers 注意：此字段可能返回 null，表示取不到有效值。 */ Headers?: Array<string>; } /** * OpenKafkaConsumer返回参数结构体 */ export interface OpenKafkaConsumerResponse { /** * KafkaConsumer 消费时使用的Topic参数 */ TopicID?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 告警对象 */ export 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; } /** * 告警分类信息 */ export interface AlarmClassification { /** * 分类键 */ Key: string; /** * 分类值 */ Value: string; } /** * ScheduledSql的资源信息 */ export interface ScheduledSqlResouceInfo { /** * 目标主题id */ TopicId: string; /** * 主题的地域信息 */ Region?: string; /** * 主题类型：0为日志主题，1为指标主题 */ BizType?: number; /** * 指标名称 */ MetricName?: string; /** * 指标名称 BizType为1时，优先使用MetricNames字段多指标只能填充到MetricNames字段，单指标建议填充到MetricName字段 */ MetricNames?: Array<string>; /** * 指标维度，不接受时间类型。 */ MetricLabels?: Array<string>; /** * 指标时间戳，默认值为SQL查询时间范围的左侧时间点，您也可以指定其他字段（类型为uinx时间，精度毫秒）为指标时间戳。 */ CustomTime?: string; /** * 除了MetricLabels，您还可以使用该参数，为指标补充静态的维度。维度名以字母或下划线开头，后面可以跟字母、数字或下划线，长度小于等于1024 字节 */ CustomMetricLabels?: Array<MetricLabel>; } /** * 文件路径信息 */ export interface FilePathInfo { /** * 文件路径 */ Path?: string; /** * 文件名称 */ File?: string; } /** * DescribeIndex请求参数结构体 */ export interface DescribeIndexRequest { /** * 日志主题ID */ TopicId: string; } /** * ModifyScheduledSql返回参数结构体 */ export interface ModifyScheduledSqlResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConfigs返回参数结构体 */ export interface DescribeConfigsResponse { /** * 采集配置列表注意：此字段可能返回 null，表示取不到有效值。 */ Configs?: Array<ConfigInfo>; /** * 过滤到的总数目 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteMachineGroupInfo请求参数结构体 */ export interface DeleteMachineGroupInfoRequest { /** * 机器组ID */ GroupId: string; /** * 机器组类型目前type支持 ip 和 label */ MachineGroupType: MachineGroupTypeInfo; } /** * CreateLogset返回参数结构体 */ export interface CreateLogsetResponse { /** * 日志集ID */ LogsetId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 通知规则 */ export interface NoticeRule { /** * 告警通知模板接收者信息。注意：此字段可能返回 null，表示取不到有效值。 */ NoticeReceivers?: Array<NoticeReceiver>; /** * 告警通知模板回调信息。注意：此字段可能返回 null，表示取不到有效值。 */ WebCallbacks?: Array<WebCallback>; /** * 匹配规则。注意：此字段可能返回 null，表示取不到有效值。 */ Rule?: string; } /** * DeleteMachineGroup返回参数结构体 */ export interface DeleteMachineGroupResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Kafka访问协议 */ export interface KafkaProtocolInfo { /** * 协议类型，支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl，此协议会进行连接加密同时需要用户认证注意：此字段可能返回 null，表示取不到有效值。 */ Protocol?: string; /** * 加密类型，支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512 注意：此字段可能返回 null，表示取不到有效值。 */ Mechanism?: string; /** * 用户名注意：此字段可能返回 null，表示取不到有效值。 */ UserName?: string; /** * 用户密码注意：此字段可能返回 null，表示取不到有效值。 */ Password?: string; } /** * ScheduledSql任务详情 */ export 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语法注意：此字段可能返回 null，表示取不到有效值。 */ SyntaxRule?: number; } /** * DescribeCosRecharges请求参数结构体 */ export interface DescribeCosRechargesRequest { /** * 日志主题 ID */ TopicId: string; /** * 状态 status 0: 已创建, 1: 运行中, 2: 已停止, 3: 已完成, 4: 运行失败。 */ Status?: number; /** * 是否启用: 0：未启用， 1：启用 */ Enable?: number; } /** * 元数据信息 */ export interface MetaTagInfo { /** * 元数据key */ Key?: string; /** * 元数据value */ Value?: string; } /** * CreateCosRecharge请求参数结构体 */ export interface CreateCosRechargeRequest { /** * 日志主题 ID */ TopicId: string; /** * 日志集ID */ LogsetId: string; /** * 投递任务名称 */ Name: string; /** * COS存储桶 */ Bucket: string; /** * COS存储桶所在地域 */ 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; } /** * DescribeKafkaUser请求参数结构体 */ export interface DescribeKafkaUserRequest { /** * kafka消费用户名 */ UserName: string; } /** * 日志提取规则 */ export interface ExtractRuleInfo { /** * 时间字段的key名字，time_key和time_format必须成对出现注意：此字段可能返回 null，表示取不到有效值。 */ TimeKey?: string; /** * 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数注意：此字段可能返回 null，表示取不到有效值。 */ TimeFormat?: string; /** * 分隔符类型日志的分隔符，只有log_type为delimiter_log时有效注意：此字段可能返回 null，表示取不到有效值。 */ Delimiter?: string; /** * 整条日志匹配规则，只有log_type为fullregex_log时有效注意：此字段可能返回 null，表示取不到有效值。 */ LogRegex?: string; /** * 行首匹配规则，只有log_type为multiline_log或fullregex_log时有效注意：此字段可能返回 null，表示取不到有效值。 */ BeginRegex?: string; /** * 取的每个字段的key名字，为空的key代表丢弃这个字段，只有log_type为delimiter_log时有效，json_log的日志使用json本身的key。限制100个。注意：此字段可能返回 null，表示取不到有效值。 */ Keys?: Array<string>; /** * 需要过滤日志的key，及其对应的regex 注意：此字段可能返回 null，表示取不到有效值。 */ FilterKeyRegex?: Array<KeyRegexInfo>; /** * 解析失败日志是否上传，true表示上传，false表示不上传注意：此字段可能返回 null，表示取不到有效值。 */ UnMatchUpLoadSwitch?: boolean; /** * 失败日志的key 注意：此字段可能返回 null，表示取不到有效值。 */ UnMatchLogKey?: string; /** * 增量采集模式下的回溯数据量，默认-1（全量采集）注意：此字段可能返回 null，表示取不到有效值。 */ Backtracking?: number; /** * 是否为Gbk编码. 0: 否, 1: 是注意：此字段可能返回 null，表示取不到有效值。 */ IsGBK?: number; /** * 是否为标准json. 0: 否, 1: 是注意：此字段可能返回 null，表示取不到有效值。 */ JsonStandard?: number; /** * syslog传输协议，取值为tcp或者udp。该字段适用于：创建采集规则配置、修改采集规则配置注意：此字段可能返回 null，表示取不到有效值。 */ Protocol?: string; /** * syslog系统日志采集指定采集器监听的地址和端口，形式：[ip]:[port]。举例：127.0.0.1:9000 该字段适用于：创建采集规则配置、修改采集规则配置注意：此字段可能返回 null，表示取不到有效值。 */ Address?: string; /** * rfc3164：指定系统日志采集使用RFC3164协议解析日志。 rfc5424：指定系统日志采集使用RFC5424协议解析日志。 auto：自动匹配rfc3164或者rfc5424其中一种协议该字段适用于：创建采集规则配置、修改采集规则配置注意：此字段可能返回 null，表示取不到有效值。 */ ParseProtocol?: string; /** * 元数据类型，0: 不使用元数据信息，1:使用机器组元数据，2:使用用户自定义元数据，3:使用采集配置路径， */ MetadataType?: number; /** * 采集配置路径正则表达式，MetadataType为3时必填注意：此字段可能返回 null，表示取不到有效值。 */ PathRegex?: string; /** * 用户自定义元数据信息，MetadataType为2时必填 */ MetaTags?: Array<MetaTagInfo>; /** * Windows事件日志采集 */ EventLogRules?: Array<EventLog>; } /** * 日志主题信息 */ export interface TopicInfo { /** * 日志集ID */ LogsetId?: string; /** * 日志主题ID */ TopicId?: string; /** * 日志主题名称 */ TopicName?: string; /** * 主题分区个数 */ PartitionCount?: number; /** * 是否开启索引 */ Index?: boolean; /** * 云产品标识，日志主题由其它云产品创建时，该字段会显示云产品名称，例如CDN、TKE 注意：此字段可能返回 null，表示取不到有效值。 */ AssumerName?: string; /** * 创建时间 */ CreateTime?: string; /** * 日主主题是否开启采集 */ Status?: boolean; /** * 日志主题绑定的标签信息注意：此字段可能返回 null，表示取不到有效值。 */ Tags?: Array<Tag>; /** * 该主题是否开启自动分裂注意：此字段可能返回 null，表示取不到有效值。 */ AutoSplit?: boolean; /** * 若开启自动分裂的话，该主题能够允许的最大分区数注意：此字段可能返回 null，表示取不到有效值。 */ MaxSplitPartitions?: number; /** * 日主题的存储类型注意：此字段可能返回 null，表示取不到有效值。 */ StorageType?: string; /** * 生命周期，单位天，可取值范围1~3600。取值为3640时代表永久保存注意：此字段可能返回 null，表示取不到有效值。 */ Period?: number; /** * 云产品二级标识，日志主题由其它云产品创建时，该字段会显示云产品名称及其日志类型的二级分类，例如TKE-Audit、TKE-Event。部分云产品仅有云产品标识(AssumerName)，无该字段。注意：此字段可能返回 null，表示取不到有效值。 */ SubAssumerName?: string; /** * 日志主题描述注意：此字段可能返回 null，表示取不到有效值。 */ Describes?: string; /** * 开启日志沉降，热存储的生命周期， hotPeriod < Period。热存储为 hotPeriod, 冷存储则为 Period-hotPeriod。注意：此字段可能返回 null，表示取不到有效值。 */ HotPeriod?: number; /** * 主题类型。 - 0: 日志主题 - 1: 指标主题注意：此字段可能返回 null，表示取不到有效值。 */ BizType?: number; /** * 免鉴权开关。 - false: 关闭 - true: 开启注意：此字段可能返回 null，表示取不到有效值。 */ IsWebTracking?: boolean; } /** * DeleteDataTransform返回参数结构体 */ export interface DeleteDataTransformResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteConfigExtra返回参数结构体 */ export interface DeleteConfigExtraResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyConsumer请求参数结构体 */ export interface ModifyConsumerRequest { /** * 投递任务绑定的日志主题 ID */ TopicId: string; /** * 投递任务是否生效，默认不生效 */ Effective?: boolean; /** * 是否投递日志的元数据信息，默认为 false */ NeedContent?: boolean; /** * 如果需要投递元数据信息，元数据信息的描述 */ Content?: ConsumerContent; /** * CKafka的描述 */ Ckafka?: Ckafka; /** * 投递时压缩方式，取值0，2，3。[0:NONE；2:SNAPPY；3:LZ4] */ Compression?: number; } /** * CreateIndex返回参数结构体 */ export interface CreateIndexResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteConfigFromMachineGroup返回参数结构体 */ export interface DeleteConfigFromMachineGroupResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateConsumer返回参数结构体 */ export interface CreateConsumerResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMachineGroup返回参数结构体 */ export interface ModifyMachineGroupResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据加工的资源信息 */ export interface DataTransformResouceInfo { /** * 目标主题id */ TopicId: string; /** * 别名 */ Alias: string; } /** * DeleteMachineGroup请求参数结构体 */ export interface DeleteMachineGroupRequest { /** * 机器组ID */ GroupId: string; } /** * 全文索引配置 */ export interface FullTextInfo { /** * 是否大小写敏感 */ CaseSensitive: boolean; /** * 全文索引的分词符，其中的每个字符代表一个分词符；仅支持英文符号、\n\t\r及转义符\；注意：\n\t\r本身已被转义，直接使用双引号包裹即可作为入参，无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式，以避免\n\t\r被重复转义 */ Tokenizer: string; /** * 是否包含中文注意：此字段可能返回 null，表示取不到有效值。 */ ContainZH?: boolean; } /** * QueryMetric返回参数结构体 */ export interface QueryMetricResponse { /** * 指标查询结果类型 */ ResultType?: string; /** * 指标查询结果 */ Result?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePartitions返回参数结构体 */ export interface DescribePartitionsResponse { /** * 分区列表 */ Partitions: Array<PartitionInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConfigMachineGroups返回参数结构体 */ export interface DescribeConfigMachineGroupsResponse { /** * 采集规则配置绑定的机器组列表注意：此字段可能返回 null，表示取不到有效值。 */ MachineGroups?: Array<MachineGroupInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyAlarm请求参数结构体 */ export interface ModifyAlarmRequest { /** * 告警策略ID。 */ AlarmId: string; /** * 告警策略名称 */ 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?: Array<MultiCondition>; /** * 持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为10。 */ TriggerCount?: number; /** * 告警重复的周期。单位是分钟。取值范围是0~1440。 */ AlarmPeriod?: number; /** * 关联的告警通知模板列表。 */ AlarmNoticeIds?: Array<string>; /** * 监控对象列表。 */ AlarmTargets?: Array<AlarmTarget>; /** * 是否开启告警策略。 */ Status?: boolean; /** * 该参数已废弃，请使用Status参数控制是否开启告警策略。 */ Enable?: boolean; /** * 用户自定义告警内容 */ MessageTemplate?: string; /** * 用户自定义回调 */ CallBack?: CallBackInfo; /** * 多维分析 */ Analysis?: Array<AnalysisDimensional>; /** * 分组触发状态。true：开启，false：关闭（默认） */ GroupTriggerStatus?: boolean; /** * 分组触发条件。 */ GroupTriggerCondition?: Array<string>; /** * 标签描述列表，通过指定该参数可以同时绑定标签到相应的告警策略。最大支持10个标签键值对，并且不能有重复的键值对。 */ Tags?: Array<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?: Array<AlarmClassification>; } /** * DescribeTopics返回参数结构体 */ export interface DescribeTopicsResponse { /** * 日志主题列表 */ Topics?: Array<TopicInfo>; /** * 总数目 */ TotalCount?: number; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LogItem的数组 */ export interface LogItems { /** * 分析结果返回的KV数据对 */ Data: Array<LogItem>; } /** * ModifyAlarmNotice请求参数结构体 */ export interface ModifyAlarmNoticeRequest { /** * 通知渠道组ID。 */ AlarmNoticeId: string; /** * 通知渠道组名称。 */ Name?: string; /** * 通知类型。可选值： <li> Trigger - 告警触发 <li> Recovery - 告警恢复 <li> All - 告警触发和告警恢复 */ Type?: string; /** * 通知接收对象。 */ NoticeReceivers?: Array<NoticeReceiver>; /** * 接口回调信息（包括企业微信）。 */ WebCallbacks?: Array<WebCallback>; /** * 通知规则。注意: - Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，2组配置互斥。 - 传其中一组数据，则另一组数据置空。 */ NoticeRules?: Array<NoticeRule>; } /** * Windows事件日志采集配置 */ export interface EventLog { /** * 事件通道，支持Application，Security，Setup，System，ALL */ EventChannel: string; /** * 时间类型，1:用户自定义，2:当前时间 */ TimeType: number; /** * 时间，用户选择自定义时间类型时，需要指定时间 */ Timestamp?: number; /** * 事件ID过滤列表 */ EventIDs?: Array<string>; } /** * CreateAlarm请求参数结构体 */ export interface CreateAlarmRequest { /** * 告警策略名称 */ Name: string; /** * 监控对象列表。 */ AlarmTargets: Array<AlarmTarget>; /** * 监控任务运行时间点。 */ MonitorTime: MonitorTime; /** * 持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为10。 */ TriggerCount: number; /** * 告警重复的周期，单位是分钟。取值范围是0~1440。 */ AlarmPeriod: number; /** * 关联的告警通知模板列表。 */ AlarmNoticeIds: Array<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?: Array<MultiCondition>; /** * 是否开启告警策略。默认值为true */ Status?: boolean; /** * 该参数已废弃，请使用Status参数控制是否开启告警策略。 */ Enable?: boolean; /** * 用户自定义告警内容 */ MessageTemplate?: string; /** * 用户自定义回调 */ CallBack?: CallBackInfo; /** * 多维分析 */ Analysis?: Array<AnalysisDimensional>; /** * 分组触发状态。默认值false */ GroupTriggerStatus?: boolean; /** * 分组触发条件。 */ GroupTriggerCondition?: Array<string>; /** * 标签描述列表，通过指定该参数可以同时绑定标签到相应的告警策略。最大支持10个标签键值对，并且不能有重复的键值对。 */ Tags?: Array<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?: Array<AlarmClassification>; } /** * DeleteExport返回参数结构体 */ export interface DeleteExportResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 多日志主题检索topic信息 */ export interface SearchLogInfos { /** * 日志主题ID */ TopicId?: string; /** * 日志存储生命周期 */ Period?: number; /** * 透传本次接口返回的Context值，可获取后续更多日志，过期时间1小时注意：此字段可能返回 null，表示取不到有效值。 */ Context?: string; } /** * 日志主题分区信息 */ export interface PartitionInfo { /** * 分区ID */ PartitionId: number; /** * 分区的状态（readwrite或者是readonly） */ Status: string; /** * 分区哈希键起始key */ InclusiveBeginKey: string; /** * 分区哈希键结束key */ ExclusiveEndKey: string; /** * 分区创建时间 */ CreateTime: string; /** * 只读分区数据停止写入时间注意：此字段可能返回 null，表示取不到有效值。 */ LastWriteTime: string; } /** * DeleteScheduledSql返回参数结构体 */ export interface DeleteScheduledSqlResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 告警历史详情 */ export 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: Array<AlertHistoryNotice>; /** * 告警持续时间，单位为分钟 */ Duration: number; /** * 告警状态，0代表未恢复，1代表已恢复，2代表已失效 */ Status: number; /** * 告警发生时间，毫秒级Unix时间戳 */ CreateTime: number; /** * 告警分组触发时对应的分组信息注意：此字段可能返回 null，表示取不到有效值。 */ GroupTriggerCondition?: Array<GroupTriggerConditionInfo>; /** * 告警级别，0代表警告(Warn)，1代表提醒(Info)，2代表紧急 (Critical) 注意：此字段可能返回 null，表示取不到有效值。 */ AlarmLevel?: number; /** * 监控对象类型。 0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。注意：此字段可能返回 null，表示取不到有效值。 */ MonitorObjectType?: number; } /** * 黑名单path信息 */ export interface ExcludePathInfo { /** * 类型，选填File或Path */ Type: string; /** * Type对应的具体内容 */ Value: string; } /** * 投递日志的过滤规则 */ export interface FilterRuleInfo { /** * 过滤规则Key */ Key: string; /** * 过滤规则 */ Regex: string; /** * 过滤规则Value */ Value: string; } /** * 特殊采集规则配置信息 */ export interface ConfigExtraInfo { /** * 采集规则扩展配置ID */ ConfigExtraId?: string; /** * 采集规则名称 */ Name?: string; /** * 日志主题ID */ TopicId?: string; /** * 类型：container_stdout、container_file、host_file */ Type?: string; /** * 节点文件配置信息注意：此字段可能返回 null，表示取不到有效值。 */ HostFile?: HostFileInfo; /** * 容器文件路径信息注意：此字段可能返回 null，表示取不到有效值。 */ ContainerFile?: ContainerFileInfo; /** * 容器标准输出信息注意：此字段可能返回 null，表示取不到有效值。 */ ContainerStdout?: ContainerStdoutInfo; /** * 日志格式化方式注意：此字段可能返回 null，表示取不到有效值。 */ LogFormat?: string; /** * 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志，multiline_log代表多行日志，fullregex_log代表完整正则，默认为minimalist_log 注意：此字段可能返回 null，表示取不到有效值。 */ LogType?: string; /** * 提取规则，如果设置了ExtractRule，则必须设置LogType 注意：此字段可能返回 null，表示取不到有效值。 */ ExtractRule?: ExtractRuleInfo; /** * 采集黑名单路径列表注意：此字段可能返回 null，表示取不到有效值。 */ ExcludePaths?: Array<ExcludePathInfo>; /** * 更新时间 */ UpdateTime?: string; /** * 创建时间 */ CreateTime?: string; /** * 用户自定义解析字符串注意：此字段可能返回 null，表示取不到有效值。 */ UserDefineRule?: string; /** * 机器组ID */ GroupId?: string; /** * 自建采集配置标注意：此字段可能返回 null，表示取不到有效值。 */ ConfigFlag?: string; /** * 日志集ID 注意：此字段可能返回 null，表示取不到有效值。 */ LogsetId?: string; /** * 日志集name 注意：此字段可能返回 null，表示取不到有效值。 */ LogsetName?: string; /** * 日志主题name 注意：此字段可能返回 null，表示取不到有效值。 */ TopicName?: string; /** * 高级采集配置。 Json字符串， Key/Value定义为如下： - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 - ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 - ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false 样例：{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true} 注意：此字段可能返回 null，表示取不到有效值。 */ AdvancedConfig?: string; } /** * CreateMachineGroup返回参数结构体 */ export interface CreateMachineGroupResponse { /** * 机器组ID */ GroupId?: string; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SplitPartition请求参数结构体 */ export interface SplitPartitionRequest { /** * 日志主题ID */ TopicId: string; /** * 待分裂分区ID */ PartitionId: number; /** * 分区切分的哈希key的位置，只在Number=2时有意义 */ SplitKey?: string; /** * 分区分裂个数(可选)，默认等于2 */ Number?: number; } /** * DescribeMachineGroupConfigs返回参数结构体 */ export interface DescribeMachineGroupConfigsResponse { /** * 采集规则配置列表注意：此字段可能返回 null，表示取不到有效值。 */ Configs?: Array<ConfigInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CheckRechargeKafkaServer请求参数结构体 */ export interface CheckRechargeKafkaServerRequest { /** * 导入Kafka类型，0: 腾讯云CKafka，1: 用户自建Kafka */ KafkaType: number; /** * 腾讯云CKafka实例ID，KafkaType为0时必填 */ KafkaInstance?: string; /** * 服务地址 */ ServerAddr?: string; /** * ServerAddr是否为加密连接 */ IsEncryptionAddr?: boolean; /** * 加密访问协议，IsEncryptionAddr参数为true时必填 */ Protocol?: KafkaProtocolInfo; } /** * 机器组信息 */ export interface MachineGroupInfo { /** * 机器组ID */ GroupId: string; /** * 机器组名称 */ GroupName: string; /** * 机器组类型 */ MachineGroupType: MachineGroupTypeInfo; /** * 创建时间 */ CreateTime: string; /** * 机器组绑定的标签列表注意：此字段可能返回 null，表示取不到有效值。 */ Tags: Array<Tag>; /** * 是否开启机器组自动更新注意：此字段可能返回 null，表示取不到有效值。 */ AutoUpdate: string; /** * 升级开始时间，建议业务低峰期升级LogListener 注意：此字段可能返回 null，表示取不到有效值。 */ UpdateStartTime: string; /** * 升级结束时间，建议业务低峰期升级LogListener 注意：此字段可能返回 null，表示取不到有效值。 */ UpdateEndTime: string; /** * 是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费注意：此字段可能返回 null，表示取不到有效值。 */ ServiceLogging: boolean; /** * 机器组元数据信息列表 */ MetaTags?: Array<MetaTagInfo>; /** * 操作系统类型，0: Linux，1: windows */ OSType?: number; } /** * DescribeLogHistogram返回参数结构体 */ export interface DescribeLogHistogramResponse { /** * 统计周期：单位ms */ Interval?: number; /** * 命中关键字的日志总条数 */ TotalCount?: number; /** * 周期内统计结果详情 */ HistogramInfos?: Array<HistogramInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CloseKafkaConsumer返回参数结构体 */ export interface CloseKafkaConsumerResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMachineGroups请求参数结构体 */ export interface DescribeMachineGroupsRequest { /** * machineGroupName - 按照【机器组名称】进行过滤。 - 类型：String - 必选：否 machineGroupId - 按照【机器组ID】进行过滤。 - 类型：String - 必选：否 osType - 按照【操作系统类型】进行过滤。 - 类型：Int - 必选：否 tagKey - 按照【标签键】进行过滤。 - 类型：String - 必选：否 tag:tagKey - 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。 - 类型：String - 必选：否每次请求的Filters的上限为10，Filter.Values的上限为5。 */ Filters?: Array<Filter>; /** * 分页的偏移量，默认值为0 */ Offset?: number; /** * 分页单页的限制数目，默认值为20，最大值100 */ Limit?: number; } /** * DescribeConsumer请求参数结构体 */ export interface DescribeConsumerRequest { /** * 投递任务绑定的日志主题 ID */ TopicId: string; } /** * CreateIndex请求参数结构体 */ export interface CreateIndexRequest { /** * 日志主题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; } /** * DescribeLogsets返回参数结构体 */ export interface DescribeLogsetsResponse { /** * 分页的总数目 */ TotalCount?: number; /** * 日志集列表 */ Logsets?: Array<LogsetInfo>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteConsumer返回参数结构体 */ export interface DeleteConsumerResponse { /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTopics请求参数结构体 */ export interface DescribeTopicsRequest { /** * <li> topicName按照【日志主题名称】进行过滤，默认为模糊匹配，可使用PreciseSearch参数设置为精确匹配。类型：String必选：否 <li> logsetName按照【日志集名称】进行过滤，默认为模糊匹配，可使用PreciseSearch参数设置为精确匹配。类型：String必选：否 <li> topicId按照【日志主题ID】进行过滤。类型：String必选：否 <li> logsetId按照【日志集ID】进行过滤，可通过调用DescribeLogsets查询已创建的日志集列表或登录控制台进行查看；也可以调用CreateLogset创建新的日志集。类型：String必选：否 <li> tagKey按照【标签键】进行过滤。类型：String必选：否 <li> tag:tagKey按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，例如tag:exampleKey。类型：String必选：否 <li> storageType按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String必选：否每次请求的Filters的上限为10，Filter.Values的上限为100。 */ Filters?: Array<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; } /** * GetAlarmLog返回参数结构体 */ export interface GetAlarmLogResponse { /** * 加载后续详情的Context */ Context?: string; /** * 指定时间范围内的告警执行详情是否完整返回 */ ListOver?: boolean; /** * 返回的结果是否为SQL分析结果 */ Analysis?: boolean; /** * 如果Analysis为True，则返回分析结果的列名，否则为空注意：此字段可能返回 null，表示取不到有效值。 */ ColNames?: Array<string>; /** * 执行详情查询结果；当Analysis为True时，可能返回为null 注意：此字段可能返回 null，表示取不到有效值。 */ Results?: Array<LogInfo>; /** * 执行详情统计分析结果；当Analysis为False时，可能返回为null 注意：此字段可能返回 null，表示取不到有效值。 */ AnalysisResults?: Array<LogItems>; /** * 执行详情统计分析结果; UseNewAnalysis为true有效注意：此字段可能返回 null，表示取不到有效值。 */ AnalysisRecords?: Array<string>; /** * 分析结果的列名， UseNewAnalysis为true有效注意：此字段可能返回 null，表示取不到有效值。 */ Columns?: Array<Column>; /** * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateTopic请求参数结构体 */ export interface CreateTopicRequest { /** * 日志集ID */ LogsetId: string; /** * 日志主题名称 */ TopicName: string; /** * 日志主题分区个数。默认创建1个，最大支持创建10个分区。 */ PartitionCount?: number; /** * 标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。 */ Tags?: Array<Tag>; /** * 是否开启自动分裂，默认值为true */ AutoSplit?: boolean; /** * 开启自动分裂后，每个主题能够允许的最大分区数，默认值为50 */ MaxSplitPartitions?: number; /** * 日志主题的存储类型，可选值 hot（标准存储），cold（低频存储）；默认为hot。 */ StorageType?: string; /** * 生命周期，单位天，标准存储取值范围1\~3600，低频存储取值范围7\~3600天。取值为3640时代表永久保存 */ Period?: number; /** * 日志主题描述