tencentcloud-sdk-python-cls 3.0.1444__tar.gz → 3.0.1447__tar.gz

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 (16) hide show
  1. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/PKG-INFO +1 -1
  2. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/setup.py +1 -1
  3. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud/cls/v20201016/models.py +491 -86
  5. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud_sdk_python_cls.egg-info/PKG-INFO +1 -1
  6. tencentcloud-sdk-python-cls-3.0.1447/tencentcloud_sdk_python_cls.egg-info/requires.txt +1 -0
  7. tencentcloud-sdk-python-cls-3.0.1444/tencentcloud_sdk_python_cls.egg-info/requires.txt +0 -1
  8. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/README.rst +0 -0
  9. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/setup.cfg +0 -0
  10. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud/cls/__init__.py +0 -0
  11. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud/cls/v20201016/__init__.py +0 -0
  12. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud/cls/v20201016/cls_client.py +0 -0
  13. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud/cls/v20201016/errorcodes.py +0 -0
  14. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud_sdk_python_cls.egg-info/SOURCES.txt +0 -0
  15. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud_sdk_python_cls.egg-info/dependency_links.txt +0 -0
  16. {tencentcloud-sdk-python-cls-3.0.1444 → tencentcloud-sdk-python-cls-3.0.1447}/tencentcloud_sdk_python_cls.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.2
2
2
  Name: tencentcloud-sdk-python-cls
3
- Version: 3.0.1444
3
+ Version: 3.0.1447
4
4
  Summary: Tencent Cloud Cls SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-cls',
11
- install_requires=["tencentcloud-sdk-python-common>=3.0.1444,<4.0.0"],
11
+ install_requires=["tencentcloud-sdk-python-common>=3.0.1447,<4.0.0"],
12
12
  version=tencentcloud.__version__,
13
13
  description='Tencent Cloud Cls SDK for Python',
14
14
  long_description=open('README.rst').read(),
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1444'
17
+ __version__ = '3.0.1447'
@@ -6257,6 +6257,7 @@ class CreateConfigExtraRequest(AbstractModel):
6257
6257
  :param _Name: 采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾
6258
6258
  :type Name: str
6259
6259
  :param _TopicId: 日志主题id
6260
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6260
6261
  :type TopicId: str
6261
6262
  :param _Type: 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。
6262
6263
  :type Type: str
@@ -6274,16 +6275,23 @@ class CreateConfigExtraRequest(AbstractModel):
6274
6275
 
6275
6276
  :type ConfigFlag: str
6276
6277
  :param _LogsetId: 日志集id
6278
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
6277
6279
  :type LogsetId: str
6278
- :param _LogsetName: 日志集name
6280
+ :param _LogsetName: 日志集名称
6281
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。
6279
6282
  :type LogsetName: str
6280
6283
  :param _TopicName: 日志主题名称
6284
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。
6281
6285
  :type TopicName: str
6282
- :param _HostFile: 节点文件路径类型配置。
6286
+ :param _HostFile: 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。
6287
+
6288
+ - 详细参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 信息。
6283
6289
  :type HostFile: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
6284
6290
  :param _ContainerFile: 容器文件路径类型配置。
6285
6291
  :type ContainerFile: :class:`tencentcloud.cls.v20201016.models.ContainerFileInfo`
6286
- :param _ContainerStdout: 容器标准输出类型配置。
6292
+ :param _ContainerStdout: 自建k8s-容器标准输出信息,包括容器、命名空间等。
6293
+
6294
+ - 详细参考 [ContainerStdoutInfo](https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 信息。
6287
6295
  :type ContainerStdout: :class:`tencentcloud.cls.v20201016.models.ContainerStdoutInfo`
6288
6296
  :param _LogFormat: 日志格式化方式,用于容器采集场景。
6289
6297
  - stdout-docker-json:用于docker容器采集场景
@@ -6297,11 +6305,15 @@ class CreateConfigExtraRequest(AbstractModel):
6297
6305
  - 取值参考:[使用组合解析提取模式采集日志
6298
6306
  ](https://cloud.tencent.com/document/product/614/61310)
6299
6307
  :type UserDefineRule: str
6300
- :param _GroupId: 绑定的机器组id
6308
+ :param _GroupId: 绑定的机器组ID
6309
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
6310
+ - GroupId 与 GroupIds 选择其一即可,不可同时为空。
6301
6311
  :type GroupId: str
6302
- :param _GroupIds: 绑定的机器组id列表
6312
+ :param _GroupIds: 绑定的机器组ID列表
6313
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id信息。
6314
+ - GroupId 与 GroupIds 选择其一即可,不可同时为空。
6303
6315
  :type GroupIds: list of str
6304
- :param _CollectInfos: 采集相关配置信息。详情见CollectInfo复杂类型配置。
6316
+ :param _CollectInfos: 采集相关配置信息。详细参考 [CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo) 信息。
6305
6317
  :type CollectInfos: list of CollectInfo
6306
6318
  :param _AdvancedConfig: 高级采集配置。 Json字符串, Key/Value定义为如下:
6307
6319
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
@@ -6345,6 +6357,7 @@ class CreateConfigExtraRequest(AbstractModel):
6345
6357
  @property
6346
6358
  def TopicId(self):
6347
6359
  """日志主题id
6360
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6348
6361
  :rtype: str
6349
6362
  """
6350
6363
  return self._TopicId
@@ -6398,6 +6411,7 @@ class CreateConfigExtraRequest(AbstractModel):
6398
6411
  @property
6399
6412
  def LogsetId(self):
6400
6413
  """日志集id
6414
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
6401
6415
  :rtype: str
6402
6416
  """
6403
6417
  return self._LogsetId
@@ -6408,7 +6422,8 @@ class CreateConfigExtraRequest(AbstractModel):
6408
6422
 
6409
6423
  @property
6410
6424
  def LogsetName(self):
6411
- """日志集name
6425
+ """日志集名称
6426
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。
6412
6427
  :rtype: str
6413
6428
  """
6414
6429
  return self._LogsetName
@@ -6420,6 +6435,7 @@ class CreateConfigExtraRequest(AbstractModel):
6420
6435
  @property
6421
6436
  def TopicName(self):
6422
6437
  """日志主题名称
6438
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。
6423
6439
  :rtype: str
6424
6440
  """
6425
6441
  return self._TopicName
@@ -6430,7 +6446,9 @@ class CreateConfigExtraRequest(AbstractModel):
6430
6446
 
6431
6447
  @property
6432
6448
  def HostFile(self):
6433
- """节点文件路径类型配置。
6449
+ """自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。
6450
+
6451
+ - 详细参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 信息。
6434
6452
  :rtype: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
6435
6453
  """
6436
6454
  return self._HostFile
@@ -6452,7 +6470,9 @@ class CreateConfigExtraRequest(AbstractModel):
6452
6470
 
6453
6471
  @property
6454
6472
  def ContainerStdout(self):
6455
- """容器标准输出类型配置。
6473
+ """自建k8s-容器标准输出信息,包括容器、命名空间等。
6474
+
6475
+ - 详细参考 [ContainerStdoutInfo](https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 信息。
6456
6476
  :rtype: :class:`tencentcloud.cls.v20201016.models.ContainerStdoutInfo`
6457
6477
  """
6458
6478
  return self._ContainerStdout
@@ -6515,7 +6535,9 @@ class CreateConfigExtraRequest(AbstractModel):
6515
6535
 
6516
6536
  @property
6517
6537
  def GroupId(self):
6518
- """绑定的机器组id
6538
+ """绑定的机器组ID
6539
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
6540
+ - GroupId 与 GroupIds 选择其一即可,不可同时为空。
6519
6541
  :rtype: str
6520
6542
  """
6521
6543
  return self._GroupId
@@ -6526,7 +6548,9 @@ class CreateConfigExtraRequest(AbstractModel):
6526
6548
 
6527
6549
  @property
6528
6550
  def GroupIds(self):
6529
- """绑定的机器组id列表
6551
+ """绑定的机器组ID列表
6552
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id信息。
6553
+ - GroupId 与 GroupIds 选择其一即可,不可同时为空。
6530
6554
  :rtype: list of str
6531
6555
  """
6532
6556
  return self._GroupIds
@@ -6537,7 +6561,7 @@ class CreateConfigExtraRequest(AbstractModel):
6537
6561
 
6538
6562
  @property
6539
6563
  def CollectInfos(self):
6540
- """采集相关配置信息。详情见CollectInfo复杂类型配置。
6564
+ """采集相关配置信息。详细参考 [CollectInfo](https://cloud.tencent.com/document/api/614/56471#CollectInfo) 信息。
6541
6565
  :rtype: list of CollectInfo
6542
6566
  """
6543
6567
  return self._CollectInfos
@@ -7502,9 +7526,14 @@ class CreateDataTransformRequest(AbstractModel):
7502
7526
  r"""
7503
7527
  :param _FuncType: 任务类型. 1: 指定主题;2:动态创建。详情请参考[创建加工任务文档](https://cloud.tencent.com/document/product/614/63940)。
7504
7528
  :type FuncType: int
7505
- :param _SrcTopicId: 源日志主题
7529
+ :param _SrcTopicId: 日志主题ID
7530
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7506
7531
  :type SrcTopicId: str
7507
7532
  :param _Name: 加工任务名称
7533
+ 名称限制
7534
+ - 不能为空字符串
7535
+ - 不能包含字符'|'
7536
+ - 最长 255 个字符
7508
7537
  :type Name: str
7509
7538
  :param _EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
7510
7539
 
@@ -7516,11 +7545,15 @@ class CreateDataTransformRequest(AbstractModel):
7516
7545
  :param _TaskType: 加工类型。
7517
7546
  1:使用源日志主题中的随机数据,进行加工预览;2:使用用户自定义测试数据,进行加工预览;3:创建真实加工任务。
7518
7547
  :type TaskType: int
7519
- :param _DstResources: 加工任务目的topic_id以及别名,当FuncType=1时,该参数必填,当FuncType=2时,无需填写。
7548
+ :param _DstResources: 加工任务目标topic_id以及别名,当FuncType=1时,该参数必填,当FuncType=2时,无需填写。
7549
+ 目标topic_id,通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7550
+ 别名限制 1.不能为空字符串,2. 不能包含字符'|'。
7551
+
7520
7552
  :type DstResources: list of DataTransformResouceInfo
7521
7553
  :param _EnableFlag: 任务启动状态. 默认为1:开启, 2:关闭
7522
7554
  :type EnableFlag: int
7523
7555
  :param _PreviewLogStatistics: 用于预览加工结果的测试数据
7556
+ 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7524
7557
  :type PreviewLogStatistics: list of PreviewLogStatistic
7525
7558
  :param _DataTransformType: 数据加工类型。0:标准加工任务; 1:前置加工任务。前置加工任务将采集的日志处理完成后,再写入日志主题。
7526
7559
  :type DataTransformType: int
@@ -7548,7 +7581,8 @@ class CreateDataTransformRequest(AbstractModel):
7548
7581
 
7549
7582
  @property
7550
7583
  def SrcTopicId(self):
7551
- """源日志主题
7584
+ """日志主题ID
7585
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7552
7586
  :rtype: str
7553
7587
  """
7554
7588
  return self._SrcTopicId
@@ -7560,6 +7594,10 @@ class CreateDataTransformRequest(AbstractModel):
7560
7594
  @property
7561
7595
  def Name(self):
7562
7596
  """加工任务名称
7597
+ 名称限制
7598
+ - 不能为空字符串
7599
+ - 不能包含字符'|'
7600
+ - 最长 255 个字符
7563
7601
  :rtype: str
7564
7602
  """
7565
7603
  return self._Name
@@ -7598,7 +7636,10 @@ class CreateDataTransformRequest(AbstractModel):
7598
7636
 
7599
7637
  @property
7600
7638
  def DstResources(self):
7601
- """加工任务目的topic_id以及别名,当FuncType=1时,该参数必填,当FuncType=2时,无需填写。
7639
+ """加工任务目标topic_id以及别名,当FuncType=1时,该参数必填,当FuncType=2时,无需填写。
7640
+ 目标topic_id,通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7641
+ 别名限制 1.不能为空字符串,2. 不能包含字符'|'。
7642
+
7602
7643
  :rtype: list of DataTransformResouceInfo
7603
7644
  """
7604
7645
  return self._DstResources
@@ -7621,6 +7662,7 @@ class CreateDataTransformRequest(AbstractModel):
7621
7662
  @property
7622
7663
  def PreviewLogStatistics(self):
7623
7664
  """用于预览加工结果的测试数据
7665
+ 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7624
7666
  :rtype: list of PreviewLogStatistic
7625
7667
  """
7626
7668
  return self._PreviewLogStatistics
@@ -10245,25 +10287,34 @@ class DashboardNoticeMode(AbstractModel):
10245
10287
 
10246
10288
  def __init__(self):
10247
10289
  r"""
10248
- :param _ReceiverType: 仪表盘通知方式。<br>
10249
- <li/>Uin:腾讯云用户<br>
10250
- <li/>Group:腾讯云用户组<br>
10251
- <li/>Email:自定义Email<br>
10252
- <li/>WeCom: 企业微信回调<br>
10253
- <li/>DingTalk:钉钉<br>
10254
- <li/>Lark:飞书
10290
+ :param _ReceiverType: 仪表盘通知方式。
10291
+
10292
+ - Uin:腾讯云用户
10293
+ - Group:腾讯云用户组
10294
+ - WeCom:企业微信回调
10295
+ - Email:自定义邮件
10296
+ - DingTalk:钉钉
10297
+ - Lark:飞书
10255
10298
  :type ReceiverType: str
10256
10299
  :param _Values: 知方式对应的值。
10257
- <br> <li/> 当ReceiverType不是 WeCom 时,Values必填。
10300
+ - 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Values必须为空,且Url字段必填。
10301
+ - 当ReceiverType为:`Uin`、`Group`、`Email` 时,Values必填,且Url字段必须为空。
10302
+ - 当ReceiverType为:`Uin ` 时,Values为用户id,通过 [拉取子用户](https://cloud.tencent.com/document/product/598/34587) 获取子用户 UID 。
10303
+ - 当ReceiverType为:`Group` 时,Values为用户组id,通过 [查询用户组列表](https://cloud.tencent.com/document/product/598/34589) 获取用户组 ID 。
10304
+ - 当ReceiverType为:`Email` 时,Values为用户邮箱信息。
10258
10305
  :type Values: list of str
10259
10306
  :param _ReceiverChannels: 仪表盘通知渠道。
10260
- <br><li/> 支持:["Email","Sms","WeChat","Phone"]。
10261
- <br><li/> 当ReceiverType是 Email 或 WeCom 时,ReceiverChannels不能赋值。
10307
+
10308
+ - 支持:["Email","Sms","WeChat","Phone"]。
10309
+ - 当ReceiverType为 `Email` 或 `WeCom` 时,ReceiverChannels无效。
10262
10310
  注意:此字段可能返回 null,表示取不到有效值。
10263
10311
  :type ReceiverChannels: list of str
10264
- :param _Url: 回调Url。
10265
- <br><li/> 当ReceiverTypeWeCom 时,Url必填。
10266
- <br><li/> 当ReceiverType不是 WeCom 时,Url不能填写。
10312
+ :param _Url: 订阅方式 - 回调地址。
10313
+ - 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Url字段必填为各渠道的回调地址。
10314
+ - 为:`WeCom` 时,Url为 企业微信回调地址。
10315
+ - 为:`DingTalk` 时,Url为 钉钉机器人Webhook地址。
10316
+ - 为:`Lark` 时,Url为 飞书机器人Webhook地址。
10317
+ - 当ReceiverType为:`Uin`、`Group`、`Email` 时,Url字段必须为空。
10267
10318
  :type Url: str
10268
10319
  """
10269
10320
  self._ReceiverType = None
@@ -10273,13 +10324,14 @@ class DashboardNoticeMode(AbstractModel):
10273
10324
 
10274
10325
  @property
10275
10326
  def ReceiverType(self):
10276
- """仪表盘通知方式。<br>
10277
- <li/>Uin:腾讯云用户<br>
10278
- <li/>Group:腾讯云用户组<br>
10279
- <li/>Email:自定义Email<br>
10280
- <li/>WeCom: 企业微信回调<br>
10281
- <li/>DingTalk:钉钉<br>
10282
- <li/>Lark:飞书
10327
+ """仪表盘通知方式。
10328
+
10329
+ - Uin:腾讯云用户
10330
+ - Group:腾讯云用户组
10331
+ - WeCom:企业微信回调
10332
+ - Email:自定义邮件
10333
+ - DingTalk:钉钉
10334
+ - Lark:飞书
10283
10335
  :rtype: str
10284
10336
  """
10285
10337
  return self._ReceiverType
@@ -10291,7 +10343,11 @@ class DashboardNoticeMode(AbstractModel):
10291
10343
  @property
10292
10344
  def Values(self):
10293
10345
  """知方式对应的值。
10294
- <br> <li/> 当ReceiverType不是 WeCom 时,Values必填。
10346
+ - 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Values必须为空,且Url字段必填。
10347
+ - 当ReceiverType为:`Uin`、`Group`、`Email` 时,Values必填,且Url字段必须为空。
10348
+ - 当ReceiverType为:`Uin ` 时,Values为用户id,通过 [拉取子用户](https://cloud.tencent.com/document/product/598/34587) 获取子用户 UID 。
10349
+ - 当ReceiverType为:`Group` 时,Values为用户组id,通过 [查询用户组列表](https://cloud.tencent.com/document/product/598/34589) 获取用户组 ID 。
10350
+ - 当ReceiverType为:`Email` 时,Values为用户邮箱信息。
10295
10351
  :rtype: list of str
10296
10352
  """
10297
10353
  return self._Values
@@ -10303,8 +10359,9 @@ class DashboardNoticeMode(AbstractModel):
10303
10359
  @property
10304
10360
  def ReceiverChannels(self):
10305
10361
  """仪表盘通知渠道。
10306
- <br><li/> 支持:["Email","Sms","WeChat","Phone"]。
10307
- <br><li/> 当ReceiverType是 Email 或 WeCom 时,ReceiverChannels不能赋值。
10362
+
10363
+ - 支持:["Email","Sms","WeChat","Phone"]。
10364
+ - 当ReceiverType为 `Email` 或 `WeCom` 时,ReceiverChannels无效。
10308
10365
  注意:此字段可能返回 null,表示取不到有效值。
10309
10366
  :rtype: list of str
10310
10367
  """
@@ -10316,9 +10373,12 @@ class DashboardNoticeMode(AbstractModel):
10316
10373
 
10317
10374
  @property
10318
10375
  def Url(self):
10319
- """回调Url。
10320
- <br><li/> 当ReceiverTypeWeCom 时,Url必填。
10321
- <br><li/> 当ReceiverType不是 WeCom 时,Url不能填写。
10376
+ """订阅方式 - 回调地址。
10377
+ - 当ReceiverType为:`WeCom`、`DingTalk`、`Lark` 时,Url字段必填为各渠道的回调地址。
10378
+ - 为:`WeCom` 时,Url为 企业微信回调地址。
10379
+ - 为:`DingTalk` 时,Url为 钉钉机器人Webhook地址。
10380
+ - 为:`Lark` 时,Url为 飞书机器人Webhook地址。
10381
+ - 当ReceiverType为:`Uin`、`Group`、`Email` 时,Url字段必须为空。
10322
10382
  :rtype: str
10323
10383
  """
10324
10384
  return self._Url
@@ -10483,6 +10543,194 @@ class DashboardSubscribeData(AbstractModel):
10483
10543
 
10484
10544
 
10485
10545
 
10546
+ class DashboardSubscribeInfo(AbstractModel):
10547
+ """仪表盘订阅信息
10548
+
10549
+ """
10550
+
10551
+ def __init__(self):
10552
+ r"""
10553
+ :param _Id: 仪表盘订阅id。
10554
+ :type Id: int
10555
+ :param _Name: 仪表盘订阅名称。
10556
+ :type Name: str
10557
+ :param _DashboardId: 仪表盘id。
10558
+ :type DashboardId: str
10559
+ :param _Cron: 仪表盘订阅时间。
10560
+ :type Cron: str
10561
+ :param _SubscribeData: 仪表盘订阅数据。
10562
+ :type SubscribeData: :class:`tencentcloud.cls.v20201016.models.DashboardSubscribeData`
10563
+ :param _CreateTime: 仪表盘订阅记录创建时间。格式:`YYYY-MM-DD HH:MM:SS`
10564
+ :type CreateTime: str
10565
+ :param _UpdateTime: 仪表盘订阅记录更新时间。格式:`YYYY-MM-DD HH:MM:SS`
10566
+ :type UpdateTime: str
10567
+ :param _LastTime: 仪表盘订阅记录最后一次发送成功时间。格式:`YYYY-MM-DD HH:MM:SS`
10568
+ :type LastTime: str
10569
+ :param _Uin: 腾讯云主账号Id。
10570
+ :type Uin: int
10571
+ :param _SubUin: 腾讯云主账号下的子账号Id。
10572
+ :type SubUin: int
10573
+ :param _LastStatus: 仪表盘订阅记录最后一次发送的状态。success:全部发送成功,fail:未发送, partialSuccess:部分发送成功。
10574
+ :type LastStatus: str
10575
+ """
10576
+ self._Id = None
10577
+ self._Name = None
10578
+ self._DashboardId = None
10579
+ self._Cron = None
10580
+ self._SubscribeData = None
10581
+ self._CreateTime = None
10582
+ self._UpdateTime = None
10583
+ self._LastTime = None
10584
+ self._Uin = None
10585
+ self._SubUin = None
10586
+ self._LastStatus = None
10587
+
10588
+ @property
10589
+ def Id(self):
10590
+ """仪表盘订阅id。
10591
+ :rtype: int
10592
+ """
10593
+ return self._Id
10594
+
10595
+ @Id.setter
10596
+ def Id(self, Id):
10597
+ self._Id = Id
10598
+
10599
+ @property
10600
+ def Name(self):
10601
+ """仪表盘订阅名称。
10602
+ :rtype: str
10603
+ """
10604
+ return self._Name
10605
+
10606
+ @Name.setter
10607
+ def Name(self, Name):
10608
+ self._Name = Name
10609
+
10610
+ @property
10611
+ def DashboardId(self):
10612
+ """仪表盘id。
10613
+ :rtype: str
10614
+ """
10615
+ return self._DashboardId
10616
+
10617
+ @DashboardId.setter
10618
+ def DashboardId(self, DashboardId):
10619
+ self._DashboardId = DashboardId
10620
+
10621
+ @property
10622
+ def Cron(self):
10623
+ """仪表盘订阅时间。
10624
+ :rtype: str
10625
+ """
10626
+ return self._Cron
10627
+
10628
+ @Cron.setter
10629
+ def Cron(self, Cron):
10630
+ self._Cron = Cron
10631
+
10632
+ @property
10633
+ def SubscribeData(self):
10634
+ """仪表盘订阅数据。
10635
+ :rtype: :class:`tencentcloud.cls.v20201016.models.DashboardSubscribeData`
10636
+ """
10637
+ return self._SubscribeData
10638
+
10639
+ @SubscribeData.setter
10640
+ def SubscribeData(self, SubscribeData):
10641
+ self._SubscribeData = SubscribeData
10642
+
10643
+ @property
10644
+ def CreateTime(self):
10645
+ """仪表盘订阅记录创建时间。格式:`YYYY-MM-DD HH:MM:SS`
10646
+ :rtype: str
10647
+ """
10648
+ return self._CreateTime
10649
+
10650
+ @CreateTime.setter
10651
+ def CreateTime(self, CreateTime):
10652
+ self._CreateTime = CreateTime
10653
+
10654
+ @property
10655
+ def UpdateTime(self):
10656
+ """仪表盘订阅记录更新时间。格式:`YYYY-MM-DD HH:MM:SS`
10657
+ :rtype: str
10658
+ """
10659
+ return self._UpdateTime
10660
+
10661
+ @UpdateTime.setter
10662
+ def UpdateTime(self, UpdateTime):
10663
+ self._UpdateTime = UpdateTime
10664
+
10665
+ @property
10666
+ def LastTime(self):
10667
+ """仪表盘订阅记录最后一次发送成功时间。格式:`YYYY-MM-DD HH:MM:SS`
10668
+ :rtype: str
10669
+ """
10670
+ return self._LastTime
10671
+
10672
+ @LastTime.setter
10673
+ def LastTime(self, LastTime):
10674
+ self._LastTime = LastTime
10675
+
10676
+ @property
10677
+ def Uin(self):
10678
+ """腾讯云主账号Id。
10679
+ :rtype: int
10680
+ """
10681
+ return self._Uin
10682
+
10683
+ @Uin.setter
10684
+ def Uin(self, Uin):
10685
+ self._Uin = Uin
10686
+
10687
+ @property
10688
+ def SubUin(self):
10689
+ """腾讯云主账号下的子账号Id。
10690
+ :rtype: int
10691
+ """
10692
+ return self._SubUin
10693
+
10694
+ @SubUin.setter
10695
+ def SubUin(self, SubUin):
10696
+ self._SubUin = SubUin
10697
+
10698
+ @property
10699
+ def LastStatus(self):
10700
+ """仪表盘订阅记录最后一次发送的状态。success:全部发送成功,fail:未发送, partialSuccess:部分发送成功。
10701
+ :rtype: str
10702
+ """
10703
+ return self._LastStatus
10704
+
10705
+ @LastStatus.setter
10706
+ def LastStatus(self, LastStatus):
10707
+ self._LastStatus = LastStatus
10708
+
10709
+
10710
+ def _deserialize(self, params):
10711
+ self._Id = params.get("Id")
10712
+ self._Name = params.get("Name")
10713
+ self._DashboardId = params.get("DashboardId")
10714
+ self._Cron = params.get("Cron")
10715
+ if params.get("SubscribeData") is not None:
10716
+ self._SubscribeData = DashboardSubscribeData()
10717
+ self._SubscribeData._deserialize(params.get("SubscribeData"))
10718
+ self._CreateTime = params.get("CreateTime")
10719
+ self._UpdateTime = params.get("UpdateTime")
10720
+ self._LastTime = params.get("LastTime")
10721
+ self._Uin = params.get("Uin")
10722
+ self._SubUin = params.get("SubUin")
10723
+ self._LastStatus = params.get("LastStatus")
10724
+ memeber_set = set(params.keys())
10725
+ for name, value in vars(self).items():
10726
+ property_name = name[1:]
10727
+ if property_name in memeber_set:
10728
+ memeber_set.remove(property_name)
10729
+ if len(memeber_set) > 0:
10730
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
10731
+
10732
+
10733
+
10486
10734
  class DashboardTemplateVariable(AbstractModel):
10487
10735
  """仪表盘订阅模板变量
10488
10736
 
@@ -10693,7 +10941,7 @@ class DataTransformTaskInfo(AbstractModel):
10693
10941
  :type TaskId: str
10694
10942
  :param _EnableFlag: 任务启用状态,默认为1,正常开启, 2关闭
10695
10943
  :type EnableFlag: int
10696
- :param _Type: 加工任务类型,1: DSL, 2:SQL
10944
+ :param _Type: 加工任务类型,1: DSL(使用自定义加工语言的加工任务), 2:SQL(使用sql的加工任务)
10697
10945
  :type Type: int
10698
10946
  :param _SrcTopicId: 源日志主题
10699
10947
  :type SrcTopicId: str
@@ -10702,8 +10950,10 @@ class DataTransformTaskInfo(AbstractModel):
10702
10950
  :param _CreateTime: 加工任务创建时间
10703
10951
  :type CreateTime: str
10704
10952
  :param _UpdateTime: 最近修改时间
10953
+ 示例值:2025-06-18 16:55:54
10705
10954
  :type UpdateTime: str
10706
10955
  :param _LastEnableTime: 最后启用时间,如果需要重建集群,修改该时间
10956
+ 示例值:2025-06-18 19:55:54
10707
10957
  :type LastEnableTime: str
10708
10958
  :param _SrcTopicName: 日志主题名称
10709
10959
  :type SrcTopicName: str
@@ -10772,7 +11022,7 @@ class DataTransformTaskInfo(AbstractModel):
10772
11022
 
10773
11023
  @property
10774
11024
  def Type(self):
10775
- """加工任务类型,1: DSL, 2:SQL
11025
+ """加工任务类型,1: DSL(使用自定义加工语言的加工任务), 2:SQL(使用sql的加工任务)
10776
11026
  :rtype: int
10777
11027
  """
10778
11028
  return self._Type
@@ -10817,6 +11067,7 @@ class DataTransformTaskInfo(AbstractModel):
10817
11067
  @property
10818
11068
  def UpdateTime(self):
10819
11069
  """最近修改时间
11070
+ 示例值:2025-06-18 16:55:54
10820
11071
  :rtype: str
10821
11072
  """
10822
11073
  return self._UpdateTime
@@ -10828,6 +11079,7 @@ class DataTransformTaskInfo(AbstractModel):
10828
11079
  @property
10829
11080
  def LastEnableTime(self):
10830
11081
  """最后启用时间,如果需要重建集群,修改该时间
11082
+ 示例值:2025-06-18 19:55:54
10831
11083
  :rtype: str
10832
11084
  """
10833
11085
  return self._LastEnableTime
@@ -11660,7 +11912,7 @@ class DeleteCosRechargeRequest(AbstractModel):
11660
11912
  def __init__(self):
11661
11913
  r"""
11662
11914
  :param _Id: COS导入配置Id。
11663
- - 通过[获取投递任务列表](https://cloud.tencent.com/document/api/614/58745)获取COS导入配置Id。
11915
+ - 通过 [获取cos导入配置](https://cloud.tencent.com/document/product/614/88099) 获取COS导入配置Id。
11664
11916
  :type Id: str
11665
11917
  :param _TopicId: 日志主题Id。
11666
11918
  - 通过[获取日志主题列表](https://cloud.tencent.com/document/api/614/56454)获取日志主题Id。
@@ -11672,7 +11924,7 @@ class DeleteCosRechargeRequest(AbstractModel):
11672
11924
  @property
11673
11925
  def Id(self):
11674
11926
  """COS导入配置Id。
11675
- - 通过[获取投递任务列表](https://cloud.tencent.com/document/api/614/58745)获取COS导入配置Id。
11927
+ - 通过 [获取cos导入配置](https://cloud.tencent.com/document/product/614/88099) 获取COS导入配置Id。
11676
11928
  :rtype: str
11677
11929
  """
11678
11930
  return self._Id
@@ -12651,9 +12903,9 @@ class DeliverConfig(AbstractModel):
12651
12903
  ap-guangzhou 广州地域;
12652
12904
  ap-nanjing 南京地域。
12653
12905
 
12654
- 详细信息请查看官网:
12906
+ 详细信息请查看官网[地域和访问域名](https://cloud.tencent.com/document/product/614/18940)
12907
+
12655
12908
 
12656
- https://cloud.tencent.com/document/product/614/18940
12657
12909
  :type Region: str
12658
12910
  :param _TopicId: 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
12659
12911
  :type TopicId: str
@@ -12676,9 +12928,9 @@ https://cloud.tencent.com/document/product/614/18940
12676
12928
  ap-guangzhou 广州地域;
12677
12929
  ap-nanjing 南京地域。
12678
12930
 
12679
- 详细信息请查看官网:
12931
+ 详细信息请查看官网[地域和访问域名](https://cloud.tencent.com/document/product/614/18940)
12932
+
12680
12933
 
12681
- https://cloud.tencent.com/document/product/614/18940
12682
12934
  :rtype: str
12683
12935
  """
12684
12936
  return self._Region
@@ -12923,7 +13175,7 @@ class DescribeAlarmShieldsRequest(AbstractModel):
12923
13175
 
12924
13176
  def __init__(self):
12925
13177
  r"""
12926
- :param _AlarmNoticeId: 通知渠道组id
13178
+ :param _AlarmNoticeId: 通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组id
12927
13179
  :type AlarmNoticeId: str
12928
13180
  :param _Filters: - taskId:按照【规则id】进行过滤。类型:String 必选:否
12929
13181
  - status:按照【规则状态】进行过滤。类型:String。 支持 0:暂未生效,1:生效中,2:已失效。 必选:否
@@ -12941,7 +13193,7 @@ class DescribeAlarmShieldsRequest(AbstractModel):
12941
13193
 
12942
13194
  @property
12943
13195
  def AlarmNoticeId(self):
12944
- """通知渠道组id
13196
+ """通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组id
12945
13197
  :rtype: str
12946
13198
  """
12947
13199
  return self._AlarmNoticeId
@@ -14371,6 +14623,7 @@ class DescribeDashboardSubscribesRequest(AbstractModel):
14371
14623
  :param _Filters: dashboardId:按照【仪表盘id】进行过滤。类型:String必选:否
14372
14624
 
14373
14625
  - 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。
14626
+ - 入参示例:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5
14374
14627
 
14375
14628
  每次请求的Filters的上限为10,Filter.Values的上限为100。
14376
14629
  :type Filters: list of Filter
@@ -14388,6 +14641,7 @@ class DescribeDashboardSubscribesRequest(AbstractModel):
14388
14641
  """dashboardId:按照【仪表盘id】进行过滤。类型:String必选:否
14389
14642
 
14390
14643
  - 仪表盘id。通过 [获取仪表盘](https://cloud.tencent.com/document/api/614/95636)接口获取DashboardId。
14644
+ - 入参示例:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5
14391
14645
 
14392
14646
  每次请求的Filters的上限为10,Filter.Values的上限为100。
14393
14647
  :rtype: list of Filter
@@ -14447,11 +14701,39 @@ class DescribeDashboardSubscribesResponse(AbstractModel):
14447
14701
 
14448
14702
  def __init__(self):
14449
14703
  r"""
14704
+ :param _DashboardSubscribeInfos: 仪表盘订阅列表
14705
+ :type DashboardSubscribeInfos: list of DashboardSubscribeInfo
14706
+ :param _TotalCount: 总数目
14707
+ :type TotalCount: int
14450
14708
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
14451
14709
  :type RequestId: str
14452
14710
  """
14711
+ self._DashboardSubscribeInfos = None
14712
+ self._TotalCount = None
14453
14713
  self._RequestId = None
14454
14714
 
14715
+ @property
14716
+ def DashboardSubscribeInfos(self):
14717
+ """仪表盘订阅列表
14718
+ :rtype: list of DashboardSubscribeInfo
14719
+ """
14720
+ return self._DashboardSubscribeInfos
14721
+
14722
+ @DashboardSubscribeInfos.setter
14723
+ def DashboardSubscribeInfos(self, DashboardSubscribeInfos):
14724
+ self._DashboardSubscribeInfos = DashboardSubscribeInfos
14725
+
14726
+ @property
14727
+ def TotalCount(self):
14728
+ """总数目
14729
+ :rtype: int
14730
+ """
14731
+ return self._TotalCount
14732
+
14733
+ @TotalCount.setter
14734
+ def TotalCount(self, TotalCount):
14735
+ self._TotalCount = TotalCount
14736
+
14455
14737
  @property
14456
14738
  def RequestId(self):
14457
14739
  """唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -14465,6 +14747,13 @@ class DescribeDashboardSubscribesResponse(AbstractModel):
14465
14747
 
14466
14748
 
14467
14749
  def _deserialize(self, params):
14750
+ if params.get("DashboardSubscribeInfos") is not None:
14751
+ self._DashboardSubscribeInfos = []
14752
+ for item in params.get("DashboardSubscribeInfos"):
14753
+ obj = DashboardSubscribeInfo()
14754
+ obj._deserialize(item)
14755
+ self._DashboardSubscribeInfos.append(obj)
14756
+ self._TotalCount = params.get("TotalCount")
14468
14757
  self._RequestId = params.get("RequestId")
14469
14758
 
14470
14759
 
@@ -14480,17 +14769,44 @@ class DescribeDashboardsRequest(AbstractModel):
14480
14769
  :param _Limit: 分页单页限制数目,默认值为20,最大值100。
14481
14770
  :type Limit: int
14482
14771
  :param _Filters: - dashboardId 按照【仪表盘id】进行过滤,类型:String, 必选:否。
14772
+ - 示例值:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5
14483
14773
  - dashboardName 按照【仪表盘名字】进行模糊搜索过滤,类型:String,必选:否。
14484
- - dashboardRegion 按照【仪表盘地域】进行过滤,为了兼容老的仪表盘,通过云API创建的仪表盘没有地域属性,类型:String,必选:否。 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940),例如:ap-guangzhou
14774
+ - 示例值:业务大盘
14775
+ - dashboardRegion 按照【仪表盘地域】进行过滤(兼容老的仪表盘),通过云API创建的仪表盘该属性,类型:String,必选:否。
14776
+ - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940)
14777
+ - 示例:ap-guangzhou
14485
14778
  - tagKey 按照【标签键】进行过滤,类型:String,必选:否。
14486
- - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,类型:String,必选:否,使用请参考[示例2](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B)。
14779
+ - 示例值:
14780
+ ```
14781
+ "Filters":[
14782
+ {
14783
+ "Key": "tagKey",
14784
+ "Values": [
14785
+ "tag-key-test"
14786
+ ]
14787
+ }
14788
+ ]
14789
+ ```
14790
+
14791
+ - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,类型:String,必选:否,
14792
+ - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。
14793
+ ```
14794
+ "Filters": [
14795
+ {
14796
+ "Key": "tag:tag-key-test",
14797
+ "Values": [
14798
+ "12"
14799
+ ]
14800
+ }
14801
+ ]
14802
+ ```
14487
14803
 
14488
14804
  每次请求的Filters的上限为10,Filter.Values的上限为100。
14489
14805
  :type Filters: list of Filter
14490
14806
  :param _TopicIdRegionFilter: 按照topicId和regionId过滤。
14491
-
14492
14807
  - topicId:日志主题Id。
14493
14808
  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14809
+ - 示例值:439a5304-08f9-484b-9c4d-46ff57133816
14494
14810
  - regionId
14495
14811
  - 1:广州
14496
14812
  - 4:上海
@@ -14547,10 +14863,37 @@ class DescribeDashboardsRequest(AbstractModel):
14547
14863
  @property
14548
14864
  def Filters(self):
14549
14865
  """- dashboardId 按照【仪表盘id】进行过滤,类型:String, 必选:否。
14866
+ - 示例值:dashboard-522a5609-1f41-4b11-8086-5afd1d7574f5
14550
14867
  - dashboardName 按照【仪表盘名字】进行模糊搜索过滤,类型:String,必选:否。
14551
- - dashboardRegion 按照【仪表盘地域】进行过滤,为了兼容老的仪表盘,通过云API创建的仪表盘没有地域属性,类型:String,必选:否。 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940),例如:ap-guangzhou
14868
+ - 示例值:业务大盘
14869
+ - dashboardRegion 按照【仪表盘地域】进行过滤(兼容老的仪表盘),通过云API创建的仪表盘该属性,类型:String,必选:否。
14870
+ - 参考 [地域和访问域名](https://cloud.tencent.com/document/product/614/18940)
14871
+ - 示例:ap-guangzhou
14552
14872
  - tagKey 按照【标签键】进行过滤,类型:String,必选:否。
14553
- - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,类型:String,必选:否,使用请参考[示例2](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B)。
14873
+ - 示例值:
14874
+ ```
14875
+ "Filters":[
14876
+ {
14877
+ "Key": "tagKey",
14878
+ "Values": [
14879
+ "tag-key-test"
14880
+ ]
14881
+ }
14882
+ ]
14883
+ ```
14884
+
14885
+ - tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换,类型:String,必选:否,
14886
+ - 参考 [示例1](https://cloud.tencent.com/document/api/614/95636#4.-.E7.A4.BA.E4.BE.8B) 使用。
14887
+ ```
14888
+ "Filters": [
14889
+ {
14890
+ "Key": "tag:tag-key-test",
14891
+ "Values": [
14892
+ "12"
14893
+ ]
14894
+ }
14895
+ ]
14896
+ ```
14554
14897
 
14555
14898
  每次请求的Filters的上限为10,Filter.Values的上限为100。
14556
14899
  :rtype: list of Filter
@@ -14564,9 +14907,9 @@ class DescribeDashboardsRequest(AbstractModel):
14564
14907
  @property
14565
14908
  def TopicIdRegionFilter(self):
14566
14909
  """按照topicId和regionId过滤。
14567
-
14568
14910
  - topicId:日志主题Id。
14569
14911
  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14912
+ - 示例值:439a5304-08f9-484b-9c4d-46ff57133816
14570
14913
  - regionId
14571
14914
  - 1:广州
14572
14915
  - 4:上海
@@ -14699,28 +15042,40 @@ class DescribeDataTransformInfoRequest(AbstractModel):
14699
15042
  按照【加工任务名称】进行过滤。
14700
15043
  类型:String
14701
15044
  必选:否
15045
+ 示例:test-task
14702
15046
 
14703
15047
  - taskId
14704
15048
  按照【加工任务id】进行过滤。
14705
15049
  类型:String
14706
15050
  必选:否
15051
+ 示例:a3622556-6402-4942-b4ff-5ae32ec29810
15052
+ 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
14707
15053
 
14708
15054
  - topicId
14709
15055
  按照【源topicId】进行过滤。
14710
15056
  类型:String
14711
15057
  必选:否
15058
+ 示例:756cec3e-a0a5-44c3-85a8-090870582000
15059
+ 日志主题ID
15060
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
15061
+
14712
15062
  - status
14713
15063
  按照【 任务运行状态】进行过滤。 1:准备中,2:运行中,3:停止中,4:已停止
14714
15064
  类型:String
14715
15065
  必选:否
15066
+ 示例:1
15067
+
14716
15068
  - hasServiceLog
14717
15069
  按照【是否开启服务日志】进行过滤。 1:未开启,2:已开启
14718
15070
  类型:String
14719
15071
  必选:否
15072
+ 示例:1
15073
+
14720
15074
  - dstTopicType
14721
15075
  按照【目标topic类型】进行过滤。 1:固定,2:动态
14722
15076
  类型:String
14723
15077
  必选:否
15078
+ 示例:1
14724
15079
 
14725
15080
  每次请求的Filters的上限为10,Filter.Values的上限为100。
14726
15081
  :type Filters: list of Filter
@@ -14731,6 +15086,7 @@ class DescribeDataTransformInfoRequest(AbstractModel):
14731
15086
  :param _Type: 默认值为2. 1: 获取单个任务的详细信息 2:获取任务列表
14732
15087
  :type Type: int
14733
15088
  :param _TaskId: Type为1, 此参数必填
15089
+ 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
14734
15090
  :type TaskId: str
14735
15091
  """
14736
15092
  self._Filters = None
@@ -14745,28 +15101,40 @@ class DescribeDataTransformInfoRequest(AbstractModel):
14745
15101
  按照【加工任务名称】进行过滤。
14746
15102
  类型:String
14747
15103
  必选:否
15104
+ 示例:test-task
14748
15105
 
14749
15106
  - taskId
14750
15107
  按照【加工任务id】进行过滤。
14751
15108
  类型:String
14752
15109
  必选:否
15110
+ 示例:a3622556-6402-4942-b4ff-5ae32ec29810
15111
+ 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
14753
15112
 
14754
15113
  - topicId
14755
15114
  按照【源topicId】进行过滤。
14756
15115
  类型:String
14757
15116
  必选:否
15117
+ 示例:756cec3e-a0a5-44c3-85a8-090870582000
15118
+ 日志主题ID
15119
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
15120
+
14758
15121
  - status
14759
15122
  按照【 任务运行状态】进行过滤。 1:准备中,2:运行中,3:停止中,4:已停止
14760
15123
  类型:String
14761
15124
  必选:否
15125
+ 示例:1
15126
+
14762
15127
  - hasServiceLog
14763
15128
  按照【是否开启服务日志】进行过滤。 1:未开启,2:已开启
14764
15129
  类型:String
14765
15130
  必选:否
15131
+ 示例:1
15132
+
14766
15133
  - dstTopicType
14767
15134
  按照【目标topic类型】进行过滤。 1:固定,2:动态
14768
15135
  类型:String
14769
15136
  必选:否
15137
+ 示例:1
14770
15138
 
14771
15139
  每次请求的Filters的上限为10,Filter.Values的上限为100。
14772
15140
  :rtype: list of Filter
@@ -14813,6 +15181,7 @@ class DescribeDataTransformInfoRequest(AbstractModel):
14813
15181
  @property
14814
15182
  def TaskId(self):
14815
15183
  """Type为1, 此参数必填
15184
+ 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
14816
15185
  :rtype: str
14817
15186
  """
14818
15187
  return self._TaskId
@@ -15481,13 +15850,15 @@ class DescribeLogContextRequest(AbstractModel):
15481
15850
 
15482
15851
  def __init__(self):
15483
15852
  r"""
15484
- :param _TopicId: 要查询的日志主题ID
15853
+ :param _TopicId: 要查询的日志主题Id。
15854
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
15855
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
15485
15856
  :type TopicId: str
15486
- :param _BTime: 日志时间, 即SearchLog接口返回信息中Results结构体中的Time,需按照 UTC+8 时区将该毫秒级Unix时间戳转换为 YYYY-mm-dd HH:MM:SS.FFF 格式的字符串。
15857
+ :param _BTime: 日志时间, 即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构体中的Time,需按照 UTC+8 时区将该毫秒级Unix时间戳转换为 YYYY-mm-dd HH:MM:SS.FFF 格式的字符串。
15487
15858
  :type BTime: str
15488
- :param _PkgId: 日志包序号,即SearchLog接口返回信息中Results结构体中的PkgId。
15859
+ :param _PkgId: 日志包序号,即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构体中的PkgId。
15489
15860
  :type PkgId: str
15490
- :param _PkgLogId: 日志包内一条日志的序号,即SearchLog接口返回信息中Results结构中的PkgLogId。
15861
+ :param _PkgLogId: 日志包内一条日志的序号,即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构中的PkgLogId。
15491
15862
  :type PkgLogId: int
15492
15863
  :param _PrevLogs: 前${PrevLogs}条日志,默认值10。
15493
15864
  :type PrevLogs: int
@@ -15521,7 +15892,9 @@ class DescribeLogContextRequest(AbstractModel):
15521
15892
 
15522
15893
  @property
15523
15894
  def TopicId(self):
15524
- """要查询的日志主题ID
15895
+ """要查询的日志主题Id。
15896
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
15897
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
15525
15898
  :rtype: str
15526
15899
  """
15527
15900
  return self._TopicId
@@ -15532,7 +15905,7 @@ class DescribeLogContextRequest(AbstractModel):
15532
15905
 
15533
15906
  @property
15534
15907
  def BTime(self):
15535
- """日志时间, 即SearchLog接口返回信息中Results结构体中的Time,需按照 UTC+8 时区将该毫秒级Unix时间戳转换为 YYYY-mm-dd HH:MM:SS.FFF 格式的字符串。
15908
+ """日志时间, 即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构体中的Time,需按照 UTC+8 时区将该毫秒级Unix时间戳转换为 YYYY-mm-dd HH:MM:SS.FFF 格式的字符串。
15536
15909
  :rtype: str
15537
15910
  """
15538
15911
  return self._BTime
@@ -15543,7 +15916,7 @@ class DescribeLogContextRequest(AbstractModel):
15543
15916
 
15544
15917
  @property
15545
15918
  def PkgId(self):
15546
- """日志包序号,即SearchLog接口返回信息中Results结构体中的PkgId。
15919
+ """日志包序号,即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构体中的PkgId。
15547
15920
  :rtype: str
15548
15921
  """
15549
15922
  return self._PkgId
@@ -15554,7 +15927,7 @@ class DescribeLogContextRequest(AbstractModel):
15554
15927
 
15555
15928
  @property
15556
15929
  def PkgLogId(self):
15557
- """日志包内一条日志的序号,即SearchLog接口返回信息中Results结构中的PkgLogId。
15930
+ """日志包内一条日志的序号,即 [检索分析日志](https://cloud.tencent.com/document/product/614/56447) 接口返回信息中Results结构中的PkgLogId。
15558
15931
  :rtype: int
15559
15932
  """
15560
15933
  return self._PkgLogId
@@ -21900,7 +22273,7 @@ class ModifyAlarmNoticeRequest(AbstractModel):
21900
22273
 
21901
22274
  def __init__(self):
21902
22275
  r"""
21903
- :param _AlarmNoticeId: 通知渠道组ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知渠道组ID
22276
+ :param _AlarmNoticeId: 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
21904
22277
  :type AlarmNoticeId: str
21905
22278
  :param _Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持10个标签键值对,并且不能有重复的键值对。
21906
22279
  :type Tags: list of Tag
@@ -21955,7 +22328,7 @@ class ModifyAlarmNoticeRequest(AbstractModel):
21955
22328
 
21956
22329
  @property
21957
22330
  def AlarmNoticeId(self):
21958
- """通知渠道组ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知渠道组ID
22331
+ """通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
21959
22332
  :rtype: str
21960
22333
  """
21961
22334
  return self._AlarmNoticeId
@@ -22913,12 +23286,17 @@ class ModifyConfigExtraRequest(AbstractModel):
22913
23286
  :param _TopicId: 日志主题id
22914
23287
  - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22915
23288
  :type TopicId: str
22916
- :param _HostFile: 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息,详细参考https://cloud.tencent.com/document/api/614/56471#HostFileInfo
23289
+ :param _HostFile: 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。
23290
+
23291
+ - 详情参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 文档。
22917
23292
  :type HostFile: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
22918
23293
  :param _ContainerFile: 采集配置标记。
22919
23294
  - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
23295
+ - 详情参考 [ ContainerFileInfo](https://cloud.tencent.com/document/api/614/56471#ContainerFileInfo) 文档
22920
23296
  :type ContainerFile: :class:`tencentcloud.cls.v20201016.models.ContainerFileInfo`
22921
- :param _ContainerStdout: 自建k8s-容器标准输出信息,包括容器、命名空间等,详细参考https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo
23297
+ :param _ContainerStdout: 自建k8s-容器标准输出信息,包括容器、命名空间等,
23298
+
23299
+ - 详情参考 [ContainerStdoutInfo]( https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 文档
22922
23300
  :type ContainerStdout: :class:`tencentcloud.cls.v20201016.models.ContainerStdoutInfo`
22923
23301
  :param _LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
22924
23302
  - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
@@ -22933,7 +23311,7 @@ class ModifyConfigExtraRequest(AbstractModel):
22933
23311
  - stdout-docker-json:用于docker容器采集场景
22934
23312
  - stdout-containerd:用于containerd容器采集场景
22935
23313
  :type LogFormat: str
22936
- :param _ExtractRule: 提取规则,如果设置了ExtractRule,则必须设置LogType
23314
+ :param _ExtractRule: 提取规则,如果设置了ExtractRule,则必须设置LogType
22937
23315
  :type ExtractRule: :class:`tencentcloud.cls.v20201016.models.ExtractRuleInfo`
22938
23316
  :param _ExcludePaths: 采集黑名单路径列表
22939
23317
  :type ExcludePaths: list of ExcludePathInfo
@@ -23024,7 +23402,9 @@ class ModifyConfigExtraRequest(AbstractModel):
23024
23402
 
23025
23403
  @property
23026
23404
  def HostFile(self):
23027
- """自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息,详细参考https://cloud.tencent.com/document/api/614/56471#HostFileInfo
23405
+ """自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息。
23406
+
23407
+ - 详情参考 [HostFileInfo](https://cloud.tencent.com/document/api/614/56471#HostFileInfo) 文档。
23028
23408
  :rtype: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
23029
23409
  """
23030
23410
  return self._HostFile
@@ -23037,6 +23417,7 @@ class ModifyConfigExtraRequest(AbstractModel):
23037
23417
  def ContainerFile(self):
23038
23418
  """采集配置标记。
23039
23419
  - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
23420
+ - 详情参考 [ ContainerFileInfo](https://cloud.tencent.com/document/api/614/56471#ContainerFileInfo) 文档
23040
23421
  :rtype: :class:`tencentcloud.cls.v20201016.models.ContainerFileInfo`
23041
23422
  """
23042
23423
  return self._ContainerFile
@@ -23047,7 +23428,9 @@ class ModifyConfigExtraRequest(AbstractModel):
23047
23428
 
23048
23429
  @property
23049
23430
  def ContainerStdout(self):
23050
- """自建k8s-容器标准输出信息,包括容器、命名空间等,详细参考https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo
23431
+ """自建k8s-容器标准输出信息,包括容器、命名空间等,
23432
+
23433
+ - 详情参考 [ContainerStdoutInfo]( https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo) 文档
23051
23434
  :rtype: :class:`tencentcloud.cls.v20201016.models.ContainerStdoutInfo`
23052
23435
  """
23053
23436
  return self._ContainerStdout
@@ -23093,7 +23476,7 @@ class ModifyConfigExtraRequest(AbstractModel):
23093
23476
 
23094
23477
  @property
23095
23478
  def ExtractRule(self):
23096
- """提取规则,如果设置了ExtractRule,则必须设置LogType
23479
+ """提取规则,如果设置了ExtractRule,则必须设置LogType
23097
23480
  :rtype: :class:`tencentcloud.cls.v20201016.models.ExtractRuleInfo`
23098
23481
  """
23099
23482
  return self._ExtractRule
@@ -24125,9 +24508,16 @@ class ModifyDataTransformRequest(AbstractModel):
24125
24508
 
24126
24509
  def __init__(self):
24127
24510
  r"""
24128
- :param _TaskId: 加工任务id
24511
+ :param _TaskId: 数据加工任务ID
24512
+ - 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
24129
24513
  :type TaskId: str
24130
24514
  :param _Name: 加工任务名称
24515
+ - 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务名称。
24516
+
24517
+ 名称限制
24518
+ - 不能为空字符串
24519
+ - 不能包含字符'|'
24520
+ - 最长 255 个字符
24131
24521
  :type Name: str
24132
24522
  :param _EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
24133
24523
 
@@ -24152,7 +24542,8 @@ class ModifyDataTransformRequest(AbstractModel):
24152
24542
 
24153
24543
  @property
24154
24544
  def TaskId(self):
24155
- """加工任务id
24545
+ """数据加工任务ID
24546
+ - 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
24156
24547
  :rtype: str
24157
24548
  """
24158
24549
  return self._TaskId
@@ -24164,6 +24555,12 @@ class ModifyDataTransformRequest(AbstractModel):
24164
24555
  @property
24165
24556
  def Name(self):
24166
24557
  """加工任务名称
24558
+ - 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务名称。
24559
+
24560
+ 名称限制
24561
+ - 不能为空字符串
24562
+ - 不能包含字符'|'
24563
+ - 最长 255 个字符
24167
24564
  :rtype: str
24168
24565
  """
24169
24566
  return self._Name
@@ -24279,9 +24676,11 @@ class ModifyIndexRequest(AbstractModel):
24279
24676
 
24280
24677
  def __init__(self):
24281
24678
  r"""
24282
- :param _TopicId: 日志主题ID
24679
+ :param _TopicId: 日志主题Id。
24680
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
24283
24681
  :type TopicId: str
24284
- :param _Status: 默认不生效
24682
+ :param _Status: 索引状态。false:关闭索引, true:开启索引
24683
+ 开启后可对日志进行检索分析,将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)
24285
24684
  :type Status: bool
24286
24685
  :param _Rule: 索引规则
24287
24686
  :type Rule: :class:`tencentcloud.cls.v20201016.models.RuleInfo`
@@ -24303,7 +24702,8 @@ class ModifyIndexRequest(AbstractModel):
24303
24702
 
24304
24703
  @property
24305
24704
  def TopicId(self):
24306
- """日志主题ID
24705
+ """日志主题Id。
24706
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
24307
24707
  :rtype: str
24308
24708
  """
24309
24709
  return self._TopicId
@@ -24314,7 +24714,8 @@ class ModifyIndexRequest(AbstractModel):
24314
24714
 
24315
24715
  @property
24316
24716
  def Status(self):
24317
- """默认不生效
24717
+ """索引状态。false:关闭索引, true:开启索引
24718
+ 开启后可对日志进行检索分析,将产生索引流量、索引存储及相应费用。[费用详情](https://cloud.tencent.com/document/product/614/45802#.E8.AE.A1.E8.B4.B9.E9.A1.B9)
24318
24719
  :rtype: bool
24319
24720
  """
24320
24721
  return self._Status
@@ -25746,7 +26147,7 @@ class ModifyTopicRequest(AbstractModel):
25746
26147
  - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
25747
26148
  :type PartitionCount: int
25748
26149
  :param _CancelTopicAsyncTaskID: 取消切换存储任务的id
25749
- - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id
26150
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id【Topics中的TopicAsyncTaskID字段】。
25750
26151
  :type CancelTopicAsyncTaskID: str
25751
26152
  """
25752
26153
  self._TopicId = None
@@ -25912,7 +26313,7 @@ class ModifyTopicRequest(AbstractModel):
25912
26313
  @property
25913
26314
  def CancelTopicAsyncTaskID(self):
25914
26315
  """取消切换存储任务的id
25915
- - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id
26316
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id【Topics中的TopicAsyncTaskID字段】。
25916
26317
  :rtype: str
25917
26318
  """
25918
26319
  return self._CancelTopicAsyncTaskID
@@ -30433,9 +30834,11 @@ class SplitPartitionRequest(AbstractModel):
30433
30834
 
30434
30835
  def __init__(self):
30435
30836
  r"""
30436
- :param _TopicId: 日志主题ID
30837
+ :param _TopicId: 日志主题Id
30838
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
30437
30839
  :type TopicId: str
30438
- :param _PartitionId: 待分裂分区ID
30840
+ :param _PartitionId: 待分裂分区Id
30841
+ - 通过[获取分区列表](https://cloud.tencent.com/document/product/614/56470)获取待分裂分区Id。
30439
30842
  :type PartitionId: int
30440
30843
  :param _SplitKey: 分区切分的哈希key的位置,只在Number=2时有意义
30441
30844
  :type SplitKey: str
@@ -30449,7 +30852,8 @@ class SplitPartitionRequest(AbstractModel):
30449
30852
 
30450
30853
  @property
30451
30854
  def TopicId(self):
30452
- """日志主题ID
30855
+ """日志主题Id
30856
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
30453
30857
  :rtype: str
30454
30858
  """
30455
30859
  return self._TopicId
@@ -30460,7 +30864,8 @@ class SplitPartitionRequest(AbstractModel):
30460
30864
 
30461
30865
  @property
30462
30866
  def PartitionId(self):
30463
- """待分裂分区ID
30867
+ """待分裂分区Id
30868
+ - 通过[获取分区列表](https://cloud.tencent.com/document/product/614/56470)获取待分裂分区Id。
30464
30869
  :rtype: int
30465
30870
  """
30466
30871
  return self._PartitionId
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.2
2
2
  Name: tencentcloud-sdk-python-cls
3
- Version: 3.0.1444
3
+ Version: 3.0.1447
4
4
  Summary: Tencent Cloud Cls SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common<4.0.0,>=3.0.1447
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common<4.0.0,>=3.0.1444