tencentcloud-sdk-cls 3.0.814 → 3.0.816

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20201016/models.rb +252 -56
  4. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b812e9c169a9f595fd41f63b0e2c42a23b5eadf7
4
- data.tar.gz: 8755146daa243894c85947ffa10b0d8b0831104b
3
+ metadata.gz: ba93f4db80fa725153714446fb0804242b70c6f1
4
+ data.tar.gz: 32f3948d962bca7a0761bc7ddff2caf6a22aa08f
5
5
  SHA512:
6
- metadata.gz: c2b9eab72298370741829d078c09b776edba1091eb478d7750bba3bf325b637b34009ab588e2f07149c1e6e8a91db65a65ef936523e29ff2121cd570350b4629
7
- data.tar.gz: 3385873dbf586e492d815b528c9fd2c11b330be3e3b7bb1e9d7bac0d4777aa7a1c865f24efef8b29ea6e5a6130cf74a9df0aec0bdde68ffb3087160c61f1b660
6
+ metadata.gz: fe955e14ca83dfe799e04f1967e74ce1549bfc0eeac096afc6caec97ec24456e000a6653a1c478fa83f301ce28d87e7e7ba86f62888733c37d3e7c07f496ecb6
7
+ data.tar.gz: 307ecb3be125c212b0a75459f8abd72c487fa3ffdb5d573ff6d051c288c8ce018737d5b80713aaf69d7192474f1b5ca9a353f0ae58b994ac9c8895e146bac792
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.814
1
+ 3.0.816
@@ -1592,19 +1592,33 @@ module TencentCloud
1592
1592
  # @param Name: 通知渠道组名称。
1593
1593
  # @type Name: String
1594
1594
  # @param Type: 通知类型。可选值:
1595
- # <li> Trigger - 告警触发 </li>
1596
- # <li> Recovery - 告警恢复</li>
1597
- # <li> All - 告警触发和告警恢复</li>
1595
+ # - Trigger - 告警触发
1596
+ # - Recovery - 告警恢复
1597
+ # - All - 告警触发和告警恢复
1598
+
1599
+
1600
+ # 注意:
1601
+ # - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
1602
+ # - 2组rule配置互斥
1603
+ # - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
1598
1604
  # @type Type: String
1599
1605
  # @param NoticeReceivers: 通知接收对象。
1606
+ # 注意:
1607
+ # - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
1608
+ # - 2组rule配置互斥
1609
+ # - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
1600
1610
  # @type NoticeReceivers: Array
1601
1611
  # @param WebCallbacks: 接口回调信息(包括企业微信)。
1612
+ # 注意:
1613
+ # - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
1614
+ # - 2组rule配置互斥
1615
+ # - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
1602
1616
  # @type WebCallbacks: Array
1603
1617
  # @param NoticeRules: 通知规则。
1604
-
1605
1618
  # 注意:
1606
-
1607
- # - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。
1619
+ # - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
1620
+ # - 2组rule配置互斥
1621
+ # - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
1608
1622
 
1609
1623
  # @type NoticeRules: Array
1610
1624
 
@@ -1898,11 +1912,19 @@ module TencentCloud
1898
1912
  # @type Name: String
1899
1913
  # @param TopicId: 日志主题id
1900
1914
  # @type TopicId: String
1901
- # @param Type: 类型:container_stdoutcontainer_filehost_file
1915
+ # @param Type: 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。
1902
1916
  # @type Type: String
1903
- # @param LogType: 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
1917
+ # @param LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
1918
+ # - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
1919
+ # - delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
1920
+ # - minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
1921
+ # - fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
1922
+ # - multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
1923
+ # - multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
1924
+ # - user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
1904
1925
  # @type LogType: String
1905
- # @param ConfigFlag: 采集配置标
1926
+ # @param ConfigFlag: 采集配置标记。
1927
+ # - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
1906
1928
  # @type ConfigFlag: String
1907
1929
  # @param LogsetId: 日志集id
1908
1930
  # @type LogsetId: String
@@ -1910,19 +1932,23 @@ module TencentCloud
1910
1932
  # @type LogsetName: String
1911
1933
  # @param TopicName: 日志主题名称
1912
1934
  # @type TopicName: String
1913
- # @param HostFile: 节点文件配置信息
1935
+ # @param HostFile: 节点文件路径类型配置。
1914
1936
  # @type HostFile: :class:`Tencentcloud::Cls.v20201016.models.HostFileInfo`
1915
- # @param ContainerFile: 容器文件路径信息
1937
+ # @param ContainerFile: 容器文件路径类型配置。
1916
1938
  # @type ContainerFile: :class:`Tencentcloud::Cls.v20201016.models.ContainerFileInfo`
1917
- # @param ContainerStdout: 容器标准输出信息
1939
+ # @param ContainerStdout: 容器标准输出类型配置。
1918
1940
  # @type ContainerStdout: :class:`Tencentcloud::Cls.v20201016.models.ContainerStdoutInfo`
1919
- # @param LogFormat: 日志格式化方式
1941
+ # @param LogFormat: 日志格式化方式,用于容器采集场景。
1942
+ # - stdout-docker-json:用于docker容器采集场景
1943
+ # - stdout-containerd:用于containerd容器采集场景
1920
1944
  # @type LogFormat: String
1921
1945
  # @param ExtractRule: 提取规则,如果设置了ExtractRule,则必须设置LogType
1922
1946
  # @type ExtractRule: :class:`Tencentcloud::Cls.v20201016.models.ExtractRuleInfo`
1923
1947
  # @param ExcludePaths: 采集黑名单路径列表
1924
1948
  # @type ExcludePaths: Array
1925
- # @param UserDefineRule: 用户自定义采集规则,Json格式序列化的字符串
1949
+ # @param UserDefineRule: 组合解析采集规则,用于复杂场景下的日志采集。
1950
+ # - 取值参考:[使用组合解析提取模式采集日志
1951
+ # ](https://cloud.tencent.com/document/product/614/61310)
1926
1952
  # @type UserDefineRule: String
1927
1953
  # @param GroupId: 绑定的机器组id
1928
1954
  # @type GroupId: String
@@ -1934,7 +1960,7 @@ module TencentCloud
1934
1960
  # - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
1935
1961
  # - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
1936
1962
  # - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
1937
- # 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
1963
+ # - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
1938
1964
  # @type AdvancedConfig: String
1939
1965
 
1940
1966
  attr_accessor :Name, :TopicId, :Type, :LogType, :ConfigFlag, :LogsetId, :LogsetName, :TopicName, :HostFile, :ContainerFile, :ContainerStdout, :LogFormat, :ExtractRule, :ExcludePaths, :UserDefineRule, :GroupId, :GroupIds, :CollectInfos, :AdvancedConfig
@@ -2036,7 +2062,7 @@ module TencentCloud
2036
2062
  # @type Name: String
2037
2063
  # @param Output: 采集配置所属日志主题ID即TopicId
2038
2064
  # @type Output: String
2039
- # @param Path: 日志采集路径,包含文件名
2065
+ # @param Path: 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
2040
2066
  # @type Path: String
2041
2067
  # @param LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
2042
2068
  # - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
@@ -2292,7 +2318,12 @@ module TencentCloud
2292
2318
  # @type SrcTopicId: String
2293
2319
  # @param Name: 加工任务名称
2294
2320
  # @type Name: String
2295
- # @param EtlContent: 加工语句。[创建加工任务](https://cloud.tencent.com/document/product/614/63940) [函数总览](https://cloud.tencent.com/document/product/614/70395)
2321
+ # @param EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
2322
+
2323
+ # 其他参考文档:
2324
+
2325
+ # - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
2326
+ # - [函数总览](https://cloud.tencent.com/document/product/614/70395)
2296
2327
  # @type EtlContent: String
2297
2328
  # @param TaskType: 加工类型。
2298
2329
  # 1:使用源日志主题中的随机数据,进行加工预览;2:使用用户自定义测试数据,进行加工预览;3:创建真实加工任务。
@@ -2670,7 +2701,9 @@ module TencentCloud
2670
2701
  class CreateMachineGroupRequest < TencentCloud::Common::AbstractModel
2671
2702
  # @param GroupName: 机器组名字,不能重复
2672
2703
  # @type GroupName: String
2673
- # @param MachineGroupType: 创建机器组类型。Type:ip,Values中为ip字符串列表创建机器组;Type:label,Values中为标签字符串列表创建机器组。
2704
+ # @param MachineGroupType: 创建机器组类型。取值如下:
2705
+ # - Type:ip,Values中为ip字符串列表创建机器组
2706
+ # - Type:label,Values中为标签字符串列表创建机器组
2674
2707
  # @type MachineGroupType: :class:`Tencentcloud::Cls.v20201016.models.MachineGroupTypeInfo`
2675
2708
  # @param Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的机器组。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。
2676
2709
  # @type Tags: Array
@@ -2686,7 +2719,9 @@ module TencentCloud
2686
2719
  # @type DelayCleanupTime: Integer
2687
2720
  # @param MetaTags: 机器组元数据信息列表
2688
2721
  # @type MetaTags: Array
2689
- # @param OSType: 系统类型,默认0,0:Linux,1: Windows
2722
+ # @param OSType: 系统类型,取值如下:
2723
+ # - 0:Linux (默认值)
2724
+ # - 1:Windows
2690
2725
  # @type OSType: Integer
2691
2726
 
2692
2727
  attr_accessor :GroupName, :MachineGroupType, :Tags, :AutoUpdate, :UpdateStartTime, :UpdateEndTime, :ServiceLogging, :DelayCleanupTime, :MetaTags, :OSType
@@ -3485,7 +3520,7 @@ module TencentCloud
3485
3520
 
3486
3521
  # DeleteConfigExtra请求参数结构体
3487
3522
  class DeleteConfigExtraRequest < TencentCloud::Common::AbstractModel
3488
- # @param ConfigExtraId: 采集规则扩展配置ID
3523
+ # @param ConfigExtraId: 特殊采集规则扩展配置ID
3489
3524
  # @type ConfigExtraId: String
3490
3525
 
3491
3526
  attr_accessor :ConfigExtraId
@@ -4292,7 +4327,24 @@ module TencentCloud
4292
4327
 
4293
4328
  # DescribeConfigExtras请求参数结构体
4294
4329
  class DescribeConfigExtrasRequest < TencentCloud::Common::AbstractModel
4295
- # @param Filters: 支持的key: topicId,name, configExtraId, machineGroupId
4330
+ # @param Filters: 过滤器,支持如下选项:
4331
+ # name
4332
+ # - 按照【特殊采集配置名称】进行模糊匹配过滤。
4333
+ # - 类型:String
4334
+
4335
+ # configExtraId
4336
+ # - 按照【特殊采集配置ID】进行过滤。
4337
+ # - 类型:String
4338
+
4339
+ # topicId
4340
+ # - 按照【日志主题】进行过滤。
4341
+ # - 类型:String
4342
+
4343
+ # machineGroupId
4344
+ # - 按照【机器组ID】进行过滤。
4345
+ # - 类型:String
4346
+
4347
+ # 每次请求的Filters的上限为10,Filter.Values的上限为5。
4296
4348
  # @type Filters: Array
4297
4349
  # @param Offset: 分页的偏移量,默认值为0
4298
4350
  # @type Offset: Integer
@@ -5913,7 +5965,7 @@ module TencentCloud
5913
5965
  # @param UnMatchUpLoadSwitch: 解析失败日志是否上传,true表示上传,false表示不上传
5914
5966
  # 注意:此字段可能返回 null,表示取不到有效值。
5915
5967
  # @type UnMatchUpLoadSwitch: Boolean
5916
- # @param UnMatchLogKey: 失败日志的key
5968
+ # @param UnMatchLogKey: 失败日志的key,当UnMatchUpLoadSwitch为true时必填
5917
5969
  # 注意:此字段可能返回 null,表示取不到有效值。
5918
5970
  # @type UnMatchLogKey: String
5919
5971
  # @param Backtracking: 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。
@@ -5922,20 +5974,22 @@ module TencentCloud
5922
5974
  # 注意:此字段可能返回 null,表示取不到有效值。
5923
5975
  # @type Backtracking: Integer
5924
5976
  # @param IsGBK: 是否为Gbk编码。 0:否;1:是。
5925
- # 注意:
5977
+ # 注意
5978
+ # - 目前取0值时,表示UTF-8编码
5926
5979
  # - COS导入不支持此字段。
5927
5980
  # 注意:此字段可能返回 null,表示取不到有效值。
5928
5981
  # @type IsGBK: Integer
5929
5982
  # @param JsonStandard: 是否为标准json。 0:否; 1:是。
5983
+ # - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
5930
5984
  # 注意:此字段可能返回 null,表示取不到有效值。
5931
5985
  # @type JsonStandard: Integer
5932
- # @param Protocol: syslog传输协议,取值为tcp或者udp
5986
+ # @param Protocol: syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
5933
5987
  # 注意:
5934
5988
  # - 该字段适用于:创建采集规则配置、修改采集规则配置。
5935
5989
  # - COS导入不支持此字段。
5936
5990
  # 注意:此字段可能返回 null,表示取不到有效值。
5937
5991
  # @type Protocol: String
5938
- # @param Address: syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000
5992
+ # @param Address: syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
5939
5993
  # 注意:
5940
5994
  # - 该字段适用于:创建采集规则配置、修改采集规则配置。
5941
5995
  # - COS导入不支持此字段。
@@ -5944,6 +5998,7 @@ module TencentCloud
5944
5998
  # @param ParseProtocol: rfc3164:指定系统日志采集使用RFC3164协议解析日志。
5945
5999
  # rfc5424:指定系统日志采集使用RFC5424协议解析日志。
5946
6000
  # auto:自动匹配rfc3164或者rfc5424其中一种协议。
6001
+ # 只有在LogType为service_syslog时生效,其余类型无需填写。
5947
6002
  # 注意:
5948
6003
  # - 该字段适用于:创建采集规则配置、修改采集规则配置
5949
6004
  # - COS导入不支持此字段。
@@ -5964,9 +6019,7 @@ module TencentCloud
5964
6019
  # - MetadataType为2时必填。
5965
6020
  # - COS导入不支持此字段。
5966
6021
  # @type MetaTags: Array
5967
- # @param EventLogRules: Windows事件日志采集。
5968
- # 注意:
5969
- # - COS导入不支持此字段。
6022
+ # @param EventLogRules: Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
5970
6023
  # @type EventLogRules: Array
5971
6024
 
5972
6025
  attr_accessor :TimeKey, :TimeFormat, :Delimiter, :LogRegex, :BeginRegex, :Keys, :FilterKeyRegex, :UnMatchUpLoadSwitch, :UnMatchLogKey, :Backtracking, :IsGBK, :JsonStandard, :Protocol, :Address, :ParseProtocol, :MetadataType, :PathRegex, :MetaTags, :EventLogRules
@@ -7458,19 +7511,31 @@ module TencentCloud
7458
7511
  # @type TopicId: String
7459
7512
  # @param HostFile: 节点文件配置信息
7460
7513
  # @type HostFile: :class:`Tencentcloud::Cls.v20201016.models.HostFileInfo`
7461
- # @param ContainerFile: 容器文件路径信息
7514
+ # @param ContainerFile: 采集配置标记。
7515
+ # - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
7462
7516
  # @type ContainerFile: :class:`Tencentcloud::Cls.v20201016.models.ContainerFileInfo`
7463
7517
  # @param ContainerStdout: 容器标准输出信息
7464
7518
  # @type ContainerStdout: :class:`Tencentcloud::Cls.v20201016.models.ContainerStdoutInfo`
7465
- # @param LogType: 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
7519
+ # @param LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
7520
+ # - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
7521
+ # - delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
7522
+ # - minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
7523
+ # - fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
7524
+ # - multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
7525
+ # - multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
7526
+ # - user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
7466
7527
  # @type LogType: String
7467
- # @param LogFormat: 日志格式化方式
7528
+ # @param LogFormat: 日志格式化方式,用于容器采集场景。
7529
+ # - stdout-docker-json:用于docker容器采集场景
7530
+ # - stdout-containerd:用于containerd容器采集场景
7468
7531
  # @type LogFormat: String
7469
7532
  # @param ExtractRule: 提取规则,如果设置了ExtractRule,则必须设置LogType
7470
7533
  # @type ExtractRule: :class:`Tencentcloud::Cls.v20201016.models.ExtractRuleInfo`
7471
7534
  # @param ExcludePaths: 采集黑名单路径列表
7472
7535
  # @type ExcludePaths: Array
7473
- # @param UserDefineRule: 用户自定义采集规则,Json格式序列化的字符串
7536
+ # @param UserDefineRule: 组合解析采集规则,用于复杂场景下的日志采集。
7537
+ # - 取值参考:[使用组合解析提取模式采集日志
7538
+ # ](https://cloud.tencent.com/document/product/614/61310)
7474
7539
  # @type UserDefineRule: String
7475
7540
  # @param Type: 类型:container_stdout、container_file、host_file
7476
7541
  # @type Type: String
@@ -7488,7 +7553,7 @@ module TencentCloud
7488
7553
  # - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
7489
7554
  # - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
7490
7555
  # - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
7491
- # 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
7556
+ # - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
7492
7557
  # @type AdvancedConfig: String
7493
7558
 
7494
7559
  attr_accessor :ConfigExtraId, :Name, :TopicId, :HostFile, :ContainerFile, :ContainerStdout, :LogType, :LogFormat, :ExtractRule, :ExcludePaths, :UserDefineRule, :Type, :GroupId, :ConfigFlag, :LogsetId, :LogsetName, :TopicName, :AdvancedConfig
@@ -7832,7 +7897,12 @@ module TencentCloud
7832
7897
  # @type TaskId: String
7833
7898
  # @param Name: 加工任务名称
7834
7899
  # @type Name: String
7835
- # @param EtlContent: 加工语句
7900
+ # @param EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
7901
+
7902
+ # 其他参考文档:
7903
+
7904
+ # - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
7905
+ # - [函数总览](https://cloud.tencent.com/document/product/614/70395)
7836
7906
  # @type EtlContent: String
7837
7907
  # @param EnableFlag: 任务启动状态. 默认为1,开启, 2关闭
7838
7908
  # @type EnableFlag: Integer
@@ -8523,23 +8593,28 @@ module TencentCloud
8523
8593
  # 告警通知接收者信息
8524
8594
  class NoticeReceiver < TencentCloud::Common::AbstractModel
8525
8595
  # @param ReceiverType: 接受者类型。可选值:
8526
- # <br><li> Uin - 用户ID
8527
- # <br><li> Group - 用户组ID
8596
+ # - Uin - 用户ID
8597
+ # - Group - 用户组ID
8528
8598
  # 暂不支持其余接收者类型。
8529
8599
  # @type ReceiverType: String
8530
8600
  # @param ReceiverIds: 接收者。
8601
+ # 当ReceiverType为Uin时,ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)
8602
+ # 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
8531
8603
  # @type ReceiverIds: Array
8532
8604
  # @param ReceiverChannels: 通知接收渠道。
8533
- # <br><li> Email - 邮件
8534
- # <br><li> Sms - 短信
8535
- # <br><li> WeChat - 微信
8536
- # <br><li> Phone - 电话
8605
+ # - Email - 邮件
8606
+ # - Sms - 短信
8607
+ # - WeChat - 微信
8608
+ # - Phone - 电话
8537
8609
  # @type ReceiverChannels: Array
8538
- # @param StartTime: 允许接收信息的开始时间。
8610
+ # @param StartTime: 允许接收信息的开始时间。格式:`15:04:05`,必填。
8539
8611
  # @type StartTime: String
8540
- # @param EndTime: 允许接收信息的结束时间。
8612
+ # @param EndTime: 允许接收信息的结束时间。格式:`15:04:05`,必填。
8541
8613
  # @type EndTime: String
8542
- # @param Index: 位序
8614
+ # @param Index: 位序。
8615
+
8616
+ # - 入参时无效。
8617
+ # - 出参时有效。
8543
8618
  # @type Index: Integer
8544
8619
 
8545
8620
  attr_accessor :ReceiverType, :ReceiverIds, :ReceiverChannels, :StartTime, :EndTime, :Index
@@ -8571,7 +8646,111 @@ module TencentCloud
8571
8646
  # @param WebCallbacks: 告警通知模板回调信息。
8572
8647
  # 注意:此字段可能返回 null,表示取不到有效值。
8573
8648
  # @type WebCallbacks: Array
8574
- # @param Rule: 匹配规则。
8649
+ # @param Rule: 匹配规则 JSON串。
8650
+ # **rule格式为如下嵌套结构体JSON字符串**
8651
+ # ```
8652
+ # {
8653
+ # "Value": "AND",
8654
+ # "Type": "Operation",
8655
+ # "Children": [
8656
+ # {
8657
+ # "Value": "OR",
8658
+ # "Type": "Operation",
8659
+ # "Children": [
8660
+ # {
8661
+ # "Type": "Condition",
8662
+ # "Value": "Level",
8663
+ # "Children": [
8664
+ # {
8665
+ # "Value": "In",
8666
+ # "Type": "Compare"
8667
+ # },
8668
+ # {
8669
+ # "Value": "[1,0]",
8670
+ # "Type": "Value"
8671
+ # }
8672
+ # ]
8673
+ # },
8674
+ # {
8675
+ # "Type": "Condition",
8676
+ # "Value": "Level",
8677
+ # "Children": [
8678
+ # {
8679
+ # "Value": "NotIn",
8680
+ # "Type": "Compare"
8681
+ # },
8682
+ # {
8683
+ # "Value": "[2]",
8684
+ # "Type": "Value"
8685
+ # }
8686
+ # ]
8687
+ # }
8688
+ # ]
8689
+ # }
8690
+ # ]
8691
+ # }
8692
+ # ```
8693
+ # **rule规则树限制规则如下**:
8694
+ # - 顶层rule中Type可取值:`Condition`,`Operation`
8695
+ # - Type为`Operation`的子节点支持的Type可取值:`Condition`,`Operation`
8696
+ # - Type为`Condition`的子节点支持的Type可取值:`String`,`Compare`,`Array`,`TimeRange`,`Value`,`Key`
8697
+ # - 其他Type无子节点
8698
+ # - 当rule Type为`Operation`时,value可取值:`AND`,`OR`
8699
+ # - 当rule Type为`Condition`时,value不可为空,子节点个数不能小于2
8700
+ # - 当子节点Type为 `Compare` 时,value可取值:`>`,`<`,`>=`,`<=`,`=`,`!=`,`Between`,`NotBetween`,`=~`,`!=~`,`In`,`NotIn`
8701
+ # - value为`Between`,`NotBetween`时,下一个子节点value必须是长度为2的数组
8702
+ # - value为`=~`,`!=~`时,下一个子节点value必须是一个正则表达式
8703
+ # - value为`In`,`NotIn`时, 下一个子节点value必须是一个数组
8704
+
8705
+ # **业务参数含义**:
8706
+ # - Type:Condition 表示是规则条件,Value:Level 表示告警等级
8707
+ # - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
8708
+ # - 下一个子节点value支持的值:0(警告),1(提醒),2 (紧急)
8709
+ # 以下示例表示:告警等级属于提醒
8710
+ # `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]}]}
8711
+ # `
8712
+
8713
+ # - Type:Condition 表示是规则条件,Value:NotifyType 表示通知类型
8714
+ # - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
8715
+ # - 下一个子节点value支持的值:1(告警通知),2 (恢复通知)
8716
+ # 以下示例表示:通知类型属于告警通知或通知类型不属于恢复通知
8717
+ # `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[2]\",\"Type\":\"Value\"}]}]}]}
8718
+ # `
8719
+
8720
+ # - Type:Condition 表示是规则条件,Value:AlarmID 表示告警策略
8721
+ # - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
8722
+ # - 下一个子节点value支持的值:告警策略id数组
8723
+ # 以下示例表示:告警策略属于alarm-53af048c-254b-4c73-bb48-xxx,alarm-6dfa8bc5-08da-4d64-b6cb-xxx或告警策略不属于alarm-1036314c-1e49-4cee-a8fb-xxx
8724
+ # `"{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-53af048c-254b-4c73-bb48-xxx\\\",\\\"alarm-6dfa8bc5-08da-4d64-b6cb-xxx\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-1036314c-1e49-4cee-a8fb-xxx\\\"]\",\"Type\":\"Value\"}]}]}]}"
8725
+ # `
8726
+
8727
+ # - Type:Condition 表示是规则条件,Value:AlarmName 表示告警策略名称
8728
+ # - 子节点Type支持`Compare`,Value支持`=~`,`!=~`
8729
+ # - 下一个子节点value支持的值:必须是正则表达式
8730
+ # 以下示例表示:告警策略名称正则匹配^test$或告警策略名称正则不匹配^hahaha$
8731
+ # `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}
8732
+ # `
8733
+
8734
+ # - Type:Condition 表示是规则条件,Value:Label 表示告警分类字段
8735
+ # - 子节点Type支持`Compare`,Value支持`In`,`NotIn`,`=~`,`!=~`
8736
+ # - 下一个子节点value支持的值:`In`,`NotIn` 时value是数组,`=~`,`!=~`时value是正则表达式
8737
+ # 以下示例表示:告警分类字段key1属于v1或告警分类字段key2不属于v2或告警分类字段key3正则匹配^test$或告警分类字段key4正则不匹配^hahaha$
8738
+ # `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key1\",\"Type\":\"Key\"},{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v1\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key2\",\"Type\":\"Key\"},{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v2\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key3\",\"Type\":\"Key\"},{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key4\",\"Type\":\"Key\"},{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}
8739
+ # `
8740
+
8741
+ # - Type:Condition 表示是规则条件,Value:NotifyTime 表示通知时间
8742
+ # - 子节点Type支持`Compare`,Value支持`Between `,`NotBetween `
8743
+ # - 下一个子节点value支持的值:长度为2,格式为`14:20:36`的字符串数组
8744
+ # 以下示例表示:通知时间在指定范围内14:18:36至14:33:36或通知时间不在指定范围内14:20:36至14:30:36
8745
+ # `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"Between\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:18:36\\\",\\\"14:33:36\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"NotBetween\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:20:36\\\",\\\"14:30:36\\\"]\",\"Type\":\"Value\"}]}]}]}
8746
+ # `
8747
+
8748
+ # - Type:Condition 表示是规则条件,Value:Duration 表示告警持续时间
8749
+ # - 子节点Type支持`Compare`,Value支持`>`,`<`,`>=`,`<=`
8750
+ # - 下一个子节点value支持的值:整型值单位分钟
8751
+ # 以下示例表示:告警持续时间大于1分钟或告警持续时间大于等于2分钟或告警持续时间小于3分钟或告警持续时间小于等于4分钟
8752
+ # `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">\",\"Type\":\"Compare\"},{\"Value\":1,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">=\",\"Type\":\"Compare\"},{\"Value\":2,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<\",\"Type\":\"Compare\"},{\"Value\":3,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<=\",\"Type\":\"Compare\"},{\"Value\":4,\"Type\":\"Value\"}]}]}]}
8753
+ # `
8575
8754
  # 注意:此字段可能返回 null,表示取不到有效值。
8576
8755
  # @type Rule: String
8577
8756
 
@@ -8827,19 +9006,25 @@ module TencentCloud
8827
9006
  class PreviewLogStatistic < TencentCloud::Common::AbstractModel
8828
9007
  # @param LogContent: 日志内容
8829
9008
  # @type LogContent: String
8830
- # @param LineNum: 行号
9009
+ # @param LineNum: 行号。从0开始
8831
9010
  # @type LineNum: Integer
8832
9011
  # @param DstTopicId: 目标日志主题
8833
9012
  # @type DstTopicId: String
8834
- # @param FailReason: 失败错误码, 空字符串""表示正常
9013
+ # @param FailReason: 失败错误信息, 空字符串""表示正常
8835
9014
  # @type FailReason: String
8836
- # @param Time: 日志时间戳
9015
+ # @param Time: 日志时间,格式:`2024-05-07 17:13:17.105`
9016
+
9017
+ # - 入参时无效
9018
+ # - 出参时有效,为日志中的时间格式
8837
9019
  # @type Time: String
8838
9020
  # @param DstTopicName: 目标topic-name
8839
9021
  # 注意:此字段可能返回 null,表示取不到有效值。
8840
9022
  # @type DstTopicName: String
8841
9023
 
8842
9024
  attr_accessor :LogContent, :LineNum, :DstTopicId, :FailReason, :Time, :DstTopicName
9025
+ extend Gem::Deprecate
9026
+ deprecate :DstTopicName, :none, 2024, 5
9027
+ deprecate :DstTopicName=, :none, 2024, 5
8843
9028
 
8844
9029
  def initialize(logcontent=nil, linenum=nil, dsttopicid=nil, failreason=nil, time=nil, dsttopicname=nil)
8845
9030
  @LogContent = logcontent
@@ -9193,10 +9378,13 @@ module TencentCloud
9193
9378
  # @param SyntaxRule: 语法规则,0:Lucene语法,1:CQL语法
9194
9379
  # 注意:此字段可能返回 null,表示取不到有效值。
9195
9380
  # @type SyntaxRule: Integer
9381
+ # @param HasServicesLog: 是否开启投递服务日志。1:关闭,2:开启。
9382
+ # 注意:此字段可能返回 null,表示取不到有效值。
9383
+ # @type HasServicesLog: Integer
9196
9384
 
9197
- attr_accessor :TaskId, :Name, :SrcTopicId, :SrcTopicName, :DstResource, :CreateTime, :UpdateTime, :Status, :EnableFlag, :ScheduledSqlContent, :ProcessStartTime, :ProcessType, :ProcessEndTime, :ProcessPeriod, :ProcessTimeWindow, :ProcessDelay, :SrcTopicRegion, :SyntaxRule
9385
+ attr_accessor :TaskId, :Name, :SrcTopicId, :SrcTopicName, :DstResource, :CreateTime, :UpdateTime, :Status, :EnableFlag, :ScheduledSqlContent, :ProcessStartTime, :ProcessType, :ProcessEndTime, :ProcessPeriod, :ProcessTimeWindow, :ProcessDelay, :SrcTopicRegion, :SyntaxRule, :HasServicesLog
9198
9386
 
9199
- def initialize(taskid=nil, name=nil, srctopicid=nil, srctopicname=nil, dstresource=nil, createtime=nil, updatetime=nil, status=nil, enableflag=nil, scheduledsqlcontent=nil, processstarttime=nil, processtype=nil, processendtime=nil, processperiod=nil, processtimewindow=nil, processdelay=nil, srctopicregion=nil, syntaxrule=nil)
9387
+ def initialize(taskid=nil, name=nil, srctopicid=nil, srctopicname=nil, dstresource=nil, createtime=nil, updatetime=nil, status=nil, enableflag=nil, scheduledsqlcontent=nil, processstarttime=nil, processtype=nil, processendtime=nil, processperiod=nil, processtimewindow=nil, processdelay=nil, srctopicregion=nil, syntaxrule=nil, hasserviceslog=nil)
9200
9388
  @TaskId = taskid
9201
9389
  @Name = name
9202
9390
  @SrcTopicId = srctopicid
@@ -9215,6 +9403,7 @@ module TencentCloud
9215
9403
  @ProcessDelay = processdelay
9216
9404
  @SrcTopicRegion = srctopicregion
9217
9405
  @SyntaxRule = syntaxrule
9406
+ @HasServicesLog = hasserviceslog
9218
9407
  end
9219
9408
 
9220
9409
  def deserialize(params)
@@ -9239,6 +9428,7 @@ module TencentCloud
9239
9428
  @ProcessDelay = params['ProcessDelay']
9240
9429
  @SrcTopicRegion = params['SrcTopicRegion']
9241
9430
  @SyntaxRule = params['SyntaxRule']
9431
+ @HasServicesLog = params['HasServicesLog']
9242
9432
  end
9243
9433
  end
9244
9434
 
@@ -10108,16 +10298,20 @@ module TencentCloud
10108
10298
 
10109
10299
  # 回调地址
10110
10300
  class WebCallback < TencentCloud::Common::AbstractModel
10111
- # @param Url: 回调地址。
10301
+ # @param Url: 回调地址。最大支持1024个字节数。
10112
10302
  # @type Url: String
10113
10303
  # @param CallbackType: 回调的类型。可选值:
10114
- # <li> WeCom
10115
- # <li> Http
10304
+ # - WeCom
10305
+ # - Http
10306
+ # - DingTalk
10307
+ # - Lark
10116
10308
  # @type CallbackType: String
10117
10309
  # @param Method: 回调方法。可选值:
10118
- # <li> POST
10119
- # <li> PUT
10120
- # 默认值为POST。CallbackType为Http时为必选。
10310
+ # - POST(默认值)
10311
+ # - PUT
10312
+
10313
+ # 注意:
10314
+ # - 参数CallbackType为Http时为必选。
10121
10315
  # 注意:此字段可能返回 null,表示取不到有效值。
10122
10316
  # @type Method: String
10123
10317
  # @param Headers: 请求头。
@@ -10128,7 +10322,9 @@ module TencentCloud
10128
10322
  # 注意:该参数已废弃,请在<a href="https://cloud.tencent.com/document/product/614/56466">创建告警策略</a>接口CallBack参数中指定请求内容。
10129
10323
  # 注意:此字段可能返回 null,表示取不到有效值。
10130
10324
  # @type Body: String
10131
- # @param Index: 序号
10325
+ # @param Index: 序号。
10326
+ # - 入参无效。
10327
+ # - 出参有效。
10132
10328
  # @type Index: Integer
10133
10329
 
10134
10330
  attr_accessor :Url, :CallbackType, :Method, :Headers, :Body, :Index
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-cls
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.814
4
+ version: 3.0.816
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-05-06 00:00:00.000000000 Z
11
+ date: 2024-05-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common
@@ -33,9 +33,9 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
- - lib/tencentcloud-sdk-cls.rb
37
- - lib/v20201016/models.rb
38
36
  - lib/v20201016/client.rb
37
+ - lib/v20201016/models.rb
38
+ - lib/tencentcloud-sdk-cls.rb
39
39
  - lib/VERSION
40
40
  homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
41
41
  licenses: