tencentcloud-sdk-python 3.0.1442__py2.py3-none-any.whl → 3.0.1443__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.

Potentially problematic release.


This version of tencentcloud-sdk-python might be problematic. Click here for more details.

Files changed (44) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/batch/v20170312/models.py +28 -48
  3. tencentcloud/ckafka/v20190819/models.py +23 -23
  4. tencentcloud/clb/v20180317/models.py +4 -4
  5. tencentcloud/cls/v20201016/cls_client.py +3 -3
  6. tencentcloud/cls/v20201016/errorcodes.py +3 -0
  7. tencentcloud/cls/v20201016/models.py +943 -214
  8. tencentcloud/common/credential.py +20 -2
  9. tencentcloud/dnspod/v20210323/errorcodes.py +3 -0
  10. tencentcloud/dnspod/v20210323/models.py +17 -2
  11. tencentcloud/es/v20180416/models.py +30 -0
  12. tencentcloud/ess/v20201111/ess_client.py +3 -1
  13. tencentcloud/ess/v20201111/models.py +2 -2
  14. tencentcloud/essbasic/v20210526/essbasic_client.py +3 -1
  15. tencentcloud/essbasic/v20210526/models.py +2 -2
  16. tencentcloud/iai/v20200303/models.py +19 -0
  17. tencentcloud/lighthouse/v20200324/errorcodes.py +27 -0
  18. tencentcloud/lighthouse/v20200324/lighthouse_client.py +53 -0
  19. tencentcloud/lighthouse/v20200324/models.py +534 -0
  20. tencentcloud/live/v20180801/models.py +2 -10
  21. tencentcloud/lke/v20231130/lke_client.py +0 -23
  22. tencentcloud/lke/v20231130/models.py +40 -128
  23. tencentcloud/ocr/v20181119/models.py +34 -0
  24. tencentcloud/organization/v20210331/models.py +24 -26
  25. tencentcloud/ssl/v20191205/models.py +2 -2
  26. tencentcloud/tbaas/v20180416/errorcodes.py +6 -0
  27. tencentcloud/teo/v20220901/models.py +18 -18
  28. tencentcloud/tms/v20201229/errorcodes.py +3 -0
  29. tencentcloud/trtc/v20190722/errorcodes.py +15 -0
  30. tencentcloud/trtc/v20190722/models.py +482 -0
  31. tencentcloud/trtc/v20190722/trtc_client.py +64 -0
  32. tencentcloud/tse/v20201207/models.py +30 -0
  33. tencentcloud/tsf/v20180326/errorcodes.py +32 -11
  34. tencentcloud/tsf/v20180326/models.py +976 -778
  35. tencentcloud/tsf/v20180326/tsf_client.py +18 -18
  36. tencentcloud/vod/v20180717/models.py +15 -0
  37. tencentcloud/vpc/v20170312/models.py +35 -0
  38. tencentcloud/vpc/v20170312/vpc_client.py +1 -1
  39. tencentcloud/wsa/v20250508/models.py +42 -6
  40. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/METADATA +1 -1
  41. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/RECORD +44 -44
  42. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/LICENSE +0 -0
  43. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/WHEEL +0 -0
  44. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/top_level.txt +0 -0
@@ -979,9 +979,9 @@ class AlarmShieldInfo(AbstractModel):
979
979
  :param _Status: 规则状态。
980
980
  0:暂未生效,1:生效中,2:已失效
981
981
  :type Status: int
982
- :param _CreateTime: 规则创建时间。
982
+ :param _CreateTime: 规则创建时间。秒级时间戳(s)
983
983
  :type CreateTime: int
984
- :param _UpdateTime: 规则更新时间。
984
+ :param _UpdateTime: 规则更新时间。秒级时间戳(s)
985
985
  :type UpdateTime: int
986
986
  """
987
987
  self._AlarmNoticeId = None
@@ -1111,7 +1111,7 @@ class AlarmShieldInfo(AbstractModel):
1111
1111
 
1112
1112
  @property
1113
1113
  def CreateTime(self):
1114
- """规则创建时间。
1114
+ """规则创建时间。秒级时间戳(s)
1115
1115
  :rtype: int
1116
1116
  """
1117
1117
  return self._CreateTime
@@ -1122,7 +1122,7 @@ class AlarmShieldInfo(AbstractModel):
1122
1122
 
1123
1123
  @property
1124
1124
  def UpdateTime(self):
1125
- """规则更新时间。
1125
+ """规则更新时间。秒级时间戳(s)
1126
1126
  :rtype: int
1127
1127
  """
1128
1128
  return self._UpdateTime
@@ -2016,8 +2016,10 @@ class ApplyConfigToMachineGroupRequest(AbstractModel):
2016
2016
  def __init__(self):
2017
2017
  r"""
2018
2018
  :param _ConfigId: 采集配置ID
2019
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
2019
2020
  :type ConfigId: str
2020
2021
  :param _GroupId: 机器组ID
2022
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
2021
2023
  :type GroupId: str
2022
2024
  """
2023
2025
  self._ConfigId = None
@@ -2026,6 +2028,7 @@ class ApplyConfigToMachineGroupRequest(AbstractModel):
2026
2028
  @property
2027
2029
  def ConfigId(self):
2028
2030
  """采集配置ID
2031
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
2029
2032
  :rtype: str
2030
2033
  """
2031
2034
  return self._ConfigId
@@ -2037,6 +2040,7 @@ class ApplyConfigToMachineGroupRequest(AbstractModel):
2037
2040
  @property
2038
2041
  def GroupId(self):
2039
2042
  """机器组ID
2043
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
2040
2044
  :rtype: str
2041
2045
  """
2042
2046
  return self._GroupId
@@ -2177,9 +2181,15 @@ class CheckFunctionRequest(AbstractModel):
2177
2181
 
2178
2182
  def __init__(self):
2179
2183
  r"""
2180
- :param _EtlContent: 用户输入的加工语句
2184
+ :param _EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
2185
+
2186
+ 其他参考文档:
2187
+
2188
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
2189
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
2181
2190
  :type EtlContent: str
2182
- :param _DstResources: 加工任务目的topic_id以及别名
2191
+ :param _DstResources: 加工任务目标topic_id以及别名,当 FuncType 为 1 时,必填。
2192
+ 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2183
2193
  :type DstResources: list of DataTransformResouceInfo
2184
2194
  :param _FuncType: 数据加工目标主题的类型. 1 固定主题 2动态创建
2185
2195
  :type FuncType: int
@@ -2190,7 +2200,12 @@ class CheckFunctionRequest(AbstractModel):
2190
2200
 
2191
2201
  @property
2192
2202
  def EtlContent(self):
2193
- """用户输入的加工语句
2203
+ """加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
2204
+
2205
+ 其他参考文档:
2206
+
2207
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
2208
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
2194
2209
  :rtype: str
2195
2210
  """
2196
2211
  return self._EtlContent
@@ -2201,7 +2216,8 @@ class CheckFunctionRequest(AbstractModel):
2201
2216
 
2202
2217
  @property
2203
2218
  def DstResources(self):
2204
- """加工任务目的topic_id以及别名
2219
+ """加工任务目标topic_id以及别名,当 FuncType 为 1 时,必填。
2220
+ 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2205
2221
  :rtype: list of DataTransformResouceInfo
2206
2222
  """
2207
2223
  return self._DstResources
@@ -2481,17 +2497,31 @@ class Ckafka(AbstractModel):
2481
2497
 
2482
2498
  def __init__(self):
2483
2499
  r"""
2484
- :param _InstanceId: Ckafka 的 InstanceId
2500
+ :param _InstanceId: Ckafka 的 InstanceId
2501
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
2502
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
2485
2503
  :type InstanceId: str
2486
- :param _TopicName: Ckafka 的 TopicName
2504
+ :param _TopicName: Ckafka 的 TopicName
2505
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
2506
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
2487
2507
  :type TopicName: str
2488
- :param _Vip: Ckafka 的 Vip
2508
+ :param _Vip: Ckafka 的 Vip
2509
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
2510
+ - 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
2489
2511
  :type Vip: str
2490
- :param _Vport: Ckafka 的 Vport
2512
+ :param _Vport: Ckafka 的 Vport
2513
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
2514
+ - 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
2491
2515
  :type Vport: str
2492
- :param _InstanceName: Ckafka 的 InstanceName
2516
+ :param _InstanceName: Ckafka 的 InstanceName
2517
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
2518
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
2519
+ - 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。
2493
2520
  :type InstanceName: str
2494
- :param _TopicId: Ckafka 的 TopicId
2521
+ :param _TopicId: Ckafka 的 TopicId
2522
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
2523
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
2524
+ - 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。
2495
2525
  :type TopicId: str
2496
2526
  """
2497
2527
  self._InstanceId = None
@@ -2503,7 +2533,9 @@ class Ckafka(AbstractModel):
2503
2533
 
2504
2534
  @property
2505
2535
  def InstanceId(self):
2506
- """Ckafka 的 InstanceId
2536
+ """Ckafka 的 InstanceId
2537
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
2538
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
2507
2539
  :rtype: str
2508
2540
  """
2509
2541
  return self._InstanceId
@@ -2514,7 +2546,9 @@ class Ckafka(AbstractModel):
2514
2546
 
2515
2547
  @property
2516
2548
  def TopicName(self):
2517
- """Ckafka 的 TopicName
2549
+ """Ckafka 的 TopicName
2550
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
2551
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
2518
2552
  :rtype: str
2519
2553
  """
2520
2554
  return self._TopicName
@@ -2525,7 +2559,9 @@ class Ckafka(AbstractModel):
2525
2559
 
2526
2560
  @property
2527
2561
  def Vip(self):
2528
- """Ckafka 的 Vip
2562
+ """Ckafka 的 Vip
2563
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
2564
+ - 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
2529
2565
  :rtype: str
2530
2566
  """
2531
2567
  return self._Vip
@@ -2536,7 +2572,9 @@ class Ckafka(AbstractModel):
2536
2572
 
2537
2573
  @property
2538
2574
  def Vport(self):
2539
- """Ckafka 的 Vport
2575
+ """Ckafka 的 Vport
2576
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
2577
+ - 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
2540
2578
  :rtype: str
2541
2579
  """
2542
2580
  return self._Vport
@@ -2547,7 +2585,10 @@ class Ckafka(AbstractModel):
2547
2585
 
2548
2586
  @property
2549
2587
  def InstanceName(self):
2550
- """Ckafka 的 InstanceName
2588
+ """Ckafka 的 InstanceName
2589
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
2590
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
2591
+ - 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。
2551
2592
  :rtype: str
2552
2593
  """
2553
2594
  return self._InstanceName
@@ -2558,7 +2599,10 @@ class Ckafka(AbstractModel):
2558
2599
 
2559
2600
  @property
2560
2601
  def TopicId(self):
2561
- """Ckafka 的 TopicId
2602
+ """Ckafka 的 TopicId
2603
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
2604
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
2605
+ - 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。
2562
2606
  :rtype: str
2563
2607
  """
2564
2608
  return self._TopicId
@@ -2592,14 +2636,18 @@ class CloseKafkaConsumerRequest(AbstractModel):
2592
2636
 
2593
2637
  def __init__(self):
2594
2638
  r"""
2595
- :param _FromTopicId: 日志主题ID
2639
+ :param _FromTopicId: 日志主题Id。
2640
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2641
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2596
2642
  :type FromTopicId: str
2597
2643
  """
2598
2644
  self._FromTopicId = None
2599
2645
 
2600
2646
  @property
2601
2647
  def FromTopicId(self):
2602
- """日志主题ID
2648
+ """日志主题Id。
2649
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2650
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2603
2651
  :rtype: str
2604
2652
  """
2605
2653
  return self._FromTopicId
@@ -3049,7 +3097,10 @@ class ConfigExtraInfo(AbstractModel):
3049
3097
  :type Name: str
3050
3098
  :param _TopicId: 日志主题ID
3051
3099
  :type TopicId: str
3052
- :param _Type: 类型:container_stdout、container_file、host_file
3100
+ :param _Type: 自建k8s集群日志采集类型,支持
3101
+ - container_stdout 标准输出
3102
+ - container_file 标准文件
3103
+ - host_file 节点文件
3053
3104
  :type Type: str
3054
3105
  :param _HostFile: 节点文件配置信息
3055
3106
  :type HostFile: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
@@ -3067,16 +3118,20 @@ class ConfigExtraInfo(AbstractModel):
3067
3118
  注意:此字段可能返回 null,表示取不到有效值。
3068
3119
  :type ExcludePaths: list of ExcludePathInfo
3069
3120
  :param _UpdateTime: 更新时间
3121
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3070
3122
  :type UpdateTime: str
3071
3123
  :param _CreateTime: 创建时间
3124
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3072
3125
  :type CreateTime: str
3073
3126
  :param _UserDefineRule: 用户自定义解析字符串
3074
3127
  :type UserDefineRule: str
3075
3128
  :param _GroupId: 机器组ID
3129
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
3076
3130
  :type GroupId: str
3077
3131
  :param _ConfigFlag: 自建采集配置标
3078
3132
  :type ConfigFlag: str
3079
3133
  :param _LogsetId: 日志集ID
3134
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
3080
3135
  :type LogsetId: str
3081
3136
  :param _LogsetName: 日志集name
3082
3137
  :type LogsetName: str
@@ -3148,7 +3203,10 @@ class ConfigExtraInfo(AbstractModel):
3148
3203
 
3149
3204
  @property
3150
3205
  def Type(self):
3151
- """类型:container_stdout、container_file、host_file
3206
+ """自建k8s集群日志采集类型,支持
3207
+ - container_stdout 标准输出
3208
+ - container_file 标准文件
3209
+ - host_file 节点文件
3152
3210
  :rtype: str
3153
3211
  """
3154
3212
  return self._Type
@@ -3238,6 +3296,7 @@ class ConfigExtraInfo(AbstractModel):
3238
3296
  @property
3239
3297
  def UpdateTime(self):
3240
3298
  """更新时间
3299
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3241
3300
  :rtype: str
3242
3301
  """
3243
3302
  return self._UpdateTime
@@ -3249,6 +3308,7 @@ class ConfigExtraInfo(AbstractModel):
3249
3308
  @property
3250
3309
  def CreateTime(self):
3251
3310
  """创建时间
3311
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3252
3312
  :rtype: str
3253
3313
  """
3254
3314
  return self._CreateTime
@@ -3271,6 +3331,7 @@ class ConfigExtraInfo(AbstractModel):
3271
3331
  @property
3272
3332
  def GroupId(self):
3273
3333
  """机器组ID
3334
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
3274
3335
  :rtype: str
3275
3336
  """
3276
3337
  return self._GroupId
@@ -3293,6 +3354,7 @@ class ConfigExtraInfo(AbstractModel):
3293
3354
  @property
3294
3355
  def LogsetId(self):
3295
3356
  """日志集ID
3357
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
3296
3358
  :rtype: str
3297
3359
  """
3298
3360
  return self._LogsetId
@@ -3434,8 +3496,10 @@ class ConfigInfo(AbstractModel):
3434
3496
  :param _Output: 采集配置所属日志主题ID即TopicId
3435
3497
  :type Output: str
3436
3498
  :param _UpdateTime: 更新时间
3499
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3437
3500
  :type UpdateTime: str
3438
3501
  :param _CreateTime: 创建时间
3502
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3439
3503
  :type CreateTime: str
3440
3504
  :param _UserDefineRule: 用户自定义解析字符串,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310)。
3441
3505
  :type UserDefineRule: str
@@ -3563,6 +3627,7 @@ class ConfigInfo(AbstractModel):
3563
3627
  @property
3564
3628
  def UpdateTime(self):
3565
3629
  """更新时间
3630
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3566
3631
  :rtype: str
3567
3632
  """
3568
3633
  return self._UpdateTime
@@ -3574,6 +3639,7 @@ class ConfigInfo(AbstractModel):
3574
3639
  @property
3575
3640
  def CreateTime(self):
3576
3641
  """创建时间
3642
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3577
3643
  :rtype: str
3578
3644
  """
3579
3645
  return self._CreateTime
@@ -3877,6 +3943,169 @@ class ConsoleSharingConfig(AbstractModel):
3877
3943
 
3878
3944
 
3879
3945
 
3946
+ class ConsoleSharingInfo(AbstractModel):
3947
+ """控制台分享信息
3948
+
3949
+ """
3950
+
3951
+ def __init__(self):
3952
+ r"""
3953
+ :param _SharingId: 分享ID
3954
+ :type SharingId: str
3955
+ :param _SharingUrl: 分享链接
3956
+ 注意:此字段可能返回 null,表示取不到有效值。
3957
+ :type SharingUrl: str
3958
+ :param _SharingConfig: 匿名分享配置信息
3959
+ 注意:此字段可能返回 null,表示取不到有效值。
3960
+ :type SharingConfig: :class:`tencentcloud.cls.v20201016.models.ConsoleSharingConfig`
3961
+ :param _ExpiredTime: 过期时间
3962
+ 注意:此字段可能返回 null,表示取不到有效值。
3963
+ :type ExpiredTime: int
3964
+ :param _CreateTime: 创建时间
3965
+ 注意:此字段可能返回 null,表示取不到有效值。
3966
+ :type CreateTime: int
3967
+ :param _UpdateTime: 修改时间
3968
+ 注意:此字段可能返回 null,表示取不到有效值。
3969
+ :type UpdateTime: int
3970
+ :param _Status: 分享链接状态
3971
+ 1: 正常
3972
+ -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
3973
+ 注意:此字段可能返回 null,表示取不到有效值。
3974
+ :type Status: int
3975
+ :param _ContentSafetyCode: 10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,
3976
+ 24005-社会
3977
+ 注意:此字段可能返回 null,表示取不到有效值。
3978
+ :type ContentSafetyCode: int
3979
+ """
3980
+ self._SharingId = None
3981
+ self._SharingUrl = None
3982
+ self._SharingConfig = None
3983
+ self._ExpiredTime = None
3984
+ self._CreateTime = None
3985
+ self._UpdateTime = None
3986
+ self._Status = None
3987
+ self._ContentSafetyCode = None
3988
+
3989
+ @property
3990
+ def SharingId(self):
3991
+ """分享ID
3992
+ :rtype: str
3993
+ """
3994
+ return self._SharingId
3995
+
3996
+ @SharingId.setter
3997
+ def SharingId(self, SharingId):
3998
+ self._SharingId = SharingId
3999
+
4000
+ @property
4001
+ def SharingUrl(self):
4002
+ """分享链接
4003
+ 注意:此字段可能返回 null,表示取不到有效值。
4004
+ :rtype: str
4005
+ """
4006
+ return self._SharingUrl
4007
+
4008
+ @SharingUrl.setter
4009
+ def SharingUrl(self, SharingUrl):
4010
+ self._SharingUrl = SharingUrl
4011
+
4012
+ @property
4013
+ def SharingConfig(self):
4014
+ """匿名分享配置信息
4015
+ 注意:此字段可能返回 null,表示取不到有效值。
4016
+ :rtype: :class:`tencentcloud.cls.v20201016.models.ConsoleSharingConfig`
4017
+ """
4018
+ return self._SharingConfig
4019
+
4020
+ @SharingConfig.setter
4021
+ def SharingConfig(self, SharingConfig):
4022
+ self._SharingConfig = SharingConfig
4023
+
4024
+ @property
4025
+ def ExpiredTime(self):
4026
+ """过期时间
4027
+ 注意:此字段可能返回 null,表示取不到有效值。
4028
+ :rtype: int
4029
+ """
4030
+ return self._ExpiredTime
4031
+
4032
+ @ExpiredTime.setter
4033
+ def ExpiredTime(self, ExpiredTime):
4034
+ self._ExpiredTime = ExpiredTime
4035
+
4036
+ @property
4037
+ def CreateTime(self):
4038
+ """创建时间
4039
+ 注意:此字段可能返回 null,表示取不到有效值。
4040
+ :rtype: int
4041
+ """
4042
+ return self._CreateTime
4043
+
4044
+ @CreateTime.setter
4045
+ def CreateTime(self, CreateTime):
4046
+ self._CreateTime = CreateTime
4047
+
4048
+ @property
4049
+ def UpdateTime(self):
4050
+ """修改时间
4051
+ 注意:此字段可能返回 null,表示取不到有效值。
4052
+ :rtype: int
4053
+ """
4054
+ return self._UpdateTime
4055
+
4056
+ @UpdateTime.setter
4057
+ def UpdateTime(self, UpdateTime):
4058
+ self._UpdateTime = UpdateTime
4059
+
4060
+ @property
4061
+ def Status(self):
4062
+ """分享链接状态
4063
+ 1: 正常
4064
+ -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
4065
+ 注意:此字段可能返回 null,表示取不到有效值。
4066
+ :rtype: int
4067
+ """
4068
+ return self._Status
4069
+
4070
+ @Status.setter
4071
+ def Status(self, Status):
4072
+ self._Status = Status
4073
+
4074
+ @property
4075
+ def ContentSafetyCode(self):
4076
+ """10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,
4077
+ 24005-社会
4078
+ 注意:此字段可能返回 null,表示取不到有效值。
4079
+ :rtype: int
4080
+ """
4081
+ return self._ContentSafetyCode
4082
+
4083
+ @ContentSafetyCode.setter
4084
+ def ContentSafetyCode(self, ContentSafetyCode):
4085
+ self._ContentSafetyCode = ContentSafetyCode
4086
+
4087
+
4088
+ def _deserialize(self, params):
4089
+ self._SharingId = params.get("SharingId")
4090
+ self._SharingUrl = params.get("SharingUrl")
4091
+ if params.get("SharingConfig") is not None:
4092
+ self._SharingConfig = ConsoleSharingConfig()
4093
+ self._SharingConfig._deserialize(params.get("SharingConfig"))
4094
+ self._ExpiredTime = params.get("ExpiredTime")
4095
+ self._CreateTime = params.get("CreateTime")
4096
+ self._UpdateTime = params.get("UpdateTime")
4097
+ self._Status = params.get("Status")
4098
+ self._ContentSafetyCode = params.get("ContentSafetyCode")
4099
+ memeber_set = set(params.keys())
4100
+ for name, value in vars(self).items():
4101
+ property_name = name[1:]
4102
+ if property_name in memeber_set:
4103
+ memeber_set.remove(property_name)
4104
+ if len(memeber_set) > 0:
4105
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
4106
+
4107
+
4108
+
3880
4109
  class ConsoleSharingParam(AbstractModel):
3881
4110
  """控制台分享链接params参数
3882
4111
 
@@ -5716,12 +5945,13 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5716
5945
  def __init__(self):
5717
5946
  r"""
5718
5947
  :param _InstanceId: 实例ID
5948
+ - 通过各个接入云产品官方文档获取
5719
5949
  :type InstanceId: str
5720
5950
  :param _AssumerName: 云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS
5721
5951
  :type AssumerName: str
5722
5952
  :param _LogType: 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
5723
5953
  :type LogType: str
5724
- :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
5954
+ :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
5725
5955
  - CDS所有日志类型:ap-guangzhou
5726
5956
  - CDB-AUDIT: gz
5727
5957
  - TDSQL-C-AUDIT: gz
@@ -5736,16 +5966,19 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5736
5966
  - APIS所有日志类型:gz
5737
5967
  :type CloudProductRegion: str
5738
5968
  :param _ClsRegion: CLS目标地域
5969
+ - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
5739
5970
  :type ClsRegion: str
5740
5971
  :param _LogsetName: 日志集名称,未填LogsetId时必填。若日志集不存在, 将自动创建
5741
5972
  :type LogsetName: str
5742
5973
  :param _TopicName: 日志主题名称,在未填TopicId时必填。 若日志主题不存在,将自动创建
5743
5974
  :type TopicName: str
5744
- :param _Extend: 日志配置拓展信息, 一般用于存储额外的日志投递配置
5975
+ :param _Extend: 日志配置扩展信息, 一般用于存储额外的日志投递配置
5745
5976
  :type Extend: str
5746
5977
  :param _LogsetId: 日志集id
5978
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
5747
5979
  :type LogsetId: str
5748
5980
  :param _TopicId: 日志主题id
5981
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5749
5982
  :type TopicId: str
5750
5983
  """
5751
5984
  self._InstanceId = None
@@ -5762,6 +5995,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5762
5995
  @property
5763
5996
  def InstanceId(self):
5764
5997
  """实例ID
5998
+ - 通过各个接入云产品官方文档获取
5765
5999
  :rtype: str
5766
6000
  """
5767
6001
  return self._InstanceId
@@ -5794,7 +6028,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5794
6028
 
5795
6029
  @property
5796
6030
  def CloudProductRegion(self):
5797
- """云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
6031
+ """云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
5798
6032
  - CDS所有日志类型:ap-guangzhou
5799
6033
  - CDB-AUDIT: gz
5800
6034
  - TDSQL-C-AUDIT: gz
@@ -5818,6 +6052,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5818
6052
  @property
5819
6053
  def ClsRegion(self):
5820
6054
  """CLS目标地域
6055
+ - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
5821
6056
  :rtype: str
5822
6057
  """
5823
6058
  return self._ClsRegion
@@ -5850,7 +6085,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5850
6085
 
5851
6086
  @property
5852
6087
  def Extend(self):
5853
- """日志配置拓展信息, 一般用于存储额外的日志投递配置
6088
+ """日志配置扩展信息, 一般用于存储额外的日志投递配置
5854
6089
  :rtype: str
5855
6090
  """
5856
6091
  return self._Extend
@@ -5862,6 +6097,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5862
6097
  @property
5863
6098
  def LogsetId(self):
5864
6099
  """日志集id
6100
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
5865
6101
  :rtype: str
5866
6102
  """
5867
6103
  return self._LogsetId
@@ -5873,6 +6109,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5873
6109
  @property
5874
6110
  def TopicId(self):
5875
6111
  """日志主题id
6112
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5876
6113
  :rtype: str
5877
6114
  """
5878
6115
  return self._TopicId
@@ -6421,8 +6658,11 @@ class CreateConfigRequest(AbstractModel):
6421
6658
  def __init__(self):
6422
6659
  r"""
6423
6660
  :param _Name: 采集配置名称
6661
+ - 名称种不得包含特殊字符|
6662
+ - 名称最长255字符,超过截断
6424
6663
  :type Name: str
6425
6664
  :param _Output: 采集配置所属日志主题ID即TopicId
6665
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6426
6666
  :type Output: str
6427
6667
  :param _Path: 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
6428
6668
  :type Path: str
@@ -6465,6 +6705,8 @@ class CreateConfigRequest(AbstractModel):
6465
6705
  @property
6466
6706
  def Name(self):
6467
6707
  """采集配置名称
6708
+ - 名称种不得包含特殊字符|
6709
+ - 名称最长255字符,超过截断
6468
6710
  :rtype: str
6469
6711
  """
6470
6712
  return self._Name
@@ -6476,6 +6718,7 @@ class CreateConfigRequest(AbstractModel):
6476
6718
  @property
6477
6719
  def Output(self):
6478
6720
  """采集配置所属日志主题ID即TopicId
6721
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6479
6722
  :rtype: str
6480
6723
  """
6481
6724
  return self._Output
@@ -6739,7 +6982,9 @@ class CreateConsumerRequest(AbstractModel):
6739
6982
 
6740
6983
  def __init__(self):
6741
6984
  r"""
6742
- :param _TopicId: 投递任务绑定的日志主题 ID
6985
+ :param _TopicId: 投递任务绑定的日志主题Id。
6986
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
6987
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
6743
6988
  :type TopicId: str
6744
6989
  :param _NeedContent: 是否投递日志的元数据信息,默认为 true。
6745
6990
  当NeedContent为true时:字段Content有效。
@@ -6760,7 +7005,9 @@ class CreateConsumerRequest(AbstractModel):
6760
7005
 
6761
7006
  @property
6762
7007
  def TopicId(self):
6763
- """投递任务绑定的日志主题 ID
7008
+ """投递任务绑定的日志主题Id。
7009
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
7010
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
6764
7011
  :rtype: str
6765
7012
  """
6766
7013
  return self._TopicId
@@ -7117,10 +7364,21 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7117
7364
  def __init__(self):
7118
7365
  r"""
7119
7366
  :param _Name: 仪表盘订阅名称。
7367
+ 输入限制:
7368
+ - 不能为空
7369
+ - 长度不能超过128字节
7370
+ - 不能包含字符'|'
7120
7371
  :type Name: str
7121
- :param _DashboardId: 仪表盘id
7372
+ :param _DashboardId: 仪表盘Id
7373
+ - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
7122
7374
  :type DashboardId: str
7123
- :param _Cron: 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。<br><li/>{秒数} 取值范围: 0 ~ 59 <br><li/>{分钟} 取值范围: 0 ~ 59 <br><li/>{小时} 取值范围: 0 ~ 23 <br><li/>{日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L) <br><li/>{月份} 取值范围: 1 ~ 12 <br><li/>{星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
7375
+ :param _Cron: 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。
7376
+ - {秒数} 取值范围: 0 ~ 59
7377
+ - {分钟} 取值范围: 0 ~ 59
7378
+ - {小时} 取值范围: 0 ~ 23
7379
+ - {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L)
7380
+ - {月份} 取值范围: 1 ~ 12
7381
+ - {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
7124
7382
  :type Cron: str
7125
7383
  :param _SubscribeData: 仪表盘订阅数据。
7126
7384
  :type SubscribeData: :class:`tencentcloud.cls.v20201016.models.DashboardSubscribeData`
@@ -7133,6 +7391,10 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7133
7391
  @property
7134
7392
  def Name(self):
7135
7393
  """仪表盘订阅名称。
7394
+ 输入限制:
7395
+ - 不能为空
7396
+ - 长度不能超过128字节
7397
+ - 不能包含字符'|'
7136
7398
  :rtype: str
7137
7399
  """
7138
7400
  return self._Name
@@ -7143,7 +7405,8 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7143
7405
 
7144
7406
  @property
7145
7407
  def DashboardId(self):
7146
- """仪表盘id
7408
+ """仪表盘Id
7409
+ - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
7147
7410
  :rtype: str
7148
7411
  """
7149
7412
  return self._DashboardId
@@ -7154,7 +7417,13 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7154
7417
 
7155
7418
  @property
7156
7419
  def Cron(self):
7157
- """订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。<br><li/>{秒数} 取值范围: 0 ~ 59 <br><li/>{分钟} 取值范围: 0 ~ 59 <br><li/>{小时} 取值范围: 0 ~ 23 <br><li/>{日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L) <br><li/>{月份} 取值范围: 1 ~ 12 <br><li/>{星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
7420
+ """订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。
7421
+ - {秒数} 取值范围: 0 ~ 59
7422
+ - {分钟} 取值范围: 0 ~ 59
7423
+ - {小时} 取值范围: 0 ~ 23
7424
+ - {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L)
7425
+ - {月份} 取值范围: 1 ~ 12
7426
+ - {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
7158
7427
  :rtype: str
7159
7428
  """
7160
7429
  return self._Cron
@@ -7448,17 +7717,22 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7448
7717
 
7449
7718
  def __init__(self):
7450
7719
  r"""
7451
- :param _TopicId: 投递规则属于的 topic id
7720
+ :param _TopicId: 投递规则属于的TopicId。
7721
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
7722
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7452
7723
  :type TopicId: str
7453
7724
  :param _FunctionName: 投递的云函数名字。仅支持[事件函数](https://cloud.tencent.com/document/product/583/9694#scf-.E4.BA.8B.E4.BB.B6.E5.87.BD.E6.95.B0) ([函数类型选型](https://cloud.tencent.com/document/product/583/73483))
7725
+ 通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。
7454
7726
  :type FunctionName: str
7455
- :param _Namespace: 命名空间
7727
+ :param _Namespace: 命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
7728
+ - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
7456
7729
  :type Namespace: str
7457
- :param _Qualifier: 函数版本
7730
+ :param _Qualifier: 函数版本。
7731
+ - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
7458
7732
  :type Qualifier: str
7459
- :param _Timeout: 投递最长等待时间,单位:秒
7733
+ :param _Timeout: 投递最长等待时间,单位:秒。 默认:60
7460
7734
  :type Timeout: int
7461
- :param _MaxMsgNum: 投递最大消息数
7735
+ :param _MaxMsgNum: 投递最大消息数。默认为100。支持范围[1,10000]
7462
7736
  :type MaxMsgNum: int
7463
7737
  """
7464
7738
  self._TopicId = None
@@ -7470,7 +7744,9 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7470
7744
 
7471
7745
  @property
7472
7746
  def TopicId(self):
7473
- """投递规则属于的 topic id
7747
+ """投递规则属于的TopicId。
7748
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
7749
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7474
7750
  :rtype: str
7475
7751
  """
7476
7752
  return self._TopicId
@@ -7482,6 +7758,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7482
7758
  @property
7483
7759
  def FunctionName(self):
7484
7760
  """投递的云函数名字。仅支持[事件函数](https://cloud.tencent.com/document/product/583/9694#scf-.E4.BA.8B.E4.BB.B6.E5.87.BD.E6.95.B0) ([函数类型选型](https://cloud.tencent.com/document/product/583/73483))
7761
+ 通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。
7485
7762
  :rtype: str
7486
7763
  """
7487
7764
  return self._FunctionName
@@ -7492,7 +7769,8 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7492
7769
 
7493
7770
  @property
7494
7771
  def Namespace(self):
7495
- """命名空间
7772
+ """命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
7773
+ - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
7496
7774
  :rtype: str
7497
7775
  """
7498
7776
  return self._Namespace
@@ -7503,7 +7781,8 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7503
7781
 
7504
7782
  @property
7505
7783
  def Qualifier(self):
7506
- """函数版本
7784
+ """函数版本。
7785
+ - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
7507
7786
  :rtype: str
7508
7787
  """
7509
7788
  return self._Qualifier
@@ -7514,7 +7793,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7514
7793
 
7515
7794
  @property
7516
7795
  def Timeout(self):
7517
- """投递最长等待时间,单位:秒
7796
+ """投递最长等待时间,单位:秒。 默认:60
7518
7797
  :rtype: int
7519
7798
  """
7520
7799
  return self._Timeout
@@ -7525,7 +7804,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7525
7804
 
7526
7805
  @property
7527
7806
  def MaxMsgNum(self):
7528
- """投递最大消息数
7807
+ """投递最大消息数。默认为100。支持范围[1,10000]
7529
7808
  :rtype: int
7530
7809
  """
7531
7810
  return self._MaxMsgNum
@@ -7587,7 +7866,8 @@ class CreateExportRequest(AbstractModel):
7587
7866
 
7588
7867
  def __init__(self):
7589
7868
  r"""
7590
- :param _TopicId: 日志主题ID
7869
+ :param _TopicId: 日志主题Id
7870
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7591
7871
  :type TopicId: str
7592
7872
  :param _Count: 日志导出数量, 最大值5000万
7593
7873
  :type Count: int
@@ -7619,7 +7899,8 @@ class CreateExportRequest(AbstractModel):
7619
7899
 
7620
7900
  @property
7621
7901
  def TopicId(self):
7622
- """日志主题ID
7902
+ """日志主题Id
7903
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7623
7904
  :rtype: str
7624
7905
  """
7625
7906
  return self._TopicId
@@ -7926,7 +8207,9 @@ class CreateKafkaRechargeRequest(AbstractModel):
7926
8207
 
7927
8208
  def __init__(self):
7928
8209
  r"""
7929
- :param _TopicId: 导入CLS目标topic ID
8210
+ :param _TopicId: 导入CLS目标TopicId。
8211
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
8212
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7930
8213
  :type TopicId: str
7931
8214
  :param _Name: Kafka导入配置名称
7932
8215
  :type Name: str
@@ -7939,6 +8222,7 @@ class CreateKafkaRechargeRequest(AbstractModel):
7939
8222
  :param _LogRechargeRule: 日志导入规则。
7940
8223
  :type LogRechargeRule: :class:`tencentcloud.cls.v20201016.models.LogRechargeRuleInfo`
7941
8224
  :param _KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填。
8225
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
7942
8226
  :type KafkaInstance: str
7943
8227
  :param _ServerAddr: 服务地址,KafkaType为1时必填。
7944
8228
  :type ServerAddr: str
@@ -7947,7 +8231,8 @@ class CreateKafkaRechargeRequest(AbstractModel):
7947
8231
  :param _Protocol: 加密访问协议。
7948
8232
  KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
7949
8233
  :type Protocol: :class:`tencentcloud.cls.v20201016.models.KafkaProtocolInfo`
7950
- :param _ConsumerGroupName: 用户Kafka消费组名称
8234
+ :param _ConsumerGroupName: 用户Kafka消费组名称。
8235
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
7951
8236
  :type ConsumerGroupName: str
7952
8237
  """
7953
8238
  self._TopicId = None
@@ -7964,7 +8249,9 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
7964
8249
 
7965
8250
  @property
7966
8251
  def TopicId(self):
7967
- """导入CLS目标topic ID
8252
+ """导入CLS目标TopicId。
8253
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
8254
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7968
8255
  :rtype: str
7969
8256
  """
7970
8257
  return self._TopicId
@@ -8031,6 +8318,7 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
8031
8318
  @property
8032
8319
  def KafkaInstance(self):
8033
8320
  """腾讯云CKafka实例ID,KafkaType为0时必填。
8321
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
8034
8322
  :rtype: str
8035
8323
  """
8036
8324
  return self._KafkaInstance
@@ -8075,7 +8363,8 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
8075
8363
 
8076
8364
  @property
8077
8365
  def ConsumerGroupName(self):
8078
- """用户Kafka消费组名称
8366
+ """用户Kafka消费组名称。
8367
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
8079
8368
  :rtype: str
8080
8369
  """
8081
8370
  return self._ConsumerGroupName
@@ -8627,9 +8916,9 @@ class CreateScheduledSqlRequest(AbstractModel):
8627
8916
 
8628
8917
  def __init__(self):
8629
8918
  r"""
8630
- :param _SrcTopicId: 源日志主题
8919
+ :param _SrcTopicId: 源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8631
8920
  :type SrcTopicId: str
8632
- :param _Name: 任务名称
8921
+ :param _Name: 任务名称,0~255字符
8633
8922
  :type Name: str
8634
8923
  :param _EnableFlag: 任务启动状态. 1开启, 2关闭
8635
8924
  :type EnableFlag: int
@@ -8641,13 +8930,13 @@ class CreateScheduledSqlRequest(AbstractModel):
8641
8930
  :type ProcessStartTime: int
8642
8931
  :param _ProcessType: 调度类型,1:持续运行 2:指定时间范围
8643
8932
  :type ProcessType: int
8644
- :param _ProcessPeriod: 调度周期(分钟)
8933
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
8645
8934
  :type ProcessPeriod: int
8646
8935
  :param _ProcessTimeWindow: 单次查询的时间窗口,如果您的目标主题为指标主题,建议该参数的大小不超过30分钟,否则可能转指标失败。
8647
8936
  :type ProcessTimeWindow: str
8648
- :param _ProcessDelay: 执行延迟(秒)
8937
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
8649
8938
  :type ProcessDelay: int
8650
- :param _SrcTopicRegion: 源topicId的地域信息
8939
+ :param _SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
8651
8940
  :type SrcTopicRegion: str
8652
8941
  :param _ProcessEndTime: 调度结束时间,当ProcessType=2时为必传字段, Unix时间戳,单位ms
8653
8942
  :type ProcessEndTime: int
@@ -8670,7 +8959,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8670
8959
 
8671
8960
  @property
8672
8961
  def SrcTopicId(self):
8673
- """源日志主题
8962
+ """源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8674
8963
  :rtype: str
8675
8964
  """
8676
8965
  return self._SrcTopicId
@@ -8681,7 +8970,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8681
8970
 
8682
8971
  @property
8683
8972
  def Name(self):
8684
- """任务名称
8973
+ """任务名称,0~255字符
8685
8974
  :rtype: str
8686
8975
  """
8687
8976
  return self._Name
@@ -8747,7 +9036,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8747
9036
 
8748
9037
  @property
8749
9038
  def ProcessPeriod(self):
8750
- """调度周期(分钟)
9039
+ """调度周期(分钟),1~1440分钟
8751
9040
  :rtype: int
8752
9041
  """
8753
9042
  return self._ProcessPeriod
@@ -8769,7 +9058,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8769
9058
 
8770
9059
  @property
8771
9060
  def ProcessDelay(self):
8772
- """执行延迟(秒)
9061
+ """执行延迟(秒),0~120秒,默认60秒
8773
9062
  :rtype: int
8774
9063
  """
8775
9064
  return self._ProcessDelay
@@ -8780,7 +9069,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8780
9069
 
8781
9070
  @property
8782
9071
  def SrcTopicRegion(self):
8783
- """源topicId的地域信息
9072
+ """源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
8784
9073
  :rtype: str
8785
9074
  """
8786
9075
  return self._SrcTopicRegion
@@ -9206,8 +9495,14 @@ class CreateTopicRequest(AbstractModel):
9206
9495
  def __init__(self):
9207
9496
  r"""
9208
9497
  :param _LogsetId: 日志集ID
9498
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
9209
9499
  :type LogsetId: str
9210
9500
  :param _TopicName: 日志主题名称
9501
+ 名称限制
9502
+ - 不能为空字符串
9503
+ - 不能包含字符'|'
9504
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
9505
+
9211
9506
  :type TopicName: str
9212
9507
  :param _PartitionCount: 日志主题分区个数。默认创建1个,最大支持创建10个分区。
9213
9508
  :type PartitionCount: int
@@ -9256,6 +9551,7 @@ class CreateTopicRequest(AbstractModel):
9256
9551
  @property
9257
9552
  def LogsetId(self):
9258
9553
  """日志集ID
9554
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
9259
9555
  :rtype: str
9260
9556
  """
9261
9557
  return self._LogsetId
@@ -9267,6 +9563,11 @@ class CreateTopicRequest(AbstractModel):
9267
9563
  @property
9268
9564
  def TopicName(self):
9269
9565
  """日志主题名称
9566
+ 名称限制
9567
+ - 不能为空字符串
9568
+ - 不能包含字符'|'
9569
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
9570
+
9270
9571
  :rtype: str
9271
9572
  """
9272
9573
  return self._TopicName
@@ -9930,7 +10231,9 @@ class DashboardNoticeMode(AbstractModel):
9930
10231
  <li/>Uin:腾讯云用户<br>
9931
10232
  <li/>Group:腾讯云用户组<br>
9932
10233
  <li/>Email:自定义Email<br>
9933
- <li/>WeCom: 企业微信回调
10234
+ <li/>WeCom: 企业微信回调<br>
10235
+ <li/>DingTalk:钉钉<br>
10236
+ <li/>Lark:飞书
9934
10237
  :type ReceiverType: str
9935
10238
  :param _Values: 知方式对应的值。
9936
10239
  <br> <li/> 当ReceiverType不是 WeCom 时,Values必填。
@@ -9956,7 +10259,9 @@ class DashboardNoticeMode(AbstractModel):
9956
10259
  <li/>Uin:腾讯云用户<br>
9957
10260
  <li/>Group:腾讯云用户组<br>
9958
10261
  <li/>Email:自定义Email<br>
9959
- <li/>WeCom: 企业微信回调
10262
+ <li/>WeCom: 企业微信回调<br>
10263
+ <li/>DingTalk:钉钉<br>
10264
+ <li/>Lark:飞书
9960
10265
  :rtype: str
9961
10266
  """
9962
10267
  return self._ReceiverType
@@ -10758,9 +11063,9 @@ class DeleteAlarmShieldRequest(AbstractModel):
10758
11063
 
10759
11064
  def __init__(self):
10760
11065
  r"""
10761
- :param _TaskId: 屏蔽规则id
11066
+ :param _TaskId: 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
10762
11067
  :type TaskId: str
10763
- :param _AlarmNoticeId: 通知渠道组id
11068
+ :param _AlarmNoticeId: 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
10764
11069
  :type AlarmNoticeId: str
10765
11070
  """
10766
11071
  self._TaskId = None
@@ -10768,7 +11073,7 @@ class DeleteAlarmShieldRequest(AbstractModel):
10768
11073
 
10769
11074
  @property
10770
11075
  def TaskId(self):
10771
- """屏蔽规则id
11076
+ """屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
10772
11077
  :rtype: str
10773
11078
  """
10774
11079
  return self._TaskId
@@ -10779,7 +11084,7 @@ class DeleteAlarmShieldRequest(AbstractModel):
10779
11084
 
10780
11085
  @property
10781
11086
  def AlarmNoticeId(self):
10782
- """通知渠道组id
11087
+ """通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
10783
11088
  :rtype: str
10784
11089
  """
10785
11090
  return self._AlarmNoticeId
@@ -10843,7 +11148,7 @@ class DeleteCloudProductLogCollectionRequest(AbstractModel):
10843
11148
  :type AssumerName: str
10844
11149
  :param _LogType: 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
10845
11150
  :type LogType: str
10846
- :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
11151
+ :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
10847
11152
  - CDS所有日志类型:ap-guangzhou
10848
11153
  - CDB-AUDIT: gz
10849
11154
  - TDSQL-C-AUDIT: gz
@@ -10898,7 +11203,7 @@ class DeleteCloudProductLogCollectionRequest(AbstractModel):
10898
11203
 
10899
11204
  @property
10900
11205
  def CloudProductRegion(self):
10901
- """云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
11206
+ """云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
10902
11207
  - CDS所有日志类型:ap-guangzhou
10903
11208
  - CDB-AUDIT: gz
10904
11209
  - TDSQL-C-AUDIT: gz
@@ -10986,6 +11291,7 @@ class DeleteConfigExtraRequest(AbstractModel):
10986
11291
  def __init__(self):
10987
11292
  r"""
10988
11293
  :param _ConfigExtraId: 特殊采集规则扩展配置ID
11294
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
10989
11295
  :type ConfigExtraId: str
10990
11296
  """
10991
11297
  self._ConfigExtraId = None
@@ -10993,6 +11299,7 @@ class DeleteConfigExtraRequest(AbstractModel):
10993
11299
  @property
10994
11300
  def ConfigExtraId(self):
10995
11301
  """特殊采集规则扩展配置ID
11302
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
10996
11303
  :rtype: str
10997
11304
  """
10998
11305
  return self._ConfigExtraId
@@ -11050,8 +11357,10 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11050
11357
  def __init__(self):
11051
11358
  r"""
11052
11359
  :param _GroupId: 机器组ID
11360
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
11053
11361
  :type GroupId: str
11054
11362
  :param _ConfigId: 采集配置ID
11363
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11055
11364
  :type ConfigId: str
11056
11365
  """
11057
11366
  self._GroupId = None
@@ -11060,6 +11369,7 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11060
11369
  @property
11061
11370
  def GroupId(self):
11062
11371
  """机器组ID
11372
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
11063
11373
  :rtype: str
11064
11374
  """
11065
11375
  return self._GroupId
@@ -11071,6 +11381,7 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11071
11381
  @property
11072
11382
  def ConfigId(self):
11073
11383
  """采集配置ID
11384
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11074
11385
  :rtype: str
11075
11386
  """
11076
11387
  return self._ConfigId
@@ -11128,14 +11439,16 @@ class DeleteConfigRequest(AbstractModel):
11128
11439
 
11129
11440
  def __init__(self):
11130
11441
  r"""
11131
- :param _ConfigId: 采集规则配置ID
11442
+ :param _ConfigId: 采集配置ID
11443
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11132
11444
  :type ConfigId: str
11133
11445
  """
11134
11446
  self._ConfigId = None
11135
11447
 
11136
11448
  @property
11137
11449
  def ConfigId(self):
11138
- """采集规则配置ID
11450
+ """采集配置ID
11451
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11139
11452
  :rtype: str
11140
11453
  """
11141
11454
  return self._ConfigId
@@ -11192,14 +11505,18 @@ class DeleteConsoleSharingRequest(AbstractModel):
11192
11505
 
11193
11506
  def __init__(self):
11194
11507
  r"""
11195
- :param _SharingId: 免密分享Id
11508
+ :param _SharingId: 免密分享Id
11509
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
11510
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
11196
11511
  :type SharingId: str
11197
11512
  """
11198
11513
  self._SharingId = None
11199
11514
 
11200
11515
  @property
11201
11516
  def SharingId(self):
11202
- """免密分享Id
11517
+ """免密分享Id
11518
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
11519
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
11203
11520
  :rtype: str
11204
11521
  """
11205
11522
  return self._SharingId
@@ -11256,14 +11573,18 @@ class DeleteConsumerRequest(AbstractModel):
11256
11573
 
11257
11574
  def __init__(self):
11258
11575
  r"""
11259
- :param _TopicId: 投递任务绑定的日志主题 ID
11576
+ :param _TopicId: 投递任务绑定的日志主题Id。
11577
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
11578
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
11260
11579
  :type TopicId: str
11261
11580
  """
11262
11581
  self._TopicId = None
11263
11582
 
11264
11583
  @property
11265
11584
  def TopicId(self):
11266
- """投递任务绑定的日志主题 ID
11585
+ """投递任务绑定的日志主题Id。
11586
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
11587
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
11267
11588
  :rtype: str
11268
11589
  """
11269
11590
  return self._TopicId
@@ -11467,14 +11788,14 @@ class DeleteDataTransformRequest(AbstractModel):
11467
11788
 
11468
11789
  def __init__(self):
11469
11790
  r"""
11470
- :param _TaskId: 数据加工任务id
11791
+ :param _TaskId: 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
11471
11792
  :type TaskId: str
11472
11793
  """
11473
11794
  self._TaskId = None
11474
11795
 
11475
11796
  @property
11476
11797
  def TaskId(self):
11477
- """数据加工任务id
11798
+ """数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
11478
11799
  :rtype: str
11479
11800
  """
11480
11801
  return self._TaskId
@@ -11531,14 +11852,18 @@ class DeleteExportRequest(AbstractModel):
11531
11852
 
11532
11853
  def __init__(self):
11533
11854
  r"""
11534
- :param _ExportId: 日志导出ID
11855
+ :param _ExportId: 日志导出任务Id
11856
+ - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
11857
+
11535
11858
  :type ExportId: str
11536
11859
  """
11537
11860
  self._ExportId = None
11538
11861
 
11539
11862
  @property
11540
11863
  def ExportId(self):
11541
- """日志导出ID
11864
+ """日志导出任务Id
11865
+ - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
11866
+
11542
11867
  :rtype: str
11543
11868
  """
11544
11869
  return self._ExportId
@@ -11812,7 +12137,8 @@ class DeleteMachineGroupInfoRequest(AbstractModel):
11812
12137
 
11813
12138
  def __init__(self):
11814
12139
  r"""
11815
- :param _GroupId: 机器组ID
12140
+ :param _GroupId: 机器组Id
12141
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11816
12142
  :type GroupId: str
11817
12143
  :param _MachineGroupType: 机器组类型
11818
12144
  目前type支持 ip 和 label
@@ -11823,7 +12149,8 @@ class DeleteMachineGroupInfoRequest(AbstractModel):
11823
12149
 
11824
12150
  @property
11825
12151
  def GroupId(self):
11826
- """机器组ID
12152
+ """机器组Id
12153
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11827
12154
  :rtype: str
11828
12155
  """
11829
12156
  return self._GroupId
@@ -11895,14 +12222,16 @@ class DeleteMachineGroupRequest(AbstractModel):
11895
12222
 
11896
12223
  def __init__(self):
11897
12224
  r"""
11898
- :param _GroupId: 机器组ID
12225
+ :param _GroupId: 机器组Id
12226
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11899
12227
  :type GroupId: str
11900
12228
  """
11901
12229
  self._GroupId = None
11902
12230
 
11903
12231
  @property
11904
12232
  def GroupId(self):
11905
- """机器组ID
12233
+ """机器组Id
12234
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11906
12235
  :rtype: str
11907
12236
  """
11908
12237
  return self._GroupId
@@ -12023,9 +12352,9 @@ class DeleteScheduledSqlRequest(AbstractModel):
12023
12352
 
12024
12353
  def __init__(self):
12025
12354
  r"""
12026
- :param _TaskId: 任务ID
12355
+ :param _TaskId: 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12027
12356
  :type TaskId: str
12028
- :param _SrcTopicId: 源日志主题ID
12357
+ :param _SrcTopicId: 源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12029
12358
  :type SrcTopicId: str
12030
12359
  """
12031
12360
  self._TaskId = None
@@ -12033,7 +12362,7 @@ class DeleteScheduledSqlRequest(AbstractModel):
12033
12362
 
12034
12363
  @property
12035
12364
  def TaskId(self):
12036
- """任务ID
12365
+ """任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12037
12366
  :rtype: str
12038
12367
  """
12039
12368
  return self._TaskId
@@ -12044,7 +12373,7 @@ class DeleteScheduledSqlRequest(AbstractModel):
12044
12373
 
12045
12374
  @property
12046
12375
  def SrcTopicId(self):
12047
- """源日志主题ID
12376
+ """源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12048
12377
  :rtype: str
12049
12378
  """
12050
12379
  return self._SrcTopicId
@@ -12169,6 +12498,7 @@ class DeleteTopicRequest(AbstractModel):
12169
12498
  def __init__(self):
12170
12499
  r"""
12171
12500
  :param _TopicId: 日志主题ID
12501
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
12172
12502
  :type TopicId: str
12173
12503
  """
12174
12504
  self._TopicId = None
@@ -12176,6 +12506,7 @@ class DeleteTopicRequest(AbstractModel):
12176
12506
  @property
12177
12507
  def TopicId(self):
12178
12508
  """日志主题ID
12509
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
12179
12510
  :rtype: str
12180
12511
  """
12181
12512
  return self._TopicId
@@ -13233,18 +13564,22 @@ class DescribeConfigExtrasRequest(AbstractModel):
13233
13564
  name
13234
13565
  - 按照【特殊采集配置名称】进行模糊匹配过滤。
13235
13566
  - 类型:String
13567
+ - 示例:test-config
13236
13568
 
13237
13569
  configExtraId
13238
13570
  - 按照【特殊采集配置ID】进行过滤。
13239
13571
  - 类型:String
13572
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13240
13573
 
13241
13574
  topicId
13242
13575
  - 按照【日志主题】进行过滤。
13243
13576
  - 类型:String
13577
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13244
13578
 
13245
13579
  machineGroupId
13246
13580
  - 按照【机器组ID】进行过滤。
13247
13581
  - 类型:String
13582
+ - 示例:f948972f-a063-408c-a59f-8c3230bddaf6
13248
13583
 
13249
13584
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13250
13585
  :type Filters: list of Filter
@@ -13263,18 +13598,22 @@ machineGroupId
13263
13598
  name
13264
13599
  - 按照【特殊采集配置名称】进行模糊匹配过滤。
13265
13600
  - 类型:String
13601
+ - 示例:test-config
13266
13602
 
13267
13603
  configExtraId
13268
13604
  - 按照【特殊采集配置ID】进行过滤。
13269
13605
  - 类型:String
13606
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13270
13607
 
13271
13608
  topicId
13272
13609
  - 按照【日志主题】进行过滤。
13273
13610
  - 类型:String
13611
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13274
13612
 
13275
13613
  machineGroupId
13276
13614
  - 按照【机器组ID】进行过滤。
13277
13615
  - 类型:String
13616
+ - 示例:f948972f-a063-408c-a59f-8c3230bddaf6
13278
13617
 
13279
13618
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13280
13619
  :rtype: list of Filter
@@ -13400,6 +13739,7 @@ class DescribeConfigMachineGroupsRequest(AbstractModel):
13400
13739
  def __init__(self):
13401
13740
  r"""
13402
13741
  :param _ConfigId: 采集配置ID
13742
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
13403
13743
  :type ConfigId: str
13404
13744
  """
13405
13745
  self._ConfigId = None
@@ -13407,6 +13747,7 @@ class DescribeConfigMachineGroupsRequest(AbstractModel):
13407
13747
  @property
13408
13748
  def ConfigId(self):
13409
13749
  """采集配置ID
13750
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
13410
13751
  :rtype: str
13411
13752
  """
13412
13753
  return self._ConfigId
@@ -13489,16 +13830,20 @@ class DescribeConfigsRequest(AbstractModel):
13489
13830
  - 按照【采集配置名称】进行模糊匹配过滤。
13490
13831
  - 类型:String
13491
13832
  - 必选:否
13833
+ - 示例:test-config
13492
13834
 
13493
13835
  configId
13494
13836
  - 按照【采集配置ID】进行过滤。
13495
13837
  - 类型:String
13496
13838
  - 必选:否
13839
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13497
13840
 
13498
13841
  topicId
13499
13842
  - 按照【日志主题】进行过滤。
13500
13843
  - 类型:String
13501
13844
  - 必选:否
13845
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13846
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
13502
13847
 
13503
13848
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13504
13849
  :type Filters: list of Filter
@@ -13517,16 +13862,20 @@ topicId
13517
13862
  - 按照【采集配置名称】进行模糊匹配过滤。
13518
13863
  - 类型:String
13519
13864
  - 必选:否
13865
+ - 示例:test-config
13520
13866
 
13521
13867
  configId
13522
13868
  - 按照【采集配置ID】进行过滤。
13523
13869
  - 类型:String
13524
13870
  - 必选:否
13871
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13525
13872
 
13526
13873
  topicId
13527
13874
  - 按照【日志主题】进行过滤。
13528
13875
  - 类型:String
13529
13876
  - 必选:否
13877
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13878
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
13530
13879
 
13531
13880
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13532
13881
  :rtype: list of Filter
@@ -13659,10 +14008,13 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13659
14008
  r"""
13660
14009
  :param _TotalCount: 分页的总数目
13661
14010
  :type TotalCount: int
14011
+ :param _ConsoleSharingInfos: 控制台免密分享列表
14012
+ :type ConsoleSharingInfos: list of ConsoleSharingInfo
13662
14013
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13663
14014
  :type RequestId: str
13664
14015
  """
13665
14016
  self._TotalCount = None
14017
+ self._ConsoleSharingInfos = None
13666
14018
  self._RequestId = None
13667
14019
 
13668
14020
  @property
@@ -13676,6 +14028,17 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13676
14028
  def TotalCount(self, TotalCount):
13677
14029
  self._TotalCount = TotalCount
13678
14030
 
14031
+ @property
14032
+ def ConsoleSharingInfos(self):
14033
+ """控制台免密分享列表
14034
+ :rtype: list of ConsoleSharingInfo
14035
+ """
14036
+ return self._ConsoleSharingInfos
14037
+
14038
+ @ConsoleSharingInfos.setter
14039
+ def ConsoleSharingInfos(self, ConsoleSharingInfos):
14040
+ self._ConsoleSharingInfos = ConsoleSharingInfos
14041
+
13679
14042
  @property
13680
14043
  def RequestId(self):
13681
14044
  """唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -13690,6 +14053,12 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13690
14053
 
13691
14054
  def _deserialize(self, params):
13692
14055
  self._TotalCount = params.get("TotalCount")
14056
+ if params.get("ConsoleSharingInfos") is not None:
14057
+ self._ConsoleSharingInfos = []
14058
+ for item in params.get("ConsoleSharingInfos"):
14059
+ obj = ConsoleSharingInfo()
14060
+ obj._deserialize(item)
14061
+ self._ConsoleSharingInfos.append(obj)
13693
14062
  self._RequestId = params.get("RequestId")
13694
14063
 
13695
14064
 
@@ -13700,14 +14069,18 @@ class DescribeConsumerRequest(AbstractModel):
13700
14069
 
13701
14070
  def __init__(self):
13702
14071
  r"""
13703
- :param _TopicId: 投递任务绑定的日志主题 ID
14072
+ :param _TopicId: 投递任务绑定的日志主题Id。
14073
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
14074
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
13704
14075
  :type TopicId: str
13705
14076
  """
13706
14077
  self._TopicId = None
13707
14078
 
13708
14079
  @property
13709
14080
  def TopicId(self):
13710
- """投递任务绑定的日志主题 ID
14081
+ """投递任务绑定的日志主题Id。
14082
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
14083
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
13711
14084
  :rtype: str
13712
14085
  """
13713
14086
  return self._TopicId
@@ -14506,7 +14879,8 @@ class DescribeExportsRequest(AbstractModel):
14506
14879
 
14507
14880
  def __init__(self):
14508
14881
  r"""
14509
- :param _TopicId: 日志主题ID
14882
+ :param _TopicId: 日志主题Id
14883
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14510
14884
  :type TopicId: str
14511
14885
  :param _Offset: 分页的偏移量,默认值为0
14512
14886
  :type Offset: int
@@ -14519,7 +14893,8 @@ class DescribeExportsRequest(AbstractModel):
14519
14893
 
14520
14894
  @property
14521
14895
  def TopicId(self):
14522
- """日志主题ID
14896
+ """日志主题Id
14897
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14523
14898
  :rtype: str
14524
14899
  """
14525
14900
  return self._TopicId
@@ -14807,14 +15182,18 @@ class DescribeKafkaConsumerRequest(AbstractModel):
14807
15182
 
14808
15183
  def __init__(self):
14809
15184
  r"""
14810
- :param _FromTopicId: 日志主题ID
15185
+ :param _FromTopicId: 日志主题Id。
15186
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
15187
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
14811
15188
  :type FromTopicId: str
14812
15189
  """
14813
15190
  self._FromTopicId = None
14814
15191
 
14815
15192
  @property
14816
15193
  def FromTopicId(self):
14817
- """日志主题ID
15194
+ """日志主题Id。
15195
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
15196
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
14818
15197
  :rtype: str
14819
15198
  """
14820
15199
  return self._FromTopicId
@@ -14933,11 +15312,14 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14933
15312
 
14934
15313
  def __init__(self):
14935
15314
  r"""
14936
- :param _TopicId: 日志主题 ID
15315
+ :param _TopicId: 日志主题Id。
15316
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14937
15317
  :type TopicId: str
14938
- :param _Id: 导入配置ID
15318
+ :param _Id: 导入配置Id。
15319
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
15320
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
14939
15321
  :type Id: str
14940
- :param _Status: 状态 status 1: 运行中, 2: 暂停...
15322
+ :param _Status: 状态。1: 运行中,2: 暂停,3:错误
14941
15323
  :type Status: int
14942
15324
  """
14943
15325
  self._TopicId = None
@@ -14946,7 +15328,8 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14946
15328
 
14947
15329
  @property
14948
15330
  def TopicId(self):
14949
- """日志主题 ID
15331
+ """日志主题Id。
15332
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14950
15333
  :rtype: str
14951
15334
  """
14952
15335
  return self._TopicId
@@ -14957,7 +15340,9 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14957
15340
 
14958
15341
  @property
14959
15342
  def Id(self):
14960
- """导入配置ID
15343
+ """导入配置Id。
15344
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
15345
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
14961
15346
  :rtype: str
14962
15347
  """
14963
15348
  return self._Id
@@ -14968,7 +15353,7 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14968
15353
 
14969
15354
  @property
14970
15355
  def Status(self):
14971
- """状态 status 1: 运行中, 2: 暂停...
15356
+ """状态。1: 运行中,2: 暂停,3:错误
14972
15357
  :rtype: int
14973
15358
  """
14974
15359
  return self._Status
@@ -15318,9 +15703,12 @@ class DescribeLogHistogramRequest(AbstractModel):
15318
15703
  :type From: int
15319
15704
  :param _To: 要查询的日志的结束时间,Unix时间戳,单位ms
15320
15705
  :type To: int
15321
- :param _Query: 查询语句
15706
+ :param _Query: 检索分析语句。
15707
+ 语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。
15708
+ 使用*或空字符串可查询所有日志。
15322
15709
  :type Query: str
15323
15710
  :param _TopicId: 要查询的日志主题ID
15711
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
15324
15712
  :type TopicId: str
15325
15713
  :param _Interval: 时间间隔: 单位ms 限制性条件:(To-From) / interval <= 200
15326
15714
  :type Interval: int
@@ -15360,7 +15748,9 @@ class DescribeLogHistogramRequest(AbstractModel):
15360
15748
 
15361
15749
  @property
15362
15750
  def Query(self):
15363
- """查询语句
15751
+ """检索分析语句。
15752
+ 语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。
15753
+ 使用*或空字符串可查询所有日志。
15364
15754
  :rtype: str
15365
15755
  """
15366
15756
  return self._Query
@@ -15372,6 +15762,7 @@ class DescribeLogHistogramRequest(AbstractModel):
15372
15762
  @property
15373
15763
  def TopicId(self):
15374
15764
  """要查询的日志主题ID
15765
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
15375
15766
  :rtype: str
15376
15767
  """
15377
15768
  return self._TopicId
@@ -15684,6 +16075,7 @@ class DescribeMachineGroupConfigsRequest(AbstractModel):
15684
16075
  def __init__(self):
15685
16076
  r"""
15686
16077
  :param _GroupId: 机器组ID
16078
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
15687
16079
  :type GroupId: str
15688
16080
  """
15689
16081
  self._GroupId = None
@@ -15691,6 +16083,7 @@ class DescribeMachineGroupConfigsRequest(AbstractModel):
15691
16083
  @property
15692
16084
  def GroupId(self):
15693
16085
  """机器组ID
16086
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
15694
16087
  :rtype: str
15695
16088
  """
15696
16089
  return self._GroupId
@@ -15769,7 +16162,8 @@ class DescribeMachineGroupsRequest(AbstractModel):
15769
16162
 
15770
16163
  def __init__(self):
15771
16164
  r"""
15772
- :param _Filters: machineGroupName
16165
+ :param _Filters: 过滤条件
16166
+ machineGroupName
15773
16167
  - 按照【机器组名称】进行过滤。
15774
16168
  - 类型:String
15775
16169
  - 必选:否
@@ -15780,7 +16174,7 @@ machineGroupId
15780
16174
  - 必选:否
15781
16175
 
15782
16176
  osType
15783
- - 按照【操作系统类型】进行过滤。
16177
+ - 按照【操作系统类型】进行过滤。0: Linux;1: Windows
15784
16178
  - 类型:Int
15785
16179
  - 必选:否
15786
16180
 
@@ -15807,7 +16201,8 @@ tag:tagKey
15807
16201
 
15808
16202
  @property
15809
16203
  def Filters(self):
15810
- """machineGroupName
16204
+ """过滤条件
16205
+ machineGroupName
15811
16206
  - 按照【机器组名称】进行过滤。
15812
16207
  - 类型:String
15813
16208
  - 必选:否
@@ -15818,7 +16213,7 @@ machineGroupId
15818
16213
  - 必选:否
15819
16214
 
15820
16215
  osType
15821
- - 按照【操作系统类型】进行过滤。
16216
+ - 按照【操作系统类型】进行过滤。0: Linux;1: Windows
15822
16217
  - 类型:Int
15823
16218
  - 必选:否
15824
16219
 
@@ -16389,14 +16784,16 @@ class DescribePartitionsRequest(AbstractModel):
16389
16784
 
16390
16785
  def __init__(self):
16391
16786
  r"""
16392
- :param _TopicId: 日志主题ID
16787
+ :param _TopicId: 日志主题Id
16788
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
16393
16789
  :type TopicId: str
16394
16790
  """
16395
16791
  self._TopicId = None
16396
16792
 
16397
16793
  @property
16398
16794
  def TopicId(self):
16399
- """日志主题ID
16795
+ """日志主题Id
16796
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
16400
16797
  :rtype: str
16401
16798
  """
16402
16799
  return self._TopicId
@@ -16481,15 +16878,14 @@ class DescribeScheduledSqlInfoRequest(AbstractModel):
16481
16878
  :type Name: str
16482
16879
  :param _TaskId: 任务id。
16483
16880
  :type TaskId: str
16484
- :param _Filters: <li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16485
- <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16486
- <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>
16487
- <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>
16488
- <li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>
16489
- <li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>
16490
- <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16491
- <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>
16492
-
16881
+ :param _Filters: - srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题1 ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
16882
+ - dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题 2,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
16883
+ - srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否。示例:a4478687-2382-4486-9692-de7986350f6b ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
16884
+ - dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否。示例:bd4d3375-d72a-4cd2-988d-d8eda2bd62b0,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
16885
+ - bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否
16886
+ - status按照【任务状态】进行过滤,1:运行;2:停止;3:异常。类型:String。必选:否
16887
+ - taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否。示例:metricTask ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。
16888
+ - taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否。示例:9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。
16493
16889
  :type Filters: list of Filter
16494
16890
  """
16495
16891
  self._Offset = None
@@ -16544,15 +16940,14 @@ class DescribeScheduledSqlInfoRequest(AbstractModel):
16544
16940
 
16545
16941
  @property
16546
16942
  def Filters(self):
16547
- """<li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16548
- <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16549
- <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>
16550
- <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>
16551
- <li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>
16552
- <li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>
16553
- <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16554
- <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>
16555
-
16943
+ """- srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题1 ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
16944
+ - dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题 2,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
16945
+ - srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否。示例:a4478687-2382-4486-9692-de7986350f6b ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
16946
+ - dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否。示例:bd4d3375-d72a-4cd2-988d-d8eda2bd62b0,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
16947
+ - bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否
16948
+ - status按照【任务状态】进行过滤,1:运行;2:停止;3:异常。类型:String。必选:否
16949
+ - taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否。示例:metricTask ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。
16950
+ - taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否。示例:9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。
16556
16951
  :rtype: list of Filter
16557
16952
  """
16558
16953
  return self._Filters
@@ -16955,7 +17350,7 @@ class DescribeTopicsRequest(AbstractModel):
16955
17350
  :param _Filters: <ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16956
17351
  <li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16957
17352
  <li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>
16958
- <li>logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用 CreateLogset 创建新的日志集。类型:String。必选:否</li>
17353
+ <li>logsetId 按照【日志集ID】进行过滤,可通过调用 <a href="https://cloud.tencent.com/document/product/614/58624">DescribeLogsets</a> 查询已创建的日志集列表或登录控制台进行查看;也可以调用<a href="https://cloud.tencent.com/document/product/614/58626">CreateLogset</a> 创建新的日志集。类型:String。必选:否</li>
16959
17354
  <li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>
16960
17355
  <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>
16961
17356
  <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>
@@ -16987,7 +17382,7 @@ class DescribeTopicsRequest(AbstractModel):
16987
17382
  """<ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16988
17383
  <li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16989
17384
  <li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>
16990
- <li>logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用 CreateLogset 创建新的日志集。类型:String。必选:否</li>
17385
+ <li>logsetId 按照【日志集ID】进行过滤,可通过调用 <a href="https://cloud.tencent.com/document/product/614/58624">DescribeLogsets</a> 查询已创建的日志集列表或登录控制台进行查看;也可以调用<a href="https://cloud.tencent.com/document/product/614/58626">CreateLogset</a> 创建新的日志集。类型:String。必选:否</li>
16991
17386
  <li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>
16992
17387
  <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>
16993
17388
  <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>
@@ -17479,9 +17874,12 @@ class EventLog(AbstractModel):
17479
17874
  - ALL 所有日志
17480
17875
 
17481
17876
  :type EventChannel: str
17482
- :param _TimeType: 时间类型,1:用户自定义,2:当前时间
17877
+ :param _TimeType: 时间字段(Timestamp)支持的类型
17878
+ - 1(用户自定义时间)
17879
+ - 2(当前时间)
17483
17880
  :type TimeType: int
17484
17881
  :param _Timestamp: 时间,用户选择自定义时间类型时,需要指定时间,单位秒
17882
+ 格式:时间戳,1754897446
17485
17883
  :type Timestamp: int
17486
17884
  :param _EventIDs: 事件ID过滤列表
17487
17885
 
@@ -17514,7 +17912,9 @@ class EventLog(AbstractModel):
17514
17912
 
17515
17913
  @property
17516
17914
  def TimeType(self):
17517
- """时间类型,1:用户自定义,2:当前时间
17915
+ """时间字段(Timestamp)支持的类型
17916
+ - 1(用户自定义时间)
17917
+ - 2(当前时间)
17518
17918
  :rtype: int
17519
17919
  """
17520
17920
  return self._TimeType
@@ -17526,6 +17926,7 @@ class EventLog(AbstractModel):
17526
17926
  @property
17527
17927
  def Timestamp(self):
17528
17928
  """时间,用户选择自定义时间类型时,需要指定时间,单位秒
17929
+ 格式:时间戳,1754897446
17529
17930
  :rtype: int
17530
17931
  """
17531
17932
  return self._Timestamp
@@ -17641,13 +18042,14 @@ class ExportInfo(AbstractModel):
17641
18042
  :type Count: int
17642
18043
  :param _Status: 日志下载状态。Processing:导出正在进行中,Completed:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期), Queuing 排队中
17643
18044
  :type Status: str
17644
- :param _From: 日志导出起始时间
18045
+ :param _From: 日志导出起始时间,毫秒时间戳
17645
18046
  :type From: int
17646
- :param _To: 日志导出结束时间
18047
+ :param _To: 日志导出结束时间,毫秒时间戳
17647
18048
  :type To: int
17648
18049
  :param _CosPath: 日志导出路径,有效期一个小时,请尽快使用该路径下载。
17649
18050
  :type CosPath: str
17650
18051
  :param _CreateTime: 日志导出创建时间
18052
+ 时间格式:yyyy-MM-dd HH:mm:ss
17651
18053
  :type CreateTime: str
17652
18054
  :param _SyntaxRule: 语法规则。 默认值为0。
17653
18055
  0:Lucene语法,1:CQL语法。
@@ -17772,7 +18174,7 @@ class ExportInfo(AbstractModel):
17772
18174
 
17773
18175
  @property
17774
18176
  def From(self):
17775
- """日志导出起始时间
18177
+ """日志导出起始时间,毫秒时间戳
17776
18178
  :rtype: int
17777
18179
  """
17778
18180
  return self._From
@@ -17783,7 +18185,7 @@ class ExportInfo(AbstractModel):
17783
18185
 
17784
18186
  @property
17785
18187
  def To(self):
17786
- """日志导出结束时间
18188
+ """日志导出结束时间,毫秒时间戳
17787
18189
  :rtype: int
17788
18190
  """
17789
18191
  return self._To
@@ -17806,6 +18208,7 @@ class ExportInfo(AbstractModel):
17806
18208
  @property
17807
18209
  def CreateTime(self):
17808
18210
  """日志导出创建时间
18211
+ 时间格式:yyyy-MM-dd HH:mm:ss
17809
18212
  :rtype: str
17810
18213
  """
17811
18214
  return self._CreateTime
@@ -17871,9 +18274,10 @@ class ExtractRuleInfo(AbstractModel):
17871
18274
 
17872
18275
  def __init__(self):
17873
18276
  r"""
17874
- :param _TimeKey: 时间字段的key名字,TikeKey和TimeFormat必须成对出现
18277
+ :param _TimeKey: 时间字段的key名字,TimeKey和TimeFormat必须成对出现
17875
18278
  :type TimeKey: str
17876
18279
  :param _TimeFormat: 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
18280
+ - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
17877
18281
  :type TimeFormat: str
17878
18282
  :param _Delimiter: 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
17879
18283
  :type Delimiter: str
@@ -17978,7 +18382,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
17978
18382
 
17979
18383
  @property
17980
18384
  def TimeKey(self):
17981
- """时间字段的key名字,TikeKey和TimeFormat必须成对出现
18385
+ """时间字段的key名字,TimeKey和TimeFormat必须成对出现
17982
18386
  :rtype: str
17983
18387
  """
17984
18388
  return self._TimeKey
@@ -17990,6 +18394,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
17990
18394
  @property
17991
18395
  def TimeFormat(self):
17992
18396
  """时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
18397
+ - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
17993
18398
  :rtype: str
17994
18399
  """
17995
18400
  return self._TimeFormat
@@ -18542,7 +18947,9 @@ class GetAlarmLogRequest(AbstractModel):
18542
18947
  :type To: int
18543
18948
  :param _Query: 查询过滤条件,例如:
18544
18949
  - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
18950
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
18545
18951
  - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
18952
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
18546
18953
  - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
18547
18954
  - 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c") AND (monitored_object:"3c514e84-6f1f-46ec-xxxx-05de6163f7fe") AND NOT condition_evaluate_result: "Skip" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1`
18548
18955
  :type Query: str
@@ -18597,7 +19004,9 @@ false:代表使用老的检索结果返回方式,输出AnalysisResults和Col
18597
19004
  def Query(self):
18598
19005
  """查询过滤条件,例如:
18599
19006
  - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
19007
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
18600
19008
  - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
19009
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
18601
19010
  - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
18602
19011
  - 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c") AND (monitored_object:"3c514e84-6f1f-46ec-xxxx-05de6163f7fe") AND NOT condition_evaluate_result: "Skip" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1`
18603
19012
  :rtype: str
@@ -19307,10 +19716,22 @@ class KafkaProtocolInfo(AbstractModel):
19307
19716
  def __init__(self):
19308
19717
  r"""
19309
19718
  :param _Protocol: 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
19310
- 入参必填
19719
+
19720
+ - 当IsEncryptionAddr为true时,Protocol必填。
19721
+ - 支持的协议类型如下:
19722
+ - plaintext:纯文本无加密协议
19723
+ - sasl_ssl:SASL 认证 + SSL 加密
19724
+ - ssl:纯 SSL/TLS 加密协议
19725
+ - sasl_plaintext:SASL 认证 + 非加密通道
19726
+
19311
19727
  :type Protocol: str
19312
19728
  :param _Mechanism: 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
19313
- 当Protocol为sasl_plaintext或sasl_ssl时必填
19729
+
19730
+ - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。
19731
+ - 支持加密类型如下
19732
+ - PLAIN:明文认证
19733
+ - SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法
19734
+ - SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法
19314
19735
  :type Mechanism: str
19315
19736
  :param _UserName: 用户名。
19316
19737
  当Protocol为sasl_plaintext或sasl_ssl时必填
@@ -19327,7 +19748,14 @@ class KafkaProtocolInfo(AbstractModel):
19327
19748
  @property
19328
19749
  def Protocol(self):
19329
19750
  """协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
19330
- 入参必填
19751
+
19752
+ - 当IsEncryptionAddr为true时,Protocol必填。
19753
+ - 支持的协议类型如下:
19754
+ - plaintext:纯文本无加密协议
19755
+ - sasl_ssl:SASL 认证 + SSL 加密
19756
+ - ssl:纯 SSL/TLS 加密协议
19757
+ - sasl_plaintext:SASL 认证 + 非加密通道
19758
+
19331
19759
  :rtype: str
19332
19760
  """
19333
19761
  return self._Protocol
@@ -19339,7 +19767,12 @@ class KafkaProtocolInfo(AbstractModel):
19339
19767
  @property
19340
19768
  def Mechanism(self):
19341
19769
  """加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
19342
- 当Protocol为sasl_plaintext或sasl_ssl时必填
19770
+
19771
+ - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。
19772
+ - 支持加密类型如下
19773
+ - PLAIN:明文认证
19774
+ - SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法
19775
+ - SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法
19343
19776
  :rtype: str
19344
19777
  """
19345
19778
  return self._Mechanism
@@ -20239,7 +20672,7 @@ class LogRechargeRuleInfo(AbstractModel):
20239
20672
  :type RechargeType: str
20240
20673
  :param _EncodingFormat: 解析编码格式,0: UTF-8(默认值),1: GBK
20241
20674
  :type EncodingFormat: int
20242
- :param _DefaultTimeSwitch: 使用默认时间,true:开启(默认值), flase:关闭
20675
+ :param _DefaultTimeSwitch: 使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true
20243
20676
  :type DefaultTimeSwitch: bool
20244
20677
  :param _LogRegex: 整条日志匹配规则,只有RechargeType为fullregex_log时有效
20245
20678
  :type LogRegex: str
@@ -20251,13 +20684,101 @@ class LogRechargeRuleInfo(AbstractModel):
20251
20684
  :type UnMatchLogTimeSrc: int
20252
20685
  :param _DefaultTimeSrc: 默认时间来源,0: 系统当前时间,1: Kafka消息时间戳
20253
20686
  :type DefaultTimeSrc: int
20254
- :param _TimeKey: 时间字段
20687
+ :param _TimeKey: 时间字段,日志中代表时间的字段名。
20688
+
20689
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。
20255
20690
  :type TimeKey: str
20256
- :param _TimeRegex: 时间提取正则表达式
20691
+ :param _TimeRegex: 时间提取正则表达式。
20692
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时, TimeRegex不能为空。
20693
+ - 仅需输入日志中代表时间的字段的正则表达式即可;若匹配到多个字段,将使用第一个。
20694
+ 例:日志原文为:message with time 2022-08-08 14:20:20,则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d
20695
+
20257
20696
  :type TimeRegex: str
20258
- :param _TimeFormat: 时间字段格式
20697
+ :param _TimeFormat: 时间字段格式。
20698
+ - 当DefaultTimeSwitch为false时, TimeFormat不能为空。
20259
20699
  :type TimeFormat: str
20260
- :param _TimeZone: 时间字段时区
20700
+ :param _TimeZone: 时间字段时区。
20701
+ - 当DefaultTimeSwitch为false时, TimeZone不能为空。
20702
+ - 时区格式规则
20703
+ ​前缀​:使用 GMT 或 UTC 作为时区基准
20704
+ ​偏移量​:
20705
+ - `-` 表示西时区(比基准时间晚)
20706
+ - `+` 表示东时区(比基准时间早)
20707
+ - 格式为 ±HH:MM(小时:分钟)
20708
+
20709
+ - 当前支持:
20710
+ ```
20711
+ "GMT-12:00"
20712
+ "GMT-11:00"
20713
+ "GMT-10:00"
20714
+ "GMT-09:30"
20715
+ "GMT-09:00"
20716
+ "GMT-08:00"
20717
+ "GMT-07:00"
20718
+ "GMT-06:00"
20719
+ "GMT-05:00"
20720
+ "GMT-04:00"
20721
+ "GMT-03:30"
20722
+ "GMT-03:00"
20723
+ "GMT-02:00"
20724
+ "GMT-01:00"
20725
+ "GMT+00:00"
20726
+ "GMT+01:00"
20727
+ "GMT+02:00"
20728
+ "GMT+03:30"
20729
+ "GMT+04:00"
20730
+ "GMT+04:30"
20731
+ "GMT+05:00"
20732
+ "GMT+05:30"
20733
+ "GMT+05:45"
20734
+ "GMT+06:00"
20735
+ "GMT+06:30"
20736
+ "GMT+07:00"
20737
+ "GMT+08:00"
20738
+ "GMT+09:00"
20739
+ "GMT+09:30"
20740
+ "GMT+10:00"
20741
+ "GMT+10:30"
20742
+ "GMT+11:00"
20743
+ "GMT+11:30"
20744
+ "GMT+12:00"
20745
+ "GMT+12:45"
20746
+ "GMT+13:00"
20747
+ "GMT+14:00"
20748
+ "UTC-11:00"
20749
+ "UTC-10:00"
20750
+ "UTC-09:00"
20751
+ "UTC-08:00"
20752
+ "UTC-12:00"
20753
+ "UTC-07:00"
20754
+ "UTC-06:00"
20755
+ "UTC-05:00"
20756
+ "UTC-04:30"
20757
+ "UTC-04:00"
20758
+ "UTC-03:30"
20759
+ "UTC-03:00"
20760
+ "UTC-02:00"
20761
+ "UTC-01:00"
20762
+ "UTC+00:00"
20763
+ "UTC+01:00"
20764
+ "UTC+02:00"
20765
+ "UTC+03:00"
20766
+ "UTC+03:30"
20767
+ "UTC+04:00"
20768
+ "UTC+04:30"
20769
+ "UTC+05:00"
20770
+ "UTC+05:45"
20771
+ "UTC+06:00"
20772
+ "UTC+06:30"
20773
+ "UTC+07:00"
20774
+ "UTC+08:00"
20775
+ "UTC+09:00"
20776
+ "UTC+09:30"
20777
+ "UTC+10:00"
20778
+ "UTC+11:00"
20779
+ "UTC+12:00"
20780
+ "UTC+13:00"
20781
+ ```
20261
20782
  :type TimeZone: str
20262
20783
  :param _Metadata: 元数据信息,Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp
20263
20784
  :type Metadata: list of str
@@ -20306,7 +20827,7 @@ class LogRechargeRuleInfo(AbstractModel):
20306
20827
 
20307
20828
  @property
20308
20829
  def DefaultTimeSwitch(self):
20309
- """使用默认时间,true:开启(默认值), flase:关闭
20830
+ """使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true
20310
20831
  :rtype: bool
20311
20832
  """
20312
20833
  return self._DefaultTimeSwitch
@@ -20372,7 +20893,9 @@ class LogRechargeRuleInfo(AbstractModel):
20372
20893
 
20373
20894
  @property
20374
20895
  def TimeKey(self):
20375
- """时间字段
20896
+ """时间字段,日志中代表时间的字段名。
20897
+
20898
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。
20376
20899
  :rtype: str
20377
20900
  """
20378
20901
  return self._TimeKey
@@ -20383,7 +20906,11 @@ class LogRechargeRuleInfo(AbstractModel):
20383
20906
 
20384
20907
  @property
20385
20908
  def TimeRegex(self):
20386
- """时间提取正则表达式
20909
+ """时间提取正则表达式。
20910
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时, TimeRegex不能为空。
20911
+ - 仅需输入日志中代表时间的字段的正则表达式即可;若匹配到多个字段,将使用第一个。
20912
+ 例:日志原文为:message with time 2022-08-08 14:20:20,则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d
20913
+
20387
20914
  :rtype: str
20388
20915
  """
20389
20916
  return self._TimeRegex
@@ -20394,7 +20921,8 @@ class LogRechargeRuleInfo(AbstractModel):
20394
20921
 
20395
20922
  @property
20396
20923
  def TimeFormat(self):
20397
- """时间字段格式
20924
+ """时间字段格式。
20925
+ - 当DefaultTimeSwitch为false时, TimeFormat不能为空。
20398
20926
  :rtype: str
20399
20927
  """
20400
20928
  return self._TimeFormat
@@ -20405,7 +20933,88 @@ class LogRechargeRuleInfo(AbstractModel):
20405
20933
 
20406
20934
  @property
20407
20935
  def TimeZone(self):
20408
- """时间字段时区
20936
+ """时间字段时区。
20937
+ - 当DefaultTimeSwitch为false时, TimeZone不能为空。
20938
+ - 时区格式规则
20939
+ ​前缀​:使用 GMT 或 UTC 作为时区基准
20940
+ ​偏移量​:
20941
+ - `-` 表示西时区(比基准时间晚)
20942
+ - `+` 表示东时区(比基准时间早)
20943
+ - 格式为 ±HH:MM(小时:分钟)
20944
+
20945
+ - 当前支持:
20946
+ ```
20947
+ "GMT-12:00"
20948
+ "GMT-11:00"
20949
+ "GMT-10:00"
20950
+ "GMT-09:30"
20951
+ "GMT-09:00"
20952
+ "GMT-08:00"
20953
+ "GMT-07:00"
20954
+ "GMT-06:00"
20955
+ "GMT-05:00"
20956
+ "GMT-04:00"
20957
+ "GMT-03:30"
20958
+ "GMT-03:00"
20959
+ "GMT-02:00"
20960
+ "GMT-01:00"
20961
+ "GMT+00:00"
20962
+ "GMT+01:00"
20963
+ "GMT+02:00"
20964
+ "GMT+03:30"
20965
+ "GMT+04:00"
20966
+ "GMT+04:30"
20967
+ "GMT+05:00"
20968
+ "GMT+05:30"
20969
+ "GMT+05:45"
20970
+ "GMT+06:00"
20971
+ "GMT+06:30"
20972
+ "GMT+07:00"
20973
+ "GMT+08:00"
20974
+ "GMT+09:00"
20975
+ "GMT+09:30"
20976
+ "GMT+10:00"
20977
+ "GMT+10:30"
20978
+ "GMT+11:00"
20979
+ "GMT+11:30"
20980
+ "GMT+12:00"
20981
+ "GMT+12:45"
20982
+ "GMT+13:00"
20983
+ "GMT+14:00"
20984
+ "UTC-11:00"
20985
+ "UTC-10:00"
20986
+ "UTC-09:00"
20987
+ "UTC-08:00"
20988
+ "UTC-12:00"
20989
+ "UTC-07:00"
20990
+ "UTC-06:00"
20991
+ "UTC-05:00"
20992
+ "UTC-04:30"
20993
+ "UTC-04:00"
20994
+ "UTC-03:30"
20995
+ "UTC-03:00"
20996
+ "UTC-02:00"
20997
+ "UTC-01:00"
20998
+ "UTC+00:00"
20999
+ "UTC+01:00"
21000
+ "UTC+02:00"
21001
+ "UTC+03:00"
21002
+ "UTC+03:30"
21003
+ "UTC+04:00"
21004
+ "UTC+04:30"
21005
+ "UTC+05:00"
21006
+ "UTC+05:45"
21007
+ "UTC+06:00"
21008
+ "UTC+06:30"
21009
+ "UTC+07:00"
21010
+ "UTC+08:00"
21011
+ "UTC+09:00"
21012
+ "UTC+09:30"
21013
+ "UTC+10:00"
21014
+ "UTC+11:00"
21015
+ "UTC+12:00"
21016
+ "UTC+13:00"
21017
+ ```
20409
21018
  :rtype: str
20410
21019
  """
20411
21020
  return self._TimeZone
@@ -20619,18 +21228,21 @@ class MachineGroupInfo(AbstractModel):
20619
21228
  :param _MachineGroupType: 机器组类型
20620
21229
  :type MachineGroupType: :class:`tencentcloud.cls.v20201016.models.MachineGroupTypeInfo`
20621
21230
  :param _CreateTime: 创建时间
21231
+ 时间格式:yyyy-MM-dd HH:mm:ss
20622
21232
  :type CreateTime: str
20623
21233
  :param _Tags: 机器组绑定的标签列表
20624
21234
  :type Tags: list of Tag
20625
21235
  :param _AutoUpdate: 是否开启机器组自动更新
20626
21236
  :type AutoUpdate: str
20627
21237
  :param _UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
21238
+ 时间格式:HH:mm:ss
20628
21239
  :type UpdateStartTime: str
20629
21240
  :param _UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
21241
+ 时间格式:HH:mm:ss
20630
21242
  :type UpdateEndTime: str
20631
21243
  :param _ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
20632
21244
  :type ServiceLogging: bool
20633
- :param _DelayCleanupTime: 机器组中机器离线定期清理时间
21245
+ :param _DelayCleanupTime: 机器组中机器离线定期清理时间,单位天,默认设置30天。
20634
21246
  :type DelayCleanupTime: int
20635
21247
  :param _MetaTags: 机器组元数据信息列表
20636
21248
  :type MetaTags: list of MetaTagInfo
@@ -20686,6 +21298,7 @@ class MachineGroupInfo(AbstractModel):
20686
21298
  @property
20687
21299
  def CreateTime(self):
20688
21300
  """创建时间
21301
+ 时间格式:yyyy-MM-dd HH:mm:ss
20689
21302
  :rtype: str
20690
21303
  """
20691
21304
  return self._CreateTime
@@ -20719,6 +21332,7 @@ class MachineGroupInfo(AbstractModel):
20719
21332
  @property
20720
21333
  def UpdateStartTime(self):
20721
21334
  """升级开始时间,建议业务低峰期升级LogListener
21335
+ 时间格式:HH:mm:ss
20722
21336
  :rtype: str
20723
21337
  """
20724
21338
  return self._UpdateStartTime
@@ -20730,6 +21344,7 @@ class MachineGroupInfo(AbstractModel):
20730
21344
  @property
20731
21345
  def UpdateEndTime(self):
20732
21346
  """升级结束时间,建议业务低峰期升级LogListener
21347
+ 时间格式:HH:mm:ss
20733
21348
  :rtype: str
20734
21349
  """
20735
21350
  return self._UpdateEndTime
@@ -20751,7 +21366,7 @@ class MachineGroupInfo(AbstractModel):
20751
21366
 
20752
21367
  @property
20753
21368
  def DelayCleanupTime(self):
20754
- """机器组中机器离线定期清理时间
21369
+ """机器组中机器离线定期清理时间,单位天,默认设置30天。
20755
21370
  :rtype: int
20756
21371
  """
20757
21372
  return self._DelayCleanupTime
@@ -21040,9 +21655,10 @@ class MergePartitionRequest(AbstractModel):
21040
21655
 
21041
21656
  def __init__(self):
21042
21657
  r"""
21043
- :param _TopicId: 日志主题ID
21658
+ :param _TopicId: 日志主题Id
21659
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
21044
21660
  :type TopicId: str
21045
- :param _PartitionId: 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Staus:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)
21661
+ :param _PartitionId: 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Status:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)
21046
21662
 
21047
21663
  1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);
21048
21664
  2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);
@@ -21054,7 +21670,8 @@ class MergePartitionRequest(AbstractModel):
21054
21670
 
21055
21671
  @property
21056
21672
  def TopicId(self):
21057
- """日志主题ID
21673
+ """日志主题Id
21674
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
21058
21675
  :rtype: str
21059
21676
  """
21060
21677
  return self._TopicId
@@ -21065,7 +21682,7 @@ class MergePartitionRequest(AbstractModel):
21065
21682
 
21066
21683
  @property
21067
21684
  def PartitionId(self):
21068
- """合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Staus:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)
21685
+ """合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Status:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)
21069
21686
 
21070
21687
  1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);
21071
21688
  2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);
@@ -22643,6 +23260,8 @@ class ModifyConfigRequest(AbstractModel):
22643
23260
  :param _ConfigId: 采集规则配置ID,通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)返回信息获取。
22644
23261
  :type ConfigId: str
22645
23262
  :param _Name: 采集规则配置名称
23263
+ - 不能包含特殊字符|
23264
+ - 长度不能超过255字符,超过会被截断
22646
23265
  :type Name: str
22647
23266
  :param _Path: 日志采集路径,包含文件名
22648
23267
  :type Path: str
@@ -22664,6 +23283,7 @@ class ModifyConfigRequest(AbstractModel):
22664
23283
  :param _ExcludePaths: 采集黑名单路径列表
22665
23284
  :type ExcludePaths: list of ExcludePathInfo
22666
23285
  :param _Output: 采集配置关联的日志主题(TopicId)
23286
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22667
23287
  :type Output: str
22668
23288
  :param _UserDefineRule: 用户自定义解析字符串,Json格式序列化的字符串。
22669
23289
  :type UserDefineRule: str
@@ -22699,6 +23319,8 @@ class ModifyConfigRequest(AbstractModel):
22699
23319
  @property
22700
23320
  def Name(self):
22701
23321
  """采集规则配置名称
23322
+ - 不能包含特殊字符|
23323
+ - 长度不能超过255字符,超过会被截断
22702
23324
  :rtype: str
22703
23325
  """
22704
23326
  return self._Name
@@ -22765,6 +23387,7 @@ class ModifyConfigRequest(AbstractModel):
22765
23387
  @property
22766
23388
  def Output(self):
22767
23389
  """采集配置关联的日志主题(TopicId)
23390
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22768
23391
  :rtype: str
22769
23392
  """
22770
23393
  return self._Output
@@ -22863,7 +23486,9 @@ class ModifyConsoleSharingRequest(AbstractModel):
22863
23486
 
22864
23487
  def __init__(self):
22865
23488
  r"""
22866
- :param _SharingId: 免密分享链接Id
23489
+ :param _SharingId: 免密分享Id
23490
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
23491
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
22867
23492
  :type SharingId: str
22868
23493
  :param _DurationMilliseconds: 指定分享链接有效期,单位:毫秒,最长可设定有效期为30天
22869
23494
  :type DurationMilliseconds: int
@@ -22873,7 +23498,9 @@ class ModifyConsoleSharingRequest(AbstractModel):
22873
23498
 
22874
23499
  @property
22875
23500
  def SharingId(self):
22876
- """免密分享链接Id
23501
+ """免密分享Id
23502
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
23503
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
22877
23504
  :rtype: str
22878
23505
  """
22879
23506
  return self._SharingId
@@ -22942,7 +23569,9 @@ class ModifyConsumerRequest(AbstractModel):
22942
23569
 
22943
23570
  def __init__(self):
22944
23571
  r"""
22945
- :param _TopicId: 投递任务绑定的日志主题 ID
23572
+ :param _TopicId: 投递任务绑定的日志主题Id。
23573
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
23574
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
22946
23575
  :type TopicId: str
22947
23576
  :param _Effective: 投递任务是否生效,默认不生效
22948
23577
  :type Effective: bool
@@ -22966,7 +23595,9 @@ class ModifyConsumerRequest(AbstractModel):
22966
23595
 
22967
23596
  @property
22968
23597
  def TopicId(self):
22969
- """投递任务绑定的日志主题 ID
23598
+ """投递任务绑定的日志主题Id。
23599
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
23600
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
22970
23601
  :rtype: str
22971
23602
  """
22972
23603
  return self._TopicId
@@ -23748,9 +24379,11 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23748
24379
 
23749
24380
  def __init__(self):
23750
24381
  r"""
23751
- :param _FromTopicId: 日志主题ID
24382
+ :param _FromTopicId: 日志主题Id。
24383
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
24384
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
23752
24385
  :type FromTopicId: str
23753
- :param _Compression: 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
24386
+ :param _Compression: 压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
23754
24387
  :type Compression: int
23755
24388
  :param _ConsumerContent: kafka协议消费数据格式
23756
24389
  :type ConsumerContent: :class:`tencentcloud.cls.v20201016.models.KafkaConsumerContent`
@@ -23761,7 +24394,9 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23761
24394
 
23762
24395
  @property
23763
24396
  def FromTopicId(self):
23764
- """日志主题ID
24397
+ """日志主题Id。
24398
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
24399
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
23765
24400
  :rtype: str
23766
24401
  """
23767
24402
  return self._FromTopicId
@@ -23772,7 +24407,7 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23772
24407
 
23773
24408
  @property
23774
24409
  def Compression(self):
23775
- """压缩方式[0:NONE;2:SNAPPY;3:LZ4]
24410
+ """压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
23776
24411
  :rtype: int
23777
24412
  """
23778
24413
  return self._Compression
@@ -23844,15 +24479,20 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23844
24479
 
23845
24480
  def __init__(self):
23846
24481
  r"""
23847
- :param _Id: Kafka导入配置ID
24482
+ :param _Id: 导入配置Id。
24483
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
24484
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
23848
24485
  :type Id: str
23849
- :param _TopicId: 导入CLS目标topic ID
24486
+ :param _TopicId: 导入CLS目标TopicId。
24487
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
24488
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。
23850
24489
  :type TopicId: str
23851
24490
  :param _Name: Kafka导入配置名称
23852
24491
  :type Name: str
23853
24492
  :param _KafkaType: 导入Kafka类型,0:腾讯云CKafka:1:用户自建Kafka。
23854
24493
  :type KafkaType: int
23855
24494
  :param _KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填。
24495
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
23856
24496
  :type KafkaInstance: str
23857
24497
  :param _ServerAddr: 服务地址,KafkaType为1时必填。
23858
24498
  :type ServerAddr: str
@@ -23860,13 +24500,15 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23860
24500
  :type IsEncryptionAddr: bool
23861
24501
  :param _Protocol: 加密访问协议,KafkaType参数为1并且IsEncryptionAddr参数为true时必填。
23862
24502
  :type Protocol: :class:`tencentcloud.cls.v20201016.models.KafkaProtocolInfo`
23863
- :param _UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
24503
+ :param _UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
24504
+
24505
+ - Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
23864
24506
  :type UserKafkaTopics: str
23865
24507
  :param _ConsumerGroupName: 用户Kafka消费组名称
23866
24508
  :type ConsumerGroupName: str
23867
24509
  :param _LogRechargeRule: 日志导入规则
23868
24510
  :type LogRechargeRule: :class:`tencentcloud.cls.v20201016.models.LogRechargeRuleInfo`
23869
- :param _StatusControl: 导入控制,1:暂停;2:继续。
24511
+ :param _StatusControl: 导入控制,1:暂停;2:启动。
23870
24512
  :type StatusControl: int
23871
24513
  """
23872
24514
  self._Id = None
@@ -23884,7 +24526,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23884
24526
 
23885
24527
  @property
23886
24528
  def Id(self):
23887
- """Kafka导入配置ID
24529
+ """导入配置Id。
24530
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
24531
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
23888
24532
  :rtype: str
23889
24533
  """
23890
24534
  return self._Id
@@ -23895,7 +24539,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23895
24539
 
23896
24540
  @property
23897
24541
  def TopicId(self):
23898
- """导入CLS目标topic ID
24542
+ """导入CLS目标TopicId。
24543
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
24544
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。
23899
24545
  :rtype: str
23900
24546
  """
23901
24547
  return self._TopicId
@@ -23929,6 +24575,7 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23929
24575
  @property
23930
24576
  def KafkaInstance(self):
23931
24577
  """腾讯云CKafka实例ID,KafkaType为0时必填。
24578
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
23932
24579
  :rtype: str
23933
24580
  """
23934
24581
  return self._KafkaInstance
@@ -23972,7 +24619,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23972
24619
 
23973
24620
  @property
23974
24621
  def UserKafkaTopics(self):
23975
- """用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
24622
+ """用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
24623
+
24624
+ - Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
23976
24625
  :rtype: str
23977
24626
  """
23978
24627
  return self._UserKafkaTopics
@@ -24005,7 +24654,7 @@ class ModifyKafkaRechargeRequest(AbstractModel):
24005
24654
 
24006
24655
  @property
24007
24656
  def StatusControl(self):
24008
- """导入控制,1:暂停;2:继续。
24657
+ """导入控制,1:暂停;2:启动。
24009
24658
  :rtype: int
24010
24659
  """
24011
24660
  return self._StatusControl
@@ -24176,9 +24825,13 @@ class ModifyMachineGroupRequest(AbstractModel):
24176
24825
 
24177
24826
  def __init__(self):
24178
24827
  r"""
24179
- :param _GroupId: 机器组ID
24828
+ :param _GroupId: 机器组Id
24829
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
24180
24830
  :type GroupId: str
24181
24831
  :param _GroupName: 机器组名称
24832
+ 输入限制:
24833
+ - 不能为空字符串
24834
+ - 不能包含字符'|'
24182
24835
  :type GroupName: str
24183
24836
  :param _MachineGroupType: 机器组类型。
24184
24837
  Type:ip,Values中为ip字符串列表机器组;
@@ -24189,8 +24842,10 @@ Type:label,Values中为标签字符串列表机器组。
24189
24842
  :param _AutoUpdate: 是否开启机器组自动更新
24190
24843
  :type AutoUpdate: bool
24191
24844
  :param _UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
24845
+ 时间格式:HH:mm:ss
24192
24846
  :type UpdateStartTime: str
24193
24847
  :param _UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
24848
+ 时间格式:HH:mm:ss
24194
24849
  :type UpdateEndTime: str
24195
24850
  :param _ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
24196
24851
  :type ServiceLogging: bool
@@ -24212,7 +24867,8 @@ Type:label,Values中为标签字符串列表机器组。
24212
24867
 
24213
24868
  @property
24214
24869
  def GroupId(self):
24215
- """机器组ID
24870
+ """机器组Id
24871
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
24216
24872
  :rtype: str
24217
24873
  """
24218
24874
  return self._GroupId
@@ -24224,6 +24880,9 @@ Type:label,Values中为标签字符串列表机器组。
24224
24880
  @property
24225
24881
  def GroupName(self):
24226
24882
  """机器组名称
24883
+ 输入限制:
24884
+ - 不能为空字符串
24885
+ - 不能包含字符'|'
24227
24886
  :rtype: str
24228
24887
  """
24229
24888
  return self._GroupName
@@ -24270,6 +24929,7 @@ Type:label,Values中为标签字符串列表机器组。
24270
24929
  @property
24271
24930
  def UpdateStartTime(self):
24272
24931
  """升级开始时间,建议业务低峰期升级LogListener
24932
+ 时间格式:HH:mm:ss
24273
24933
  :rtype: str
24274
24934
  """
24275
24935
  return self._UpdateStartTime
@@ -24281,6 +24941,7 @@ Type:label,Values中为标签字符串列表机器组。
24281
24941
  @property
24282
24942
  def UpdateEndTime(self):
24283
24943
  """升级结束时间,建议业务低峰期升级LogListener
24944
+ 时间格式:HH:mm:ss
24284
24945
  :rtype: str
24285
24946
  """
24286
24947
  return self._UpdateEndTime
@@ -24509,9 +25170,9 @@ class ModifyScheduledSqlRequest(AbstractModel):
24509
25170
 
24510
25171
  def __init__(self):
24511
25172
  r"""
24512
- :param _TaskId: 任务ID
25173
+ :param _TaskId: 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24513
25174
  :type TaskId: str
24514
- :param _SrcTopicId: 源日志主题
25175
+ :param _SrcTopicId: 源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24515
25176
  :type SrcTopicId: str
24516
25177
  :param _EnableFlag: 任务启动状态. 1开启, 2关闭
24517
25178
  :type EnableFlag: int
@@ -24519,15 +25180,15 @@ class ModifyScheduledSqlRequest(AbstractModel):
24519
25180
  :type DstResource: :class:`tencentcloud.cls.v20201016.models.ScheduledSqlResouceInfo`
24520
25181
  :param _ScheduledSqlContent: 查询语句
24521
25182
  :type ScheduledSqlContent: str
24522
- :param _ProcessPeriod: 调度周期(分钟)
25183
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
24523
25184
  :type ProcessPeriod: int
24524
25185
  :param _ProcessTimeWindow: 单次查询的时间窗口. 例子中为近15分钟
24525
25186
  :type ProcessTimeWindow: str
24526
- :param _ProcessDelay: 执行延迟(秒)
25187
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
24527
25188
  :type ProcessDelay: int
24528
- :param _SrcTopicRegion: 源topicId的地域信息
25189
+ :param _SrcTopicRegion: 源topicId的地域信息,支持地域见(https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8)
24529
25190
  :type SrcTopicRegion: str
24530
- :param _Name: 任务名称
25191
+ :param _Name: 任务名称,0~255字符
24531
25192
  :type Name: str
24532
25193
  :param _SyntaxRule: 语法规则。 默认值为0。 0:Lucene语法,1:CQL语法
24533
25194
  :type SyntaxRule: int
@@ -24546,7 +25207,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24546
25207
 
24547
25208
  @property
24548
25209
  def TaskId(self):
24549
- """任务ID
25210
+ """任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24550
25211
  :rtype: str
24551
25212
  """
24552
25213
  return self._TaskId
@@ -24557,7 +25218,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24557
25218
 
24558
25219
  @property
24559
25220
  def SrcTopicId(self):
24560
- """源日志主题
25221
+ """源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24561
25222
  :rtype: str
24562
25223
  """
24563
25224
  return self._SrcTopicId
@@ -24601,7 +25262,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24601
25262
 
24602
25263
  @property
24603
25264
  def ProcessPeriod(self):
24604
- """调度周期(分钟)
25265
+ """调度周期(分钟),1~1440分钟
24605
25266
  :rtype: int
24606
25267
  """
24607
25268
  return self._ProcessPeriod
@@ -24623,7 +25284,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24623
25284
 
24624
25285
  @property
24625
25286
  def ProcessDelay(self):
24626
- """执行延迟(秒)
25287
+ """执行延迟(秒),0~120秒,默认60秒
24627
25288
  :rtype: int
24628
25289
  """
24629
25290
  return self._ProcessDelay
@@ -24634,7 +25295,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24634
25295
 
24635
25296
  @property
24636
25297
  def SrcTopicRegion(self):
24637
- """源topicId的地域信息
25298
+ """源topicId的地域信息,支持地域见(https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8)
24638
25299
  :rtype: str
24639
25300
  """
24640
25301
  return self._SrcTopicRegion
@@ -24645,7 +25306,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24645
25306
 
24646
25307
  @property
24647
25308
  def Name(self):
24648
- """任务名称
25309
+ """任务名称,0~255字符
24649
25310
  :rtype: str
24650
25311
  """
24651
25312
  return self._Name
@@ -25011,8 +25672,13 @@ class ModifyTopicRequest(AbstractModel):
25011
25672
  def __init__(self):
25012
25673
  r"""
25013
25674
  :param _TopicId: 日志主题ID
25675
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
25014
25676
  :type TopicId: str
25015
25677
  :param _TopicName: 日志主题名称
25678
+ 输入限制:
25679
+ - 不能为空字符串
25680
+ - 不能包含字符'|'
25681
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
25016
25682
  :type TopicName: str
25017
25683
  :param _Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,并且不能有重复的键值对。
25018
25684
  :type Tags: list of Tag
@@ -25021,7 +25687,8 @@ class ModifyTopicRequest(AbstractModel):
25021
25687
  :type Status: bool
25022
25688
  :param _AutoSplit: 是否开启自动分裂
25023
25689
  :type AutoSplit: bool
25024
- :param _MaxSplitPartitions: 若开启最大分裂,该主题能够能够允许的最大分区数
25690
+ :param _MaxSplitPartitions: 若开启最大分裂,该主题能够能够允许的最大分区数;
25691
+ 默认为50;必须为正数
25025
25692
  :type MaxSplitPartitions: int
25026
25693
  :param _Period: 生命周期,单位天,标准存储取值范围1\~3600,低频存储取值范围7\~3600。取值为3640时代表永久保存
25027
25694
  :type Period: int
@@ -25035,9 +25702,15 @@ class ModifyTopicRequest(AbstractModel):
25035
25702
  :type IsWebTracking: bool
25036
25703
  :param _Extends: 日志主题扩展信息
25037
25704
  :type Extends: :class:`tencentcloud.cls.v20201016.models.TopicExtendInfo`
25038
- :param _PartitionCount: 日志主题分区数量
25705
+ :param _PartitionCount: 日志主题分区数量。
25706
+ 默认为1;
25707
+ 取值范围及约束:
25708
+ - 当输入值<=0,系统自动调整为1。
25709
+ - 如果未传MaxSplitPartitions,需要PartitionCount<=50;
25710
+ - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
25039
25711
  :type PartitionCount: int
25040
25712
  :param _CancelTopicAsyncTaskID: 取消切换存储任务的id
25713
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
25041
25714
  :type CancelTopicAsyncTaskID: str
25042
25715
  """
25043
25716
  self._TopicId = None
@@ -25057,6 +25730,7 @@ class ModifyTopicRequest(AbstractModel):
25057
25730
  @property
25058
25731
  def TopicId(self):
25059
25732
  """日志主题ID
25733
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
25060
25734
  :rtype: str
25061
25735
  """
25062
25736
  return self._TopicId
@@ -25068,6 +25742,10 @@ class ModifyTopicRequest(AbstractModel):
25068
25742
  @property
25069
25743
  def TopicName(self):
25070
25744
  """日志主题名称
25745
+ 输入限制:
25746
+ - 不能为空字符串
25747
+ - 不能包含字符'|'
25748
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
25071
25749
  :rtype: str
25072
25750
  """
25073
25751
  return self._TopicName
@@ -25112,7 +25790,8 @@ class ModifyTopicRequest(AbstractModel):
25112
25790
 
25113
25791
  @property
25114
25792
  def MaxSplitPartitions(self):
25115
- """若开启最大分裂,该主题能够能够允许的最大分区数
25793
+ """若开启最大分裂,该主题能够能够允许的最大分区数;
25794
+ 默认为50;必须为正数
25116
25795
  :rtype: int
25117
25796
  """
25118
25797
  return self._MaxSplitPartitions
@@ -25180,7 +25859,12 @@ class ModifyTopicRequest(AbstractModel):
25180
25859
 
25181
25860
  @property
25182
25861
  def PartitionCount(self):
25183
- """日志主题分区数量
25862
+ """日志主题分区数量。
25863
+ 默认为1;
25864
+ 取值范围及约束:
25865
+ - 当输入值<=0,系统自动调整为1。
25866
+ - 如果未传MaxSplitPartitions,需要PartitionCount<=50;
25867
+ - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
25184
25868
  :rtype: int
25185
25869
  """
25186
25870
  return self._PartitionCount
@@ -25192,6 +25876,7 @@ class ModifyTopicRequest(AbstractModel):
25192
25876
  @property
25193
25877
  def CancelTopicAsyncTaskID(self):
25194
25878
  """取消切换存储任务的id
25879
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
25195
25880
  :rtype: str
25196
25881
  """
25197
25882
  return self._CancelTopicAsyncTaskID
@@ -25677,7 +26362,7 @@ class NoticeContentInfo(AbstractModel):
25677
26362
  def __init__(self):
25678
26363
  r"""
25679
26364
  :param _Title: 通知内容模板标题信息。
25680
- 部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
26365
+ 部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
25681
26366
  :type Title: str
25682
26367
  :param _Content: 通知内容模板正文信息。
25683
26368
  :type Content: str
@@ -25692,7 +26377,7 @@ class NoticeContentInfo(AbstractModel):
25692
26377
  @property
25693
26378
  def Title(self):
25694
26379
  """通知内容模板标题信息。
25695
- 部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
26380
+ 部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
25696
26381
  :rtype: str
25697
26382
  """
25698
26383
  return self._Title
@@ -26327,7 +27012,9 @@ class OpenKafkaConsumerRequest(AbstractModel):
26327
27012
 
26328
27013
  def __init__(self):
26329
27014
  r"""
26330
- :param _FromTopicId: 日志主题ID
27015
+ :param _FromTopicId: 日志主题Id。
27016
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27017
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
26331
27018
  :type FromTopicId: str
26332
27019
  :param _Compression: 压缩方式[0:NONE;2:SNAPPY;3:LZ4],默认:0
26333
27020
  :type Compression: int
@@ -26340,7 +27027,9 @@ class OpenKafkaConsumerRequest(AbstractModel):
26340
27027
 
26341
27028
  @property
26342
27029
  def FromTopicId(self):
26343
- """日志主题ID
27030
+ """日志主题Id。
27031
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27032
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
26344
27033
  :rtype: str
26345
27034
  """
26346
27035
  return self._FromTopicId
@@ -26554,8 +27243,10 @@ class PartitionInfo(AbstractModel):
26554
27243
  :param _ExclusiveEndKey: 分区哈希键结束key
26555
27244
  :type ExclusiveEndKey: str
26556
27245
  :param _CreateTime: 分区创建时间
27246
+ 时间格式:yyyy-MM-dd HH:mm:ss
26557
27247
  :type CreateTime: str
26558
27248
  :param _LastWriteTime: 只读分区数据停止写入时间
27249
+ 时间格式:yyyy-MM-dd HH:mm:ss
26559
27250
  注意:此字段可能返回 null,表示取不到有效值。
26560
27251
  :type LastWriteTime: str
26561
27252
  """
@@ -26613,6 +27304,7 @@ class PartitionInfo(AbstractModel):
26613
27304
  @property
26614
27305
  def CreateTime(self):
26615
27306
  """分区创建时间
27307
+ 时间格式:yyyy-MM-dd HH:mm:ss
26616
27308
  :rtype: str
26617
27309
  """
26618
27310
  return self._CreateTime
@@ -26624,6 +27316,7 @@ class PartitionInfo(AbstractModel):
26624
27316
  @property
26625
27317
  def LastWriteTime(self):
26626
27318
  """只读分区数据停止写入时间
27319
+ 时间格式:yyyy-MM-dd HH:mm:ss
26627
27320
  注意:此字段可能返回 null,表示取不到有效值。
26628
27321
  :rtype: str
26629
27322
  """
@@ -27029,8 +27722,10 @@ class QueryMetricRequest(AbstractModel):
27029
27722
  def __init__(self):
27030
27723
  r"""
27031
27724
  :param _Query: 查询语句,使用PromQL语法
27725
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27032
27726
  :type Query: str
27033
27727
  :param _TopicId: 指标主题ID
27728
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27034
27729
  :type TopicId: str
27035
27730
  :param _Time: 查询时间,秒级Unix时间戳。为空时代表当前时间戳。
27036
27731
 
@@ -27043,6 +27738,7 @@ class QueryMetricRequest(AbstractModel):
27043
27738
  @property
27044
27739
  def Query(self):
27045
27740
  """查询语句,使用PromQL语法
27741
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27046
27742
  :rtype: str
27047
27743
  """
27048
27744
  return self._Query
@@ -27054,6 +27750,7 @@ class QueryMetricRequest(AbstractModel):
27054
27750
  @property
27055
27751
  def TopicId(self):
27056
27752
  """指标主题ID
27753
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27057
27754
  :rtype: str
27058
27755
  """
27059
27756
  return self._TopicId
@@ -27096,7 +27793,11 @@ class QueryMetricResponse(AbstractModel):
27096
27793
 
27097
27794
  def __init__(self):
27098
27795
  r"""
27099
- :param _ResultType: 指标查询结果类型
27796
+ :param _ResultType: 指标查询结果类型,支持
27797
+ - scalar 标量值
27798
+ - string 字符串值
27799
+ - vector 瞬时向量
27800
+ - matrix 区间向量
27100
27801
  :type ResultType: str
27101
27802
  :param _Result: 指标查询结果
27102
27803
  :type Result: str
@@ -27109,7 +27810,11 @@ class QueryMetricResponse(AbstractModel):
27109
27810
 
27110
27811
  @property
27111
27812
  def ResultType(self):
27112
- """指标查询结果类型
27813
+ """指标查询结果类型,支持
27814
+ - scalar 标量值
27815
+ - string 字符串值
27816
+ - vector 瞬时向量
27817
+ - matrix 区间向量
27113
27818
  :rtype: str
27114
27819
  """
27115
27820
  return self._ResultType
@@ -27155,8 +27860,10 @@ class QueryRangeMetricRequest(AbstractModel):
27155
27860
  def __init__(self):
27156
27861
  r"""
27157
27862
  :param _TopicId: 指标主题ID
27863
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27158
27864
  :type TopicId: str
27159
27865
  :param _Query: 查询语句,使用PromQL语法
27866
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27160
27867
  :type Query: str
27161
27868
  :param _Start: 查询起始时间,秒级Unix时间戳
27162
27869
  :type Start: int
@@ -27174,6 +27881,7 @@ class QueryRangeMetricRequest(AbstractModel):
27174
27881
  @property
27175
27882
  def TopicId(self):
27176
27883
  """指标主题ID
27884
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27177
27885
  :rtype: str
27178
27886
  """
27179
27887
  return self._TopicId
@@ -27185,6 +27893,7 @@ class QueryRangeMetricRequest(AbstractModel):
27185
27893
  @property
27186
27894
  def Query(self):
27187
27895
  """查询语句,使用PromQL语法
27896
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27188
27897
  :rtype: str
27189
27898
  """
27190
27899
  return self._Query
@@ -27250,7 +27959,11 @@ class QueryRangeMetricResponse(AbstractModel):
27250
27959
 
27251
27960
  def __init__(self):
27252
27961
  r"""
27253
- :param _ResultType: 指标查询结果类型
27962
+ :param _ResultType: 指标查询结果类型,支持
27963
+ - scalar 标量值
27964
+ - string 字符串值
27965
+ - vector 瞬时向量
27966
+ - matrix 区间向量
27254
27967
  :type ResultType: str
27255
27968
  :param _Result: 指标查询结果
27256
27969
  :type Result: str
@@ -27263,7 +27976,11 @@ class QueryRangeMetricResponse(AbstractModel):
27263
27976
 
27264
27977
  @property
27265
27978
  def ResultType(self):
27266
- """指标查询结果类型
27979
+ """指标查询结果类型,支持
27980
+ - scalar 标量值
27981
+ - string 字符串值
27982
+ - vector 瞬时向量
27983
+ - matrix 区间向量
27267
27984
  :rtype: str
27268
27985
  """
27269
27986
  return self._ResultType
@@ -27606,9 +28323,9 @@ class ScheduledSqlResouceInfo(AbstractModel):
27606
28323
 
27607
28324
  def __init__(self):
27608
28325
  r"""
27609
- :param _TopicId: 目标主题id
28326
+ :param _TopicId: 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27610
28327
  :type TopicId: str
27611
- :param _Region: 主题的地域信息
28328
+ :param _Region: 主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
27612
28329
  :type Region: str
27613
28330
  :param _BizType: 主题类型:0为日志主题,1为指标主题
27614
28331
  :type BizType: int
@@ -27636,7 +28353,7 @@ BizType为1时,优先使用MetricNames字段多指标只能填充到MetricName
27636
28353
 
27637
28354
  @property
27638
28355
  def TopicId(self):
27639
- """目标主题id
28356
+ """通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27640
28357
  :rtype: str
27641
28358
  """
27642
28359
  return self._TopicId
@@ -27647,7 +28364,7 @@ BizType为1时,优先使用MetricNames字段多指标只能填充到MetricName
27647
28364
 
27648
28365
  @property
27649
28366
  def Region(self):
27650
- """主题的地域信息
28367
+ """主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
27651
28368
  :rtype: str
27652
28369
  """
27653
28370
  return self._Region
@@ -27766,9 +28483,9 @@ class ScheduledSqlTaskInfo(AbstractModel):
27766
28483
  :type SrcTopicName: str
27767
28484
  :param _DstResource: 定时SQL分析目标主题
27768
28485
  :type DstResource: :class:`tencentcloud.cls.v20201016.models.ScheduledSqlResouceInfo`
27769
- :param _CreateTime: 任务创建时间
28486
+ :param _CreateTime: 任务创建时间。格式:yyyy-MM-dd HH:mm:ss
27770
28487
  :type CreateTime: str
27771
- :param _UpdateTime: 任务更新时间
28488
+ :param _UpdateTime: 任务更新时间,格式:yyyy-MM-dd HH:mm:ss
27772
28489
  :type UpdateTime: str
27773
28490
  :param _Status: 任务状态,1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题
27774
28491
 
@@ -27778,19 +28495,19 @@ class ScheduledSqlTaskInfo(AbstractModel):
27778
28495
  :type EnableFlag: int
27779
28496
  :param _ScheduledSqlContent: 查询语句
27780
28497
  :type ScheduledSqlContent: str
27781
- :param _ProcessStartTime: 调度开始时间
28498
+ :param _ProcessStartTime: 调度开始时间,格式:yyyy-MM-dd HH:mm:ss
27782
28499
  :type ProcessStartTime: str
27783
28500
  :param _ProcessType: 调度类型,1:持续运行 2:指定时间范围
27784
28501
  :type ProcessType: int
27785
- :param _ProcessEndTime: 调度结束时间,当process_type=2时为必传字段
28502
+ :param _ProcessEndTime: 调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段
27786
28503
  :type ProcessEndTime: str
27787
- :param _ProcessPeriod: 调度周期(分钟)
28504
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
27788
28505
  :type ProcessPeriod: int
27789
28506
  :param _ProcessTimeWindow: 查询的时间窗口. @m-15m, @m,意为近15分钟
27790
28507
  :type ProcessTimeWindow: str
27791
- :param _ProcessDelay: 执行延迟(秒)
28508
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
27792
28509
  :type ProcessDelay: int
27793
- :param _SrcTopicRegion: 源topicId的地域信息
28510
+ :param _SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
27794
28511
  :type SrcTopicRegion: str
27795
28512
  :param _SyntaxRule: 语法规则,0:Lucene语法,1:CQL语法
27796
28513
  :type SyntaxRule: int
@@ -27877,7 +28594,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27877
28594
 
27878
28595
  @property
27879
28596
  def CreateTime(self):
27880
- """任务创建时间
28597
+ """任务创建时间。格式:yyyy-MM-dd HH:mm:ss
27881
28598
  :rtype: str
27882
28599
  """
27883
28600
  return self._CreateTime
@@ -27888,7 +28605,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27888
28605
 
27889
28606
  @property
27890
28607
  def UpdateTime(self):
27891
- """任务更新时间
28608
+ """任务更新时间,格式:yyyy-MM-dd HH:mm:ss
27892
28609
  :rtype: str
27893
28610
  """
27894
28611
  return self._UpdateTime
@@ -27934,7 +28651,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27934
28651
 
27935
28652
  @property
27936
28653
  def ProcessStartTime(self):
27937
- """调度开始时间
28654
+ """调度开始时间,格式:yyyy-MM-dd HH:mm:ss
27938
28655
  :rtype: str
27939
28656
  """
27940
28657
  return self._ProcessStartTime
@@ -27956,7 +28673,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27956
28673
 
27957
28674
  @property
27958
28675
  def ProcessEndTime(self):
27959
- """调度结束时间,当process_type=2时为必传字段
28676
+ """调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段
27960
28677
  :rtype: str
27961
28678
  """
27962
28679
  return self._ProcessEndTime
@@ -27967,7 +28684,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27967
28684
 
27968
28685
  @property
27969
28686
  def ProcessPeriod(self):
27970
- """调度周期(分钟)
28687
+ """调度周期(分钟),1~1440分钟
27971
28688
  :rtype: int
27972
28689
  """
27973
28690
  return self._ProcessPeriod
@@ -27989,7 +28706,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27989
28706
 
27990
28707
  @property
27991
28708
  def ProcessDelay(self):
27992
- """执行延迟(秒)
28709
+ """执行延迟(秒),0~120秒,默认60秒
27993
28710
  :rtype: int
27994
28711
  """
27995
28712
  return self._ProcessDelay
@@ -28000,7 +28717,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
28000
28717
 
28001
28718
  @property
28002
28719
  def SrcTopicRegion(self):
28003
- """源topicId的地域信息
28720
+ """源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
28004
28721
  :rtype: str
28005
28722
  """
28006
28723
  return self._SrcTopicRegion
@@ -30006,6 +30723,7 @@ class TopicInfo(AbstractModel):
30006
30723
  :param _AssumerName: 云产品标识,主题由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
30007
30724
  :type AssumerName: str
30008
30725
  :param _CreateTime: 创建时间
30726
+ 时间格式:yyyy-MM-dd HH:mm:ss
30009
30727
  :type CreateTime: str
30010
30728
  :param _Status: 主题是否开启采集,true:开启采集;false:关闭采集。
30011
30729
  创建日志主题时默认开启,可通过SDK调用ModifyTopic修改此字段。
@@ -30044,8 +30762,13 @@ HotPeriod=0为没有开启日志沉降。
30044
30762
  :param _TopicAsyncTaskID: 异步迁移任务ID
30045
30763
  :type TopicAsyncTaskID: str
30046
30764
  :param _MigrationStatus: 异步迁移状态
30765
+ - 1:进行中
30766
+ - 2:已完成
30767
+ - 3:失败
30768
+ - 4:已取消
30047
30769
  :type MigrationStatus: int
30048
30770
  :param _EffectiveDate: 异步迁移完成后,预计生效日期
30771
+ 时间格式:yyyy-MM-dd HH:mm:ss
30049
30772
  :type EffectiveDate: str
30050
30773
  """
30051
30774
  self._LogsetId = None
@@ -30140,6 +30863,7 @@ HotPeriod=0为没有开启日志沉降。
30140
30863
  @property
30141
30864
  def CreateTime(self):
30142
30865
  """创建时间
30866
+ 时间格式:yyyy-MM-dd HH:mm:ss
30143
30867
  :rtype: str
30144
30868
  """
30145
30869
  return self._CreateTime
@@ -30304,6 +31028,10 @@ HotPeriod=0为没有开启日志沉降。
30304
31028
  @property
30305
31029
  def MigrationStatus(self):
30306
31030
  """异步迁移状态
31031
+ - 1:进行中
31032
+ - 2:已完成
31033
+ - 3:失败
31034
+ - 4:已取消
30307
31035
  :rtype: int
30308
31036
  """
30309
31037
  return self._MigrationStatus
@@ -30315,6 +31043,7 @@ HotPeriod=0为没有开启日志沉降。
30315
31043
  @property
30316
31044
  def EffectiveDate(self):
30317
31045
  """异步迁移完成后,预计生效日期
31046
+ 时间格式:yyyy-MM-dd HH:mm:ss
30318
31047
  :rtype: str
30319
31048
  """
30320
31049
  return self._EffectiveDate