tencentcloud-sdk-cls 3.0.1118 → 3.0.1122

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -416,9 +416,9 @@ module TencentCloud
416
416
  # @param Status: 规则状态。
417
417
  # 0:暂未生效,1:生效中,2:已失效
418
418
  # @type Status: Integer
419
- # @param CreateTime: 规则创建时间。
419
+ # @param CreateTime: 规则创建时间。秒级时间戳(s)
420
420
  # @type CreateTime: Integer
421
- # @param UpdateTime: 规则更新时间。
421
+ # @param UpdateTime: 规则更新时间。秒级时间戳(s)
422
422
  # @type UpdateTime: Integer
423
423
 
424
424
  attr_accessor :AlarmNoticeId, :TaskId, :StartTime, :EndTime, :Type, :Rule, :Reason, :Source, :Operator, :Status, :CreateTime, :UpdateTime
@@ -767,8 +767,10 @@ module TencentCloud
767
767
  # ApplyConfigToMachineGroup请求参数结构体
768
768
  class ApplyConfigToMachineGroupRequest < TencentCloud::Common::AbstractModel
769
769
  # @param ConfigId: 采集配置ID
770
+ # - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
770
771
  # @type ConfigId: String
771
772
  # @param GroupId: 机器组ID
773
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
772
774
  # @type GroupId: String
773
775
 
774
776
  attr_accessor :ConfigId, :GroupId
@@ -838,9 +840,15 @@ module TencentCloud
838
840
 
839
841
  # CheckFunction请求参数结构体
840
842
  class CheckFunctionRequest < TencentCloud::Common::AbstractModel
841
- # @param EtlContent: 用户输入的加工语句
843
+ # @param EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
844
+
845
+ # 其他参考文档:
846
+
847
+ # - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
848
+ # - [函数总览](https://cloud.tencent.com/document/product/614/70395)
842
849
  # @type EtlContent: String
843
- # @param DstResources: 加工任务目的topic_id以及别名
850
+ # @param DstResources: 加工任务目标topic_id以及别名,当 FuncType 为 1 时,必填。
851
+ # 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
844
852
  # @type DstResources: Array
845
853
  # @param FuncType: 数据加工目标主题的类型. 1 固定主题 2动态创建
846
854
  # @type FuncType: Integer
@@ -897,6 +905,8 @@ module TencentCloud
897
905
  # @type KafkaType: Integer
898
906
  # @param KafkaInstance: 腾讯云CKafka实例ID。
899
907
  # KafkaType为0时,KafkaInstance必填
908
+
909
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
900
910
  # @type KafkaInstance: String
901
911
  # @param ServerAddr: 服务地址。
902
912
  # KafkaType为1时,ServerAddr必填
@@ -930,7 +940,20 @@ module TencentCloud
930
940
 
931
941
  # CheckRechargeKafkaServer返回参数结构体
932
942
  class CheckRechargeKafkaServerResponse < TencentCloud::Common::AbstractModel
933
- # @param Status: Kafka集群可访问状态,0:可正常访问 ...
943
+ # @param Status: Kafka集群可访问状态。
944
+
945
+ # - 0:可正常访问
946
+ # - -1:broker 连接失败
947
+ # - -2:sasl 鉴权失败
948
+ # - -3:ckafka 角色未授权
949
+ # - -4:topic 列表不存在
950
+ # - -5:topic 内暂无数据
951
+ # - -6:用户没有 ckafka 权限
952
+ # - -7:消费组已经存在
953
+ # - -8:kafka 实例不存在或已销毁
954
+ # - -9:Broker 列表为空
955
+ # - -10:Broker 地址格式不正确
956
+ # - -11:Broker 端口非整型
934
957
  # @type Status: Integer
935
958
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
936
959
  # @type RequestId: String
@@ -950,17 +973,31 @@ module TencentCloud
950
973
 
951
974
  # CKafka的描述-需要投递到的kafka信息
952
975
  class Ckafka < TencentCloud::Common::AbstractModel
953
- # @param InstanceId: Ckafka 的 InstanceId
976
+ # @param InstanceId: Ckafka 的 InstanceId
977
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
978
+ # - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
954
979
  # @type InstanceId: String
955
- # @param TopicName: Ckafka 的 TopicName
980
+ # @param TopicName: Ckafka 的 TopicName
981
+ # - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
982
+ # - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
956
983
  # @type TopicName: String
957
- # @param Vip: Ckafka 的 Vip
984
+ # @param Vip: Ckafka 的 Vip
985
+ # - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
986
+ # - 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
958
987
  # @type Vip: String
959
- # @param Vport: Ckafka 的 Vport
988
+ # @param Vport: Ckafka 的 Vport
989
+ # - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
990
+ # - 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
960
991
  # @type Vport: String
961
- # @param InstanceName: Ckafka 的 InstanceName
992
+ # @param InstanceName: Ckafka 的 InstanceName
993
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
994
+ # - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
995
+ # - 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。
962
996
  # @type InstanceName: String
963
- # @param TopicId: Ckafka 的 TopicId
997
+ # @param TopicId: Ckafka 的 TopicId
998
+ # - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
999
+ # - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
1000
+ # - 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。
964
1001
  # @type TopicId: String
965
1002
 
966
1003
  attr_accessor :InstanceId, :TopicName, :Vip, :Vport, :InstanceName, :TopicId
@@ -986,7 +1023,9 @@ module TencentCloud
986
1023
 
987
1024
  # CloseKafkaConsumer请求参数结构体
988
1025
  class CloseKafkaConsumerRequest < TencentCloud::Common::AbstractModel
989
- # @param FromTopicId: 日志主题ID
1026
+ # @param FromTopicId: 日志主题Id。
1027
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
1028
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
990
1029
  # @type FromTopicId: String
991
1030
 
992
1031
  attr_accessor :FromTopicId
@@ -1175,7 +1214,10 @@ module TencentCloud
1175
1214
  # @type Name: String
1176
1215
  # @param TopicId: 日志主题ID
1177
1216
  # @type TopicId: String
1178
- # @param Type: 类型:container_stdout、container_file、host_file
1217
+ # @param Type: 自建k8s集群日志采集类型,支持
1218
+ # - container_stdout 标准输出
1219
+ # - container_file 标准文件
1220
+ # - host_file 节点文件
1179
1221
  # @type Type: String
1180
1222
  # @param HostFile: 节点文件配置信息
1181
1223
  # @type HostFile: :class:`Tencentcloud::Cls.v20201016.models.HostFileInfo`
@@ -1193,16 +1235,20 @@ module TencentCloud
1193
1235
  # 注意:此字段可能返回 null,表示取不到有效值。
1194
1236
  # @type ExcludePaths: Array
1195
1237
  # @param UpdateTime: 更新时间
1238
+ # - 时间格式:yyyy-MM-dd HH:mm:ss
1196
1239
  # @type UpdateTime: String
1197
1240
  # @param CreateTime: 创建时间
1241
+ # - 时间格式:yyyy-MM-dd HH:mm:ss
1198
1242
  # @type CreateTime: String
1199
1243
  # @param UserDefineRule: 用户自定义解析字符串
1200
1244
  # @type UserDefineRule: String
1201
1245
  # @param GroupId: 机器组ID
1246
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
1202
1247
  # @type GroupId: String
1203
1248
  # @param ConfigFlag: 自建采集配置标
1204
1249
  # @type ConfigFlag: String
1205
1250
  # @param LogsetId: 日志集ID
1251
+ # - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
1206
1252
  # @type LogsetId: String
1207
1253
  # @param LogsetName: 日志集name
1208
1254
  # @type LogsetName: String
@@ -1323,8 +1369,10 @@ module TencentCloud
1323
1369
  # @param Output: 采集配置所属日志主题ID即TopicId
1324
1370
  # @type Output: String
1325
1371
  # @param UpdateTime: 更新时间
1372
+ # - 时间格式:yyyy-MM-dd HH:mm:ss
1326
1373
  # @type UpdateTime: String
1327
1374
  # @param CreateTime: 创建时间
1375
+ # - 时间格式:yyyy-MM-dd HH:mm:ss
1328
1376
  # @type CreateTime: String
1329
1377
  # @param UserDefineRule: 用户自定义解析字符串,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310)。
1330
1378
  # @type UserDefineRule: String
@@ -1459,6 +1507,63 @@ module TencentCloud
1459
1507
  end
1460
1508
  end
1461
1509
 
1510
+ # 控制台分享信息
1511
+ class ConsoleSharingInfo < TencentCloud::Common::AbstractModel
1512
+ # @param SharingId: 分享ID
1513
+ # @type SharingId: String
1514
+ # @param SharingUrl: 分享链接
1515
+ # 注意:此字段可能返回 null,表示取不到有效值。
1516
+ # @type SharingUrl: String
1517
+ # @param SharingConfig: 匿名分享配置信息
1518
+ # 注意:此字段可能返回 null,表示取不到有效值。
1519
+ # @type SharingConfig: :class:`Tencentcloud::Cls.v20201016.models.ConsoleSharingConfig`
1520
+ # @param ExpiredTime: 过期时间
1521
+ # 注意:此字段可能返回 null,表示取不到有效值。
1522
+ # @type ExpiredTime: Integer
1523
+ # @param CreateTime: 创建时间
1524
+ # 注意:此字段可能返回 null,表示取不到有效值。
1525
+ # @type CreateTime: Integer
1526
+ # @param UpdateTime: 修改时间
1527
+ # 注意:此字段可能返回 null,表示取不到有效值。
1528
+ # @type UpdateTime: Integer
1529
+ # @param Status: 分享链接状态
1530
+ # 1: 正常
1531
+ # -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
1532
+ # 注意:此字段可能返回 null,表示取不到有效值。
1533
+ # @type Status: Integer
1534
+ # @param ContentSafetyCode: 10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,
1535
+ # 24005-社会
1536
+ # 注意:此字段可能返回 null,表示取不到有效值。
1537
+ # @type ContentSafetyCode: Integer
1538
+
1539
+ attr_accessor :SharingId, :SharingUrl, :SharingConfig, :ExpiredTime, :CreateTime, :UpdateTime, :Status, :ContentSafetyCode
1540
+
1541
+ def initialize(sharingid=nil, sharingurl=nil, sharingconfig=nil, expiredtime=nil, createtime=nil, updatetime=nil, status=nil, contentsafetycode=nil)
1542
+ @SharingId = sharingid
1543
+ @SharingUrl = sharingurl
1544
+ @SharingConfig = sharingconfig
1545
+ @ExpiredTime = expiredtime
1546
+ @CreateTime = createtime
1547
+ @UpdateTime = updatetime
1548
+ @Status = status
1549
+ @ContentSafetyCode = contentsafetycode
1550
+ end
1551
+
1552
+ def deserialize(params)
1553
+ @SharingId = params['SharingId']
1554
+ @SharingUrl = params['SharingUrl']
1555
+ unless params['SharingConfig'].nil?
1556
+ @SharingConfig = ConsoleSharingConfig.new
1557
+ @SharingConfig.deserialize(params['SharingConfig'])
1558
+ end
1559
+ @ExpiredTime = params['ExpiredTime']
1560
+ @CreateTime = params['CreateTime']
1561
+ @UpdateTime = params['UpdateTime']
1562
+ @Status = params['Status']
1563
+ @ContentSafetyCode = params['ContentSafetyCode']
1564
+ end
1565
+ end
1566
+
1462
1567
  # 控制台分享链接params参数
1463
1568
  class ConsoleSharingParam < TencentCloud::Common::AbstractModel
1464
1569
  # @param Name: 名称
@@ -1652,7 +1757,12 @@ module TencentCloud
1652
1757
 
1653
1758
  # 自建k8s-工作负载信息
1654
1759
  class ContainerWorkLoadInfo < TencentCloud::Common::AbstractModel
1655
- # @param Kind: 工作负载的类型
1760
+ # @param Kind: 工作负载的类型,支持
1761
+ # - deployment
1762
+ # - statefulset
1763
+ # - daemonset
1764
+ # - job
1765
+ # - cronjob
1656
1766
  # @type Kind: String
1657
1767
  # @param Name: 工作负载的名称
1658
1768
  # @type Name: String
@@ -2149,12 +2259,13 @@ module TencentCloud
2149
2259
  # CreateCloudProductLogCollection请求参数结构体
2150
2260
  class CreateCloudProductLogCollectionRequest < TencentCloud::Common::AbstractModel
2151
2261
  # @param InstanceId: 实例ID
2262
+ # - 通过各个接入云产品官方文档获取
2152
2263
  # @type InstanceId: String
2153
2264
  # @param AssumerName: 云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS
2154
2265
  # @type AssumerName: String
2155
2266
  # @param LogType: 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
2156
2267
  # @type LogType: String
2157
- # @param CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
2268
+ # @param CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
2158
2269
  # - CDS所有日志类型:ap-guangzhou
2159
2270
  # - CDB-AUDIT: gz
2160
2271
  # - TDSQL-C-AUDIT: gz
@@ -2169,16 +2280,19 @@ module TencentCloud
2169
2280
  # - APIS所有日志类型:gz
2170
2281
  # @type CloudProductRegion: String
2171
2282
  # @param ClsRegion: CLS目标地域
2283
+ # - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
2172
2284
  # @type ClsRegion: String
2173
2285
  # @param LogsetName: 日志集名称,未填LogsetId时必填。若日志集不存在, 将自动创建
2174
2286
  # @type LogsetName: String
2175
2287
  # @param TopicName: 日志主题名称,在未填TopicId时必填。 若日志主题不存在,将自动创建
2176
2288
  # @type TopicName: String
2177
- # @param Extend: 日志配置拓展信息, 一般用于存储额外的日志投递配置
2289
+ # @param Extend: 日志配置扩展信息, 一般用于存储额外的日志投递配置
2178
2290
  # @type Extend: String
2179
2291
  # @param LogsetId: 日志集id
2292
+ # - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
2180
2293
  # @type LogsetId: String
2181
2294
  # @param TopicId: 日志主题id
2295
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2182
2296
  # @type TopicId: String
2183
2297
 
2184
2298
  attr_accessor :InstanceId, :AssumerName, :LogType, :CloudProductRegion, :ClsRegion, :LogsetName, :TopicName, :Extend, :LogsetId, :TopicId
@@ -2402,8 +2516,11 @@ module TencentCloud
2402
2516
  # CreateConfig请求参数结构体
2403
2517
  class CreateConfigRequest < TencentCloud::Common::AbstractModel
2404
2518
  # @param Name: 采集配置名称
2519
+ # - 名称种不得包含特殊字符|
2520
+ # - 名称最长255字符,超过截断
2405
2521
  # @type Name: String
2406
2522
  # @param Output: 采集配置所属日志主题ID即TopicId
2523
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2407
2524
  # @type Output: String
2408
2525
  # @param Path: 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
2409
2526
  # @type Path: String
@@ -2534,7 +2651,9 @@ module TencentCloud
2534
2651
 
2535
2652
  # CreateConsumer请求参数结构体
2536
2653
  class CreateConsumerRequest < TencentCloud::Common::AbstractModel
2537
- # @param TopicId: 投递任务绑定的日志主题 ID
2654
+ # @param TopicId: 投递任务绑定的日志主题Id。
2655
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2656
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2538
2657
  # @type TopicId: String
2539
2658
  # @param NeedContent: 是否投递日志的元数据信息,默认为 true。
2540
2659
  # 当NeedContent为true时:字段Content有效。
@@ -2677,10 +2796,21 @@ module TencentCloud
2677
2796
  # CreateDashboardSubscribe请求参数结构体
2678
2797
  class CreateDashboardSubscribeRequest < TencentCloud::Common::AbstractModel
2679
2798
  # @param Name: 仪表盘订阅名称。
2799
+ # 输入限制:
2800
+ # - 不能为空
2801
+ # - 长度不能超过128字节
2802
+ # - 不能包含字符'|'
2680
2803
  # @type Name: String
2681
- # @param DashboardId: 仪表盘id
2804
+ # @param DashboardId: 仪表盘Id
2805
+ # - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
2682
2806
  # @type DashboardId: String
2683
- # @param Cron: 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。<br><li/>{秒数} 取值范围: 0 ~ 59 <br><li/>{分钟} 取值范围: 0 ~ 59 <br><li/>{小时} 取值范围: 0 ~ 23 <br><li/>{日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L) <br><li/>{月份} 取值范围: 1 ~ 12 <br><li/>{星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
2807
+ # @param Cron: 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。
2808
+ # - {秒数} 取值范围: 0 ~ 59
2809
+ # - {分钟} 取值范围: 0 ~ 59
2810
+ # - {小时} 取值范围: 0 ~ 23
2811
+ # - {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L)
2812
+ # - {月份} 取值范围: 1 ~ 12
2813
+ # - {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
2684
2814
  # @type Cron: String
2685
2815
  # @param SubscribeData: 仪表盘订阅数据。
2686
2816
  # @type SubscribeData: :class:`Tencentcloud::Cls.v20201016.models.DashboardSubscribeData`
@@ -2811,17 +2941,22 @@ module TencentCloud
2811
2941
 
2812
2942
  # CreateDeliverCloudFunction请求参数结构体
2813
2943
  class CreateDeliverCloudFunctionRequest < TencentCloud::Common::AbstractModel
2814
- # @param TopicId: 投递规则属于的 topic id
2944
+ # @param TopicId: 投递规则属于的TopicId。
2945
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2946
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2815
2947
  # @type TopicId: String
2816
2948
  # @param FunctionName: 投递的云函数名字。仅支持[事件函数](https://cloud.tencent.com/document/product/583/9694#scf-.E4.BA.8B.E4.BB.B6.E5.87.BD.E6.95.B0) ([函数类型选型](https://cloud.tencent.com/document/product/583/73483))
2949
+ # 通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。
2817
2950
  # @type FunctionName: String
2818
- # @param Namespace: 命名空间
2951
+ # @param Namespace: 命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
2952
+ # - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
2819
2953
  # @type Namespace: String
2820
- # @param Qualifier: 函数版本
2954
+ # @param Qualifier: 函数版本。
2955
+ # - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
2821
2956
  # @type Qualifier: String
2822
- # @param Timeout: 投递最长等待时间,单位:秒
2957
+ # @param Timeout: 投递最长等待时间,单位:秒。 默认:60
2823
2958
  # @type Timeout: Integer
2824
- # @param MaxMsgNum: 投递最大消息数
2959
+ # @param MaxMsgNum: 投递最大消息数。默认为100。支持范围[1,10000]
2825
2960
  # @type MaxMsgNum: Integer
2826
2961
 
2827
2962
  attr_accessor :TopicId, :FunctionName, :Namespace, :Qualifier, :Timeout, :MaxMsgNum
@@ -2863,7 +2998,8 @@ module TencentCloud
2863
2998
 
2864
2999
  # CreateExport请求参数结构体
2865
3000
  class CreateExportRequest < TencentCloud::Common::AbstractModel
2866
- # @param TopicId: 日志主题ID
3001
+ # @param TopicId: 日志主题Id
3002
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2867
3003
  # @type TopicId: String
2868
3004
  # @param Count: 日志导出数量, 最大值5000万
2869
3005
  # @type Count: Integer
@@ -2989,7 +3125,9 @@ module TencentCloud
2989
3125
 
2990
3126
  # CreateKafkaRecharge请求参数结构体
2991
3127
  class CreateKafkaRechargeRequest < TencentCloud::Common::AbstractModel
2992
- # @param TopicId: 导入CLS目标topic ID
3128
+ # @param TopicId: 导入CLS目标TopicId。
3129
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
3130
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2993
3131
  # @type TopicId: String
2994
3132
  # @param Name: Kafka导入配置名称
2995
3133
  # @type Name: String
@@ -3002,6 +3140,7 @@ module TencentCloud
3002
3140
  # @param LogRechargeRule: 日志导入规则。
3003
3141
  # @type LogRechargeRule: :class:`Tencentcloud::Cls.v20201016.models.LogRechargeRuleInfo`
3004
3142
  # @param KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填。
3143
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
3005
3144
  # @type KafkaInstance: String
3006
3145
  # @param ServerAddr: 服务地址,KafkaType为1时必填。
3007
3146
  # @type ServerAddr: String
@@ -3010,7 +3149,8 @@ module TencentCloud
3010
3149
  # @param Protocol: 加密访问协议。
3011
3150
  # KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
3012
3151
  # @type Protocol: :class:`Tencentcloud::Cls.v20201016.models.KafkaProtocolInfo`
3013
- # @param ConsumerGroupName: 用户Kafka消费组名称
3152
+ # @param ConsumerGroupName: 用户Kafka消费组名称。
3153
+ # - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
3014
3154
  # @type ConsumerGroupName: String
3015
3155
 
3016
3156
  attr_accessor :TopicId, :Name, :KafkaType, :UserKafkaTopics, :Offset, :LogRechargeRule, :KafkaInstance, :ServerAddr, :IsEncryptionAddr, :Protocol, :ConsumerGroupName
@@ -3269,9 +3409,9 @@ module TencentCloud
3269
3409
 
3270
3410
  # CreateScheduledSql请求参数结构体
3271
3411
  class CreateScheduledSqlRequest < TencentCloud::Common::AbstractModel
3272
- # @param SrcTopicId: 源日志主题
3412
+ # @param SrcTopicId: 源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
3273
3413
  # @type SrcTopicId: String
3274
- # @param Name: 任务名称
3414
+ # @param Name: 任务名称,0~255字符
3275
3415
  # @type Name: String
3276
3416
  # @param EnableFlag: 任务启动状态. 1开启, 2关闭
3277
3417
  # @type EnableFlag: Integer
@@ -3283,13 +3423,13 @@ module TencentCloud
3283
3423
  # @type ProcessStartTime: Integer
3284
3424
  # @param ProcessType: 调度类型,1:持续运行 2:指定时间范围
3285
3425
  # @type ProcessType: Integer
3286
- # @param ProcessPeriod: 调度周期(分钟)
3426
+ # @param ProcessPeriod: 调度周期(分钟),1~1440分钟
3287
3427
  # @type ProcessPeriod: Integer
3288
3428
  # @param ProcessTimeWindow: 单次查询的时间窗口,如果您的目标主题为指标主题,建议该参数的大小不超过30分钟,否则可能转指标失败。
3289
3429
  # @type ProcessTimeWindow: String
3290
- # @param ProcessDelay: 执行延迟(秒)
3430
+ # @param ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
3291
3431
  # @type ProcessDelay: Integer
3292
- # @param SrcTopicRegion: 源topicId的地域信息
3432
+ # @param SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
3293
3433
  # @type SrcTopicRegion: String
3294
3434
  # @param ProcessEndTime: 调度结束时间,当ProcessType=2时为必传字段, Unix时间戳,单位ms
3295
3435
  # @type ProcessEndTime: Integer
@@ -3475,8 +3615,13 @@ module TencentCloud
3475
3615
  # CreateTopic请求参数结构体
3476
3616
  class CreateTopicRequest < TencentCloud::Common::AbstractModel
3477
3617
  # @param LogsetId: 日志集ID
3618
+ # - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
3478
3619
  # @type LogsetId: String
3479
3620
  # @param TopicName: 日志主题名称
3621
+ # 名称限制
3622
+ # - 不能为空字符串
3623
+ # - 不能包含字符'|'
3624
+ # - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
3480
3625
  # @type TopicName: String
3481
3626
  # @param PartitionCount: 日志主题分区个数。默认创建1个,最大支持创建10个分区。
3482
3627
  # @type PartitionCount: Integer
@@ -3738,7 +3883,9 @@ module TencentCloud
3738
3883
  # <li/>Uin:腾讯云用户<br>
3739
3884
  # <li/>Group:腾讯云用户组<br>
3740
3885
  # <li/>Email:自定义Email<br>
3741
- # <li/>WeCom: 企业微信回调
3886
+ # <li/>WeCom: 企业微信回调<br>
3887
+ # <li/>DingTalk:钉钉<br>
3888
+ # <li/>Lark:飞书
3742
3889
  # @type ReceiverType: String
3743
3890
  # @param Values: 知方式对应的值。
3744
3891
  # <br> <li/> 当ReceiverType不是 WeCom 时,Values必填。
@@ -4057,9 +4204,9 @@ module TencentCloud
4057
4204
 
4058
4205
  # DeleteAlarmShield请求参数结构体
4059
4206
  class DeleteAlarmShieldRequest < TencentCloud::Common::AbstractModel
4060
- # @param TaskId: 屏蔽规则id
4207
+ # @param TaskId: 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
4061
4208
  # @type TaskId: String
4062
- # @param AlarmNoticeId: 通知渠道组id
4209
+ # @param AlarmNoticeId: 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
4063
4210
  # @type AlarmNoticeId: String
4064
4211
 
4065
4212
  attr_accessor :TaskId, :AlarmNoticeId
@@ -4099,7 +4246,7 @@ module TencentCloud
4099
4246
  # @type AssumerName: String
4100
4247
  # @param LogType: 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
4101
4248
  # @type LogType: String
4102
- # @param CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
4249
+ # @param CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
4103
4250
  # - CDS所有日志类型:ap-guangzhou
4104
4251
  # - CDB-AUDIT: gz
4105
4252
  # - TDSQL-C-AUDIT: gz
@@ -4154,6 +4301,7 @@ module TencentCloud
4154
4301
  # DeleteConfigExtra请求参数结构体
4155
4302
  class DeleteConfigExtraRequest < TencentCloud::Common::AbstractModel
4156
4303
  # @param ConfigExtraId: 特殊采集规则扩展配置ID
4304
+ # - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
4157
4305
  # @type ConfigExtraId: String
4158
4306
 
4159
4307
  attr_accessor :ConfigExtraId
@@ -4186,8 +4334,10 @@ module TencentCloud
4186
4334
  # DeleteConfigFromMachineGroup请求参数结构体
4187
4335
  class DeleteConfigFromMachineGroupRequest < TencentCloud::Common::AbstractModel
4188
4336
  # @param GroupId: 机器组ID
4337
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
4189
4338
  # @type GroupId: String
4190
4339
  # @param ConfigId: 采集配置ID
4340
+ # - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
4191
4341
  # @type ConfigId: String
4192
4342
 
4193
4343
  attr_accessor :GroupId, :ConfigId
@@ -4221,7 +4371,8 @@ module TencentCloud
4221
4371
 
4222
4372
  # DeleteConfig请求参数结构体
4223
4373
  class DeleteConfigRequest < TencentCloud::Common::AbstractModel
4224
- # @param ConfigId: 采集规则配置ID
4374
+ # @param ConfigId: 采集配置ID
4375
+ # - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
4225
4376
  # @type ConfigId: String
4226
4377
 
4227
4378
  attr_accessor :ConfigId
@@ -4253,7 +4404,9 @@ module TencentCloud
4253
4404
 
4254
4405
  # DeleteConsoleSharing请求参数结构体
4255
4406
  class DeleteConsoleSharingRequest < TencentCloud::Common::AbstractModel
4256
- # @param SharingId: 免密分享Id
4407
+ # @param SharingId: 免密分享Id
4408
+ # - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
4409
+ # - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
4257
4410
  # @type SharingId: String
4258
4411
 
4259
4412
  attr_accessor :SharingId
@@ -4285,7 +4438,9 @@ module TencentCloud
4285
4438
 
4286
4439
  # DeleteConsumer请求参数结构体
4287
4440
  class DeleteConsumerRequest < TencentCloud::Common::AbstractModel
4288
- # @param TopicId: 投递任务绑定的日志主题 ID
4441
+ # @param TopicId: 投递任务绑定的日志主题Id。
4442
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
4443
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
4289
4444
  # @type TopicId: String
4290
4445
 
4291
4446
  attr_accessor :TopicId
@@ -4387,7 +4542,7 @@ module TencentCloud
4387
4542
 
4388
4543
  # DeleteDataTransform请求参数结构体
4389
4544
  class DeleteDataTransformRequest < TencentCloud::Common::AbstractModel
4390
- # @param TaskId: 数据加工任务id
4545
+ # @param TaskId: 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
4391
4546
  # @type TaskId: String
4392
4547
 
4393
4548
  attr_accessor :TaskId
@@ -4419,7 +4574,8 @@ module TencentCloud
4419
4574
 
4420
4575
  # DeleteExport请求参数结构体
4421
4576
  class DeleteExportRequest < TencentCloud::Common::AbstractModel
4422
- # @param ExportId: 日志导出ID
4577
+ # @param ExportId: 日志导出任务Id
4578
+ # - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
4423
4579
  # @type ExportId: String
4424
4580
 
4425
4581
  attr_accessor :ExportId
@@ -4484,9 +4640,13 @@ module TencentCloud
4484
4640
 
4485
4641
  # DeleteKafkaRecharge请求参数结构体
4486
4642
  class DeleteKafkaRechargeRequest < TencentCloud::Common::AbstractModel
4487
- # @param Id: Kafka导入配置ID
4643
+ # @param Id: Kafka导入配置Id。
4644
+
4645
+ # - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
4646
+ # - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
4488
4647
  # @type Id: String
4489
- # @param TopicId: 导入CLS目标topic ID
4648
+ # @param TopicId: 导入CLS目标日志主题Id。
4649
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
4490
4650
  # @type TopicId: String
4491
4651
 
4492
4652
  attr_accessor :Id, :TopicId
@@ -4552,7 +4712,8 @@ module TencentCloud
4552
4712
 
4553
4713
  # DeleteMachineGroupInfo请求参数结构体
4554
4714
  class DeleteMachineGroupInfoRequest < TencentCloud::Common::AbstractModel
4555
- # @param GroupId: 机器组ID
4715
+ # @param GroupId: 机器组Id
4716
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
4556
4717
  # @type GroupId: String
4557
4718
  # @param MachineGroupType: 机器组类型
4558
4719
  # 目前type支持 ip 和 label
@@ -4592,7 +4753,8 @@ module TencentCloud
4592
4753
 
4593
4754
  # DeleteMachineGroup请求参数结构体
4594
4755
  class DeleteMachineGroupRequest < TencentCloud::Common::AbstractModel
4595
- # @param GroupId: 机器组ID
4756
+ # @param GroupId: 机器组Id
4757
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
4596
4758
  # @type GroupId: String
4597
4759
 
4598
4760
  attr_accessor :GroupId
@@ -4656,9 +4818,9 @@ module TencentCloud
4656
4818
 
4657
4819
  # DeleteScheduledSql请求参数结构体
4658
4820
  class DeleteScheduledSqlRequest < TencentCloud::Common::AbstractModel
4659
- # @param TaskId: 任务ID
4821
+ # @param TaskId: 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
4660
4822
  # @type TaskId: String
4661
- # @param SrcTopicId: 源日志主题ID
4823
+ # @param SrcTopicId: 源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
4662
4824
  # @type SrcTopicId: String
4663
4825
 
4664
4826
  attr_accessor :TaskId, :SrcTopicId
@@ -4726,6 +4888,7 @@ module TencentCloud
4726
4888
  # DeleteTopic请求参数结构体
4727
4889
  class DeleteTopicRequest < TencentCloud::Common::AbstractModel
4728
4890
  # @param TopicId: 日志主题ID
4891
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
4729
4892
  # @type TopicId: String
4730
4893
 
4731
4894
  attr_accessor :TopicId
@@ -5215,18 +5378,22 @@ module TencentCloud
5215
5378
  # name
5216
5379
  # - 按照【特殊采集配置名称】进行模糊匹配过滤。
5217
5380
  # - 类型:String
5381
+ # - 示例:test-config
5218
5382
 
5219
5383
  # configExtraId
5220
5384
  # - 按照【特殊采集配置ID】进行过滤。
5221
5385
  # - 类型:String
5386
+ # - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
5222
5387
 
5223
5388
  # topicId
5224
5389
  # - 按照【日志主题】进行过滤。
5225
5390
  # - 类型:String
5391
+ # - 示例:3581a3be-aa41-423b-995a-54ec84da6264
5226
5392
 
5227
5393
  # machineGroupId
5228
5394
  # - 按照【机器组ID】进行过滤。
5229
5395
  # - 类型:String
5396
+ # - 示例:f948972f-a063-408c-a59f-8c3230bddaf6
5230
5397
 
5231
5398
  # 每次请求的Filters的上限为10,Filter.Values的上限为5。
5232
5399
  # @type Filters: Array
@@ -5292,6 +5459,7 @@ module TencentCloud
5292
5459
  # DescribeConfigMachineGroups请求参数结构体
5293
5460
  class DescribeConfigMachineGroupsRequest < TencentCloud::Common::AbstractModel
5294
5461
  # @param ConfigId: 采集配置ID
5462
+ # - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
5295
5463
  # @type ConfigId: String
5296
5464
 
5297
5465
  attr_accessor :ConfigId
@@ -5339,16 +5507,20 @@ module TencentCloud
5339
5507
  # - 按照【采集配置名称】进行模糊匹配过滤。
5340
5508
  # - 类型:String
5341
5509
  # - 必选:否
5510
+ # - 示例:test-config
5342
5511
 
5343
5512
  # configId
5344
5513
  # - 按照【采集配置ID】进行过滤。
5345
5514
  # - 类型:String
5346
5515
  # - 必选:否
5516
+ # - 示例:3581a3be-aa41-423b-995a-54ec84da6264
5347
5517
 
5348
5518
  # topicId
5349
5519
  # - 按照【日志主题】进行过滤。
5350
5520
  # - 类型:String
5351
5521
  # - 必选:否
5522
+ # - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
5523
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5352
5524
 
5353
5525
  # 每次请求的Filters的上限为10,Filter.Values的上限为5。
5354
5526
  # @type Filters: Array
@@ -5426,25 +5598,38 @@ module TencentCloud
5426
5598
  class DescribeConsoleSharingListResponse < TencentCloud::Common::AbstractModel
5427
5599
  # @param TotalCount: 分页的总数目
5428
5600
  # @type TotalCount: Integer
5601
+ # @param ConsoleSharingInfos: 控制台免密分享列表
5602
+ # @type ConsoleSharingInfos: Array
5429
5603
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5430
5604
  # @type RequestId: String
5431
5605
 
5432
- attr_accessor :TotalCount, :RequestId
5606
+ attr_accessor :TotalCount, :ConsoleSharingInfos, :RequestId
5433
5607
 
5434
- def initialize(totalcount=nil, requestid=nil)
5608
+ def initialize(totalcount=nil, consolesharinginfos=nil, requestid=nil)
5435
5609
  @TotalCount = totalcount
5610
+ @ConsoleSharingInfos = consolesharinginfos
5436
5611
  @RequestId = requestid
5437
5612
  end
5438
5613
 
5439
5614
  def deserialize(params)
5440
5615
  @TotalCount = params['TotalCount']
5616
+ unless params['ConsoleSharingInfos'].nil?
5617
+ @ConsoleSharingInfos = []
5618
+ params['ConsoleSharingInfos'].each do |i|
5619
+ consolesharinginfo_tmp = ConsoleSharingInfo.new
5620
+ consolesharinginfo_tmp.deserialize(i)
5621
+ @ConsoleSharingInfos << consolesharinginfo_tmp
5622
+ end
5623
+ end
5441
5624
  @RequestId = params['RequestId']
5442
5625
  end
5443
5626
  end
5444
5627
 
5445
5628
  # DescribeConsumer请求参数结构体
5446
5629
  class DescribeConsumerRequest < TencentCloud::Common::AbstractModel
5447
- # @param TopicId: 投递任务绑定的日志主题 ID
5630
+ # @param TopicId: 投递任务绑定的日志主题Id。
5631
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
5632
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
5448
5633
  # @type TopicId: String
5449
5634
 
5450
5635
  attr_accessor :TopicId
@@ -5808,7 +5993,8 @@ module TencentCloud
5808
5993
 
5809
5994
  # DescribeExports请求参数结构体
5810
5995
  class DescribeExportsRequest < TencentCloud::Common::AbstractModel
5811
- # @param TopicId: 日志主题ID
5996
+ # @param TopicId: 日志主题Id
5997
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5812
5998
  # @type TopicId: String
5813
5999
  # @param Offset: 分页的偏移量,默认值为0
5814
6000
  # @type Offset: Integer
@@ -5930,7 +6116,9 @@ module TencentCloud
5930
6116
 
5931
6117
  # DescribeKafkaConsumer请求参数结构体
5932
6118
  class DescribeKafkaConsumerRequest < TencentCloud::Common::AbstractModel
5933
- # @param FromTopicId: 日志主题ID
6119
+ # @param FromTopicId: 日志主题Id。
6120
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
6121
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
5934
6122
  # @type FromTopicId: String
5935
6123
 
5936
6124
  attr_accessor :FromTopicId
@@ -5981,11 +6169,14 @@ module TencentCloud
5981
6169
 
5982
6170
  # DescribeKafkaRecharges请求参数结构体
5983
6171
  class DescribeKafkaRechargesRequest < TencentCloud::Common::AbstractModel
5984
- # @param TopicId: 日志主题 ID
6172
+ # @param TopicId: 日志主题Id。
6173
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5985
6174
  # @type TopicId: String
5986
- # @param Id: 导入配置ID
6175
+ # @param Id: 导入配置Id。
6176
+ # - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
6177
+ # - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
5987
6178
  # @type Id: String
5988
- # @param Status: 状态 status 1: 运行中, 2: 暂停...
6179
+ # @param Status: 状态。1: 运行中,2: 暂停,3:错误
5989
6180
  # @type Status: Integer
5990
6181
 
5991
6182
  attr_accessor :TopicId, :Id, :Status
@@ -6132,9 +6323,12 @@ module TencentCloud
6132
6323
  # @type From: Integer
6133
6324
  # @param To: 要查询的日志的结束时间,Unix时间戳,单位ms
6134
6325
  # @type To: Integer
6135
- # @param Query: 查询语句
6326
+ # @param Query: 检索分析语句。
6327
+ # 语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。
6328
+ # 使用*或空字符串可查询所有日志。
6136
6329
  # @type Query: String
6137
6330
  # @param TopicId: 要查询的日志主题ID
6331
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6138
6332
  # @type TopicId: String
6139
6333
  # @param Interval: 时间间隔: 单位ms 限制性条件:(To-From) / interval <= 200
6140
6334
  # @type Interval: Integer
@@ -6285,6 +6479,7 @@ module TencentCloud
6285
6479
  # DescribeMachineGroupConfigs请求参数结构体
6286
6480
  class DescribeMachineGroupConfigsRequest < TencentCloud::Common::AbstractModel
6287
6481
  # @param GroupId: 机器组ID
6482
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
6288
6483
  # @type GroupId: String
6289
6484
 
6290
6485
  attr_accessor :GroupId
@@ -6328,7 +6523,8 @@ module TencentCloud
6328
6523
 
6329
6524
  # DescribeMachineGroups请求参数结构体
6330
6525
  class DescribeMachineGroupsRequest < TencentCloud::Common::AbstractModel
6331
- # @param Filters: machineGroupName
6526
+ # @param Filters: 过滤条件
6527
+ # machineGroupName
6332
6528
  # - 按照【机器组名称】进行过滤。
6333
6529
  # - 类型:String
6334
6530
  # - 必选:否
@@ -6339,7 +6535,7 @@ module TencentCloud
6339
6535
  # - 必选:否
6340
6536
 
6341
6537
  # osType
6342
- # - 按照【操作系统类型】进行过滤。
6538
+ # - 按照【操作系统类型】进行过滤。0: Linux;1: Windows
6343
6539
  # - 类型:Int
6344
6540
  # - 必选:否
6345
6541
 
@@ -6602,7 +6798,8 @@ module TencentCloud
6602
6798
 
6603
6799
  # DescribePartitions请求参数结构体
6604
6800
  class DescribePartitionsRequest < TencentCloud::Common::AbstractModel
6605
- # @param TopicId: 日志主题ID
6801
+ # @param TopicId: 日志主题Id
6802
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6606
6803
  # @type TopicId: String
6607
6804
 
6608
6805
  attr_accessor :TopicId
@@ -6653,14 +6850,14 @@ module TencentCloud
6653
6850
  # @type Name: String
6654
6851
  # @param TaskId: 任务id。
6655
6852
  # @type TaskId: String
6656
- # @param Filters: <li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
6657
- # <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
6658
- # <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>
6659
- # <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>
6660
- # <li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>
6661
- # <li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>
6662
- # <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>
6663
- # <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>
6853
+ # @param Filters: - srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题1 ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
6854
+ # - dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题 2,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
6855
+ # - srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否。示例:a4478687-2382-4486-9692-de7986350f6b ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
6856
+ # - dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否。示例:bd4d3375-d72a-4cd2-988d-d8eda2bd62b0,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
6857
+ # - bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否
6858
+ # - status按照【任务状态】进行过滤,1:运行;2:停止;3:异常。类型:String。必选:否
6859
+ # - taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否。示例:metricTask ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。
6860
+ # - taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否。示例:9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。
6664
6861
  # @type Filters: Array
6665
6862
 
6666
6863
  attr_accessor :Offset, :Limit, :Name, :TaskId, :Filters
@@ -6860,7 +7057,7 @@ module TencentCloud
6860
7057
  # @param Filters: <ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
6861
7058
  # <li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
6862
7059
  # <li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>
6863
- # <li>logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用 CreateLogset 创建新的日志集。类型:String。必选:否</li>
7060
+ # <li>logsetId 按照【日志集ID】进行过滤,可通过调用 <a href="https://cloud.tencent.com/document/product/614/58624">DescribeLogsets</a> 查询已创建的日志集列表或登录控制台进行查看;也可以调用<a href="https://cloud.tencent.com/document/product/614/58626">CreateLogset</a> 创建新的日志集。类型:String。必选:否</li>
6864
7061
  # <li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>
6865
7062
  # <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>
6866
7063
  # <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>
@@ -7088,11 +7285,19 @@ module TencentCloud
7088
7285
 
7089
7286
  # Windows事件日志采集配置
7090
7287
  class EventLog < TencentCloud::Common::AbstractModel
7091
- # @param EventChannel: 事件通道,支持Application,Security,Setup,System,ALL
7288
+ # @param EventChannel: 事件通道,支持
7289
+ # - Application 应用日志
7290
+ # - Security 安全日志
7291
+ # - Setup 启动日志
7292
+ # - System 系统日志
7293
+ # - ALL 所有日志
7092
7294
  # @type EventChannel: String
7093
- # @param TimeType: 时间类型,1:用户自定义,2:当前时间
7295
+ # @param TimeType: 时间字段(Timestamp)支持的类型
7296
+ # - 1(用户自定义时间)
7297
+ # - 2(当前时间)
7094
7298
  # @type TimeType: Integer
7095
- # @param Timestamp: 时间,用户选择自定义时间类型时,需要指定时间
7299
+ # @param Timestamp: 时间,用户选择自定义时间类型时,需要指定时间,单位秒
7300
+ # 格式:时间戳,1754897446
7096
7301
  # @type Timestamp: Integer
7097
7302
  # @param EventIDs: 事件ID过滤列表
7098
7303
 
@@ -7158,13 +7363,14 @@ module TencentCloud
7158
7363
  # @type Count: Integer
7159
7364
  # @param Status: 日志下载状态。Processing:导出正在进行中,Completed:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期), Queuing 排队中
7160
7365
  # @type Status: String
7161
- # @param From: 日志导出起始时间
7366
+ # @param From: 日志导出起始时间,毫秒时间戳
7162
7367
  # @type From: Integer
7163
- # @param To: 日志导出结束时间
7368
+ # @param To: 日志导出结束时间,毫秒时间戳
7164
7369
  # @type To: Integer
7165
7370
  # @param CosPath: 日志导出路径,有效期一个小时,请尽快使用该路径下载。
7166
7371
  # @type CosPath: String
7167
7372
  # @param CreateTime: 日志导出创建时间
7373
+ # 时间格式:yyyy-MM-dd HH:mm:ss
7168
7374
  # @type CreateTime: String
7169
7375
  # @param SyntaxRule: 语法规则。 默认值为0。
7170
7376
  # 0:Lucene语法,1:CQL语法。
@@ -7213,9 +7419,10 @@ module TencentCloud
7213
7419
 
7214
7420
  # 日志提取规则
7215
7421
  class ExtractRuleInfo < TencentCloud::Common::AbstractModel
7216
- # @param TimeKey: 时间字段的key名字,TikeKey和TimeFormat必须成对出现
7422
+ # @param TimeKey: 时间字段的key名字,TimeKey和TimeFormat必须成对出现
7217
7423
  # @type TimeKey: String
7218
7424
  # @param TimeFormat: 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
7425
+ # - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
7219
7426
  # @type TimeFormat: String
7220
7427
  # @param Delimiter: 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
7221
7428
  # @type Delimiter: String
@@ -7471,7 +7678,9 @@ module TencentCloud
7471
7678
  # @type To: Integer
7472
7679
  # @param Query: 查询过滤条件,例如:
7473
7680
  # - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
7681
+ # - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
7474
7682
  # - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
7683
+ # - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
7475
7684
  # - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
7476
7685
  # - 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c") AND (monitored_object:"3c514e84-6f1f-46ec-xxxx-05de6163f7fe") AND NOT condition_evaluate_result: "Skip" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1`
7477
7686
  # @type Query: String
@@ -7765,10 +7974,21 @@ module TencentCloud
7765
7974
  # Kafka访问协议
7766
7975
  class KafkaProtocolInfo < TencentCloud::Common::AbstractModel
7767
7976
  # @param Protocol: 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
7768
- # 入参必填
7977
+
7978
+ # - 当IsEncryptionAddr为true时,Protocol必填。
7979
+ # - 支持的协议类型如下:
7980
+ # - plaintext:纯文本无加密协议
7981
+ # - sasl_ssl:SASL 认证 + SSL 加密
7982
+ # - ssl:纯 SSL/TLS 加密协议
7983
+ # - sasl_plaintext:SASL 认证 + 非加密通道
7769
7984
  # @type Protocol: String
7770
7985
  # @param Mechanism: 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
7771
- # 当Protocol为sasl_plaintext或sasl_ssl时必填
7986
+
7987
+ # - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。
7988
+ # - 支持加密类型如下
7989
+ # - PLAIN:明文认证
7990
+ # - SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法
7991
+ # - SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法
7772
7992
  # @type Mechanism: String
7773
7993
  # @param UserName: 用户名。
7774
7994
  # 当Protocol为sasl_plaintext或sasl_ssl时必填
@@ -7820,9 +8040,9 @@ module TencentCloud
7820
8040
  # @type Status: Integer
7821
8041
  # @param Offset: 导入数据位置,-2:最早(默认),-1:最晚
7822
8042
  # @type Offset: Integer
7823
- # @param CreateTime: 创建时间
8043
+ # @param CreateTime: 创建时间。格式`YYYY-MM-DD HH:MM:SS`
7824
8044
  # @type CreateTime: String
7825
- # @param UpdateTime: 更新时间
8045
+ # @param UpdateTime: 更新时间。格式`YYYY-MM-DD HH:MM:SS`
7826
8046
  # @type UpdateTime: String
7827
8047
  # @param LogRechargeRule: 日志导入规则
7828
8048
  # @type LogRechargeRule: :class:`Tencentcloud::Cls.v20201016.models.LogRechargeRuleInfo`
@@ -8096,7 +8316,7 @@ module TencentCloud
8096
8316
  # @type RechargeType: String
8097
8317
  # @param EncodingFormat: 解析编码格式,0: UTF-8(默认值),1: GBK
8098
8318
  # @type EncodingFormat: Integer
8099
- # @param DefaultTimeSwitch: 使用默认时间,true:开启(默认值), flase:关闭
8319
+ # @param DefaultTimeSwitch: 使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true
8100
8320
  # @type DefaultTimeSwitch: Boolean
8101
8321
  # @param LogRegex: 整条日志匹配规则,只有RechargeType为fullregex_log时有效
8102
8322
  # @type LogRegex: String
@@ -8108,13 +8328,100 @@ module TencentCloud
8108
8328
  # @type UnMatchLogTimeSrc: Integer
8109
8329
  # @param DefaultTimeSrc: 默认时间来源,0: 系统当前时间,1: Kafka消息时间戳
8110
8330
  # @type DefaultTimeSrc: Integer
8111
- # @param TimeKey: 时间字段
8331
+ # @param TimeKey: 时间字段,日志中代表时间的字段名。
8332
+
8333
+ # - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。
8112
8334
  # @type TimeKey: String
8113
- # @param TimeRegex: 时间提取正则表达式
8335
+ # @param TimeRegex: 时间提取正则表达式。
8336
+ # - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时, TimeRegex不能为空。
8337
+ # - 仅需输入日志中代表时间的字段的正则表达式即可;若匹配到多个字段,将使用第一个。
8338
+ # 例:日志原文为:message with time 2022-08-08 14:20:20,则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d
8114
8339
  # @type TimeRegex: String
8115
- # @param TimeFormat: 时间字段格式
8340
+ # @param TimeFormat: 时间字段格式。
8341
+ # - 当DefaultTimeSwitch为false时, TimeFormat不能为空。
8116
8342
  # @type TimeFormat: String
8117
- # @param TimeZone: 时间字段时区
8343
+ # @param TimeZone: 时间字段时区。
8344
+ # - 当DefaultTimeSwitch为false时, TimeZone不能为空。
8345
+ # - 时区格式规则
8346
+ # ​前缀​:使用 GMT 或 UTC 作为时区基准
8347
+ # ​偏移量​:
8348
+ # - `-` 表示西时区(比基准时间晚)
8349
+ # - `+` 表示东时区(比基准时间早)
8350
+ # - 格式为 ±HH:MM(小时:分钟)
8351
+
8352
+ # - 当前支持:
8353
+ # ```
8354
+ # "GMT-12:00"
8355
+ # "GMT-11:00"
8356
+ # "GMT-10:00"
8357
+ # "GMT-09:30"
8358
+ # "GMT-09:00"
8359
+ # "GMT-08:00"
8360
+ # "GMT-07:00"
8361
+ # "GMT-06:00"
8362
+ # "GMT-05:00"
8363
+ # "GMT-04:00"
8364
+ # "GMT-03:30"
8365
+ # "GMT-03:00"
8366
+ # "GMT-02:00"
8367
+ # "GMT-01:00"
8368
+ # "GMT+00:00"
8369
+ # "GMT+01:00"
8370
+ # "GMT+02:00"
8371
+ # "GMT+03:30"
8372
+ # "GMT+04:00"
8373
+ # "GMT+04:30"
8374
+ # "GMT+05:00"
8375
+ # "GMT+05:30"
8376
+ # "GMT+05:45"
8377
+ # "GMT+06:00"
8378
+ # "GMT+06:30"
8379
+ # "GMT+07:00"
8380
+ # "GMT+08:00"
8381
+ # "GMT+09:00"
8382
+ # "GMT+09:30"
8383
+ # "GMT+10:00"
8384
+ # "GMT+10:30"
8385
+ # "GMT+11:00"
8386
+ # "GMT+11:30"
8387
+ # "GMT+12:00"
8388
+ # "GMT+12:45"
8389
+ # "GMT+13:00"
8390
+ # "GMT+14:00"
8391
+ # "UTC-11:00"
8392
+ # "UTC-10:00"
8393
+ # "UTC-09:00"
8394
+ # "UTC-08:00"
8395
+ # "UTC-12:00"
8396
+ # "UTC-07:00"
8397
+ # "UTC-06:00"
8398
+ # "UTC-05:00"
8399
+ # "UTC-04:30"
8400
+ # "UTC-04:00"
8401
+ # "UTC-03:30"
8402
+ # "UTC-03:00"
8403
+ # "UTC-02:00"
8404
+ # "UTC-01:00"
8405
+ # "UTC+00:00"
8406
+ # "UTC+01:00"
8407
+ # "UTC+02:00"
8408
+ # "UTC+03:00"
8409
+ # "UTC+03:30"
8410
+ # "UTC+04:00"
8411
+ # "UTC+04:30"
8412
+ # "UTC+05:00"
8413
+ # "UTC+05:45"
8414
+ # "UTC+06:00"
8415
+ # "UTC+06:30"
8416
+ # "UTC+07:00"
8417
+ # "UTC+08:00"
8418
+ # "UTC+09:00"
8419
+ # "UTC+09:30"
8420
+ # "UTC+10:00"
8421
+ # "UTC+11:00"
8422
+ # "UTC+12:00"
8423
+ # "UTC+13:00"
8424
+ # ```
8118
8425
  # @type TimeZone: String
8119
8426
  # @param Metadata: 元数据信息,Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp
8120
8427
  # @type Metadata: Array
@@ -8218,18 +8525,21 @@ module TencentCloud
8218
8525
  # @param MachineGroupType: 机器组类型
8219
8526
  # @type MachineGroupType: :class:`Tencentcloud::Cls.v20201016.models.MachineGroupTypeInfo`
8220
8527
  # @param CreateTime: 创建时间
8528
+ # 时间格式:yyyy-MM-dd HH:mm:ss
8221
8529
  # @type CreateTime: String
8222
8530
  # @param Tags: 机器组绑定的标签列表
8223
8531
  # @type Tags: Array
8224
8532
  # @param AutoUpdate: 是否开启机器组自动更新
8225
8533
  # @type AutoUpdate: String
8226
8534
  # @param UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
8535
+ # 时间格式:HH:mm:ss
8227
8536
  # @type UpdateStartTime: String
8228
8537
  # @param UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
8538
+ # 时间格式:HH:mm:ss
8229
8539
  # @type UpdateEndTime: String
8230
8540
  # @param ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
8231
8541
  # @type ServiceLogging: Boolean
8232
- # @param DelayCleanupTime: 机器组中机器离线定期清理时间
8542
+ # @param DelayCleanupTime: 机器组中机器离线定期清理时间,单位天,默认设置30天。
8233
8543
  # @type DelayCleanupTime: Integer
8234
8544
  # @param MetaTags: 机器组元数据信息列表
8235
8545
  # @type MetaTags: Array
@@ -8360,9 +8670,10 @@ module TencentCloud
8360
8670
 
8361
8671
  # MergePartition请求参数结构体
8362
8672
  class MergePartitionRequest < TencentCloud::Common::AbstractModel
8363
- # @param TopicId: 日志主题ID
8673
+ # @param TopicId: 日志主题Id
8674
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8364
8675
  # @type TopicId: String
8365
- # @param PartitionId: 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Staus:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)
8676
+ # @param PartitionId: 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Status:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)
8366
8677
 
8367
8678
  # 1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);
8368
8679
  # 2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);
@@ -8859,17 +9170,19 @@ module TencentCloud
8859
9170
  # ModifyConfigExtra请求参数结构体
8860
9171
  class ModifyConfigExtraRequest < TencentCloud::Common::AbstractModel
8861
9172
  # @param ConfigExtraId: 采集配置扩展信息id
9173
+ # - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)获取采集配置扩展信息id。
8862
9174
  # @type ConfigExtraId: String
8863
9175
  # @param Name: 采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾
8864
9176
  # @type Name: String
8865
9177
  # @param TopicId: 日志主题id
9178
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8866
9179
  # @type TopicId: String
8867
- # @param HostFile: 节点文件配置信息
9180
+ # @param HostFile: 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息,详细参考https://cloud.tencent.com/document/api/614/56471#HostFileInfo
8868
9181
  # @type HostFile: :class:`Tencentcloud::Cls.v20201016.models.HostFileInfo`
8869
9182
  # @param ContainerFile: 采集配置标记。
8870
9183
  # - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
8871
9184
  # @type ContainerFile: :class:`Tencentcloud::Cls.v20201016.models.ContainerFileInfo`
8872
- # @param ContainerStdout: 容器标准输出信息
9185
+ # @param ContainerStdout: 自建k8s-容器标准输出信息,包括容器、命名空间等,详细参考https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo
8873
9186
  # @type ContainerStdout: :class:`Tencentcloud::Cls.v20201016.models.ContainerStdoutInfo`
8874
9187
  # @param LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
8875
9188
  # - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
@@ -8892,17 +9205,24 @@ module TencentCloud
8892
9205
  # - 取值参考:[使用组合解析提取模式采集日志
8893
9206
  # ](https://cloud.tencent.com/document/product/614/61310)
8894
9207
  # @type UserDefineRule: String
8895
- # @param Type: 类型:container_stdout、container_file、host_file
9208
+ # @param Type: 容器场景,日志采集输入类型,支持以下三种类型
9209
+ # - container_stdout 标准输出
9210
+ # - container_file 容器文件
9211
+ # - host_file 主机节点文件
8896
9212
  # @type Type: String
8897
9213
  # @param GroupId: 机器组ID
9214
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
8898
9215
  # @type GroupId: String
8899
9216
  # @param ConfigFlag: 自建采集配置标
8900
9217
  # @type ConfigFlag: String
8901
9218
  # @param LogsetId: 日志集ID
9219
+ # - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
8902
9220
  # @type LogsetId: String
8903
- # @param LogsetName: 日志集name
9221
+ # @param LogsetName: 日志集名称
9222
+ # - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。
8904
9223
  # @type LogsetName: String
8905
- # @param TopicName: 日志主题name
9224
+ # @param TopicName: 日志主题名称
9225
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。
8906
9226
  # @type TopicName: String
8907
9227
  # @param AdvancedConfig: 高级采集配置。 Json字符串, Key/Value定义为如下:
8908
9228
  # - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
@@ -8999,6 +9319,8 @@ module TencentCloud
8999
9319
  # @param ConfigId: 采集规则配置ID,通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)返回信息获取。
9000
9320
  # @type ConfigId: String
9001
9321
  # @param Name: 采集规则配置名称
9322
+ # - 不能包含特殊字符|
9323
+ # - 长度不能超过255字符,超过会被截断
9002
9324
  # @type Name: String
9003
9325
  # @param Path: 日志采集路径,包含文件名
9004
9326
  # @type Path: String
@@ -9019,6 +9341,7 @@ module TencentCloud
9019
9341
  # @param ExcludePaths: 采集黑名单路径列表
9020
9342
  # @type ExcludePaths: Array
9021
9343
  # @param Output: 采集配置关联的日志主题(TopicId)
9344
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
9022
9345
  # @type Output: String
9023
9346
  # @param UserDefineRule: 用户自定义解析字符串,Json格式序列化的字符串。
9024
9347
  # @type UserDefineRule: String
@@ -9085,7 +9408,9 @@ module TencentCloud
9085
9408
 
9086
9409
  # ModifyConsoleSharing请求参数结构体
9087
9410
  class ModifyConsoleSharingRequest < TencentCloud::Common::AbstractModel
9088
- # @param SharingId: 免密分享链接Id
9411
+ # @param SharingId: 免密分享Id
9412
+ # - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
9413
+ # - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
9089
9414
  # @type SharingId: String
9090
9415
  # @param DurationMilliseconds: 指定分享链接有效期,单位:毫秒,最长可设定有效期为30天
9091
9416
  # @type DurationMilliseconds: Integer
@@ -9121,7 +9446,9 @@ module TencentCloud
9121
9446
 
9122
9447
  # ModifyConsumer请求参数结构体
9123
9448
  class ModifyConsumerRequest < TencentCloud::Common::AbstractModel
9124
- # @param TopicId: 投递任务绑定的日志主题 ID
9449
+ # @param TopicId: 投递任务绑定的日志主题Id。
9450
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
9451
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
9125
9452
  # @type TopicId: String
9126
9453
  # @param Effective: 投递任务是否生效,默认不生效
9127
9454
  # @type Effective: Boolean
@@ -9437,9 +9764,11 @@ module TencentCloud
9437
9764
 
9438
9765
  # ModifyKafkaConsumer请求参数结构体
9439
9766
  class ModifyKafkaConsumerRequest < TencentCloud::Common::AbstractModel
9440
- # @param FromTopicId: 日志主题ID
9767
+ # @param FromTopicId: 日志主题Id。
9768
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
9769
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
9441
9770
  # @type FromTopicId: String
9442
- # @param Compression: 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
9771
+ # @param Compression: 压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
9443
9772
  # @type Compression: Integer
9444
9773
  # @param ConsumerContent: kafka协议消费数据格式
9445
9774
  # @type ConsumerContent: :class:`Tencentcloud::Cls.v20201016.models.KafkaConsumerContent`
@@ -9480,15 +9809,20 @@ module TencentCloud
9480
9809
 
9481
9810
  # ModifyKafkaRecharge请求参数结构体
9482
9811
  class ModifyKafkaRechargeRequest < TencentCloud::Common::AbstractModel
9483
- # @param Id: Kafka导入配置ID
9812
+ # @param Id: 导入配置Id。
9813
+ # - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
9814
+ # - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
9484
9815
  # @type Id: String
9485
- # @param TopicId: 导入CLS目标topic ID
9816
+ # @param TopicId: 导入CLS目标TopicId。
9817
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
9818
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。
9486
9819
  # @type TopicId: String
9487
9820
  # @param Name: Kafka导入配置名称
9488
9821
  # @type Name: String
9489
9822
  # @param KafkaType: 导入Kafka类型,0:腾讯云CKafka:1:用户自建Kafka。
9490
9823
  # @type KafkaType: Integer
9491
9824
  # @param KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填。
9825
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
9492
9826
  # @type KafkaInstance: String
9493
9827
  # @param ServerAddr: 服务地址,KafkaType为1时必填。
9494
9828
  # @type ServerAddr: String
@@ -9496,13 +9830,15 @@ module TencentCloud
9496
9830
  # @type IsEncryptionAddr: Boolean
9497
9831
  # @param Protocol: 加密访问协议,KafkaType参数为1并且IsEncryptionAddr参数为true时必填。
9498
9832
  # @type Protocol: :class:`Tencentcloud::Cls.v20201016.models.KafkaProtocolInfo`
9499
- # @param UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
9833
+ # @param UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
9834
+
9835
+ # - Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
9500
9836
  # @type UserKafkaTopics: String
9501
9837
  # @param ConsumerGroupName: 用户Kafka消费组名称
9502
9838
  # @type ConsumerGroupName: String
9503
9839
  # @param LogRechargeRule: 日志导入规则
9504
9840
  # @type LogRechargeRule: :class:`Tencentcloud::Cls.v20201016.models.LogRechargeRuleInfo`
9505
- # @param StatusControl: 导入控制,1:暂停;2:继续。
9841
+ # @param StatusControl: 导入控制,1:暂停;2:启动。
9506
9842
  # @type StatusControl: Integer
9507
9843
 
9508
9844
  attr_accessor :Id, :TopicId, :Name, :KafkaType, :KafkaInstance, :ServerAddr, :IsEncryptionAddr, :Protocol, :UserKafkaTopics, :ConsumerGroupName, :LogRechargeRule, :StatusControl
@@ -9609,9 +9945,13 @@ module TencentCloud
9609
9945
 
9610
9946
  # ModifyMachineGroup请求参数结构体
9611
9947
  class ModifyMachineGroupRequest < TencentCloud::Common::AbstractModel
9612
- # @param GroupId: 机器组ID
9948
+ # @param GroupId: 机器组Id
9949
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
9613
9950
  # @type GroupId: String
9614
9951
  # @param GroupName: 机器组名称
9952
+ # 输入限制:
9953
+ # - 不能为空字符串
9954
+ # - 不能包含字符'|'
9615
9955
  # @type GroupName: String
9616
9956
  # @param MachineGroupType: 机器组类型。
9617
9957
  # Type:ip,Values中为ip字符串列表机器组;
@@ -9622,8 +9962,10 @@ module TencentCloud
9622
9962
  # @param AutoUpdate: 是否开启机器组自动更新
9623
9963
  # @type AutoUpdate: Boolean
9624
9964
  # @param UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
9965
+ # 时间格式:HH:mm:ss
9625
9966
  # @type UpdateStartTime: String
9626
9967
  # @param UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
9968
+ # 时间格式:HH:mm:ss
9627
9969
  # @type UpdateEndTime: String
9628
9970
  # @param ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
9629
9971
  # @type ServiceLogging: Boolean
@@ -9749,9 +10091,9 @@ module TencentCloud
9749
10091
 
9750
10092
  # ModifyScheduledSql请求参数结构体
9751
10093
  class ModifyScheduledSqlRequest < TencentCloud::Common::AbstractModel
9752
- # @param TaskId: 任务ID
10094
+ # @param TaskId: 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
9753
10095
  # @type TaskId: String
9754
- # @param SrcTopicId: 源日志主题
10096
+ # @param SrcTopicId: 源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
9755
10097
  # @type SrcTopicId: String
9756
10098
  # @param EnableFlag: 任务启动状态. 1开启, 2关闭
9757
10099
  # @type EnableFlag: Integer
@@ -9759,15 +10101,15 @@ module TencentCloud
9759
10101
  # @type DstResource: :class:`Tencentcloud::Cls.v20201016.models.ScheduledSqlResouceInfo`
9760
10102
  # @param ScheduledSqlContent: 查询语句
9761
10103
  # @type ScheduledSqlContent: String
9762
- # @param ProcessPeriod: 调度周期(分钟)
10104
+ # @param ProcessPeriod: 调度周期(分钟),1~1440分钟
9763
10105
  # @type ProcessPeriod: Integer
9764
10106
  # @param ProcessTimeWindow: 单次查询的时间窗口. 例子中为近15分钟
9765
10107
  # @type ProcessTimeWindow: String
9766
- # @param ProcessDelay: 执行延迟(秒)
10108
+ # @param ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
9767
10109
  # @type ProcessDelay: Integer
9768
- # @param SrcTopicRegion: 源topicId的地域信息
10110
+ # @param SrcTopicRegion: 源topicId的地域信息,支持地域见(https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8)
9769
10111
  # @type SrcTopicRegion: String
9770
- # @param Name: 任务名称
10112
+ # @param Name: 任务名称,0~255字符
9771
10113
  # @type Name: String
9772
10114
  # @param SyntaxRule: 语法规则。 默认值为0。 0:Lucene语法,1:CQL语法
9773
10115
  # @type SyntaxRule: Integer
@@ -9934,8 +10276,13 @@ module TencentCloud
9934
10276
  # ModifyTopic请求参数结构体
9935
10277
  class ModifyTopicRequest < TencentCloud::Common::AbstractModel
9936
10278
  # @param TopicId: 日志主题ID
10279
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
9937
10280
  # @type TopicId: String
9938
10281
  # @param TopicName: 日志主题名称
10282
+ # 输入限制:
10283
+ # - 不能为空字符串
10284
+ # - 不能包含字符'|'
10285
+ # - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
9939
10286
  # @type TopicName: String
9940
10287
  # @param Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,并且不能有重复的键值对。
9941
10288
  # @type Tags: Array
@@ -9944,7 +10291,8 @@ module TencentCloud
9944
10291
  # @type Status: Boolean
9945
10292
  # @param AutoSplit: 是否开启自动分裂
9946
10293
  # @type AutoSplit: Boolean
9947
- # @param MaxSplitPartitions: 若开启最大分裂,该主题能够能够允许的最大分区数
10294
+ # @param MaxSplitPartitions: 若开启最大分裂,该主题能够能够允许的最大分区数;
10295
+ # 默认为50;必须为正数
9948
10296
  # @type MaxSplitPartitions: Integer
9949
10297
  # @param Period: 生命周期,单位天,标准存储取值范围1\~3600,低频存储取值范围7\~3600。取值为3640时代表永久保存
9950
10298
  # @type Period: Integer
@@ -9958,9 +10306,15 @@ module TencentCloud
9958
10306
  # @type IsWebTracking: Boolean
9959
10307
  # @param Extends: 日志主题扩展信息
9960
10308
  # @type Extends: :class:`Tencentcloud::Cls.v20201016.models.TopicExtendInfo`
9961
- # @param PartitionCount: 日志主题分区数量
10309
+ # @param PartitionCount: 日志主题分区数量。
10310
+ # 默认为1;
10311
+ # 取值范围及约束:
10312
+ # - 当输入值<=0,系统自动调整为1。
10313
+ # - 如果未传MaxSplitPartitions,需要PartitionCount<=50;
10314
+ # - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
9962
10315
  # @type PartitionCount: Integer
9963
10316
  # @param CancelTopicAsyncTaskID: 取消切换存储任务的id
10317
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
9964
10318
  # @type CancelTopicAsyncTaskID: String
9965
10319
 
9966
10320
  attr_accessor :TopicId, :TopicName, :Tags, :Status, :AutoSplit, :MaxSplitPartitions, :Period, :Describes, :HotPeriod, :IsWebTracking, :Extends, :PartitionCount, :CancelTopicAsyncTaskID
@@ -10189,7 +10543,7 @@ module TencentCloud
10189
10543
  # 通知模板内容
10190
10544
  class NoticeContentInfo < TencentCloud::Common::AbstractModel
10191
10545
  # @param Title: 通知内容模板标题信息。
10192
- # 部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
10546
+ # 部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
10193
10547
  # @type Title: String
10194
10548
  # @param Content: 通知内容模板正文信息。
10195
10549
  # @type Content: String
@@ -10443,7 +10797,9 @@ module TencentCloud
10443
10797
 
10444
10798
  # OpenKafkaConsumer请求参数结构体
10445
10799
  class OpenKafkaConsumerRequest < TencentCloud::Common::AbstractModel
10446
- # @param FromTopicId: 日志主题ID
10800
+ # @param FromTopicId: 日志主题Id。
10801
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
10802
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
10447
10803
  # @type FromTopicId: String
10448
10804
  # @param Compression: 压缩方式[0:NONE;2:SNAPPY;3:LZ4],默认:0
10449
10805
  # @type Compression: Integer
@@ -10546,8 +10902,10 @@ module TencentCloud
10546
10902
  # @param ExclusiveEndKey: 分区哈希键结束key
10547
10903
  # @type ExclusiveEndKey: String
10548
10904
  # @param CreateTime: 分区创建时间
10905
+ # 时间格式:yyyy-MM-dd HH:mm:ss
10549
10906
  # @type CreateTime: String
10550
10907
  # @param LastWriteTime: 只读分区数据停止写入时间
10908
+ # 时间格式:yyyy-MM-dd HH:mm:ss
10551
10909
  # 注意:此字段可能返回 null,表示取不到有效值。
10552
10910
  # @type LastWriteTime: String
10553
10911
 
@@ -10584,6 +10942,7 @@ module TencentCloud
10584
10942
  # @param Offset: 导入数据位置,-2:最早;-1:最晚。
10585
10943
  # @type Offset: Integer
10586
10944
  # @param KafkaInstance: 腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。
10945
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
10587
10946
  # @type KafkaInstance: String
10588
10947
  # @param ServerAddr: 服务地址。
10589
10948
  # KafkaType为1时ServerAddr必填。
@@ -10594,7 +10953,9 @@ module TencentCloud
10594
10953
  # @param Protocol: 加密访问协议。
10595
10954
  # KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
10596
10955
  # @type Protocol: :class:`Tencentcloud::Cls.v20201016.models.KafkaProtocolInfo`
10597
- # @param ConsumerGroupName: 用户Kafka消费组
10956
+ # @param ConsumerGroupName: 用户Kafka消费组。
10957
+
10958
+ # - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
10598
10959
  # @type ConsumerGroupName: String
10599
10960
  # @param LogRechargeRule: 日志导入规则
10600
10961
  # @type LogRechargeRule: :class:`Tencentcloud::Cls.v20201016.models.LogRechargeRuleInfo`
@@ -10704,8 +11065,10 @@ module TencentCloud
10704
11065
  # QueryMetric请求参数结构体
10705
11066
  class QueryMetricRequest < TencentCloud::Common::AbstractModel
10706
11067
  # @param Query: 查询语句,使用PromQL语法
11068
+ # - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
10707
11069
  # @type Query: String
10708
11070
  # @param TopicId: 指标主题ID
11071
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
10709
11072
  # @type TopicId: String
10710
11073
  # @param Time: 查询时间,秒级Unix时间戳。为空时代表当前时间戳。
10711
11074
  # @type Time: Integer
@@ -10727,7 +11090,11 @@ module TencentCloud
10727
11090
 
10728
11091
  # QueryMetric返回参数结构体
10729
11092
  class QueryMetricResponse < TencentCloud::Common::AbstractModel
10730
- # @param ResultType: 指标查询结果类型
11093
+ # @param ResultType: 指标查询结果类型,支持
11094
+ # - scalar 标量值
11095
+ # - string 字符串值
11096
+ # - vector 瞬时向量
11097
+ # - matrix 区间向量
10731
11098
  # @type ResultType: String
10732
11099
  # @param Result: 指标查询结果
10733
11100
  # @type Result: String
@@ -10752,8 +11119,10 @@ module TencentCloud
10752
11119
  # QueryRangeMetric请求参数结构体
10753
11120
  class QueryRangeMetricRequest < TencentCloud::Common::AbstractModel
10754
11121
  # @param TopicId: 指标主题ID
11122
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
10755
11123
  # @type TopicId: String
10756
11124
  # @param Query: 查询语句,使用PromQL语法
11125
+ # - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
10757
11126
  # @type Query: String
10758
11127
  # @param Start: 查询起始时间,秒级Unix时间戳
10759
11128
  # @type Start: Integer
@@ -10783,7 +11152,11 @@ module TencentCloud
10783
11152
 
10784
11153
  # QueryRangeMetric返回参数结构体
10785
11154
  class QueryRangeMetricResponse < TencentCloud::Common::AbstractModel
10786
- # @param ResultType: 指标查询结果类型
11155
+ # @param ResultType: 指标查询结果类型,支持
11156
+ # - scalar 标量值
11157
+ # - string 字符串值
11158
+ # - vector 瞬时向量
11159
+ # - matrix 区间向量
10787
11160
  # @type ResultType: String
10788
11161
  # @param Result: 指标查询结果
10789
11162
  # @type Result: String
@@ -10946,9 +11319,9 @@ module TencentCloud
10946
11319
 
10947
11320
  # ScheduledSql的资源信息
10948
11321
  class ScheduledSqlResouceInfo < TencentCloud::Common::AbstractModel
10949
- # @param TopicId: 目标主题id
11322
+ # @param TopicId: 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
10950
11323
  # @type TopicId: String
10951
- # @param Region: 主题的地域信息
11324
+ # @param Region: 主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
10952
11325
  # @type Region: String
10953
11326
  # @param BizType: 主题类型:0为日志主题,1为指标主题
10954
11327
  # @type BizType: Integer
@@ -11009,9 +11382,9 @@ module TencentCloud
11009
11382
  # @type SrcTopicName: String
11010
11383
  # @param DstResource: 定时SQL分析目标主题
11011
11384
  # @type DstResource: :class:`Tencentcloud::Cls.v20201016.models.ScheduledSqlResouceInfo`
11012
- # @param CreateTime: 任务创建时间
11385
+ # @param CreateTime: 任务创建时间。格式:yyyy-MM-dd HH:mm:ss
11013
11386
  # @type CreateTime: String
11014
- # @param UpdateTime: 任务更新时间
11387
+ # @param UpdateTime: 任务更新时间,格式:yyyy-MM-dd HH:mm:ss
11015
11388
  # @type UpdateTime: String
11016
11389
  # @param Status: 任务状态,1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题
11017
11390
 
@@ -11021,19 +11394,19 @@ module TencentCloud
11021
11394
  # @type EnableFlag: Integer
11022
11395
  # @param ScheduledSqlContent: 查询语句
11023
11396
  # @type ScheduledSqlContent: String
11024
- # @param ProcessStartTime: 调度开始时间
11397
+ # @param ProcessStartTime: 调度开始时间,格式:yyyy-MM-dd HH:mm:ss
11025
11398
  # @type ProcessStartTime: String
11026
11399
  # @param ProcessType: 调度类型,1:持续运行 2:指定时间范围
11027
11400
  # @type ProcessType: Integer
11028
- # @param ProcessEndTime: 调度结束时间,当process_type=2时为必传字段
11401
+ # @param ProcessEndTime: 调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段
11029
11402
  # @type ProcessEndTime: String
11030
- # @param ProcessPeriod: 调度周期(分钟)
11403
+ # @param ProcessPeriod: 调度周期(分钟),1~1440分钟
11031
11404
  # @type ProcessPeriod: Integer
11032
11405
  # @param ProcessTimeWindow: 查询的时间窗口. @m-15m, @m,意为近15分钟
11033
11406
  # @type ProcessTimeWindow: String
11034
- # @param ProcessDelay: 执行延迟(秒)
11407
+ # @param ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
11035
11408
  # @type ProcessDelay: Integer
11036
- # @param SrcTopicRegion: 源topicId的地域信息
11409
+ # @param SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
11037
11410
  # @type SrcTopicRegion: String
11038
11411
  # @param SyntaxRule: 语法规则,0:Lucene语法,1:CQL语法
11039
11412
  # @type SyntaxRule: Integer
@@ -11835,6 +12208,7 @@ module TencentCloud
11835
12208
  # @param AssumerName: 云产品标识,主题由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
11836
12209
  # @type AssumerName: String
11837
12210
  # @param CreateTime: 创建时间
12211
+ # 时间格式:yyyy-MM-dd HH:mm:ss
11838
12212
  # @type CreateTime: String
11839
12213
  # @param Status: 主题是否开启采集,true:开启采集;false:关闭采集。
11840
12214
  # 创建日志主题时默认开启,可通过SDK调用ModifyTopic修改此字段。
@@ -11873,8 +12247,13 @@ module TencentCloud
11873
12247
  # @param TopicAsyncTaskID: 异步迁移任务ID
11874
12248
  # @type TopicAsyncTaskID: String
11875
12249
  # @param MigrationStatus: 异步迁移状态
12250
+ # - 1:进行中
12251
+ # - 2:已完成
12252
+ # - 3:失败
12253
+ # - 4:已取消
11876
12254
  # @type MigrationStatus: Integer
11877
12255
  # @param EffectiveDate: 异步迁移完成后,预计生效日期
12256
+ # 时间格式:yyyy-MM-dd HH:mm:ss
11878
12257
  # @type EffectiveDate: String
11879
12258
 
11880
12259
  attr_accessor :LogsetId, :TopicId, :TopicName, :PartitionCount, :Index, :AssumerName, :CreateTime, :Status, :Tags, :AutoSplit, :MaxSplitPartitions, :StorageType, :Period, :SubAssumerName, :Describes, :HotPeriod, :BizType, :IsWebTracking, :Extends, :TopicAsyncTaskID, :MigrationStatus, :EffectiveDate
@@ -11942,11 +12321,14 @@ module TencentCloud
11942
12321
 
11943
12322
  # UploadLog请求参数结构体
11944
12323
  class UploadLogRequest < TencentCloud::Common::AbstractModel
11945
- # @param TopicId: 主题id
12324
+ # @param TopicId: 日志主题id
12325
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
11946
12326
  # @type TopicId: String
11947
12327
  # @param HashKey: 该参数已废弃,请勿使用
11948
12328
  # @type HashKey: String
11949
- # @param CompressType: 压缩方法
12329
+ # @param CompressType: 压缩方法,目前支持
12330
+ # - lz4
12331
+ # - zstd
11950
12332
  # @type CompressType: String
11951
12333
 
11952
12334
  attr_accessor :TopicId, :HashKey, :CompressType