tencentcloud-sdk-nodejs
Version:
2,367 lines (2,344 loc) • 490 kB
TypeScript
/**
* 告警策略描述
*/
export interface AlarmInfo {
/**
* 告警策略名称。
*/
Name?: string;
/**
* 监控对象列表。
*/
AlarmTargets?: Array<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?: Array<string>;
/**
* 开启状态。
*/
Status?: boolean;
/**
* 告警策略ID。
*/
AlarmId?: string;
/**
* 创建时间。格式： YYYY-MM-DD HH:MM:SS
*/
CreateTime?: string;
/**
* 最近更新时间。格式： YYYY-MM-DD HH:MM:SS
*/
UpdateTime?: string;
/**
* 自定义通知模板
注意：此字段可能返回 null，表示取不到有效值。
*/
MessageTemplate?: string;
/**
* 自定义回调模板
*/
CallBack?: CallBackInfo;
/**
* 多维分析设置
*/
Analysis?: Array<AnalysisDimensional>;
/**
* 分组触发状态。true：开启，false：关闭（默认）
*/
GroupTriggerStatus?: boolean;
/**
* 分组触发条件。
*/
GroupTriggerCondition?: Array<string>;
/**
* 告警策略绑定的标签信息。
*/
Tags?: Array<Tag>;
/**
* 监控对象类型。0:执行语句共用监控对象;1:每个执行语句单独选择监控对象。
*/
MonitorObjectType?: number;
/**
* 告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)。
*/
AlarmLevel?: number;
/**
* 告警附加分类字段。
*/
Classifications?: Array<AlarmClassification>;
/**
* 多触发条件。与
Condition互斥。
*/
MultiConditions?: Array<MultiCondition>;
/**
* 腾讯云可观测平台通知渠道相关信息，和AlarmNoticeIds互斥
*/
MonitorNotice?: MonitorNotice;
}
/**
* DescribeLogHistogram请求参数结构体
*/
export 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语法。
详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a>
*/
SyntaxRule?: number;
}
/**
* 投递类任务数据过滤统计信息
*/
export interface FilterStatistics {
/**
* <p>原始日志数</p>
*/
OriginalCount?: number;
/**
* <p>过滤后日志数</p>
*/
FilteredCount?: number;
/**
* <p>过滤后结果</p>
*/
FilteredResult?: Array<string>;
}
/**
* DescribeNetworkApplicationDetail请求参数结构体
*/
export interface DescribeNetworkApplicationDetailRequest {
/**
* <p>网络应用id</p>
*/
NetworkAppId: string;
}
/**
* 自定义 KMS 密钥
*/
export interface CustomKmsInfo {
/**
* <p>KMS支持的地域，详见 腾讯云-密钥管理系统 官方文档</p><p>参数格式：ap-guangzhou</p>
*/
KmsRegion: string;
/**
* <p>KMS秘钥ID</p>
*/
KmsKeyId: string;
}
/**
* DeleteShipper请求参数结构体
*/
export interface DeleteShipperRequest {
/**
* 投递规则Id。
- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。
*/
ShipperId: string;
}
/**
* DeleteConsole返回参数结构体
*/
export interface DeleteConsoleResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 键值索引自动配置，启用后自动将日志内的字段添加到键值索引中，包括日志中后续新增的字段。
*/
export interface DynamicIndex {
/**
* 键值索引自动配置开关
*/
Status?: boolean;
}
/**
* CreateRebuildIndexTask返回参数结构体
*/
export interface CreateRebuildIndexTaskResponse {
/**
* 索引重建任务ID
*/
TaskId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateSearchView请求参数结构体
*/
export interface CreateSearchViewRequest {
/**
* <p>日志集id</p><p>查询视图所属的日志集，仅用于管理查询视图，查询视图中包含的主题可与该日志集无关</p>
*/
LogsetId: string;
/**
* <p>日志集所属地域</p><p>参数格式：ap-guangzhou</p>
*/
LogsetRegion: string;
/**
* <p>视图名称</p><p>入参限制：最大支持255字符，不能包含"|"字符。</p>
*/
ViewName: string;
/**
* <p>视图类型</p><p>枚举值：</p><ul><li>log： 日志主题</li><li>metric： 指标主题</li></ul><p>Topics字段中配置的主题类型应该与ViewType类型匹配</p>
*/
ViewType: string;
/**
* <p>查询视图中包含的主题，最大可包含10个主题</p><p>Topics字段中配置的主题信息应该与ViewType类型匹配</p>
*/
Topics: Array<ViewSearchTopic>;
/**
* <p>自定义查询视图id前缀</p><p>参数格式：<code>^[a-z0-9][a-z0-9_-]{1,61}[a-z0-9]$</code></p><p>创建成功的查询视图 ViewId 格式为 ${ViewIdPrefix}-view</p>
*/
ViewIdPrefix?: string;
/**
* <p>描述信息</p>
*/
Description?: string;
}
/**
* DescribeAgentConfigs返回参数结构体
*/
export interface DescribeAgentConfigsResponse {
/**
* 采集配置
注意：此字段可能返回 null，表示取不到有效值。
*/
LogConfigs: Array<LogConfigInfo>;
/**
* 服务日志的配置信息
注意：此字段可能返回 null，表示取不到有效值。
*/
ServiceLogConfigs: Array<ServiceLogConfigInfo>;
/**
* 弃用
注意：此字段可能返回 null，表示取不到有效值。
*/
LastVersion: string;
/**
* 弃用
注意：此字段可能返回 null，表示取不到有效值。
*/
NeedUpdate: boolean;
/**
* 弃用
注意：此字段可能返回 null，表示取不到有效值。
*/
URL: string;
/**
* 弃用
注意：此字段可能返回 null，表示取不到有效值。
*/
FileMd5: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CheckFunction请求参数结构体
*/
export interface CheckFunctionRequest {
/**
* 加工语句。 当FuncType为2时，EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
其他参考文档：
- [创建加工任务](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?: Array<DataTransformResouceInfo>;
/**
* 数据加工目标主题的类型. 1 固定主题 2动态创建
*/
FuncType?: number;
}
/**
* ModifyNetworkApplication返回参数结构体
*/
export interface ModifyNetworkApplicationResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* Splunk投递任务-目标配置网络信息相关
*/
export 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;
}
/**
* CreateLogset请求参数结构体
*/
export interface CreateLogsetRequest {
/**
* 日志集名字。
- 最大支持255个字符。不支持`|`字符。
*/
LogsetName: string;
/**
* 标签描述列表。最大支持10个标签键值对，并且不能有重复的键值对
*/
Tags?: Array<Tag>;
/**
* 日志集ID，格式为：用户自定义部分-用户APPID。未填写该参数时将自动生成ID。
- 用户自定义部分仅支持小写字母、数字和-，且不能以-开头和结尾，长度为3至40字符。
- 尾部需要使用-拼接用户APPID，APPID可在https://console.cloud.tencent.com/developer页面查询。
- 如果指定该字段，需保证全地域唯一
*/
LogsetId?: string;
}
/**
* CreateScheduledSql返回参数结构体
*/
export interface CreateScheduledSqlResponse {
/**
* <p>任务id</p>
*/
TaskId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConsoleSharing请求参数结构体
*/
export interface CreateConsoleSharingRequest {
/**
* 免密分享配置
*/
SharingConfig: ConsoleSharingConfig;
}
/**
* 预聚合Yaml任务详情
*/
export interface RecordingRuleYamlTaskInfo {
/**
* yaml配置文件id
*/
YamlId?: string;
/**
* 源日志主题id
*/
TopicId?: string;
/**
* 写入描述的日志主题id
*/
DstTopicId?: string;
/**
* 任务创建时间
*/
CreateTime?: string;
/**
* 任务更新时间
*/
UpdateTime?: string;
/**
* 任务状态，1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题
5: 访问权限问题 6:内部故障 7:其他故障
*/
Status?: number;
/**
* 任务启用状态，1开启, 2关闭
*/
EnableFlag?: number;
/**
* 调度开始时间
*/
ProcessStartTime?: number;
/**
* 调度周期(分钟)
*/
ProcessPeriod?: number;
/**
* 执行延迟(秒)
*/
ProcessDelay?: number;
/**
* 是否开启投递服务日志。1：关闭，2：开启。
*/
HasServicesLog?: number;
/**
* yaml配置文件名称
*/
YamlConfigName?: string;
/**
* yaml配置文件内容
*/
YamlContent?: string;
/**
* yaml文件子任务数量
*/
SubTaskCount?: number;
}
/**
* SearchLog返回参数结构体
*/
export interface SearchLogResponse {
/**
* <p>透传本次接口返回的Context值，可获取后续更多日志，过期时间1小时。<br>注意：</p><ul><li>仅适用于单日志主题检索，检索多个日志主题时，请使用Topics中的Context</li></ul>
*/
Context?: string;
/**
* <p>符合检索条件的日志是否已全部返回，如未全部返回可使用Context参数获取后续更多日志<br>注意：仅当检索分析语句(Query)不包含SQL时有效</p>
*/
ListOver?: boolean;
/**
* <p>返回的是否为统计分析（即SQL）结果</p>
*/
Analysis?: boolean;
/**
* <p>匹配检索条件的原始日志</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Results?: Array<LogInfo>;
/**
* <p>日志统计分析结果的列名<br>当UseNewAnalysis为false时生效</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
ColNames?: Array<string>;
/**
* <p>日志统计分析结果<br>当UseNewAnalysis为false时生效</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
AnalysisResults?: Array<LogItems>;
/**
* <p>日志统计分析结果<br>当UseNewAnalysis为true时生效</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
AnalysisRecords?: Array<string>;
/**
* <p>日志统计分析结果的列属性<br>当UseNewAnalysis为true时生效</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Columns?: Array<Column>;
/**
* <p>本次统计分析使用的采样率</p>
*/
SamplingRate?: number;
/**
* <p>使用多日志主题检索时，各个日志主题的基本信息，例如报错信息。</p>
注意：此字段可能返回 null，表示取不到有效值。
*/
Topics?: SearchLogTopics;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteMetricSubscribe返回参数结构体
*/
export interface DeleteMetricSubscribeResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePartitions请求参数结构体
*/
export interface DescribePartitionsRequest {
/**
* 日志主题Id
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
TopicId: string;
}
/**
* CheckFunction返回参数结构体
*/
export interface CheckFunctionResponse {
/**
* 失败错误码
*/
ErrorCode?: number;
/**
* 失败错误信息
*/
ErrorMsg?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAlarm返回参数结构体
*/
export interface ModifyAlarmResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PreviewKafkaRecharge请求参数结构体
*/
export 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;
}
/**
* 采集配置信息
*/
export interface CollectInfo {
/**
* 采集类型，必填字段。
<li>0：元数据配置。</li>
<li>1：指定Pod Label。</li>
*/
Type: number;
/**
* 指定采集类型的采集配置信息。
<li>当Type为0时，CollectConfigs不允许为空。</li>
<li>当Type为1时，CollectConfigs为空时，表示选择所有Pod Label；否则CollectConfigs为指定Pod Label。</li>
*/
CollectConfigs?: Array<CollectConfig>;
}
/**
* 仪表盘 topic与地域信息
*/
export 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;
}
/**
* CreateConfigExtra返回参数结构体
*/
export interface CreateConfigExtraResponse {
/**
* 采集配置扩展信息ID
*/
ConfigExtraId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterBaseMetricConfigs请求参数结构体
*/
export interface DescribeClusterBaseMetricConfigsRequest {
/**
* 机器组id
*/
GroupId: string;
/**
* <li> topicId按照【指标主题id】进行过滤。类型：String 必选：否</li>
<li> 每次请求的Filters的上限为10，所有Filter.Values总和上限为100。</li>
*/
Filters?: Array<Filter>;
/**
* 分页的偏移量，默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目，默认值为20，最大值100。
*/
Limit?: number;
}
/**
* DescribeConfigExtras返回参数结构体
*/
export interface DescribeConfigExtrasResponse {
/**
* 采集配置列表
注意：此字段可能返回 null，表示取不到有效值。
*/
Configs?: Array<ConfigExtraInfo>;
/**
* 过滤到的总数目
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteMetricSubscribe请求参数结构体
*/
export interface DeleteMetricSubscribeRequest {
/**
* 指标采集任务id
*/
TaskId: string;
/**
* 指标采集任务配置的日志主题id。
*/
TopicId: string;
}
/**
* 投递Ckafka 高级配置
*/
export interface AdvancedConsumerConfiguration {
/**
* Ckafka分区hash状态。 默认 false
- true：开启根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区
- false：关闭根据字段 Hash 值结果相等的信息投递到统一 ckafka 分区
*/
PartitionHashStatus?: boolean;
/**
* 需要计算 hash 的字段列表。最大支持5个字段。
*/
PartitionFields?: Array<string>;
}
/**
* ScheduledSql的资源信息
*/
export interface ScheduledSqlResouceInfo {
/**
* 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
*/
TopicId: string;
/**
* 主题的地域信息，当前不支持跨地域，支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
*/
Region?: string;
/**
* 主题类型：0为日志主题，1为指标主题
*/
BizType?: number;
/**
* 指标名称。当BizType为1时，MetricName需要填写
*/
MetricName?: string;
/**
* 指标名称
BizType为1时，优先使用MetricNames字段多指标只能填充到MetricNames字段，单指标建议填充到MetricName字段
*/
MetricNames?: Array<string>;
/**
* 指标维度，不接受时间类型。
*/
MetricLabels?: Array<string>;
/**
* 指标时间戳，默认值为SQL查询时间范围的左侧时间点，您也可以指定其他字段（类型为uinx时间、TimeStamp，精度毫秒）为指标时间戳。
*/
CustomTime?: string;
/**
* 除了MetricLabels，您还可以使用该参数，为指标补充静态的维度。
维度名以字母或下划线开头，后面可以跟字母、数字或下划线，长度小于等于1024 字节
*/
CustomMetricLabels?: Array<MetricLabel>;
}
/**
* 免鉴权条件信息
*/
export interface ConditionInfo {
/**
* 条件属性，目前只支持VpcID
*/
Attributes?: string;
/**
* 条件规则，1:等于，2:不等于
*/
Rule?: number;
/**
* 对应条件属性的值
*/
ConditionValue?: string;
}
/**
* es集群配置信息
*/
export 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;
}
/**
* DeleteMachineGroup返回参数结构体
*/
export interface DeleteMachineGroupResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 创建资源实例时同时绑定的标签对说明
*/
export interface Tag {
/**
* 标签键
*/
Key: string;
/**
* 标签值
*/
Value: string;
}
/**
* ScheduledSql任务详情
*/
export interface ScheduledSqlTaskInfo {
/**
* <p>ScheduledSql任务id</p>
*/
TaskId?: string;
/**
* <p>ScheduledSql任务名称</p>
*/
Name?: string;
/**
* <p>源日志主题id</p>
*/
SrcTopicId?: string;
/**
* <p>源日志主题名称</p>
*/
SrcTopicName?: string;
/**
* <p>定时SQL分析目标主题</p>
*/
DstResource?: ScheduledSqlResouceInfo;
/**
* <p>任务创建时间。格式：yyyy-MM-dd HH:mm:ss</p>
*/
CreateTime?: string;
/**
* <p>任务更新时间，格式：yyyy-MM-dd HH:mm:ss</p>
*/
UpdateTime?: string;
/**
* <p>任务状态，1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题</p><p>5: 访问权限问题 6:内部故障 7:其他故障</p>
*/
Status?: number;
/**
* <p>任务启用状态，1开启, 2关闭</p>
*/
EnableFlag?: number;
/**
* <p>查询语句</p>
*/
ScheduledSqlContent?: string;
/**
* <p>调度开始时间，格式：yyyy-MM-dd HH:mm:ss</p>
*/
ProcessStartTime?: string;
/**
* <p>调度类型，1:持续运行 2:指定时间范围</p>
*/
ProcessType?: number;
/**
* <p>调度结束时间，格式：yyyy-MM-dd HH:mm:ss，当process_type=2时为必传字段</p>
*/
ProcessEndTime?: string;
/**
* <p>调度周期(分钟)，1~1440分钟</p>
*/
ProcessPeriod?: number;
/**
* <p>查询的时间窗口. @m-15m, @m，意为近15分钟</p>
*/
ProcessTimeWindow?: string;
/**
* <p>执行延迟(秒)，0~120秒，默认60秒</p>
*/
ProcessDelay?: number;
/**
* <p>源topicId的地域信息，支持地域见 <a href="https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8">地域列表</a> 文档。</p>
*/
SrcTopicRegion?: string;
/**
* <p>语法规则，0：Lucene语法，1：CQL语法</p>
*/
SyntaxRule?: number;
/**
* <p>是否开启投递服务日志。1：关闭，2：开启。</p>
*/
HasServicesLog?: number;
/**
* <p>全文检索标记。1：关闭，2：打开。</p>
*/
FullQuery?: number;
/**
* <p>调度周期时间单位</p><p>取值范围：[1, 2]</p><p>默认值：1</p><p>默认值1（分钟），其他值2（秒）</p>
*/
ProcessPeriodUnit?: number;
}
/**
* CreateDlcDeliver返回参数结构体
*/
export interface CreateDlcDeliverResponse {
/**
* <p>配置id</p>
*/
TaskId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateConsumerGroup请求参数结构体
*/
export interface CreateConsumerGroupRequest {
/**
* 创建的消费者组标识
限制： 字母数字下划线，不允许数字开头，长度限制256
*/
ConsumerGroup: string;
/**
* 消费者心跳超时时间（秒）
*/
Timeout: number;
/**
* 创建的消费者组包含的日志主题列表
*/
Topics: Array<string>;
/**
* 日志集Id（日志主题所属的日志集）
*/
LogsetId: string;
}
/**
* agent 应用主题信息
*/
export interface AgentTopicInfo {
/**
* <p>日志主题id</p>
*/
TopicId?: string;
/**
* <p>主题对应的标识</p><p>Langfuse类型对应一个trace标识的日志主题</p>
*/
Flag?: string;
}
/**
* 标签结构体
*/
export 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不能重复
注意：此字段可能返回 null，表示取不到有效值。
*/
Key: string;
/**
* 标签键值直接的比较关系。 不同业务场景支持的比较符不同，具体支持那些参考接口业务描述。
例如：`in`、`notin`
注意：此字段可能返回 null，表示取不到有效值。
*/
Operate: string;
/**
* 标签的值.
- 最大支持63个字符。
- 格式：`([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]`
注意：此字段可能返回 null，表示取不到有效值。
*/
Values?: Array<string>;
}
/**
* ModifyMachineGroup返回参数结构体
*/
export interface ModifyMachineGroupResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 索引规则，FullText、KeyValue、Tag参数必须输入一个有效参数
*/
export interface RuleInfo {
/**
* 全文索引配置, 为空时代表未开启全文索引
注意：此字段可能返回 null，表示取不到有效值。
*/
FullText?: FullTextInfo;
/**
* 键值索引配置，为空时代表未开启键值索引
注意：此字段可能返回 null，表示取不到有效值。
*/
KeyValue?: RuleKeyValueInfo;
/**
* 元字段索引配置，为空时代表未开启元字段索引
注意：此字段可能返回 null，表示取不到有效值。
*/
Tag?: RuleTagInfo;
/**
* 键值索引自动配置，为空时代表未开启该功能。
启用后自动将日志内的字段添加到键值索引中，包括日志中后续新增的字段。
注意：此字段可能返回 null，表示取不到有效值。
*/
DynamicIndex?: DynamicIndex;
}
/**
* DescribeConsumerPreview请求参数结构体
*/
export type DescribeConsumerPreviewRequest = null;
/**
* CreateRecordingRuleTask返回参数结构体
*/
export interface CreateRecordingRuleTaskResponse {
/**
* <p>任务id</p>
*/
TaskId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDashboard返回参数结构体
*/
export interface DeleteDashboardResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenClsService请求参数结构体
*/
export type OpenClsServiceRequest = null;
/**
* LogItem的数组
*/
export interface LogItems {
/**
* 分析结果返回的KV数据对
*/
Data: Array<LogItem>;
}
/**
* DescribeRecordingRuleYamlTask返回参数结构体
*/
export interface DescribeRecordingRuleYamlTaskResponse {
/**
* <p>RecordingRule任务列表信息</p>
*/
RecordingRuleYamlTaskInfos?: Array<RecordingRuleYamlTaskInfo>;
/**
* <p>任务总条数</p>
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 键值索引配置
*/
export interface RuleKeyValueInfo {
/**
* 是否大小写敏感
*/
CaseSensitive: boolean;
/**
* 需要建立索引的键值对信息
*/
KeyValues?: Array<KeyValueInfo>;
}
/**
* DeleteExport返回参数结构体
*/
export interface DeleteExportResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeDashboardSubscribes请求参数结构体
*/
export 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?: Array<Filter>;
/**
* 分页的偏移量，默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目，默认值为20，最大值100。
*/
Limit?: number;
}
/**
* 日志主题分区信息
*/
export 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
注意：此字段可能返回 null，表示取不到有效值。
*/
LastWriteTime?: string;
}
/**
* CreateNoticeContent返回参数结构体
*/
export interface CreateNoticeContentResponse {
/**
* 通知内容配置ID
*/
NoticeContentId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* OpenClsService返回参数结构体
*/
export interface OpenClsServiceResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAlarm请求参数结构体
*/
export interface ModifyAlarmRequest {
/**
* <p>告警策略ID。-通过<a href="https://cloud.tencent.com/document/product/614/56461">获取告警策略列表</a>获取告警策略ID</p>
*/
AlarmId: string;
/**
* <p>告警策略名称。最大支持255个字节，不支持 '|'。</p>
*/
Name?: string;
/**
* <p>监控任务运行时间点。</p>
*/
MonitorTime?: MonitorTime;
/**
* <p>告警信息发送的触发条件。</p><p>注意: </p><ul><li>Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。</li></ul>
*/
Condition?: string;
/**
* <p>告警级别。</p><p>0:警告(Warn);1:提醒(Info);2:紧急 (Critical)</p><p>注意: </p><ul><li>Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。</li></ul>
*/
AlarmLevel?: number;
/**
* <p>多触发条件。 </p><p>注意: </p><ul><li>Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。</li></ul>
*/
MultiConditions?: Array<MultiCondition>;
/**
* <p>持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为2000。</p>
*/
TriggerCount?: number;
/**
* <p>告警重复的周期。单位是分钟。取值范围是0~1440。</p>
*/
AlarmPeriod?: number;
/**
* <p>监控对象列表。</p>
*/
AlarmTargets?: Array<AlarmTarget>;
/**
* <p>是否开启告警策略。</p>
*/
Status?: boolean;
/**
* <p>该参数已废弃，请使用Status参数控制是否开启告警策略。</p>
* @deprecated
*/
Enable?: boolean;
/**
* <p>用户自定义告警内容</p>
*/
MessageTemplate?: string;
/**
* <p>用户自定义回调</p>
*/
CallBack?: CallBackInfo;
/**
* <p>多维分析</p>
*/
Analysis?: Array<AnalysisDimensional>;
/**
* <p>分组触发状态。true：开启，false：关闭（默认）</p>
*/
GroupTriggerStatus?: boolean;
/**
* <p>分组触发条件。</p>
*/
GroupTriggerCondition?: Array<string>;
/**
* <p>标签描述列表，通过指定该参数可以同时绑定标签到相应的告警策略。最大支持10个标签键值对，并且不能有重复的键值对。</p>
*/
Tags?: Array<Tag>;
/**
* <p>监控对象类型。0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。<br>当值为1时，AlarmTargets元素个数不能超过10个，AlarmTargets中的Number必须是从1开始的连续正整数，不能重复。</p>
*/
MonitorObjectType?: number;
/**
* <p>告警附加分类信息列表。<br>Classifications元素个数不能超过20个。<br>Classifications元素的Key不能为空，不能重复，长度不能超过50个字符，符合正则 <code>^[a-z]([a-z0-9_]{0,49})$</code>。<br>Classifications元素的Value长度不能超过200个字符。</p>
*/
Classifications?: Array<AlarmClassification>;
/**
* <p>关联的日志服务告警通知渠道组列表。-通过<a href="https://cloud.tencent.com/document/product/614/56462">获取通知渠道组列表</a>获取关联的告警通知渠道组列表，和MonitorNotice互斥</p>
*/
AlarmNoticeIds?: Array<string>;
/**
* <p>关联的可观测平台通知模板，与 AlarmNoticeIds 参数互斥，不能同时使用</p>
*/
MonitorNotice?: MonitorNotice;
}
/**
* 特殊采集规则配置信息
*/
export 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;
/**
* 采集黑名单路径列表
注意：此字段可能返回 null，表示取不到有效值。
*/
ExcludePaths?: Array<ExcludePathInfo>;
/**
* 更新时间
- 时间格式：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?: Array<CollectInfo>;
/**
* 高级采集配置。 Json字符串， Key/Value定义为如下：
- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时
- ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数
- ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false
样例：{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
*/
AdvancedConfig?: string;
}
/**
* RetryShipperTask返回参数结构体
*/
export interface RetryShipperTaskResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SplitPartition请求参数结构体
*/
export 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;
}
/**
* CreateAlarmShield请求参数结构体
*/
export 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)。
*/
Rule?: string;
}
/**
* 机器组信息
*/
export interface MachineGroupInfo {
/**
* 机器组ID
*/
GroupId?: string;
/**
* 机器组名称
*/
GroupName?: string;
/**
* 机器组类型
*/
MachineGroupType?: MachineGroupTypeInfo;
/**
* 创建时间
时间格式：yyyy-MM-dd HH:mm:ss
*/
CreateTime?: string;
/**
* 机器组绑定的标签列表
*/
Tags?: Array<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?: Array<MetaTagInfo>;
/**
* 操作系统类型，0: Linux，1: windows
*/
OSType?: number;
}
/**
* DeleteAlarmShield返回参数结构体
*/
export interface DeleteAlarmShieldResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 日志主题扩展信息
*/
export interface TopicExtendInfo {
/**
* 日志主题免鉴权配置信息
注意：此字段可能返回 null，表示取不到有效值。
*/
AnonymousAccess?: AnonymousInfo;
}
/**
* CreateIndex请求参数结构体
*/
export 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;
}
/**
* Es导入信息
*/
export interface EsImportInfo {
/**
* 导入模式。
1. 导入历史数据
2. 导入实时数据
*/
Type: number;
/**
* 开始时间。 单位:秒级时间戳。
*/
StartTime?: number;
/**
* 结束时间。 单位：秒级时间戳。
*/
EndTime?: number;
/**
* 最大延迟时间。单位：s
导入模式为 2: 导入实时数据时必填
*/
MaxDelay?: number;
/**
* 检查间隔。单位：s
导入模式为 2: 导入实时数据时必填
*/
CheckInterval?: number;
}
/**
* CreateTopic请求参数结构体
*/
export interface CreateTopicRequest {
/**
* <p>日志集ID</p><ul><li>通过<a href="https://cloud.tencent.com/document/product/614/58624">获取日志集列表</a>获取日志集Id。</li></ul>
*/
LogsetId: string;
/**
* <p>主题名称<br>名称限制</p><ul><li>不能为空字符串</li><li>不能包含字符'|'</li><li>不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]</li></ul>
*/
TopicName: string;
/**
* <p>主题分区个数。默认创建1个，最大支持创建10个分区。</p>
*/
PartitionCount?: number;
/**
* <p>标签描述列表，通过指定该参数可以同时绑定标签到相应的主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。</p>
*/
Tags?: Array<Tag>;
/**
* <p>是否开启自动分裂，默认值为true</p>
*/
AutoSplit?: boolean;
/**
* <p>开启自动分裂后，每个主题能够允许的最大分区数，默认值为50</p>
*/
MaxSplitPartitions?: number;
/**
* <p>日志主题的存储类型，可选值 hot（标准存储），cold（低频存储）；默认为hot。指标主题不支持该配置。</p>
*/
StorageType?: string;
/**
* <p>存储时间，单位天。</p><ul><li>日志主题：日志接入标准存储时，支持1至3600天，值为3640时代表永久保存。</li><li>日志主题：日志接入低频存储时，支持7至3600天，值为3640时代表永久保存。</li><li>指标主题：支持1至3600天，值为3640时代表永久保存。</li></ul>
*/
Period?: number;
/**
* <p>主题描述</p>
*/
Describes?: string;
/**
* <p>0：日志主题关闭日志沉降。<br>非0：日志主题开启日志沉降后标准存储的天数，HotPeriod需要大于等于7，且小于Period。<br>仅在StorageType为 hot 时生效，指标主题不支持该配置。</p>
*/
HotPeriod?: number;
/**
* <p>加密相关参数。 支持加密地域并且开白用户可以传此参数，其他场景不能传递该参数。<br>0或者不传： 不加密<br>1：kms-cls 云产品密钥加密</p>
*/
Encryption?: number;
/**
* <p>用户自定义 KMS 密钥信息；为空则使用默认密钥（别名 KMS-CLS）</p><p>当参数 Encryption为 1 时有效。</p>
*/
CustomKmsInfo?: CustomKmsInfo;
/**
* <p>主题类型</p><ul><li>0:日志主题，默认值</li><li>1:指标主题</li></ul>
*/
BizType?: number;
/**
* <p>主题自定义ID，格式为：用户自定义部分-用户APPID。未填写该参数时将自动生成ID。</p><ul><li>用户自定义部分仅支持小写字母、数字和-，且不能以-开头和结尾，长度为3至40字符</li><li>尾部需要使用-拼接用户APPID，APPID可在https://console.cloud.tencent.com/developer页面查询。</li><li>如果指定该字段，需保证全地域唯一</li></ul>
*/
TopicId?: string;
/**
* <p>免鉴权开关。 false：关闭； true：开启。默认为false。<br>开启后将支持指定操作匿名访问该日志主题。详情请参见<a href="https://cloud.tencent.com/document/product/614/41035">日志主题</a>。指标主题不支持该配置。</p>
*/
IsWebTracking?: boolean;
/**
* <p>主题扩展信息</p>
*/
Extends?: TopicExtendInfo;
/**
* <p>开启记录公网来源ip和服务端接收时间</p>
*/
IsSourceFrom?: boolean;
/**
* <p>计费模式</p><p>枚举值：</p><ul><li>0： 按使用功能计费</li><li>1： 按原始日志量计费（目前仅面向少部分客户支持）</li></ul><p>默认值：0</p>
*/
BillingMode?: number;
}
/**
* ModifyDataTransform请求参数结构体
*/
export 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#b3c58797-4825-4807-bef4-68106e25024f)
其他参考文档：
- [创建加工任务](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?: Array<DataTransformResouceInfo>;
/**
* 超限之后是否丢弃日志数据
*/
BackupGiveUpData?: boolean;
/**
* 是否开启投递服务日志。1关闭，2开启
*/
HasServicesLog?: number;
/**
* 保留失败日志状态。 1:不保留，2:保留
*/
KeepFailureLog?: number;
/**
* 失败日志的字段名称
*/
FailureLogKey?: string;
/**
* 外部数据源信息
*/
DataTransformSqlDataSources?: Array<DataTransformSqlDataSource>;
/**
* 设置的环境变量
*/
EnvInfos?: Array<EnvInfo>;
}
/**
* CreateDlcDeliver请求参数结构体
*/
export interface CreateDlcDeliverRequest {
/**
* <p>日志主题id。</p><ul><li>通过<a href="https://cloud.tencent.com/document/product/614/56454">获取日志主题列表</a>获取日志主题Id。</li></ul>
*/
TopicId: string;
/**
* <p>名称：长度不超过64字符，以字母开头，接受0-9,a-z,A-Z, _,-,中文字符。</p>
*/
Name: string;
/**
* <p>投递类型。0:批投递,1:实时投递</p>
*/
DeliverType: number;
/**
* <p>投递时间范围的开始时间</p>
*/
StartTime: number;
/**
* <p>dlc配置信息</p>
*/
DlcInfo: DlcInfo;
/**
* <p>投递文件大小,单位MB。 DeliverType=0时必填，范围 5<= MaxSize <= 256。</p>
*/
MaxSize?: number;
/**
* <p>投递间隔，单位秒。 DeliverType=0时必填，范围 300<= Interval <=900。</p>
*/
Interval?: number;
/**
* <p>投递时间范围的结束时间。 如果为空，则表示不限时。EndTime不为空时，需要大于StartTime。</p>
*/
EndTime?: number;
/**
* <p>是否开启投递服务日志。1关闭，2开启。默认开启</p>
*/
HasServicesLog?: number;
/**
* <p>自动创建dlc字段</p><p>默认值：false</p><p>当您的日志中有新增字段时，系统自动将其投递至DLC</p>
*/
AutoCreateField?: boolean;
/**
* <p>将投递失败的日志存储至DLC表</p>
*/
DlcFailHandle?: DlcFailHandle;
/**
* <p>日志预过滤-数据写入 Splunk 的原始数据进行预过滤处理</p>
*/
DSLFilter?: string;
}
/**
* 云产品实例维度信息
*/
export interface Dimension {
/**
* 实例维度名称,此字段可能返回 null，表示取不到有效值。
注意：此字段可能返回 null，表示取不到有效值。
*/
Name?: string;
/**
* 实例维度值,此字段可能返回 null，表示取不到有效值。
注意：此字段可能返回 null，表示取不到有效值。
*/
Value?: string;
}
/**
* ModifyScheduledSql请求参数结构体
*/
export interface ModifyScheduledSqlRequest {
/**
* <p>任务ID，通过<a href="https://cloud.tencent.com/document/product/614/95519">获取定时SQL分析任务列表</a>获取</p>
*/
TaskId: string;
/**
* <p>源日志主题，通过<a href="https://cloud.tencent.com/document/product/614/95519">获取定时SQL分析任务列表</a>获取</p>
*/
SrcTopicId?: string;
/**
* <p>任务启动状态. 1开启, 2关闭</p>
*/
EnableFlag?: number;
/**
* <p>定时SQL分析的目标日志主题</p>
*/
DstResource?: ScheduledSqlResouceInfo;
/**
* <p>查询语句</p>
*/
ScheduledSqlContent?: string;
/**
* <p>调度周期(分钟)，1~1440分钟</p>
*/
ProcessPeriod?: number;
/**
* <p>单次查询的时间窗口. 例子中为近15分钟</p>
*/
ProcessTimeWindow?: string;
/**
* <p>执行延迟(秒)，0~120秒，默认60秒</p>
*/
ProcessDelay?: number;
/**
* <p>源topicId的地域信息,支持地域见 <a href="https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8">地域列表</a> 文档</p>
*/
SrcTopicRegion?: string;
/**
* <p>任务名称，0~255字符</p>
*/
Name?: string;
/**
* <p>语法规则。 默认值为0。 0：Lucene语法，1：CQL语法</p>
*/
SyntaxRule?: number;
/**
* <p>是否开启投递服务日志。1：关闭，2：开启。</p>
*/
HasServicesLog?: number;
/**
* <p>全文检索查询标记。1：关闭，2：打开。</p>
*/
FullQuery?: number;
/**
* <p>调度周期单位</p><p>取值范围：[1, 2]</p><p>默认值：1</p><p>默认值1（分钟），其他值2（秒）</p>
*/
ProcessPeriodUnit?: number;
}
/**
* DeleteConfig返回参数结构体
*/
export interface DeleteConfigResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDeliverCloudFunction请求参数结构体
*/
export 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#scf-.E4.BA.8B.E4.BB.B6.E5.87.BD.E6.95.B0) （[函数类型选型](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;
}
/**
* ModifyDlcDeliver返回参数结构体
*/
export interface ModifyDlcDeliverResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyDashboard返回参数结构体
*/
export interface ModifyDashboardResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeMetricSubscribes返回参数结构体
*/
export interface DescribeMetricSubscribesResponse {
/**
* 总数目
*/
TotalCount?: number;
/**
* 指标订阅配置信息
*/
Datas?: Array<MetricSubscribeInfo>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateWebCallback请求参数结构体
*/
export interface CreateWebCallbackRequest {
/**
* 通知内容名称。最大支持255个字节
*/
Name: string;
/**
* 渠道类型。
WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调。
*/
Type: string;
/**
* Webhook地址。
*/
Webhook: string;
/**
* 请求方式。 支持POST、PUT。
当Type为Http时，必填。
*/
Method?: string;
/**
* 秘钥。最大支持1024个字节
*/
Key?: string;
}
/**
* DescribeClusterMetricConfigs请求参数结构体
*/
export interface DescribeClusterMetricConfigsRequest {
/**
* 机器组id
*/
GroupId: string;
/**
* <li> configId按照【指标采集配置id】进行过滤。类型：String 必选：否</li>
<li> name按照【配置名称】进行过滤。类型：String 必选：否</li>
<li> 每次请求的Filters的上限为10，所有Filter.Values总和上限为100。</li>
*/
Filters?: Array<Filter>;
/**
* 分页的偏移量，默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目，默认值为20，最大值100。
*/
Limit?: number;
}
/**
* DescribeConfigs请求参数结构体
*/
export interface DescribeConfigsRequest {
/**
* configName
- 按照【采集配置名称】进行模糊匹配过滤。
- 类型：String
- 必选：否
- 示例：test-config
configId
- 按照【采集配置ID】进行过滤。
- 类型：String
- 必选：否
- 示例：3581a3be-aa41-423b-995a-54ec84da6264
topicId
- 按照【日志主题】进行过滤。
- 类型：String
- 必选：否
- 示例：3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
每次请求的Filters的上限为10，Filter.Values的上限为5。
*/
Filters?: Array<Filter>;
/**
* 分页的偏移量，默认值为0
*/
Offset?: number;
/**
* 分页单页的限制数目，默认值为20，最大值100
*/
Limit?: number;
}
/**
* 数据湖计算服务（Data Lake Compute，简称DLC）数据分区额外信息
*/
export interface DlcPartitionExtra {
/**
* 时间格式 eg: %Y-%m-%d %H:%M:%S.%f
*/
TimeFormat?: string;
/**
* 时间时区
*/
TimeZone?: string;
}
/**
* DescribeKafkaConsumerTopics返回参数结构体
*/
export interface DescribeKafkaConsumerTopicsResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 仪表盘关联的topic信息
*/
export 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;
}
/**
* QueryMetric请求参数结构体
*/
export 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;
}
/**
* 云产品日志投递任务信息
*/
export interface CloudProductLogTaskInfo {
/**
* <p>日志服务地域</p>
*/
ClsRegion?: string;
/**
* <p>实例ID</p>
*/
InstanceId?: string;
/**
* <p>日志集ID</p>
*/
LogsetId?: string;
/**
* <p>日志主题ID</p>
*/
TopicId?: string;
/**
* <p>日志配置拓展信息， 一般用于存储额外的日志投递配置</p>
*/
Extend?: string;
/**
* <p>日志类型，支持枚举：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</p>
*/
LogType?: string;
/**
* <p>任务状态， 0创建中 1创建完成 2 删除中</p>
*/
Status?: number;
/**
* <p>投递任务关联topic的标签信息</p>
*/
TopicTags?: Array<Tag>;
/**
* <p>投递任务关联logset的标签信息</p>
*/
LogsetTags?: Array<Tag>;
}
/**
* 实例信息
*/
export interface Instance {
/**
* 实例信息
*/
Values: Array<string>;
}
/**
* DescribeAlarmNotices返回参数结构体
*/
export interface DescribeAlarmNoticesResponse {
/**
* 告警通知模板列表。
*/
AlarmNotices?: Array<AlarmNotice>;
/**
* 符合条件的告警通知模板总数。
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteDataTransform请求参数结构体
*/
export interface DeleteDataTransformRequest {
/**
* 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
*/
TaskId: string;
}
/**
* DescribeRemoteWriteTasks返回参数结构体
*/
export interface DescribeRemoteWriteTasksResponse {
/**
* RemoteWrite 信息列表
*/
Infos?: Array<RemoteWriteInfo>;
/**
* RemoteWrite信息总条数
*/
TotalCount?: number;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddMachineGroupInfo请求参数结构体
*/
export interface AddMachineGroupInfoRequest {
/**
* 机器组Id
- 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
*/
GroupId: string;
/**
* 机器组类型
目前type支持 ip 和 label
*/
MachineGroupType: MachineGroupTypeInfo;
}
/**
* DescribeKafkaConsumerGroupList返回参数结构体
*/
export interface DescribeKafkaConsumerGroupListResponse {
/**
* 日志主题名称
*/
TopicName?: string;
/**
* 日志集id
*/
LogsetId?: string;
/**
* 总个数
*/
Total?: number;
/**
* 消费组信息列表
*/
Groups?: Array<ConsumerGroup>;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateHostMetricConfig返回参数结构体
*/
export interface CreateHostMetricConfigResponse {
/**
* 主机指标采集配置id
*/
ConfigId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyConsumerGroup请求参数结构体
*/
export interface ModifyConsumerGroupRequest {
/**
* 更新的目标消费者组标识
*/
ConsumerGroup: string;
/**
* 消费者心跳超时时间（秒）
*/
Timeout: number;
/**
* 更新的消费者组包含的日志主题列表
*/
Topics: Array<string>;
/**
* 日志集Id（日志主题所属的日志集）
*/
LogsetId: string;
}
/**
* CreateTopic返回参数结构体
*/
export interface CreateTopicResponse {
/**
* <p>主题ID</p>
*/
TopicId?: string;
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteAlarm返回参数结构体
*/
export interface DeleteAlarmResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteConsoleSharing返回参数结构体
*/
export interface DeleteConsoleSharingResponse {
/**
* 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeTopicBaseMetricConfigs请求参数结构体
*/
export 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?: Array<Filter>;
/**
* 分页的偏移量，默认值为0。
*/
Offset?: number;
/**
* 分页单页限制数目，默认值为20，最大值100。
*/
Limit?: number;
}
/**
* 预览数据详情
*/
export interface PreviewLogStatistic {
/**
* 日志内容
*/
LogContent: string;
/**
* 行号。从0开始
*/
LineNum: number;
/**
* 目标日志主题ID
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
*/
DstTopicId?: string;
/**
* 失败错误信息， 空字符串""表示正常
*/
FailReason?: