tencentcloud-sdk-nodejs

/** * DescribeAlarmNotices请求参数结构体 */ export interface DescribeAlarmNoticesRequest { /** * <li> name 按照【通知渠道组名称】进行过滤。类型：String 必选：否</li> <li> alarmNoticeId 按照【通知渠道组ID】进行过滤。类型：String 必选：否</li> <li> uid 按照【接收用户ID】进行过滤。类型：String 必选：否</li> <li> groupId 按照【接收用户组ID】进行过滤。类型：String 必选：否</li> <li> deliverFlag 按照【投递状态】进行过滤。类型：String 必选：否可选值： "1":未启用, "2": 已启用, "3":投递异常</li> 每次请求的Filters的上限为10，Filter.Values的上限为5。 */ Filters?: Array<Filter>; /** * 分页的偏移量，默认值为0。 */ Offset?: number; /** * 分页单页限制数目，默认值为20，最大值100。 */ Limit?: number; } /** * CreateAlarm返回参数结构体 */ export interface CreateAlarmResponse { /** * 告警策略ID。 */ AlarmId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 告警策略描述 */ export interface AlarmInfo { /** * 告警策略名称。 */ Name?: string; /** * 监控对象列表。 */ AlarmTargets?: Array<AlarmTargetInfo>; /** * 监控任务运行时间点。 */ MonitorTime?: MonitorTime; /** * 单触发条件。与MultiConditions参数互斥。 */ 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; /** * 自定义回调模板 */ CallBack?: CallBackInfo; /** * 多维分析设置 */ Analysis?: Array<AnalysisDimensional>; /** * 分组触发状态。true：开启，false：关闭（默认） */ GroupTriggerStatus?: boolean; /** * 分组触发条件。 */ GroupTriggerCondition?: Array<string>; /** * 监控对象类型。0:执行语句共用监控对象;1:每个执行语句单独选择监控对象。 */ MonitorObjectType?: number; /** * 告警级别。0:警告(Warn);1:提醒(Info);2:紧急 (Critical)。 */ AlarmLevel?: number; /** * 告警附加分类字段。 */ Classifications?: Array<AlarmClassification>; /** * 多触发条件。与 Condition互斥。 */ 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; /** * 符合检索条件的关键词，一般用于高亮显示。仅支持键值检索，不支持全文检索 */ HighLights?: Array<HighLightItem>; /** * 日志内容的Json序列化字符串 */ LogJson?: string; /** * 日志来源主机名称 */ HostName?: string; /** * 原始日志(仅在日志创建索引异常时有值) */ RawLog?: string; /** * 日志创建索引异常原因(仅在日志创建索引异常时有值) */ IndexStatus?: string; } /** * DeleteAlarmNotice返回参数结构体 */ export interface DeleteAlarmNoticeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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; } /** * DeleteAlarmShield请求参数结构体 */ export interface DeleteAlarmShieldRequest { /** * 屏蔽规则id。 */ TaskId: string; /** * 通知渠道组id。 */ AlarmNoticeId: string; } /** * DescribeLogContext请求参数结构体 */ export interface DescribeLogContextRequest { /** * 要查询的日志主题ID */ TopicId: string; /** * 日志时间, 即SearchLog接口返回信息中Results结构体中的Time，需按照 UTC+8 时区将该毫秒级Unix时间戳转换为 YYYY-mm-dd HH:MM:SS.FFF 格式的字符串。 */ BTime: string; /** * 日志包序号，即SearchLog接口返回信息中Results结构体中的PkgId。 */ PkgId: string; /** * 日志包内一条日志的序号，即SearchLog接口返回信息中Results结构中的PkgLogId。 */ PkgLogId: number; /** * 前${PrevLogs}条日志，默认值10。 */ PrevLogs?: number; /** * 后${NextLogs}条日志，默认值10。 */ NextLogs?: number; /** * 检索语句，对日志上下文进行过滤，最大长度为12KB 语句由 <a href="https://cloud.tencent.com/document/product/614/47044" target="_blank">[检索条件]</a>构成，不支持SQL语句 */ Query?: string; /** * 上下文检索的开始时间，单位：毫秒级时间戳注意： - From为空时，表示上下文检索的开始时间不做限制 - From和To非空时，From < To - 暂时仅支持上海 / 弗吉尼亚/ 新加坡地域 */ From?: number; /** * 上下文检索的结束时间，单位：毫秒级时间戳。注意： - To为空时，表示上下文检索的结束时间不做限制 - From和To非空时，From < To - 暂时仅支持上海 / 弗吉尼亚/ 新加坡地域 */ To?: number; } /** * DeleteShipper请求参数结构体 */ export interface DeleteShipperRequest { /** * 投递规则ID */ ShipperId: string; } /** * DeleteScheduledSql请求参数结构体 */ export interface DeleteScheduledSqlRequest { /** * 任务ID */ TaskId: string; /** * 源日志主题ID */ SrcTopicId: string; } /** * 键值索引自动配置，启用后自动将日志内的字段添加到键值索引中，包括日志中后续新增的字段。 */ export interface DynamicIndex { /** * 键值索引自动配置开关 */ Status?: boolean; } /** * DeleteLogset返回参数结构体 */ export interface DeleteLogsetResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UploadLog返回参数结构体 */ export interface UploadLogResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Parquet内容描述 */ export interface ParquetKeyInfo { /** * 键值名称 */ KeyName: string; /** * 数据类型，目前支持6种类型：string、boolean、int32、int64、float、double */ KeyType: string; /** * 解析失败赋值信息 */ KeyNonExistingField: string; } /** * DescribeCosRecharges返回参数结构体 */ export interface DescribeCosRechargesResponse { /** * 见: CosRechargeInfo 结构描述 */ Data?: Array<CosRechargeInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeShipperTasks返回参数结构体 */ export interface DescribeShipperTasksResponse { /** * 投递任务列表注意：此字段可能返回 null，表示取不到有效值。 */ Tasks?: Array<ShipperTaskInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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>; } /** * DescribeAlarmShields返回参数结构体 */ export interface DescribeAlarmShieldsResponse { /** * 符合条件的规则总数目 */ TotalCount?: number; /** * 告警屏蔽规则详情 */ AlarmShields?: Array<AlarmShieldInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyConfigExtra返回参数结构体 */ export interface ModifyConfigExtraResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SearchCosRechargeInfo请求参数结构体 */ export interface SearchCosRechargeInfoRequest { /** * 日志主题 ID */ TopicId: string; /** * 日志集ID */ LogsetId: string; /** * 投递任务名称 */ Name: string; /** * COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 */ Bucket: string; /** * COS存储桶所在地域，详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。 */ BucketRegion: string; /** * COS文件所在文件夹的前缀。默认为空，投递存储桶下所有的文件。 */ Prefix?: string; /** * 压缩模式: "", "gzip", "lzop", "snappy"; 默认"" */ Compress?: string; } /** * DeleteScheduledSql返回参数结构体 */ export interface DeleteScheduledSqlResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNoticeContents请求参数结构体 */ export interface DescribeNoticeContentsRequest { /** * <li> name 按照【通知内容模板名称】进行过滤。类型：String 必选：否 </li> <li> noticeContentId 按照【通知内容模板ID】进行过滤。类型：String 必选：否 </li> 每次请求的Filters的上限为10，Filter.Values的上限为100。 */ Filters?: Array<Filter>; /** * 分页的偏移量，默认值为0。 */ Offset?: number; /** * 分页单页限制数目，默认值为20，最大值100。 */ Limit?: number; } /** * 控制台分享配置 */ export interface ConsoleSharingConfig { /** * 分享链接名称 */ Name: string; /** * 仪表盘: 1; 检索页:2 */ Type: number; /** * 分享链接有效期，单位：毫秒，最长支持30天 */ DurationMilliseconds: number; /** * 允许访问的资源列表，目前仅支持一个Resource */ Resources: Array<string>; /** * 分享链接域名，可选范围 - 公网匿名分享：填写clsshare.com - datasight内网匿名分享(若开启)：datasight内网域名注意：此字段可能返回 null，表示取不到有效值。 */ Domain?: string; /** * 分享链接加密访问验证码。支持0-9和a-z(不区分大小写)在内的6个字符，可为空，代表免验证码访问注意：此字段可能返回 null，表示取不到有效值。 */ VerifyCode?: string; /** * 默认查询范围的开始时间点，支持绝对时间(13位Unix时间戳)或相对时间表达式 */ StartTime?: string; /** * 默认查询范围的结束时间点，支持绝对时间(13位Unix时间戳)或相对时间表达式。注意，结束时间点要大于开始时间点 */ EndTime?: string; /** * 仅当StartTime/EndTime为相对时间时使用，基于NowTime计算绝对时间，默认为创建时间注意：此字段可能返回 null，表示取不到有效值。 */ NowTime?: number; /** * 默认的检索分析语句，仅当Type为2时使用注意：此字段可能返回 null，表示取不到有效值。 */ Params?: Array<ConsoleSharingParam>; /** * 是否允许访问者自行修改检索分析时间范围。默认不锁定（false） */ IsLockTimeRange?: boolean; /** * 是否允许访问者自行修改日志检索语句。在检索页分享中表示检索语句锁定状态；在仪表盘中表示过滤变量锁定状态。默认不锁定（false） */ IsLockQuery?: boolean; /** * 检索页分享是否允许访问者下载日志，默认不允许（false）注意：此字段可能返回 null，表示取不到有效值。 */ IsSupportLogExport?: boolean; } /** * DeleteConsoleSharing请求参数结构体 */ export interface DeleteConsoleSharingRequest { /** * 免密分享Id */ SharingId: string; } /** * UploadLog请求参数结构体 */ export interface UploadLogRequest { /** * 主题id */ TopicId: string; /** * 该参数已废弃，请勿使用 * @deprecated */ HashKey?: string; /** * 压缩方法 */ CompressType?: string; } /** * DescribeWebCallbacks返回参数结构体 */ export interface DescribeWebCallbacksResponse { /** * 告警渠道回调配置列表。 */ WebCallbacks?: Array<WebCallbackInfo>; /** * 符合条件的通知内容配置总数。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateLogset请求参数结构体 */ export interface CreateLogsetRequest { /** * 日志集名字，不能重名 */ LogsetName: string; /** * 标签描述列表。最大支持10个标签键值对，并且不能有重复的键值对 */ Tags?: Array<Tag>; } /** * DescribeShippers请求参数结构体 */ export interface DescribeShippersRequest { /** * - shipperName：按照【投递规则名称】进行过滤。类型：String。必选：否 - shipperId：按照【投递规则ID】进行过滤。类型：String。必选：否 - topicId：按照【日志主题】进行过滤。类型：String。必选：否 - taskStatus 按照【任务运行状态】进行过滤。支持`0`：停止，`1`：运行中，`2`：异常类型：String 必选：否每次请求的Filters的上限为10，Filter.Values的上限为10。 */ Filters?: Array<Filter>; /** * 分页的偏移量，默认值为0 */ Offset?: number; /** * 分页单页的限制数目，默认值为20，最大值100 */ Limit?: number; /** * 控制Filters相关字段是否为精确匹配。 0: 默认值，shipperName模糊匹配 1: shipperName 精确匹配 */ PreciseSearch?: number; } /** * CreateScheduledSql返回参数结构体 */ export interface CreateScheduledSqlResponse { /** * 任务id */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDashboards请求参数结构体 */ export interface DescribeDashboardsRequest { /** * 分页的偏移量，默认值为0。 */ Offset?: number; /** * 分页单页限制数目，默认值为20，最大值100。 */ Limit?: number; /** * - dashboardId 按照【仪表盘id】进行过滤，类型：String，必选：否。 - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。 - dashboardRegion 按照【仪表盘地域】进行过滤，为了兼容老的仪表盘，通过云API创建的仪表盘没有地域属性，类型：String，必选：否。 - tagKey 按照【标签键】进行过滤，类型：String，必选：否。 - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否，使用请参考[示例2](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B)。每次请求的Filters的上限为10，Filter.Values的上限为100。 */ Filters?: Array<Filter>; /** * 按照topicId和regionId过滤。 */ TopicIdRegionFilter?: Array<TopicIdAndRegion>; } /** * CreateConsoleSharing请求参数结构体 */ export interface CreateConsoleSharingRequest { /** * 免密分享配置 */ SharingConfig: ConsoleSharingConfig; } /** * 日志中的KV对 */ export interface LogItem { /** * 日志Key */ Key?: string; /** * 日志Value */ Value?: string; } /** * DeleteNoticeContent返回参数结构体 */ export interface DeleteNoticeContentResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteTopic请求参数结构体 */ export interface DeleteTopicRequest { /** * 日志主题ID */ TopicId: string; } /** * DescribePartitions请求参数结构体 */ export interface DescribePartitionsRequest { /** * 日志主题ID */ TopicId: string; } /** * 自建k8s-容器标准输出信息 */ export interface ContainerStdoutInfo { /** * 是否所有容器 */ AllContainers: boolean; /** * container为空表所有的，不为空采集指定的容器 */ Container?: string; /** * namespace可以多个，用分隔号分割,例如A,B；为空或者没有这个字段，表示所有namespace */ Namespace?: string; /** * pod标签信息注意：此字段可能返回 null，表示取不到有效值。 */ IncludeLabels?: Array<string>; /** * 工作负载信息注意：此字段可能返回 null，表示取不到有效值。 */ WorkLoads?: Array<ContainerWorkLoadInfo>; /** * 需要排除的namespace可以多个，用分隔号分割,例如A,B */ ExcludeNamespace?: string; /** * 需要排除的pod标签信息注意：此字段可能返回 null，表示取不到有效值。 */ ExcludeLabels?: Array<string>; /** * metadata信息注意：此字段可能返回 null，表示取不到有效值。 */ CustomLabels?: Array<string>; } /** * 采集规则配置信息 */ export 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; /** * 采集黑名单路径列表注意：此字段可能返回 null，表示取不到有效值。 */ ExcludePaths?: Array<ExcludePathInfo>; /** * 采集配置所属日志主题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; } /** * QueryRangeMetric请求参数结构体 */ export interface QueryRangeMetricRequest { /** * 指标主题ID */ TopicId: string; /** * 查询语句，使用PromQL语法 */ Query: string; /** * 查询起始时间，秒级Unix时间戳 */ Start: number; /** * 查询结束时间，秒级Unix时间戳 */ End: number; /** * 查询时间间隔，单位秒 */ Step: number; } /** * ModifyAlarm返回参数结构体 */ export interface ModifyAlarmResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeShipperTasks请求参数结构体 */ export interface DescribeShipperTasksRequest { /** * 投递规则ID */ ShipperId: string; /** * 查询的开始时间戳，支持最近3天的查询，毫秒。 StartTime必须小于EndTime */ StartTime: number; /** * 查询的结束时间戳，毫秒。 StartTime必须小于EndTime */ EndTime: number; } /** * 采集配置信息 */ 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>; } /** * DeleteCloudProductLogCollection请求参数结构体 */ export interface DeleteCloudProductLogCollectionRequest { /** * 实例ID */ InstanceId: string; /** * 云产品标识，支持枚举：CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS */ AssumerName: string; /** * 日志类型，支持枚举：CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS */ LogType: string; /** * 云产品地域。不同日志类型(LogType)地域入參格式存在差异，请参考如下示例： - CDS所有日志类型：ap-guangzhou - CDB-AUDIT: gz - TDSQL-C-AUDIT: gz - MongoDB-AUDIT: gz - MongoDB-SlowLog：ap-guangzhou - MongoDB-ErrorLog：ap-guangzhou - TDMYSQL-SLOW：gz - DCDB所有日志类型：gz - MariaDB所有日志类型：gz - PostgreSQL所有日志类型：gz - BH所有日志类型：overseas-polaris(国内站海外)/fsi-polaris(国内站金融)/general-polaris(国内站普通)/intl-sg-prod(国际站) - APIS所有日志类型：gz */ CloudProductRegion: string; } /** * CreateCloudProductLogCollection请求参数结构体 */ export interface CreateCloudProductLogCollectionRequest { /** * 实例ID */ InstanceId: string; /** * 云产品标识，支持枚举：CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS */ AssumerName: string; /** * 日志类型，支持枚举：CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS */ LogType: string; /** * 云产品地域。不同日志类型(LogType)地域入參格式存在差异，请参考如下示例： - CDS所有日志类型：ap-guangzhou - CDB-AUDIT: gz - TDSQL-C-AUDIT: gz - MongoDB-AUDIT: gz - MongoDB-SlowLog：ap-guangzhou - MongoDB-ErrorLog：ap-guangzhou - TDMYSQL-SLOW：gz - DCDB所有日志类型：gz - MariaDB所有日志类型：gz - PostgreSQL所有日志类型：gz - BH所有日志类型：overseas-polaris(国内站海外)/fsi-polaris(国内站金融)/general-polaris(国内站普通)/intl-sg-prod(国际站) - APIS所有日志类型：gz */ CloudProductRegion: string; /** * CLS目标地域 */ ClsRegion: string; /** * 日志集名称，未填LogsetId时必填。若日志集不存在, 将自动创建 */ LogsetName?: string; /** * 日志主题名称，在未填TopicId时必填。若日志主题不存在，将自动创建 */ TopicName?: string; /** * 日志配置拓展信息，一般用于存储额外的日志投递配置 */ Extend?: string; /** * 日志集id */ LogsetId?: string; /** * 日志主题id */ TopicId?: string; } /** * DescribeShippers返回参数结构体 */ export interface DescribeShippersResponse { /** * 投递规则列表 */ Shippers?: Array<ShipperInfo>; /** * 本次查询获取到的总数 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 仪表盘 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; } /** * 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。 */ RequestId?: string; } /** * CreateConfigExtra返回参数结构体 */ export interface CreateConfigExtraResponse { /** * 采集配置扩展信息ID */ ConfigExtraId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Kafka导入配置信息 */ export 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; } /** * DeleteKafkaRecharge返回参数结构体 */ export interface DeleteKafkaRechargeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自建k8s-工作负载信息 */ export interface ContainerWorkLoadInfo { /** * 工作负载的类型 */ Kind: string; /** * 工作负载的名称 */ Name: string; /** * 容器名 */ Container?: string; /** * 命名空间 */ Namespace?: string; } /** * 云产品日志投递任务信息 */ export 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; } /** * ModifyDataTransform请求参数结构体 */ export interface ModifyDataTransformRequest { /** * 加工任务id */ TaskId: string; /** * 加工任务名称 */ 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>; /** * 是否开启投递服务日志。1关闭，2开启 */ HasServicesLog?: number; } /** * DescribeScheduledSqlInfo返回参数结构体 */ export interface DescribeScheduledSqlInfoResponse { /** * ScheduledSQL任务列表信息 */ ScheduledSqlTaskInfos?: Array<ScheduledSqlTaskInfo>; /** * 任务总次数 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 回调配置 */ export 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?: Array<string>; } /** * OpenKafkaConsumer返回参数结构体 */ export interface OpenKafkaConsumerResponse { /** * KafkaConsumer 消费时使用的Topic参数 */ TopicID?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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; /** * 检索语法规则，默认值为0。 0：Lucene语法，1：CQL语法。详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a> */ SyntaxRule?: number; /** * 主题类型。 0: 日志主题，1: 指标主题 */ BizType?: number; } /** * 键值索引配置 */ export interface RuleKeyValueInfo { /** * 是否大小写敏感 */ CaseSensitive: boolean; /** * 需要建立索引的键值对信息 */ KeyValues?: Array<KeyValueInfo>; } /** * 告警分类信息 */ export interface AlarmClassification { /** * 分类键 */ Key: string; /** * 分类值 */ Value: string; } /** * ScheduledSql的资源信息 */ export interface ScheduledSqlResouceInfo { /** * 目标主题id */ TopicId: string; /** * 主题的地域信息 */ 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 FilePathInfo { /** * 文件路径 */ Path?: string; /** * 文件名称 */ File?: string; } /** * DescribeIndex请求参数结构体 */ export interface DescribeIndexRequest { /** * 日志主题ID */ TopicId: string; } /** * ModifyScheduledSql返回参数结构体 */ export interface ModifyScheduledSqlResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 投递日志的过滤规则 */ export interface FilterRuleInfo { /** * 过滤规则Key */ Key: string; /** * 过滤规则 */ Regex: string; /** * 过滤规则Value */ Value: string; } /** * 免鉴权条件信息 */ export interface ConditionInfo { /** * 条件属性，目前只支持VpcID */ Attributes?: string; /** * 条件规则，1:等于，2:不等于 */ Rule?: number; /** * 对应条件属性的值 */ ConditionValue?: string; } /** * 机器组信息 */ export interface MachineGroupInfo { /** * 机器组ID */ GroupId?: string; /** * 机器组名称 */ GroupName?: string; /** * 机器组类型 */ MachineGroupType?: MachineGroupTypeInfo; /** * 创建时间 */ CreateTime?: string; /** * 机器组绑定的标签列表 */ Tags?: Array<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?: Array<MetaTagInfo>; /** * 操作系统类型，0: Linux，1: windows */ OSType?: number; } /** * DeleteMachineGroupInfo请求参数结构体 */ export interface DeleteMachineGroupInfoRequest { /** * 机器组ID */ GroupId: string; /** * 机器组类型目前type支持 ip 和 label */ MachineGroupType: MachineGroupTypeInfo; } /** * CreateLogset返回参数结构体 */ export interface CreateLogsetResponse { /** * 日志集ID */ LogsetId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 通知规则 */ export 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?: Array<NoticeReceiver>; /** * 告警通知模板回调信息，包括企业微信、钉钉、飞书。 */ WebCallbacks?: Array<WebCallback>; /** * 告警升级开关。`true`：开启告警升级、`false`：关闭告警升级，默认：false */ Escalate?: boolean; /** * 告警升级条件。`1`：无人认领且未恢复、`2`：未恢复，默认为1 - 无人认领且未恢复：告警没有恢复并且没有人认领则升级 - 未恢复：当前告警持续未恢复则升级 */ Type?: number; /** * 告警升级间隔。单位：分钟，范围`[1，14400]` */ Interval?: number; /** * 告警升级后下一个环节的通知渠道配置 */ EscalateNotice?: EscalateNoticeInfo; } /** * 仪表盘订阅通知方式 */ export interface DashboardNoticeMode { /** * 仪表盘通知方式。 <li/>Uin：腾讯云用户 <li/>Group：腾讯云用户组 <li/>Email：自定义Email <li/>WeCom: 企业微信回调 */ ReceiverType: string; /** * 知方式对应的值。 <li/> 当ReceiverType不是 Wecom 时，Values必填。 */ Values?: Array<string>; /** * 仪表盘通知渠道。 <li/> 支持：["Email","Sms","WeChat","Phone"]。 <li/> 当ReceiverType是 Email 或 Wecom 时，ReceiverChannels不能赋值。注意：此字段可能返回 null，表示取不到有效值。 */ ReceiverChannels?: Array<string>; /** * 回调Url。 <li/> 当ReceiverType是 Wecom 时，Url必填。 <li/> 当ReceiverType不是 Wecom 时，Url不能填写。 */ Url?: string; } /** * Kafka访问协议 */ export 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; } /** * 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语法 */ SyntaxRule?: number; /** * 是否开启投递服务日志。1：关闭，2：开启。 */ HasServicesLog?: number; } /** * DescribeConfigMachineGroups请求参数结构体 */ export interface DescribeConfigMachineGroupsRequest { /** * 采集配置ID */ ConfigId: string; } /** * 元数据信息 */ export interface MetaTagInfo { /** * 元数据key */ Key?: string; /** * 元数据value */ Value?: string; } /** * ModifyTopic请求参数结构体 */ export interface ModifyTopicRequest { /** * 日志主题ID */ TopicId: string; /** * 日志主题名称 */ TopicName?: string; /** * 标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，并且不能有重复的键值对。 */ Tags?: Array<Tag>; /** * 主题是否开启采集，true：开启采集；false：关闭采集。控制台目前不支持修改此参数。 */ Status?: boolean; /** * 是否开启自动分裂 */ AutoSplit?: boolean; /** * 若开启最大分裂，该主题能够能够允许的最大分区数 */ MaxSplitPartitions?: number; /** * 生命周期，单位天，标准存储取值范围1\~3600，低频存储取值范围7\~3600。取值为3640时代表永久保存 */ Period?: number; /** * 日志主题描述 */ Describes?: string; /** * 0：关闭日志沉降。非0：开启日志沉降后标准存储的天数。HotPeriod需要大于等于7，且小于Period。仅在StorageType为 hot 时生效 */ HotPeriod?: number; /** * 免鉴权开关。 false：关闭； true：开启。开启后将支持指定操作匿名访问该日志主题。详情请参见[日志主题](https://cloud.tencent.com/document/product/614/41035)。 */ IsWebTracking?: boolean; /** * 日志主题扩展信息 */ Extends?: TopicExtendInfo; /** * 日志主题分区数量 */ PartitionCount?: number; /** * 取消切换存储任务的id */ CancelTopicAsyncTaskID?: string; } /** * CreateCosRecharge请求参数结构体 */ export interface CreateCosRechargeRequest { /** * 日志主题 ID */ TopicId: string; /** * 日志集ID */ LogsetId: string; /** * 投递任务名称 */ Name: string; /** * COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。 */ Bucket: string; /** * COS存储桶所在地域，详见产品支持的[地域列表](https://cloud.tencent.com/document/product/436/6224)。 */ BucketRegion: string; /** * 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表单行全文；默认为minimalist_log */ LogType: string; /** * COS文件所在文件夹的前缀。默认为空，投递存储桶下所有的文件。 */ Prefix?: string; /** * supported: "", "gzip", "lzop", "snappy"; 默认空 */ Compress?: string; /** * 提取规则，如果设置了ExtractRule，则必须设置LogType */ ExtractRuleInfo?: ExtractRuleInfo; /** * COS导入任务类型。1：一次性导入任务；2：持续性导入任务。默认为1：一次性导入任务 */ TaskType?: number; /** * 元数据。 */ Metadata?: Array<string>; } /** * DescribeConfigs返回参数结构体 */ export interface DescribeConfigsResponse { /** * 采集配置列表注意：此字段可能返回 null，表示取不到有效值。 */ Configs?: Array<ConfigInfo>; /** * 过滤到的总数目 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeNoticeContents返回参数结构体 */ export interface DescribeNoticeContentsResponse { /** * 通知内容模板列表。 */ NoticeContents?: Array<NoticeContentTemplate>; /** * 符合条件的通知内容模板总数。 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateAlarmShield返回参数结构体 */ export interface CreateAlarmShieldResponse { /** * 屏蔽规则ID。 */ TaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteDataTransform返回参数结构体 */ export interface DeleteDataTransformResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteConfigExtra返回参数结构体 */ export interface DeleteConfigExtraResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyConsumer请求参数结构体 */ export interface ModifyConsumerRequest { /** * 投递任务绑定的日志主题 ID */ TopicId: string; /** * 投递任务是否生效，默认不生效 */ Effective?: boolean; /** * 是否投递日志的元数据信息，默认为 true。当NeedContent为true时：字段Content有效。当NeedContent为false时：字段Content无效。 */ NeedContent?: boolean; /** * 如果需要投递元数据信息，元数据信息的描述 */ Content?: ConsumerContent; /** * CKafka的描述 */ Ckafka?: Ckafka; /** * 投递时压缩方式，取值0，2，3。[0：NONE；2：SNAPPY；3：LZ4] */ Compression?: number; } /** * CreateIndex返回参数结构体 */ export interface CreateIndexResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteConfigFromMachineGroup返回参数结构体 */ export interface DeleteConfigFromMachineGroupResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDashboardSubscribe返回参数结构体 */ export interface ModifyDashboardSubscribeResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDashboardSubscribe请求参数结构体 */ export interface ModifyDashboardSubscribeRequest { /** * 仪表盘订阅id。 */ Id: number; /** * 仪表盘id。 */ DashboardId?: string; /** * 仪表盘订阅名称。 */ Name?: string; /** * 订阅时间cron表达式，格式为：{秒数} {分钟} {小时} {日期} {月份} {星期}；（有效数据为：{分钟} {小时} {日期} {月份} {星期}）。 */ Cron?: string; /** * 仪表盘订阅数据。 */ SubscribeData?: DashboardSubscribeData; } /** * CreateConsumer返回参数结构体 */ export interface CreateConsumerResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeConsoleSharingList返回参数结构体 */ export interface DescribeConsoleSharingListResponse { /** * 分页的总数目 */ TotalCount?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteWebCallback返回参数结构体 */ export interface DeleteWebCallbackResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMachineGroup返回参数结构体 */ export interface ModifyMachineGroupResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据加工的资源信息 */ export interface DataTransformResouceInfo { /** * 目标主题id */ TopicId: string; /** * 别名 */ Alias: string; } /** * CreateDashboardSubscribe请求参数结构体 */ export interface CreateDashboardSubscribeRequest { /** * 仪表盘订阅名称。 */ Name: string; /** * 仪表盘id。 */ DashboardId: string; /** * 订阅时间cron表达式，格式为：{秒数} {分钟} {小时} {日期} {月份} {星期}；（有效数据为：{分钟} {小时} {日期} {月份} {星期}）。 <li/>{秒数} 取值范围： 0 ~ 59 <li/>{分钟} 取值范围： 0 ~ 59 <li/>{小时} 取值范围： 0 ~ 23 <li/>{日期} 取值范围： 1 ~ 31 AND (dayOfMonth最后一天： L) <li/>{月份} 取值范围： 1 ~ 12 <li/>{星期} 取值范围： 0 ~ 6 【0:星期日， 6星期六】 */ Cron: string; /** * 仪表盘订阅数据。 */ SubscribeData: DashboardSubscribeData; } /** * 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; /** * 是否包含中文 */ ContainZH?: boolean; } /** * QueryMetric返回参数结构体 */ export interface QueryMetricResponse { /** * 指标查询结果类型 */ ResultType?: string; /** * 指标查询结果 */ Result?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAlarmShields请求参数结构体 */ export interface DescribeAlarmShieldsRequest { /** * 通知渠道组id。 */ AlarmNoticeId: string; /** * - taskId:按照【规则id】进行过滤。类型：String 必选：否 - status:按照【规则状态】进行过滤。类型：String。支持 0:暂未生效，1:生效中，2:已失效。必选：否每次请求的Filters的上限为10，Filter.Values的上限为100。 */ Filters?: Array<Filter>; /** * 分页的偏移量，默认值为0。 */ Offset?: number; /** * 分页单页限制数目，默认值为20，最大值100。 */ Limit?: number; } /** * ModifyLogset请求参数结构体 */ export interface ModifyLogsetRequest { /** * 日志集ID */ LogsetId: string; /** * 日志集名称 */ LogsetName?: string; /** * 日志集的绑定的标签键值对。最大支持10个标签键值对，同一个资源只能同时绑定一个标签键。 */ Tags?: Array<Tag>; } /** * 告警渠道回调配置信息 */ export interface WebCallbackInfo { /** * 告警渠道回调配置id。 */ WebCallbackId?: string; /** * 告警渠道回调配置名称。 */ Name?: string; /** * 渠道类型 WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调; */ Type?: string; /** * 回调地址。 */ Webhook?: string; /** * 请求方式。 */ Method?: string; /** * 秘钥信息。 */ Key?: string; /** * 主账号。 */ Uin?: number; /** * 子账号。 */ SubUin?: number; /** * 创建时间。秒级时间戳 */ CreateTime?: number; /** * 更新时间。秒级时间戳 */ UpdateTime?: number; } /** *