tencentcloud-sdk-python 3.0.1441__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 (47) 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 +1063 -246
  8. tencentcloud/common/credential.py +20 -2
  9. tencentcloud/dlc/v20210125/models.py +6 -6
  10. tencentcloud/dnspod/v20210323/errorcodes.py +3 -0
  11. tencentcloud/dnspod/v20210323/models.py +17 -2
  12. tencentcloud/es/v20180416/models.py +30 -0
  13. tencentcloud/ess/v20201111/ess_client.py +3 -1
  14. tencentcloud/ess/v20201111/models.py +65 -4
  15. tencentcloud/essbasic/v20210526/essbasic_client.py +3 -1
  16. tencentcloud/essbasic/v20210526/models.py +63 -2
  17. tencentcloud/faceid/v20180301/models.py +96 -4
  18. tencentcloud/iai/v20200303/models.py +19 -0
  19. tencentcloud/lighthouse/v20200324/errorcodes.py +27 -0
  20. tencentcloud/lighthouse/v20200324/lighthouse_client.py +53 -0
  21. tencentcloud/lighthouse/v20200324/models.py +534 -0
  22. tencentcloud/live/v20180801/models.py +2 -10
  23. tencentcloud/lke/v20231130/lke_client.py +0 -23
  24. tencentcloud/lke/v20231130/models.py +40 -128
  25. tencentcloud/mariadb/v20170312/models.py +2 -2
  26. tencentcloud/ocr/v20181119/models.py +34 -0
  27. tencentcloud/organization/v20210331/models.py +24 -26
  28. tencentcloud/ssl/v20191205/models.py +2 -2
  29. tencentcloud/tbaas/v20180416/errorcodes.py +6 -0
  30. tencentcloud/teo/v20220901/models.py +18 -18
  31. tencentcloud/tms/v20201229/errorcodes.py +3 -0
  32. tencentcloud/trtc/v20190722/errorcodes.py +15 -0
  33. tencentcloud/trtc/v20190722/models.py +482 -0
  34. tencentcloud/trtc/v20190722/trtc_client.py +64 -0
  35. tencentcloud/tse/v20201207/models.py +30 -0
  36. tencentcloud/tsf/v20180326/errorcodes.py +38 -17
  37. tencentcloud/tsf/v20180326/models.py +976 -778
  38. tencentcloud/tsf/v20180326/tsf_client.py +18 -18
  39. tencentcloud/vod/v20180717/models.py +15 -0
  40. tencentcloud/vpc/v20170312/models.py +35 -0
  41. tencentcloud/vpc/v20170312/vpc_client.py +1 -1
  42. tencentcloud/wsa/v20250508/models.py +42 -6
  43. {tencentcloud_sdk_python-3.0.1441.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/METADATA +1 -1
  44. {tencentcloud_sdk_python-3.0.1441.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/RECORD +47 -47
  45. {tencentcloud_sdk_python-3.0.1441.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/LICENSE +0 -0
  46. {tencentcloud_sdk_python-3.0.1441.dist-info → tencentcloud_sdk_python-3.0.1443.dist-info}/WHEEL +0 -0
  47. {tencentcloud_sdk_python-3.0.1441.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
@@ -2310,6 +2326,8 @@ class CheckRechargeKafkaServerRequest(AbstractModel):
2310
2326
  :type KafkaType: int
2311
2327
  :param _KafkaInstance: 腾讯云CKafka实例ID。
2312
2328
  KafkaType为0时,KafkaInstance必填
2329
+
2330
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
2313
2331
  :type KafkaInstance: str
2314
2332
  :param _ServerAddr: 服务地址。
2315
2333
  KafkaType为1时,ServerAddr必填
@@ -2340,6 +2358,8 @@ KafkaType为1时,ServerAddr必填
2340
2358
  def KafkaInstance(self):
2341
2359
  """腾讯云CKafka实例ID。
2342
2360
  KafkaType为0时,KafkaInstance必填
2361
+
2362
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
2343
2363
  :rtype: str
2344
2364
  """
2345
2365
  return self._KafkaInstance
@@ -2408,7 +2428,20 @@ class CheckRechargeKafkaServerResponse(AbstractModel):
2408
2428
 
2409
2429
  def __init__(self):
2410
2430
  r"""
2411
- :param _Status: Kafka集群可访问状态,0:可正常访问 ...
2431
+ :param _Status: Kafka集群可访问状态。
2432
+
2433
+ - 0:可正常访问
2434
+ - -1:broker 连接失败
2435
+ - -2:sasl 鉴权失败
2436
+ - -3:ckafka 角色未授权
2437
+ - -4:topic 列表不存在
2438
+ - -5:topic 内暂无数据
2439
+ - -6:用户没有 ckafka 权限
2440
+ - -7:消费组已经存在
2441
+ - -8:kafka 实例不存在或已销毁
2442
+ - -9:Broker 列表为空
2443
+ - -10:Broker 地址格式不正确
2444
+ - -11:Broker 端口非整型
2412
2445
  :type Status: int
2413
2446
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2414
2447
  :type RequestId: str
@@ -2418,7 +2451,20 @@ class CheckRechargeKafkaServerResponse(AbstractModel):
2418
2451
 
2419
2452
  @property
2420
2453
  def Status(self):
2421
- """Kafka集群可访问状态,0:可正常访问 ...
2454
+ """Kafka集群可访问状态。
2455
+
2456
+ - 0:可正常访问
2457
+ - -1:broker 连接失败
2458
+ - -2:sasl 鉴权失败
2459
+ - -3:ckafka 角色未授权
2460
+ - -4:topic 列表不存在
2461
+ - -5:topic 内暂无数据
2462
+ - -6:用户没有 ckafka 权限
2463
+ - -7:消费组已经存在
2464
+ - -8:kafka 实例不存在或已销毁
2465
+ - -9:Broker 列表为空
2466
+ - -10:Broker 地址格式不正确
2467
+ - -11:Broker 端口非整型
2422
2468
  :rtype: int
2423
2469
  """
2424
2470
  return self._Status
@@ -2451,17 +2497,31 @@ class Ckafka(AbstractModel):
2451
2497
 
2452
2498
  def __init__(self):
2453
2499
  r"""
2454
- :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。
2455
2503
  :type InstanceId: str
2456
- :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。
2457
2507
  :type TopicName: str
2458
- :param _Vip: Ckafka 的 Vip
2508
+ :param _Vip: Ckafka 的 Vip
2509
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
2510
+ - 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
2459
2511
  :type Vip: str
2460
- :param _Vport: Ckafka 的 Vport
2512
+ :param _Vport: Ckafka 的 Vport
2513
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
2514
+ - 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
2461
2515
  :type Vport: str
2462
- :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字段可为空。
2463
2520
  :type InstanceName: str
2464
- :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字段可为空。
2465
2525
  :type TopicId: str
2466
2526
  """
2467
2527
  self._InstanceId = None
@@ -2473,7 +2533,9 @@ class Ckafka(AbstractModel):
2473
2533
 
2474
2534
  @property
2475
2535
  def InstanceId(self):
2476
- """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。
2477
2539
  :rtype: str
2478
2540
  """
2479
2541
  return self._InstanceId
@@ -2484,7 +2546,9 @@ class Ckafka(AbstractModel):
2484
2546
 
2485
2547
  @property
2486
2548
  def TopicName(self):
2487
- """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。
2488
2552
  :rtype: str
2489
2553
  """
2490
2554
  return self._TopicName
@@ -2495,7 +2559,9 @@ class Ckafka(AbstractModel):
2495
2559
 
2496
2560
  @property
2497
2561
  def Vip(self):
2498
- """Ckafka 的 Vip
2562
+ """Ckafka 的 Vip
2563
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
2564
+ - 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
2499
2565
  :rtype: str
2500
2566
  """
2501
2567
  return self._Vip
@@ -2506,7 +2572,9 @@ class Ckafka(AbstractModel):
2506
2572
 
2507
2573
  @property
2508
2574
  def Vport(self):
2509
- """Ckafka 的 Vport
2575
+ """Ckafka 的 Vport
2576
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
2577
+ - 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
2510
2578
  :rtype: str
2511
2579
  """
2512
2580
  return self._Vport
@@ -2517,7 +2585,10 @@ class Ckafka(AbstractModel):
2517
2585
 
2518
2586
  @property
2519
2587
  def InstanceName(self):
2520
- """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字段可为空。
2521
2592
  :rtype: str
2522
2593
  """
2523
2594
  return self._InstanceName
@@ -2528,7 +2599,10 @@ class Ckafka(AbstractModel):
2528
2599
 
2529
2600
  @property
2530
2601
  def TopicId(self):
2531
- """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字段可为空。
2532
2606
  :rtype: str
2533
2607
  """
2534
2608
  return self._TopicId
@@ -2562,14 +2636,18 @@ class CloseKafkaConsumerRequest(AbstractModel):
2562
2636
 
2563
2637
  def __init__(self):
2564
2638
  r"""
2565
- :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。
2566
2642
  :type FromTopicId: str
2567
2643
  """
2568
2644
  self._FromTopicId = None
2569
2645
 
2570
2646
  @property
2571
2647
  def FromTopicId(self):
2572
- """日志主题ID
2648
+ """日志主题Id。
2649
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2650
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2573
2651
  :rtype: str
2574
2652
  """
2575
2653
  return self._FromTopicId
@@ -3019,7 +3097,10 @@ class ConfigExtraInfo(AbstractModel):
3019
3097
  :type Name: str
3020
3098
  :param _TopicId: 日志主题ID
3021
3099
  :type TopicId: str
3022
- :param _Type: 类型:container_stdout、container_file、host_file
3100
+ :param _Type: 自建k8s集群日志采集类型,支持
3101
+ - container_stdout 标准输出
3102
+ - container_file 标准文件
3103
+ - host_file 节点文件
3023
3104
  :type Type: str
3024
3105
  :param _HostFile: 节点文件配置信息
3025
3106
  :type HostFile: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
@@ -3037,16 +3118,20 @@ class ConfigExtraInfo(AbstractModel):
3037
3118
  注意:此字段可能返回 null,表示取不到有效值。
3038
3119
  :type ExcludePaths: list of ExcludePathInfo
3039
3120
  :param _UpdateTime: 更新时间
3121
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3040
3122
  :type UpdateTime: str
3041
3123
  :param _CreateTime: 创建时间
3124
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3042
3125
  :type CreateTime: str
3043
3126
  :param _UserDefineRule: 用户自定义解析字符串
3044
3127
  :type UserDefineRule: str
3045
3128
  :param _GroupId: 机器组ID
3129
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
3046
3130
  :type GroupId: str
3047
3131
  :param _ConfigFlag: 自建采集配置标
3048
3132
  :type ConfigFlag: str
3049
3133
  :param _LogsetId: 日志集ID
3134
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
3050
3135
  :type LogsetId: str
3051
3136
  :param _LogsetName: 日志集name
3052
3137
  :type LogsetName: str
@@ -3118,7 +3203,10 @@ class ConfigExtraInfo(AbstractModel):
3118
3203
 
3119
3204
  @property
3120
3205
  def Type(self):
3121
- """类型:container_stdout、container_file、host_file
3206
+ """自建k8s集群日志采集类型,支持
3207
+ - container_stdout 标准输出
3208
+ - container_file 标准文件
3209
+ - host_file 节点文件
3122
3210
  :rtype: str
3123
3211
  """
3124
3212
  return self._Type
@@ -3208,6 +3296,7 @@ class ConfigExtraInfo(AbstractModel):
3208
3296
  @property
3209
3297
  def UpdateTime(self):
3210
3298
  """更新时间
3299
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3211
3300
  :rtype: str
3212
3301
  """
3213
3302
  return self._UpdateTime
@@ -3219,6 +3308,7 @@ class ConfigExtraInfo(AbstractModel):
3219
3308
  @property
3220
3309
  def CreateTime(self):
3221
3310
  """创建时间
3311
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3222
3312
  :rtype: str
3223
3313
  """
3224
3314
  return self._CreateTime
@@ -3241,6 +3331,7 @@ class ConfigExtraInfo(AbstractModel):
3241
3331
  @property
3242
3332
  def GroupId(self):
3243
3333
  """机器组ID
3334
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
3244
3335
  :rtype: str
3245
3336
  """
3246
3337
  return self._GroupId
@@ -3263,6 +3354,7 @@ class ConfigExtraInfo(AbstractModel):
3263
3354
  @property
3264
3355
  def LogsetId(self):
3265
3356
  """日志集ID
3357
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
3266
3358
  :rtype: str
3267
3359
  """
3268
3360
  return self._LogsetId
@@ -3404,8 +3496,10 @@ class ConfigInfo(AbstractModel):
3404
3496
  :param _Output: 采集配置所属日志主题ID即TopicId
3405
3497
  :type Output: str
3406
3498
  :param _UpdateTime: 更新时间
3499
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3407
3500
  :type UpdateTime: str
3408
3501
  :param _CreateTime: 创建时间
3502
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3409
3503
  :type CreateTime: str
3410
3504
  :param _UserDefineRule: 用户自定义解析字符串,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310)。
3411
3505
  :type UserDefineRule: str
@@ -3533,6 +3627,7 @@ class ConfigInfo(AbstractModel):
3533
3627
  @property
3534
3628
  def UpdateTime(self):
3535
3629
  """更新时间
3630
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3536
3631
  :rtype: str
3537
3632
  """
3538
3633
  return self._UpdateTime
@@ -3544,6 +3639,7 @@ class ConfigInfo(AbstractModel):
3544
3639
  @property
3545
3640
  def CreateTime(self):
3546
3641
  """创建时间
3642
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3547
3643
  :rtype: str
3548
3644
  """
3549
3645
  return self._CreateTime
@@ -3847,6 +3943,169 @@ class ConsoleSharingConfig(AbstractModel):
3847
3943
 
3848
3944
 
3849
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
+
3850
4109
  class ConsoleSharingParam(AbstractModel):
3851
4110
  """控制台分享链接params参数
3852
4111
 
@@ -4377,7 +4636,12 @@ class ContainerWorkLoadInfo(AbstractModel):
4377
4636
 
4378
4637
  def __init__(self):
4379
4638
  r"""
4380
- :param _Kind: 工作负载的类型
4639
+ :param _Kind: 工作负载的类型,支持
4640
+ - deployment
4641
+ - statefulset
4642
+ - daemonset
4643
+ - job
4644
+ - cronjob
4381
4645
  :type Kind: str
4382
4646
  :param _Name: 工作负载的名称
4383
4647
  :type Name: str
@@ -4393,7 +4657,12 @@ class ContainerWorkLoadInfo(AbstractModel):
4393
4657
 
4394
4658
  @property
4395
4659
  def Kind(self):
4396
- """工作负载的类型
4660
+ """工作负载的类型,支持
4661
+ - deployment
4662
+ - statefulset
4663
+ - daemonset
4664
+ - job
4665
+ - cronjob
4397
4666
  :rtype: str
4398
4667
  """
4399
4668
  return self._Kind
@@ -5676,12 +5945,13 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5676
5945
  def __init__(self):
5677
5946
  r"""
5678
5947
  :param _InstanceId: 实例ID
5948
+ - 通过各个接入云产品官方文档获取
5679
5949
  :type InstanceId: str
5680
5950
  :param _AssumerName: 云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS
5681
5951
  :type AssumerName: str
5682
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
5683
5953
  :type LogType: str
5684
- :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
5954
+ :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
5685
5955
  - CDS所有日志类型:ap-guangzhou
5686
5956
  - CDB-AUDIT: gz
5687
5957
  - TDSQL-C-AUDIT: gz
@@ -5696,16 +5966,19 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5696
5966
  - APIS所有日志类型:gz
5697
5967
  :type CloudProductRegion: str
5698
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) 文档
5699
5970
  :type ClsRegion: str
5700
5971
  :param _LogsetName: 日志集名称,未填LogsetId时必填。若日志集不存在, 将自动创建
5701
5972
  :type LogsetName: str
5702
5973
  :param _TopicName: 日志主题名称,在未填TopicId时必填。 若日志主题不存在,将自动创建
5703
5974
  :type TopicName: str
5704
- :param _Extend: 日志配置拓展信息, 一般用于存储额外的日志投递配置
5975
+ :param _Extend: 日志配置扩展信息, 一般用于存储额外的日志投递配置
5705
5976
  :type Extend: str
5706
5977
  :param _LogsetId: 日志集id
5978
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
5707
5979
  :type LogsetId: str
5708
5980
  :param _TopicId: 日志主题id
5981
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5709
5982
  :type TopicId: str
5710
5983
  """
5711
5984
  self._InstanceId = None
@@ -5722,6 +5995,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5722
5995
  @property
5723
5996
  def InstanceId(self):
5724
5997
  """实例ID
5998
+ - 通过各个接入云产品官方文档获取
5725
5999
  :rtype: str
5726
6000
  """
5727
6001
  return self._InstanceId
@@ -5754,7 +6028,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5754
6028
 
5755
6029
  @property
5756
6030
  def CloudProductRegion(self):
5757
- """云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
6031
+ """云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
5758
6032
  - CDS所有日志类型:ap-guangzhou
5759
6033
  - CDB-AUDIT: gz
5760
6034
  - TDSQL-C-AUDIT: gz
@@ -5778,6 +6052,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5778
6052
  @property
5779
6053
  def ClsRegion(self):
5780
6054
  """CLS目标地域
6055
+ - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
5781
6056
  :rtype: str
5782
6057
  """
5783
6058
  return self._ClsRegion
@@ -5810,7 +6085,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5810
6085
 
5811
6086
  @property
5812
6087
  def Extend(self):
5813
- """日志配置拓展信息, 一般用于存储额外的日志投递配置
6088
+ """日志配置扩展信息, 一般用于存储额外的日志投递配置
5814
6089
  :rtype: str
5815
6090
  """
5816
6091
  return self._Extend
@@ -5822,6 +6097,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5822
6097
  @property
5823
6098
  def LogsetId(self):
5824
6099
  """日志集id
6100
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
5825
6101
  :rtype: str
5826
6102
  """
5827
6103
  return self._LogsetId
@@ -5833,6 +6109,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5833
6109
  @property
5834
6110
  def TopicId(self):
5835
6111
  """日志主题id
6112
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5836
6113
  :rtype: str
5837
6114
  """
5838
6115
  return self._TopicId
@@ -6381,8 +6658,11 @@ class CreateConfigRequest(AbstractModel):
6381
6658
  def __init__(self):
6382
6659
  r"""
6383
6660
  :param _Name: 采集配置名称
6661
+ - 名称种不得包含特殊字符|
6662
+ - 名称最长255字符,超过截断
6384
6663
  :type Name: str
6385
6664
  :param _Output: 采集配置所属日志主题ID即TopicId
6665
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6386
6666
  :type Output: str
6387
6667
  :param _Path: 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
6388
6668
  :type Path: str
@@ -6425,6 +6705,8 @@ class CreateConfigRequest(AbstractModel):
6425
6705
  @property
6426
6706
  def Name(self):
6427
6707
  """采集配置名称
6708
+ - 名称种不得包含特殊字符|
6709
+ - 名称最长255字符,超过截断
6428
6710
  :rtype: str
6429
6711
  """
6430
6712
  return self._Name
@@ -6436,6 +6718,7 @@ class CreateConfigRequest(AbstractModel):
6436
6718
  @property
6437
6719
  def Output(self):
6438
6720
  """采集配置所属日志主题ID即TopicId
6721
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6439
6722
  :rtype: str
6440
6723
  """
6441
6724
  return self._Output
@@ -6699,7 +6982,9 @@ class CreateConsumerRequest(AbstractModel):
6699
6982
 
6700
6983
  def __init__(self):
6701
6984
  r"""
6702
- :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。
6703
6988
  :type TopicId: str
6704
6989
  :param _NeedContent: 是否投递日志的元数据信息,默认为 true。
6705
6990
  当NeedContent为true时:字段Content有效。
@@ -6720,7 +7005,9 @@ class CreateConsumerRequest(AbstractModel):
6720
7005
 
6721
7006
  @property
6722
7007
  def TopicId(self):
6723
- """投递任务绑定的日志主题 ID
7008
+ """投递任务绑定的日志主题Id。
7009
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
7010
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
6724
7011
  :rtype: str
6725
7012
  """
6726
7013
  return self._TopicId
@@ -7077,10 +7364,21 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7077
7364
  def __init__(self):
7078
7365
  r"""
7079
7366
  :param _Name: 仪表盘订阅名称。
7367
+ 输入限制:
7368
+ - 不能为空
7369
+ - 长度不能超过128字节
7370
+ - 不能包含字符'|'
7080
7371
  :type Name: str
7081
- :param _DashboardId: 仪表盘id
7372
+ :param _DashboardId: 仪表盘Id
7373
+ - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
7082
7374
  :type DashboardId: str
7083
- :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星期六】
7084
7382
  :type Cron: str
7085
7383
  :param _SubscribeData: 仪表盘订阅数据。
7086
7384
  :type SubscribeData: :class:`tencentcloud.cls.v20201016.models.DashboardSubscribeData`
@@ -7093,6 +7391,10 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7093
7391
  @property
7094
7392
  def Name(self):
7095
7393
  """仪表盘订阅名称。
7394
+ 输入限制:
7395
+ - 不能为空
7396
+ - 长度不能超过128字节
7397
+ - 不能包含字符'|'
7096
7398
  :rtype: str
7097
7399
  """
7098
7400
  return self._Name
@@ -7103,7 +7405,8 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7103
7405
 
7104
7406
  @property
7105
7407
  def DashboardId(self):
7106
- """仪表盘id
7408
+ """仪表盘Id
7409
+ - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
7107
7410
  :rtype: str
7108
7411
  """
7109
7412
  return self._DashboardId
@@ -7114,7 +7417,13 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7114
7417
 
7115
7418
  @property
7116
7419
  def Cron(self):
7117
- """订阅时间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星期六】
7118
7427
  :rtype: str
7119
7428
  """
7120
7429
  return self._Cron
@@ -7408,17 +7717,22 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7408
7717
 
7409
7718
  def __init__(self):
7410
7719
  r"""
7411
- :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。
7412
7723
  :type TopicId: str
7413
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) 获取函数信息。
7414
7726
  :type FunctionName: str
7415
- :param _Namespace: 命名空间
7727
+ :param _Namespace: 命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
7728
+ - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
7416
7729
  :type Namespace: str
7417
- :param _Qualifier: 函数版本
7730
+ :param _Qualifier: 函数版本。
7731
+ - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
7418
7732
  :type Qualifier: str
7419
- :param _Timeout: 投递最长等待时间,单位:秒
7733
+ :param _Timeout: 投递最长等待时间,单位:秒。 默认:60
7420
7734
  :type Timeout: int
7421
- :param _MaxMsgNum: 投递最大消息数
7735
+ :param _MaxMsgNum: 投递最大消息数。默认为100。支持范围[1,10000]
7422
7736
  :type MaxMsgNum: int
7423
7737
  """
7424
7738
  self._TopicId = None
@@ -7430,7 +7744,9 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7430
7744
 
7431
7745
  @property
7432
7746
  def TopicId(self):
7433
- """投递规则属于的 topic id
7747
+ """投递规则属于的TopicId。
7748
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
7749
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7434
7750
  :rtype: str
7435
7751
  """
7436
7752
  return self._TopicId
@@ -7442,6 +7758,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7442
7758
  @property
7443
7759
  def FunctionName(self):
7444
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) 获取函数信息。
7445
7762
  :rtype: str
7446
7763
  """
7447
7764
  return self._FunctionName
@@ -7452,7 +7769,8 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7452
7769
 
7453
7770
  @property
7454
7771
  def Namespace(self):
7455
- """命名空间
7772
+ """命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
7773
+ - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
7456
7774
  :rtype: str
7457
7775
  """
7458
7776
  return self._Namespace
@@ -7463,7 +7781,8 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7463
7781
 
7464
7782
  @property
7465
7783
  def Qualifier(self):
7466
- """函数版本
7784
+ """函数版本。
7785
+ - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
7467
7786
  :rtype: str
7468
7787
  """
7469
7788
  return self._Qualifier
@@ -7474,7 +7793,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7474
7793
 
7475
7794
  @property
7476
7795
  def Timeout(self):
7477
- """投递最长等待时间,单位:秒
7796
+ """投递最长等待时间,单位:秒。 默认:60
7478
7797
  :rtype: int
7479
7798
  """
7480
7799
  return self._Timeout
@@ -7485,7 +7804,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7485
7804
 
7486
7805
  @property
7487
7806
  def MaxMsgNum(self):
7488
- """投递最大消息数
7807
+ """投递最大消息数。默认为100。支持范围[1,10000]
7489
7808
  :rtype: int
7490
7809
  """
7491
7810
  return self._MaxMsgNum
@@ -7547,7 +7866,8 @@ class CreateExportRequest(AbstractModel):
7547
7866
 
7548
7867
  def __init__(self):
7549
7868
  r"""
7550
- :param _TopicId: 日志主题ID
7869
+ :param _TopicId: 日志主题Id
7870
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7551
7871
  :type TopicId: str
7552
7872
  :param _Count: 日志导出数量, 最大值5000万
7553
7873
  :type Count: int
@@ -7579,7 +7899,8 @@ class CreateExportRequest(AbstractModel):
7579
7899
 
7580
7900
  @property
7581
7901
  def TopicId(self):
7582
- """日志主题ID
7902
+ """日志主题Id
7903
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7583
7904
  :rtype: str
7584
7905
  """
7585
7906
  return self._TopicId
@@ -7886,7 +8207,9 @@ class CreateKafkaRechargeRequest(AbstractModel):
7886
8207
 
7887
8208
  def __init__(self):
7888
8209
  r"""
7889
- :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。
7890
8213
  :type TopicId: str
7891
8214
  :param _Name: Kafka导入配置名称
7892
8215
  :type Name: str
@@ -7899,6 +8222,7 @@ class CreateKafkaRechargeRequest(AbstractModel):
7899
8222
  :param _LogRechargeRule: 日志导入规则。
7900
8223
  :type LogRechargeRule: :class:`tencentcloud.cls.v20201016.models.LogRechargeRuleInfo`
7901
8224
  :param _KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填。
8225
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
7902
8226
  :type KafkaInstance: str
7903
8227
  :param _ServerAddr: 服务地址,KafkaType为1时必填。
7904
8228
  :type ServerAddr: str
@@ -7907,7 +8231,8 @@ class CreateKafkaRechargeRequest(AbstractModel):
7907
8231
  :param _Protocol: 加密访问协议。
7908
8232
  KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
7909
8233
  :type Protocol: :class:`tencentcloud.cls.v20201016.models.KafkaProtocolInfo`
7910
- :param _ConsumerGroupName: 用户Kafka消费组名称
8234
+ :param _ConsumerGroupName: 用户Kafka消费组名称。
8235
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
7911
8236
  :type ConsumerGroupName: str
7912
8237
  """
7913
8238
  self._TopicId = None
@@ -7924,7 +8249,9 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
7924
8249
 
7925
8250
  @property
7926
8251
  def TopicId(self):
7927
- """导入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。
7928
8255
  :rtype: str
7929
8256
  """
7930
8257
  return self._TopicId
@@ -7991,6 +8318,7 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
7991
8318
  @property
7992
8319
  def KafkaInstance(self):
7993
8320
  """腾讯云CKafka实例ID,KafkaType为0时必填。
8321
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
7994
8322
  :rtype: str
7995
8323
  """
7996
8324
  return self._KafkaInstance
@@ -8035,7 +8363,8 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
8035
8363
 
8036
8364
  @property
8037
8365
  def ConsumerGroupName(self):
8038
- """用户Kafka消费组名称
8366
+ """用户Kafka消费组名称。
8367
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
8039
8368
  :rtype: str
8040
8369
  """
8041
8370
  return self._ConsumerGroupName
@@ -8587,9 +8916,9 @@ class CreateScheduledSqlRequest(AbstractModel):
8587
8916
 
8588
8917
  def __init__(self):
8589
8918
  r"""
8590
- :param _SrcTopicId: 源日志主题
8919
+ :param _SrcTopicId: 源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8591
8920
  :type SrcTopicId: str
8592
- :param _Name: 任务名称
8921
+ :param _Name: 任务名称,0~255字符
8593
8922
  :type Name: str
8594
8923
  :param _EnableFlag: 任务启动状态. 1开启, 2关闭
8595
8924
  :type EnableFlag: int
@@ -8601,13 +8930,13 @@ class CreateScheduledSqlRequest(AbstractModel):
8601
8930
  :type ProcessStartTime: int
8602
8931
  :param _ProcessType: 调度类型,1:持续运行 2:指定时间范围
8603
8932
  :type ProcessType: int
8604
- :param _ProcessPeriod: 调度周期(分钟)
8933
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
8605
8934
  :type ProcessPeriod: int
8606
8935
  :param _ProcessTimeWindow: 单次查询的时间窗口,如果您的目标主题为指标主题,建议该参数的大小不超过30分钟,否则可能转指标失败。
8607
8936
  :type ProcessTimeWindow: str
8608
- :param _ProcessDelay: 执行延迟(秒)
8937
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
8609
8938
  :type ProcessDelay: int
8610
- :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) 文档
8611
8940
  :type SrcTopicRegion: str
8612
8941
  :param _ProcessEndTime: 调度结束时间,当ProcessType=2时为必传字段, Unix时间戳,单位ms
8613
8942
  :type ProcessEndTime: int
@@ -8630,7 +8959,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8630
8959
 
8631
8960
  @property
8632
8961
  def SrcTopicId(self):
8633
- """源日志主题
8962
+ """源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8634
8963
  :rtype: str
8635
8964
  """
8636
8965
  return self._SrcTopicId
@@ -8641,7 +8970,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8641
8970
 
8642
8971
  @property
8643
8972
  def Name(self):
8644
- """任务名称
8973
+ """任务名称,0~255字符
8645
8974
  :rtype: str
8646
8975
  """
8647
8976
  return self._Name
@@ -8707,7 +9036,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8707
9036
 
8708
9037
  @property
8709
9038
  def ProcessPeriod(self):
8710
- """调度周期(分钟)
9039
+ """调度周期(分钟),1~1440分钟
8711
9040
  :rtype: int
8712
9041
  """
8713
9042
  return self._ProcessPeriod
@@ -8729,7 +9058,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8729
9058
 
8730
9059
  @property
8731
9060
  def ProcessDelay(self):
8732
- """执行延迟(秒)
9061
+ """执行延迟(秒),0~120秒,默认60秒
8733
9062
  :rtype: int
8734
9063
  """
8735
9064
  return self._ProcessDelay
@@ -8740,7 +9069,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8740
9069
 
8741
9070
  @property
8742
9071
  def SrcTopicRegion(self):
8743
- """源topicId的地域信息
9072
+ """源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
8744
9073
  :rtype: str
8745
9074
  """
8746
9075
  return self._SrcTopicRegion
@@ -9166,8 +9495,14 @@ class CreateTopicRequest(AbstractModel):
9166
9495
  def __init__(self):
9167
9496
  r"""
9168
9497
  :param _LogsetId: 日志集ID
9498
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
9169
9499
  :type LogsetId: str
9170
9500
  :param _TopicName: 日志主题名称
9501
+ 名称限制
9502
+ - 不能为空字符串
9503
+ - 不能包含字符'|'
9504
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
9505
+
9171
9506
  :type TopicName: str
9172
9507
  :param _PartitionCount: 日志主题分区个数。默认创建1个,最大支持创建10个分区。
9173
9508
  :type PartitionCount: int
@@ -9216,6 +9551,7 @@ class CreateTopicRequest(AbstractModel):
9216
9551
  @property
9217
9552
  def LogsetId(self):
9218
9553
  """日志集ID
9554
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
9219
9555
  :rtype: str
9220
9556
  """
9221
9557
  return self._LogsetId
@@ -9227,6 +9563,11 @@ class CreateTopicRequest(AbstractModel):
9227
9563
  @property
9228
9564
  def TopicName(self):
9229
9565
  """日志主题名称
9566
+ 名称限制
9567
+ - 不能为空字符串
9568
+ - 不能包含字符'|'
9569
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
9570
+
9230
9571
  :rtype: str
9231
9572
  """
9232
9573
  return self._TopicName
@@ -9890,7 +10231,9 @@ class DashboardNoticeMode(AbstractModel):
9890
10231
  <li/>Uin:腾讯云用户<br>
9891
10232
  <li/>Group:腾讯云用户组<br>
9892
10233
  <li/>Email:自定义Email<br>
9893
- <li/>WeCom: 企业微信回调
10234
+ <li/>WeCom: 企业微信回调<br>
10235
+ <li/>DingTalk:钉钉<br>
10236
+ <li/>Lark:飞书
9894
10237
  :type ReceiverType: str
9895
10238
  :param _Values: 知方式对应的值。
9896
10239
  <br> <li/> 当ReceiverType不是 WeCom 时,Values必填。
@@ -9916,7 +10259,9 @@ class DashboardNoticeMode(AbstractModel):
9916
10259
  <li/>Uin:腾讯云用户<br>
9917
10260
  <li/>Group:腾讯云用户组<br>
9918
10261
  <li/>Email:自定义Email<br>
9919
- <li/>WeCom: 企业微信回调
10262
+ <li/>WeCom: 企业微信回调<br>
10263
+ <li/>DingTalk:钉钉<br>
10264
+ <li/>Lark:飞书
9920
10265
  :rtype: str
9921
10266
  """
9922
10267
  return self._ReceiverType
@@ -10718,9 +11063,9 @@ class DeleteAlarmShieldRequest(AbstractModel):
10718
11063
 
10719
11064
  def __init__(self):
10720
11065
  r"""
10721
- :param _TaskId: 屏蔽规则id
11066
+ :param _TaskId: 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
10722
11067
  :type TaskId: str
10723
- :param _AlarmNoticeId: 通知渠道组id
11068
+ :param _AlarmNoticeId: 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
10724
11069
  :type AlarmNoticeId: str
10725
11070
  """
10726
11071
  self._TaskId = None
@@ -10728,7 +11073,7 @@ class DeleteAlarmShieldRequest(AbstractModel):
10728
11073
 
10729
11074
  @property
10730
11075
  def TaskId(self):
10731
- """屏蔽规则id
11076
+ """屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
10732
11077
  :rtype: str
10733
11078
  """
10734
11079
  return self._TaskId
@@ -10739,7 +11084,7 @@ class DeleteAlarmShieldRequest(AbstractModel):
10739
11084
 
10740
11085
  @property
10741
11086
  def AlarmNoticeId(self):
10742
- """通知渠道组id
11087
+ """通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
10743
11088
  :rtype: str
10744
11089
  """
10745
11090
  return self._AlarmNoticeId
@@ -10803,7 +11148,7 @@ class DeleteCloudProductLogCollectionRequest(AbstractModel):
10803
11148
  :type AssumerName: str
10804
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
10805
11150
  :type LogType: str
10806
- :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
11151
+ :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
10807
11152
  - CDS所有日志类型:ap-guangzhou
10808
11153
  - CDB-AUDIT: gz
10809
11154
  - TDSQL-C-AUDIT: gz
@@ -10858,7 +11203,7 @@ class DeleteCloudProductLogCollectionRequest(AbstractModel):
10858
11203
 
10859
11204
  @property
10860
11205
  def CloudProductRegion(self):
10861
- """云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
11206
+ """云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
10862
11207
  - CDS所有日志类型:ap-guangzhou
10863
11208
  - CDB-AUDIT: gz
10864
11209
  - TDSQL-C-AUDIT: gz
@@ -10946,6 +11291,7 @@ class DeleteConfigExtraRequest(AbstractModel):
10946
11291
  def __init__(self):
10947
11292
  r"""
10948
11293
  :param _ConfigExtraId: 特殊采集规则扩展配置ID
11294
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
10949
11295
  :type ConfigExtraId: str
10950
11296
  """
10951
11297
  self._ConfigExtraId = None
@@ -10953,6 +11299,7 @@ class DeleteConfigExtraRequest(AbstractModel):
10953
11299
  @property
10954
11300
  def ConfigExtraId(self):
10955
11301
  """特殊采集规则扩展配置ID
11302
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
10956
11303
  :rtype: str
10957
11304
  """
10958
11305
  return self._ConfigExtraId
@@ -11010,8 +11357,10 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11010
11357
  def __init__(self):
11011
11358
  r"""
11012
11359
  :param _GroupId: 机器组ID
11360
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
11013
11361
  :type GroupId: str
11014
11362
  :param _ConfigId: 采集配置ID
11363
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11015
11364
  :type ConfigId: str
11016
11365
  """
11017
11366
  self._GroupId = None
@@ -11020,6 +11369,7 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11020
11369
  @property
11021
11370
  def GroupId(self):
11022
11371
  """机器组ID
11372
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
11023
11373
  :rtype: str
11024
11374
  """
11025
11375
  return self._GroupId
@@ -11031,6 +11381,7 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11031
11381
  @property
11032
11382
  def ConfigId(self):
11033
11383
  """采集配置ID
11384
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11034
11385
  :rtype: str
11035
11386
  """
11036
11387
  return self._ConfigId
@@ -11088,14 +11439,16 @@ class DeleteConfigRequest(AbstractModel):
11088
11439
 
11089
11440
  def __init__(self):
11090
11441
  r"""
11091
- :param _ConfigId: 采集规则配置ID
11442
+ :param _ConfigId: 采集配置ID
11443
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11092
11444
  :type ConfigId: str
11093
11445
  """
11094
11446
  self._ConfigId = None
11095
11447
 
11096
11448
  @property
11097
11449
  def ConfigId(self):
11098
- """采集规则配置ID
11450
+ """采集配置ID
11451
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11099
11452
  :rtype: str
11100
11453
  """
11101
11454
  return self._ConfigId
@@ -11152,14 +11505,18 @@ class DeleteConsoleSharingRequest(AbstractModel):
11152
11505
 
11153
11506
  def __init__(self):
11154
11507
  r"""
11155
- :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。
11156
11511
  :type SharingId: str
11157
11512
  """
11158
11513
  self._SharingId = None
11159
11514
 
11160
11515
  @property
11161
11516
  def SharingId(self):
11162
- """免密分享Id
11517
+ """免密分享Id
11518
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
11519
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
11163
11520
  :rtype: str
11164
11521
  """
11165
11522
  return self._SharingId
@@ -11216,14 +11573,18 @@ class DeleteConsumerRequest(AbstractModel):
11216
11573
 
11217
11574
  def __init__(self):
11218
11575
  r"""
11219
- :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。
11220
11579
  :type TopicId: str
11221
11580
  """
11222
11581
  self._TopicId = None
11223
11582
 
11224
11583
  @property
11225
11584
  def TopicId(self):
11226
- """投递任务绑定的日志主题 ID
11585
+ """投递任务绑定的日志主题Id。
11586
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
11587
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
11227
11588
  :rtype: str
11228
11589
  """
11229
11590
  return self._TopicId
@@ -11427,14 +11788,14 @@ class DeleteDataTransformRequest(AbstractModel):
11427
11788
 
11428
11789
  def __init__(self):
11429
11790
  r"""
11430
- :param _TaskId: 数据加工任务id
11791
+ :param _TaskId: 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
11431
11792
  :type TaskId: str
11432
11793
  """
11433
11794
  self._TaskId = None
11434
11795
 
11435
11796
  @property
11436
11797
  def TaskId(self):
11437
- """数据加工任务id
11798
+ """数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
11438
11799
  :rtype: str
11439
11800
  """
11440
11801
  return self._TaskId
@@ -11491,14 +11852,18 @@ class DeleteExportRequest(AbstractModel):
11491
11852
 
11492
11853
  def __init__(self):
11493
11854
  r"""
11494
- :param _ExportId: 日志导出ID
11855
+ :param _ExportId: 日志导出任务Id
11856
+ - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
11857
+
11495
11858
  :type ExportId: str
11496
11859
  """
11497
11860
  self._ExportId = None
11498
11861
 
11499
11862
  @property
11500
11863
  def ExportId(self):
11501
- """日志导出ID
11864
+ """日志导出任务Id
11865
+ - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
11866
+
11502
11867
  :rtype: str
11503
11868
  """
11504
11869
  return self._ExportId
@@ -11621,9 +11986,13 @@ class DeleteKafkaRechargeRequest(AbstractModel):
11621
11986
 
11622
11987
  def __init__(self):
11623
11988
  r"""
11624
- :param _Id: Kafka导入配置ID
11989
+ :param _Id: Kafka导入配置Id。
11990
+
11991
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
11992
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
11625
11993
  :type Id: str
11626
- :param _TopicId: 导入CLS目标topic ID
11994
+ :param _TopicId: 导入CLS目标日志主题Id。
11995
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
11627
11996
  :type TopicId: str
11628
11997
  """
11629
11998
  self._Id = None
@@ -11631,7 +12000,10 @@ class DeleteKafkaRechargeRequest(AbstractModel):
11631
12000
 
11632
12001
  @property
11633
12002
  def Id(self):
11634
- """Kafka导入配置ID
12003
+ """Kafka导入配置Id。
12004
+
12005
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
12006
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
11635
12007
  :rtype: str
11636
12008
  """
11637
12009
  return self._Id
@@ -11642,7 +12014,8 @@ class DeleteKafkaRechargeRequest(AbstractModel):
11642
12014
 
11643
12015
  @property
11644
12016
  def TopicId(self):
11645
- """导入CLS目标topic ID
12017
+ """导入CLS目标日志主题Id。
12018
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
11646
12019
  :rtype: str
11647
12020
  """
11648
12021
  return self._TopicId
@@ -11764,7 +12137,8 @@ class DeleteMachineGroupInfoRequest(AbstractModel):
11764
12137
 
11765
12138
  def __init__(self):
11766
12139
  r"""
11767
- :param _GroupId: 机器组ID
12140
+ :param _GroupId: 机器组Id
12141
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11768
12142
  :type GroupId: str
11769
12143
  :param _MachineGroupType: 机器组类型
11770
12144
  目前type支持 ip 和 label
@@ -11775,7 +12149,8 @@ class DeleteMachineGroupInfoRequest(AbstractModel):
11775
12149
 
11776
12150
  @property
11777
12151
  def GroupId(self):
11778
- """机器组ID
12152
+ """机器组Id
12153
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11779
12154
  :rtype: str
11780
12155
  """
11781
12156
  return self._GroupId
@@ -11847,14 +12222,16 @@ class DeleteMachineGroupRequest(AbstractModel):
11847
12222
 
11848
12223
  def __init__(self):
11849
12224
  r"""
11850
- :param _GroupId: 机器组ID
12225
+ :param _GroupId: 机器组Id
12226
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11851
12227
  :type GroupId: str
11852
12228
  """
11853
12229
  self._GroupId = None
11854
12230
 
11855
12231
  @property
11856
12232
  def GroupId(self):
11857
- """机器组ID
12233
+ """机器组Id
12234
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11858
12235
  :rtype: str
11859
12236
  """
11860
12237
  return self._GroupId
@@ -11975,9 +12352,9 @@ class DeleteScheduledSqlRequest(AbstractModel):
11975
12352
 
11976
12353
  def __init__(self):
11977
12354
  r"""
11978
- :param _TaskId: 任务ID
12355
+ :param _TaskId: 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
11979
12356
  :type TaskId: str
11980
- :param _SrcTopicId: 源日志主题ID
12357
+ :param _SrcTopicId: 源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
11981
12358
  :type SrcTopicId: str
11982
12359
  """
11983
12360
  self._TaskId = None
@@ -11985,7 +12362,7 @@ class DeleteScheduledSqlRequest(AbstractModel):
11985
12362
 
11986
12363
  @property
11987
12364
  def TaskId(self):
11988
- """任务ID
12365
+ """任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
11989
12366
  :rtype: str
11990
12367
  """
11991
12368
  return self._TaskId
@@ -11996,7 +12373,7 @@ class DeleteScheduledSqlRequest(AbstractModel):
11996
12373
 
11997
12374
  @property
11998
12375
  def SrcTopicId(self):
11999
- """源日志主题ID
12376
+ """源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12000
12377
  :rtype: str
12001
12378
  """
12002
12379
  return self._SrcTopicId
@@ -12121,6 +12498,7 @@ class DeleteTopicRequest(AbstractModel):
12121
12498
  def __init__(self):
12122
12499
  r"""
12123
12500
  :param _TopicId: 日志主题ID
12501
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
12124
12502
  :type TopicId: str
12125
12503
  """
12126
12504
  self._TopicId = None
@@ -12128,6 +12506,7 @@ class DeleteTopicRequest(AbstractModel):
12128
12506
  @property
12129
12507
  def TopicId(self):
12130
12508
  """日志主题ID
12509
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
12131
12510
  :rtype: str
12132
12511
  """
12133
12512
  return self._TopicId
@@ -13185,18 +13564,22 @@ class DescribeConfigExtrasRequest(AbstractModel):
13185
13564
  name
13186
13565
  - 按照【特殊采集配置名称】进行模糊匹配过滤。
13187
13566
  - 类型:String
13567
+ - 示例:test-config
13188
13568
 
13189
13569
  configExtraId
13190
13570
  - 按照【特殊采集配置ID】进行过滤。
13191
13571
  - 类型:String
13572
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13192
13573
 
13193
13574
  topicId
13194
13575
  - 按照【日志主题】进行过滤。
13195
13576
  - 类型:String
13577
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13196
13578
 
13197
13579
  machineGroupId
13198
13580
  - 按照【机器组ID】进行过滤。
13199
13581
  - 类型:String
13582
+ - 示例:f948972f-a063-408c-a59f-8c3230bddaf6
13200
13583
 
13201
13584
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13202
13585
  :type Filters: list of Filter
@@ -13215,18 +13598,22 @@ machineGroupId
13215
13598
  name
13216
13599
  - 按照【特殊采集配置名称】进行模糊匹配过滤。
13217
13600
  - 类型:String
13601
+ - 示例:test-config
13218
13602
 
13219
13603
  configExtraId
13220
13604
  - 按照【特殊采集配置ID】进行过滤。
13221
13605
  - 类型:String
13606
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13222
13607
 
13223
13608
  topicId
13224
13609
  - 按照【日志主题】进行过滤。
13225
13610
  - 类型:String
13611
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13226
13612
 
13227
13613
  machineGroupId
13228
13614
  - 按照【机器组ID】进行过滤。
13229
13615
  - 类型:String
13616
+ - 示例:f948972f-a063-408c-a59f-8c3230bddaf6
13230
13617
 
13231
13618
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13232
13619
  :rtype: list of Filter
@@ -13352,6 +13739,7 @@ class DescribeConfigMachineGroupsRequest(AbstractModel):
13352
13739
  def __init__(self):
13353
13740
  r"""
13354
13741
  :param _ConfigId: 采集配置ID
13742
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
13355
13743
  :type ConfigId: str
13356
13744
  """
13357
13745
  self._ConfigId = None
@@ -13359,6 +13747,7 @@ class DescribeConfigMachineGroupsRequest(AbstractModel):
13359
13747
  @property
13360
13748
  def ConfigId(self):
13361
13749
  """采集配置ID
13750
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
13362
13751
  :rtype: str
13363
13752
  """
13364
13753
  return self._ConfigId
@@ -13441,16 +13830,20 @@ class DescribeConfigsRequest(AbstractModel):
13441
13830
  - 按照【采集配置名称】进行模糊匹配过滤。
13442
13831
  - 类型:String
13443
13832
  - 必选:否
13833
+ - 示例:test-config
13444
13834
 
13445
13835
  configId
13446
13836
  - 按照【采集配置ID】进行过滤。
13447
13837
  - 类型:String
13448
13838
  - 必选:否
13839
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13449
13840
 
13450
13841
  topicId
13451
13842
  - 按照【日志主题】进行过滤。
13452
13843
  - 类型:String
13453
13844
  - 必选:否
13845
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13846
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
13454
13847
 
13455
13848
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13456
13849
  :type Filters: list of Filter
@@ -13469,16 +13862,20 @@ topicId
13469
13862
  - 按照【采集配置名称】进行模糊匹配过滤。
13470
13863
  - 类型:String
13471
13864
  - 必选:否
13865
+ - 示例:test-config
13472
13866
 
13473
13867
  configId
13474
13868
  - 按照【采集配置ID】进行过滤。
13475
13869
  - 类型:String
13476
13870
  - 必选:否
13871
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13477
13872
 
13478
13873
  topicId
13479
13874
  - 按照【日志主题】进行过滤。
13480
13875
  - 类型:String
13481
13876
  - 必选:否
13877
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13878
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
13482
13879
 
13483
13880
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13484
13881
  :rtype: list of Filter
@@ -13611,10 +14008,13 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13611
14008
  r"""
13612
14009
  :param _TotalCount: 分页的总数目
13613
14010
  :type TotalCount: int
14011
+ :param _ConsoleSharingInfos: 控制台免密分享列表
14012
+ :type ConsoleSharingInfos: list of ConsoleSharingInfo
13614
14013
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13615
14014
  :type RequestId: str
13616
14015
  """
13617
14016
  self._TotalCount = None
14017
+ self._ConsoleSharingInfos = None
13618
14018
  self._RequestId = None
13619
14019
 
13620
14020
  @property
@@ -13628,6 +14028,17 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13628
14028
  def TotalCount(self, TotalCount):
13629
14029
  self._TotalCount = TotalCount
13630
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
+
13631
14042
  @property
13632
14043
  def RequestId(self):
13633
14044
  """唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -13642,6 +14053,12 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13642
14053
 
13643
14054
  def _deserialize(self, params):
13644
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)
13645
14062
  self._RequestId = params.get("RequestId")
13646
14063
 
13647
14064
 
@@ -13652,14 +14069,18 @@ class DescribeConsumerRequest(AbstractModel):
13652
14069
 
13653
14070
  def __init__(self):
13654
14071
  r"""
13655
- :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。
13656
14075
  :type TopicId: str
13657
14076
  """
13658
14077
  self._TopicId = None
13659
14078
 
13660
14079
  @property
13661
14080
  def TopicId(self):
13662
- """投递任务绑定的日志主题 ID
14081
+ """投递任务绑定的日志主题Id。
14082
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
14083
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
13663
14084
  :rtype: str
13664
14085
  """
13665
14086
  return self._TopicId
@@ -14458,7 +14879,8 @@ class DescribeExportsRequest(AbstractModel):
14458
14879
 
14459
14880
  def __init__(self):
14460
14881
  r"""
14461
- :param _TopicId: 日志主题ID
14882
+ :param _TopicId: 日志主题Id
14883
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14462
14884
  :type TopicId: str
14463
14885
  :param _Offset: 分页的偏移量,默认值为0
14464
14886
  :type Offset: int
@@ -14471,7 +14893,8 @@ class DescribeExportsRequest(AbstractModel):
14471
14893
 
14472
14894
  @property
14473
14895
  def TopicId(self):
14474
- """日志主题ID
14896
+ """日志主题Id
14897
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14475
14898
  :rtype: str
14476
14899
  """
14477
14900
  return self._TopicId
@@ -14759,14 +15182,18 @@ class DescribeKafkaConsumerRequest(AbstractModel):
14759
15182
 
14760
15183
  def __init__(self):
14761
15184
  r"""
14762
- :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。
14763
15188
  :type FromTopicId: str
14764
15189
  """
14765
15190
  self._FromTopicId = None
14766
15191
 
14767
15192
  @property
14768
15193
  def FromTopicId(self):
14769
- """日志主题ID
15194
+ """日志主题Id。
15195
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
15196
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
14770
15197
  :rtype: str
14771
15198
  """
14772
15199
  return self._FromTopicId
@@ -14885,11 +15312,14 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14885
15312
 
14886
15313
  def __init__(self):
14887
15314
  r"""
14888
- :param _TopicId: 日志主题 ID
15315
+ :param _TopicId: 日志主题Id。
15316
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14889
15317
  :type TopicId: str
14890
- :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。
14891
15321
  :type Id: str
14892
- :param _Status: 状态 status 1: 运行中, 2: 暂停...
15322
+ :param _Status: 状态。1: 运行中,2: 暂停,3:错误
14893
15323
  :type Status: int
14894
15324
  """
14895
15325
  self._TopicId = None
@@ -14898,7 +15328,8 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14898
15328
 
14899
15329
  @property
14900
15330
  def TopicId(self):
14901
- """日志主题 ID
15331
+ """日志主题Id。
15332
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14902
15333
  :rtype: str
14903
15334
  """
14904
15335
  return self._TopicId
@@ -14909,7 +15340,9 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14909
15340
 
14910
15341
  @property
14911
15342
  def Id(self):
14912
- """导入配置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。
14913
15346
  :rtype: str
14914
15347
  """
14915
15348
  return self._Id
@@ -14920,7 +15353,7 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14920
15353
 
14921
15354
  @property
14922
15355
  def Status(self):
14923
- """状态 status 1: 运行中, 2: 暂停...
15356
+ """状态。1: 运行中,2: 暂停,3:错误
14924
15357
  :rtype: int
14925
15358
  """
14926
15359
  return self._Status
@@ -15270,9 +15703,12 @@ class DescribeLogHistogramRequest(AbstractModel):
15270
15703
  :type From: int
15271
15704
  :param _To: 要查询的日志的结束时间,Unix时间戳,单位ms
15272
15705
  :type To: int
15273
- :param _Query: 查询语句
15706
+ :param _Query: 检索分析语句。
15707
+ 语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。
15708
+ 使用*或空字符串可查询所有日志。
15274
15709
  :type Query: str
15275
15710
  :param _TopicId: 要查询的日志主题ID
15711
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
15276
15712
  :type TopicId: str
15277
15713
  :param _Interval: 时间间隔: 单位ms 限制性条件:(To-From) / interval <= 200
15278
15714
  :type Interval: int
@@ -15312,7 +15748,9 @@ class DescribeLogHistogramRequest(AbstractModel):
15312
15748
 
15313
15749
  @property
15314
15750
  def Query(self):
15315
- """查询语句
15751
+ """检索分析语句。
15752
+ 语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。
15753
+ 使用*或空字符串可查询所有日志。
15316
15754
  :rtype: str
15317
15755
  """
15318
15756
  return self._Query
@@ -15324,6 +15762,7 @@ class DescribeLogHistogramRequest(AbstractModel):
15324
15762
  @property
15325
15763
  def TopicId(self):
15326
15764
  """要查询的日志主题ID
15765
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
15327
15766
  :rtype: str
15328
15767
  """
15329
15768
  return self._TopicId
@@ -15636,6 +16075,7 @@ class DescribeMachineGroupConfigsRequest(AbstractModel):
15636
16075
  def __init__(self):
15637
16076
  r"""
15638
16077
  :param _GroupId: 机器组ID
16078
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
15639
16079
  :type GroupId: str
15640
16080
  """
15641
16081
  self._GroupId = None
@@ -15643,6 +16083,7 @@ class DescribeMachineGroupConfigsRequest(AbstractModel):
15643
16083
  @property
15644
16084
  def GroupId(self):
15645
16085
  """机器组ID
16086
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
15646
16087
  :rtype: str
15647
16088
  """
15648
16089
  return self._GroupId
@@ -15721,7 +16162,8 @@ class DescribeMachineGroupsRequest(AbstractModel):
15721
16162
 
15722
16163
  def __init__(self):
15723
16164
  r"""
15724
- :param _Filters: machineGroupName
16165
+ :param _Filters: 过滤条件
16166
+ machineGroupName
15725
16167
  - 按照【机器组名称】进行过滤。
15726
16168
  - 类型:String
15727
16169
  - 必选:否
@@ -15732,7 +16174,7 @@ machineGroupId
15732
16174
  - 必选:否
15733
16175
 
15734
16176
  osType
15735
- - 按照【操作系统类型】进行过滤。
16177
+ - 按照【操作系统类型】进行过滤。0: Linux;1: Windows
15736
16178
  - 类型:Int
15737
16179
  - 必选:否
15738
16180
 
@@ -15759,7 +16201,8 @@ tag:tagKey
15759
16201
 
15760
16202
  @property
15761
16203
  def Filters(self):
15762
- """machineGroupName
16204
+ """过滤条件
16205
+ machineGroupName
15763
16206
  - 按照【机器组名称】进行过滤。
15764
16207
  - 类型:String
15765
16208
  - 必选:否
@@ -15770,7 +16213,7 @@ machineGroupId
15770
16213
  - 必选:否
15771
16214
 
15772
16215
  osType
15773
- - 按照【操作系统类型】进行过滤。
16216
+ - 按照【操作系统类型】进行过滤。0: Linux;1: Windows
15774
16217
  - 类型:Int
15775
16218
  - 必选:否
15776
16219
 
@@ -16341,14 +16784,16 @@ class DescribePartitionsRequest(AbstractModel):
16341
16784
 
16342
16785
  def __init__(self):
16343
16786
  r"""
16344
- :param _TopicId: 日志主题ID
16787
+ :param _TopicId: 日志主题Id
16788
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
16345
16789
  :type TopicId: str
16346
16790
  """
16347
16791
  self._TopicId = None
16348
16792
 
16349
16793
  @property
16350
16794
  def TopicId(self):
16351
- """日志主题ID
16795
+ """日志主题Id
16796
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
16352
16797
  :rtype: str
16353
16798
  """
16354
16799
  return self._TopicId
@@ -16433,15 +16878,14 @@ class DescribeScheduledSqlInfoRequest(AbstractModel):
16433
16878
  :type Name: str
16434
16879
  :param _TaskId: 任务id。
16435
16880
  :type TaskId: str
16436
- :param _Filters: <li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16437
- <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16438
- <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>
16439
- <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>
16440
- <li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>
16441
- <li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>
16442
- <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16443
- <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>
16444
-
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。
16445
16889
  :type Filters: list of Filter
16446
16890
  """
16447
16891
  self._Offset = None
@@ -16496,15 +16940,14 @@ class DescribeScheduledSqlInfoRequest(AbstractModel):
16496
16940
 
16497
16941
  @property
16498
16942
  def Filters(self):
16499
- """<li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16500
- <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16501
- <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>
16502
- <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>
16503
- <li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>
16504
- <li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>
16505
- <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16506
- <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>
16507
-
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。
16508
16951
  :rtype: list of Filter
16509
16952
  """
16510
16953
  return self._Filters
@@ -16907,7 +17350,7 @@ class DescribeTopicsRequest(AbstractModel):
16907
17350
  :param _Filters: <ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16908
17351
  <li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16909
17352
  <li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>
16910
- <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>
16911
17354
  <li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>
16912
17355
  <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>
16913
17356
  <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>
@@ -16939,7 +17382,7 @@ class DescribeTopicsRequest(AbstractModel):
16939
17382
  """<ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16940
17383
  <li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16941
17384
  <li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>
16942
- <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>
16943
17386
  <li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>
16944
17387
  <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>
16945
17388
  <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>
@@ -17423,12 +17866,20 @@ class EventLog(AbstractModel):
17423
17866
 
17424
17867
  def __init__(self):
17425
17868
  r"""
17426
- :param _EventChannel: 事件通道,支持Application,Security,Setup,System,ALL
17869
+ :param _EventChannel: 事件通道,支持
17870
+ - Application 应用日志
17871
+ - Security 安全日志
17872
+ - Setup 启动日志
17873
+ - System 系统日志
17874
+ - ALL 所有日志
17427
17875
 
17428
17876
  :type EventChannel: str
17429
- :param _TimeType: 时间类型,1:用户自定义,2:当前时间
17877
+ :param _TimeType: 时间字段(Timestamp)支持的类型
17878
+ - 1(用户自定义时间)
17879
+ - 2(当前时间)
17430
17880
  :type TimeType: int
17431
- :param _Timestamp: 时间,用户选择自定义时间类型时,需要指定时间
17881
+ :param _Timestamp: 时间,用户选择自定义时间类型时,需要指定时间,单位秒
17882
+ 格式:时间戳,1754897446
17432
17883
  :type Timestamp: int
17433
17884
  :param _EventIDs: 事件ID过滤列表
17434
17885
 
@@ -17444,7 +17895,12 @@ class EventLog(AbstractModel):
17444
17895
 
17445
17896
  @property
17446
17897
  def EventChannel(self):
17447
- """事件通道,支持Application,Security,Setup,System,ALL
17898
+ """事件通道,支持
17899
+ - Application 应用日志
17900
+ - Security 安全日志
17901
+ - Setup 启动日志
17902
+ - System 系统日志
17903
+ - ALL 所有日志
17448
17904
 
17449
17905
  :rtype: str
17450
17906
  """
@@ -17456,7 +17912,9 @@ class EventLog(AbstractModel):
17456
17912
 
17457
17913
  @property
17458
17914
  def TimeType(self):
17459
- """时间类型,1:用户自定义,2:当前时间
17915
+ """时间字段(Timestamp)支持的类型
17916
+ - 1(用户自定义时间)
17917
+ - 2(当前时间)
17460
17918
  :rtype: int
17461
17919
  """
17462
17920
  return self._TimeType
@@ -17467,7 +17925,8 @@ class EventLog(AbstractModel):
17467
17925
 
17468
17926
  @property
17469
17927
  def Timestamp(self):
17470
- """时间,用户选择自定义时间类型时,需要指定时间
17928
+ """时间,用户选择自定义时间类型时,需要指定时间,单位秒
17929
+ 格式:时间戳,1754897446
17471
17930
  :rtype: int
17472
17931
  """
17473
17932
  return self._Timestamp
@@ -17583,13 +18042,14 @@ class ExportInfo(AbstractModel):
17583
18042
  :type Count: int
17584
18043
  :param _Status: 日志下载状态。Processing:导出正在进行中,Completed:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期), Queuing 排队中
17585
18044
  :type Status: str
17586
- :param _From: 日志导出起始时间
18045
+ :param _From: 日志导出起始时间,毫秒时间戳
17587
18046
  :type From: int
17588
- :param _To: 日志导出结束时间
18047
+ :param _To: 日志导出结束时间,毫秒时间戳
17589
18048
  :type To: int
17590
18049
  :param _CosPath: 日志导出路径,有效期一个小时,请尽快使用该路径下载。
17591
18050
  :type CosPath: str
17592
18051
  :param _CreateTime: 日志导出创建时间
18052
+ 时间格式:yyyy-MM-dd HH:mm:ss
17593
18053
  :type CreateTime: str
17594
18054
  :param _SyntaxRule: 语法规则。 默认值为0。
17595
18055
  0:Lucene语法,1:CQL语法。
@@ -17714,7 +18174,7 @@ class ExportInfo(AbstractModel):
17714
18174
 
17715
18175
  @property
17716
18176
  def From(self):
17717
- """日志导出起始时间
18177
+ """日志导出起始时间,毫秒时间戳
17718
18178
  :rtype: int
17719
18179
  """
17720
18180
  return self._From
@@ -17725,7 +18185,7 @@ class ExportInfo(AbstractModel):
17725
18185
 
17726
18186
  @property
17727
18187
  def To(self):
17728
- """日志导出结束时间
18188
+ """日志导出结束时间,毫秒时间戳
17729
18189
  :rtype: int
17730
18190
  """
17731
18191
  return self._To
@@ -17748,6 +18208,7 @@ class ExportInfo(AbstractModel):
17748
18208
  @property
17749
18209
  def CreateTime(self):
17750
18210
  """日志导出创建时间
18211
+ 时间格式:yyyy-MM-dd HH:mm:ss
17751
18212
  :rtype: str
17752
18213
  """
17753
18214
  return self._CreateTime
@@ -17813,9 +18274,10 @@ class ExtractRuleInfo(AbstractModel):
17813
18274
 
17814
18275
  def __init__(self):
17815
18276
  r"""
17816
- :param _TimeKey: 时间字段的key名字,TikeKey和TimeFormat必须成对出现
18277
+ :param _TimeKey: 时间字段的key名字,TimeKey和TimeFormat必须成对出现
17817
18278
  :type TimeKey: str
17818
18279
  :param _TimeFormat: 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
18280
+ - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
17819
18281
  :type TimeFormat: str
17820
18282
  :param _Delimiter: 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
17821
18283
  :type Delimiter: str
@@ -17920,7 +18382,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
17920
18382
 
17921
18383
  @property
17922
18384
  def TimeKey(self):
17923
- """时间字段的key名字,TikeKey和TimeFormat必须成对出现
18385
+ """时间字段的key名字,TimeKey和TimeFormat必须成对出现
17924
18386
  :rtype: str
17925
18387
  """
17926
18388
  return self._TimeKey
@@ -17932,6 +18394,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
17932
18394
  @property
17933
18395
  def TimeFormat(self):
17934
18396
  """时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
18397
+ - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
17935
18398
  :rtype: str
17936
18399
  """
17937
18400
  return self._TimeFormat
@@ -18484,7 +18947,9 @@ class GetAlarmLogRequest(AbstractModel):
18484
18947
  :type To: int
18485
18948
  :param _Query: 查询过滤条件,例如:
18486
18949
  - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
18950
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
18487
18951
  - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
18952
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
18488
18953
  - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
18489
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`
18490
18955
  :type Query: str
@@ -18539,7 +19004,9 @@ false:代表使用老的检索结果返回方式,输出AnalysisResults和Col
18539
19004
  def Query(self):
18540
19005
  """查询过滤条件,例如:
18541
19006
  - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
19007
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
18542
19008
  - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
19009
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
18543
19010
  - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
18544
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`
18545
19012
  :rtype: str
@@ -19249,10 +19716,22 @@ class KafkaProtocolInfo(AbstractModel):
19249
19716
  def __init__(self):
19250
19717
  r"""
19251
19718
  :param _Protocol: 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
19252
- 入参必填
19719
+
19720
+ - 当IsEncryptionAddr为true时,Protocol必填。
19721
+ - 支持的协议类型如下:
19722
+ - plaintext:纯文本无加密协议
19723
+ - sasl_ssl:SASL 认证 + SSL 加密
19724
+ - ssl:纯 SSL/TLS 加密协议
19725
+ - sasl_plaintext:SASL 认证 + 非加密通道
19726
+
19253
19727
  :type Protocol: str
19254
19728
  :param _Mechanism: 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
19255
- 当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算法
19256
19735
  :type Mechanism: str
19257
19736
  :param _UserName: 用户名。
19258
19737
  当Protocol为sasl_plaintext或sasl_ssl时必填
@@ -19269,7 +19748,14 @@ class KafkaProtocolInfo(AbstractModel):
19269
19748
  @property
19270
19749
  def Protocol(self):
19271
19750
  """协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
19272
- 入参必填
19751
+
19752
+ - 当IsEncryptionAddr为true时,Protocol必填。
19753
+ - 支持的协议类型如下:
19754
+ - plaintext:纯文本无加密协议
19755
+ - sasl_ssl:SASL 认证 + SSL 加密
19756
+ - ssl:纯 SSL/TLS 加密协议
19757
+ - sasl_plaintext:SASL 认证 + 非加密通道
19758
+
19273
19759
  :rtype: str
19274
19760
  """
19275
19761
  return self._Protocol
@@ -19281,7 +19767,12 @@ class KafkaProtocolInfo(AbstractModel):
19281
19767
  @property
19282
19768
  def Mechanism(self):
19283
19769
  """加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
19284
- 当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算法
19285
19776
  :rtype: str
19286
19777
  """
19287
19778
  return self._Mechanism
@@ -19361,9 +19852,9 @@ class KafkaRechargeInfo(AbstractModel):
19361
19852
  :type Status: int
19362
19853
  :param _Offset: 导入数据位置,-2:最早(默认),-1:最晚
19363
19854
  :type Offset: int
19364
- :param _CreateTime: 创建时间
19855
+ :param _CreateTime: 创建时间。格式`YYYY-MM-DD HH:MM:SS`
19365
19856
  :type CreateTime: str
19366
- :param _UpdateTime: 更新时间
19857
+ :param _UpdateTime: 更新时间。格式`YYYY-MM-DD HH:MM:SS`
19367
19858
  :type UpdateTime: str
19368
19859
  :param _LogRechargeRule: 日志导入规则
19369
19860
  :type LogRechargeRule: :class:`tencentcloud.cls.v20201016.models.LogRechargeRuleInfo`
@@ -19518,7 +20009,7 @@ class KafkaRechargeInfo(AbstractModel):
19518
20009
 
19519
20010
  @property
19520
20011
  def CreateTime(self):
19521
- """创建时间
20012
+ """创建时间。格式`YYYY-MM-DD HH:MM:SS`
19522
20013
  :rtype: str
19523
20014
  """
19524
20015
  return self._CreateTime
@@ -19529,7 +20020,7 @@ class KafkaRechargeInfo(AbstractModel):
19529
20020
 
19530
20021
  @property
19531
20022
  def UpdateTime(self):
19532
- """更新时间
20023
+ """更新时间。格式`YYYY-MM-DD HH:MM:SS`
19533
20024
  :rtype: str
19534
20025
  """
19535
20026
  return self._UpdateTime
@@ -20181,7 +20672,7 @@ class LogRechargeRuleInfo(AbstractModel):
20181
20672
  :type RechargeType: str
20182
20673
  :param _EncodingFormat: 解析编码格式,0: UTF-8(默认值),1: GBK
20183
20674
  :type EncodingFormat: int
20184
- :param _DefaultTimeSwitch: 使用默认时间,true:开启(默认值), flase:关闭
20675
+ :param _DefaultTimeSwitch: 使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true
20185
20676
  :type DefaultTimeSwitch: bool
20186
20677
  :param _LogRegex: 整条日志匹配规则,只有RechargeType为fullregex_log时有效
20187
20678
  :type LogRegex: str
@@ -20193,13 +20684,101 @@ class LogRechargeRuleInfo(AbstractModel):
20193
20684
  :type UnMatchLogTimeSrc: int
20194
20685
  :param _DefaultTimeSrc: 默认时间来源,0: 系统当前时间,1: Kafka消息时间戳
20195
20686
  :type DefaultTimeSrc: int
20196
- :param _TimeKey: 时间字段
20687
+ :param _TimeKey: 时间字段,日志中代表时间的字段名。
20688
+
20689
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。
20197
20690
  :type TimeKey: str
20198
- :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
+
20199
20696
  :type TimeRegex: str
20200
- :param _TimeFormat: 时间字段格式
20697
+ :param _TimeFormat: 时间字段格式。
20698
+ - 当DefaultTimeSwitch为false时, TimeFormat不能为空。
20201
20699
  :type TimeFormat: str
20202
- :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
+ ```
20203
20782
  :type TimeZone: str
20204
20783
  :param _Metadata: 元数据信息,Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp
20205
20784
  :type Metadata: list of str
@@ -20248,7 +20827,7 @@ class LogRechargeRuleInfo(AbstractModel):
20248
20827
 
20249
20828
  @property
20250
20829
  def DefaultTimeSwitch(self):
20251
- """使用默认时间,true:开启(默认值), flase:关闭
20830
+ """使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true
20252
20831
  :rtype: bool
20253
20832
  """
20254
20833
  return self._DefaultTimeSwitch
@@ -20314,7 +20893,9 @@ class LogRechargeRuleInfo(AbstractModel):
20314
20893
 
20315
20894
  @property
20316
20895
  def TimeKey(self):
20317
- """时间字段
20896
+ """时间字段,日志中代表时间的字段名。
20897
+
20898
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。
20318
20899
  :rtype: str
20319
20900
  """
20320
20901
  return self._TimeKey
@@ -20325,7 +20906,11 @@ class LogRechargeRuleInfo(AbstractModel):
20325
20906
 
20326
20907
  @property
20327
20908
  def TimeRegex(self):
20328
- """时间提取正则表达式
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
+
20329
20914
  :rtype: str
20330
20915
  """
20331
20916
  return self._TimeRegex
@@ -20336,7 +20921,8 @@ class LogRechargeRuleInfo(AbstractModel):
20336
20921
 
20337
20922
  @property
20338
20923
  def TimeFormat(self):
20339
- """时间字段格式
20924
+ """时间字段格式。
20925
+ - 当DefaultTimeSwitch为false时, TimeFormat不能为空。
20340
20926
  :rtype: str
20341
20927
  """
20342
20928
  return self._TimeFormat
@@ -20347,7 +20933,88 @@ class LogRechargeRuleInfo(AbstractModel):
20347
20933
 
20348
20934
  @property
20349
20935
  def TimeZone(self):
20350
- """时间字段时区
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
+ ```
20351
21018
  :rtype: str
20352
21019
  """
20353
21020
  return self._TimeZone
@@ -20561,18 +21228,21 @@ class MachineGroupInfo(AbstractModel):
20561
21228
  :param _MachineGroupType: 机器组类型
20562
21229
  :type MachineGroupType: :class:`tencentcloud.cls.v20201016.models.MachineGroupTypeInfo`
20563
21230
  :param _CreateTime: 创建时间
21231
+ 时间格式:yyyy-MM-dd HH:mm:ss
20564
21232
  :type CreateTime: str
20565
21233
  :param _Tags: 机器组绑定的标签列表
20566
21234
  :type Tags: list of Tag
20567
21235
  :param _AutoUpdate: 是否开启机器组自动更新
20568
21236
  :type AutoUpdate: str
20569
21237
  :param _UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
21238
+ 时间格式:HH:mm:ss
20570
21239
  :type UpdateStartTime: str
20571
21240
  :param _UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
21241
+ 时间格式:HH:mm:ss
20572
21242
  :type UpdateEndTime: str
20573
21243
  :param _ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
20574
21244
  :type ServiceLogging: bool
20575
- :param _DelayCleanupTime: 机器组中机器离线定期清理时间
21245
+ :param _DelayCleanupTime: 机器组中机器离线定期清理时间,单位天,默认设置30天。
20576
21246
  :type DelayCleanupTime: int
20577
21247
  :param _MetaTags: 机器组元数据信息列表
20578
21248
  :type MetaTags: list of MetaTagInfo
@@ -20628,6 +21298,7 @@ class MachineGroupInfo(AbstractModel):
20628
21298
  @property
20629
21299
  def CreateTime(self):
20630
21300
  """创建时间
21301
+ 时间格式:yyyy-MM-dd HH:mm:ss
20631
21302
  :rtype: str
20632
21303
  """
20633
21304
  return self._CreateTime
@@ -20661,6 +21332,7 @@ class MachineGroupInfo(AbstractModel):
20661
21332
  @property
20662
21333
  def UpdateStartTime(self):
20663
21334
  """升级开始时间,建议业务低峰期升级LogListener
21335
+ 时间格式:HH:mm:ss
20664
21336
  :rtype: str
20665
21337
  """
20666
21338
  return self._UpdateStartTime
@@ -20672,6 +21344,7 @@ class MachineGroupInfo(AbstractModel):
20672
21344
  @property
20673
21345
  def UpdateEndTime(self):
20674
21346
  """升级结束时间,建议业务低峰期升级LogListener
21347
+ 时间格式:HH:mm:ss
20675
21348
  :rtype: str
20676
21349
  """
20677
21350
  return self._UpdateEndTime
@@ -20693,7 +21366,7 @@ class MachineGroupInfo(AbstractModel):
20693
21366
 
20694
21367
  @property
20695
21368
  def DelayCleanupTime(self):
20696
- """机器组中机器离线定期清理时间
21369
+ """机器组中机器离线定期清理时间,单位天,默认设置30天。
20697
21370
  :rtype: int
20698
21371
  """
20699
21372
  return self._DelayCleanupTime
@@ -20982,9 +21655,10 @@ class MergePartitionRequest(AbstractModel):
20982
21655
 
20983
21656
  def __init__(self):
20984
21657
  r"""
20985
- :param _TopicId: 日志主题ID
21658
+ :param _TopicId: 日志主题Id
21659
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
20986
21660
  :type TopicId: str
20987
- :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)
20988
21662
 
20989
21663
  1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);
20990
21664
  2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);
@@ -20996,7 +21670,8 @@ class MergePartitionRequest(AbstractModel):
20996
21670
 
20997
21671
  @property
20998
21672
  def TopicId(self):
20999
- """日志主题ID
21673
+ """日志主题Id
21674
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
21000
21675
  :rtype: str
21001
21676
  """
21002
21677
  return self._TopicId
@@ -21007,7 +21682,7 @@ class MergePartitionRequest(AbstractModel):
21007
21682
 
21008
21683
  @property
21009
21684
  def PartitionId(self):
21010
- """合并的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)
21011
21686
 
21012
21687
  1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);
21013
21688
  2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);
@@ -22195,17 +22870,19 @@ class ModifyConfigExtraRequest(AbstractModel):
22195
22870
  def __init__(self):
22196
22871
  r"""
22197
22872
  :param _ConfigExtraId: 采集配置扩展信息id
22873
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)获取采集配置扩展信息id。
22198
22874
  :type ConfigExtraId: str
22199
22875
  :param _Name: 采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾
22200
22876
  :type Name: str
22201
22877
  :param _TopicId: 日志主题id
22878
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22202
22879
  :type TopicId: str
22203
- :param _HostFile: 节点文件配置信息
22880
+ :param _HostFile: 自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息,详细参考https://cloud.tencent.com/document/api/614/56471#HostFileInfo
22204
22881
  :type HostFile: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
22205
22882
  :param _ContainerFile: 采集配置标记。
22206
22883
  - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
22207
22884
  :type ContainerFile: :class:`tencentcloud.cls.v20201016.models.ContainerFileInfo`
22208
- :param _ContainerStdout: 容器标准输出信息
22885
+ :param _ContainerStdout: 自建k8s-容器标准输出信息,包括容器、命名空间等,详细参考https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo
22209
22886
  :type ContainerStdout: :class:`tencentcloud.cls.v20201016.models.ContainerStdoutInfo`
22210
22887
  :param _LogType: 采集的日志类型,默认为minimalist_log。支持以下类型:
22211
22888
  - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
@@ -22228,17 +22905,24 @@ class ModifyConfigExtraRequest(AbstractModel):
22228
22905
  - 取值参考:[使用组合解析提取模式采集日志
22229
22906
  ](https://cloud.tencent.com/document/product/614/61310)
22230
22907
  :type UserDefineRule: str
22231
- :param _Type: 类型:container_stdout、container_file、host_file
22908
+ :param _Type: 容器场景,日志采集输入类型,支持以下三种类型
22909
+ - container_stdout 标准输出
22910
+ - container_file 容器文件
22911
+ - host_file 主机节点文件
22232
22912
  :type Type: str
22233
22913
  :param _GroupId: 机器组ID
22914
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
22234
22915
  :type GroupId: str
22235
22916
  :param _ConfigFlag: 自建采集配置标
22236
22917
  :type ConfigFlag: str
22237
22918
  :param _LogsetId: 日志集ID
22919
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
22238
22920
  :type LogsetId: str
22239
- :param _LogsetName: 日志集name
22921
+ :param _LogsetName: 日志集名称
22922
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。
22240
22923
  :type LogsetName: str
22241
- :param _TopicName: 日志主题name
22924
+ :param _TopicName: 日志主题名称
22925
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。
22242
22926
  :type TopicName: str
22243
22927
  :param _AdvancedConfig: 高级采集配置。 Json字符串, Key/Value定义为如下:
22244
22928
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
@@ -22270,6 +22954,7 @@ class ModifyConfigExtraRequest(AbstractModel):
22270
22954
  @property
22271
22955
  def ConfigExtraId(self):
22272
22956
  """采集配置扩展信息id
22957
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)获取采集配置扩展信息id。
22273
22958
  :rtype: str
22274
22959
  """
22275
22960
  return self._ConfigExtraId
@@ -22292,6 +22977,7 @@ class ModifyConfigExtraRequest(AbstractModel):
22292
22977
  @property
22293
22978
  def TopicId(self):
22294
22979
  """日志主题id
22980
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22295
22981
  :rtype: str
22296
22982
  """
22297
22983
  return self._TopicId
@@ -22302,7 +22988,7 @@ class ModifyConfigExtraRequest(AbstractModel):
22302
22988
 
22303
22989
  @property
22304
22990
  def HostFile(self):
22305
- """节点文件配置信息
22991
+ """自建k8s-节点文件配置信息,包括文件路径、名称及元数据相关信息,详细参考https://cloud.tencent.com/document/api/614/56471#HostFileInfo
22306
22992
  :rtype: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
22307
22993
  """
22308
22994
  return self._HostFile
@@ -22325,7 +23011,7 @@ class ModifyConfigExtraRequest(AbstractModel):
22325
23011
 
22326
23012
  @property
22327
23013
  def ContainerStdout(self):
22328
- """容器标准输出信息
23014
+ """自建k8s-容器标准输出信息,包括容器、命名空间等,详细参考https://cloud.tencent.com/document/api/614/56471#ContainerStdoutInfo
22329
23015
  :rtype: :class:`tencentcloud.cls.v20201016.models.ContainerStdoutInfo`
22330
23016
  """
22331
23017
  return self._ContainerStdout
@@ -22406,7 +23092,10 @@ class ModifyConfigExtraRequest(AbstractModel):
22406
23092
 
22407
23093
  @property
22408
23094
  def Type(self):
22409
- """类型:container_stdout、container_file、host_file
23095
+ """容器场景,日志采集输入类型,支持以下三种类型
23096
+ - container_stdout 标准输出
23097
+ - container_file 容器文件
23098
+ - host_file 主机节点文件
22410
23099
  :rtype: str
22411
23100
  """
22412
23101
  return self._Type
@@ -22418,6 +23107,7 @@ class ModifyConfigExtraRequest(AbstractModel):
22418
23107
  @property
22419
23108
  def GroupId(self):
22420
23109
  """机器组ID
23110
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
22421
23111
  :rtype: str
22422
23112
  """
22423
23113
  return self._GroupId
@@ -22440,6 +23130,7 @@ class ModifyConfigExtraRequest(AbstractModel):
22440
23130
  @property
22441
23131
  def LogsetId(self):
22442
23132
  """日志集ID
23133
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
22443
23134
  :rtype: str
22444
23135
  """
22445
23136
  return self._LogsetId
@@ -22450,7 +23141,8 @@ class ModifyConfigExtraRequest(AbstractModel):
22450
23141
 
22451
23142
  @property
22452
23143
  def LogsetName(self):
22453
- """日志集name
23144
+ """日志集名称
23145
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集名称。
22454
23146
  :rtype: str
22455
23147
  """
22456
23148
  return self._LogsetName
@@ -22461,7 +23153,8 @@ class ModifyConfigExtraRequest(AbstractModel):
22461
23153
 
22462
23154
  @property
22463
23155
  def TopicName(self):
22464
- """日志主题name
23156
+ """日志主题名称
23157
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题名称。
22465
23158
  :rtype: str
22466
23159
  """
22467
23160
  return self._TopicName
@@ -22567,6 +23260,8 @@ class ModifyConfigRequest(AbstractModel):
22567
23260
  :param _ConfigId: 采集规则配置ID,通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)返回信息获取。
22568
23261
  :type ConfigId: str
22569
23262
  :param _Name: 采集规则配置名称
23263
+ - 不能包含特殊字符|
23264
+ - 长度不能超过255字符,超过会被截断
22570
23265
  :type Name: str
22571
23266
  :param _Path: 日志采集路径,包含文件名
22572
23267
  :type Path: str
@@ -22588,6 +23283,7 @@ class ModifyConfigRequest(AbstractModel):
22588
23283
  :param _ExcludePaths: 采集黑名单路径列表
22589
23284
  :type ExcludePaths: list of ExcludePathInfo
22590
23285
  :param _Output: 采集配置关联的日志主题(TopicId)
23286
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22591
23287
  :type Output: str
22592
23288
  :param _UserDefineRule: 用户自定义解析字符串,Json格式序列化的字符串。
22593
23289
  :type UserDefineRule: str
@@ -22623,6 +23319,8 @@ class ModifyConfigRequest(AbstractModel):
22623
23319
  @property
22624
23320
  def Name(self):
22625
23321
  """采集规则配置名称
23322
+ - 不能包含特殊字符|
23323
+ - 长度不能超过255字符,超过会被截断
22626
23324
  :rtype: str
22627
23325
  """
22628
23326
  return self._Name
@@ -22689,6 +23387,7 @@ class ModifyConfigRequest(AbstractModel):
22689
23387
  @property
22690
23388
  def Output(self):
22691
23389
  """采集配置关联的日志主题(TopicId)
23390
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22692
23391
  :rtype: str
22693
23392
  """
22694
23393
  return self._Output
@@ -22787,7 +23486,9 @@ class ModifyConsoleSharingRequest(AbstractModel):
22787
23486
 
22788
23487
  def __init__(self):
22789
23488
  r"""
22790
- :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。
22791
23492
  :type SharingId: str
22792
23493
  :param _DurationMilliseconds: 指定分享链接有效期,单位:毫秒,最长可设定有效期为30天
22793
23494
  :type DurationMilliseconds: int
@@ -22797,7 +23498,9 @@ class ModifyConsoleSharingRequest(AbstractModel):
22797
23498
 
22798
23499
  @property
22799
23500
  def SharingId(self):
22800
- """免密分享链接Id
23501
+ """免密分享Id
23502
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
23503
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
22801
23504
  :rtype: str
22802
23505
  """
22803
23506
  return self._SharingId
@@ -22866,7 +23569,9 @@ class ModifyConsumerRequest(AbstractModel):
22866
23569
 
22867
23570
  def __init__(self):
22868
23571
  r"""
22869
- :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。
22870
23575
  :type TopicId: str
22871
23576
  :param _Effective: 投递任务是否生效,默认不生效
22872
23577
  :type Effective: bool
@@ -22890,7 +23595,9 @@ class ModifyConsumerRequest(AbstractModel):
22890
23595
 
22891
23596
  @property
22892
23597
  def TopicId(self):
22893
- """投递任务绑定的日志主题 ID
23598
+ """投递任务绑定的日志主题Id。
23599
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
23600
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
22894
23601
  :rtype: str
22895
23602
  """
22896
23603
  return self._TopicId
@@ -23672,9 +24379,11 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23672
24379
 
23673
24380
  def __init__(self):
23674
24381
  r"""
23675
- :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。
23676
24385
  :type FromTopicId: str
23677
- :param _Compression: 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
24386
+ :param _Compression: 压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
23678
24387
  :type Compression: int
23679
24388
  :param _ConsumerContent: kafka协议消费数据格式
23680
24389
  :type ConsumerContent: :class:`tencentcloud.cls.v20201016.models.KafkaConsumerContent`
@@ -23685,7 +24394,9 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23685
24394
 
23686
24395
  @property
23687
24396
  def FromTopicId(self):
23688
- """日志主题ID
24397
+ """日志主题Id。
24398
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
24399
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
23689
24400
  :rtype: str
23690
24401
  """
23691
24402
  return self._FromTopicId
@@ -23696,7 +24407,7 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23696
24407
 
23697
24408
  @property
23698
24409
  def Compression(self):
23699
- """压缩方式[0:NONE;2:SNAPPY;3:LZ4]
24410
+ """压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
23700
24411
  :rtype: int
23701
24412
  """
23702
24413
  return self._Compression
@@ -23768,15 +24479,20 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23768
24479
 
23769
24480
  def __init__(self):
23770
24481
  r"""
23771
- :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。
23772
24485
  :type Id: str
23773
- :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。
23774
24489
  :type TopicId: str
23775
24490
  :param _Name: Kafka导入配置名称
23776
24491
  :type Name: str
23777
24492
  :param _KafkaType: 导入Kafka类型,0:腾讯云CKafka:1:用户自建Kafka。
23778
24493
  :type KafkaType: int
23779
24494
  :param _KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填。
24495
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
23780
24496
  :type KafkaInstance: str
23781
24497
  :param _ServerAddr: 服务地址,KafkaType为1时必填。
23782
24498
  :type ServerAddr: str
@@ -23784,13 +24500,15 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23784
24500
  :type IsEncryptionAddr: bool
23785
24501
  :param _Protocol: 加密访问协议,KafkaType参数为1并且IsEncryptionAddr参数为true时必填。
23786
24502
  :type Protocol: :class:`tencentcloud.cls.v20201016.models.KafkaProtocolInfo`
23787
- :param _UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
24503
+ :param _UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
24504
+
24505
+ - Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
23788
24506
  :type UserKafkaTopics: str
23789
24507
  :param _ConsumerGroupName: 用户Kafka消费组名称
23790
24508
  :type ConsumerGroupName: str
23791
24509
  :param _LogRechargeRule: 日志导入规则
23792
24510
  :type LogRechargeRule: :class:`tencentcloud.cls.v20201016.models.LogRechargeRuleInfo`
23793
- :param _StatusControl: 导入控制,1:暂停;2:继续。
24511
+ :param _StatusControl: 导入控制,1:暂停;2:启动。
23794
24512
  :type StatusControl: int
23795
24513
  """
23796
24514
  self._Id = None
@@ -23808,7 +24526,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23808
24526
 
23809
24527
  @property
23810
24528
  def Id(self):
23811
- """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。
23812
24532
  :rtype: str
23813
24533
  """
23814
24534
  return self._Id
@@ -23819,7 +24539,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23819
24539
 
23820
24540
  @property
23821
24541
  def TopicId(self):
23822
- """导入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。
23823
24545
  :rtype: str
23824
24546
  """
23825
24547
  return self._TopicId
@@ -23853,6 +24575,7 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23853
24575
  @property
23854
24576
  def KafkaInstance(self):
23855
24577
  """腾讯云CKafka实例ID,KafkaType为0时必填。
24578
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
23856
24579
  :rtype: str
23857
24580
  """
23858
24581
  return self._KafkaInstance
@@ -23896,7 +24619,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23896
24619
 
23897
24620
  @property
23898
24621
  def UserKafkaTopics(self):
23899
- """用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
24622
+ """用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
24623
+
24624
+ - Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
23900
24625
  :rtype: str
23901
24626
  """
23902
24627
  return self._UserKafkaTopics
@@ -23929,7 +24654,7 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23929
24654
 
23930
24655
  @property
23931
24656
  def StatusControl(self):
23932
- """导入控制,1:暂停;2:继续。
24657
+ """导入控制,1:暂停;2:启动。
23933
24658
  :rtype: int
23934
24659
  """
23935
24660
  return self._StatusControl
@@ -24100,9 +24825,13 @@ class ModifyMachineGroupRequest(AbstractModel):
24100
24825
 
24101
24826
  def __init__(self):
24102
24827
  r"""
24103
- :param _GroupId: 机器组ID
24828
+ :param _GroupId: 机器组Id
24829
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
24104
24830
  :type GroupId: str
24105
24831
  :param _GroupName: 机器组名称
24832
+ 输入限制:
24833
+ - 不能为空字符串
24834
+ - 不能包含字符'|'
24106
24835
  :type GroupName: str
24107
24836
  :param _MachineGroupType: 机器组类型。
24108
24837
  Type:ip,Values中为ip字符串列表机器组;
@@ -24113,8 +24842,10 @@ Type:label,Values中为标签字符串列表机器组。
24113
24842
  :param _AutoUpdate: 是否开启机器组自动更新
24114
24843
  :type AutoUpdate: bool
24115
24844
  :param _UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
24845
+ 时间格式:HH:mm:ss
24116
24846
  :type UpdateStartTime: str
24117
24847
  :param _UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
24848
+ 时间格式:HH:mm:ss
24118
24849
  :type UpdateEndTime: str
24119
24850
  :param _ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
24120
24851
  :type ServiceLogging: bool
@@ -24136,7 +24867,8 @@ Type:label,Values中为标签字符串列表机器组。
24136
24867
 
24137
24868
  @property
24138
24869
  def GroupId(self):
24139
- """机器组ID
24870
+ """机器组Id
24871
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
24140
24872
  :rtype: str
24141
24873
  """
24142
24874
  return self._GroupId
@@ -24148,6 +24880,9 @@ Type:label,Values中为标签字符串列表机器组。
24148
24880
  @property
24149
24881
  def GroupName(self):
24150
24882
  """机器组名称
24883
+ 输入限制:
24884
+ - 不能为空字符串
24885
+ - 不能包含字符'|'
24151
24886
  :rtype: str
24152
24887
  """
24153
24888
  return self._GroupName
@@ -24194,6 +24929,7 @@ Type:label,Values中为标签字符串列表机器组。
24194
24929
  @property
24195
24930
  def UpdateStartTime(self):
24196
24931
  """升级开始时间,建议业务低峰期升级LogListener
24932
+ 时间格式:HH:mm:ss
24197
24933
  :rtype: str
24198
24934
  """
24199
24935
  return self._UpdateStartTime
@@ -24205,6 +24941,7 @@ Type:label,Values中为标签字符串列表机器组。
24205
24941
  @property
24206
24942
  def UpdateEndTime(self):
24207
24943
  """升级结束时间,建议业务低峰期升级LogListener
24944
+ 时间格式:HH:mm:ss
24208
24945
  :rtype: str
24209
24946
  """
24210
24947
  return self._UpdateEndTime
@@ -24433,9 +25170,9 @@ class ModifyScheduledSqlRequest(AbstractModel):
24433
25170
 
24434
25171
  def __init__(self):
24435
25172
  r"""
24436
- :param _TaskId: 任务ID
25173
+ :param _TaskId: 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24437
25174
  :type TaskId: str
24438
- :param _SrcTopicId: 源日志主题
25175
+ :param _SrcTopicId: 源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24439
25176
  :type SrcTopicId: str
24440
25177
  :param _EnableFlag: 任务启动状态. 1开启, 2关闭
24441
25178
  :type EnableFlag: int
@@ -24443,15 +25180,15 @@ class ModifyScheduledSqlRequest(AbstractModel):
24443
25180
  :type DstResource: :class:`tencentcloud.cls.v20201016.models.ScheduledSqlResouceInfo`
24444
25181
  :param _ScheduledSqlContent: 查询语句
24445
25182
  :type ScheduledSqlContent: str
24446
- :param _ProcessPeriod: 调度周期(分钟)
25183
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
24447
25184
  :type ProcessPeriod: int
24448
25185
  :param _ProcessTimeWindow: 单次查询的时间窗口. 例子中为近15分钟
24449
25186
  :type ProcessTimeWindow: str
24450
- :param _ProcessDelay: 执行延迟(秒)
25187
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
24451
25188
  :type ProcessDelay: int
24452
- :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)
24453
25190
  :type SrcTopicRegion: str
24454
- :param _Name: 任务名称
25191
+ :param _Name: 任务名称,0~255字符
24455
25192
  :type Name: str
24456
25193
  :param _SyntaxRule: 语法规则。 默认值为0。 0:Lucene语法,1:CQL语法
24457
25194
  :type SyntaxRule: int
@@ -24470,7 +25207,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24470
25207
 
24471
25208
  @property
24472
25209
  def TaskId(self):
24473
- """任务ID
25210
+ """任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24474
25211
  :rtype: str
24475
25212
  """
24476
25213
  return self._TaskId
@@ -24481,7 +25218,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24481
25218
 
24482
25219
  @property
24483
25220
  def SrcTopicId(self):
24484
- """源日志主题
25221
+ """源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24485
25222
  :rtype: str
24486
25223
  """
24487
25224
  return self._SrcTopicId
@@ -24525,7 +25262,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24525
25262
 
24526
25263
  @property
24527
25264
  def ProcessPeriod(self):
24528
- """调度周期(分钟)
25265
+ """调度周期(分钟),1~1440分钟
24529
25266
  :rtype: int
24530
25267
  """
24531
25268
  return self._ProcessPeriod
@@ -24547,7 +25284,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24547
25284
 
24548
25285
  @property
24549
25286
  def ProcessDelay(self):
24550
- """执行延迟(秒)
25287
+ """执行延迟(秒),0~120秒,默认60秒
24551
25288
  :rtype: int
24552
25289
  """
24553
25290
  return self._ProcessDelay
@@ -24558,7 +25295,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24558
25295
 
24559
25296
  @property
24560
25297
  def SrcTopicRegion(self):
24561
- """源topicId的地域信息
25298
+ """源topicId的地域信息,支持地域见(https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8)
24562
25299
  :rtype: str
24563
25300
  """
24564
25301
  return self._SrcTopicRegion
@@ -24569,7 +25306,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24569
25306
 
24570
25307
  @property
24571
25308
  def Name(self):
24572
- """任务名称
25309
+ """任务名称,0~255字符
24573
25310
  :rtype: str
24574
25311
  """
24575
25312
  return self._Name
@@ -24935,8 +25672,13 @@ class ModifyTopicRequest(AbstractModel):
24935
25672
  def __init__(self):
24936
25673
  r"""
24937
25674
  :param _TopicId: 日志主题ID
25675
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
24938
25676
  :type TopicId: str
24939
25677
  :param _TopicName: 日志主题名称
25678
+ 输入限制:
25679
+ - 不能为空字符串
25680
+ - 不能包含字符'|'
25681
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
24940
25682
  :type TopicName: str
24941
25683
  :param _Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,并且不能有重复的键值对。
24942
25684
  :type Tags: list of Tag
@@ -24945,7 +25687,8 @@ class ModifyTopicRequest(AbstractModel):
24945
25687
  :type Status: bool
24946
25688
  :param _AutoSplit: 是否开启自动分裂
24947
25689
  :type AutoSplit: bool
24948
- :param _MaxSplitPartitions: 若开启最大分裂,该主题能够能够允许的最大分区数
25690
+ :param _MaxSplitPartitions: 若开启最大分裂,该主题能够能够允许的最大分区数;
25691
+ 默认为50;必须为正数
24949
25692
  :type MaxSplitPartitions: int
24950
25693
  :param _Period: 生命周期,单位天,标准存储取值范围1\~3600,低频存储取值范围7\~3600。取值为3640时代表永久保存
24951
25694
  :type Period: int
@@ -24959,9 +25702,15 @@ class ModifyTopicRequest(AbstractModel):
24959
25702
  :type IsWebTracking: bool
24960
25703
  :param _Extends: 日志主题扩展信息
24961
25704
  :type Extends: :class:`tencentcloud.cls.v20201016.models.TopicExtendInfo`
24962
- :param _PartitionCount: 日志主题分区数量
25705
+ :param _PartitionCount: 日志主题分区数量。
25706
+ 默认为1;
25707
+ 取值范围及约束:
25708
+ - 当输入值<=0,系统自动调整为1。
25709
+ - 如果未传MaxSplitPartitions,需要PartitionCount<=50;
25710
+ - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
24963
25711
  :type PartitionCount: int
24964
25712
  :param _CancelTopicAsyncTaskID: 取消切换存储任务的id
25713
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
24965
25714
  :type CancelTopicAsyncTaskID: str
24966
25715
  """
24967
25716
  self._TopicId = None
@@ -24981,6 +25730,7 @@ class ModifyTopicRequest(AbstractModel):
24981
25730
  @property
24982
25731
  def TopicId(self):
24983
25732
  """日志主题ID
25733
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
24984
25734
  :rtype: str
24985
25735
  """
24986
25736
  return self._TopicId
@@ -24992,6 +25742,10 @@ class ModifyTopicRequest(AbstractModel):
24992
25742
  @property
24993
25743
  def TopicName(self):
24994
25744
  """日志主题名称
25745
+ 输入限制:
25746
+ - 不能为空字符串
25747
+ - 不能包含字符'|'
25748
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
24995
25749
  :rtype: str
24996
25750
  """
24997
25751
  return self._TopicName
@@ -25036,7 +25790,8 @@ class ModifyTopicRequest(AbstractModel):
25036
25790
 
25037
25791
  @property
25038
25792
  def MaxSplitPartitions(self):
25039
- """若开启最大分裂,该主题能够能够允许的最大分区数
25793
+ """若开启最大分裂,该主题能够能够允许的最大分区数;
25794
+ 默认为50;必须为正数
25040
25795
  :rtype: int
25041
25796
  """
25042
25797
  return self._MaxSplitPartitions
@@ -25104,7 +25859,12 @@ class ModifyTopicRequest(AbstractModel):
25104
25859
 
25105
25860
  @property
25106
25861
  def PartitionCount(self):
25107
- """日志主题分区数量
25862
+ """日志主题分区数量。
25863
+ 默认为1;
25864
+ 取值范围及约束:
25865
+ - 当输入值<=0,系统自动调整为1。
25866
+ - 如果未传MaxSplitPartitions,需要PartitionCount<=50;
25867
+ - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
25108
25868
  :rtype: int
25109
25869
  """
25110
25870
  return self._PartitionCount
@@ -25116,6 +25876,7 @@ class ModifyTopicRequest(AbstractModel):
25116
25876
  @property
25117
25877
  def CancelTopicAsyncTaskID(self):
25118
25878
  """取消切换存储任务的id
25879
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
25119
25880
  :rtype: str
25120
25881
  """
25121
25882
  return self._CancelTopicAsyncTaskID
@@ -25601,7 +26362,7 @@ class NoticeContentInfo(AbstractModel):
25601
26362
  def __init__(self):
25602
26363
  r"""
25603
26364
  :param _Title: 通知内容模板标题信息。
25604
- 部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
26365
+ 部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
25605
26366
  :type Title: str
25606
26367
  :param _Content: 通知内容模板正文信息。
25607
26368
  :type Content: str
@@ -25616,7 +26377,7 @@ class NoticeContentInfo(AbstractModel):
25616
26377
  @property
25617
26378
  def Title(self):
25618
26379
  """通知内容模板标题信息。
25619
- 部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
26380
+ 部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
25620
26381
  :rtype: str
25621
26382
  """
25622
26383
  return self._Title
@@ -26251,7 +27012,9 @@ class OpenKafkaConsumerRequest(AbstractModel):
26251
27012
 
26252
27013
  def __init__(self):
26253
27014
  r"""
26254
- :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。
26255
27018
  :type FromTopicId: str
26256
27019
  :param _Compression: 压缩方式[0:NONE;2:SNAPPY;3:LZ4],默认:0
26257
27020
  :type Compression: int
@@ -26264,7 +27027,9 @@ class OpenKafkaConsumerRequest(AbstractModel):
26264
27027
 
26265
27028
  @property
26266
27029
  def FromTopicId(self):
26267
- """日志主题ID
27030
+ """日志主题Id。
27031
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27032
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
26268
27033
  :rtype: str
26269
27034
  """
26270
27035
  return self._FromTopicId
@@ -26478,8 +27243,10 @@ class PartitionInfo(AbstractModel):
26478
27243
  :param _ExclusiveEndKey: 分区哈希键结束key
26479
27244
  :type ExclusiveEndKey: str
26480
27245
  :param _CreateTime: 分区创建时间
27246
+ 时间格式:yyyy-MM-dd HH:mm:ss
26481
27247
  :type CreateTime: str
26482
27248
  :param _LastWriteTime: 只读分区数据停止写入时间
27249
+ 时间格式:yyyy-MM-dd HH:mm:ss
26483
27250
  注意:此字段可能返回 null,表示取不到有效值。
26484
27251
  :type LastWriteTime: str
26485
27252
  """
@@ -26537,6 +27304,7 @@ class PartitionInfo(AbstractModel):
26537
27304
  @property
26538
27305
  def CreateTime(self):
26539
27306
  """分区创建时间
27307
+ 时间格式:yyyy-MM-dd HH:mm:ss
26540
27308
  :rtype: str
26541
27309
  """
26542
27310
  return self._CreateTime
@@ -26548,6 +27316,7 @@ class PartitionInfo(AbstractModel):
26548
27316
  @property
26549
27317
  def LastWriteTime(self):
26550
27318
  """只读分区数据停止写入时间
27319
+ 时间格式:yyyy-MM-dd HH:mm:ss
26551
27320
  注意:此字段可能返回 null,表示取不到有效值。
26552
27321
  :rtype: str
26553
27322
  """
@@ -26592,6 +27361,7 @@ class PreviewKafkaRechargeRequest(AbstractModel):
26592
27361
  :param _Offset: 导入数据位置,-2:最早;-1:最晚。
26593
27362
  :type Offset: int
26594
27363
  :param _KafkaInstance: 腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。
27364
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
26595
27365
  :type KafkaInstance: str
26596
27366
  :param _ServerAddr: 服务地址。
26597
27367
  KafkaType为1时ServerAddr必填。
@@ -26602,7 +27372,9 @@ KafkaType为1时有效。
26602
27372
  :param _Protocol: 加密访问协议。
26603
27373
  KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
26604
27374
  :type Protocol: :class:`tencentcloud.cls.v20201016.models.KafkaProtocolInfo`
26605
- :param _ConsumerGroupName: 用户Kafka消费组
27375
+ :param _ConsumerGroupName: 用户Kafka消费组。
27376
+
27377
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
26606
27378
  :type ConsumerGroupName: str
26607
27379
  :param _LogRechargeRule: 日志导入规则
26608
27380
  :type LogRechargeRule: :class:`tencentcloud.cls.v20201016.models.LogRechargeRuleInfo`
@@ -26666,6 +27438,7 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
26666
27438
  @property
26667
27439
  def KafkaInstance(self):
26668
27440
  """腾讯云CKafka实例ID,当KafkaType为0时参数KafkaInstance有效且必填。
27441
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
26669
27442
  :rtype: str
26670
27443
  """
26671
27444
  return self._KafkaInstance
@@ -26712,7 +27485,9 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
26712
27485
 
26713
27486
  @property
26714
27487
  def ConsumerGroupName(self):
26715
- """用户Kafka消费组
27488
+ """用户Kafka消费组。
27489
+
27490
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
26716
27491
  :rtype: str
26717
27492
  """
26718
27493
  return self._ConsumerGroupName
@@ -26947,8 +27722,10 @@ class QueryMetricRequest(AbstractModel):
26947
27722
  def __init__(self):
26948
27723
  r"""
26949
27724
  :param _Query: 查询语句,使用PromQL语法
27725
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
26950
27726
  :type Query: str
26951
27727
  :param _TopicId: 指标主题ID
27728
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
26952
27729
  :type TopicId: str
26953
27730
  :param _Time: 查询时间,秒级Unix时间戳。为空时代表当前时间戳。
26954
27731
 
@@ -26961,6 +27738,7 @@ class QueryMetricRequest(AbstractModel):
26961
27738
  @property
26962
27739
  def Query(self):
26963
27740
  """查询语句,使用PromQL语法
27741
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
26964
27742
  :rtype: str
26965
27743
  """
26966
27744
  return self._Query
@@ -26972,6 +27750,7 @@ class QueryMetricRequest(AbstractModel):
26972
27750
  @property
26973
27751
  def TopicId(self):
26974
27752
  """指标主题ID
27753
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
26975
27754
  :rtype: str
26976
27755
  """
26977
27756
  return self._TopicId
@@ -27014,7 +27793,11 @@ class QueryMetricResponse(AbstractModel):
27014
27793
 
27015
27794
  def __init__(self):
27016
27795
  r"""
27017
- :param _ResultType: 指标查询结果类型
27796
+ :param _ResultType: 指标查询结果类型,支持
27797
+ - scalar 标量值
27798
+ - string 字符串值
27799
+ - vector 瞬时向量
27800
+ - matrix 区间向量
27018
27801
  :type ResultType: str
27019
27802
  :param _Result: 指标查询结果
27020
27803
  :type Result: str
@@ -27027,7 +27810,11 @@ class QueryMetricResponse(AbstractModel):
27027
27810
 
27028
27811
  @property
27029
27812
  def ResultType(self):
27030
- """指标查询结果类型
27813
+ """指标查询结果类型,支持
27814
+ - scalar 标量值
27815
+ - string 字符串值
27816
+ - vector 瞬时向量
27817
+ - matrix 区间向量
27031
27818
  :rtype: str
27032
27819
  """
27033
27820
  return self._ResultType
@@ -27073,8 +27860,10 @@ class QueryRangeMetricRequest(AbstractModel):
27073
27860
  def __init__(self):
27074
27861
  r"""
27075
27862
  :param _TopicId: 指标主题ID
27863
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27076
27864
  :type TopicId: str
27077
27865
  :param _Query: 查询语句,使用PromQL语法
27866
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27078
27867
  :type Query: str
27079
27868
  :param _Start: 查询起始时间,秒级Unix时间戳
27080
27869
  :type Start: int
@@ -27092,6 +27881,7 @@ class QueryRangeMetricRequest(AbstractModel):
27092
27881
  @property
27093
27882
  def TopicId(self):
27094
27883
  """指标主题ID
27884
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27095
27885
  :rtype: str
27096
27886
  """
27097
27887
  return self._TopicId
@@ -27103,6 +27893,7 @@ class QueryRangeMetricRequest(AbstractModel):
27103
27893
  @property
27104
27894
  def Query(self):
27105
27895
  """查询语句,使用PromQL语法
27896
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27106
27897
  :rtype: str
27107
27898
  """
27108
27899
  return self._Query
@@ -27168,7 +27959,11 @@ class QueryRangeMetricResponse(AbstractModel):
27168
27959
 
27169
27960
  def __init__(self):
27170
27961
  r"""
27171
- :param _ResultType: 指标查询结果类型
27962
+ :param _ResultType: 指标查询结果类型,支持
27963
+ - scalar 标量值
27964
+ - string 字符串值
27965
+ - vector 瞬时向量
27966
+ - matrix 区间向量
27172
27967
  :type ResultType: str
27173
27968
  :param _Result: 指标查询结果
27174
27969
  :type Result: str
@@ -27181,7 +27976,11 @@ class QueryRangeMetricResponse(AbstractModel):
27181
27976
 
27182
27977
  @property
27183
27978
  def ResultType(self):
27184
- """指标查询结果类型
27979
+ """指标查询结果类型,支持
27980
+ - scalar 标量值
27981
+ - string 字符串值
27982
+ - vector 瞬时向量
27983
+ - matrix 区间向量
27185
27984
  :rtype: str
27186
27985
  """
27187
27986
  return self._ResultType
@@ -27524,9 +28323,9 @@ class ScheduledSqlResouceInfo(AbstractModel):
27524
28323
 
27525
28324
  def __init__(self):
27526
28325
  r"""
27527
- :param _TopicId: 目标主题id
28326
+ :param _TopicId: 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27528
28327
  :type TopicId: str
27529
- :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) 文档。
27530
28329
  :type Region: str
27531
28330
  :param _BizType: 主题类型:0为日志主题,1为指标主题
27532
28331
  :type BizType: int
@@ -27554,7 +28353,7 @@ BizType为1时,优先使用MetricNames字段多指标只能填充到MetricName
27554
28353
 
27555
28354
  @property
27556
28355
  def TopicId(self):
27557
- """目标主题id
28356
+ """通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27558
28357
  :rtype: str
27559
28358
  """
27560
28359
  return self._TopicId
@@ -27565,7 +28364,7 @@ BizType为1时,优先使用MetricNames字段多指标只能填充到MetricName
27565
28364
 
27566
28365
  @property
27567
28366
  def Region(self):
27568
- """主题的地域信息
28367
+ """主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
27569
28368
  :rtype: str
27570
28369
  """
27571
28370
  return self._Region
@@ -27684,9 +28483,9 @@ class ScheduledSqlTaskInfo(AbstractModel):
27684
28483
  :type SrcTopicName: str
27685
28484
  :param _DstResource: 定时SQL分析目标主题
27686
28485
  :type DstResource: :class:`tencentcloud.cls.v20201016.models.ScheduledSqlResouceInfo`
27687
- :param _CreateTime: 任务创建时间
28486
+ :param _CreateTime: 任务创建时间。格式:yyyy-MM-dd HH:mm:ss
27688
28487
  :type CreateTime: str
27689
- :param _UpdateTime: 任务更新时间
28488
+ :param _UpdateTime: 任务更新时间,格式:yyyy-MM-dd HH:mm:ss
27690
28489
  :type UpdateTime: str
27691
28490
  :param _Status: 任务状态,1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题
27692
28491
 
@@ -27696,19 +28495,19 @@ class ScheduledSqlTaskInfo(AbstractModel):
27696
28495
  :type EnableFlag: int
27697
28496
  :param _ScheduledSqlContent: 查询语句
27698
28497
  :type ScheduledSqlContent: str
27699
- :param _ProcessStartTime: 调度开始时间
28498
+ :param _ProcessStartTime: 调度开始时间,格式:yyyy-MM-dd HH:mm:ss
27700
28499
  :type ProcessStartTime: str
27701
28500
  :param _ProcessType: 调度类型,1:持续运行 2:指定时间范围
27702
28501
  :type ProcessType: int
27703
- :param _ProcessEndTime: 调度结束时间,当process_type=2时为必传字段
28502
+ :param _ProcessEndTime: 调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段
27704
28503
  :type ProcessEndTime: str
27705
- :param _ProcessPeriod: 调度周期(分钟)
28504
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
27706
28505
  :type ProcessPeriod: int
27707
28506
  :param _ProcessTimeWindow: 查询的时间窗口. @m-15m, @m,意为近15分钟
27708
28507
  :type ProcessTimeWindow: str
27709
- :param _ProcessDelay: 执行延迟(秒)
28508
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
27710
28509
  :type ProcessDelay: int
27711
- :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) 文档。
27712
28511
  :type SrcTopicRegion: str
27713
28512
  :param _SyntaxRule: 语法规则,0:Lucene语法,1:CQL语法
27714
28513
  :type SyntaxRule: int
@@ -27795,7 +28594,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27795
28594
 
27796
28595
  @property
27797
28596
  def CreateTime(self):
27798
- """任务创建时间
28597
+ """任务创建时间。格式:yyyy-MM-dd HH:mm:ss
27799
28598
  :rtype: str
27800
28599
  """
27801
28600
  return self._CreateTime
@@ -27806,7 +28605,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27806
28605
 
27807
28606
  @property
27808
28607
  def UpdateTime(self):
27809
- """任务更新时间
28608
+ """任务更新时间,格式:yyyy-MM-dd HH:mm:ss
27810
28609
  :rtype: str
27811
28610
  """
27812
28611
  return self._UpdateTime
@@ -27852,7 +28651,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27852
28651
 
27853
28652
  @property
27854
28653
  def ProcessStartTime(self):
27855
- """调度开始时间
28654
+ """调度开始时间,格式:yyyy-MM-dd HH:mm:ss
27856
28655
  :rtype: str
27857
28656
  """
27858
28657
  return self._ProcessStartTime
@@ -27874,7 +28673,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27874
28673
 
27875
28674
  @property
27876
28675
  def ProcessEndTime(self):
27877
- """调度结束时间,当process_type=2时为必传字段
28676
+ """调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段
27878
28677
  :rtype: str
27879
28678
  """
27880
28679
  return self._ProcessEndTime
@@ -27885,7 +28684,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27885
28684
 
27886
28685
  @property
27887
28686
  def ProcessPeriod(self):
27888
- """调度周期(分钟)
28687
+ """调度周期(分钟),1~1440分钟
27889
28688
  :rtype: int
27890
28689
  """
27891
28690
  return self._ProcessPeriod
@@ -27907,7 +28706,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27907
28706
 
27908
28707
  @property
27909
28708
  def ProcessDelay(self):
27910
- """执行延迟(秒)
28709
+ """执行延迟(秒),0~120秒,默认60秒
27911
28710
  :rtype: int
27912
28711
  """
27913
28712
  return self._ProcessDelay
@@ -27918,7 +28717,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27918
28717
 
27919
28718
  @property
27920
28719
  def SrcTopicRegion(self):
27921
- """源topicId的地域信息
28720
+ """源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
27922
28721
  :rtype: str
27923
28722
  """
27924
28723
  return self._SrcTopicRegion
@@ -29924,6 +30723,7 @@ class TopicInfo(AbstractModel):
29924
30723
  :param _AssumerName: 云产品标识,主题由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
29925
30724
  :type AssumerName: str
29926
30725
  :param _CreateTime: 创建时间
30726
+ 时间格式:yyyy-MM-dd HH:mm:ss
29927
30727
  :type CreateTime: str
29928
30728
  :param _Status: 主题是否开启采集,true:开启采集;false:关闭采集。
29929
30729
  创建日志主题时默认开启,可通过SDK调用ModifyTopic修改此字段。
@@ -29962,8 +30762,13 @@ HotPeriod=0为没有开启日志沉降。
29962
30762
  :param _TopicAsyncTaskID: 异步迁移任务ID
29963
30763
  :type TopicAsyncTaskID: str
29964
30764
  :param _MigrationStatus: 异步迁移状态
30765
+ - 1:进行中
30766
+ - 2:已完成
30767
+ - 3:失败
30768
+ - 4:已取消
29965
30769
  :type MigrationStatus: int
29966
30770
  :param _EffectiveDate: 异步迁移完成后,预计生效日期
30771
+ 时间格式:yyyy-MM-dd HH:mm:ss
29967
30772
  :type EffectiveDate: str
29968
30773
  """
29969
30774
  self._LogsetId = None
@@ -30058,6 +30863,7 @@ HotPeriod=0为没有开启日志沉降。
30058
30863
  @property
30059
30864
  def CreateTime(self):
30060
30865
  """创建时间
30866
+ 时间格式:yyyy-MM-dd HH:mm:ss
30061
30867
  :rtype: str
30062
30868
  """
30063
30869
  return self._CreateTime
@@ -30222,6 +31028,10 @@ HotPeriod=0为没有开启日志沉降。
30222
31028
  @property
30223
31029
  def MigrationStatus(self):
30224
31030
  """异步迁移状态
31031
+ - 1:进行中
31032
+ - 2:已完成
31033
+ - 3:失败
31034
+ - 4:已取消
30225
31035
  :rtype: int
30226
31036
  """
30227
31037
  return self._MigrationStatus
@@ -30233,6 +31043,7 @@ HotPeriod=0为没有开启日志沉降。
30233
31043
  @property
30234
31044
  def EffectiveDate(self):
30235
31045
  """异步迁移完成后,预计生效日期
31046
+ 时间格式:yyyy-MM-dd HH:mm:ss
30236
31047
  :rtype: str
30237
31048
  """
30238
31049
  return self._EffectiveDate
@@ -30289,11 +31100,14 @@ class UploadLogRequest(AbstractModel):
30289
31100
 
30290
31101
  def __init__(self):
30291
31102
  r"""
30292
- :param _TopicId: 主题id
31103
+ :param _TopicId: 日志主题id
31104
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
30293
31105
  :type TopicId: str
30294
31106
  :param _HashKey: 该参数已废弃,请勿使用
30295
31107
  :type HashKey: str
30296
- :param _CompressType: 压缩方法
31108
+ :param _CompressType: 压缩方法,目前支持
31109
+ - lz4
31110
+ - zstd
30297
31111
  :type CompressType: str
30298
31112
  """
30299
31113
  self._TopicId = None
@@ -30302,7 +31116,8 @@ class UploadLogRequest(AbstractModel):
30302
31116
 
30303
31117
  @property
30304
31118
  def TopicId(self):
30305
- """主题id
31119
+ """日志主题id
31120
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
30306
31121
  :rtype: str
30307
31122
  """
30308
31123
  return self._TopicId
@@ -30328,7 +31143,9 @@ class UploadLogRequest(AbstractModel):
30328
31143
 
30329
31144
  @property
30330
31145
  def CompressType(self):
30331
- """压缩方法
31146
+ """压缩方法,目前支持
31147
+ - lz4
31148
+ - zstd
30332
31149
  :rtype: str
30333
31150
  """
30334
31151
  return self._CompressType