tencentcloud-sdk-nodejs-cls 4.0.258 → 4.0.262

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

@@ -950,6 +950,16 @@ export interface TopicInfo {
   Period: number
 }
 
+/**
+ * DescribeConsumer请求参数结构体
+ */
+export interface DescribeConsumerRequest {
+  /**
+   * 投递任务绑定的日志主题 ID
+   */
+  TopicId: string
+}
+
 /**
  * 投递任务信息
  */
@@ -1000,6 +1010,36 @@ export interface ShipperTaskInfo {
   Message: string
 }
 
+/**
+ * ModifyConsumer请求参数结构体
+ */
+export interface ModifyConsumerRequest {
+  /**
+   * 投递任务绑定的日志主题 ID
+   */
+  TopicId: string
+
+  /**
+   * 投递任务是否生效
+   */
+  Effective?: boolean
+
+  /**
+   * 是否投递日志的元数据信息，默认为 false
+   */
+  NeedContent?: boolean
+
+  /**
+   * 如果需要投递元数据信息，元数据信息的描述
+   */
+  Content?: ConsumerContent
+
+  /**
+   * CKafka的描述
+   */
+  Ckafka?: Ckafka
+}
+
 /**
  * CreateIndex返回参数结构体
  */
@@ -1020,6 +1060,16 @@ export interface DeleteConfigFromMachineGroupResponse {
   RequestId?: string
 }
 
+/**
+ * CreateConsumer返回参数结构体
+ */
+export interface CreateConsumerResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * ModifyMachineGroup返回参数结构体
  */
@@ -1624,48 +1674,13 @@ export interface CreateIndexRequest {
 }
 
 /**
- * CreateTopic请求参数结构体
+ * DeleteConsumer返回参数结构体
  */
-export interface CreateTopicRequest {
-  /**
-   * 日志集ID
-   */
-  LogsetId: string
-
-  /**
-   * 日志主题名称
-   */
-  TopicName: string
-
-  /**
-   * 日志主题分区个数。默认创建1个，最大支持创建10个分区。
-   */
-  PartitionCount?: number
-
+export interface DeleteConsumerResponse {
   /**
-   * 标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。
-   */
-  Tags?: Array<Tag>
-
-  /**
-   * 是否开启自动分裂，默认值为true
-   */
-  AutoSplit?: boolean
-
-  /**
-   * 开启自动分裂后，每个主题能够允许的最大分区数，默认值为50
-   */
-  MaxSplitPartitions?: number
-
-  /**
-   * 日志主题的存储类型，可选值 hot（实时存储），cold（离线存储）；默认为hot。若传入cold，请先联系客服进行开白。
-   */
-  StorageType?: string
-
-  /**
-   * 生命周期，单位天；可取值范围1~366。默认30天
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
    */
-  Period?: number
+  RequestId?: string
 }
 
 /**
@@ -1825,45 +1840,48 @@ export interface DescribeAsyncSearchTasksRequest {
 }
 
 /**
- * DescribeConfigs请求参数结构体
+ * CreateTopic请求参数结构体
  */
-export interface DescribeConfigsRequest {
+export interface CreateTopicRequest {
   /**
-      * <br><li> configName
-
-按照【采集配置名称】进行模糊匹配过滤。
-类型：String
-
-必选：否
-
-<br><li> configId
-
-按照【采集配置ID】进行过滤。
-类型：String
-
-必选：否
+   * 日志集ID
+   */
+  LogsetId: string
 
-<br><li> topicId
+  /**
+   * 日志主题名称
+   */
+  TopicName: string
 
-按照【日志主题】进行过滤。
+  /**
+   * 日志主题分区个数。默认创建1个，最大支持创建10个分区。
+   */
+  PartitionCount?: number
 
-类型：String
+  /**
+   * 标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，同一个资源只能绑定到同一个标签键下。
+   */
+  Tags?: Array<Tag>
 
-必选：否
+  /**
+   * 是否开启自动分裂，默认值为true
+   */
+  AutoSplit?: boolean
 
-每次请求的Filters的上限为10，Filter.Values的上限为5。
-      */
-  Filters?: Array<Filter>
+  /**
+   * 开启自动分裂后，每个主题能够允许的最大分区数，默认值为50
+   */
+  MaxSplitPartitions?: number
 
   /**
-   * 分页的偏移量，默认值为0
+   * 日志主题的存储类型，可选值 hot（实时存储），cold（离线存储）；默认为hot。若传入cold，请先联系客服进行开白。
    */
-  Offset?: number
+  StorageType?: string
 
   /**
-   * 分页单页的限制数目，默认值为20，最大值100
+   * 生命周期，单位天；可取值范围1~366。默认30天
    */
-  Limit?: number
+  Period?: number
 }
 
 /**
@@ -1981,6 +1999,16 @@ export interface ModifyIndexResponse {
   RequestId?: string
 }
 
+/**
+ * DeleteConsumer请求参数结构体
+ */
+export interface DeleteConsumerRequest {
+  /**
+   * 投递任务绑定的日志主题 ID
+   */
+  TopicId: string
+}
+
 /**
  * DeleteIndex请求参数结构体
  */
@@ -1991,6 +2019,37 @@ export interface DeleteIndexRequest {
   TopicId: string
 }
 
+/**
+ * DescribeConsumer返回参数结构体
+ */
+export interface DescribeConsumerResponse {
+  /**
+   * 投递任务是否生效
+   */
+  Effective: boolean
+
+  /**
+   * 是否投递日志的元数据信息
+   */
+  NeedContent: boolean
+
+  /**
+      * 如果需要投递元数据信息，元数据信息的描述
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Content: ConsumerContent
+
+  /**
+   * CKafka的描述
+   */
+  Ckafka: Ckafka
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * 日志提取规则
  */
@@ -2122,6 +2181,58 @@ 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请求参数结构体
  */
@@ -3023,6 +3134,31 @@ export interface DescribeAsyncSearchResultRequest {
   Limit?: number
 }
 
+/**
+ * CreateConsumer请求参数结构体
+ */
+export interface CreateConsumerRequest {
+  /**
+   * 投递任务绑定的日志主题 ID
+   */
+  TopicId: string
+
+  /**
+   * 是否投递日志的元数据信息，默认为 true
+   */
+  NeedContent?: boolean
+
+  /**
+   * 如果需要投递元数据信息，元数据信息的描述
+   */
+  Content?: ConsumerContent
+
+  /**
+   * CKafka的描述
+   */
+  Ckafka?: Ckafka
+}
+
 /**
  * 告警通知模板类型
  */
@@ -3348,6 +3484,21 @@ export interface ModifyMachineGroupRequest {
   ServiceLogging?: boolean
 }
 
+/**
+ * MergePartition请求参数结构体
+ */
+export interface MergePartitionRequest {
+  /**
+   * 日志主题ID
+   */
+  TopicId: string
+
+  /**
+   * 合并的PartitionId
+   */
+  PartitionId: number
+}
+
 /**
  * DescribeAlarmNotices请求参数结构体
  */
@@ -3509,18 +3660,38 @@ export interface AsyncSearchTask {
 }
 
 /**
- * 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
 }
 
 /**
@@ -4020,6 +4191,23 @@ export interface Filter {
   Values: Array<string>
 }
 
+/**
+ * 投递任务出入参 Content
+ */
+export interface ConsumerContent {
+  /**
+      * 是否投递 TAG 信息
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  EnableTag: boolean
+
+  /**
+      * 需要投递的元数据列表，目前仅支持：__SOURCE__，__FILENAME__和__TIMESTAMP__
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  MetaFields: Array<string>
+}
+
 /**
  * CreateExport返回参数结构体
  */

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

@@ -1,5 +1,5 @@
 import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
-import { UploadLogResponse, CreateAlarmResponse, DeleteAlarmNoticeResponse, DescribeLogContextRequest, DeleteShipperRequest, ModifyTopicRequest, DeleteLogsetResponse, DescribeShipperTasksResponse, CreateMachineGroupResponse, DescribeConfigMachineGroupsRequest, DescribeAsyncContextResultResponse, UploadLogRequest, CreateAsyncContextTaskRequest, CreateLogsetRequest, SearchLogResponse, DeleteTopicRequest, DescribePartitionsRequest, ModifyAlarmResponse, DescribeShipperTasksRequest, DescribeAlarmsRequest, CreateAsyncContextTaskResponse, DescribeShippersResponse, ModifyShipperResponse, RetryShipperTaskRequest, DescribeIndexRequest, DescribeConfigsResponse, CreateLogsetResponse, DeleteAsyncContextTaskResponse, DeleteMachineGroupResponse, DescribeAsyncContextResultRequest, DeleteAsyncSearchTaskResponse, DescribeExportsRequest, CreateAsyncSearchTaskRequest, CreateIndexResponse, DeleteConfigFromMachineGroupResponse, ModifyMachineGroupResponse, DeleteMachineGroupRequest, DescribePartitionsResponse, DescribeConfigMachineGroupsResponse, ModifyAlarmRequest, DescribeTopicsResponse, ModifyAlarmNoticeRequest, CreateAlarmRequest, DeleteExportResponse, DescribeShippersRequest, RetryShipperTaskResponse, SplitPartitionRequest, DescribeMachineGroupsRequest, DescribeAsyncContextTasksResponse, CreateIndexRequest, CreateTopicRequest, DescribeTopicsRequest, GetAlarmLogResponse, DescribeAsyncSearchTasksRequest, DescribeConfigsRequest, DescribeAsyncSearchResultResponse, DescribeAsyncContextTasksRequest, DeleteConfigResponse, ModifyIndexResponse, DeleteIndexRequest, DeleteConfigRequest, CreateExportRequest, DescribeAlarmNoticesResponse, ModifyConfigRequest, DescribeLogsetsResponse, CreateShipperRequest, CreateTopicResponse, DeleteAlarmResponse, DescribeMachinesResponse, DescribeAlarmsResponse, CreateAlarmNoticeResponse, ModifyTopicResponse, CreateConfigRequest, CreateShipperResponse, DeleteIndexResponse, DeleteAsyncContextTaskRequest, ModifyIndexRequest, GetAlarmLogRequest, DescribeMachinesRequest, DeleteShipperResponse, DeleteExportRequest, SplitPartitionResponse, ModifyShipperRequest, DescribeLogContextResponse, DescribeAsyncSearchResultRequest, ModifyConfigResponse, ModifyAlarmNoticeResponse, DescribeAsyncSearchTasksResponse, ApplyConfigToMachineGroupResponse, DeleteAlarmRequest, CreateConfigResponse, DeleteConfigFromMachineGroupRequest, DeleteAsyncSearchTaskRequest, ModifyMachineGroupRequest, DescribeAlarmNoticesRequest, MergePartitionRequest, CreateAsyncSearchTaskResponse, DeleteAlarmNoticeRequest, DeleteLogsetRequest, ModifyLogsetResponse, SearchLogRequest, CreateMachineGroupRequest, DescribeExportsResponse, ApplyConfigToMachineGroupRequest, DescribeMachineGroupConfigsResponse, CreateAlarmNoticeRequest, DescribeIndexResponse, DescribeMachineGroupConfigsRequest, ModifyLogsetRequest, DescribeMachineGroupsResponse, DescribeLogsetsRequest, DeleteTopicResponse, CreateExportResponse, MergePartitionResponse } from "./cls_models";
+import { UploadLogResponse, CreateAlarmResponse, DeleteAlarmNoticeResponse, DescribeLogContextRequest, DeleteShipperRequest, ModifyTopicRequest, DeleteLogsetResponse, DescribeShipperTasksResponse, CreateMachineGroupResponse, DescribeConfigMachineGroupsRequest, DescribeAsyncContextResultResponse, UploadLogRequest, CreateAsyncContextTaskRequest, CreateLogsetRequest, SearchLogResponse, DeleteTopicRequest, DescribePartitionsRequest, ModifyAlarmResponse, DescribeShipperTasksRequest, DescribeAlarmsRequest, CreateAsyncContextTaskResponse, DescribeShippersResponse, ModifyShipperResponse, RetryShipperTaskRequest, DescribeIndexRequest, DescribeConfigsResponse, CreateLogsetResponse, DeleteAsyncContextTaskResponse, DeleteMachineGroupResponse, DescribeAsyncContextResultRequest, DeleteAsyncSearchTaskResponse, DescribeExportsRequest, CreateAsyncSearchTaskRequest, DescribeConsumerRequest, ModifyConsumerRequest, CreateIndexResponse, DeleteConfigFromMachineGroupResponse, CreateConsumerResponse, ModifyMachineGroupResponse, DeleteMachineGroupRequest, DescribePartitionsResponse, DescribeConfigMachineGroupsResponse, ModifyAlarmRequest, DescribeTopicsResponse, ModifyAlarmNoticeRequest, CreateAlarmRequest, DeleteExportResponse, DescribeShippersRequest, RetryShipperTaskResponse, SplitPartitionRequest, DescribeMachineGroupsRequest, DescribeAsyncContextTasksResponse, CreateIndexRequest, DeleteConsumerResponse, DescribeTopicsRequest, GetAlarmLogResponse, DescribeAsyncSearchTasksRequest, CreateTopicRequest, DescribeAsyncSearchResultResponse, DescribeAsyncContextTasksRequest, DeleteConfigResponse, ModifyIndexResponse, DeleteConsumerRequest, DeleteIndexRequest, DescribeConsumerResponse, ModifyConsumerResponse, DescribeConfigsRequest, DeleteConfigRequest, CreateExportRequest, DescribeAlarmNoticesResponse, ModifyConfigRequest, DescribeLogsetsResponse, CreateShipperRequest, CreateTopicResponse, DeleteAlarmResponse, DescribeMachinesResponse, DescribeAlarmsResponse, CreateAlarmNoticeResponse, ModifyTopicResponse, CreateConfigRequest, CreateShipperResponse, DeleteIndexResponse, DeleteAsyncContextTaskRequest, ModifyIndexRequest, GetAlarmLogRequest, DescribeMachinesRequest, DeleteShipperResponse, DeleteExportRequest, SplitPartitionResponse, ModifyShipperRequest, DescribeLogContextResponse, DescribeAsyncSearchResultRequest, CreateConsumerRequest, ModifyConfigResponse, ModifyAlarmNoticeResponse, DescribeAsyncSearchTasksResponse, ApplyConfigToMachineGroupResponse, DeleteAlarmRequest, CreateConfigResponse, DeleteConfigFromMachineGroupRequest, DeleteAsyncSearchTaskRequest, ModifyMachineGroupRequest, MergePartitionRequest, DescribeAlarmNoticesRequest, CreateAsyncSearchTaskResponse, DeleteAlarmNoticeRequest, DeleteLogsetRequest, ModifyLogsetResponse, SearchLogRequest, CreateMachineGroupRequest, DescribeExportsResponse, ApplyConfigToMachineGroupRequest, DescribeMachineGroupConfigsResponse, CreateAlarmNoticeRequest, DescribeIndexResponse, DescribeMachineGroupConfigsRequest, ModifyLogsetRequest, DescribeMachineGroupsResponse, DescribeLogsetsRequest, DeleteTopicResponse, CreateExportResponse, MergePartitionResponse } from "./cls_models";
 /**
  * cls client
  * @class
@@ -18,6 +18,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 本接口用于获取告警任务历史
      */
     GetAlarmLog(req: GetAlarmLogRequest, cb?: (error: string, rep: GetAlarmLogResponse) => void): Promise<GetAlarmLogResponse>;
+    /**
+     * 本接口用于创建投递任务
+     */
+    CreateConsumer(req: CreateConsumerRequest, cb?: (error: string, rep: CreateConsumerResponse) => void): Promise<CreateConsumerResponse>;
     /**
      * 本接口用于修改日志主题。
      */
@@ -67,9 +71,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CreateShipper(req: CreateShipperRequest, cb?: (error: string, rep: CreateShipperResponse) => void): Promise<CreateShipperResponse>;
     /**
-     * 修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
+     * 本接口用于修改投递任务
      */
-    ModifyShipper(req: ModifyShipperRequest, cb?: (error: string, rep: ModifyShipperResponse) => void): Promise<ModifyShipperResponse>;
+    ModifyConsumer(req: ModifyConsumerRequest, cb?: (error: string, rep: ModifyConsumerResponse) => void): Promise<ModifyConsumerResponse>;
     /**
      * 本接口用于删除离线检索任务
      */
@@ -79,9 +83,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      */
     CreateAlarmNotice(req: CreateAlarmNoticeRequest, cb?: (error: string, rep: CreateAlarmNoticeResponse) => void): Promise<CreateAlarmNoticeResponse>;
     /**
-     * 获取采集规则配置
+     * 本接口用于删除投递配置
      */
-    DescribeConfigs(req: DescribeConfigsRequest, cb?: (error: string, rep: DescribeConfigsResponse) => void): Promise<DescribeConfigsResponse>;
+    DeleteConsumer(req: DeleteConsumerRequest, cb?: (error: string, rep: DeleteConsumerResponse) => void): Promise<DeleteConsumerResponse>;
     /**
      * 本接口用于修改告警策略。需要至少修改一项有效内容。
      */
@@ -311,6 +315,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 本接口用于创建离线上下文任务
      */
     CreateAsyncContextTask(req: CreateAsyncContextTaskRequest, cb?: (error: string, rep: CreateAsyncContextTaskResponse) => void): Promise<CreateAsyncContextTaskResponse>;
+    /**
+     * 修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
+     */
+    ModifyShipper(req: ModifyShipperRequest, cb?: (error: string, rep: ModifyShipperResponse) => void): Promise<ModifyShipperResponse>;
     /**
      * 创建采集规则配置
      */
@@ -339,6 +347,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
      * 本接口用于搜索日志上下文附近的内容
      */
     DescribeLogContext(req: DescribeLogContextRequest, cb?: (error: string, rep: DescribeLogContextResponse) => void): Promise<DescribeLogContextResponse>;
+    /**
+     * 本接口用于获取投递配置
+     */
+    DescribeConsumer(req: DescribeConsumerRequest, cb?: (error: string, rep: DescribeConsumerResponse) => void): Promise<DescribeConsumerResponse>;
+    /**
+     * 获取采集规则配置
+     */
+    DescribeConfigs(req: DescribeConfigsRequest, cb?: (error: string, rep: DescribeConfigsResponse) => void): Promise<DescribeConfigsResponse>;
     /**
      * 本接口用于合并一个读写态的主题分区，合并时指定一个主题分区 ID，日志服务会自动合并范围右相邻的分区。
      */

package/tencentcloud/services/cls/v20201016/cls_client.js

@@ -45,6 +45,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async GetAlarmLog(req, cb) {
         return this.request("GetAlarmLog", req, cb);
     }
+    /**
+     * 本接口用于创建投递任务
+     */
+    async CreateConsumer(req, cb) {
+        return this.request("CreateConsumer", req, cb);
+    }
     /**
      * 本接口用于修改日志主题。
      */
@@ -118,10 +124,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateShipper", req, cb);
     }
     /**
-     * 修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
+     * 本接口用于修改投递任务
      */
-    async ModifyShipper(req, cb) {
-        return this.request("ModifyShipper", req, cb);
+    async ModifyConsumer(req, cb) {
+        return this.request("ModifyConsumer", req, cb);
     }
     /**
      * 本接口用于删除离线检索任务
@@ -136,10 +142,10 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("CreateAlarmNotice", req, cb);
     }
     /**
-     * 获取采集规则配置
+     * 本接口用于删除投递配置
      */
-    async DescribeConfigs(req, cb) {
-        return this.request("DescribeConfigs", req, cb);
+    async DeleteConsumer(req, cb) {
+        return this.request("DeleteConsumer", req, cb);
     }
     /**
      * 本接口用于修改告警策略。需要至少修改一项有效内容。
@@ -410,6 +416,12 @@ class Client extends TencentCloudCommon.AbstractClient {
     async CreateAsyncContextTask(req, cb) {
         return this.request("CreateAsyncContextTask", req, cb);
     }
+    /**
+     * 修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
+     */
+    async ModifyShipper(req, cb) {
+        return this.request("ModifyShipper", req, cb);
+    }
     /**
      * 创建采集规则配置
      */
@@ -452,6 +464,18 @@ class Client extends TencentCloudCommon.AbstractClient {
     async DescribeLogContext(req, cb) {
         return this.request("DescribeLogContext", req, cb);
     }
+    /**
+     * 本接口用于获取投递配置
+     */
+    async DescribeConsumer(req, cb) {
+        return this.request("DescribeConsumer", req, cb);
+    }
+    /**
+     * 获取采集规则配置
+     */
+    async DescribeConfigs(req, cb) {
+        return this.request("DescribeConfigs", req, cb);
+    }
     /**
      * 本接口用于合并一个读写态的主题分区，合并时指定一个主题分区 ID，日志服务会自动合并范围右相邻的分区。
      */