tencentcloud-sdk-nodejs-cls 4.0.256 → 4.0.261

package/tencentcloud/services/cls/v20201016/cls_models.d.ts

@@ -796,6 +796,15 @@ export interface TopicInfo {
         */
     Period: number;
 }
+/**
+ * DescribeConsumer请求参数结构体
+ */
+export interface DescribeConsumerRequest {
+    /**
+     * 投递任务绑定的日志主题 ID
+     */
+    TopicId: string;
+}
 /**
  * 投递任务信息
  */
@@ -837,6 +846,31 @@ export interface ShipperTaskInfo {
      */
     Message: string;
 }
+/**
+ * ModifyConsumer请求参数结构体
+ */
+export interface ModifyConsumerRequest {
+    /**
+     * 投递任务绑定的日志主题 ID
+     */
+    TopicId: string;
+    /**
+     * 投递任务是否生效
+     */
+    Effective?: boolean;
+    /**
+     * 是否投递日志的元数据信息，默认为 false
+     */
+    NeedContent?: boolean;
+    /**
+     * 如果需要投递元数据信息，元数据信息的描述
+     */
+    Content?: ConsumerContent;
+    /**
+     * CKafka的描述
+     */
+    Ckafka?: Ckafka;
+}
 /**
  * CreateIndex返回参数结构体
  */
@@ -855,6 +889,15 @@ export interface DeleteConfigFromMachineGroupResponse {
      */
     RequestId?: string;
 }
+/**
+ * CreateConsumer返回参数结构体
+ */
+export interface CreateConsumerResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ModifyMachineGroup返回参数结构体
  */
@@ -1375,41 +1418,13 @@ export interface CreateIndexRequest {
     Status?: boolean;
 }
 /**
- * CreateTopic请求参数结构体
+ * DeleteConsumer返回参数结构体
  */
-export interface CreateTopicRequest {
-    /**
-     * 日志集ID
-     */
-    LogsetId: string;
-    /**
-     * 日志主题名称
-     */
-    TopicName: string;
-    /**
-     * 日志主题分区个数。默认创建1个，最大支持创建10个分区。
-     */
-    PartitionCount?: number;
-    /**
-     * 标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。
-     */
-    Tags?: Array<Tag>;
+export interface DeleteConsumerResponse {
     /**
-     * 是否开启自动分裂，默认值为true
-     */
-    AutoSplit?: boolean;
-    /**
-     * 开启自动分裂后，每个主题能够允许的最大分区数，默认值为50
-     */
-    MaxSplitPartitions?: number;
-    /**
-     * 日志主题的存储类型，可选值 hot（实时存储），cold（离线存储）；默认为hot。若传入cold，请先联系客服进行开白。
-     */
-    StorageType?: string;
-    /**
-     * 生命周期，单位天；可取值范围1~366。默认30天
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
      */
-    Period?: number;
+    RequestId?: string;
 }
 /**
  * DescribeTopics请求参数结构体
@@ -1553,43 +1568,41 @@ export interface DescribeAsyncSearchTasksRequest {
     Filters?: Array<Filter>;
 }
 /**
- * DescribeConfigs请求参数结构体
+ * CreateTopic请求参数结构体
  */
-export interface DescribeConfigsRequest {
+export interface CreateTopicRequest {
     /**
-        * <br><li> configName
-  
-  按照【采集配置名称】进行模糊匹配过滤。
-  类型：String
-  
-  必选：否
-  
-  <br><li> configId
-  
-  按照【采集配置ID】进行过滤。
-  类型：String
-  
-  必选：否
-  
-  <br><li> topicId
-  
-  按照【日志主题】进行过滤。
-  
-  类型：String
-  
-  必选：否
-  
-  每次请求的Filters的上限为10，Filter.Values的上限为5。
-        */
-    Filters?: Array<Filter>;
+     * 日志集ID
+     */
+    LogsetId: string;
     /**
-     * 分页的偏移量，默认值为0
+     * 日志主题名称
      */
-    Offset?: number;
+    TopicName: string;
     /**
-     * 分页单页的限制数目，默认值为20，最大值100
+     * 日志主题分区个数。默认创建1个，最大支持创建10个分区。
      */
-    Limit?: number;
+    PartitionCount?: number;
+    /**
+     * 标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。
+     */
+    Tags?: Array<Tag>;
+    /**
+     * 是否开启自动分裂，默认值为true
+     */
+    AutoSplit?: boolean;
+    /**
+     * 开启自动分裂后，每个主题能够允许的最大分区数，默认值为50
+     */
+    MaxSplitPartitions?: number;
+    /**
+     * 日志主题的存储类型，可选值 hot（实时存储），cold（离线存储）；默认为hot。若传入cold，请先联系客服进行开白。
+     */
+    StorageType?: string;
+    /**
+     * 生命周期，单位天；可取值范围1~366。默认30天
+     */
+    Period?: number;
 }
 /**
  * DescribeAsyncSearchResult返回参数结构体
@@ -1691,6 +1704,15 @@ export interface ModifyIndexResponse {
      */
     RequestId?: string;
 }
+/**
+ * DeleteConsumer请求参数结构体
+ */
+export interface DeleteConsumerRequest {
+    /**
+     * 投递任务绑定的日志主题 ID
+     */
+    TopicId: string;
+}
 /**
  * DeleteIndex请求参数结构体
  */
@@ -1700,6 +1722,32 @@ export interface DeleteIndexRequest {
      */
     TopicId: string;
 }
+/**
+ * DescribeConsumer返回参数结构体
+ */
+export interface DescribeConsumerResponse {
+    /**
+     * 投递任务是否生效
+     */
+    Effective: boolean;
+    /**
+     * 是否投递日志的元数据信息
+     */
+    NeedContent: boolean;
+    /**
+        * 如果需要投递元数据信息，元数据信息的描述
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    Content: ConsumerContent;
+    /**
+     * CKafka的描述
+     */
+    Ckafka: Ckafka;
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * 日志提取规则
  */
@@ -1810,6 +1858,54 @@ export interface AsyncContextTask {
         */
     AsyncSearchTaskId: string;
 }
+/**
+ * ModifyConsumer返回参数结构体
+ */
+export interface ModifyConsumerResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * DescribeConfigs请求参数结构体
+ */
+export interface DescribeConfigsRequest {
+    /**
+        * <br><li> configName
+  
+  按照【采集配置名称】进行模糊匹配过滤。
+  类型：String
+  
+  必选：否
+  
+  <br><li> configId
+  
+  按照【采集配置ID】进行过滤。
+  类型：String
+  
+  必选：否
+  
+  <br><li> topicId
+  
+  按照【日志主题】进行过滤。
+  
+  类型：String
+  
+  必选：否
+  
+  每次请求的Filters的上限为10，Filter.Values的上限为5。
+        */
+    Filters?: Array<Filter>;
+    /**
+     * 分页的偏移量，默认值为0
+     */
+    Offset?: number;
+    /**
+     * 分页单页的限制数目，默认值为20，最大值100
+     */
+    Limit?: number;
+}
 /**
  * DeleteConfig请求参数结构体
  */
@@ -2568,6 +2664,27 @@ export interface DescribeAsyncSearchResultRequest {
      */
     Limit?: number;
 }
+/**
+ * CreateConsumer请求参数结构体
+ */
+export interface CreateConsumerRequest {
+    /**
+     * 投递任务绑定的日志主题 ID
+     */
+    TopicId: string;
+    /**
+     * 是否投递日志的元数据信息，默认为 true
+     */
+    NeedContent?: boolean;
+    /**
+     * 如果需要投递元数据信息，元数据信息的描述
+     */
+    Content?: ConsumerContent;
+    /**
+     * CKafka的描述
+     */
+    Ckafka?: Ckafka;
+}
 /**
  * 告警通知模板类型
  */
@@ -2845,6 +2962,19 @@ export interface ModifyMachineGroupRequest {
      */
     ServiceLogging?: boolean;
 }
+/**
+ * MergePartition请求参数结构体
+ */
+export interface MergePartitionRequest {
+    /**
+     * 日志主题ID
+     */
+    TopicId: string;
+    /**
+     * 合并的PartitionId
+     */
+    PartitionId: number;
+}
 /**
  * DescribeAlarmNotices请求参数结构体
  */
@@ -2985,17 +3115,33 @@ export interface AsyncSearchTask {
     FinishTime: string;
 }
 /**
- * MergePartition请求参数结构体
+ * CKafka的描述-需要投递到的kafka信息
  */
-export interface MergePartitionRequest {
+export interface Ckafka {
     /**
-     * 日志主题ID
+     * Ckafka 的 Vip
+     */
+    Vip: string;
+    /**
+     * Ckafka 的 Vport
+     */
+    Vport: string;
+    /**
+     * Ckafka 的 InstanceId
+     */
+    InstanceId: string;
+    /**
+     * Ckafka 的 InstanceName
+     */
+    InstanceName: string;
+    /**
+     * Ckafka 的 TopicId
      */
     TopicId: string;
     /**
-     * 合并的PartitionId
+     * Ckafka 的 TopicName
      */
-    PartitionId: number;
+    TopicName: string;
 }
 /**
  * 回调地址
@@ -3147,7 +3293,7 @@ export interface SearchLogRequest {
      */
     Limit?: number;
     /**
-     * 加载更多日志时使用，透传上次返回的Context值，获取后续的日志内容。过期时间1小时
+     * 加载更多日志时使用，透传上次返回的Context值，获取后续的日志内容，总计最多可获取1万条原始日志。过期时间1小时
      */
     Context?: string;
     /**
@@ -3425,6 +3571,21 @@ export interface Filter {
      */
     Values: Array<string>;
 }
+/**
+ * 投递任务出入参 Content
+ */
+export interface ConsumerContent {
+    /**
+        * 是否投递 TAG 信息
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    EnableTag: boolean;
+    /**
+        * 需要投递的元数据列表，目前仅支持：__SOURCE__，__FILENAME__和__TIMESTAMP__
+  注意：此字段可能返回 null，表示取不到有效值。
+        */
+    MetaFields: Array<string>;
+}
 /**
  * CreateExport返回参数结构体
  */