tencentcloud-sdk-python 3.0.1140__py2.py3-none-any.whl → 3.0.1142__py2.py3-none-any.whl

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 (33) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/cdb/v20170320/cdb_client.py +69 -0
  3. tencentcloud/cdb/v20170320/models.py +258 -0
  4. tencentcloud/cdn/v20180606/cdn_client.py +1 -1
  5. tencentcloud/clb/v20180317/models.py +24 -0
  6. tencentcloud/cls/v20201016/models.py +262 -54
  7. tencentcloud/csip/v20221121/models.py +204 -0
  8. tencentcloud/cvm/v20170312/models.py +1 -1
  9. tencentcloud/cwp/v20180228/cwp_client.py +0 -25
  10. tencentcloud/cwp/v20180228/models.py +0 -250
  11. tencentcloud/cynosdb/v20190107/models.py +1 -1
  12. tencentcloud/ess/v20201111/models.py +12 -0
  13. tencentcloud/essbasic/v20210526/models.py +26 -1
  14. tencentcloud/hunyuan/v20230901/models.py +1 -1
  15. tencentcloud/monitor/v20180724/models.py +14 -14
  16. tencentcloud/ocr/v20181119/ocr_client.py +0 -2
  17. tencentcloud/rum/v20210622/models.py +14 -14
  18. tencentcloud/ssl/v20191205/models.py +2 -2
  19. tencentcloud/tdmq/v20200217/models.py +144 -1
  20. tencentcloud/teo/v20220901/models.py +89 -0
  21. tencentcloud/teo/v20220901/teo_client.py +27 -1
  22. tencentcloud/tmt/v20180321/errorcodes.py +6 -0
  23. tencentcloud/trtc/v20190722/models.py +31 -5
  24. tencentcloud/trtc/v20190722/trtc_client.py +3 -3
  25. tencentcloud/tsf/v20180326/models.py +49 -0
  26. tencentcloud/vpc/v20170312/models.py +25 -12
  27. tencentcloud/vpc/v20170312/vpc_client.py +2 -2
  28. tencentcloud/wedata/v20210820/models.py +657 -0
  29. {tencentcloud_sdk_python-3.0.1140.dist-info → tencentcloud_sdk_python-3.0.1142.dist-info}/METADATA +1 -1
  30. {tencentcloud_sdk_python-3.0.1140.dist-info → tencentcloud_sdk_python-3.0.1142.dist-info}/RECORD +33 -33
  31. {tencentcloud_sdk_python-3.0.1140.dist-info → tencentcloud_sdk_python-3.0.1142.dist-info}/LICENSE +0 -0
  32. {tencentcloud_sdk_python-3.0.1140.dist-info → tencentcloud_sdk_python-3.0.1142.dist-info}/WHEEL +0 -0
  33. {tencentcloud_sdk_python-3.0.1140.dist-info → tencentcloud_sdk_python-3.0.1142.dist-info}/top_level.txt +0 -0
@@ -3386,19 +3386,33 @@ class CreateAlarmNoticeRequest(AbstractModel):
3386
3386
  :param _Name: 通知渠道组名称。
3387
3387
  :type Name: str
3388
3388
  :param _Type: 通知类型。可选值:
3389
- <li> Trigger - 告警触发 </li>
3390
- <li> Recovery - 告警恢复</li>
3391
- <li> All - 告警触发和告警恢复</li>
3389
+ - Trigger - 告警触发
3390
+ - Recovery - 告警恢复
3391
+ - All - 告警触发和告警恢复
3392
+
3393
+
3394
+ 注意:
3395
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
3396
+ - 2组rule配置互斥
3397
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
3392
3398
  :type Type: str
3393
3399
  :param _NoticeReceivers: 通知接收对象。
3400
+ 注意:
3401
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
3402
+ - 2组rule配置互斥
3403
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
3394
3404
  :type NoticeReceivers: list of NoticeReceiver
3395
3405
  :param _WebCallbacks: 接口回调信息(包括企业微信)。
3406
+ 注意:
3407
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
3408
+ - 2组rule配置互斥
3409
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
3396
3410
  :type WebCallbacks: list of WebCallback
3397
3411
  :param _NoticeRules: 通知规则。
3398
-
3399
3412
  注意:
3400
-
3401
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。
3413
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
3414
+ - 2组rule配置互斥
3415
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
3402
3416
 
3403
3417
 
3404
3418
  :type NoticeRules: list of NoticeRule
@@ -3996,11 +4010,20 @@ class CreateConfigExtraRequest(AbstractModel):
3996
4010
  :type Name: str
3997
4011
  :param _TopicId: 日志主题id
3998
4012
  :type TopicId: str
3999
- :param _Type: 类型:container_stdoutcontainer_filehost_file
4013
+ :param _Type: 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。
4000
4014
  :type Type: str
4001
- :param _LogType: 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
4015
+ :param _LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
4016
+ - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
4017
+ - delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
4018
+ - minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
4019
+ - fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
4020
+ - multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
4021
+ - multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
4022
+ - user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
4002
4023
  :type LogType: str
4003
- :param _ConfigFlag: 采集配置标
4024
+ :param _ConfigFlag: 采集配置标记。
4025
+ - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
4026
+
4004
4027
  :type ConfigFlag: str
4005
4028
  :param _LogsetId: 日志集id
4006
4029
  :type LogsetId: str
@@ -4008,19 +4031,23 @@ class CreateConfigExtraRequest(AbstractModel):
4008
4031
  :type LogsetName: str
4009
4032
  :param _TopicName: 日志主题名称
4010
4033
  :type TopicName: str
4011
- :param _HostFile: 节点文件配置信息
4034
+ :param _HostFile: 节点文件路径类型配置。
4012
4035
  :type HostFile: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
4013
- :param _ContainerFile: 容器文件路径信息
4036
+ :param _ContainerFile: 容器文件路径类型配置。
4014
4037
  :type ContainerFile: :class:`tencentcloud.cls.v20201016.models.ContainerFileInfo`
4015
- :param _ContainerStdout: 容器标准输出信息
4038
+ :param _ContainerStdout: 容器标准输出类型配置。
4016
4039
  :type ContainerStdout: :class:`tencentcloud.cls.v20201016.models.ContainerStdoutInfo`
4017
- :param _LogFormat: 日志格式化方式
4040
+ :param _LogFormat: 日志格式化方式,用于容器采集场景。
4041
+ - stdout-docker-json:用于docker容器采集场景
4042
+ - stdout-containerd:用于containerd容器采集场景
4018
4043
  :type LogFormat: str
4019
4044
  :param _ExtractRule: 提取规则,如果设置了ExtractRule,则必须设置LogType
4020
4045
  :type ExtractRule: :class:`tencentcloud.cls.v20201016.models.ExtractRuleInfo`
4021
4046
  :param _ExcludePaths: 采集黑名单路径列表
4022
4047
  :type ExcludePaths: list of ExcludePathInfo
4023
- :param _UserDefineRule: 用户自定义采集规则,Json格式序列化的字符串
4048
+ :param _UserDefineRule: 组合解析采集规则,用于复杂场景下的日志采集。
4049
+ - 取值参考:[使用组合解析提取模式采集日志
4050
+ ](https://cloud.tencent.com/document/product/614/61310)
4024
4051
  :type UserDefineRule: str
4025
4052
  :param _GroupId: 绑定的机器组id
4026
4053
  :type GroupId: str
@@ -4032,7 +4059,8 @@ class CreateConfigExtraRequest(AbstractModel):
4032
4059
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
4033
4060
  - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
4034
4061
  - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
4035
- 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
4062
+ - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
4063
+
4036
4064
  :type AdvancedConfig: str
4037
4065
  """
4038
4066
  self._Name = None
@@ -4304,7 +4332,7 @@ class CreateConfigRequest(AbstractModel):
4304
4332
  :type Name: str
4305
4333
  :param _Output: 采集配置所属日志主题ID即TopicId
4306
4334
  :type Output: str
4307
- :param _Path: 日志采集路径,包含文件名
4335
+ :param _Path: 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
4308
4336
  :type Path: str
4309
4337
  :param _LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
4310
4338
  - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
@@ -4820,7 +4848,12 @@ class CreateDataTransformRequest(AbstractModel):
4820
4848
  :type SrcTopicId: str
4821
4849
  :param _Name: 加工任务名称
4822
4850
  :type Name: str
4823
- :param _EtlContent: 加工语句。[创建加工任务](https://cloud.tencent.com/document/product/614/63940) [函数总览](https://cloud.tencent.com/document/product/614/70395)
4851
+ :param _EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
4852
+
4853
+ 其他参考文档:
4854
+
4855
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
4856
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
4824
4857
  :type EtlContent: str
4825
4858
  :param _TaskType: 加工类型。
4826
4859
  1:使用源日志主题中的随机数据,进行加工预览;2:使用用户自定义测试数据,进行加工预览;3:创建真实加工任务。
@@ -5649,7 +5682,9 @@ class CreateMachineGroupRequest(AbstractModel):
5649
5682
  r"""
5650
5683
  :param _GroupName: 机器组名字,不能重复
5651
5684
  :type GroupName: str
5652
- :param _MachineGroupType: 创建机器组类型。Type:ip,Values中为ip字符串列表创建机器组;Type:label,Values中为标签字符串列表创建机器组。
5685
+ :param _MachineGroupType: 创建机器组类型。取值如下:
5686
+ - Type:ip,Values中为ip字符串列表创建机器组
5687
+ - Type:label,Values中为标签字符串列表创建机器组
5653
5688
  :type MachineGroupType: :class:`tencentcloud.cls.v20201016.models.MachineGroupTypeInfo`
5654
5689
  :param _Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的机器组。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。
5655
5690
  :type Tags: list of Tag
@@ -5665,7 +5700,9 @@ class CreateMachineGroupRequest(AbstractModel):
5665
5700
  :type DelayCleanupTime: int
5666
5701
  :param _MetaTags: 机器组元数据信息列表
5667
5702
  :type MetaTags: list of MetaTagInfo
5668
- :param _OSType: 系统类型,默认0,0:Linux,1: Windows
5703
+ :param _OSType: 系统类型,取值如下:
5704
+ - 0:Linux (默认值)
5705
+ - 1:Windows
5669
5706
  :type OSType: int
5670
5707
  """
5671
5708
  self._GroupName = None
@@ -7456,7 +7493,7 @@ class DeleteConfigExtraRequest(AbstractModel):
7456
7493
 
7457
7494
  def __init__(self):
7458
7495
  r"""
7459
- :param _ConfigExtraId: 采集规则扩展配置ID
7496
+ :param _ConfigExtraId: 特殊采集规则扩展配置ID
7460
7497
  :type ConfigExtraId: str
7461
7498
  """
7462
7499
  self._ConfigExtraId = None
@@ -8902,7 +8939,24 @@ class DescribeConfigExtrasRequest(AbstractModel):
8902
8939
 
8903
8940
  def __init__(self):
8904
8941
  r"""
8905
- :param _Filters: 支持的key: topicId,name, configExtraId, machineGroupId
8942
+ :param _Filters: 过滤器,支持如下选项:
8943
+ name
8944
+ - 按照【特殊采集配置名称】进行模糊匹配过滤。
8945
+ - 类型:String
8946
+
8947
+ configExtraId
8948
+ - 按照【特殊采集配置ID】进行过滤。
8949
+ - 类型:String
8950
+
8951
+ topicId
8952
+ - 按照【日志主题】进行过滤。
8953
+ - 类型:String
8954
+
8955
+ machineGroupId
8956
+ - 按照【机器组ID】进行过滤。
8957
+ - 类型:String
8958
+
8959
+ 每次请求的Filters的上限为10,Filter.Values的上限为5。
8906
8960
  :type Filters: list of Filter
8907
8961
  :param _Offset: 分页的偏移量,默认值为0
8908
8962
  :type Offset: int
@@ -12020,7 +12074,7 @@ class ExtractRuleInfo(AbstractModel):
12020
12074
  :param _UnMatchUpLoadSwitch: 解析失败日志是否上传,true表示上传,false表示不上传
12021
12075
  注意:此字段可能返回 null,表示取不到有效值。
12022
12076
  :type UnMatchUpLoadSwitch: bool
12023
- :param _UnMatchLogKey: 失败日志的key
12077
+ :param _UnMatchLogKey: 失败日志的key,当UnMatchUpLoadSwitch为true时必填
12024
12078
  注意:此字段可能返回 null,表示取不到有效值。
12025
12079
  :type UnMatchLogKey: str
12026
12080
  :param _Backtracking: 增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。
@@ -12029,20 +12083,22 @@ class ExtractRuleInfo(AbstractModel):
12029
12083
  注意:此字段可能返回 null,表示取不到有效值。
12030
12084
  :type Backtracking: int
12031
12085
  :param _IsGBK: 是否为Gbk编码。 0:否;1:是。
12032
- 注意:
12086
+ 注意
12087
+ - 目前取0值时,表示UTF-8编码
12033
12088
  - COS导入不支持此字段。
12034
12089
  注意:此字段可能返回 null,表示取不到有效值。
12035
12090
  :type IsGBK: int
12036
12091
  :param _JsonStandard: 是否为标准json。 0:否; 1:是。
12092
+ - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
12037
12093
  注意:此字段可能返回 null,表示取不到有效值。
12038
12094
  :type JsonStandard: int
12039
- :param _Protocol: syslog传输协议,取值为tcp或者udp
12095
+ :param _Protocol: syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
12040
12096
  注意:
12041
12097
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
12042
12098
  - COS导入不支持此字段。
12043
12099
  注意:此字段可能返回 null,表示取不到有效值。
12044
12100
  :type Protocol: str
12045
- :param _Address: syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000
12101
+ :param _Address: syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
12046
12102
  注意:
12047
12103
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
12048
12104
  - COS导入不支持此字段。
@@ -12051,6 +12107,7 @@ class ExtractRuleInfo(AbstractModel):
12051
12107
  :param _ParseProtocol: rfc3164:指定系统日志采集使用RFC3164协议解析日志。
12052
12108
  rfc5424:指定系统日志采集使用RFC5424协议解析日志。
12053
12109
  auto:自动匹配rfc3164或者rfc5424其中一种协议。
12110
+ 只有在LogType为service_syslog时生效,其余类型无需填写。
12054
12111
  注意:
12055
12112
  - 该字段适用于:创建采集规则配置、修改采集规则配置
12056
12113
  - COS导入不支持此字段。
@@ -12071,9 +12128,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
12071
12128
  - MetadataType为2时必填。
12072
12129
  - COS导入不支持此字段。
12073
12130
  :type MetaTags: list of MetaTagInfo
12074
- :param _EventLogRules: Windows事件日志采集。
12075
- 注意:
12076
- - COS导入不支持此字段。
12131
+ :param _EventLogRules: Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
12077
12132
  :type EventLogRules: list of EventLog
12078
12133
  """
12079
12134
  self._TimeKey = None
@@ -15388,19 +15443,31 @@ class ModifyConfigExtraRequest(AbstractModel):
15388
15443
  :type TopicId: str
15389
15444
  :param _HostFile: 节点文件配置信息
15390
15445
  :type HostFile: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
15391
- :param _ContainerFile: 容器文件路径信息
15446
+ :param _ContainerFile: 采集配置标记。
15447
+ - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
15392
15448
  :type ContainerFile: :class:`tencentcloud.cls.v20201016.models.ContainerFileInfo`
15393
15449
  :param _ContainerStdout: 容器标准输出信息
15394
15450
  :type ContainerStdout: :class:`tencentcloud.cls.v20201016.models.ContainerStdoutInfo`
15395
- :param _LogType: 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
15451
+ :param _LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
15452
+ - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
15453
+ - delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
15454
+ - minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
15455
+ - fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
15456
+ - multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
15457
+ - multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
15458
+ - user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
15396
15459
  :type LogType: str
15397
- :param _LogFormat: 日志格式化方式
15460
+ :param _LogFormat: 日志格式化方式,用于容器采集场景。
15461
+ - stdout-docker-json:用于docker容器采集场景
15462
+ - stdout-containerd:用于containerd容器采集场景
15398
15463
  :type LogFormat: str
15399
15464
  :param _ExtractRule: 提取规则,如果设置了ExtractRule,则必须设置LogType
15400
15465
  :type ExtractRule: :class:`tencentcloud.cls.v20201016.models.ExtractRuleInfo`
15401
15466
  :param _ExcludePaths: 采集黑名单路径列表
15402
15467
  :type ExcludePaths: list of ExcludePathInfo
15403
- :param _UserDefineRule: 用户自定义采集规则,Json格式序列化的字符串
15468
+ :param _UserDefineRule: 组合解析采集规则,用于复杂场景下的日志采集。
15469
+ - 取值参考:[使用组合解析提取模式采集日志
15470
+ ](https://cloud.tencent.com/document/product/614/61310)
15404
15471
  :type UserDefineRule: str
15405
15472
  :param _Type: 类型:container_stdout、container_file、host_file
15406
15473
  :type Type: str
@@ -15418,7 +15485,8 @@ class ModifyConfigExtraRequest(AbstractModel):
15418
15485
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
15419
15486
  - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
15420
15487
  - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
15421
- 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
15488
+ - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
15489
+
15422
15490
  :type AdvancedConfig: str
15423
15491
  """
15424
15492
  self._ConfigExtraId = None
@@ -16187,7 +16255,12 @@ class ModifyDataTransformRequest(AbstractModel):
16187
16255
  :type TaskId: str
16188
16256
  :param _Name: 加工任务名称
16189
16257
  :type Name: str
16190
- :param _EtlContent: 加工语句
16258
+ :param _EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
16259
+
16260
+ 其他参考文档:
16261
+
16262
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
16263
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
16191
16264
  :type EtlContent: str
16192
16265
  :param _EnableFlag: 任务启动状态. 默认为1,开启, 2关闭
16193
16266
  :type EnableFlag: int
@@ -17679,23 +17752,28 @@ class NoticeReceiver(AbstractModel):
17679
17752
  def __init__(self):
17680
17753
  r"""
17681
17754
  :param _ReceiverType: 接受者类型。可选值:
17682
- <br><li> Uin - 用户ID
17683
- <br><li> Group - 用户组ID
17755
+ - Uin - 用户ID
17756
+ - Group - 用户组ID
17684
17757
  暂不支持其余接收者类型。
17685
17758
  :type ReceiverType: str
17686
17759
  :param _ReceiverIds: 接收者。
17760
+ 当ReceiverType为Uin时,ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)
17761
+ 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
17687
17762
  :type ReceiverIds: list of int
17688
17763
  :param _ReceiverChannels: 通知接收渠道。
17689
- <br><li> Email - 邮件
17690
- <br><li> Sms - 短信
17691
- <br><li> WeChat - 微信
17692
- <br><li> Phone - 电话
17764
+ - Email - 邮件
17765
+ - Sms - 短信
17766
+ - WeChat - 微信
17767
+ - Phone - 电话
17693
17768
  :type ReceiverChannels: list of str
17694
- :param _StartTime: 允许接收信息的开始时间。
17769
+ :param _StartTime: 允许接收信息的开始时间。格式:`15:04:05`,必填。
17695
17770
  :type StartTime: str
17696
- :param _EndTime: 允许接收信息的结束时间。
17771
+ :param _EndTime: 允许接收信息的结束时间。格式:`15:04:05`,必填。
17697
17772
  :type EndTime: str
17698
- :param _Index: 位序
17773
+ :param _Index: 位序。
17774
+
17775
+ - 入参时无效。
17776
+ - 出参时有效。
17699
17777
  :type Index: int
17700
17778
  """
17701
17779
  self._ReceiverType = None
@@ -17784,7 +17862,111 @@ class NoticeRule(AbstractModel):
17784
17862
  :param _WebCallbacks: 告警通知模板回调信息。
17785
17863
  注意:此字段可能返回 null,表示取不到有效值。
17786
17864
  :type WebCallbacks: list of WebCallback
17787
- :param _Rule: 匹配规则。
17865
+ :param _Rule: 匹配规则 JSON串。
17866
+ **rule格式为如下嵌套结构体JSON字符串**
17867
+ ```
17868
+ {
17869
+ "Value": "AND",
17870
+ "Type": "Operation",
17871
+ "Children": [
17872
+ {
17873
+ "Value": "OR",
17874
+ "Type": "Operation",
17875
+ "Children": [
17876
+ {
17877
+ "Type": "Condition",
17878
+ "Value": "Level",
17879
+ "Children": [
17880
+ {
17881
+ "Value": "In",
17882
+ "Type": "Compare"
17883
+ },
17884
+ {
17885
+ "Value": "[1,0]",
17886
+ "Type": "Value"
17887
+ }
17888
+ ]
17889
+ },
17890
+ {
17891
+ "Type": "Condition",
17892
+ "Value": "Level",
17893
+ "Children": [
17894
+ {
17895
+ "Value": "NotIn",
17896
+ "Type": "Compare"
17897
+ },
17898
+ {
17899
+ "Value": "[2]",
17900
+ "Type": "Value"
17901
+ }
17902
+ ]
17903
+ }
17904
+ ]
17905
+ }
17906
+ ]
17907
+ }
17908
+ ```
17909
+ **rule规则树限制规则如下**:
17910
+ - 顶层rule中Type可取值:`Condition`,`Operation`
17911
+ - Type为`Operation`的子节点支持的Type可取值:`Condition`,`Operation`
17912
+ - Type为`Condition`的子节点支持的Type可取值:`String`,`Compare`,`Array`,`TimeRange`,`Value`,`Key`
17913
+ - 其他Type无子节点
17914
+ - 当rule Type为`Operation`时,value可取值:`AND`,`OR`
17915
+ - 当rule Type为`Condition`时,value不可为空,子节点个数不能小于2
17916
+ - 当子节点Type为 `Compare` 时,value可取值:`>`,`<`,`>=`,`<=`,`=`,`!=`,`Between`,`NotBetween`,`=~`,`!=~`,`In`,`NotIn`
17917
+ - value为`Between`,`NotBetween`时,下一个子节点value必须是长度为2的数组
17918
+ - value为`=~`,`!=~`时,下一个子节点value必须是一个正则表达式
17919
+ - value为`In`,`NotIn`时, 下一个子节点value必须是一个数组
17920
+
17921
+ **业务参数含义**:
17922
+ - Type:Condition 表示是规则条件,Value:Level 表示告警等级
17923
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
17924
+ - 下一个子节点value支持的值:0(警告),1(提醒),2 (紧急)
17925
+ 以下示例表示:告警等级属于提醒
17926
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]}]}
17927
+ `
17928
+
17929
+ - Type:Condition 表示是规则条件,Value:NotifyType 表示通知类型
17930
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
17931
+ - 下一个子节点value支持的值:1(告警通知),2 (恢复通知)
17932
+ 以下示例表示:通知类型属于告警通知或通知类型不属于恢复通知
17933
+ `{\"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\"}]}]}]}
17934
+ `
17935
+
17936
+ - Type:Condition 表示是规则条件,Value:AlarmID 表示告警策略
17937
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
17938
+ - 下一个子节点value支持的值:告警策略id数组
17939
+ 以下示例表示:告警策略属于alarm-53af048c-254b-4c73-bb48-xxx,alarm-6dfa8bc5-08da-4d64-b6cb-xxx或告警策略不属于alarm-1036314c-1e49-4cee-a8fb-xxx
17940
+ `"{\"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\"}]}]}]}"
17941
+ `
17942
+
17943
+ - Type:Condition 表示是规则条件,Value:AlarmName 表示告警策略名称
17944
+ - 子节点Type支持`Compare`,Value支持`=~`,`!=~`
17945
+ - 下一个子节点value支持的值:必须是正则表达式
17946
+ 以下示例表示:告警策略名称正则匹配^test$或告警策略名称正则不匹配^hahaha$
17947
+ `{\"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\"}]}]}]}
17948
+ `
17949
+
17950
+ - Type:Condition 表示是规则条件,Value:Label 表示告警分类字段
17951
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`,`=~`,`!=~`
17952
+ - 下一个子节点value支持的值:`In`,`NotIn` 时value是数组,`=~`,`!=~`时value是正则表达式
17953
+ 以下示例表示:告警分类字段key1属于v1或告警分类字段key2不属于v2或告警分类字段key3正则匹配^test$或告警分类字段key4正则不匹配^hahaha$
17954
+ `{\"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\"}]}]}]}
17955
+ `
17956
+
17957
+ - Type:Condition 表示是规则条件,Value:NotifyTime 表示通知时间
17958
+ - 子节点Type支持`Compare`,Value支持`Between `,`NotBetween `
17959
+ - 下一个子节点value支持的值:长度为2,格式为`14:20:36`的字符串数组
17960
+ 以下示例表示:通知时间在指定范围内14:18:36至14:33:36或通知时间不在指定范围内14:20:36至14:30:36
17961
+ `{\"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\"}]}]}]}
17962
+ `
17963
+
17964
+ - Type:Condition 表示是规则条件,Value:Duration 表示告警持续时间
17965
+ - 子节点Type支持`Compare`,Value支持`>`,`<`,`>=`,`<=`
17966
+ - 下一个子节点value支持的值:整型值单位分钟
17967
+ 以下示例表示:告警持续时间大于1分钟或告警持续时间大于等于2分钟或告警持续时间小于3分钟或告警持续时间小于等于4分钟
17968
+ `{\"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\"}]}]}]}
17969
+ `
17788
17970
  注意:此字段可能返回 null,表示取不到有效值。
17789
17971
  :type Rule: str
17790
17972
  """
@@ -18335,13 +18517,16 @@ class PreviewLogStatistic(AbstractModel):
18335
18517
  r"""
18336
18518
  :param _LogContent: 日志内容
18337
18519
  :type LogContent: str
18338
- :param _LineNum: 行号
18520
+ :param _LineNum: 行号。从0开始
18339
18521
  :type LineNum: int
18340
18522
  :param _DstTopicId: 目标日志主题
18341
18523
  :type DstTopicId: str
18342
- :param _FailReason: 失败错误码, 空字符串""表示正常
18524
+ :param _FailReason: 失败错误信息, 空字符串""表示正常
18343
18525
  :type FailReason: str
18344
- :param _Time: 日志时间戳
18526
+ :param _Time: 日志时间,格式:`2024-05-07 17:13:17.105`
18527
+
18528
+ - 入参时无效
18529
+ - 出参时有效,为日志中的时间格式
18345
18530
  :type Time: str
18346
18531
  :param _DstTopicName: 目标topic-name
18347
18532
  注意:此字段可能返回 null,表示取不到有效值。
@@ -18396,10 +18581,14 @@ class PreviewLogStatistic(AbstractModel):
18396
18581
 
18397
18582
  @property
18398
18583
  def DstTopicName(self):
18584
+ warnings.warn("parameter `DstTopicName` is deprecated", DeprecationWarning)
18585
+
18399
18586
  return self._DstTopicName
18400
18587
 
18401
18588
  @DstTopicName.setter
18402
18589
  def DstTopicName(self, DstTopicName):
18590
+ warnings.warn("parameter `DstTopicName` is deprecated", DeprecationWarning)
18591
+
18403
18592
  self._DstTopicName = DstTopicName
18404
18593
 
18405
18594
 
@@ -19078,6 +19267,9 @@ class ScheduledSqlTaskInfo(AbstractModel):
19078
19267
  :param _SyntaxRule: 语法规则,0:Lucene语法,1:CQL语法
19079
19268
  注意:此字段可能返回 null,表示取不到有效值。
19080
19269
  :type SyntaxRule: int
19270
+ :param _HasServicesLog: 是否开启投递服务日志。1:关闭,2:开启。
19271
+ 注意:此字段可能返回 null,表示取不到有效值。
19272
+ :type HasServicesLog: int
19081
19273
  """
19082
19274
  self._TaskId = None
19083
19275
  self._Name = None
@@ -19097,6 +19289,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
19097
19289
  self._ProcessDelay = None
19098
19290
  self._SrcTopicRegion = None
19099
19291
  self._SyntaxRule = None
19292
+ self._HasServicesLog = None
19100
19293
 
19101
19294
  @property
19102
19295
  def TaskId(self):
@@ -19242,6 +19435,14 @@ class ScheduledSqlTaskInfo(AbstractModel):
19242
19435
  def SyntaxRule(self, SyntaxRule):
19243
19436
  self._SyntaxRule = SyntaxRule
19244
19437
 
19438
+ @property
19439
+ def HasServicesLog(self):
19440
+ return self._HasServicesLog
19441
+
19442
+ @HasServicesLog.setter
19443
+ def HasServicesLog(self, HasServicesLog):
19444
+ self._HasServicesLog = HasServicesLog
19445
+
19245
19446
 
19246
19447
  def _deserialize(self, params):
19247
19448
  self._TaskId = params.get("TaskId")
@@ -19264,6 +19465,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
19264
19465
  self._ProcessDelay = params.get("ProcessDelay")
19265
19466
  self._SrcTopicRegion = params.get("SrcTopicRegion")
19266
19467
  self._SyntaxRule = params.get("SyntaxRule")
19468
+ self._HasServicesLog = params.get("HasServicesLog")
19267
19469
  memeber_set = set(params.keys())
19268
19470
  for name, value in vars(self).items():
19269
19471
  property_name = name[1:]
@@ -21158,16 +21360,20 @@ class WebCallback(AbstractModel):
21158
21360
 
21159
21361
  def __init__(self):
21160
21362
  r"""
21161
- :param _Url: 回调地址。
21363
+ :param _Url: 回调地址。最大支持1024个字节数。
21162
21364
  :type Url: str
21163
21365
  :param _CallbackType: 回调的类型。可选值:
21164
- <li> WeCom
21165
- <li> Http
21366
+ - WeCom
21367
+ - Http
21368
+ - DingTalk
21369
+ - Lark
21166
21370
  :type CallbackType: str
21167
21371
  :param _Method: 回调方法。可选值:
21168
- <li> POST
21169
- <li> PUT
21170
- 默认值为POST。CallbackType为Http时为必选。
21372
+ - POST(默认值)
21373
+ - PUT
21374
+
21375
+ 注意:
21376
+ - 参数CallbackType为Http时为必选。
21171
21377
  注意:此字段可能返回 null,表示取不到有效值。
21172
21378
  :type Method: str
21173
21379
  :param _Headers: 请求头。
@@ -21178,7 +21384,9 @@ class WebCallback(AbstractModel):
21178
21384
  注意:该参数已废弃,请在<a href="https://cloud.tencent.com/document/product/614/56466">创建告警策略</a>接口CallBack参数中指定请求内容。
21179
21385
  注意:此字段可能返回 null,表示取不到有效值。
21180
21386
  :type Body: str
21181
- :param _Index: 序号
21387
+ :param _Index: 序号。
21388
+ - 入参无效。
21389
+ - 出参有效。
21182
21390
  :type Index: int
21183
21391
  """
21184
21392
  self._Url = None