tencentcloud-sdk-nodejs 4.1.89 → 4.1.91

package/tencentcloud/services/clb/v20180317/clb_models.d.ts

@@ -3736,7 +3736,7 @@ export interface CreateTargetGroupRequest {
      */
     Type?: string;
     /**
-     * 目标组后端转发协议。v2新版目标组该项必填。目前支持tcp、udp。
+     * 目标组后端转发协议。v2新版目标组该项必填。目前支持TCP、UDP、HTTP、HTTPS、GRPC。
      */
     Protocol?: string;
     /**
@@ -3753,7 +3753,7 @@ export interface CreateTargetGroupRequest {
      */
     Weight?: number;
     /**
-     * 全监听目标组标识，为true表示是全监听目标组，false表示不是全监听目标组。
+     * 全监听目标组标识，true表示是全监听目标组，false表示不是全监听目标组。仅V2新版类型目标组支持该参数。
      */
     FullListenSwitch?: boolean;
     /**
@@ -3761,7 +3761,7 @@ export interface CreateTargetGroupRequest {
      */
     KeepaliveEnable?: boolean;
     /**
-     * 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。TCP/UDP目标组不支持该参数。
+     * 会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。仅V2新版且后端转发协议为HTTP/HTTPS/GRPC目标组支持该参数。
      */
     SessionExpireTime?: number;
 }
@@ -5603,13 +5603,12 @@ export interface TargetGroupInfo {
      */
     AssociatedRule?: Array<AssociationItem>;
     /**
-     * 后端转发协议类型，支持类型TCP， UDP。仅V2新版目标组支持返回该参数。
-  
+     * 目标组后端转发协议, 仅v2新版目标组返回有效值。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     Protocol?: string;
     /**
-     * 目标组类型，当前支持v1(旧版目标组), v2(新版目标组), gwlb(全局负载均衡目标组)。
+     * 目标组类型，当前支持v1(旧版目标组), v2(新版目标组)。默认为v1旧版目标组。
      */
     TargetGroupType?: string;
     /**
@@ -5626,12 +5625,21 @@ export interface TargetGroupInfo {
     Tag?: Array<TagInfo>;
     /**
      * 默认权重。只有v2类型目标组返回该字段。当返回为NULL时， 表示未设置默认权重。
+  注意：此字段可能返回 null，表示取不到有效值。
      */
     Weight?: number;
     /**
-     * 是否全监听目标组
+     * 是否全监听目标组。
      */
     FullListenSwitch?: boolean;
+    /**
+     * 是否开启长连接,  仅后端转发协议为HTTP/HTTPS/GRPC目标组返回有效值。
+     */
+    KeepaliveEnable?: boolean;
+    /**
+     * 会话保持时间，仅后端转发协议为HTTP/HTTPS/GRPC目标组返回有效值。
+     */
+    SessionExpireTime?: number;
 }
 /**
  * DeleteListener返回参数结构体

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

@@ -303,7 +303,8 @@ export interface DescribeLogContextRequest {
  */
 export interface DeleteShipperRequest {
     /**
-     * 投递规则ID
+     * 投递规则Id。
+  - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。
      */
     ShipperId: string;
 }
@@ -452,19 +453,24 @@ export interface ModifyConfigExtraResponse {
  */
 export interface SearchCosRechargeInfoRequest {
     /**
-     * 日志主题 ID
+     * 日志主题Id。
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
-     * 日志集ID
+     * 日志集Id。
+  
+  - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
      */
     LogsetId: string;
     /**
-     * 投递任务名称
+     * COS导入任务名称,最大支持128个字节。
      */
     Name: string;
     /**
      * COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。
+  
+  - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
      */
     Bucket: string;
     /**
@@ -476,7 +482,7 @@ export interface SearchCosRechargeInfoRequest {
      */
     Prefix?: string;
     /**
-     * 压缩模式:   "", "gzip", "lzop", "snappy";   默认""
+     * 压缩模式:   "", "gzip", "lzop", "snappy"。  默认："" 不压缩
      */
     Compress?: string;
 }
@@ -655,10 +661,9 @@ export interface DescribeShippersRequest {
   - topicId：按照【日志主题】进行过滤。
       类型：String。
       必选：否
-  - taskStatus
-  按照【任务运行状态】进行过滤。 支持`0`：停止，`1`：运行中，`2`：异常
-  类型：String
-  必选：否
+  - taskStatus：按照【任务运行状态】进行过滤。 支持`0`：停止，`1`：运行中，`2`：异常
+      类型：String
+      必选：否
   
   每次请求的Filters的上限为10，Filter.Values的上限为10。
      */
@@ -704,7 +709,7 @@ export interface DescribeDashboardsRequest {
     /**
      * - dashboardId 按照【仪表盘id】进行过滤，类型：String， 必选：否。
   - dashboardName 按照【仪表盘名字】进行模糊搜索过滤，类型：String，必选：否。
-  - dashboardRegion 按照【仪表盘地域】进行过滤，为了兼容老的仪表盘，通过云API创建的仪表盘没有地域属性，类型：String，必选：否。
+  - dashboardRegion 按照【仪表盘地域】进行过滤，为了兼容老的仪表盘，通过云API创建的仪表盘没有地域属性，类型：String，必选：否。 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940)，例如：ap-guangzhou
   - tagKey 按照【标签键】进行过滤，类型：String，必选：否。
   - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换，类型：String，必选：否，使用请参考[示例2](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B)。
   
@@ -713,6 +718,33 @@ export interface DescribeDashboardsRequest {
     Filters?: Array<Filter>;
     /**
      * 按照topicId和regionId过滤。
+  
+  - topicId:日志主题Id。
+      -  通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
+  - regionId
+      - 1:广州
+      - 4:上海
+      - 5:中国香港
+      - 7:上海金融
+      - 8:北京
+      - 9:新加坡
+      - 11:深圳金融
+      - 15:硅谷
+      - 16:成都
+      - 17:法兰克福
+      - 18:首尔
+      - 19:重庆
+      - 22:弗吉尼亚
+      - 23:曼谷
+      - 25:东京
+      - 33:南京
+      - 36:天津
+      - 39:台北
+      - 46:北京金融
+      - 72:雅加达
+      - 74:圣保罗
+      - 78:上海自动驾驶云
+  
      */
     TopicIdRegionFilter?: Array<TopicIdAndRegion>;
 }
@@ -915,7 +947,9 @@ export interface ModifyAlarmResponse {
  */
 export interface DescribeShipperTasksRequest {
     /**
-     * 投递规则ID
+     * 投递规则Id。
+  
+  - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。
      */
     ShipperId: string;
     /**
@@ -1927,19 +1961,25 @@ export interface ModifyTopicRequest {
  */
 export interface CreateCosRechargeRequest {
     /**
-     * 日志主题 ID
+     * 日志主题Id。
+  
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
-     * 日志集ID
+     * 日志集Id。
+  
+  - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
      */
     LogsetId: string;
     /**
-     * 投递任务名称
+     * COS导入任务名称,最大支持128个字节。
      */
     Name: string;
     /**
      * COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。
+  
+  - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
      */
     Bucket: string;
     /**
@@ -1956,7 +1996,7 @@ export interface CreateCosRechargeRequest {
      */
     Prefix?: string;
     /**
-     * supported: "", "gzip", "lzop", "snappy"; 默认空
+     * supported: "", "gzip", "lzop", "snappy"。默认空，不压缩。
      */
     Compress?: string;
     /**
@@ -3556,7 +3596,8 @@ export interface CreateMachineGroupResponse {
  */
 export interface DescribeCosRechargesRequest {
     /**
-     * 日志主题 ID
+     * 日志主题Id。
+  -  通过[获取日志主题列表](https://cloud.tencent.com/document/api/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
@@ -4165,7 +4206,29 @@ export interface DashboardTopicInfo {
      */
     TopicId: string;
     /**
-     * topic所在的地域
+     * topic所在的地域。
+  - 1:广州
+  - 4:上海
+  - 5:中国香港
+  - 7:上海金融
+  - 8:北京
+  - 9:新加坡
+  - 11:深圳金融
+  - 15:硅谷
+  - 16:成都
+  - 17:法兰克福
+  - 18:首尔
+  - 19:重庆
+  - 22:弗吉尼亚
+  - 23:曼谷
+  - 25:东京
+  - 33:南京
+  - 36:天津
+  - 39:台北
+  - 46:北京金融
+  - 72:雅加达
+  - 74:圣保罗
+  - 78:上海自动驾驶云
      */
     Region: string;
 }
@@ -4318,11 +4381,13 @@ export interface LogRechargeRuleInfo {
  */
 export interface DeleteCosRechargeRequest {
     /**
-     * COS导入配置Id
+     * COS导入配置Id。
+  - 通过[获取投递任务列表](https://cloud.tencent.com/document/api/614/58745)获取COS导入配置Id。
      */
     Id: string;
     /**
-     * 日志主题Id
+     * 日志主题Id。
+  -  通过[获取日志主题列表](https://cloud.tencent.com/document/api/614/56454)获取日志主题Id。
      */
     TopicId: string;
 }
@@ -4333,39 +4398,43 @@ export interface ShipperTaskInfo {
     /**
      * 投递任务ID
      */
-    TaskId: string;
+    TaskId?: string;
     /**
      * 投递信息ID
      */
-    ShipperId: string;
+    ShipperId?: string;
     /**
      * 日志主题ID
      */
-    TopicId: string;
+    TopicId?: string;
     /**
      * 本批投递的日志的开始时间戳，毫秒
      */
-    RangeStart: number;
+    RangeStart?: number;
     /**
      * 本批投递的日志的结束时间戳， 毫秒
      */
-    RangeEnd: number;
+    RangeEnd?: number;
     /**
      * 本次投递任务的开始时间戳， 毫秒
      */
-    StartTime: number;
+    StartTime?: number;
     /**
      * 本次投递任务的结束时间戳， 毫秒
      */
-    EndTime: number;
+    EndTime?: number;
     /**
-     * 本次投递的结果，"success","running","failed"
+     * 本次投递的结果。"success"，"running"，"failed"
+  
+  - success：任务成功。
+  - running：任务处理中。
+  - failed：任务失败。
      */
-    Status: string;
+    Status?: string;
     /**
      * 结果的详细信息
      */
-    Message: string;
+    Message?: string;
 }
 /**
  * CloseKafkaConsumer请求参数结构体
@@ -4554,7 +4623,7 @@ export interface DashboardInfo {
      */
     Data?: string;
     /**
-     * 创建仪表盘的时间
+     * 创建仪表盘的时间。格式：YYYY-MM-DD HH:MM:SS
      */
     CreateTime?: string;
     /**
@@ -4578,7 +4647,7 @@ export interface DashboardInfo {
      */
     DashboardRegion?: string;
     /**
-     * 修改仪表盘的时间
+     * 修改仪表盘的时间。格式：YYYY-MM-DD HH:MM:SS
      */
     UpdateTime?: string;
     /**
@@ -4684,6 +4753,11 @@ export interface JsonInfo {
     EnableTag: boolean;
     /**
      * 元数据信息列表, 可选值为 __SOURCE__、__FILENAME__、__TIMESTAMP__、__HOSTNAME__。
+  
+  - __SOURCE__：日志采集的源 IP，示例：10.0.1.2
+  - __FILENAME__：日志采集的文件名，示例：/data/log/nginx/access.log
+  - __TIMESTAMP__：日志时间戳（毫秒级别 Unix 时间戳），按时间范围检索日志时，将自动使用该时间对日志进行检索，在控制台显示为“日志时间”，示例：1640005601188
+  - __HOSTNAME__：日志来源机器名称，需使用2.7.4及以上版本的 Loglistener 才会采集该字段，示例：localhost
   注意：此字段可能返回 null，表示取不到有效值。
      */
     MetaFields: Array<string>;
@@ -4762,11 +4836,14 @@ export interface ModifyWebCallbackRequest {
  */
 export interface CreateShipperRequest {
     /**
-     * 创建的投递规则所属的日志主题ID
+     * 创建的投递规则所属的日志主题Id。
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
      * COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。
+  
+  - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
      */
     Bucket: string;
     /**
@@ -4776,7 +4853,7 @@ export interface CreateShipperRequest {
      */
     Prefix: string;
     /**
-     * 投递规则的名字
+     * 投递规则的名字。最大支持255个字符
      */
     ShipperName: string;
     /**
@@ -4818,15 +4895,17 @@ export interface CreateShipperRequest {
      */
     EndTime?: number;
     /**
-     * cos桶存储类型。支持：STANDARD_IA、ARCHIVE、DEEP_ARCHIVE、STANDARD、MAZ_STANDARD、MAZ_STANDARD_IA、INTELLIGENT_TIERING。
+     * 对象存储类型，默认值为 STANDARD。枚举值请参见[ 存储类型概述](https://cloud.tencent.com/document/product/436/33417) 文档。
+  参考值有：
   
-  1. STANDARD_IA：低频存储；
-  2. ARCHIVE：归档存储；
-  3. DEEP_ARCHIVE：深度归档存储；
-  4. STANDARD：标准存储；
-  5. MAZ_STANDARD：标准存储（多 AZ）；
-  6. MAZ_STANDARD_IA：低频存储（多 AZ）；
-  7. INTELLIGENT_TIERING：智能分层存储。
+  - STANDARD：标准存储
+  - STANDARD_IA：低频存储
+  - ARCHIVE：归档存储
+  - DEEP_ARCHIVE：深度归档存储
+  - MAZ_STANDARD：标准存储（多 AZ）
+  - MAZ_STANDARD_IA：低频存储（多 AZ）
+  - INTELLIGENT_TIERING：智能分层存储
+  - MAZ_INTELLIGENT_TIERING：智能分层存储（多 AZ）
      */
     StorageType?: string;
 }
@@ -5290,7 +5369,7 @@ export interface Column {
  */
 export interface ContentInfo {
     /**
-     * 内容格式，支持json、csv
+     * 内容格式，支持json，csv，parquet
      */
     Format: string;
     /**
@@ -5881,11 +5960,15 @@ export interface LogContextInfo {
  */
 export interface ModifyShipperRequest {
     /**
-     * 投递规则ID
+     * 投递规则Id。
+  
+  - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。
      */
     ShipperId: string;
     /**
      * COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。
+  
+  - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
      */
     Bucket?: string;
     /**
@@ -5931,15 +6014,17 @@ export interface ModifyShipperRequest {
      */
     FilenameMode?: number;
     /**
-     * cos桶存储类型。支持：STANDARD_IA、ARCHIVE、DEEP_ARCHIVE、STANDARD、MAZ_STANDARD、MAZ_STANDARD_IA、INTELLIGENT_TIERING。
+     * 对象存储类型，默认值为 STANDARD。枚举值请参见[ 存储类型概述](https://cloud.tencent.com/document/product/436/33417) 文档。
+  参考值有：
   
-  1. STANDARD_IA：低频存储；
-  2. ARCHIVE：归档存储；
-  3. DEEP_ARCHIVE：深度归档存储；
-  4. STANDARD：标准存储；
-  5. MAZ_STANDARD：标准存储（多 AZ）；
-  6. MAZ_STANDARD_IA：低频存储（多 AZ）；
-  7. INTELLIGENT_TIERING：智能分层存储。
+  - STANDARD：标准存储
+  - STANDARD_IA：低频存储
+  - ARCHIVE：归档存储
+  - DEEP_ARCHIVE：深度归档存储
+  - MAZ_STANDARD：标准存储（多 AZ）
+  - MAZ_STANDARD_IA：低频存储（多 AZ）
+  - INTELLIGENT_TIERING：智能分层存储
+  - MAZ_INTELLIGENT_TIERING：智能分层存储（多 AZ）
      */
     StorageType?: string;
 }
@@ -6602,7 +6687,16 @@ export interface SearchCosRechargeInfoResponse {
      */
     Msg?: string;
     /**
-     * 状态
+     * 状态。
+  - 0：成功
+  - 10000：参数错误，请确认参数
+  - 10001：授权失败，请确认授权
+  - 10002：获取文件列表失败，请稍后再试。若无法解决，请联系智能客服或提交工单
+  - 10003：桶内无相应前缀文件，请使用正确的桶、文件前缀和压缩方式
+  - 10004：文件下载失败，请稍后再试。若无法解决，请联系智能客服或提交工单
+  - 10005：文件解压缩失败，请选择正确的压缩方式然后再试
+  - 10006：读取文件内容失败，请确认文件可读
+  - 10007：文件预览失败，请稍后再试。若无法解决，请联系智能客服或提交工单
      */
     Status?: number;
     /**
@@ -6786,7 +6880,7 @@ export interface ShipperInfo {
      */
     Content?: ContentInfo;
     /**
-     * 投递日志的创建时间
+     * 投递日志的创建时间。格式：YYYY-MM-DD HH:MM:SS
      */
     CreateTime?: string;
     /**
@@ -6819,7 +6913,16 @@ export interface ShipperInfo {
      */
     HistoryStatus?: number;
     /**
-     * cos桶类型
+     * 对象存储类型，默认值为 STANDARD。枚举值请参见[ 存储类型概述](https://cloud.tencent.com/document/product/436/33417) 文档。
+  参考值有：
+  STANDARD：标准存储
+  STANDARD_IA：低频存储
+  ARCHIVE：归档存储
+  DEEP_ARCHIVE：深度归档存储
+  MAZ_STANDARD：标准存储（多 AZ）
+  MAZ_STANDARD_IA：低频存储（多 AZ）
+  INTELLIGENT_TIERING：智能分层存储
+  MAZ_INTELLIGENT_TIERING：智能分层存储（多 AZ）
      */
     StorageType?: string;
 }
@@ -7014,36 +7117,38 @@ export interface Ckafka {
  */
 export interface DescribeMachinesRequest {
     /**
-     * 查询的机器组ID
+     * 查询的机器组ID。
+  
+  - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组ID。
      */
     GroupId: string;
     /**
      * ip
-  - 按照【ip】进行过滤。
+  - 按照ip进行过滤。
   - 类型：String
   - 必选：否
   
   instance
-  - 按照【instance】进行过滤。
+  - 按照实例id进行过滤。
   - 类型：String
   - 必选：否
   
   version
-  - 按照【LogListener版本】进行过滤。
+  - 按照LogListener版本进行过滤。
   - 类型：String
   - 必选：否
   
   status
-  - 按照【状态】进行过滤。
+  - 按照机器状态进行过滤。
   - 类型：String
   - 必选：否
   - 可选值：0：离线，1：正常
   
   offlineTime
-  - 按照【机器离线时间】进行过滤。
+  - 按照机器离线时间进行过滤。
   - 类型：String
   - 必选：否
-  - - 可选值：0：无离线时间，12：12小时内，24：一天内，48：两天内，99：两天前
+  - -可选值：0：无离线时间，12：12小时内，24：一天内，48：两天内，99：两天前
   
   每次请求的Filters的上限为10，Filter.Values的上限为100。
      */
@@ -7140,7 +7245,7 @@ export interface MachineInfo {
      */
     Status?: number;
     /**
-     * 机器离线时间，空为正常，异常返回具体时间
+     * 机器离线时间，空为正常，异常返回具体时间。时间格式：YYYY-MM-DD HH:mm:ss
      */
     OfflineTime?: string;
     /**
@@ -7829,15 +7934,19 @@ export interface CheckRechargeKafkaServerResponse {
  */
 export interface ModifyCosRechargeRequest {
     /**
-     * COS导入配置Id
+     * COS导入配置Id。
+  
+  - 通过[获取cos导入配置](https://cloud.tencent.com/document/product/614/88099)接口获取COS导入配置Id。
      */
     Id: string;
     /**
-     * 日志主题Id
+     * 日志主题Id。
+  
+  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
      */
     TopicId: string;
     /**
-     * COS导入任务名称
+     * COS导入任务名称,最大支持128个字节。
      */
     Name?: string;
     /**
@@ -7846,6 +7955,8 @@ export interface ModifyCosRechargeRequest {
     Enable?: number;
     /**
      * COS存储桶，详见产品支持的[存储桶命名规范](https://cloud.tencent.com/document/product/436/13312)。
+  
+  - 通过[GET Service（List Buckets）](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
      */
     Bucket?: string;
     /**
@@ -7861,7 +7972,7 @@ export interface ModifyCosRechargeRequest {
      */
     LogType?: string;
     /**
-     * 解析格式。supported: "", "gzip", "lzop", "snappy"; 默认空
+     * 解析格式。supported: "", "gzip", "lzop", "snappy"。空串表示不压缩。
      */
     Compress?: string;
     /**
@@ -7957,7 +8068,9 @@ export interface CosRechargeInfo {
      */
     Bucket?: string;
     /**
-     * COS存储桶所在地域
+     * COS存储桶所在地域。
+  
+  - 通过[地域和访问域名](https://cloud.tencent.com/document/product/436/6224)获取地域信息。
      */
     BucketRegion?: string;
     /**
@@ -7978,11 +8091,11 @@ export interface CosRechargeInfo {
      */
     Enable?: number;
     /**
-     * 创建时间
+     * 创建时间。时间格式：YYYY-MM-DD HH:mm:ss
      */
     CreateTime?: string;
     /**
-     * 更新时间
+     * 更新时间。时间格式：YYYY-MM-DD HH:mm:ss
      */
     UpdateTime?: string;
     /**
@@ -7990,7 +8103,7 @@ export interface CosRechargeInfo {
      */
     Progress?: number;
     /**
-     * supported: "", "gzip", "lzop", "snappy”; 默认空
+     * 压缩方式supported: "", "gzip", "lzop", "snappy”;  默认空不压缩
      */
     Compress?: string;
     /**
@@ -8279,11 +8392,15 @@ export interface HighLightItem {
  */
 export interface RetryShipperTaskRequest {
     /**
-     * 投递规则ID
+     * 投递规则Id。
+  
+  - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。
      */
     ShipperId: string;
     /**
-     * 投递任务ID
+     * 投递任务Id。
+  
+  - 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745) 获取TaskId。
      */
     TaskId: string;
 }