tencentcloud-sdk-nodejs-cls 4.0.320 → 4.0.323

package/src/services/cls/v20201016/cls_models.ts

@@ -350,6 +350,26 @@ export interface ModifyConfigExtraResponse {
   RequestId?: string
 }
 
+/**
+ * ModifyLogset请求参数结构体
+ */
+export interface ModifyLogsetRequest {
+  /**
+   * 日志集ID
+   */
+  LogsetId: string
+
+  /**
+   * 日志集名称
+   */
+  LogsetName?: string
+
+  /**
+   * 日志集的绑定的标签键值对。最大支持10个标签键值对，同一个资源只能同时绑定一个标签键。
+   */
+  Tags?: Array<Tag>
+}
+
 /**
  * CreateLogset请求参数结构体
  */
@@ -366,45 +386,33 @@ export interface CreateLogsetRequest {
 }
 
 /**
- * DescribeShippers请求参数结构体
+ * ModifyDataTransform请求参数结构体
  */
-export interface DescribeShippersRequest {
+export interface ModifyDataTransformRequest {
   /**
-      * <br><li> shipperName
-
-按照【投递规则名称】进行过滤。
-类型：String
-
-必选：否
-
-<br><li> shipperId
-
-按照【投递规则ID】进行过滤。
-类型：String
-
-必选：否
-
-<br><li> topicId
-
-按照【日志主题】进行过滤。
-
-类型：String
+   * 加工任务id
+   */
+  TaskId: string
 
-必选：否
+  /**
+   * 加工任务名称
+   */
+  Name?: string
 
-每次请求的Filters的上限为10，Filter.Values的上限为5。
-      */
-  Filters?: Array<Filter>
+  /**
+   * 加工逻辑函数
+   */
+  EtlContent?: string
 
   /**
-   * 分页的偏移量，默认值为0
+   * 任务启动状态. 默认为1，正常开启,  2关闭
    */
-  Offset?: number
+  EnableFlag?: number
 
   /**
-   * 分页单页的限制数目，默认值为20，最大值100
+   * 加工任务目的topic_id以及别名
    */
-  Limit?: number
+  DstResources?: Array<DataTransformResouceInfo>
 }
 
 /**
@@ -770,6 +778,21 @@ export interface CallBackInfo {
   Headers?: Array<string>
 }
 
+/**
+ * OpenKafkaConsumer返回参数结构体
+ */
+export interface OpenKafkaConsumerResponse {
+  /**
+   * 待消费TopicId
+   */
+  TopicID: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 告警对象
  */
@@ -1042,13 +1065,13 @@ export interface TopicInfo {
 }
 
 /**
- * DescribeConsumer请求参数结构体
+ * DeleteDataTransform返回参数结构体
  */
-export interface DescribeConsumerRequest {
+export interface DeleteDataTransformResponse {
   /**
-   * 投递任务绑定的日志主题 ID
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  TopicId: string
+  RequestId?: string
 }
 
 /**
@@ -1132,26 +1155,18 @@ export interface ModifyMachineGroupResponse {
 }
 
 /**
- * 索引规则，FullText、KeyValue、Tag参数必须输入一个有效参数
+ * 数据加工的资源信息
  */
-export interface RuleInfo {
-  /**
-      * 全文索引配置
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  FullText?: FullTextInfo
-
+export interface DataTransformResouceInfo {
   /**
-      * 键值索引配置
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  KeyValue?: RuleKeyValueInfo
+   * 目标主题id
+   */
+  TopicId: string
 
   /**
-      * 元字段索引配置
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Tag?: RuleTagInfo
+   * 别名
+   */
+  Alias: string
 }
 
 /**
@@ -1466,93 +1481,45 @@ export interface PartitionInfo {
 }
 
 /**
- * CreateConfigExtra请求参数结构体
+ * DescribeShippers请求参数结构体
  */
-export interface CreateConfigExtraRequest {
-  /**
-   * 采集配置规程名称，最长63个字符，只能包含小写字符、数字及分隔符（“-”），且必须以小写字符开头，数字或小写字符结尾
-   */
-  Name: string
-
-  /**
-   * 日志主题id
-   */
-  TopicId: string
-
-  /**
-   * 类型：container_stdout、container_file、host_file
-   */
-  Type: string
-
-  /**
-   * 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志，multiline_log代表多行日志，fullregex_log代表完整正则，默认为minimalist_log
-   */
-  LogType: string
-
+export interface DescribeShippersRequest {
   /**
-   * 采集配置标
-   */
-  ConfigFlag: string
+      * <br><li> shipperName
 
-  /**
-   * 日志集id
-   */
-  LogsetId: string
+按照【投递规则名称】进行过滤。
+类型：String
 
-  /**
-   * 日志集name
-   */
-  LogsetName: string
+必选：否
 
-  /**
-   * 日志主题名称
-   */
-  TopicName: string
+<br><li> shipperId
 
-  /**
-   * 节点文件配置信息
-   */
-  HostFile?: HostFileInfo
+按照【投递规则ID】进行过滤。
+类型：String
 
-  /**
-   * 容器文件路径信息
-   */
-  ContainerFile?: ContainerFileInfo
+必选：否
 
-  /**
-   * 容器标准输出信息
-   */
-  ContainerStdout?: ContainerStdoutInfo
+<br><li> topicId
 
-  /**
-   * 日志格式化方式
-   */
-  LogFormat?: string
+按照【日志主题】进行过滤。
 
-  /**
-   * 提取规则，如果设置了ExtractRule，则必须设置LogType
-   */
-  ExtractRule?: ExtractRuleInfo
+类型：String
 
-  /**
-   * 采集黑名单路径列表
-   */
-  ExcludePaths?: Array<ExcludePathInfo>
+必选：否
 
-  /**
-   * 用户自定义采集规则，Json格式序列化的字符串
-   */
-  UserDefineRule?: string
+每次请求的Filters的上限为10，Filter.Values的上限为5。
+      */
+  Filters?: Array<Filter>
 
   /**
-   * 绑定的机器组id
+   * 分页的偏移量，默认值为0
    */
-  GroupId?: string
+  Offset?: number
 
   /**
-   * 绑定的机器组id列表
+   * 分页单页的限制数目，默认值为20，最大值100
    */
-  GroupIds?: Array<string>
+  Limit?: number
 }
 
 /**
@@ -1833,6 +1800,16 @@ export interface DescribeLogHistogramResponse {
   RequestId?: string
 }
 
+/**
+ * CloseKafkaConsumer返回参数结构体
+ */
+export interface CloseKafkaConsumerResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 元字段索引配置
  */
@@ -1866,6 +1843,16 @@ export interface CreateIndexRequest {
    * 是否生效，默认为true
    */
   Status?: boolean
+
+  /**
+   * 全文索引系统预置字段标记，默认false。  false:不包含系统预置字段， true:包含系统预置字段
+   */
+  IncludeInternalFields?: boolean
+
+  /**
+   * 元数据相关标志位，默认为0。 0：全文索引包括开启键值索引的元数据字段， 1：全文索引包括所有元数据字段，2：全文索引不包括元数据字段。
+   */
+  MetadataFlag?: number
 }
 
 /**
@@ -2068,12 +2055,12 @@ export interface AlarmTarget {
   Number: number
 
   /**
-   * 查询范围起始时间相对当前的历史时间，单位非分钟，取值为非正，最大值为0，最小值为-1440。
+   * 查询范围起始时间相对于告警执行时间的偏移，单位为分钟，取值为非正，最大值为0，最小值为-1440。
    */
   StartTimeOffset: number
 
   /**
-   * 查询范围终止时间相对当前的历史时间，单位非分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。
+   * 查询范围终止时间相对于告警执行时间的偏移，单位为分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。
    */
   EndTimeOffset: number
 
@@ -2083,6 +2070,16 @@ export interface AlarmTarget {
   LogsetId: string
 }
 
+/**
+ * OpenKafkaConsumer请求参数结构体
+ */
+export interface OpenKafkaConsumerRequest {
+  /**
+   * CLS控制台创建的TopicId
+   */
+  FromTopicId: string
+}
+
 /**
  * DeleteConfig返回参数结构体
  */
@@ -2226,6 +2223,52 @@ export interface DescribeConfigsRequest {
   Limit?: number
 }
 
+/**
+ * 日志集相关信息
+ */
+export interface LogsetInfo {
+  /**
+   * 日志集ID
+   */
+  LogsetId: string
+
+  /**
+   * 日志集名称
+   */
+  LogsetName: string
+
+  /**
+   * 创建时间
+   */
+  CreateTime: string
+
+  /**
+      * 日志集绑定的标签
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Tags: Array<Tag>
+
+  /**
+   * 日志集下日志主题的数目
+   */
+  TopicCount: number
+
+  /**
+   * 若AssumerUin非空，则表示创建该日志集的服务方角色
+   */
+  RoleName: string
+}
+
+/**
+ * DescribeConsumer请求参数结构体
+ */
+export interface DescribeConsumerRequest {
+  /**
+   * 投递任务绑定的日志主题 ID
+   */
+  TopicId: string
+}
+
 /**
  * DeleteConfig请求参数结构体
  */
@@ -2307,40 +2350,14 @@ export interface ShipperTaskInfo {
 }
 
 /**
- * 日志集相关信息
+ * CloseKafkaConsumer请求参数结构体
  */
-export interface LogsetInfo {
+export interface CloseKafkaConsumerRequest {
   /**
-   * 日志集ID
+   * CLS对应的topic标识
    */
-  LogsetId: string
-
-  /**
-   * 日志集名称
-   */
-  LogsetName: string
-
-  /**
-   * 创建时间
-   */
-  CreateTime: string
-
-  /**
-      * 日志集绑定的标签
-注意：此字段可能返回 null，表示取不到有效值。
-      */
-  Tags: Array<Tag>
-
-  /**
-   * 日志集下日志主题的数目
-   */
-  TopicCount: number
-
-  /**
-   * 若AssumerUin非空，则表示创建该日志集的服务方角色
-   */
-  RoleName: string
-}
+  FromTopicId: string
+}
 
 /**
  * CreateExport请求参数结构体
@@ -2403,6 +2420,16 @@ export interface DescribeAlarmNoticesResponse {
   RequestId?: string
 }
 
+/**
+ * DeleteDataTransform请求参数结构体
+ */
+export interface DeleteDataTransformRequest {
+  /**
+   * 数据加工任务id
+   */
+  TaskId: string
+}
+
 /**
  * DeleteConfigExtra请求参数结构体
  */
@@ -2747,6 +2774,16 @@ export interface ModifyIndexRequest {
    * 索引规则
    */
   Rule?: RuleInfo
+
+  /**
+   * 全文索引系统预置字段标记，默认false。  false:不包含系统预置字段， true:包含系统预置字段
+   */
+  IncludeInternalFields?: boolean
+
+  /**
+   * 元数据相关标志位，默认为0。 0：全文索引包括开启键值索引的元数据字段， 1：全文索引包括所有元数据字段，2：全文索引不包括元数据字段。
+   */
+  MetadataFlag?: number
 }
 
 /**
@@ -2801,43 +2838,47 @@ export interface ValueInfo {
 }
 
 /**
- * GetAlarmLog请求参数结构体
+ * DescribeDataTransformInfo请求参数结构体
  */
-export interface GetAlarmLogRequest {
+export interface DescribeDataTransformInfoRequest {
   /**
-   * 要查询的日志的起始时间，Unix时间戳，单位ms
-   */
-  From: number
+      * <br><li> taskName
 
-  /**
-   * 要查询的日志的结束时间，Unix时间戳，单位ms
-   */
-  To: number
+按照【加工任务名称】进行过滤。
+类型：String
 
-  /**
-   * 查询语句，语句长度最大为1024
-   */
-  Query: string
+必选：否
+
+<br><li> taskId
+
+按照【加工任务id】进行过滤。
+类型：String
+
+必选：否
+
+每次请求的Filters的上限为10，Filter.Values的上限为100。
+      */
+  Filters?: Array<Filter>
 
   /**
-   * 单次查询返回的日志条数，最大值为1000
+   * 分页的偏移量，默认值为0。
    */
-  Limit?: number
+  Offset?: number
 
   /**
-   * 加载更多日志时使用，透传上次返回的Context值，获取后续的日志内容
+   * 分页单页限制数目，默认值为20，最大值100。
    */
-  Context?: string
+  Limit?: number
 
   /**
-   * 日志接口是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc
+   * 默认值为2.   1: 获取单个任务的详细信息 2：获取任务列表
    */
-  Sort?: string
+  Type?: number
 
   /**
-   * 为true代表使用新检索,响应参数AnalysisRecords和Columns有效， 为false时代表使用老检索方式, AnalysisResults和ColNames有效
+   * Type为1， 此参数必填
    */
-  UseNewAnalysis?: boolean
+  TaskId?: string
 }
 
 /**
@@ -2920,6 +2961,31 @@ export interface ExportInfo {
   CreateTime: string
 }
 
+/**
+ * DescribeLogContext返回参数结构体
+ */
+export interface DescribeLogContextResponse {
+  /**
+   * 日志上下文信息集合
+   */
+  LogContextInfos: Array<LogContextInfo>
+
+  /**
+   * 上文日志是否已经返回
+   */
+  PrevOver: boolean
+
+  /**
+   * 下文日志是否已经返回
+   */
+  NextOver: boolean
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 采集规则配置信息
  */
@@ -3007,6 +3073,21 @@ export interface SplitPartitionResponse {
   RequestId?: string
 }
 
+/**
+ * CreateDataTransform返回参数结构体
+ */
+export interface CreateDataTransformResponse {
+  /**
+   * 任务id
+   */
+  TaskId: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 日志上下文信息
  */
@@ -3103,28 +3184,116 @@ export interface ModifyShipperRequest {
 }
 
 /**
- * DescribeLogContext返回参数结构体
+ * 索引规则，FullText、KeyValue、Tag参数必须输入一个有效参数
  */
-export interface DescribeLogContextResponse {
+export interface RuleInfo {
   /**
-   * 日志上下文信息集合
+      * 全文索引配置
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  FullText?: FullTextInfo
+
+  /**
+      * 键值索引配置
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  KeyValue?: RuleKeyValueInfo
+
+  /**
+      * 元字段索引配置
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Tag?: RuleTagInfo
+}
+
+/**
+ * CreateConfigExtra请求参数结构体
+ */
+export interface CreateConfigExtraRequest {
+  /**
+   * 采集配置规程名称，最长63个字符，只能包含小写字符、数字及分隔符（“-”），且必须以小写字符开头，数字或小写字符结尾
    */
-  LogContextInfos: Array<LogContextInfo>
+  Name: string
 
   /**
-   * 上文日志是否已经返回
+   * 日志主题id
    */
-  PrevOver: boolean
+  TopicId: string
 
   /**
-   * 下文日志是否已经返回
+   * 类型：container_stdout、container_file、host_file
    */
-  NextOver: boolean
+  Type: string
 
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志，multiline_log代表多行日志，fullregex_log代表完整正则，默认为minimalist_log
    */
-  RequestId?: string
+  LogType: string
+
+  /**
+   * 采集配置标
+   */
+  ConfigFlag: string
+
+  /**
+   * 日志集id
+   */
+  LogsetId: string
+
+  /**
+   * 日志集name
+   */
+  LogsetName: string
+
+  /**
+   * 日志主题名称
+   */
+  TopicName: string
+
+  /**
+   * 节点文件配置信息
+   */
+  HostFile?: HostFileInfo
+
+  /**
+   * 容器文件路径信息
+   */
+  ContainerFile?: ContainerFileInfo
+
+  /**
+   * 容器标准输出信息
+   */
+  ContainerStdout?: ContainerStdoutInfo
+
+  /**
+   * 日志格式化方式
+   */
+  LogFormat?: string
+
+  /**
+   * 提取规则，如果设置了ExtractRule，则必须设置LogType
+   */
+  ExtractRule?: ExtractRuleInfo
+
+  /**
+   * 采集黑名单路径列表
+   */
+  ExcludePaths?: Array<ExcludePathInfo>
+
+  /**
+   * 用户自定义采集规则，Json格式序列化的字符串
+   */
+  UserDefineRule?: string
+
+  /**
+   * 绑定的机器组id
+   */
+  GroupId?: string
+
+  /**
+   * 绑定的机器组id列表
+   */
+  GroupIds?: Array<string>
 }
 
 /**
@@ -3220,6 +3389,76 @@ export interface ModifyAlarmNoticeResponse {
   RequestId?: string
 }
 
+/**
+ * 数据加工任务基本详情
+ */
+export interface DataTransformTaskInfo {
+  /**
+   * 数据加工任务名称
+   */
+  Name: string
+
+  /**
+   * 数据加工任务id
+   */
+  TaskId: string
+
+  /**
+   * 任务启用状态，默认为1，正常开启,  2关闭
+   */
+  EnableFlag: number
+
+  /**
+   * 加工任务类型，1： DSL， 2：SQL
+   */
+  Type: number
+
+  /**
+   * 源日志主题
+   */
+  SrcTopicId: string
+
+  /**
+   * 当前加工任务状态（1准备中/2运行中/3停止中/4已停止）
+   */
+  Status: number
+
+  /**
+   * 加工任务创建时间
+   */
+  CreateTime: string
+
+  /**
+   * 最近修改时间
+   */
+  UpdateTime: string
+
+  /**
+   * 最后启用时间，如果需要重建集群，修改该时间
+   */
+  LastEnableTime: string
+
+  /**
+   * 日志主题名称
+   */
+  SrcTopicName: string
+
+  /**
+   * 日志集id
+   */
+  LogsetId: string
+
+  /**
+   * 加工任务目的topic_id以及别名
+   */
+  DstResources: Array<DataTransformResouceInfo>
+
+  /**
+   * 加工逻辑函数
+   */
+  EtlContent: string
+}
+
 /**
  * DescribeMachines返回参数结构体
  */
@@ -3260,6 +3499,42 @@ export interface DescribeMachinesResponse {
   RequestId?: string
 }
 
+/**
+ * 预览数据详情
+ */
+export interface PreviewLogStatistic {
+  /**
+   * 日志内容
+   */
+  LogContent: string
+
+  /**
+   * 行号
+   */
+  LineNum: number
+
+  /**
+   * 目标日志主题
+   */
+  DstTopicId?: string
+
+  /**
+   * 失败错误码， 空字符串""表示正常
+   */
+  FailReason?: string
+
+  /**
+   * 日志时间戳
+   */
+  Time?: string
+
+  /**
+      * 目标topic-name
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  DstTopicName?: string
+}
+
 /**
  * 投递日志的内容格式配置
  */
@@ -3828,6 +4103,46 @@ export interface ApplyConfigToMachineGroupRequest {
   GroupId: string
 }
 
+/**
+ * GetAlarmLog请求参数结构体
+ */
+export interface GetAlarmLogRequest {
+  /**
+   * 要查询的日志的起始时间，Unix时间戳，单位ms
+   */
+  From: number
+
+  /**
+   * 要查询的日志的结束时间，Unix时间戳，单位ms
+   */
+  To: number
+
+  /**
+   * 查询语句，语句长度最大为1024
+   */
+  Query: string
+
+  /**
+   * 单次查询返回的日志条数，最大值为1000
+   */
+  Limit?: number
+
+  /**
+   * 加载更多日志时使用，透传上次返回的Context值，获取后续的日志内容
+   */
+  Context?: string
+
+  /**
+   * 日志接口是否按时间排序返回；可选值：asc(升序)、desc(降序)，默认为 desc
+   */
+  Sort?: string
+
+  /**
+   * 为true代表使用新检索,响应参数AnalysisRecords和Columns有效， 为false时代表使用老检索方式, AnalysisResults和ColNames有效
+   */
+  UseNewAnalysis?: boolean
+}
+
 /**
  * 自建k8s-容器文件路径信息
  */
@@ -3981,6 +4296,18 @@ export interface DescribeIndexResponse {
    */
   ModifyTime: string
 
+  /**
+      * 全文索引系统预置字段标记，默认false。  false:不包含系统预置字段， true:包含系统预置字段
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  IncludeInternalFields: boolean
+
+  /**
+      * 元数据相关标志位，默认为0。 0：全文索引包括开启键值索引的元数据字段， 1：全文索引包括所有元数据字段，2：全文索引不包括元数据字段。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  MetadataFlag: number
+
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
@@ -4103,23 +4430,48 @@ export interface ModifyConfigExtraRequest {
 }
 
 /**
- * ModifyLogset请求参数结构体
+ * CreateDataTransform请求参数结构体
  */
-export interface ModifyLogsetRequest {
+export interface CreateDataTransformRequest {
   /**
-   * 日志集ID
+   * 函数类型. DSL:1 SQL:2
    */
-  LogsetId: string
+  FuncType: number
 
   /**
-   * 日志集名称
+   * 源日志主题
    */
-  LogsetName?: string
+  SrcTopicId: string
 
   /**
-   * 日志集的绑定的标签键值对。最大支持10个标签键值对，同一个资源只能同时绑定一个标签键。
+   * 加工任务名称
    */
-  Tags?: Array<Tag>
+  Name: string
+
+  /**
+   * 加工逻辑函数
+   */
+  EtlContent: string
+
+  /**
+   * 加工任务目的topic_id以及别名
+   */
+  DstResources: Array<DataTransformResouceInfo>
+
+  /**
+   * 任务类型.  以SrcTopicId为数据源建立预览任务:1，以PreviewLogStatistics为数据源建立预览任务:2  真实任务:3
+   */
+  TaskType: number
+
+  /**
+   * 任务启动状态.   默认为1，正常开启,  2关闭
+   */
+  EnableFlag?: number
+
+  /**
+   * 测试数据
+   */
+  PreviewLogStatistics?: Array<PreviewLogStatistic>
 }
 
 /**
@@ -4218,6 +4570,36 @@ export interface Filter {
   Values: Array<string>
 }
 
+/**
+ * ModifyDataTransform返回参数结构体
+ */
+export interface ModifyDataTransformResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DescribeDataTransformInfo返回参数结构体
+ */
+export interface DescribeDataTransformInfoResponse {
+  /**
+   * 数据加工任务列表信息
+   */
+  DataTransformTaskInfos: Array<DataTransformTaskInfo>
+
+  /**
+   * 任务总次数
+   */
+  TotalCount: number
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 投递任务出入参 Content
  */