tencentcloud-sdk-cls 3.0.1121 → 3.0.1123

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.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20201016/client.rb +4 -4
  4. data/lib/v20201016/models.rb +518 -163
  5. metadata +2 -2
data/lib/v20201016/models.rb CHANGED
@@ -19,7 +19,8 @@ module TencentCloud
19
19
  module V20201016
20
20
  # AddMachineGroupInfo请求参数结构体
21
21
  class AddMachineGroupInfoRequest < TencentCloud::Common::AbstractModel
22
- # @param GroupId: 机器组ID
22
+ # @param GroupId: 机器组Id
23
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
23
24
  # @type GroupId: String
24
25
  # @param MachineGroupType: 机器组类型
25
26
  # 目前type支持 ip 和 label
@@ -142,7 +143,7 @@ module TencentCloud
142
143
  # @type AlarmTargets: Array
143
144
  # @param MonitorTime: 监控任务运行时间点。
144
145
  # @type MonitorTime: :class:`Tencentcloud::Cls.v20201016.models.MonitorTime`
145
- # @param Condition: 单触发条件。与MultiConditions参数互斥。
146
+ # @param Condition: 是否触发告警的单触发条件。与MultiConditions参数互斥。
146
147
  # @type Condition: String
147
148
  # @param TriggerCount: 持续周期。持续满足触发条件TriggerCount个周期后，再进行告警；最小值为1，最大值为10。
148
149
  # @type TriggerCount: Integer
@@ -154,9 +155,9 @@ module TencentCloud
154
155
  # @type Status: Boolean
155
156
  # @param AlarmId: 告警策略ID。
156
157
  # @type AlarmId: String
157
- # @param CreateTime: 创建时间。
158
+ # @param CreateTime: 创建时间。格式： YYYY-MM-DD HH:MM:SS
158
159
  # @type CreateTime: String
159
- # @param UpdateTime: 最近更新时间。
160
+ # @param UpdateTime: 最近更新时间。格式： YYYY-MM-DD HH:MM:SS
160
161
  # @type UpdateTime: String
161
162
  # @param MessageTemplate: 自定义通知模板
162
163
  # 注意：此字段可能返回 null，表示取不到有效值。
@@ -300,9 +301,9 @@ module TencentCloud
300
301
  # @param AlarmNoticeDeliverConfig: 投递相关信息。
301
302
  # 注意：此字段可能返回 null，表示取不到有效值。
302
303
  # @type AlarmNoticeDeliverConfig: :class:`Tencentcloud::Cls.v20201016.models.AlarmNoticeDeliverConfig`
303
- # @param CreateTime: 创建时间。
304
+ # @param CreateTime: 创建时间。格式： YYYY-MM-DD HH:MM:SS
304
305
  # @type CreateTime: String
305
- # @param UpdateTime: 最近更新时间。
306
+ # @param UpdateTime: 最近更新时间。格式： YYYY-MM-DD HH:MM:SS
306
307
  # @type UpdateTime: String
307
308
 
308
309
  attr_accessor :Name, :Tags, :Type, :NoticeReceivers, :WebCallbacks, :AlarmNoticeId, :NoticeRules, :AlarmShieldStatus, :JumpDomain, :AlarmNoticeDeliverConfig, :CreateTime, :UpdateTime
@@ -416,9 +417,9 @@ module TencentCloud
416
417
  # @param Status: 规则状态。
417
418
  # 0：暂未生效，1：生效中，2：已失效
418
419
  # @type Status: Integer
419
- # @param CreateTime: 规则创建时间。
420
+ # @param CreateTime: 规则创建时间。秒级时间戳(s)
420
421
  # @type CreateTime: Integer
421
- # @param UpdateTime: 规则更新时间。
422
+ # @param UpdateTime: 规则更新时间。秒级时间戳(s)
422
423
  # @type UpdateTime: Integer
423
424
 
424
425
  attr_accessor :AlarmNoticeId, :TaskId, :StartTime, :EndTime, :Type, :Rule, :Reason, :Source, :Operator, :Status, :CreateTime, :UpdateTime
@@ -456,7 +457,7 @@ module TencentCloud
456
457
 
457
458
  # 告警对象
458
459
  class AlarmTarget < TencentCloud::Common::AbstractModel
459
- # @param TopicId: 日志主题ID。
460
+ # @param TopicId: 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
460
461
  # @type TopicId: String
461
462
  # @param Query: 查询语句。
462
463
  # @type Query: String
@@ -466,7 +467,7 @@ module TencentCloud
466
467
  # @type StartTimeOffset: Integer
467
468
  # @param EndTimeOffset: 查询范围终止时间相对于告警执行时间的偏移，单位为分钟，取值为非正，须大于StartTimeOffset，最大值为0，最小值为-1440。
468
469
  # @type EndTimeOffset: Integer
469
- # @param LogsetId: 日志集ID。
470
+ # @param LogsetId: 日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID
470
471
  # @type LogsetId: String
471
472
  # @param SyntaxRule: 检索语法规则，默认值为0。
472
473
  # 0：Lucene语法，1：CQL语法。
@@ -589,15 +590,15 @@ module TencentCloud
589
590
  # @type Trigger: String
590
591
  # @param TriggerCount: 持续周期，持续满足触发条件TriggerCount个周期后，再进行告警
591
592
  # @type TriggerCount: Integer
592
- # @param AlarmPeriod: 告警通知发送频率，单位为分钟
593
+ # @param AlarmPeriod: 告警通知发送频率，单位为分钟(min)
593
594
  # @type AlarmPeriod: Integer
594
595
  # @param Notices: 通知渠道组
595
596
  # @type Notices: Array
596
- # @param Duration: 告警持续时间，单位为分钟
597
+ # @param Duration: 告警持续时间，单位为分钟(min)
597
598
  # @type Duration: Integer
598
599
  # @param Status: 告警状态，0代表未恢复，1代表已恢复，2代表已失效
599
600
  # @type Status: Integer
600
- # @param CreateTime: 告警发生时间，毫秒级Unix时间戳
601
+ # @param CreateTime: 告警发生时间，毫秒级Unix时间戳(ms)
601
602
  # @type CreateTime: Integer
602
603
  # @param GroupTriggerCondition: 告警分组触发时对应的分组信息
603
604
  # @type GroupTriggerCondition: Array
@@ -666,7 +667,7 @@ module TencentCloud
666
667
  class AnalysisDimensional < TencentCloud::Common::AbstractModel
667
668
  # @param Name: 分析名称
668
669
  # @type Name: String
669
- # @param Type: 分析类型：query，field ，original
670
+ # @param Type: 分析类型：query(自定义检索分析)，field(字段TOP5及占比统计) ，original(相关原始日志)
670
671
  # @type Type: String
671
672
  # @param Content: 分析内容
672
673
  # @type Content: String
@@ -767,8 +768,10 @@ module TencentCloud
767
768
  # ApplyConfigToMachineGroup请求参数结构体
768
769
  class ApplyConfigToMachineGroupRequest < TencentCloud::Common::AbstractModel
769
770
  # @param ConfigId: 采集配置ID
771
+ # - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
770
772
  # @type ConfigId: String
771
773
  # @param GroupId: 机器组ID
774
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
772
775
  # @type GroupId: String
773
776
 
774
777
  attr_accessor :ConfigId, :GroupId
@@ -838,9 +841,15 @@ module TencentCloud
838
841
 
839
842
  # CheckFunction请求参数结构体
840
843
  class CheckFunctionRequest < TencentCloud::Common::AbstractModel
841
- # @param EtlContent: 用户输入的加工语句
844
+ # @param EtlContent: 加工语句。 当FuncType为2时，EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
845
+
846
+ # 其他参考文档：
847
+
848
+ # - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
849
+ # - [函数总览](https://cloud.tencent.com/document/product/614/70395)
842
850
  # @type EtlContent: String
843
- # @param DstResources: 加工任务目的topic_id以及别名
851
+ # @param DstResources: 加工任务目标topic_id以及别名，当 FuncType 为 1 时，必填。
852
+ # 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
844
853
  # @type DstResources: Array
845
854
  # @param FuncType: 数据加工目标主题的类型. 1 固定主题 2动态创建
846
855
  # @type FuncType: Integer
@@ -965,17 +974,31 @@ module TencentCloud
965
974
 
966
975
  # CKafka的描述-需要投递到的kafka信息
967
976
  class Ckafka < TencentCloud::Common::AbstractModel
968
- # @param InstanceId: Ckafka 的 InstanceId
977
+ # @param InstanceId: Ckafka 的 InstanceId。
978
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
979
+ # - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
969
980
  # @type InstanceId: String
970
- # @param TopicName: Ckafka 的 TopicName
981
+ # @param TopicName: Ckafka 的 TopicName。
982
+ # - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
983
+ # - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
971
984
  # @type TopicName: String
972
- # @param Vip: Ckafka 的 Vip
985
+ # @param Vip: Ckafka 的 Vip。
986
+ # - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
987
+ # - 如果是通过 角色ARN 方式创建投递任务，则Vip字段可为空。
973
988
  # @type Vip: String
974
- # @param Vport: Ckafka 的 Vport
989
+ # @param Vport: Ckafka 的 Vport。
990
+ # - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
991
+ # - 如果是通过 角色ARN 方式创建投递任务，则Vport字段可为空。
975
992
  # @type Vport: String
976
- # @param InstanceName: Ckafka 的 InstanceName
993
+ # @param InstanceName: Ckafka 的 InstanceName。
994
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
995
+ # - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
996
+ # - 如果是通过 角色ARN 方式创建投递任务，则InstanceName字段可为空。
977
997
  # @type InstanceName: String
978
- # @param TopicId: Ckafka 的 TopicId
998
+ # @param TopicId: Ckafka 的 TopicId。
999
+ # - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
1000
+ # - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
1001
+ # - 如果是通过 角色ARN 方式创建投递任务，则TopicId字段可为空。
979
1002
  # @type TopicId: String
980
1003
 
981
1004
  attr_accessor :InstanceId, :TopicName, :Vip, :Vport, :InstanceName, :TopicId
@@ -1001,7 +1024,9 @@ module TencentCloud
1001
1024
 
1002
1025
  # CloseKafkaConsumer请求参数结构体
1003
1026
  class CloseKafkaConsumerRequest < TencentCloud::Common::AbstractModel
1004
- # @param FromTopicId: 日志主题ID
1027
+ # @param FromTopicId: 日志主题Id。
1028
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
1029
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
1005
1030
  # @type FromTopicId: String
1006
1031
 
1007
1032
  attr_accessor :FromTopicId
@@ -1190,7 +1215,10 @@ module TencentCloud
1190
1215
  # @type Name: String
1191
1216
  # @param TopicId: 日志主题ID
1192
1217
  # @type TopicId: String
1193
- # @param Type: 类型：container_stdout、container_file、host_file
1218
+ # @param Type: 自建k8s集群日志采集类型，支持
1219
+ # - container_stdout 标准输出
1220
+ # - container_file 标准文件
1221
+ # - host_file 节点文件
1194
1222
  # @type Type: String
1195
1223
  # @param HostFile: 节点文件配置信息
1196
1224
  # @type HostFile: :class:`Tencentcloud::Cls.v20201016.models.HostFileInfo`
@@ -1208,16 +1236,20 @@ module TencentCloud
1208
1236
  # 注意：此字段可能返回 null，表示取不到有效值。
1209
1237
  # @type ExcludePaths: Array
1210
1238
  # @param UpdateTime: 更新时间
1239
+ # - 时间格式：yyyy-MM-dd HH:mm:ss
1211
1240
  # @type UpdateTime: String
1212
1241
  # @param CreateTime: 创建时间
1242
+ # - 时间格式：yyyy-MM-dd HH:mm:ss
1213
1243
  # @type CreateTime: String
1214
1244
  # @param UserDefineRule: 用户自定义解析字符串
1215
1245
  # @type UserDefineRule: String
1216
1246
  # @param GroupId: 机器组ID
1247
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
1217
1248
  # @type GroupId: String
1218
1249
  # @param ConfigFlag: 自建采集配置标
1219
1250
  # @type ConfigFlag: String
1220
1251
  # @param LogsetId: 日志集ID
1252
+ # - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
1221
1253
  # @type LogsetId: String
1222
1254
  # @param LogsetName: 日志集name
1223
1255
  # @type LogsetName: String
@@ -1338,8 +1370,10 @@ module TencentCloud
1338
1370
  # @param Output: 采集配置所属日志主题ID即TopicId
1339
1371
  # @type Output: String
1340
1372
  # @param UpdateTime: 更新时间
1373
+ # - 时间格式：yyyy-MM-dd HH:mm:ss
1341
1374
  # @type UpdateTime: String
1342
1375
  # @param CreateTime: 创建时间
1376
+ # - 时间格式：yyyy-MM-dd HH:mm:ss
1343
1377
  # @type CreateTime: String
1344
1378
  # @param UserDefineRule: 用户自定义解析字符串，详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310)。
1345
1379
  # @type UserDefineRule: String
@@ -1474,6 +1508,63 @@ module TencentCloud
1474
1508
  end
1475
1509
  end
1476
1510
 
1511
+ # 控制台分享信息
1512
+ class ConsoleSharingInfo < TencentCloud::Common::AbstractModel
1513
+ # @param SharingId: 分享ID
1514
+ # @type SharingId: String
1515
+ # @param SharingUrl: 分享链接
1516
+ # 注意：此字段可能返回 null，表示取不到有效值。
1517
+ # @type SharingUrl: String
1518
+ # @param SharingConfig: 匿名分享配置信息
1519
+ # 注意：此字段可能返回 null，表示取不到有效值。
1520
+ # @type SharingConfig: :class:`Tencentcloud::Cls.v20201016.models.ConsoleSharingConfig`
1521
+ # @param ExpiredTime: 过期时间
1522
+ # 注意：此字段可能返回 null，表示取不到有效值。
1523
+ # @type ExpiredTime: Integer
1524
+ # @param CreateTime: 创建时间
1525
+ # 注意：此字段可能返回 null，表示取不到有效值。
1526
+ # @type CreateTime: Integer
1527
+ # @param UpdateTime: 修改时间
1528
+ # 注意：此字段可能返回 null，表示取不到有效值。
1529
+ # @type UpdateTime: Integer
1530
+ # @param Status: 分享链接状态
1531
+ # 1: 正常
1532
+ # -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
1533
+ # 注意：此字段可能返回 null，表示取不到有效值。
1534
+ # @type Status: Integer
1535
+ # @param ContentSafetyCode: 10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐（天御独有恶意类型），20472-违法，
1536
+ # 24005-社会
1537
+ # 注意：此字段可能返回 null，表示取不到有效值。
1538
+ # @type ContentSafetyCode: Integer
1539
+
1540
+ attr_accessor :SharingId, :SharingUrl, :SharingConfig, :ExpiredTime, :CreateTime, :UpdateTime, :Status, :ContentSafetyCode
1541
+
1542
+ def initialize(sharingid=nil, sharingurl=nil, sharingconfig=nil, expiredtime=nil, createtime=nil, updatetime=nil, status=nil, contentsafetycode=nil)
1543
+ @SharingId = sharingid
1544
+ @SharingUrl = sharingurl
1545
+ @SharingConfig = sharingconfig
1546
+ @ExpiredTime = expiredtime
1547
+ @CreateTime = createtime
1548
+ @UpdateTime = updatetime
1549
+ @Status = status
1550
+ @ContentSafetyCode = contentsafetycode
1551
+ end
1552
+
1553
+ def deserialize(params)
1554
+ @SharingId = params['SharingId']
1555
+ @SharingUrl = params['SharingUrl']
1556
+ unless params['SharingConfig'].nil?
1557
+ @SharingConfig = ConsoleSharingConfig.new
1558
+ @SharingConfig.deserialize(params['SharingConfig'])
1559
+ end
1560
+ @ExpiredTime = params['ExpiredTime']
1561
+ @CreateTime = params['CreateTime']
1562
+ @UpdateTime = params['UpdateTime']
1563
+ @Status = params['Status']
1564
+ @ContentSafetyCode = params['ContentSafetyCode']
1565
+ end
1566
+ end
1567
+
1477
1568
  # 控制台分享链接params参数
1478
1569
  class ConsoleSharingParam < TencentCloud::Common::AbstractModel
1479
1570
  # @param Name: 名称
@@ -1826,7 +1917,7 @@ module TencentCloud
1826
1917
 
1827
1918
  # CreateAlarmNotice请求参数结构体
1828
1919
  class CreateAlarmNoticeRequest < TencentCloud::Common::AbstractModel
1829
- # @param Name: 通知渠道组名称。
1920
+ # @param Name: 通知渠道组名称。最大支持255个字节。 不支持 '|'。
1830
1921
  # @type Name: String
1831
1922
  # @param Tags: 标签描述列表，通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持50个标签键值对，并且不能有重复的键值对。
1832
1923
  # @type Tags: Array
@@ -1941,7 +2032,7 @@ module TencentCloud
1941
2032
 
1942
2033
  # CreateAlarm请求参数结构体
1943
2034
  class CreateAlarmRequest < TencentCloud::Common::AbstractModel
1944
- # @param Name: 告警策略名称
2035
+ # @param Name: 告警策略名称。最大支持255个字节。 不支持 '|'。
1945
2036
  # @type Name: String
1946
2037
  # @param AlarmTargets: 监控对象列表。
1947
2038
  # @type AlarmTargets: Array
@@ -1951,9 +2042,9 @@ module TencentCloud
1951
2042
  # @type TriggerCount: Integer
1952
2043
  # @param AlarmPeriod: 告警重复的周期，单位是分钟。取值范围是0~1440。
1953
2044
  # @type AlarmPeriod: Integer
1954
- # @param AlarmNoticeIds: 关联的告警通知模板列表。
2045
+ # @param AlarmNoticeIds: 关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表
1955
2046
  # @type AlarmNoticeIds: Array
1956
- # @param Condition: 触发条件
2047
+ # @param Condition: 告警发送通知的触发条件
1957
2048
  # 注意:
1958
2049
  # - Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。
1959
2050
  # @type Condition: String
@@ -2112,11 +2203,11 @@ module TencentCloud
2112
2203
 
2113
2204
  # CreateAlarmShield请求参数结构体
2114
2205
  class CreateAlarmShieldRequest < TencentCloud::Common::AbstractModel
2115
- # @param AlarmNoticeId: 通知渠道组id。
2206
+ # @param AlarmNoticeId: 通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取通知渠道组id
2116
2207
  # @type AlarmNoticeId: String
2117
- # @param StartTime: 屏蔽开始时间（秒级时间戳）。
2208
+ # @param StartTime: 屏蔽规则开始时间，秒级(s)时间戳。
2118
2209
  # @type StartTime: Integer
2119
- # @param EndTime: 屏蔽结束时间（秒级时间戳）。
2210
+ # @param EndTime: 屏蔽规则结束时间，秒级(s)时间戳。结束时间需要大于当前时间
2120
2211
  # @type EndTime: Integer
2121
2212
  # @param Type: 屏蔽类型。1：屏蔽所有通知，2：按照Rule参数屏蔽匹配规则的通知。
2122
2213
  # @type Type: Integer
@@ -2169,12 +2260,13 @@ module TencentCloud
2169
2260
  # CreateCloudProductLogCollection请求参数结构体
2170
2261
  class CreateCloudProductLogCollectionRequest < TencentCloud::Common::AbstractModel
2171
2262
  # @param InstanceId: 实例ID
2263
+ # - 通过各个接入云产品官方文档获取
2172
2264
  # @type InstanceId: String
2173
2265
  # @param AssumerName: 云产品标识，支持枚举：CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS
2174
2266
  # @type AssumerName: String
2175
2267
  # @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
2176
2268
  # @type LogType: String
2177
- # @param CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异， 请参考如下示例：
2269
+ # @param CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异， 请参考如下示例：
2178
2270
  # - CDS所有日志类型：ap-guangzhou
2179
2271
  # - CDB-AUDIT: gz
2180
2272
  # - TDSQL-C-AUDIT: gz
@@ -2189,16 +2281,19 @@ module TencentCloud
2189
2281
  # - APIS所有日志类型：gz
2190
2282
  # @type CloudProductRegion: String
2191
2283
  # @param ClsRegion: CLS目标地域
2284
+ # - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
2192
2285
  # @type ClsRegion: String
2193
2286
  # @param LogsetName: 日志集名称，未填LogsetId时必填。若日志集不存在, 将自动创建
2194
2287
  # @type LogsetName: String
2195
2288
  # @param TopicName: 日志主题名称，在未填TopicId时必填。 若日志主题不存在，将自动创建
2196
2289
  # @type TopicName: String
2197
- # @param Extend: 日志配置拓展信息， 一般用于存储额外的日志投递配置
2290
+ # @param Extend: 日志配置扩展信息， 一般用于存储额外的日志投递配置
2198
2291
  # @type Extend: String
2199
2292
  # @param LogsetId: 日志集id
2293
+ # - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
2200
2294
  # @type LogsetId: String
2201
2295
  # @param TopicId: 日志主题id
2296
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2202
2297
  # @type TopicId: String
2203
2298
 
2204
2299
  attr_accessor :InstanceId, :AssumerName, :LogType, :CloudProductRegion, :ClsRegion, :LogsetName, :TopicName, :Extend, :LogsetId, :TopicId
@@ -2422,8 +2517,11 @@ module TencentCloud
2422
2517
  # CreateConfig请求参数结构体
2423
2518
  class CreateConfigRequest < TencentCloud::Common::AbstractModel
2424
2519
  # @param Name: 采集配置名称
2520
+ # - 名称种不得包含特殊字符｜
2521
+ # - 名称最长255字符，超过截断
2425
2522
  # @type Name: String
2426
2523
  # @param Output: 采集配置所属日志主题ID即TopicId
2524
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2427
2525
  # @type Output: String
2428
2526
  # @param Path: 日志采集路径，包含文件名，支持多个路径，多个路径之间英文逗号分隔，文件采集情况下必填
2429
2527
  # @type Path: String
@@ -2554,7 +2652,9 @@ module TencentCloud
2554
2652
 
2555
2653
  # CreateConsumer请求参数结构体
2556
2654
  class CreateConsumerRequest < TencentCloud::Common::AbstractModel
2557
- # @param TopicId: 投递任务绑定的日志主题 ID
2655
+ # @param TopicId: 投递任务绑定的日志主题Id。
2656
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2657
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2558
2658
  # @type TopicId: String
2559
2659
  # @param NeedContent: 是否投递日志的元数据信息，默认为 true。
2560
2660
  # 当NeedContent为true时：字段Content有效。
@@ -2697,10 +2797,21 @@ module TencentCloud
2697
2797
  # CreateDashboardSubscribe请求参数结构体
2698
2798
  class CreateDashboardSubscribeRequest < TencentCloud::Common::AbstractModel
2699
2799
  # @param Name: 仪表盘订阅名称。
2800
+ # 输入限制：
2801
+ # - 不能为空
2802
+ # - 长度不能超过128字节
2803
+ # - 不能包含字符'|'
2700
2804
  # @type Name: String
2701
- # @param DashboardId: 仪表盘id。
2805
+ # @param DashboardId: 仪表盘Id。
2806
+ # - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
2702
2807
  # @type DashboardId: String
2703
- # @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星期六】
2808
+ # @param Cron: 订阅时间cron表达式，格式为：{秒数} {分钟} {小时} {日期} {月份} {星期}；（有效数据为：{分钟} {小时} {日期} {月份} {星期}）。
2809
+ # - {秒数} 取值范围： 0 ~ 59
2810
+ # - {分钟} 取值范围： 0 ~ 59
2811
+ # - {小时} 取值范围： 0 ~ 23
2812
+ # - {日期} 取值范围： 1 ~ 31 AND (dayOfMonth最后一天： L)
2813
+ # - {月份} 取值范围： 1 ~ 12
2814
+ # - {星期} 取值范围： 0 ~ 6 【0:星期日， 6星期六】
2704
2815
  # @type Cron: String
2705
2816
  # @param SubscribeData: 仪表盘订阅数据。
2706
2817
  # @type SubscribeData: :class:`Tencentcloud::Cls.v20201016.models.DashboardSubscribeData`
@@ -2831,17 +2942,22 @@ module TencentCloud
2831
2942
 
2832
2943
  # CreateDeliverCloudFunction请求参数结构体
2833
2944
  class CreateDeliverCloudFunctionRequest < TencentCloud::Common::AbstractModel
2834
- # @param TopicId: 投递规则属于的 topic id
2945
+ # @param TopicId: 投递规则属于的TopicId。
2946
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2947
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2835
2948
  # @type TopicId: String
2836
2949
  # @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)）
2950
+ # 通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。
2837
2951
  # @type FunctionName: String
2838
- # @param Namespace: 命名空间
2952
+ # @param Namespace: 命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
2953
+ # - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
2839
2954
  # @type Namespace: String
2840
- # @param Qualifier: 函数版本
2955
+ # @param Qualifier: 函数版本。
2956
+ # - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
2841
2957
  # @type Qualifier: String
2842
- # @param Timeout: 投递最长等待时间，单位：秒
2958
+ # @param Timeout: 投递最长等待时间，单位：秒。 默认：60
2843
2959
  # @type Timeout: Integer
2844
- # @param MaxMsgNum: 投递最大消息数
2960
+ # @param MaxMsgNum: 投递最大消息数。默认为100。支持范围[1,10000]
2845
2961
  # @type MaxMsgNum: Integer
2846
2962
 
2847
2963
  attr_accessor :TopicId, :FunctionName, :Namespace, :Qualifier, :Timeout, :MaxMsgNum
@@ -2883,7 +2999,8 @@ module TencentCloud
2883
2999
 
2884
3000
  # CreateExport请求参数结构体
2885
3001
  class CreateExportRequest < TencentCloud::Common::AbstractModel
2886
- # @param TopicId: 日志主题ID
3002
+ # @param TopicId: 日志主题Id
3003
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2887
3004
  # @type TopicId: String
2888
3005
  # @param Count: 日志导出数量, 最大值5000万
2889
3006
  # @type Count: Integer
@@ -3009,7 +3126,9 @@ module TencentCloud
3009
3126
 
3010
3127
  # CreateKafkaRecharge请求参数结构体
3011
3128
  class CreateKafkaRechargeRequest < TencentCloud::Common::AbstractModel
3012
- # @param TopicId: 导入CLS目标topic ID
3129
+ # @param TopicId: 导入CLS目标TopicId。
3130
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
3131
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
3013
3132
  # @type TopicId: String
3014
3133
  # @param Name: Kafka导入配置名称
3015
3134
  # @type Name: String
@@ -3022,6 +3141,7 @@ module TencentCloud
3022
3141
  # @param LogRechargeRule: 日志导入规则。
3023
3142
  # @type LogRechargeRule: :class:`Tencentcloud::Cls.v20201016.models.LogRechargeRuleInfo`
3024
3143
  # @param KafkaInstance: 腾讯云CKafka实例ID，KafkaType为0时必填。
3144
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
3025
3145
  # @type KafkaInstance: String
3026
3146
  # @param ServerAddr: 服务地址，KafkaType为1时必填。
3027
3147
  # @type ServerAddr: String
@@ -3030,7 +3150,8 @@ module TencentCloud
3030
3150
  # @param Protocol: 加密访问协议。
3031
3151
  # KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
3032
3152
  # @type Protocol: :class:`Tencentcloud::Cls.v20201016.models.KafkaProtocolInfo`
3033
- # @param ConsumerGroupName: 用户Kafka消费组名称
3153
+ # @param ConsumerGroupName: 用户Kafka消费组名称。
3154
+ # - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制，一个消费组中存在多个消费者，组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition，但一个 Partition 只能被消费组内的一个消费者消费。
3034
3155
  # @type ConsumerGroupName: String
3035
3156
 
3036
3157
  attr_accessor :TopicId, :Name, :KafkaType, :UserKafkaTopics, :Offset, :LogRechargeRule, :KafkaInstance, :ServerAddr, :IsEncryptionAddr, :Protocol, :ConsumerGroupName
@@ -3145,7 +3266,10 @@ module TencentCloud
3145
3266
 
3146
3267
  # CreateMachineGroup请求参数结构体
3147
3268
  class CreateMachineGroupRequest < TencentCloud::Common::AbstractModel
3148
- # @param GroupName: 机器组名字，不能重复
3269
+ # @param GroupName: 机器组名字。
3270
+ # 输入限制：
3271
+ # - 最大支持255个字符，不能为空字符串
3272
+ # - 不能包含字符'|'
3149
3273
  # @type GroupName: String
3150
3274
  # @param MachineGroupType: 创建机器组类型。取值如下：
3151
3275
  # - Type：ip，Values中为ip字符串列表创建机器组
@@ -3156,12 +3280,16 @@ module TencentCloud
3156
3280
  # @param AutoUpdate: 是否开启机器组自动更新。默认false
3157
3281
  # @type AutoUpdate: Boolean
3158
3282
  # @param UpdateStartTime: 升级开始时间，建议业务低峰期升级LogListener
3283
+ # 时间格式：HH:mm:ss
3159
3284
  # @type UpdateStartTime: String
3160
3285
  # @param UpdateEndTime: 升级结束时间，建议业务低峰期升级LogListener
3286
+ # 时间格式：HH:mm:ss
3161
3287
  # @type UpdateEndTime: String
3162
3288
  # @param ServiceLogging: 是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费。默认false
3163
3289
  # @type ServiceLogging: Boolean
3164
3290
  # @param DelayCleanupTime: 机器组中机器离线清理时间。单位：天
3291
+
3292
+ # - 大于0时生效。
3165
3293
  # @type DelayCleanupTime: Integer
3166
3294
  # @param MetaTags: 机器组元数据信息列表
3167
3295
  # @type MetaTags: Array
@@ -3238,7 +3366,7 @@ module TencentCloud
3238
3366
 
3239
3367
  # CreateNoticeContent请求参数结构体
3240
3368
  class CreateNoticeContentRequest < TencentCloud::Common::AbstractModel
3241
- # @param Name: 模板名称。
3369
+ # @param Name: 模板名称。最大支持255个字节
3242
3370
  # @type Name: String
3243
3371
  # @param Type: 模板内容语言。0：中文1：英文
3244
3372
  # @type Type: Integer
@@ -3289,9 +3417,9 @@ module TencentCloud
3289
3417
 
3290
3418
  # CreateScheduledSql请求参数结构体
3291
3419
  class CreateScheduledSqlRequest < TencentCloud::Common::AbstractModel
3292
- # @param SrcTopicId: 源日志主题
3420
+ # @param SrcTopicId: 源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
3293
3421
  # @type SrcTopicId: String
3294
- # @param Name: 任务名称
3422
+ # @param Name: 任务名称，0~255字符
3295
3423
  # @type Name: String
3296
3424
  # @param EnableFlag: 任务启动状态. 1开启, 2关闭
3297
3425
  # @type EnableFlag: Integer
@@ -3303,13 +3431,13 @@ module TencentCloud
3303
3431
  # @type ProcessStartTime: Integer
3304
3432
  # @param ProcessType: 调度类型，1:持续运行 2:指定时间范围
3305
3433
  # @type ProcessType: Integer
3306
- # @param ProcessPeriod: 调度周期(分钟)
3434
+ # @param ProcessPeriod: 调度周期(分钟)，1~1440分钟
3307
3435
  # @type ProcessPeriod: Integer
3308
3436
  # @param ProcessTimeWindow: 单次查询的时间窗口,如果您的目标主题为指标主题，建议该参数的大小不超过30分钟，否则可能转指标失败。
3309
3437
  # @type ProcessTimeWindow: String
3310
- # @param ProcessDelay: 执行延迟(秒)
3438
+ # @param ProcessDelay: 执行延迟(秒)，0~120秒，默认60秒
3311
3439
  # @type ProcessDelay: Integer
3312
- # @param SrcTopicRegion: 源topicId的地域信息
3440
+ # @param SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
3313
3441
  # @type SrcTopicRegion: String
3314
3442
  # @param ProcessEndTime: 调度结束时间，当ProcessType=2时为必传字段, Unix时间戳，单位ms
3315
3443
  # @type ProcessEndTime: Integer
@@ -3495,8 +3623,13 @@ module TencentCloud
3495
3623
  # CreateTopic请求参数结构体
3496
3624
  class CreateTopicRequest < TencentCloud::Common::AbstractModel
3497
3625
  # @param LogsetId: 日志集ID
3626
+ # - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
3498
3627
  # @type LogsetId: String
3499
3628
  # @param TopicName: 日志主题名称
3629
+ # 名称限制
3630
+ # - 不能为空字符串
3631
+ # - 不能包含字符'|'
3632
+ # - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
3500
3633
  # @type TopicName: String
3501
3634
  # @param PartitionCount: 日志主题分区个数。默认创建1个，最大支持创建10个分区。
3502
3635
  # @type PartitionCount: Integer
@@ -3595,7 +3728,7 @@ module TencentCloud
3595
3728
 
3596
3729
  # CreateWebCallback请求参数结构体
3597
3730
  class CreateWebCallbackRequest < TencentCloud::Common::AbstractModel
3598
- # @param Name: 通知内容名称。
3731
+ # @param Name: 通知内容名称。最大支持255个字节
3599
3732
  # @type Name: String
3600
3733
  # @param Type: 渠道类型。
3601
3734
 
@@ -3607,7 +3740,7 @@ module TencentCloud
3607
3740
 
3608
3741
  # 当Type为Http时，必填。
3609
3742
  # @type Method: String
3610
- # @param Key: 秘钥。
3743
+ # @param Key: 秘钥。最大支持1024个字节
3611
3744
  # @type Key: String
3612
3745
 
3613
3746
  attr_accessor :Name, :Type, :Webhook, :Method, :Key
@@ -3758,7 +3891,9 @@ module TencentCloud
3758
3891
  # <li/>Uin：腾讯云用户<br>
3759
3892
  # <li/>Group：腾讯云用户组<br>
3760
3893
  # <li/>Email：自定义Email<br>
3761
- # <li/>WeCom: 企业微信回调
3894
+ # <li/>WeCom: 企业微信回调<br>
3895
+ # <li/>DingTalk：钉钉<br>
3896
+ # <li/>Lark：飞书
3762
3897
  # @type ReceiverType: String
3763
3898
  # @param Values: 知方式对应的值。
3764
3899
  # <br> <li/> 当ReceiverType不是 WeCom 时，Values必填。
@@ -4013,7 +4148,7 @@ module TencentCloud
4013
4148
 
4014
4149
  # DeleteAlarmNotice请求参数结构体
4015
4150
  class DeleteAlarmNoticeRequest < TencentCloud::Common::AbstractModel
4016
- # @param AlarmNoticeId: 通知渠道组ID
4151
+ # @param AlarmNoticeId: 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
4017
4152
  # @type AlarmNoticeId: String
4018
4153
 
4019
4154
  attr_accessor :AlarmNoticeId
@@ -4077,9 +4212,9 @@ module TencentCloud
4077
4212
 
4078
4213
  # DeleteAlarmShield请求参数结构体
4079
4214
  class DeleteAlarmShieldRequest < TencentCloud::Common::AbstractModel
4080
- # @param TaskId: 屏蔽规则id。
4215
+ # @param TaskId: 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
4081
4216
  # @type TaskId: String
4082
- # @param AlarmNoticeId: 通知渠道组id。
4217
+ # @param AlarmNoticeId: 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
4083
4218
  # @type AlarmNoticeId: String
4084
4219
 
4085
4220
  attr_accessor :TaskId, :AlarmNoticeId
@@ -4119,7 +4254,7 @@ module TencentCloud
4119
4254
  # @type AssumerName: String
4120
4255
  # @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
4121
4256
  # @type LogType: String
4122
- # @param CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异， 请参考如下示例：
4257
+ # @param CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异， 请参考如下示例：
4123
4258
  # - CDS所有日志类型：ap-guangzhou
4124
4259
  # - CDB-AUDIT: gz
4125
4260
  # - TDSQL-C-AUDIT: gz
@@ -4174,6 +4309,7 @@ module TencentCloud
4174
4309
  # DeleteConfigExtra请求参数结构体
4175
4310
  class DeleteConfigExtraRequest < TencentCloud::Common::AbstractModel
4176
4311
  # @param ConfigExtraId: 特殊采集规则扩展配置ID
4312
+ # - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
4177
4313
  # @type ConfigExtraId: String
4178
4314
 
4179
4315
  attr_accessor :ConfigExtraId
@@ -4206,8 +4342,10 @@ module TencentCloud
4206
4342
  # DeleteConfigFromMachineGroup请求参数结构体
4207
4343
  class DeleteConfigFromMachineGroupRequest < TencentCloud::Common::AbstractModel
4208
4344
  # @param GroupId: 机器组ID
4345
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
4209
4346
  # @type GroupId: String
4210
4347
  # @param ConfigId: 采集配置ID
4348
+ # - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
4211
4349
  # @type ConfigId: String
4212
4350
 
4213
4351
  attr_accessor :GroupId, :ConfigId
@@ -4241,7 +4379,8 @@ module TencentCloud
4241
4379
 
4242
4380
  # DeleteConfig请求参数结构体
4243
4381
  class DeleteConfigRequest < TencentCloud::Common::AbstractModel
4244
- # @param ConfigId: 采集规则配置ID
4382
+ # @param ConfigId: 采集配置ID
4383
+ # - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
4245
4384
  # @type ConfigId: String
4246
4385
 
4247
4386
  attr_accessor :ConfigId
@@ -4273,7 +4412,9 @@ module TencentCloud
4273
4412
 
4274
4413
  # DeleteConsoleSharing请求参数结构体
4275
4414
  class DeleteConsoleSharingRequest < TencentCloud::Common::AbstractModel
4276
- # @param SharingId: 免密分享Id
4415
+ # @param SharingId: 免密分享Id。
4416
+ # - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
4417
+ # - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
4277
4418
  # @type SharingId: String
4278
4419
 
4279
4420
  attr_accessor :SharingId
@@ -4305,7 +4446,9 @@ module TencentCloud
4305
4446
 
4306
4447
  # DeleteConsumer请求参数结构体
4307
4448
  class DeleteConsumerRequest < TencentCloud::Common::AbstractModel
4308
- # @param TopicId: 投递任务绑定的日志主题 ID
4449
+ # @param TopicId: 投递任务绑定的日志主题Id。
4450
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
4451
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
4309
4452
  # @type TopicId: String
4310
4453
 
4311
4454
  attr_accessor :TopicId
@@ -4407,7 +4550,7 @@ module TencentCloud
4407
4550
 
4408
4551
  # DeleteDataTransform请求参数结构体
4409
4552
  class DeleteDataTransformRequest < TencentCloud::Common::AbstractModel
4410
- # @param TaskId: 数据加工任务id
4553
+ # @param TaskId: 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
4411
4554
  # @type TaskId: String
4412
4555
 
4413
4556
  attr_accessor :TaskId
@@ -4439,7 +4582,8 @@ module TencentCloud
4439
4582
 
4440
4583
  # DeleteExport请求参数结构体
4441
4584
  class DeleteExportRequest < TencentCloud::Common::AbstractModel
4442
- # @param ExportId: 日志导出ID
4585
+ # @param ExportId: 日志导出任务Id
4586
+ # - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
4443
4587
  # @type ExportId: String
4444
4588
 
4445
4589
  attr_accessor :ExportId
@@ -4576,7 +4720,8 @@ module TencentCloud
4576
4720
 
4577
4721
  # DeleteMachineGroupInfo请求参数结构体
4578
4722
  class DeleteMachineGroupInfoRequest < TencentCloud::Common::AbstractModel
4579
- # @param GroupId: 机器组ID
4723
+ # @param GroupId: 机器组Id
4724
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
4580
4725
  # @type GroupId: String
4581
4726
  # @param MachineGroupType: 机器组类型
4582
4727
  # 目前type支持 ip 和 label
@@ -4616,7 +4761,8 @@ module TencentCloud
4616
4761
 
4617
4762
  # DeleteMachineGroup请求参数结构体
4618
4763
  class DeleteMachineGroupRequest < TencentCloud::Common::AbstractModel
4619
- # @param GroupId: 机器组ID
4764
+ # @param GroupId: 机器组Id
4765
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
4620
4766
  # @type GroupId: String
4621
4767
 
4622
4768
  attr_accessor :GroupId
@@ -4648,7 +4794,7 @@ module TencentCloud
4648
4794
 
4649
4795
  # DeleteNoticeContent请求参数结构体
4650
4796
  class DeleteNoticeContentRequest < TencentCloud::Common::AbstractModel
4651
- # @param NoticeContentId: 通知内容模板ID
4797
+ # @param NoticeContentId: 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
4652
4798
  # @type NoticeContentId: String
4653
4799
 
4654
4800
  attr_accessor :NoticeContentId
@@ -4680,9 +4826,9 @@ module TencentCloud
4680
4826
 
4681
4827
  # DeleteScheduledSql请求参数结构体
4682
4828
  class DeleteScheduledSqlRequest < TencentCloud::Common::AbstractModel
4683
- # @param TaskId: 任务ID
4829
+ # @param TaskId: 任务ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
4684
4830
  # @type TaskId: String
4685
- # @param SrcTopicId: 源日志主题ID
4831
+ # @param SrcTopicId: 源日志主题ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
4686
4832
  # @type SrcTopicId: String
4687
4833
 
4688
4834
  attr_accessor :TaskId, :SrcTopicId
@@ -4750,6 +4896,7 @@ module TencentCloud
4750
4896
  # DeleteTopic请求参数结构体
4751
4897
  class DeleteTopicRequest < TencentCloud::Common::AbstractModel
4752
4898
  # @param TopicId: 日志主题ID
4899
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
4753
4900
  # @type TopicId: String
4754
4901
 
4755
4902
  attr_accessor :TopicId
@@ -4781,7 +4928,7 @@ module TencentCloud
4781
4928
 
4782
4929
  # DeleteWebCallback请求参数结构体
4783
4930
  class DeleteWebCallbackRequest < TencentCloud::Common::AbstractModel
4784
- # @param WebCallbackId: 告警渠道回调配置ID。
4931
+ # @param WebCallbackId: 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
4785
4932
  # @type WebCallbackId: String
4786
4933
 
4787
4934
  attr_accessor :WebCallbackId
@@ -4823,7 +4970,7 @@ module TencentCloud
4823
4970
 
4824
4971
  # https://cloud.tencent.com/document/product/614/18940
4825
4972
  # @type Region: String
4826
- # @param TopicId: 日志主题ID。
4973
+ # @param TopicId: 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
4827
4974
  # @type TopicId: String
4828
4975
  # @param Scope: 投递数据范围。
4829
4976
 
@@ -4852,18 +4999,22 @@ module TencentCloud
4852
4999
  # @param Filters: <li> name
4853
5000
  # 按照【通知渠道组名称】进行过滤。
4854
5001
  # 类型：String
5002
+ # 示例："Filters":[{"Key":"name","Values":["test-notice"]}]
4855
5003
  # 必选：否</li>
4856
5004
  # <li> alarmNoticeId
4857
5005
  # 按照【通知渠道组ID】进行过滤。
4858
5006
  # 类型：String
5007
+ # 示例："Filters": [{Key: "alarmNoticeId", Values: ["notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f"]}]
4859
5008
  # 必选：否</li>
4860
5009
  # <li> uid
4861
5010
  # 按照【接收用户ID】进行过滤。
4862
5011
  # 类型：String
5012
+ # 示例："Filters": [{Key: "uid", Values: ["1137546"]}]
4863
5013
  # 必选：否</li>
4864
5014
  # <li> groupId
4865
5015
  # 按照【接收用户组ID】进行过滤。
4866
5016
  # 类型：String
5017
+ # 示例："Filters": [{Key: "groupId", Values: ["344098"]}]
4867
5018
  # 必选：否</li>
4868
5019
 
4869
5020
  # <li> deliverFlag
@@ -4871,7 +5022,7 @@ module TencentCloud
4871
5022
  # 类型：String
4872
5023
  # 必选：否
4873
5024
  # 可选值： "1":未启用, "2": 已启用, "3":投递异常</li>
4874
-
5025
+ # 示例："Filters":[{"Key":"deliverFlag","Values":["2"]}]
4875
5026
  # 每次请求的Filters的上限为10，Filter.Values的上限为5。
4876
5027
  # @type Filters: Array
4877
5028
  # @param Offset: 分页的偏移量，默认值为0。
@@ -5006,22 +5157,26 @@ module TencentCloud
5006
5157
  # - 按照【告警策略名称】进行过滤。
5007
5158
  # - 类型：String
5008
5159
  # - 必选：否
5160
+ # - 示例：test-alarm
5009
5161
 
5010
5162
  # alarmId
5011
5163
  # - 按照【告警策略ID】进行过滤。
5012
5164
  # - 类型：String
5013
5165
  # - 必选：否
5166
+ # - 示例：alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751
5014
5167
 
5015
5168
  # topicId
5016
5169
  # - 按照【监控对象的日志主题ID】进行过滤。
5017
5170
  # - 类型：String
5018
5171
  # - 必选：否
5172
+ # - 示例：6766f83d-659e-xxxx-a8f7-9104a1012743
5019
5173
 
5020
5174
  # enable
5021
5175
  # - 按照【启用状态】进行过滤。
5022
5176
  # - 类型：String
5023
5177
  # - 备注：enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.
5024
5178
  # - 必选：否
5179
+ # - 示例：true
5025
5180
 
5026
5181
  # 每次请求的Filters的上限为10，Filter.Values的上限为5。
5027
5182
  # @type Filters: Array
@@ -5085,9 +5240,9 @@ module TencentCloud
5085
5240
 
5086
5241
  # DescribeAlertRecordHistory请求参数结构体
5087
5242
  class DescribeAlertRecordHistoryRequest < TencentCloud::Common::AbstractModel
5088
- # @param From: 查询时间范围启始时间，毫秒级unix时间戳
5243
+ # @param From: 查询时间范围启始时间，毫秒级unix时间戳(ms)
5089
5244
  # @type From: Integer
5090
- # @param To: 查询时间范围结束时间，毫秒级unix时间戳
5245
+ # @param To: 查询时间范围结束时间，毫秒级unix时间戳(ms)
5091
5246
  # @type To: Integer
5092
5247
  # @param Offset: 分页的偏移量，默认值为0。
5093
5248
  # @type Offset: Integer
@@ -5239,18 +5394,22 @@ module TencentCloud
5239
5394
  # name
5240
5395
  # - 按照【特殊采集配置名称】进行模糊匹配过滤。
5241
5396
  # - 类型：String
5397
+ # - 示例：test-config
5242
5398
 
5243
5399
  # configExtraId
5244
5400
  # - 按照【特殊采集配置ID】进行过滤。
5245
5401
  # - 类型：String
5402
+ # - 示例：3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
5246
5403
 
5247
5404
  # topicId
5248
5405
  # - 按照【日志主题】进行过滤。
5249
5406
  # - 类型：String
5407
+ # - 示例：3581a3be-aa41-423b-995a-54ec84da6264
5250
5408
 
5251
5409
  # machineGroupId
5252
5410
  # - 按照【机器组ID】进行过滤。
5253
5411
  # - 类型：String
5412
+ # - 示例：f948972f-a063-408c-a59f-8c3230bddaf6
5254
5413
 
5255
5414
  # 每次请求的Filters的上限为10，Filter.Values的上限为5。
5256
5415
  # @type Filters: Array
@@ -5316,6 +5475,7 @@ module TencentCloud
5316
5475
  # DescribeConfigMachineGroups请求参数结构体
5317
5476
  class DescribeConfigMachineGroupsRequest < TencentCloud::Common::AbstractModel
5318
5477
  # @param ConfigId: 采集配置ID
5478
+ # - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
5319
5479
  # @type ConfigId: String
5320
5480
 
5321
5481
  attr_accessor :ConfigId
@@ -5363,16 +5523,20 @@ module TencentCloud
5363
5523
  # - 按照【采集配置名称】进行模糊匹配过滤。
5364
5524
  # - 类型：String
5365
5525
  # - 必选：否
5526
+ # - 示例：test-config
5366
5527
 
5367
5528
  # configId
5368
5529
  # - 按照【采集配置ID】进行过滤。
5369
5530
  # - 类型：String
5370
5531
  # - 必选：否
5532
+ # - 示例：3581a3be-aa41-423b-995a-54ec84da6264
5371
5533
 
5372
5534
  # topicId
5373
5535
  # - 按照【日志主题】进行过滤。
5374
5536
  # - 类型：String
5375
5537
  # - 必选：否
5538
+ # - 示例：3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
5539
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5376
5540
 
5377
5541
  # 每次请求的Filters的上限为10，Filter.Values的上限为5。
5378
5542
  # @type Filters: Array
@@ -5450,25 +5614,38 @@ module TencentCloud
5450
5614
  class DescribeConsoleSharingListResponse < TencentCloud::Common::AbstractModel
5451
5615
  # @param TotalCount: 分页的总数目
5452
5616
  # @type TotalCount: Integer
5617
+ # @param ConsoleSharingInfos: 控制台免密分享列表
5618
+ # @type ConsoleSharingInfos: Array
5453
5619
  # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
5454
5620
  # @type RequestId: String
5455
5621
 
5456
- attr_accessor :TotalCount, :RequestId
5622
+ attr_accessor :TotalCount, :ConsoleSharingInfos, :RequestId
5457
5623
 
5458
- def initialize(totalcount=nil, requestid=nil)
5624
+ def initialize(totalcount=nil, consolesharinginfos=nil, requestid=nil)
5459
5625
  @TotalCount = totalcount
5626
+ @ConsoleSharingInfos = consolesharinginfos
5460
5627
  @RequestId = requestid
5461
5628
  end
5462
5629
 
5463
5630
  def deserialize(params)
5464
5631
  @TotalCount = params['TotalCount']
5632
+ unless params['ConsoleSharingInfos'].nil?
5633
+ @ConsoleSharingInfos = []
5634
+ params['ConsoleSharingInfos'].each do |i|
5635
+ consolesharinginfo_tmp = ConsoleSharingInfo.new
5636
+ consolesharinginfo_tmp.deserialize(i)
5637
+ @ConsoleSharingInfos << consolesharinginfo_tmp
5638
+ end
5639
+ end
5465
5640
  @RequestId = params['RequestId']
5466
5641
  end
5467
5642
  end
5468
5643
 
5469
5644
  # DescribeConsumer请求参数结构体
5470
5645
  class DescribeConsumerRequest < TencentCloud::Common::AbstractModel
5471
- # @param TopicId: 投递任务绑定的日志主题 ID
5646
+ # @param TopicId: 投递任务绑定的日志主题Id。
5647
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
5648
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
5472
5649
  # @type TopicId: String
5473
5650
 
5474
5651
  attr_accessor :TopicId
@@ -5832,7 +6009,8 @@ module TencentCloud
5832
6009
 
5833
6010
  # DescribeExports请求参数结构体
5834
6011
  class DescribeExportsRequest < TencentCloud::Common::AbstractModel
5835
- # @param TopicId: 日志主题ID
6012
+ # @param TopicId: 日志主题Id
6013
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5836
6014
  # @type TopicId: String
5837
6015
  # @param Offset: 分页的偏移量，默认值为0
5838
6016
  # @type Offset: Integer
@@ -5954,7 +6132,9 @@ module TencentCloud
5954
6132
 
5955
6133
  # DescribeKafkaConsumer请求参数结构体
5956
6134
  class DescribeKafkaConsumerRequest < TencentCloud::Common::AbstractModel
5957
- # @param FromTopicId: 日志主题ID
6135
+ # @param FromTopicId: 日志主题Id。
6136
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
6137
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
5958
6138
  # @type FromTopicId: String
5959
6139
 
5960
6140
  attr_accessor :FromTopicId
@@ -6005,11 +6185,14 @@ module TencentCloud
6005
6185
 
6006
6186
  # DescribeKafkaRecharges请求参数结构体
6007
6187
  class DescribeKafkaRechargesRequest < TencentCloud::Common::AbstractModel
6008
- # @param TopicId: 日志主题 ID
6188
+ # @param TopicId: 日志主题Id。
6189
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6009
6190
  # @type TopicId: String
6010
- # @param Id: 导入配置ID
6191
+ # @param Id: 导入配置Id。
6192
+ # - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
6193
+ # - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
6011
6194
  # @type Id: String
6012
- # @param Status: 状态 status 1: 运行中, 2: 暂停...
6195
+ # @param Status: 状态。1: 运行中，2: 暂停，3：错误
6013
6196
  # @type Status: Integer
6014
6197
 
6015
6198
  attr_accessor :TopicId, :Id, :Status
@@ -6156,9 +6339,12 @@ module TencentCloud
6156
6339
  # @type From: Integer
6157
6340
  # @param To: 要查询的日志的结束时间，Unix时间戳，单位ms
6158
6341
  # @type To: Integer
6159
- # @param Query: 查询语句
6342
+ # @param Query: 检索分析语句。
6343
+ # 语句由 [检索条件] | [SQL语句]构成，无需对日志进行统计分析时，可省略其中的管道符 | 及SQL语句。
6344
+ # 使用*或空字符串可查询所有日志。
6160
6345
  # @type Query: String
6161
6346
  # @param TopicId: 要查询的日志主题ID
6347
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6162
6348
  # @type TopicId: String
6163
6349
  # @param Interval: 时间间隔: 单位ms 限制性条件：(To-From) / interval <= 200
6164
6350
  # @type Interval: Integer
@@ -6309,6 +6495,7 @@ module TencentCloud
6309
6495
  # DescribeMachineGroupConfigs请求参数结构体
6310
6496
  class DescribeMachineGroupConfigsRequest < TencentCloud::Common::AbstractModel
6311
6497
  # @param GroupId: 机器组ID
6498
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
6312
6499
  # @type GroupId: String
6313
6500
 
6314
6501
  attr_accessor :GroupId
@@ -6352,7 +6539,8 @@ module TencentCloud
6352
6539
 
6353
6540
  # DescribeMachineGroups请求参数结构体
6354
6541
  class DescribeMachineGroupsRequest < TencentCloud::Common::AbstractModel
6355
- # @param Filters: machineGroupName
6542
+ # @param Filters: 过滤条件
6543
+ # machineGroupName
6356
6544
  # - 按照【机器组名称】进行过滤。
6357
6545
  # - 类型：String
6358
6546
  # - 必选：否
@@ -6363,7 +6551,7 @@ module TencentCloud
6363
6551
  # - 必选：否
6364
6552
 
6365
6553
  # osType
6366
- # - 按照【操作系统类型】进行过滤。
6554
+ # - 按照【操作系统类型】进行过滤。0： Linux；1： Windows
6367
6555
  # - 类型：Int
6368
6556
  # - 必选：否
6369
6557
 
@@ -6626,7 +6814,8 @@ module TencentCloud
6626
6814
 
6627
6815
  # DescribePartitions请求参数结构体
6628
6816
  class DescribePartitionsRequest < TencentCloud::Common::AbstractModel
6629
- # @param TopicId: 日志主题ID
6817
+ # @param TopicId: 日志主题Id
6818
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6630
6819
  # @type TopicId: String
6631
6820
 
6632
6821
  attr_accessor :TopicId
@@ -6677,14 +6866,14 @@ module TencentCloud
6677
6866
  # @type Name: String
6678
6867
  # @param TaskId: 任务id。
6679
6868
  # @type TaskId: String
6680
- # @param Filters: <li>srcTopicName按照【源日志主题名称】进行过滤，模糊匹配。类型：String。必选：否</li>
6681
- # <li>dstTopicName按照【目标日志主题名称】进行过滤，模糊匹配。类型：String。必选：否</li>
6682
- # <li>srcTopicId按照【源日志主题ID】进行过滤。类型：String。必选：否</li>
6683
- # <li>dstTopicId按照【目标日志主题ID】进行过滤。类型：String。必选：否</li>
6684
- # <li>bizType按照【主题类型】进行过滤，0：日志主题；1：指标主题。类型：String。必选：否</li>
6685
- # <li>status按照【任务状态】进行过滤，1：运行；2：停止。类型：String。必选：否</li>
6686
- # <li>taskName按照【任务名称】进行过滤，模糊匹配。类型：String。必选：否</li>
6687
- # <li>taskId按照【任务ID】进行过滤，模糊匹配。类型：String。必选：否</li>
6869
+ # @param Filters: - srcTopicName按照【源日志主题名称】进行过滤，模糊匹配。类型：String。必选：否。示例：业务日志主题1 ，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
6870
+ # - dstTopicName按照【目标日志主题名称】进行过滤，模糊匹配。类型：String。必选：否。示例：业务日志主题 2，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
6871
+ # - srcTopicId按照【源日志主题ID】进行过滤。类型：String。必选：否。示例：a4478687-2382-4486-9692-de7986350f6b ，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
6872
+ # - dstTopicId按照【目标日志主题ID】进行过滤。类型：String。必选：否。示例：bd4d3375-d72a-4cd2-988d-d8eda2bd62b0，通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
6873
+ # - bizType按照【主题类型】进行过滤，0：日志主题；1：指标主题。类型：String。必选：否
6874
+ # - status按照【任务状态】进行过滤，1：运行；2：停止；3：异常。类型：String。必选：否
6875
+ # - taskName按照【任务名称】进行过滤，模糊匹配。类型：String。必选：否。示例：metricTask ，通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。
6876
+ # - taskId按照【任务ID】进行过滤，模糊匹配。类型：String。必选：否。示例：9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ，通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。
6688
6877
  # @type Filters: Array
6689
6878
 
6690
6879
  attr_accessor :Offset, :Limit, :Name, :TaskId, :Filters
@@ -6884,7 +7073,7 @@ module TencentCloud
6884
7073
  # @param Filters: <ul><li>topicName 按照【日志主题名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否</li>
6885
7074
  # <li>logsetName 按照【日志集名称】进行过滤，默认为模糊匹配，可使用 PreciseSearch 参数设置为精确匹配。类型：String。必选：否</li>
6886
7075
  # <li>topicId 按照【日志主题ID】进行过滤。类型：String。必选：否</li>
6887
- # <li>logsetId 按照【日志集ID】进行过滤，可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看；也可以调用 CreateLogset 创建新的日志集。类型：String。必选：否</li>
7076
+ # <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>
6888
7077
  # <li>tagKey 按照【标签键】进行过滤。类型：String。必选：否</li>
6889
7078
  # <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换，例如 tag:exampleKey。类型：String。必选：否</li>
6890
7079
  # <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot（标准存储），cold（低频存储）类型：String。必选：否</li></ul>
@@ -6978,7 +7167,7 @@ module TencentCloud
6978
7167
  # 按照【告警渠道回调配置渠道类型】进行过滤。
6979
7168
  # 类型：String
6980
7169
  # 必选：否
6981
-
7170
+ # 枚举值：WeCom，DingTalk，Lark，Http
6982
7171
  # 每次请求的Filters的上限为10，Filter.Values的上限为100。
6983
7172
  # @type Filters: Array
6984
7173
  # @param Offset: 分页的偏移量，默认值为0。
@@ -7119,9 +7308,12 @@ module TencentCloud
7119
7308
  # - System 系统日志
7120
7309
  # - ALL 所有日志
7121
7310
  # @type EventChannel: String
7122
- # @param TimeType: 时间类型，1:用户自定义，2:当前时间
7311
+ # @param TimeType: 时间字段（Timestamp）支持的类型
7312
+ # - 1（用户自定义时间）
7313
+ # - 2（当前时间）
7123
7314
  # @type TimeType: Integer
7124
7315
  # @param Timestamp: 时间，用户选择自定义时间类型时，需要指定时间，单位秒
7316
+ # 格式：时间戳，1754897446
7125
7317
  # @type Timestamp: Integer
7126
7318
  # @param EventIDs: 事件ID过滤列表
7127
7319
 
@@ -7187,13 +7379,14 @@ module TencentCloud
7187
7379
  # @type Count: Integer
7188
7380
  # @param Status: 日志下载状态。Processing:导出正在进行中，Completed:导出完成，Failed:导出失败，Expired:日志导出已过期(三天有效期), Queuing 排队中
7189
7381
  # @type Status: String
7190
- # @param From: 日志导出起始时间
7382
+ # @param From: 日志导出起始时间，毫秒时间戳
7191
7383
  # @type From: Integer
7192
- # @param To: 日志导出结束时间
7384
+ # @param To: 日志导出结束时间，毫秒时间戳
7193
7385
  # @type To: Integer
7194
7386
  # @param CosPath: 日志导出路径,有效期一个小时，请尽快使用该路径下载。
7195
7387
  # @type CosPath: String
7196
7388
  # @param CreateTime: 日志导出创建时间
7389
+ # 时间格式：yyyy-MM-dd HH:mm:ss
7197
7390
  # @type CreateTime: String
7198
7391
  # @param SyntaxRule: 语法规则。 默认值为0。
7199
7392
  # 0：Lucene语法，1：CQL语法。
@@ -7242,9 +7435,10 @@ module TencentCloud
7242
7435
 
7243
7436
  # 日志提取规则
7244
7437
  class ExtractRuleInfo < TencentCloud::Common::AbstractModel
7245
- # @param TimeKey: 时间字段的key名字，TikeKey和TimeFormat必须成对出现
7438
+ # @param TimeKey: 时间字段的key名字，TimeKey和TimeFormat必须成对出现
7246
7439
  # @type TimeKey: String
7247
7440
  # @param TimeFormat: 时间字段的格式，参考c语言的strftime函数对于时间的格式说明输出参数
7441
+ # - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
7248
7442
  # @type TimeFormat: String
7249
7443
  # @param Delimiter: 分隔符类型日志的分隔符，只有LogType为delimiter_log时有效
7250
7444
  # @type Delimiter: String
@@ -7500,7 +7694,9 @@ module TencentCloud
7500
7694
  # @type To: Integer
7501
7695
  # @param Query: 查询过滤条件，例如：
7502
7696
  # - 按告警策略ID查询：`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
7697
+ # - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
7503
7698
  # - 按监控对象ID查询：`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
7699
+ # - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
7504
7700
  # - 按告警策略ID及监控对象ID查询：`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
7505
7701
  # - 按告警策略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`
7506
7702
  # @type Query: String
@@ -7794,10 +7990,21 @@ module TencentCloud
7794
7990
  # Kafka访问协议
7795
7991
  class KafkaProtocolInfo < TencentCloud::Common::AbstractModel
7796
7992
  # @param Protocol: 协议类型，支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl，此协议会进行连接加密同时需要用户认证。
7797
- # 入参必填
7993
+
7994
+ # - 当IsEncryptionAddr为true时，Protocol必填。
7995
+ # - 支持的协议类型如下：
7996
+ # - plaintext：纯文本无加密协议
7997
+ # - sasl_ssl：SASL 认证 + SSL 加密
7998
+ # - ssl：纯 SSL/TLS 加密协议
7999
+ # - sasl_plaintext：SASL 认证 + 非加密通道
7798
8000
  # @type Protocol: String
7799
8001
  # @param Mechanism: 加密类型，支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
7800
- # 当Protocol为sasl_plaintext或sasl_ssl时必填
8002
+
8003
+ # - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。
8004
+ # - 支持加密类型如下
8005
+ # - PLAIN：明文认证
8006
+ # - SCRAM-SHA-256：基于挑战-响应机制，使用PBKDF2-HMAC-SHA256算法
8007
+ # - SCRAM-SHA-512：增强版SCRAM，使用PBKDF2-HMAC-SHA512算法
7801
8008
  # @type Mechanism: String
7802
8009
  # @param UserName: 用户名。
7803
8010
  # 当Protocol为sasl_plaintext或sasl_ssl时必填
@@ -8125,7 +8332,7 @@ module TencentCloud
8125
8332
  # @type RechargeType: String
8126
8333
  # @param EncodingFormat: 解析编码格式，0: UTF-8（默认值），1: GBK
8127
8334
  # @type EncodingFormat: Integer
8128
- # @param DefaultTimeSwitch: 使用默认时间，true：开启（默认值）， flase：关闭
8335
+ # @param DefaultTimeSwitch: 使用默认时间状态。true：开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳；false：关闭将使用日志中的时间字段作为日志时间戳。 默认：true
8129
8336
  # @type DefaultTimeSwitch: Boolean
8130
8337
  # @param LogRegex: 整条日志匹配规则，只有RechargeType为fullregex_log时有效
8131
8338
  # @type LogRegex: String
@@ -8137,13 +8344,100 @@ module TencentCloud
8137
8344
  # @type UnMatchLogTimeSrc: Integer
8138
8345
  # @param DefaultTimeSrc: 默认时间来源，0: 系统当前时间，1: Kafka消息时间戳
8139
8346
  # @type DefaultTimeSrc: Integer
8140
- # @param TimeKey: 时间字段
8347
+ # @param TimeKey: 时间字段，日志中代表时间的字段名。
8348
+
8349
+ # - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时， TimeKey不能为空。
8141
8350
  # @type TimeKey: String
8142
- # @param TimeRegex: 时间提取正则表达式
8351
+ # @param TimeRegex: 时间提取正则表达式。
8352
+ # - 当DefaultTimeSwitch为false，且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时， TimeRegex不能为空。
8353
+ # - 仅需输入日志中代表时间的字段的正则表达式即可；若匹配到多个字段，将使用第一个。
8354
+ # 例：日志原文为：message with time 2022-08-08 14:20:20，则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d
8143
8355
  # @type TimeRegex: String
8144
- # @param TimeFormat: 时间字段格式
8356
+ # @param TimeFormat: 时间字段格式。
8357
+ # - 当DefaultTimeSwitch为false时， TimeFormat不能为空。
8145
8358
  # @type TimeFormat: String
8146
- # @param TimeZone: 时间字段时区
8359
+ # @param TimeZone: 时间字段时区。
8360
+ # - 当DefaultTimeSwitch为false时， TimeZone不能为空。
8361
+ # - 时区格式规则
8362
+ # ​前缀​：使用 GMT 或 UTC 作为时区基准
8363
+ # ​偏移量​：
8364
+ # - `-` 表示西时区（比基准时间晚）
8365
+ # - `+` 表示东时区（比基准时间早）
8366
+ # - 格式为 ±HH:MM（小时:分钟）
8367
+
8368
+ # - 当前支持：
8369
+ # ```
8370
+ # "GMT-12:00"
8371
+ # "GMT-11:00"
8372
+ # "GMT-10:00"
8373
+ # "GMT-09:30"
8374
+ # "GMT-09:00"
8375
+ # "GMT-08:00"
8376
+ # "GMT-07:00"
8377
+ # "GMT-06:00"
8378
+ # "GMT-05:00"
8379
+ # "GMT-04:00"
8380
+ # "GMT-03:30"
8381
+ # "GMT-03:00"
8382
+ # "GMT-02:00"
8383
+ # "GMT-01:00"
8384
+ # "GMT+00:00"
8385
+ # "GMT+01:00"
8386
+ # "GMT+02:00"
8387
+ # "GMT+03:30"
8388
+ # "GMT+04:00"
8389
+ # "GMT+04:30"
8390
+ # "GMT+05:00"
8391
+ # "GMT+05:30"
8392
+ # "GMT+05:45"
8393
+ # "GMT+06:00"
8394
+ # "GMT+06:30"
8395
+ # "GMT+07:00"
8396
+ # "GMT+08:00"
8397
+ # "GMT+09:00"
8398
+ # "GMT+09:30"
8399
+ # "GMT+10:00"
8400
+ # "GMT+10:30"
8401
+ # "GMT+11:00"
8402
+ # "GMT+11:30"
8403
+ # "GMT+12:00"
8404
+ # "GMT+12:45"
8405
+ # "GMT+13:00"
8406
+ # "GMT+14:00"
8407
+ # "UTC-11:00"
8408
+ # "UTC-10:00"
8409
+ # "UTC-09:00"
8410
+ # "UTC-08:00"
8411
+ # "UTC-12:00"
8412
+ # "UTC-07:00"
8413
+ # "UTC-06:00"
8414
+ # "UTC-05:00"
8415
+ # "UTC-04:30"
8416
+ # "UTC-04:00"
8417
+ # "UTC-03:30"
8418
+ # "UTC-03:00"
8419
+ # "UTC-02:00"
8420
+ # "UTC-01:00"
8421
+ # "UTC+00:00"
8422
+ # "UTC+01:00"
8423
+ # "UTC+02:00"
8424
+ # "UTC+03:00"
8425
+ # "UTC+03:30"
8426
+ # "UTC+04:00"
8427
+ # "UTC+04:30"
8428
+ # "UTC+05:00"
8429
+ # "UTC+05:45"
8430
+ # "UTC+06:00"
8431
+ # "UTC+06:30"
8432
+ # "UTC+07:00"
8433
+ # "UTC+08:00"
8434
+ # "UTC+09:00"
8435
+ # "UTC+09:30"
8436
+ # "UTC+10:00"
8437
+ # "UTC+11:00"
8438
+ # "UTC+12:00"
8439
+ # "UTC+13:00"
8440
+ # ```
8147
8441
  # @type TimeZone: String
8148
8442
  # @param Metadata: 元数据信息，Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp
8149
8443
  # @type Metadata: Array
@@ -8247,18 +8541,21 @@ module TencentCloud
8247
8541
  # @param MachineGroupType: 机器组类型
8248
8542
  # @type MachineGroupType: :class:`Tencentcloud::Cls.v20201016.models.MachineGroupTypeInfo`
8249
8543
  # @param CreateTime: 创建时间
8544
+ # 时间格式：yyyy-MM-dd HH:mm:ss
8250
8545
  # @type CreateTime: String
8251
8546
  # @param Tags: 机器组绑定的标签列表
8252
8547
  # @type Tags: Array
8253
8548
  # @param AutoUpdate: 是否开启机器组自动更新
8254
8549
  # @type AutoUpdate: String
8255
8550
  # @param UpdateStartTime: 升级开始时间，建议业务低峰期升级LogListener
8551
+ # 时间格式：HH:mm:ss
8256
8552
  # @type UpdateStartTime: String
8257
8553
  # @param UpdateEndTime: 升级结束时间，建议业务低峰期升级LogListener
8554
+ # 时间格式：HH:mm:ss
8258
8555
  # @type UpdateEndTime: String
8259
8556
  # @param ServiceLogging: 是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费
8260
8557
  # @type ServiceLogging: Boolean
8261
- # @param DelayCleanupTime: 机器组中机器离线定期清理时间
8558
+ # @param DelayCleanupTime: 机器组中机器离线定期清理时间，单位天，默认设置30天。
8262
8559
  # @type DelayCleanupTime: Integer
8263
8560
  # @param MetaTags: 机器组元数据信息列表
8264
8561
  # @type MetaTags: Array
@@ -8389,9 +8686,10 @@ module TencentCloud
8389
8686
 
8390
8687
  # MergePartition请求参数结构体
8391
8688
  class MergePartitionRequest < TencentCloud::Common::AbstractModel
8392
- # @param TopicId: 日志主题ID
8689
+ # @param TopicId: 日志主题Id
8690
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8393
8691
  # @type TopicId: String
8394
- # @param PartitionId: 合并的PartitionId（找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等，且找到的分区必须是读写分区（Staus:readwrite），入参PartitionId与找到的PartitionId设置为只读分区（Status:readonly）,再新建一个新的读写分区） 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)
8692
+ # @param PartitionId: 合并的PartitionId（找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等，且找到的分区必须是读写分区（Status:readwrite），入参PartitionId与找到的PartitionId设置为只读分区（Status:readonly）,再新建一个新的读写分区） 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)
8395
8693
 
8396
8694
  # 1. 入参PartitionId只能是读写分区（Status的值有readonly，readwrite），且能找到入参PartitionId的下一个可读写分区（找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等）；
8397
8695
  # 2. 入参PartitionId不能是最后一个分区（PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff）；
@@ -8480,7 +8778,7 @@ module TencentCloud
8480
8778
 
8481
8779
  # ModifyAlarmNotice请求参数结构体
8482
8780
  class ModifyAlarmNoticeRequest < TencentCloud::Common::AbstractModel
8483
- # @param AlarmNoticeId: 通知渠道组ID。
8781
+ # @param AlarmNoticeId: 通知渠道组ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知渠道组ID
8484
8782
  # @type AlarmNoticeId: String
8485
8783
  # @param Tags: 标签描述列表，通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持10个标签键值对，并且不能有重复的键值对。
8486
8784
  # @type Tags: Array
@@ -8600,13 +8898,13 @@ module TencentCloud
8600
8898
 
8601
8899
  # ModifyAlarm请求参数结构体
8602
8900
  class ModifyAlarmRequest < TencentCloud::Common::AbstractModel
8603
- # @param AlarmId: 告警策略ID。
8901
+ # @param AlarmId: 告警策略ID。-通过[获取告警策略列表](https://cloud.tencent.com/document/product/614/56461)获取告警策略ID
8604
8902
  # @type AlarmId: String
8605
- # @param Name: 告警策略名称
8903
+ # @param Name: 告警策略名称。最大支持255个字节，不支持 '|'。
8606
8904
  # @type Name: String
8607
8905
  # @param MonitorTime: 监控任务运行时间点。
8608
8906
  # @type MonitorTime: :class:`Tencentcloud::Cls.v20201016.models.MonitorTime`
8609
- # @param Condition: 触发条件。
8907
+ # @param Condition: 告警信息发送的触发条件。
8610
8908
 
8611
8909
  # 注意:
8612
8910
  # - Condition和AlarmLevel是一组配置，MultiConditions是另一组配置，2组配置互斥。
@@ -8627,7 +8925,7 @@ module TencentCloud
8627
8925
  # @type TriggerCount: Integer
8628
8926
  # @param AlarmPeriod: 告警重复的周期。单位是分钟。取值范围是0~1440。
8629
8927
  # @type AlarmPeriod: Integer
8630
- # @param AlarmNoticeIds: 关联的告警通知模板列表。
8928
+ # @param AlarmNoticeIds: 关联的告警通知渠道列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取告警通知渠道列表
8631
8929
  # @type AlarmNoticeIds: Array
8632
8930
  # @param AlarmTargets: 监控对象列表。
8633
8931
  # @type AlarmTargets: Array
@@ -8767,13 +9065,13 @@ module TencentCloud
8767
9065
 
8768
9066
  # ModifyAlarmShield请求参数结构体
8769
9067
  class ModifyAlarmShieldRequest < TencentCloud::Common::AbstractModel
8770
- # @param TaskId: 屏蔽规则ID。
9068
+ # @param TaskId: 屏蔽规则ID。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
8771
9069
  # @type TaskId: String
8772
- # @param AlarmNoticeId: 通知渠道组id。
9070
+ # @param AlarmNoticeId: 通知渠道组id。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
8773
9071
  # @type AlarmNoticeId: String
8774
- # @param StartTime: 屏蔽开始时间（秒级时间戳）。
9072
+ # @param StartTime: 屏蔽开始时间，秒级(s)时间戳。
8775
9073
  # @type StartTime: Integer
8776
- # @param EndTime: 屏蔽结束时间（秒级时间戳）。
9074
+ # @param EndTime: 屏蔽结束时间，秒级(s)时间戳。
8777
9075
  # @type EndTime: Integer
8778
9076
  # @param Type: 屏蔽类型。1：屏蔽所有通知，2：按照Rule参数屏蔽匹配规则的通知。
8779
9077
  # @type Type: Integer
@@ -8782,6 +9080,7 @@ module TencentCloud
8782
9080
  # @param Reason: 屏蔽原因。
8783
9081
  # @type Reason: String
8784
9082
  # @param Status: 规则状态。只有规则状态为生效中（status:1）时，才能将其修改为已失效（status:2）。
9083
+ # 枚举：0（未生效），1（生效中），2（已失效）
8785
9084
  # @type Status: Integer
8786
9085
 
8787
9086
  attr_accessor :TaskId, :AlarmNoticeId, :StartTime, :EndTime, :Type, :Rule, :Reason, :Status
@@ -9037,6 +9336,8 @@ module TencentCloud
9037
9336
  # @param ConfigId: 采集规则配置ID，通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)返回信息获取。
9038
9337
  # @type ConfigId: String
9039
9338
  # @param Name: 采集规则配置名称
9339
+ # - 不能包含特殊字符｜
9340
+ # - 长度不能超过255字符，超过会被截断
9040
9341
  # @type Name: String
9041
9342
  # @param Path: 日志采集路径，包含文件名
9042
9343
  # @type Path: String
@@ -9057,6 +9358,7 @@ module TencentCloud
9057
9358
  # @param ExcludePaths: 采集黑名单路径列表
9058
9359
  # @type ExcludePaths: Array
9059
9360
  # @param Output: 采集配置关联的日志主题（TopicId）
9361
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
9060
9362
  # @type Output: String
9061
9363
  # @param UserDefineRule: 用户自定义解析字符串，Json格式序列化的字符串。
9062
9364
  # @type UserDefineRule: String
@@ -9123,7 +9425,9 @@ module TencentCloud
9123
9425
 
9124
9426
  # ModifyConsoleSharing请求参数结构体
9125
9427
  class ModifyConsoleSharingRequest < TencentCloud::Common::AbstractModel
9126
- # @param SharingId: 免密分享链接Id
9428
+ # @param SharingId: 免密分享Id。
9429
+ # - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
9430
+ # - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
9127
9431
  # @type SharingId: String
9128
9432
  # @param DurationMilliseconds: 指定分享链接有效期，单位：毫秒，最长可设定有效期为30天
9129
9433
  # @type DurationMilliseconds: Integer
@@ -9159,7 +9463,9 @@ module TencentCloud
9159
9463
 
9160
9464
  # ModifyConsumer请求参数结构体
9161
9465
  class ModifyConsumerRequest < TencentCloud::Common::AbstractModel
9162
- # @param TopicId: 投递任务绑定的日志主题 ID
9466
+ # @param TopicId: 投递任务绑定的日志主题Id。
9467
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
9468
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
9163
9469
  # @type TopicId: String
9164
9470
  # @param Effective: 投递任务是否生效，默认不生效
9165
9471
  # @type Effective: Boolean
@@ -9475,9 +9781,11 @@ module TencentCloud
9475
9781
 
9476
9782
  # ModifyKafkaConsumer请求参数结构体
9477
9783
  class ModifyKafkaConsumerRequest < TencentCloud::Common::AbstractModel
9478
- # @param FromTopicId: 日志主题ID
9784
+ # @param FromTopicId: 日志主题Id。
9785
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
9786
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
9479
9787
  # @type FromTopicId: String
9480
- # @param Compression: 压缩方式[0:NONE；2:SNAPPY；3:LZ4]
9788
+ # @param Compression: 压缩方式。0：不压缩；2：使用Snappy压缩；3：使用LZ4压缩
9481
9789
  # @type Compression: Integer
9482
9790
  # @param ConsumerContent: kafka协议消费数据格式
9483
9791
  # @type ConsumerContent: :class:`Tencentcloud::Cls.v20201016.models.KafkaConsumerContent`
@@ -9518,15 +9826,20 @@ module TencentCloud
9518
9826
 
9519
9827
  # ModifyKafkaRecharge请求参数结构体
9520
9828
  class ModifyKafkaRechargeRequest < TencentCloud::Common::AbstractModel
9521
- # @param Id: Kafka导入配置ID
9829
+ # @param Id: 导入配置Id。
9830
+ # - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
9831
+ # - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
9522
9832
  # @type Id: String
9523
- # @param TopicId: 导入CLS目标topic ID
9833
+ # @param TopicId: 导入CLS目标TopicId。
9834
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
9835
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。
9524
9836
  # @type TopicId: String
9525
9837
  # @param Name: Kafka导入配置名称
9526
9838
  # @type Name: String
9527
9839
  # @param KafkaType: 导入Kafka类型，0：腾讯云CKafka：1：用户自建Kafka。
9528
9840
  # @type KafkaType: Integer
9529
9841
  # @param KafkaInstance: 腾讯云CKafka实例ID，KafkaType为0时必填。
9842
+ # - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
9530
9843
  # @type KafkaInstance: String
9531
9844
  # @param ServerAddr: 服务地址，KafkaType为1时必填。
9532
9845
  # @type ServerAddr: String
@@ -9534,13 +9847,15 @@ module TencentCloud
9534
9847
  # @type IsEncryptionAddr: Boolean
9535
9848
  # @param Protocol: 加密访问协议，KafkaType参数为1并且IsEncryptionAddr参数为true时必填。
9536
9849
  # @type Protocol: :class:`Tencentcloud::Cls.v20201016.models.KafkaProtocolInfo`
9537
- # @param UserKafkaTopics: 用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开
9850
+ # @param UserKafkaTopics: 用户需要导入的Kafka相关topic列表，多个topic之间使用半角逗号隔开。
9851
+
9852
+ # - Kafka类型为腾讯云CKafka时：通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
9538
9853
  # @type UserKafkaTopics: String
9539
9854
  # @param ConsumerGroupName: 用户Kafka消费组名称
9540
9855
  # @type ConsumerGroupName: String
9541
9856
  # @param LogRechargeRule: 日志导入规则
9542
9857
  # @type LogRechargeRule: :class:`Tencentcloud::Cls.v20201016.models.LogRechargeRuleInfo`
9543
- # @param StatusControl: 导入控制，1：暂停；2：继续。
9858
+ # @param StatusControl: 导入控制，1：暂停；2：启动。
9544
9859
  # @type StatusControl: Integer
9545
9860
 
9546
9861
  attr_accessor :Id, :TopicId, :Name, :KafkaType, :KafkaInstance, :ServerAddr, :IsEncryptionAddr, :Protocol, :UserKafkaTopics, :ConsumerGroupName, :LogRechargeRule, :StatusControl
@@ -9647,9 +9962,13 @@ module TencentCloud
9647
9962
 
9648
9963
  # ModifyMachineGroup请求参数结构体
9649
9964
  class ModifyMachineGroupRequest < TencentCloud::Common::AbstractModel
9650
- # @param GroupId: 机器组ID
9965
+ # @param GroupId: 机器组Id
9966
+ # - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
9651
9967
  # @type GroupId: String
9652
9968
  # @param GroupName: 机器组名称
9969
+ # 输入限制：
9970
+ # - 不能为空字符串
9971
+ # - 不能包含字符'|'
9653
9972
  # @type GroupName: String
9654
9973
  # @param MachineGroupType: 机器组类型。
9655
9974
  # Type：ip，Values中为ip字符串列表机器组；
@@ -9660,8 +9979,10 @@ module TencentCloud
9660
9979
  # @param AutoUpdate: 是否开启机器组自动更新
9661
9980
  # @type AutoUpdate: Boolean
9662
9981
  # @param UpdateStartTime: 升级开始时间，建议业务低峰期升级LogListener
9982
+ # 时间格式：HH:mm:ss
9663
9983
  # @type UpdateStartTime: String
9664
9984
  # @param UpdateEndTime: 升级结束时间，建议业务低峰期升级LogListener
9985
+ # 时间格式：HH:mm:ss
9665
9986
  # @type UpdateEndTime: String
9666
9987
  # @param ServiceLogging: 是否开启服务日志，用于记录因Loglistener 服务自身产生的log，开启后，会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business，不产生计费
9667
9988
  # @type ServiceLogging: Boolean
@@ -9734,7 +10055,7 @@ module TencentCloud
9734
10055
 
9735
10056
  # ModifyNoticeContent请求参数结构体
9736
10057
  class ModifyNoticeContentRequest < TencentCloud::Common::AbstractModel
9737
- # @param NoticeContentId: 通知内容模板ID。
10058
+ # @param NoticeContentId: 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
9738
10059
  # @type NoticeContentId: String
9739
10060
  # @param Name: 通知内容模板名称。
9740
10061
  # @type Name: String
@@ -9787,9 +10108,9 @@ module TencentCloud
9787
10108
 
9788
10109
  # ModifyScheduledSql请求参数结构体
9789
10110
  class ModifyScheduledSqlRequest < TencentCloud::Common::AbstractModel
9790
- # @param TaskId: 任务ID
10111
+ # @param TaskId: 任务ID，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
9791
10112
  # @type TaskId: String
9792
- # @param SrcTopicId: 源日志主题
10113
+ # @param SrcTopicId: 源日志主题，通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
9793
10114
  # @type SrcTopicId: String
9794
10115
  # @param EnableFlag: 任务启动状态. 1开启, 2关闭
9795
10116
  # @type EnableFlag: Integer
@@ -9797,15 +10118,15 @@ module TencentCloud
9797
10118
  # @type DstResource: :class:`Tencentcloud::Cls.v20201016.models.ScheduledSqlResouceInfo`
9798
10119
  # @param ScheduledSqlContent: 查询语句
9799
10120
  # @type ScheduledSqlContent: String
9800
- # @param ProcessPeriod: 调度周期(分钟)
10121
+ # @param ProcessPeriod: 调度周期(分钟)，1~1440分钟
9801
10122
  # @type ProcessPeriod: Integer
9802
10123
  # @param ProcessTimeWindow: 单次查询的时间窗口. 例子中为近15分钟
9803
10124
  # @type ProcessTimeWindow: String
9804
- # @param ProcessDelay: 执行延迟(秒)
10125
+ # @param ProcessDelay: 执行延迟(秒)，0~120秒，默认60秒
9805
10126
  # @type ProcessDelay: Integer
9806
- # @param SrcTopicRegion: 源topicId的地域信息
10127
+ # @param SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
9807
10128
  # @type SrcTopicRegion: String
9808
- # @param Name: 任务名称
10129
+ # @param Name: 任务名称，0~255字符
9809
10130
  # @type Name: String
9810
10131
  # @param SyntaxRule: 语法规则。 默认值为0。 0：Lucene语法，1：CQL语法
9811
10132
  # @type SyntaxRule: Integer
@@ -9972,8 +10293,13 @@ module TencentCloud
9972
10293
  # ModifyTopic请求参数结构体
9973
10294
  class ModifyTopicRequest < TencentCloud::Common::AbstractModel
9974
10295
  # @param TopicId: 日志主题ID
10296
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
9975
10297
  # @type TopicId: String
9976
10298
  # @param TopicName: 日志主题名称
10299
+ # 输入限制：
10300
+ # - 不能为空字符串
10301
+ # - 不能包含字符'|'
10302
+ # - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
9977
10303
  # @type TopicName: String
9978
10304
  # @param Tags: 标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，并且不能有重复的键值对。
9979
10305
  # @type Tags: Array
@@ -9982,7 +10308,8 @@ module TencentCloud
9982
10308
  # @type Status: Boolean
9983
10309
  # @param AutoSplit: 是否开启自动分裂
9984
10310
  # @type AutoSplit: Boolean
9985
- # @param MaxSplitPartitions: 若开启最大分裂，该主题能够能够允许的最大分区数
10311
+ # @param MaxSplitPartitions: 若开启最大分裂，该主题能够能够允许的最大分区数；
10312
+ # 默认为50；必须为正数
9986
10313
  # @type MaxSplitPartitions: Integer
9987
10314
  # @param Period: 生命周期，单位天，标准存储取值范围1\~3600，低频存储取值范围7\~3600。取值为3640时代表永久保存
9988
10315
  # @type Period: Integer
@@ -9996,9 +10323,15 @@ module TencentCloud
9996
10323
  # @type IsWebTracking: Boolean
9997
10324
  # @param Extends: 日志主题扩展信息
9998
10325
  # @type Extends: :class:`Tencentcloud::Cls.v20201016.models.TopicExtendInfo`
9999
- # @param PartitionCount: 日志主题分区数量
10326
+ # @param PartitionCount: 日志主题分区数量。
10327
+ # 默认为1；
10328
+ # 取值范围及约束：
10329
+ # - 当输入值<=0，系统自动调整为1。
10330
+ # - 如果未传MaxSplitPartitions，需要PartitionCount<=50；
10331
+ # - 如果传递了MaxSplitPartitions，需要PartitionCount<=MaxSplitPartitions；
10000
10332
  # @type PartitionCount: Integer
10001
10333
  # @param CancelTopicAsyncTaskID: 取消切换存储任务的id
10334
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
10002
10335
  # @type CancelTopicAsyncTaskID: String
10003
10336
 
10004
10337
  attr_accessor :TopicId, :TopicName, :Tags, :Status, :AutoSplit, :MaxSplitPartitions, :Period, :Describes, :HotPeriod, :IsWebTracking, :Extends, :PartitionCount, :CancelTopicAsyncTaskID
@@ -10064,9 +10397,9 @@ module TencentCloud
10064
10397
 
10065
10398
  # ModifyWebCallback请求参数结构体
10066
10399
  class ModifyWebCallbackRequest < TencentCloud::Common::AbstractModel
10067
- # @param WebCallbackId: 告警渠道回调配置ID。
10400
+ # @param WebCallbackId: 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
10068
10401
  # @type WebCallbackId: String
10069
- # @param Name: 告警渠道回调配置名称。
10402
+ # @param Name: 告警渠道回调配置名称。最大支持255个字节
10070
10403
  # @type Name: String
10071
10404
  # @param Type: 渠道类型
10072
10405
 
@@ -10080,7 +10413,7 @@ module TencentCloud
10080
10413
 
10081
10414
  # 注意：当Type为Http时，必填。
10082
10415
  # @type Method: String
10083
- # @param Key: 秘钥信息。
10416
+ # @param Key: 秘钥信息。最大支持1024个字节
10084
10417
  # @type Key: String
10085
10418
 
10086
10419
  attr_accessor :WebCallbackId, :Name, :Type, :Webhook, :Method, :Key
@@ -10131,7 +10464,7 @@ module TencentCloud
10131
10464
  # @param Time: 执行的周期，或者定制执行的时间节点。单位为分钟，取值范围为1~1440。
10132
10465
  # 当type为`Period`,`Fixed`时，time字段生效。
10133
10466
  # @type Time: Integer
10134
- # @param CronExpression: 执行的周期cron表达式。示例：`"*/1 * * * *"` 从左到右每个field的含义 Minutes field, Hours field,Day of month field,Month field,Day of week field， 不支持秒级别。
10467
+ # @param CronExpression: 执行的周期cron表达式。示例：`"*/1 * * * *"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期)， 不支持秒级别。
10135
10468
  # 当type为`Cron`时，CronExpression字段生效。
10136
10469
  # @type CronExpression: String
10137
10470
 
@@ -10227,7 +10560,7 @@ module TencentCloud
10227
10560
  # 通知模板内容
10228
10561
  class NoticeContentInfo < TencentCloud::Common::AbstractModel
10229
10562
  # @param Title: 通知内容模板标题信息。
10230
- # 部分通知渠道类型不支持“标题”，请参照腾讯云控制台页面。
10563
+ # 部分通知渠道类型不支持“标题”，请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
10231
10564
  # @type Title: String
10232
10565
  # @param Content: 通知内容模板正文信息。
10233
10566
  # @type Content: String
@@ -10272,9 +10605,9 @@ module TencentCloud
10272
10605
  # @type Uin: Integer
10273
10606
  # @param SubUin: 创建/修改者子账号。
10274
10607
  # @type SubUin: Integer
10275
- # @param CreateTime: 创建时间 秒级时间戳。
10608
+ # @param CreateTime: 创建时间 秒级(s)时间戳。
10276
10609
  # @type CreateTime: Integer
10277
- # @param UpdateTime: 更新时间 秒级时间戳。
10610
+ # @param UpdateTime: 更新时间 秒级(s)时间戳。
10278
10611
  # @type UpdateTime: Integer
10279
10612
 
10280
10613
  attr_accessor :NoticeContentId, :Name, :Type, :NoticeContents, :Flag, :Uin, :SubUin, :CreateTime, :UpdateTime
@@ -10328,7 +10661,7 @@ module TencentCloud
10328
10661
  # - WeChat - 微信
10329
10662
  # - Phone - 电话
10330
10663
  # @type ReceiverChannels: Array
10331
- # @param NoticeContentId: 通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。
10664
+ # @param NoticeContentId: 通知内容模板ID，使用Default-zh引用默认模板（中文），使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID
10332
10665
  # @type NoticeContentId: String
10333
10666
  # @param StartTime: 允许接收信息的开始时间。格式：`15:04:05`。必填
10334
10667
  # @type StartTime: String
@@ -10481,7 +10814,9 @@ module TencentCloud
10481
10814
 
10482
10815
  # OpenKafkaConsumer请求参数结构体
10483
10816
  class OpenKafkaConsumerRequest < TencentCloud::Common::AbstractModel
10484
- # @param FromTopicId: 日志主题ID
10817
+ # @param FromTopicId: 日志主题Id。
10818
+ # - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
10819
+ # - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
10485
10820
  # @type FromTopicId: String
10486
10821
  # @param Compression: 压缩方式[0:NONE；2:SNAPPY；3:LZ4]，默认：0
10487
10822
  # @type Compression: Integer
@@ -10584,8 +10919,10 @@ module TencentCloud
10584
10919
  # @param ExclusiveEndKey: 分区哈希键结束key
10585
10920
  # @type ExclusiveEndKey: String
10586
10921
  # @param CreateTime: 分区创建时间
10922
+ # 时间格式：yyyy-MM-dd HH:mm:ss
10587
10923
  # @type CreateTime: String
10588
10924
  # @param LastWriteTime: 只读分区数据停止写入时间
10925
+ # 时间格式：yyyy-MM-dd HH:mm:ss
10589
10926
  # 注意：此字段可能返回 null，表示取不到有效值。
10590
10927
  # @type LastWriteTime: String
10591
10928
 
@@ -10745,8 +11082,10 @@ module TencentCloud
10745
11082
  # QueryMetric请求参数结构体
10746
11083
  class QueryMetricRequest < TencentCloud::Common::AbstractModel
10747
11084
  # @param Query: 查询语句，使用PromQL语法
11085
+ # - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
10748
11086
  # @type Query: String
10749
11087
  # @param TopicId: 指标主题ID
11088
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
10750
11089
  # @type TopicId: String
10751
11090
  # @param Time: 查询时间，秒级Unix时间戳。为空时代表当前时间戳。
10752
11091
  # @type Time: Integer
@@ -10768,7 +11107,11 @@ module TencentCloud
10768
11107
 
10769
11108
  # QueryMetric返回参数结构体
10770
11109
  class QueryMetricResponse < TencentCloud::Common::AbstractModel
10771
- # @param ResultType: 指标查询结果类型
11110
+ # @param ResultType: 指标查询结果类型，支持
11111
+ # - scalar 标量值
11112
+ # - string 字符串值
11113
+ # - vector 瞬时向量
11114
+ # - matrix 区间向量
10772
11115
  # @type ResultType: String
10773
11116
  # @param Result: 指标查询结果
10774
11117
  # @type Result: String
@@ -10793,8 +11136,10 @@ module TencentCloud
10793
11136
  # QueryRangeMetric请求参数结构体
10794
11137
  class QueryRangeMetricRequest < TencentCloud::Common::AbstractModel
10795
11138
  # @param TopicId: 指标主题ID
11139
+ # - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
10796
11140
  # @type TopicId: String
10797
11141
  # @param Query: 查询语句，使用PromQL语法
11142
+ # - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
10798
11143
  # @type Query: String
10799
11144
  # @param Start: 查询起始时间，秒级Unix时间戳
10800
11145
  # @type Start: Integer
@@ -10824,7 +11169,11 @@ module TencentCloud
10824
11169
 
10825
11170
  # QueryRangeMetric返回参数结构体
10826
11171
  class QueryRangeMetricResponse < TencentCloud::Common::AbstractModel
10827
- # @param ResultType: 指标查询结果类型
11172
+ # @param ResultType: 指标查询结果类型，支持
11173
+ # - scalar 标量值
11174
+ # - string 字符串值
11175
+ # - vector 瞬时向量
11176
+ # - matrix 区间向量
10828
11177
  # @type ResultType: String
10829
11178
  # @param Result: 指标查询结果
10830
11179
  # @type Result: String
@@ -10987,9 +11336,9 @@ module TencentCloud
10987
11336
 
10988
11337
  # ScheduledSql的资源信息
10989
11338
  class ScheduledSqlResouceInfo < TencentCloud::Common::AbstractModel
10990
- # @param TopicId: 目标主题id
11339
+ # @param TopicId: 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
10991
11340
  # @type TopicId: String
10992
- # @param Region: 主题的地域信息
11341
+ # @param Region: 主题的地域信息，当前不支持跨地域，支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
10993
11342
  # @type Region: String
10994
11343
  # @param BizType: 主题类型：0为日志主题，1为指标主题
10995
11344
  # @type BizType: Integer
@@ -11050,9 +11399,9 @@ module TencentCloud
11050
11399
  # @type SrcTopicName: String
11051
11400
  # @param DstResource: 定时SQL分析目标主题
11052
11401
  # @type DstResource: :class:`Tencentcloud::Cls.v20201016.models.ScheduledSqlResouceInfo`
11053
- # @param CreateTime: 任务创建时间
11402
+ # @param CreateTime: 任务创建时间。格式：yyyy-MM-dd HH:mm:ss
11054
11403
  # @type CreateTime: String
11055
- # @param UpdateTime: 任务更新时间
11404
+ # @param UpdateTime: 任务更新时间，格式：yyyy-MM-dd HH:mm:ss
11056
11405
  # @type UpdateTime: String
11057
11406
  # @param Status: 任务状态，1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题
11058
11407
 
@@ -11062,19 +11411,19 @@ module TencentCloud
11062
11411
  # @type EnableFlag: Integer
11063
11412
  # @param ScheduledSqlContent: 查询语句
11064
11413
  # @type ScheduledSqlContent: String
11065
- # @param ProcessStartTime: 调度开始时间
11414
+ # @param ProcessStartTime: 调度开始时间，格式：yyyy-MM-dd HH:mm:ss
11066
11415
  # @type ProcessStartTime: String
11067
11416
  # @param ProcessType: 调度类型，1:持续运行 2:指定时间范围
11068
11417
  # @type ProcessType: Integer
11069
- # @param ProcessEndTime: 调度结束时间，当process_type=2时为必传字段
11418
+ # @param ProcessEndTime: 调度结束时间，格式：yyyy-MM-dd HH:mm:ss，当process_type=2时为必传字段
11070
11419
  # @type ProcessEndTime: String
11071
- # @param ProcessPeriod: 调度周期(分钟)
11420
+ # @param ProcessPeriod: 调度周期(分钟)，1~1440分钟
11072
11421
  # @type ProcessPeriod: Integer
11073
11422
  # @param ProcessTimeWindow: 查询的时间窗口. @m-15m, @m，意为近15分钟
11074
11423
  # @type ProcessTimeWindow: String
11075
- # @param ProcessDelay: 执行延迟(秒)
11424
+ # @param ProcessDelay: 执行延迟(秒)，0~120秒，默认60秒
11076
11425
  # @type ProcessDelay: Integer
11077
- # @param SrcTopicRegion: 源topicId的地域信息
11426
+ # @param SrcTopicRegion: 源topicId的地域信息，支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
11078
11427
  # @type SrcTopicRegion: String
11079
11428
  # @param SyntaxRule: 语法规则，0：Lucene语法，1：CQL语法
11080
11429
  # @type SyntaxRule: Integer
@@ -11876,6 +12225,7 @@ module TencentCloud
11876
12225
  # @param AssumerName: 云产品标识，主题由其它云产品创建时，该字段会显示云产品名称，例如CDN、TKE
11877
12226
  # @type AssumerName: String
11878
12227
  # @param CreateTime: 创建时间
12228
+ # 时间格式：yyyy-MM-dd HH:mm:ss
11879
12229
  # @type CreateTime: String
11880
12230
  # @param Status: 主题是否开启采集，true：开启采集；false：关闭采集。
11881
12231
  # 创建日志主题时默认开启，可通过SDK调用ModifyTopic修改此字段。
@@ -11914,8 +12264,13 @@ module TencentCloud
11914
12264
  # @param TopicAsyncTaskID: 异步迁移任务ID
11915
12265
  # @type TopicAsyncTaskID: String
11916
12266
  # @param MigrationStatus: 异步迁移状态
12267
+ # - 1：进行中
12268
+ # - 2：已完成
12269
+ # - 3：失败
12270
+ # - 4：已取消
11917
12271
  # @type MigrationStatus: Integer
11918
12272
  # @param EffectiveDate: 异步迁移完成后，预计生效日期
12273
+ # 时间格式：yyyy-MM-dd HH:mm:ss
11919
12274
  # @type EffectiveDate: String
11920
12275
 
11921
12276
  attr_accessor :LogsetId, :TopicId, :TopicName, :PartitionCount, :Index, :AssumerName, :CreateTime, :Status, :Tags, :AutoSplit, :MaxSplitPartitions, :StorageType, :Period, :SubAssumerName, :Describes, :HotPeriod, :BizType, :IsWebTracking, :Extends, :TopicAsyncTaskID, :MigrationStatus, :EffectiveDate
@@ -12065,15 +12420,15 @@ module TencentCloud
12065
12420
  # 回调地址
12066
12421
  class WebCallback < TencentCloud::Common::AbstractModel
12067
12422
  # @param CallbackType: 回调的类型。可选值：
12068
- # - Http
12069
- # - WeCom
12070
- # - DingTalk
12071
- # - Lark
12423
+ # - Http(自定义接口回调)
12424
+ # - WeCom(企业微信)
12425
+ # - DingTalk(钉钉)
12426
+ # - Lark(飞书)
12072
12427
  # @type CallbackType: String
12073
12428
  # @param Url: 回调地址，最大支持1024个字节。
12074
12429
  # 也可使用WebCallbackId引用集成配置中的URL，此时该字段请填写为空字符串。
12075
12430
  # @type Url: String
12076
- # @param WebCallbackId: 集成配置ID。
12431
+ # @param WebCallbackId: 集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID
12077
12432
  # @type WebCallbackId: String
12078
12433
  # @param Method: 回调方法。可选值：
12079
12434
  # - POST（默认值）
@@ -12158,9 +12513,9 @@ module TencentCloud
12158
12513
  # @type Uin: Integer
12159
12514
  # @param SubUin: 子账号。
12160
12515
  # @type SubUin: Integer
12161
- # @param CreateTime: 创建时间。秒级时间戳
12516
+ # @param CreateTime: 创建时间。秒(s)级时间戳
12162
12517
  # @type CreateTime: Integer
12163
- # @param UpdateTime: 更新时间。秒级时间戳
12518
+ # @param UpdateTime: 更新时间。秒(s)级时间戳
12164
12519
  # @type UpdateTime: Integer
12165
12520
 
12166
12521
  attr_accessor :WebCallbackId, :Name, :Type, :Webhook, :Method, :Key, :Uin, :SubUin, :CreateTime, :UpdateTime