tencentcloud-sdk-cls 3.0.813 → 3.0.815

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4a570711bf7e4db0d25ef685881d871c82b6fb7
-  data.tar.gz: 6ee1b15aa5b7319f554b741e2ef1c19c81caf23c
+  metadata.gz: 98512e16f67d129db72e5bee2401704b4d3f19f0
+  data.tar.gz: bfca529ea7aa147404e27feee502e5024b3cf439
 SHA512:
-  metadata.gz: 170b0e620c9e86e70869fbda1838170057fe702499b0e01706b068cd9947c257a7d476c07a217dcf62600f151f66990b3ba952cab690d997cba8fc1f6897b7be
-  data.tar.gz: 6ebab2ce7675859f442bce11603816e1e8ae1de4b7c679fdaa96d068d842ff9bab4d88efe0b7c84d1e9394bda64cd116ddeb97d58d509ba7b15fa76b3198e7d5
+  metadata.gz: 39e77fe11896989aa8c31437ecf1c0baeda00a0177537acfb2daba0d7de8db1be048b261a77923ab9be9af2c4506448bed7824f41bc4b1ad433931be860c3ca7
+  data.tar.gz: de1116301bca5fc6d3a195e4af7e47d74fb35162d8ee5b9b62ee55fd544cba1e3ceea6fe22e52e39d5eef9e605fc2f60c65e3f9a140ac3418a718ea173f52060

data/lib/VERSION

@@ -1 +1 @@
-3.0.813
+3.0.815

data/lib/v20201016/models.rb

@@ -1592,19 +1592,29 @@ module TencentCloud
         # @param Name: 通知渠道组名称。
         # @type Name: String
         # @param Type: 通知类型。可选值：
-        # <li> Trigger - 告警触发 </li>
-        # <li> Recovery - 告警恢复</li>
-        # <li> All - 告警触发和告警恢复</li>
+        # - Trigger - 告警触发
+        # - Recovery - 告警恢复
+        # - All - 告警触发和告警恢复
+
+
+        #  注意:
+        # - Type、NoticeReceivers和WebCallbacks是一组配置，其中Type必填，NoticeReceivers和WebCallbacks至少一个不为空，NoticeRules是另一组配置，其中rule不许为空，2组配置互斥。
+        # - Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，必须填写一组配置。
         # @type Type: String
         # @param NoticeReceivers: 通知接收对象。
+        #  注意:
+        # - Type、NoticeReceivers和WebCallbacks是一组配置，其中Type必填，NoticeReceivers和WebCallbacks至少一个不为空，NoticeRules是另一组配置，其中rule不许为空，2组配置互斥。
+        # - Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，必须填写一组配置。
         # @type NoticeReceivers: Array
         # @param WebCallbacks: 接口回调信息（包括企业微信）。
+        #  注意:
+        # - Type、NoticeReceivers和WebCallbacks是一组配置，其中Type必填，NoticeReceivers和WebCallbacks至少一个不为空，NoticeRules是另一组配置，其中rule不许为空，2组配置互斥。
+        # - Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，必须填写一组配置。
         # @type WebCallbacks: Array
         # @param NoticeRules: 通知规则。
-
         #  注意:
-
-        # - Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，2组配置互斥。
+        # - Type、NoticeReceivers和WebCallbacks是一组配置，其中Type必填，NoticeReceivers和WebCallbacks至少一个不为空，NoticeRules是另一组配置，其中rule不许为空，2组配置互斥。
+        # - Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，必须填写一组配置。
 
         # @type NoticeRules: Array
 
@@ -2036,7 +2046,7 @@ module TencentCloud
         # @type Name: String
         # @param Output: 采集配置所属日志主题ID即TopicId
         # @type Output: String
-        # @param Path: 日志采集路径,包含文件名
+        # @param Path: 日志采集路径，包含文件名，支持多个路径，多个路径之间英文逗号分隔，文件采集情况下必填
         # @type Path: String
         # @param LogType: 采集的日志类型，默认为minimalist_log。支持以下类型：
         # - json_log代表：JSON-文件日志（详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419)）；
@@ -3153,6 +3163,125 @@ module TencentCloud
         end
       end
 
+      # 仪表盘订阅通知方式
+      class DashboardNoticeMode < TencentCloud::Common::AbstractModel
+        # @param ReceiverType: 仪表盘通知方式。<br>
+        # <li/>Uin：腾讯云用户<br>
+        # <li/>Group：腾讯云用户组<br>
+        # <li/>Email：自定义Email<br>
+        # <li/>WeCom: 企业微信回调
+        # @type ReceiverType: String
+        # @param Values: 知方式对应的值。
+        # <br> <li/> 当ReceiverType不是 Wecom 时，Values必填。
+        # @type Values: Array
+        # @param ReceiverChannels: 仪表盘通知渠道。
+        # <br><li/> 支持：["Email","Sms","WeChat","Phone"]。
+        # <br><li/> 当ReceiverType是 Email 或 Wecom 时，ReceiverChannels不能赋值。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type ReceiverChannels: Array
+        # @param Url: 回调Url。
+        # <br><li/> 当ReceiverType是 Wecom 时，Url必填。
+        # <br><li/> 当ReceiverType不是 Wecom 时，Url不能填写。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Url: String
+
+        attr_accessor :ReceiverType, :Values, :ReceiverChannels, :Url
+
+        def initialize(receivertype=nil, values=nil, receiverchannels=nil, url=nil)
+          @ReceiverType = receivertype
+          @Values = values
+          @ReceiverChannels = receiverchannels
+          @Url = url
+        end
+
+        def deserialize(params)
+          @ReceiverType = params['ReceiverType']
+          @Values = params['Values']
+          @ReceiverChannels = params['ReceiverChannels']
+          @Url = params['Url']
+        end
+      end
+
+      # 仪表盘订阅相关数据
+      class DashboardSubscribeData < TencentCloud::Common::AbstractModel
+        # @param NoticeModes: 仪表盘订阅通知方式。
+        # @type NoticeModes: Array
+        # @param DashboardTime: 仪表盘订阅时间，为空标识取仪表盘默认的时间。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type DashboardTime: Array
+        # @param TemplateVariables: 仪表盘订阅模板变量。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type TemplateVariables: Array
+        # @param Timezone: 时区。参考：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#SHANGHAI
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type Timezone: String
+        # @param SubscribeLanguage: 语言。 zh 中文、en`英文。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type SubscribeLanguage: String
+        # @param JumpDomain: 调用链接域名。http:// 或者 https:// 开头，不能/结尾
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type JumpDomain: String
+        # @param JumpUrl: 自定义跳转链接。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type JumpUrl: String
+
+        attr_accessor :NoticeModes, :DashboardTime, :TemplateVariables, :Timezone, :SubscribeLanguage, :JumpDomain, :JumpUrl
+
+        def initialize(noticemodes=nil, dashboardtime=nil, templatevariables=nil, timezone=nil, subscribelanguage=nil, jumpdomain=nil, jumpurl=nil)
+          @NoticeModes = noticemodes
+          @DashboardTime = dashboardtime
+          @TemplateVariables = templatevariables
+          @Timezone = timezone
+          @SubscribeLanguage = subscribelanguage
+          @JumpDomain = jumpdomain
+          @JumpUrl = jumpurl
+        end
+
+        def deserialize(params)
+          unless params['NoticeModes'].nil?
+            @NoticeModes = []
+            params['NoticeModes'].each do |i|
+              dashboardnoticemode_tmp = DashboardNoticeMode.new
+              dashboardnoticemode_tmp.deserialize(i)
+              @NoticeModes << dashboardnoticemode_tmp
+            end
+          end
+          @DashboardTime = params['DashboardTime']
+          unless params['TemplateVariables'].nil?
+            @TemplateVariables = []
+            params['TemplateVariables'].each do |i|
+              dashboardtemplatevariable_tmp = DashboardTemplateVariable.new
+              dashboardtemplatevariable_tmp.deserialize(i)
+              @TemplateVariables << dashboardtemplatevariable_tmp
+            end
+          end
+          @Timezone = params['Timezone']
+          @SubscribeLanguage = params['SubscribeLanguage']
+          @JumpDomain = params['JumpDomain']
+          @JumpUrl = params['JumpUrl']
+        end
+      end
+
+      # 仪表盘订阅模板变量
+      class DashboardTemplateVariable < TencentCloud::Common::AbstractModel
+        # @param Key: key的值
+        # @type Key: String
+        # @param Values: key对应的values取值values
+        # @type Values: Array
+
+        attr_accessor :Key, :Values
+
+        def initialize(key=nil, values=nil)
+          @Key = key
+          @Values = values
+        end
+
+        def deserialize(params)
+          @Key = params['Key']
+          @Values = params['Values']
+        end
+      end
+
       # 仪表盘关联的topic信息
       class DashboardTopicInfo < TencentCloud::Common::AbstractModel
         # @param TopicId: 主题id
@@ -3366,7 +3495,7 @@ module TencentCloud
 
       # DeleteConfigExtra请求参数结构体
       class DeleteConfigExtraRequest < TencentCloud::Common::AbstractModel
-        # @param ConfigExtraId: 采集规则扩展配置ID
+        # @param ConfigExtraId: 特殊采集规则扩展配置ID
         # @type ConfigExtraId: String
 
         attr_accessor :ConfigExtraId
@@ -4173,7 +4302,27 @@ module TencentCloud
 
       # DescribeConfigExtras请求参数结构体
       class DescribeConfigExtrasRequest < TencentCloud::Common::AbstractModel
-        # @param Filters: 支持的key： topicId,name, configExtraId, machineGroupId
+        # @param Filters: name
+        # - 按照【特殊采集配置名称】进行模糊匹配过滤。
+        # - 类型：String
+        # - 必选：否
+
+        # configExtraId
+        # - 按照【特殊采集配置ID】进行过滤。
+        # - 类型：String
+        # - 必选：否
+
+        # topicId
+        # - 按照【日志主题】进行过滤。
+        # - 类型：String
+        # - 必选：否
+
+        # machineGroupId
+        # - 按照【机器组ID】进行过滤。
+        # - 类型：String
+        # - 必选：否
+
+        # 每次请求的Filters的上限为10，Filter.Values的上限为5。
         # @type Filters: Array
         # @param Offset: 分页的偏移量，默认值为0
         # @type Offset: Integer
@@ -5794,7 +5943,7 @@ module TencentCloud
         # @param UnMatchUpLoadSwitch: 解析失败日志是否上传，true表示上传，false表示不上传
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type UnMatchUpLoadSwitch: Boolean
-        # @param UnMatchLogKey: 失败日志的key
+        # @param UnMatchLogKey: 失败日志的key，当UnMatchUpLoadSwitch为true时必填
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type UnMatchLogKey: String
         # @param Backtracking: 增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。
@@ -5803,20 +5952,23 @@ module TencentCloud
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Backtracking: Integer
         # @param IsGBK: 是否为Gbk编码。 0：否；1：是。
-        # 注意：
+        # 注意
+        # - 目前取0值时，表示UTF-8编码
         # - COS导入不支持此字段。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type IsGBK: Integer
         # @param JsonStandard: 是否为标准json。  0：否； 1：是。
+        # 注
+        # - 标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type JsonStandard: Integer
-        # @param Protocol: syslog传输协议，取值为tcp或者udp。
+        # @param Protocol: syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。
         # 注意：
         # - 该字段适用于：创建采集规则配置、修改采集规则配置。
         # - COS导入不支持此字段。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Protocol: String
-        # @param Address: syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]。举例：127.0.0.1:9000
+        # @param Address: syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。
         # 注意：
         # - 该字段适用于：创建采集规则配置、修改采集规则配置。
         # - COS导入不支持此字段。
@@ -5825,6 +5977,7 @@ module TencentCloud
         # @param ParseProtocol: rfc3164：指定系统日志采集使用RFC3164协议解析日志。
         # rfc5424：指定系统日志采集使用RFC5424协议解析日志。
         # auto：自动匹配rfc3164或者rfc5424其中一种协议。
+        # 只有在LogType为service_syslog时生效，其余类型无需填写。
         # 注意：
         # - 该字段适用于：创建采集规则配置、修改采集规则配置
         # - COS导入不支持此字段。
@@ -5845,9 +5998,7 @@ module TencentCloud
         # - MetadataType为2时必填。
         # - COS导入不支持此字段。
         # @type MetaTags: Array
-        # @param EventLogRules: Windows事件日志采集。
-        # 注意：
-        # - COS导入不支持此字段。
+        # @param EventLogRules: Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。
         # @type EventLogRules: Array
 
         attr_accessor :TimeKey, :TimeFormat, :Delimiter, :LogRegex, :BeginRegex, :Keys, :FilterKeyRegex, :UnMatchUpLoadSwitch, :UnMatchLogKey, :Backtracking, :IsGBK, :JsonStandard, :Protocol, :Address, :ParseProtocol, :MetadataType, :PathRegex, :MetaTags, :EventLogRules
@@ -8404,23 +8555,28 @@ module TencentCloud
       # 告警通知接收者信息
       class NoticeReceiver < TencentCloud::Common::AbstractModel
         # @param ReceiverType: 接受者类型。可选值：
-        # <br><li> Uin - 用户ID
-        # <br><li> Group - 用户组ID
+        # -  Uin - 用户ID
+        # - Group - 用户组ID
         # 暂不支持其余接收者类型。
         # @type ReceiverType: String
         # @param ReceiverIds: 接收者。
+        # 当ReceiverType为Uin时，ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)
+        # 当ReceiverType为Group时，ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
         # @type ReceiverIds: Array
         # @param ReceiverChannels: 通知接收渠道。
-        # <br><li> Email - 邮件
-        # <br><li> Sms - 短信
-        # <br><li> WeChat - 微信
-        # <br><li> Phone - 电话
+        # - Email - 邮件
+        # - Sms - 短信
+        # - WeChat - 微信
+        # - Phone - 电话
         # @type ReceiverChannels: Array
         # @param StartTime: 允许接收信息的开始时间。
         # @type StartTime: String
         # @param EndTime: 允许接收信息的结束时间。
         # @type EndTime: String
-        # @param Index: 位序
+        # @param Index: 位序。
+
+        # - 入参无效。
+        # - 出参时有效。
         # @type Index: Integer
 
         attr_accessor :ReceiverType, :ReceiverIds, :ReceiverChannels, :StartTime, :EndTime, :Index
@@ -8452,7 +8608,12 @@ module TencentCloud
         # @param WebCallbacks: 告警通知模板回调信息。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type WebCallbacks: Array
-        # @param Rule: 匹配规则。
+        # @param Rule: 匹配规则 JSON串。
+        # `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}
+        # `
+        # 以上示例表示：
+        # 规则：
+        # 通知类型属于告警通知,恢复通知
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Rule: String
 
@@ -9204,12 +9365,32 @@ module TencentCloud
 
       # SearchDashboardSubscribe请求参数结构体
       class SearchDashboardSubscribeRequest < TencentCloud::Common::AbstractModel
+        # @param DashboardId: 仪表盘id。
+        # @type DashboardId: String
+        # @param SubscribeData: 仪表盘订阅数据。
+        # @type SubscribeData: :class:`Tencentcloud::Cls.v20201016.models.DashboardSubscribeData`
+        # @param Id: 仪表盘订阅Id。
+        # @type Id: Integer
+        # @param Name: 仪表盘订阅名称。
+        # @type Name: String
 
+        attr_accessor :DashboardId, :SubscribeData, :Id, :Name
 
-        def initialize()
+        def initialize(dashboardid=nil, subscribedata=nil, id=nil, name=nil)
+          @DashboardId = dashboardid
+          @SubscribeData = subscribedata
+          @Id = id
+          @Name = name
         end
 
         def deserialize(params)
+          @DashboardId = params['DashboardId']
+          unless params['SubscribeData'].nil?
+            @SubscribeData = DashboardSubscribeData.new
+            @SubscribeData.deserialize(params['SubscribeData'])
+          end
+          @Id = params['Id']
+          @Name = params['Name']
         end
       end
 
@@ -9969,15 +10150,17 @@ module TencentCloud
 
       # 回调地址
       class WebCallback < TencentCloud::Common::AbstractModel
-        # @param Url: 回调地址。
+        # @param Url: 回调地址。最大支持1024个字节数。
         # @type Url: String
         # @param CallbackType: 回调的类型。可选值：
-        # <li> WeCom
-        # <li> Http
+        # - WeCom
+        # - Http
+        # - DingTalk
+        # - Lark
         # @type CallbackType: String
         # @param Method: 回调方法。可选值：
-        # <li> POST
-        # <li> PUT
+        # - POST
+        # - PUT
         # 默认值为POST。CallbackType为Http时为必选。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Method: String
@@ -9989,7 +10172,9 @@ module TencentCloud
         # 注意：该参数已废弃，请在<a href="https://cloud.tencent.com/document/product/614/56466">创建告警策略</a>接口CallBack参数中指定请求内容。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Body: String
-        # @param Index: 序号
+        # @param Index: 序号。
+        # - 入参无效。
+        # - 出参有效。
         # @type Index: Integer
 
         attr_accessor :Url, :CallbackType, :Method, :Headers, :Body, :Index

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-cls
 version: !ruby/object:Gem::Version
-  version: 3.0.813
+  version: 3.0.815
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common