tencentcloud-sdk-nodejs 4.0.257 → 4.0.261

package/src/services/clb/v20180317/clb_models.ts

@@ -329,22 +329,22 @@ export interface DescribeLoadBalancerOverviewResponse {
   /**
    * 负载均衡总数
    */
-  TotalCount?: number
+  TotalCount: number
 
   /**
    * 运行中的负载均衡数目
    */
-  RunningCount?: number
+  RunningCount: number
 
   /**
    * 隔离中的负载均衡数目
    */
-  IsolationCount?: number
+  IsolationCount: number
 
   /**
    * 即将到期的负载均衡数目
    */
-  WillExpireCount?: number
+  WillExpireCount: number
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -403,13 +403,13 @@ export interface CloneLoadBalancerRequest {
   LoadBalancerName?: string
 
   /**
-   * 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。不传此参数则视为默认项目。
+   * 负载均衡实例所属的项目 ID，可以通过 [DescribeProject](https://cloud.tencent.com/document/product/378/4400) 接口获取。不传此参数则视为默认项目。
    */
   ProjectId?: number
 
   /**
       * 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID，例如 100001 或 ap-guangzhou-1
-注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区，平台将为您自动选择最佳备可用区。可通过 DescribeMasterZones 接口查询一个地域的主可用区的列表。
+注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区，平台将为您自动选择最佳备可用区。
       */
   MasterZoneId?: string
 
@@ -663,17 +663,17 @@ export interface ModifyLoadBalancerAttributesResponse {
  */
 export interface DescribeTargetGroupInstancesRequest {
   /**
-   * 过滤条件，当前仅支持TargetGroupId，BindIP，InstanceId过滤
+   * 过滤条件，当前仅支持TargetGroupId，BindIP，InstanceId过滤。
    */
   Filters: Array<Filter>
 
   /**
-   * 显示数量限制，默认20
+   * 显示数量限制，默认20。
    */
   Limit?: number
 
   /**
-   * 显示的偏移量，默认为0
+   * 显示的偏移量，默认为0。
    */
   Offset?: number
 }
@@ -1438,7 +1438,7 @@ export interface DescribeLoadBalancerListByCertIdResponse {
   /**
    * 证书ID，以及与该证书ID关联的负载均衡实例列表
    */
-  CertSet?: Array<CertIdRelatedWithLoadBalancers>
+  CertSet: Array<CertIdRelatedWithLoadBalancers>
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -2532,12 +2532,12 @@ export interface DescribeClassicalLBHealthStatusRequest {
  */
 export interface ModifyDomainRequest {
   /**
-   * 负载均衡实例 ID
+   * 负载均衡实例 ID。
    */
   LoadBalancerId: string
 
   /**
-   * 负载均衡监听器 ID
+   * 负载均衡监听器 ID。
    */
   ListenerId: string
 
@@ -3187,19 +3187,19 @@ export interface DescribeTargetHealthResponse {
  */
 export interface DescribeTargetGroupInstancesResponse {
   /**
-   * 本次查询的结果数量
+   * 本次查询的结果数量。
    */
-  TotalCount?: number
+  TotalCount: number
 
   /**
-   * 绑定的服务器信息
+   * 绑定的服务器信息。
    */
-  TargetGroupInstanceSet?: Array<TargetGroupBackend>
+  TargetGroupInstanceSet: Array<TargetGroupBackend>
 
   /**
-   * 实际统计数量，不受Limit，Offset，CAM的影响
+   * 实际统计数量，不受Limit、Offset、CAM的影响。
    */
-  RealCount?: number
+  RealCount: number
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -4312,7 +4312,7 @@ export interface DescribeQuotaResponse {
   /**
    * 配额列表
    */
-  QuotaSet?: Array<Quota>
+  QuotaSet: Array<Quota>
 
   /**
    * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

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

@@ -58,9 +58,12 @@ import {
   DescribeExportsRequest,
   CreateAsyncSearchTaskRequest,
   TopicInfo,
+  DescribeConsumerRequest,
   ShipperTaskInfo,
+  ModifyConsumerRequest,
   CreateIndexResponse,
   DeleteConfigFromMachineGroupResponse,
+  CreateConsumerResponse,
   ModifyMachineGroupResponse,
   RuleInfo,
   DeleteMachineGroupRequest,
@@ -84,19 +87,23 @@ import {
   DescribeMachineGroupsRequest,
   DescribeAsyncContextTasksResponse,
   CreateIndexRequest,
-  CreateTopicRequest,
+  DeleteConsumerResponse,
   DescribeTopicsRequest,
   GetAlarmLogResponse,
   DescribeAsyncSearchTasksRequest,
-  DescribeConfigsRequest,
+  CreateTopicRequest,
   DescribeAsyncSearchResultResponse,
   DescribeAsyncContextTasksRequest,
   AlarmTarget,
   DeleteConfigResponse,
   ModifyIndexResponse,
+  DeleteConsumerRequest,
   DeleteIndexRequest,
+  DescribeConsumerResponse,
   ExtractRuleInfo,
   AsyncContextTask,
+  ModifyConsumerResponse,
+  DescribeConfigsRequest,
   DeleteConfigRequest,
   AnalysisDimensional,
   LogsetInfo,
@@ -132,6 +139,7 @@ import {
   ModifyShipperRequest,
   DescribeLogContextResponse,
   DescribeAsyncSearchResultRequest,
+  CreateConsumerRequest,
   AlarmNotice,
   ModifyConfigResponse,
   ModifyAlarmNoticeResponse,
@@ -146,10 +154,11 @@ import {
   KeyValueInfo,
   DeleteAsyncSearchTaskRequest,
   ModifyMachineGroupRequest,
+  MergePartitionRequest,
   DescribeAlarmNoticesRequest,
   NoticeReceiver,
   AsyncSearchTask,
-  MergePartitionRequest,
+  Ckafka,
   WebCallback,
   CreateAsyncSearchTaskResponse,
   DeleteAlarmNoticeRequest,
@@ -171,6 +180,7 @@ import {
   DescribeLogsetsRequest,
   DeleteTopicResponse,
   Filter,
+  ConsumerContent,
   CreateExportResponse,
   KeyRegexInfo,
   MergePartitionResponse,
@@ -215,6 +225,16 @@ export class Client extends AbstractClient {
     return this.request("GetAlarmLog", req, cb)
   }
 
+  /**
+   * 本接口用于创建投递任务
+   */
+  async CreateConsumer(
+    req: CreateConsumerRequest,
+    cb?: (error: string, rep: CreateConsumerResponse) => void
+  ): Promise<CreateConsumerResponse> {
+    return this.request("CreateConsumer", req, cb)
+  }
+
   /**
    * 本接口用于修改日志主题。
    */
@@ -336,13 +356,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
+   * 本接口用于修改投递任务
    */
-  async ModifyShipper(
-    req: ModifyShipperRequest,
-    cb?: (error: string, rep: ModifyShipperResponse) => void
-  ): Promise<ModifyShipperResponse> {
-    return this.request("ModifyShipper", req, cb)
+  async ModifyConsumer(
+    req: ModifyConsumerRequest,
+    cb?: (error: string, rep: ModifyConsumerResponse) => void
+  ): Promise<ModifyConsumerResponse> {
+    return this.request("ModifyConsumer", req, cb)
   }
 
   /**
@@ -366,13 +386,13 @@ export class Client extends AbstractClient {
   }
 
   /**
-   * 获取采集规则配置
+   * 本接口用于删除投递配置
    */
-  async DescribeConfigs(
-    req: DescribeConfigsRequest,
-    cb?: (error: string, rep: DescribeConfigsResponse) => void
-  ): Promise<DescribeConfigsResponse> {
-    return this.request("DescribeConfigs", req, cb)
+  async DeleteConsumer(
+    req: DeleteConsumerRequest,
+    cb?: (error: string, rep: DeleteConsumerResponse) => void
+  ): Promise<DeleteConsumerResponse> {
+    return this.request("DeleteConsumer", req, cb)
   }
 
   /**
@@ -724,6 +744,16 @@ cls.pb.cc cls.pb.h cls.proto
     return this.request("CreateAsyncContextTask", req, cb)
   }
 
+  /**
+   * 修改现有的投递规则，客户如果使用此接口，需要自行处理CLS对指定bucket的写权限。
+   */
+  async ModifyShipper(
+    req: ModifyShipperRequest,
+    cb?: (error: string, rep: ModifyShipperResponse) => void
+  ): Promise<ModifyShipperResponse> {
+    return this.request("ModifyShipper", req, cb)
+  }
+
   /**
    * 创建采集规则配置
    */
@@ -794,6 +824,26 @@ cls.pb.cc cls.pb.h cls.proto
     return this.request("DescribeLogContext", req, cb)
   }
 
+  /**
+   * 本接口用于获取投递配置
+   */
+  async DescribeConsumer(
+    req: DescribeConsumerRequest,
+    cb?: (error: string, rep: DescribeConsumerResponse) => void
+  ): Promise<DescribeConsumerResponse> {
+    return this.request("DescribeConsumer", req, cb)
+  }
+
+  /**
+   * 获取采集规则配置
+   */
+  async DescribeConfigs(
+    req: DescribeConfigsRequest,
+    cb?: (error: string, rep: DescribeConfigsResponse) => void
+  ): Promise<DescribeConfigsResponse> {
+    return this.request("DescribeConfigs", req, cb)
+  }
+
   /**
    * 本接口用于合并一个读写态的主题分区，合并时指定一个主题分区 ID，日志服务会自动合并范围右相邻的分区。
    */

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返回参数结构体
  */