tencentcloud-sdk-python 3.0.1139__py2.py3-none-any.whl → 3.0.1141__py2.py3-none-any.whl

tencentcloud/cls/v20201016/models.py

@@ -3386,19 +3386,29 @@ class CreateAlarmNoticeRequest(AbstractModel):
         :param _Name: 通知渠道组名称。
         :type Name: str
         :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: str
         :param _NoticeReceivers: 通知接收对象。
+ 注意:  
+- Type、NoticeReceivers和WebCallbacks是一组配置，其中Type必填，NoticeReceivers和WebCallbacks至少一个不为空，NoticeRules是另一组配置，其中rule不许为空，2组配置互斥。
+- Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，必须填写一组配置。
         :type NoticeReceivers: list of NoticeReceiver
         :param _WebCallbacks: 接口回调信息（包括企业微信）。
+ 注意:  
+- Type、NoticeReceivers和WebCallbacks是一组配置，其中Type必填，NoticeReceivers和WebCallbacks至少一个不为空，NoticeRules是另一组配置，其中rule不许为空，2组配置互斥。
+- Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，必须填写一组配置。
         :type WebCallbacks: list of WebCallback
         :param _NoticeRules: 通知规则。
-
  注意:  
-
-- Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，2组配置互斥。
+- Type、NoticeReceivers和WebCallbacks是一组配置，其中Type必填，NoticeReceivers和WebCallbacks至少一个不为空，NoticeRules是另一组配置，其中rule不许为空，2组配置互斥。
+- Type、NoticeReceivers和WebCallbacks是一组配置，NoticeRules是另一组配置，必须填写一组配置。
 
 
         :type NoticeRules: list of NoticeRule
@@ -4304,7 +4314,7 @@ class CreateConfigRequest(AbstractModel):
         :type Name: str
         :param _Output: 采集配置所属日志主题ID即TopicId
         :type Output: str
-        :param _Path: 日志采集路径,包含文件名
+        :param _Path: 日志采集路径，包含文件名，支持多个路径，多个路径之间英文逗号分隔，文件采集情况下必填
         :type Path: str
         :param _LogType: 采集的日志类型，默认为minimalist_log。支持以下类型：
 - json_log代表：JSON-文件日志（详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419)）；
@@ -6745,6 +6755,252 @@ class DashboardInfo(AbstractModel):
         
 
 
+class DashboardNoticeMode(AbstractModel):
+    """仪表盘订阅通知方式
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _ReceiverType: 仪表盘通知方式。<br>
+<li/>Uin：腾讯云用户<br>
+<li/>Group：腾讯云用户组<br>
+<li/>Email：自定义Email<br>
+<li/>WeCom: 企业微信回调
+        :type ReceiverType: str
+        :param _Values: 知方式对应的值。
+<br> <li/> 当ReceiverType不是 Wecom 时，Values必填。
+        :type Values: list of str
+        :param _ReceiverChannels: 仪表盘通知渠道。
+<br><li/> 支持：["Email","Sms","WeChat","Phone"]。
+<br><li/> 当ReceiverType是 Email 或 Wecom 时，ReceiverChannels不能赋值。
+注意：此字段可能返回 null，表示取不到有效值。
+        :type ReceiverChannels: list of str
+        :param _Url: 回调Url。
+<br><li/> 当ReceiverType是 Wecom 时，Url必填。
+<br><li/> 当ReceiverType不是 Wecom 时，Url不能填写。
+注意：此字段可能返回 null，表示取不到有效值。
+        :type Url: str
+        """
+        self._ReceiverType = None
+        self._Values = None
+        self._ReceiverChannels = None
+        self._Url = None
+
+    @property
+    def ReceiverType(self):
+        return self._ReceiverType
+
+    @ReceiverType.setter
+    def ReceiverType(self, ReceiverType):
+        self._ReceiverType = ReceiverType
+
+    @property
+    def Values(self):
+        return self._Values
+
+    @Values.setter
+    def Values(self, Values):
+        self._Values = Values
+
+    @property
+    def ReceiverChannels(self):
+        return self._ReceiverChannels
+
+    @ReceiverChannels.setter
+    def ReceiverChannels(self, ReceiverChannels):
+        self._ReceiverChannels = ReceiverChannels
+
+    @property
+    def Url(self):
+        return self._Url
+
+    @Url.setter
+    def Url(self, Url):
+        self._Url = Url
+
+
+    def _deserialize(self, params):
+        self._ReceiverType = params.get("ReceiverType")
+        self._Values = params.get("Values")
+        self._ReceiverChannels = params.get("ReceiverChannels")
+        self._Url = params.get("Url")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class DashboardSubscribeData(AbstractModel):
+    """仪表盘订阅相关数据
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _NoticeModes: 仪表盘订阅通知方式。
+        :type NoticeModes: list of DashboardNoticeMode
+        :param _DashboardTime: 仪表盘订阅时间，为空标识取仪表盘默认的时间。
+注意：此字段可能返回 null，表示取不到有效值。
+        :type DashboardTime: list of str
+        :param _TemplateVariables: 仪表盘订阅模板变量。
+注意：此字段可能返回 null，表示取不到有效值。
+        :type TemplateVariables: list of DashboardTemplateVariable
+        :param _Timezone: 时区。参考：https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#SHANGHAI
+注意：此字段可能返回 null，表示取不到有效值。
+        :type Timezone: str
+        :param _SubscribeLanguage: 语言。 zh 中文、en`英文。
+注意：此字段可能返回 null，表示取不到有效值。
+        :type SubscribeLanguage: str
+        :param _JumpDomain: 调用链接域名。http:// 或者 https:// 开头，不能/结尾
+注意：此字段可能返回 null，表示取不到有效值。
+        :type JumpDomain: str
+        :param _JumpUrl: 自定义跳转链接。
+注意：此字段可能返回 null，表示取不到有效值。
+        :type JumpUrl: str
+        """
+        self._NoticeModes = None
+        self._DashboardTime = None
+        self._TemplateVariables = None
+        self._Timezone = None
+        self._SubscribeLanguage = None
+        self._JumpDomain = None
+        self._JumpUrl = None
+
+    @property
+    def NoticeModes(self):
+        return self._NoticeModes
+
+    @NoticeModes.setter
+    def NoticeModes(self, NoticeModes):
+        self._NoticeModes = NoticeModes
+
+    @property
+    def DashboardTime(self):
+        return self._DashboardTime
+
+    @DashboardTime.setter
+    def DashboardTime(self, DashboardTime):
+        self._DashboardTime = DashboardTime
+
+    @property
+    def TemplateVariables(self):
+        return self._TemplateVariables
+
+    @TemplateVariables.setter
+    def TemplateVariables(self, TemplateVariables):
+        self._TemplateVariables = TemplateVariables
+
+    @property
+    def Timezone(self):
+        return self._Timezone
+
+    @Timezone.setter
+    def Timezone(self, Timezone):
+        self._Timezone = Timezone
+
+    @property
+    def SubscribeLanguage(self):
+        return self._SubscribeLanguage
+
+    @SubscribeLanguage.setter
+    def SubscribeLanguage(self, SubscribeLanguage):
+        self._SubscribeLanguage = SubscribeLanguage
+
+    @property
+    def JumpDomain(self):
+        return self._JumpDomain
+
+    @JumpDomain.setter
+    def JumpDomain(self, JumpDomain):
+        self._JumpDomain = JumpDomain
+
+    @property
+    def JumpUrl(self):
+        return self._JumpUrl
+
+    @JumpUrl.setter
+    def JumpUrl(self, JumpUrl):
+        self._JumpUrl = JumpUrl
+
+
+    def _deserialize(self, params):
+        if params.get("NoticeModes") is not None:
+            self._NoticeModes = []
+            for item in params.get("NoticeModes"):
+                obj = DashboardNoticeMode()
+                obj._deserialize(item)
+                self._NoticeModes.append(obj)
+        self._DashboardTime = params.get("DashboardTime")
+        if params.get("TemplateVariables") is not None:
+            self._TemplateVariables = []
+            for item in params.get("TemplateVariables"):
+                obj = DashboardTemplateVariable()
+                obj._deserialize(item)
+                self._TemplateVariables.append(obj)
+        self._Timezone = params.get("Timezone")
+        self._SubscribeLanguage = params.get("SubscribeLanguage")
+        self._JumpDomain = params.get("JumpDomain")
+        self._JumpUrl = params.get("JumpUrl")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class DashboardTemplateVariable(AbstractModel):
+    """仪表盘订阅模板变量
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Key: key的值
+        :type Key: str
+        :param _Values: key对应的values取值values
+        :type Values: list of str
+        """
+        self._Key = None
+        self._Values = None
+
+    @property
+    def Key(self):
+        return self._Key
+
+    @Key.setter
+    def Key(self, Key):
+        self._Key = Key
+
+    @property
+    def Values(self):
+        return self._Values
+
+    @Values.setter
+    def Values(self, Values):
+        self._Values = Values
+
+
+    def _deserialize(self, params):
+        self._Key = params.get("Key")
+        self._Values = params.get("Values")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
 class DashboardTopicInfo(AbstractModel):
     """仪表盘关联的topic信息
 
@@ -7210,7 +7466,7 @@ class DeleteConfigExtraRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _ConfigExtraId: 采集规则扩展配置ID
+        :param _ConfigExtraId: 特殊采集规则扩展配置ID
         :type ConfigExtraId: str
         """
         self._ConfigExtraId = None
@@ -8656,7 +8912,27 @@ class DescribeConfigExtrasRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :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: list of Filter
         :param _Offset: 分页的偏移量，默认值为0
         :type Offset: int
@@ -11774,7 +12050,7 @@ class ExtractRuleInfo(AbstractModel):
         :param _UnMatchUpLoadSwitch: 解析失败日志是否上传，true表示上传，false表示不上传
 注意：此字段可能返回 null，表示取不到有效值。
         :type UnMatchUpLoadSwitch: bool
-        :param _UnMatchLogKey: 失败日志的key
+        :param _UnMatchLogKey: 失败日志的key，当UnMatchUpLoadSwitch为true时必填
 注意：此字段可能返回 null，表示取不到有效值。
         :type UnMatchLogKey: str
         :param _Backtracking: 增量采集模式下的回溯数据量，默认：-1（全量采集）；其他非负数表示增量采集（从最新的位置，往前采集${Backtracking}字节（Byte）的日志）最大支持1073741824（1G）。
@@ -11783,20 +12059,23 @@ class ExtractRuleInfo(AbstractModel):
 注意：此字段可能返回 null，表示取不到有效值。
         :type Backtracking: int
         :param _IsGBK: 是否为Gbk编码。 0：否；1：是。
-注意：
+注意
+- 目前取0值时，表示UTF-8编码
 - COS导入不支持此字段。
 注意：此字段可能返回 null，表示取不到有效值。
         :type IsGBK: int
         :param _JsonStandard: 是否为标准json。  0：否； 1：是。
+注
+- 标准json指采集器使用业界标准开源解析器进行json解析，非标json指采集器使用CLS自研json解析器进行解析，两种解析器没有本质区别，建议客户使用标准json进行解析。
 注意：此字段可能返回 null，表示取不到有效值。
         :type JsonStandard: int
-        :param _Protocol: syslog传输协议，取值为tcp或者udp。
+        :param _Protocol: syslog传输协议，取值为tcp或者udp，只有在LogType为service_syslog时生效，其余类型无需填写。
 注意：
 - 该字段适用于：创建采集规则配置、修改采集规则配置。
 - COS导入不支持此字段。
 注意：此字段可能返回 null，表示取不到有效值。
         :type Protocol: str
-        :param _Address: syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]。举例：127.0.0.1:9000
+        :param _Address: syslog系统日志采集指定采集器监听的地址和端口 ，形式：[ip]:[port]，只有在LogType为service_syslog时生效，其余类型无需填写。
 注意：
 - 该字段适用于：创建采集规则配置、修改采集规则配置。
 - COS导入不支持此字段。
@@ -11805,6 +12084,7 @@ class ExtractRuleInfo(AbstractModel):
         :param _ParseProtocol: rfc3164：指定系统日志采集使用RFC3164协议解析日志。
 rfc5424：指定系统日志采集使用RFC5424协议解析日志。
 auto：自动匹配rfc3164或者rfc5424其中一种协议。
+只有在LogType为service_syslog时生效，其余类型无需填写。
 注意：
 - 该字段适用于：创建采集规则配置、修改采集规则配置
 - COS导入不支持此字段。
@@ -11825,9 +12105,7 @@ auto：自动匹配rfc3164或者rfc5424其中一种协议。
 - MetadataType为2时必填。
 - COS导入不支持此字段。
         :type MetaTags: list of MetaTagInfo
-        :param _EventLogRules: Windows事件日志采集。
-注意：
-- COS导入不支持此字段。
+        :param _EventLogRules: Windows事件日志采集规则，只有在LogType为windows_event_log时生效，其余类型无需填写。
         :type EventLogRules: list of EventLog
         """
         self._TimeKey = None
@@ -17433,23 +17711,28 @@ class NoticeReceiver(AbstractModel):
     def __init__(self):
         r"""
         :param _ReceiverType: 接受者类型。可选值：
-<br><li> Uin - 用户ID
-<br><li> Group - 用户组ID
+-  Uin - 用户ID
+- Group - 用户组ID
 暂不支持其余接收者类型。
         :type ReceiverType: str
         :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: list of int
         :param _ReceiverChannels: 通知接收渠道。
-<br><li> Email - 邮件
-<br><li> Sms - 短信
-<br><li> WeChat - 微信
-<br><li> Phone - 电话
+- Email - 邮件
+- Sms - 短信
+- WeChat - 微信
+- Phone - 电话
         :type ReceiverChannels: list of str
         :param _StartTime: 允许接收信息的开始时间。
         :type StartTime: str
         :param _EndTime: 允许接收信息的结束时间。
         :type EndTime: str
-        :param _Index: 位序
+        :param _Index: 位序。
+
+- 入参无效。
+- 出参时有效。
         :type Index: int
         """
         self._ReceiverType = None
@@ -17538,7 +17821,12 @@ class NoticeRule(AbstractModel):
         :param _WebCallbacks: 告警通知模板回调信息。
 注意：此字段可能返回 null，表示取不到有效值。
         :type WebCallbacks: list of WebCallback
-        :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: str
         """
@@ -19226,6 +19514,71 @@ class SearchDashboardSubscribeRequest(AbstractModel):
 
     """
 
+    def __init__(self):
+        r"""
+        :param _DashboardId: 仪表盘id。
+        :type DashboardId: str
+        :param _SubscribeData: 仪表盘订阅数据。
+        :type SubscribeData: :class:`tencentcloud.cls.v20201016.models.DashboardSubscribeData`
+        :param _Id: 仪表盘订阅Id。
+        :type Id: int
+        :param _Name: 仪表盘订阅名称。
+        :type Name: str
+        """
+        self._DashboardId = None
+        self._SubscribeData = None
+        self._Id = None
+        self._Name = None
+
+    @property
+    def DashboardId(self):
+        return self._DashboardId
+
+    @DashboardId.setter
+    def DashboardId(self, DashboardId):
+        self._DashboardId = DashboardId
+
+    @property
+    def SubscribeData(self):
+        return self._SubscribeData
+
+    @SubscribeData.setter
+    def SubscribeData(self, SubscribeData):
+        self._SubscribeData = SubscribeData
+
+    @property
+    def Id(self):
+        return self._Id
+
+    @Id.setter
+    def Id(self, Id):
+        self._Id = Id
+
+    @property
+    def Name(self):
+        return self._Name
+
+    @Name.setter
+    def Name(self, Name):
+        self._Name = Name
+
+
+    def _deserialize(self, params):
+        self._DashboardId = params.get("DashboardId")
+        if params.get("SubscribeData") is not None:
+            self._SubscribeData = DashboardSubscribeData()
+            self._SubscribeData._deserialize(params.get("SubscribeData"))
+        self._Id = params.get("Id")
+        self._Name = params.get("Name")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
 
 class SearchDashboardSubscribeResponse(AbstractModel):
     """SearchDashboardSubscribe返回参数结构体
@@ -20847,15 +21200,17 @@ class WebCallback(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _Url: 回调地址。
+        :param _Url: 回调地址。最大支持1024个字节数。
         :type Url: str
         :param _CallbackType: 回调的类型。可选值：
-<li> WeCom
-<li> Http
+- WeCom
+- Http
+- DingTalk
+- Lark
         :type CallbackType: str
         :param _Method: 回调方法。可选值：
-<li> POST
-<li> PUT
+- POST
+- PUT
 默认值为POST。CallbackType为Http时为必选。
 注意：此字段可能返回 null，表示取不到有效值。
         :type Method: str
@@ -20867,7 +21222,9 @@ class WebCallback(AbstractModel):
 注意：该参数已废弃，请在<a href="https://cloud.tencent.com/document/product/614/56466">创建告警策略</a>接口CallBack参数中指定请求内容。
 注意：此字段可能返回 null，表示取不到有效值。
         :type Body: str
-        :param _Index: 序号
+        :param _Index: 序号。
+- 入参无效。
+- 出参有效。
         :type Index: int
         """
         self._Url = None