tencentcloud-sdk-python 3.0.1442__py2.py3-none-any.whl → 3.0.1444__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 (66) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/batch/v20170312/models.py +30 -50
  3. tencentcloud/ckafka/v20190819/models.py +23 -23
  4. tencentcloud/clb/v20180317/models.py +426 -30
  5. tencentcloud/cls/v20201016/cls_client.py +4 -4
  6. tencentcloud/cls/v20201016/errorcodes.py +3 -0
  7. tencentcloud/cls/v20201016/models.py +1089 -324
  8. tencentcloud/common/credential.py +20 -2
  9. tencentcloud/dnspod/v20210323/errorcodes.py +3 -0
  10. tencentcloud/dnspod/v20210323/models.py +17 -2
  11. tencentcloud/es/v20180416/models.py +30 -0
  12. tencentcloud/ess/v20201111/ess_client.py +3 -1
  13. tencentcloud/ess/v20201111/models.py +2 -2
  14. tencentcloud/essbasic/v20210526/essbasic_client.py +3 -1
  15. tencentcloud/essbasic/v20210526/models.py +2 -2
  16. tencentcloud/iai/v20200303/models.py +19 -0
  17. tencentcloud/keewidb/v20220308/errorcodes.py +3 -0
  18. tencentcloud/keewidb/v20220308/models.py +2 -2
  19. tencentcloud/lcic/v20220817/errorcodes.py +15 -0
  20. tencentcloud/lcic/v20220817/models.py +67 -16
  21. tencentcloud/lighthouse/v20200324/errorcodes.py +27 -0
  22. tencentcloud/lighthouse/v20200324/lighthouse_client.py +53 -0
  23. tencentcloud/lighthouse/v20200324/models.py +534 -0
  24. tencentcloud/live/v20180801/models.py +2 -10
  25. tencentcloud/lke/v20231130/lke_client.py +0 -23
  26. tencentcloud/lke/v20231130/models.py +40 -128
  27. tencentcloud/lkeap/v20240522/errorcodes.py +1 -1
  28. tencentcloud/mongodb/v20190725/models.py +4 -4
  29. tencentcloud/mps/v20190612/models.py +64 -0
  30. tencentcloud/ocr/v20181119/models.py +65 -16
  31. tencentcloud/organization/v20210331/models.py +24 -26
  32. tencentcloud/postgres/v20170312/errorcodes.py +0 -12
  33. tencentcloud/postgres/v20170312/models.py +191 -1527
  34. tencentcloud/postgres/v20170312/postgres_client.py +0 -75
  35. tencentcloud/ssl/v20191205/models.py +2 -2
  36. tencentcloud/sts/v20180813/sts_client.py +21 -7
  37. tencentcloud/tbaas/v20180416/errorcodes.py +6 -0
  38. tencentcloud/tcbr/v20220217/models.py +151 -0
  39. tencentcloud/tcss/v20201101/models.py +45 -0
  40. tencentcloud/teo/v20220901/models.py +18 -18
  41. tencentcloud/tke/v20180525/models.py +17 -2
  42. tencentcloud/tms/v20201229/errorcodes.py +3 -0
  43. tencentcloud/trabbit/v20230418/models.py +60 -0
  44. tencentcloud/trocket/v20230308/models.py +319 -0
  45. tencentcloud/trocket/v20230308/trocket_client.py +25 -0
  46. tencentcloud/trtc/v20190722/errorcodes.py +18 -0
  47. tencentcloud/trtc/v20190722/models.py +486 -2
  48. tencentcloud/trtc/v20190722/trtc_client.py +64 -0
  49. tencentcloud/tse/v20201207/models.py +30 -0
  50. tencentcloud/tsf/v20180326/errorcodes.py +41 -11
  51. tencentcloud/tsf/v20180326/models.py +1705 -1263
  52. tencentcloud/tsf/v20180326/tsf_client.py +18 -18
  53. tencentcloud/vod/v20180717/models.py +78 -10
  54. tencentcloud/vod/v20180717/vod_client.py +1 -0
  55. tencentcloud/vpc/v20170312/models.py +35 -0
  56. tencentcloud/vpc/v20170312/vpc_client.py +1 -1
  57. tencentcloud/waf/v20180125/errorcodes.py +6 -0
  58. tencentcloud/waf/v20180125/models.py +1926 -744
  59. tencentcloud/waf/v20180125/waf_client.py +161 -0
  60. tencentcloud/wedata/v20210820/models.py +204 -0
  61. tencentcloud/wsa/v20250508/models.py +42 -6
  62. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1444.dist-info}/METADATA +1 -1
  63. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1444.dist-info}/RECORD +66 -66
  64. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1444.dist-info}/LICENSE +0 -0
  65. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1444.dist-info}/WHEEL +0 -0
  66. {tencentcloud_sdk_python-3.0.1442.dist-info → tencentcloud_sdk_python-3.0.1444.dist-info}/top_level.txt +0 -0
@@ -25,7 +25,8 @@ class AddMachineGroupInfoRequest(AbstractModel):
25
25
 
26
26
  def __init__(self):
27
27
  r"""
28
- :param _GroupId: 机器组ID
28
+ :param _GroupId: 机器组Id
29
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
29
30
  :type GroupId: str
30
31
  :param _MachineGroupType: 机器组类型
31
32
  目前type支持 ip 和 label
@@ -36,7 +37,8 @@ class AddMachineGroupInfoRequest(AbstractModel):
36
37
 
37
38
  @property
38
39
  def GroupId(self):
39
- """机器组ID
40
+ """机器组Id
41
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
40
42
  :rtype: str
41
43
  """
42
44
  return self._GroupId
@@ -308,7 +310,7 @@ class AlarmInfo(AbstractModel):
308
310
  :type AlarmTargets: list of AlarmTargetInfo
309
311
  :param _MonitorTime: 监控任务运行时间点。
310
312
  :type MonitorTime: :class:`tencentcloud.cls.v20201016.models.MonitorTime`
311
- :param _Condition: 单触发条件。与MultiConditions参数互斥。
313
+ :param _Condition: 是否触发告警的单触发条件。与MultiConditions参数互斥。
312
314
  :type Condition: str
313
315
  :param _TriggerCount: 持续周期。持续满足触发条件TriggerCount个周期后,再进行告警;最小值为1,最大值为10。
314
316
  :type TriggerCount: int
@@ -320,9 +322,9 @@ class AlarmInfo(AbstractModel):
320
322
  :type Status: bool
321
323
  :param _AlarmId: 告警策略ID。
322
324
  :type AlarmId: str
323
- :param _CreateTime: 创建时间。
325
+ :param _CreateTime: 创建时间。格式: YYYY-MM-DD HH:MM:SS
324
326
  :type CreateTime: str
325
- :param _UpdateTime: 最近更新时间。
327
+ :param _UpdateTime: 最近更新时间。格式: YYYY-MM-DD HH:MM:SS
326
328
  :type UpdateTime: str
327
329
  :param _MessageTemplate: 自定义通知模板
328
330
  注意:此字段可能返回 null,表示取不到有效值。
@@ -404,7 +406,7 @@ Condition互斥。
404
406
 
405
407
  @property
406
408
  def Condition(self):
407
- """单触发条件。与MultiConditions参数互斥。
409
+ """是否触发告警的单触发条件。与MultiConditions参数互斥。
408
410
  :rtype: str
409
411
  """
410
412
  return self._Condition
@@ -470,7 +472,7 @@ Condition互斥。
470
472
 
471
473
  @property
472
474
  def CreateTime(self):
473
- """创建时间。
475
+ """创建时间。格式: YYYY-MM-DD HH:MM:SS
474
476
  :rtype: str
475
477
  """
476
478
  return self._CreateTime
@@ -481,7 +483,7 @@ Condition互斥。
481
483
 
482
484
  @property
483
485
  def UpdateTime(self):
484
- """最近更新时间。
486
+ """最近更新时间。格式: YYYY-MM-DD HH:MM:SS
485
487
  :rtype: str
486
488
  """
487
489
  return self._UpdateTime
@@ -696,9 +698,9 @@ class AlarmNotice(AbstractModel):
696
698
  :param _AlarmNoticeDeliverConfig: 投递相关信息。
697
699
  注意:此字段可能返回 null,表示取不到有效值。
698
700
  :type AlarmNoticeDeliverConfig: :class:`tencentcloud.cls.v20201016.models.AlarmNoticeDeliverConfig`
699
- :param _CreateTime: 创建时间。
701
+ :param _CreateTime: 创建时间。格式: YYYY-MM-DD HH:MM:SS
700
702
  :type CreateTime: str
701
- :param _UpdateTime: 最近更新时间。
703
+ :param _UpdateTime: 最近更新时间。格式: YYYY-MM-DD HH:MM:SS
702
704
  :type UpdateTime: str
703
705
  """
704
706
  self._Name = None
@@ -831,7 +833,7 @@ class AlarmNotice(AbstractModel):
831
833
 
832
834
  @property
833
835
  def CreateTime(self):
834
- """创建时间。
836
+ """创建时间。格式: YYYY-MM-DD HH:MM:SS
835
837
  :rtype: str
836
838
  """
837
839
  return self._CreateTime
@@ -842,7 +844,7 @@ class AlarmNotice(AbstractModel):
842
844
 
843
845
  @property
844
846
  def UpdateTime(self):
845
- """最近更新时间。
847
+ """最近更新时间。格式: YYYY-MM-DD HH:MM:SS
846
848
  :rtype: str
847
849
  """
848
850
  return self._UpdateTime
@@ -979,9 +981,9 @@ class AlarmShieldInfo(AbstractModel):
979
981
  :param _Status: 规则状态。
980
982
  0:暂未生效,1:生效中,2:已失效
981
983
  :type Status: int
982
- :param _CreateTime: 规则创建时间。
984
+ :param _CreateTime: 规则创建时间。秒级时间戳(s)
983
985
  :type CreateTime: int
984
- :param _UpdateTime: 规则更新时间。
986
+ :param _UpdateTime: 规则更新时间。秒级时间戳(s)
985
987
  :type UpdateTime: int
986
988
  """
987
989
  self._AlarmNoticeId = None
@@ -1111,7 +1113,7 @@ class AlarmShieldInfo(AbstractModel):
1111
1113
 
1112
1114
  @property
1113
1115
  def CreateTime(self):
1114
- """规则创建时间。
1116
+ """规则创建时间。秒级时间戳(s)
1115
1117
  :rtype: int
1116
1118
  """
1117
1119
  return self._CreateTime
@@ -1122,7 +1124,7 @@ class AlarmShieldInfo(AbstractModel):
1122
1124
 
1123
1125
  @property
1124
1126
  def UpdateTime(self):
1125
- """规则更新时间。
1127
+ """规则更新时间。秒级时间戳(s)
1126
1128
  :rtype: int
1127
1129
  """
1128
1130
  return self._UpdateTime
@@ -1162,7 +1164,7 @@ class AlarmTarget(AbstractModel):
1162
1164
 
1163
1165
  def __init__(self):
1164
1166
  r"""
1165
- :param _TopicId: 日志主题ID
1167
+ :param _TopicId: 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
1166
1168
  :type TopicId: str
1167
1169
  :param _Query: 查询语句。
1168
1170
  :type Query: str
@@ -1172,7 +1174,7 @@ class AlarmTarget(AbstractModel):
1172
1174
  :type StartTimeOffset: int
1173
1175
  :param _EndTimeOffset: 查询范围终止时间相对于告警执行时间的偏移,单位为分钟,取值为非正,须大于StartTimeOffset,最大值为0,最小值为-1440。
1174
1176
  :type EndTimeOffset: int
1175
- :param _LogsetId: 日志集ID
1177
+ :param _LogsetId: 日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID
1176
1178
  :type LogsetId: str
1177
1179
  :param _SyntaxRule: 检索语法规则,默认值为0。
1178
1180
  0:Lucene语法,1:CQL语法。
@@ -1189,7 +1191,7 @@ class AlarmTarget(AbstractModel):
1189
1191
 
1190
1192
  @property
1191
1193
  def TopicId(self):
1192
- """日志主题ID
1194
+ """日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
1193
1195
  :rtype: str
1194
1196
  """
1195
1197
  return self._TopicId
@@ -1244,7 +1246,7 @@ class AlarmTarget(AbstractModel):
1244
1246
 
1245
1247
  @property
1246
1248
  def LogsetId(self):
1247
- """日志集ID
1249
+ """日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID
1248
1250
  :rtype: str
1249
1251
  """
1250
1252
  return self._LogsetId
@@ -1536,15 +1538,15 @@ class AlertHistoryRecord(AbstractModel):
1536
1538
  :type Trigger: str
1537
1539
  :param _TriggerCount: 持续周期,持续满足触发条件TriggerCount个周期后,再进行告警
1538
1540
  :type TriggerCount: int
1539
- :param _AlarmPeriod: 告警通知发送频率,单位为分钟
1541
+ :param _AlarmPeriod: 告警通知发送频率,单位为分钟(min)
1540
1542
  :type AlarmPeriod: int
1541
1543
  :param _Notices: 通知渠道组
1542
1544
  :type Notices: list of AlertHistoryNotice
1543
- :param _Duration: 告警持续时间,单位为分钟
1545
+ :param _Duration: 告警持续时间,单位为分钟(min)
1544
1546
  :type Duration: int
1545
1547
  :param _Status: 告警状态,0代表未恢复,1代表已恢复,2代表已失效
1546
1548
  :type Status: int
1547
- :param _CreateTime: 告警发生时间,毫秒级Unix时间戳
1549
+ :param _CreateTime: 告警发生时间,毫秒级Unix时间戳(ms)
1548
1550
  :type CreateTime: int
1549
1551
  :param _GroupTriggerCondition: 告警分组触发时对应的分组信息
1550
1552
  :type GroupTriggerCondition: list of GroupTriggerConditionInfo
@@ -1661,7 +1663,7 @@ class AlertHistoryRecord(AbstractModel):
1661
1663
 
1662
1664
  @property
1663
1665
  def AlarmPeriod(self):
1664
- """告警通知发送频率,单位为分钟
1666
+ """告警通知发送频率,单位为分钟(min)
1665
1667
  :rtype: int
1666
1668
  """
1667
1669
  return self._AlarmPeriod
@@ -1683,7 +1685,7 @@ class AlertHistoryRecord(AbstractModel):
1683
1685
 
1684
1686
  @property
1685
1687
  def Duration(self):
1686
- """告警持续时间,单位为分钟
1688
+ """告警持续时间,单位为分钟(min)
1687
1689
  :rtype: int
1688
1690
  """
1689
1691
  return self._Duration
@@ -1705,7 +1707,7 @@ class AlertHistoryRecord(AbstractModel):
1705
1707
 
1706
1708
  @property
1707
1709
  def CreateTime(self):
1708
- """告警发生时间,毫秒级Unix时间戳
1710
+ """告警发生时间,毫秒级Unix时间戳(ms)
1709
1711
  :rtype: int
1710
1712
  """
1711
1713
  return self._CreateTime
@@ -1795,7 +1797,8 @@ class AnalysisDimensional(AbstractModel):
1795
1797
  r"""
1796
1798
  :param _Name: 分析名称
1797
1799
  :type Name: str
1798
- :param _Type: 分析类型:query,field ,original
1800
+ :param _Type: 分析类型:query(自定义检索分析),field(字段TOP5及占比统计) ,original(相关原始日志)
1801
+
1799
1802
  :type Type: str
1800
1803
  :param _Content: 分析内容
1801
1804
  :type Content: str
@@ -1860,7 +1863,8 @@ class AnalysisDimensional(AbstractModel):
1860
1863
 
1861
1864
  @property
1862
1865
  def Type(self):
1863
- """分析类型:query,field ,original
1866
+ """分析类型:query(自定义检索分析),field(字段TOP5及占比统计) ,original(相关原始日志)
1867
+
1864
1868
  :rtype: str
1865
1869
  """
1866
1870
  return self._Type
@@ -2016,8 +2020,10 @@ class ApplyConfigToMachineGroupRequest(AbstractModel):
2016
2020
  def __init__(self):
2017
2021
  r"""
2018
2022
  :param _ConfigId: 采集配置ID
2023
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
2019
2024
  :type ConfigId: str
2020
2025
  :param _GroupId: 机器组ID
2026
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
2021
2027
  :type GroupId: str
2022
2028
  """
2023
2029
  self._ConfigId = None
@@ -2026,6 +2032,7 @@ class ApplyConfigToMachineGroupRequest(AbstractModel):
2026
2032
  @property
2027
2033
  def ConfigId(self):
2028
2034
  """采集配置ID
2035
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
2029
2036
  :rtype: str
2030
2037
  """
2031
2038
  return self._ConfigId
@@ -2037,6 +2044,7 @@ class ApplyConfigToMachineGroupRequest(AbstractModel):
2037
2044
  @property
2038
2045
  def GroupId(self):
2039
2046
  """机器组ID
2047
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
2040
2048
  :rtype: str
2041
2049
  """
2042
2050
  return self._GroupId
@@ -2177,9 +2185,15 @@ class CheckFunctionRequest(AbstractModel):
2177
2185
 
2178
2186
  def __init__(self):
2179
2187
  r"""
2180
- :param _EtlContent: 用户输入的加工语句
2188
+ :param _EtlContent: 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
2189
+
2190
+ 其他参考文档:
2191
+
2192
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
2193
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
2181
2194
  :type EtlContent: str
2182
- :param _DstResources: 加工任务目的topic_id以及别名
2195
+ :param _DstResources: 加工任务目标topic_id以及别名,当 FuncType 为 1 时,必填。
2196
+ 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2183
2197
  :type DstResources: list of DataTransformResouceInfo
2184
2198
  :param _FuncType: 数据加工目标主题的类型. 1 固定主题 2动态创建
2185
2199
  :type FuncType: int
@@ -2190,7 +2204,12 @@ class CheckFunctionRequest(AbstractModel):
2190
2204
 
2191
2205
  @property
2192
2206
  def EtlContent(self):
2193
- """用户输入的加工语句
2207
+ """加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
2208
+
2209
+ 其他参考文档:
2210
+
2211
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
2212
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
2194
2213
  :rtype: str
2195
2214
  """
2196
2215
  return self._EtlContent
@@ -2201,7 +2220,8 @@ class CheckFunctionRequest(AbstractModel):
2201
2220
 
2202
2221
  @property
2203
2222
  def DstResources(self):
2204
- """加工任务目的topic_id以及别名
2223
+ """加工任务目标topic_id以及别名,当 FuncType 为 1 时,必填。
2224
+ 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
2205
2225
  :rtype: list of DataTransformResouceInfo
2206
2226
  """
2207
2227
  return self._DstResources
@@ -2481,17 +2501,31 @@ class Ckafka(AbstractModel):
2481
2501
 
2482
2502
  def __init__(self):
2483
2503
  r"""
2484
- :param _InstanceId: Ckafka 的 InstanceId
2504
+ :param _InstanceId: Ckafka 的 InstanceId
2505
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
2506
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
2485
2507
  :type InstanceId: str
2486
- :param _TopicName: Ckafka 的 TopicName
2508
+ :param _TopicName: Ckafka 的 TopicName
2509
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
2510
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
2487
2511
  :type TopicName: str
2488
- :param _Vip: Ckafka 的 Vip
2512
+ :param _Vip: Ckafka 的 Vip
2513
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
2514
+ - 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
2489
2515
  :type Vip: str
2490
- :param _Vport: Ckafka 的 Vport
2516
+ :param _Vport: Ckafka 的 Vport
2517
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
2518
+ - 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
2491
2519
  :type Vport: str
2492
- :param _InstanceName: Ckafka 的 InstanceName
2520
+ :param _InstanceName: Ckafka 的 InstanceName
2521
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
2522
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
2523
+ - 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。
2493
2524
  :type InstanceName: str
2494
- :param _TopicId: Ckafka 的 TopicId
2525
+ :param _TopicId: Ckafka 的 TopicId
2526
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
2527
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
2528
+ - 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。
2495
2529
  :type TopicId: str
2496
2530
  """
2497
2531
  self._InstanceId = None
@@ -2503,7 +2537,9 @@ class Ckafka(AbstractModel):
2503
2537
 
2504
2538
  @property
2505
2539
  def InstanceId(self):
2506
- """Ckafka 的 InstanceId
2540
+ """Ckafka 的 InstanceId
2541
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
2542
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
2507
2543
  :rtype: str
2508
2544
  """
2509
2545
  return self._InstanceId
@@ -2514,7 +2550,9 @@ class Ckafka(AbstractModel):
2514
2550
 
2515
2551
  @property
2516
2552
  def TopicName(self):
2517
- """Ckafka 的 TopicName
2553
+ """Ckafka 的 TopicName
2554
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
2555
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
2518
2556
  :rtype: str
2519
2557
  """
2520
2558
  return self._TopicName
@@ -2525,7 +2563,9 @@ class Ckafka(AbstractModel):
2525
2563
 
2526
2564
  @property
2527
2565
  def Vip(self):
2528
- """Ckafka 的 Vip
2566
+ """Ckafka 的 Vip
2567
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
2568
+ - 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
2529
2569
  :rtype: str
2530
2570
  """
2531
2571
  return self._Vip
@@ -2536,7 +2576,9 @@ class Ckafka(AbstractModel):
2536
2576
 
2537
2577
  @property
2538
2578
  def Vport(self):
2539
- """Ckafka 的 Vport
2579
+ """Ckafka 的 Vport
2580
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
2581
+ - 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
2540
2582
  :rtype: str
2541
2583
  """
2542
2584
  return self._Vport
@@ -2547,7 +2589,10 @@ class Ckafka(AbstractModel):
2547
2589
 
2548
2590
  @property
2549
2591
  def InstanceName(self):
2550
- """Ckafka 的 InstanceName
2592
+ """Ckafka 的 InstanceName
2593
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
2594
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
2595
+ - 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。
2551
2596
  :rtype: str
2552
2597
  """
2553
2598
  return self._InstanceName
@@ -2558,7 +2603,10 @@ class Ckafka(AbstractModel):
2558
2603
 
2559
2604
  @property
2560
2605
  def TopicId(self):
2561
- """Ckafka 的 TopicId
2606
+ """Ckafka 的 TopicId
2607
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
2608
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
2609
+ - 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。
2562
2610
  :rtype: str
2563
2611
  """
2564
2612
  return self._TopicId
@@ -2592,14 +2640,18 @@ class CloseKafkaConsumerRequest(AbstractModel):
2592
2640
 
2593
2641
  def __init__(self):
2594
2642
  r"""
2595
- :param _FromTopicId: 日志主题ID
2643
+ :param _FromTopicId: 日志主题Id。
2644
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2645
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2596
2646
  :type FromTopicId: str
2597
2647
  """
2598
2648
  self._FromTopicId = None
2599
2649
 
2600
2650
  @property
2601
2651
  def FromTopicId(self):
2602
- """日志主题ID
2652
+ """日志主题Id。
2653
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2654
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2603
2655
  :rtype: str
2604
2656
  """
2605
2657
  return self._FromTopicId
@@ -3049,7 +3101,10 @@ class ConfigExtraInfo(AbstractModel):
3049
3101
  :type Name: str
3050
3102
  :param _TopicId: 日志主题ID
3051
3103
  :type TopicId: str
3052
- :param _Type: 类型:container_stdout、container_file、host_file
3104
+ :param _Type: 自建k8s集群日志采集类型,支持
3105
+ - container_stdout 标准输出
3106
+ - container_file 标准文件
3107
+ - host_file 节点文件
3053
3108
  :type Type: str
3054
3109
  :param _HostFile: 节点文件配置信息
3055
3110
  :type HostFile: :class:`tencentcloud.cls.v20201016.models.HostFileInfo`
@@ -3067,16 +3122,20 @@ class ConfigExtraInfo(AbstractModel):
3067
3122
  注意:此字段可能返回 null,表示取不到有效值。
3068
3123
  :type ExcludePaths: list of ExcludePathInfo
3069
3124
  :param _UpdateTime: 更新时间
3125
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3070
3126
  :type UpdateTime: str
3071
3127
  :param _CreateTime: 创建时间
3128
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3072
3129
  :type CreateTime: str
3073
3130
  :param _UserDefineRule: 用户自定义解析字符串
3074
3131
  :type UserDefineRule: str
3075
3132
  :param _GroupId: 机器组ID
3133
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
3076
3134
  :type GroupId: str
3077
3135
  :param _ConfigFlag: 自建采集配置标
3078
3136
  :type ConfigFlag: str
3079
3137
  :param _LogsetId: 日志集ID
3138
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
3080
3139
  :type LogsetId: str
3081
3140
  :param _LogsetName: 日志集name
3082
3141
  :type LogsetName: str
@@ -3148,7 +3207,10 @@ class ConfigExtraInfo(AbstractModel):
3148
3207
 
3149
3208
  @property
3150
3209
  def Type(self):
3151
- """类型:container_stdout、container_file、host_file
3210
+ """自建k8s集群日志采集类型,支持
3211
+ - container_stdout 标准输出
3212
+ - container_file 标准文件
3213
+ - host_file 节点文件
3152
3214
  :rtype: str
3153
3215
  """
3154
3216
  return self._Type
@@ -3238,6 +3300,7 @@ class ConfigExtraInfo(AbstractModel):
3238
3300
  @property
3239
3301
  def UpdateTime(self):
3240
3302
  """更新时间
3303
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3241
3304
  :rtype: str
3242
3305
  """
3243
3306
  return self._UpdateTime
@@ -3249,6 +3312,7 @@ class ConfigExtraInfo(AbstractModel):
3249
3312
  @property
3250
3313
  def CreateTime(self):
3251
3314
  """创建时间
3315
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3252
3316
  :rtype: str
3253
3317
  """
3254
3318
  return self._CreateTime
@@ -3271,6 +3335,7 @@ class ConfigExtraInfo(AbstractModel):
3271
3335
  @property
3272
3336
  def GroupId(self):
3273
3337
  """机器组ID
3338
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
3274
3339
  :rtype: str
3275
3340
  """
3276
3341
  return self._GroupId
@@ -3293,6 +3358,7 @@ class ConfigExtraInfo(AbstractModel):
3293
3358
  @property
3294
3359
  def LogsetId(self):
3295
3360
  """日志集ID
3361
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
3296
3362
  :rtype: str
3297
3363
  """
3298
3364
  return self._LogsetId
@@ -3434,8 +3500,10 @@ class ConfigInfo(AbstractModel):
3434
3500
  :param _Output: 采集配置所属日志主题ID即TopicId
3435
3501
  :type Output: str
3436
3502
  :param _UpdateTime: 更新时间
3503
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3437
3504
  :type UpdateTime: str
3438
3505
  :param _CreateTime: 创建时间
3506
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3439
3507
  :type CreateTime: str
3440
3508
  :param _UserDefineRule: 用户自定义解析字符串,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310)。
3441
3509
  :type UserDefineRule: str
@@ -3563,6 +3631,7 @@ class ConfigInfo(AbstractModel):
3563
3631
  @property
3564
3632
  def UpdateTime(self):
3565
3633
  """更新时间
3634
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3566
3635
  :rtype: str
3567
3636
  """
3568
3637
  return self._UpdateTime
@@ -3574,6 +3643,7 @@ class ConfigInfo(AbstractModel):
3574
3643
  @property
3575
3644
  def CreateTime(self):
3576
3645
  """创建时间
3646
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3577
3647
  :rtype: str
3578
3648
  """
3579
3649
  return self._CreateTime
@@ -3877,6 +3947,169 @@ class ConsoleSharingConfig(AbstractModel):
3877
3947
 
3878
3948
 
3879
3949
 
3950
+ class ConsoleSharingInfo(AbstractModel):
3951
+ """控制台分享信息
3952
+
3953
+ """
3954
+
3955
+ def __init__(self):
3956
+ r"""
3957
+ :param _SharingId: 分享ID
3958
+ :type SharingId: str
3959
+ :param _SharingUrl: 分享链接
3960
+ 注意:此字段可能返回 null,表示取不到有效值。
3961
+ :type SharingUrl: str
3962
+ :param _SharingConfig: 匿名分享配置信息
3963
+ 注意:此字段可能返回 null,表示取不到有效值。
3964
+ :type SharingConfig: :class:`tencentcloud.cls.v20201016.models.ConsoleSharingConfig`
3965
+ :param _ExpiredTime: 过期时间
3966
+ 注意:此字段可能返回 null,表示取不到有效值。
3967
+ :type ExpiredTime: int
3968
+ :param _CreateTime: 创建时间
3969
+ 注意:此字段可能返回 null,表示取不到有效值。
3970
+ :type CreateTime: int
3971
+ :param _UpdateTime: 修改时间
3972
+ 注意:此字段可能返回 null,表示取不到有效值。
3973
+ :type UpdateTime: int
3974
+ :param _Status: 分享链接状态
3975
+ 1: 正常
3976
+ -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
3977
+ 注意:此字段可能返回 null,表示取不到有效值。
3978
+ :type Status: int
3979
+ :param _ContentSafetyCode: 10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,
3980
+ 24005-社会
3981
+ 注意:此字段可能返回 null,表示取不到有效值。
3982
+ :type ContentSafetyCode: int
3983
+ """
3984
+ self._SharingId = None
3985
+ self._SharingUrl = None
3986
+ self._SharingConfig = None
3987
+ self._ExpiredTime = None
3988
+ self._CreateTime = None
3989
+ self._UpdateTime = None
3990
+ self._Status = None
3991
+ self._ContentSafetyCode = None
3992
+
3993
+ @property
3994
+ def SharingId(self):
3995
+ """分享ID
3996
+ :rtype: str
3997
+ """
3998
+ return self._SharingId
3999
+
4000
+ @SharingId.setter
4001
+ def SharingId(self, SharingId):
4002
+ self._SharingId = SharingId
4003
+
4004
+ @property
4005
+ def SharingUrl(self):
4006
+ """分享链接
4007
+ 注意:此字段可能返回 null,表示取不到有效值。
4008
+ :rtype: str
4009
+ """
4010
+ return self._SharingUrl
4011
+
4012
+ @SharingUrl.setter
4013
+ def SharingUrl(self, SharingUrl):
4014
+ self._SharingUrl = SharingUrl
4015
+
4016
+ @property
4017
+ def SharingConfig(self):
4018
+ """匿名分享配置信息
4019
+ 注意:此字段可能返回 null,表示取不到有效值。
4020
+ :rtype: :class:`tencentcloud.cls.v20201016.models.ConsoleSharingConfig`
4021
+ """
4022
+ return self._SharingConfig
4023
+
4024
+ @SharingConfig.setter
4025
+ def SharingConfig(self, SharingConfig):
4026
+ self._SharingConfig = SharingConfig
4027
+
4028
+ @property
4029
+ def ExpiredTime(self):
4030
+ """过期时间
4031
+ 注意:此字段可能返回 null,表示取不到有效值。
4032
+ :rtype: int
4033
+ """
4034
+ return self._ExpiredTime
4035
+
4036
+ @ExpiredTime.setter
4037
+ def ExpiredTime(self, ExpiredTime):
4038
+ self._ExpiredTime = ExpiredTime
4039
+
4040
+ @property
4041
+ def CreateTime(self):
4042
+ """创建时间
4043
+ 注意:此字段可能返回 null,表示取不到有效值。
4044
+ :rtype: int
4045
+ """
4046
+ return self._CreateTime
4047
+
4048
+ @CreateTime.setter
4049
+ def CreateTime(self, CreateTime):
4050
+ self._CreateTime = CreateTime
4051
+
4052
+ @property
4053
+ def UpdateTime(self):
4054
+ """修改时间
4055
+ 注意:此字段可能返回 null,表示取不到有效值。
4056
+ :rtype: int
4057
+ """
4058
+ return self._UpdateTime
4059
+
4060
+ @UpdateTime.setter
4061
+ def UpdateTime(self, UpdateTime):
4062
+ self._UpdateTime = UpdateTime
4063
+
4064
+ @property
4065
+ def Status(self):
4066
+ """分享链接状态
4067
+ 1: 正常
4068
+ -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
4069
+ 注意:此字段可能返回 null,表示取不到有效值。
4070
+ :rtype: int
4071
+ """
4072
+ return self._Status
4073
+
4074
+ @Status.setter
4075
+ def Status(self, Status):
4076
+ self._Status = Status
4077
+
4078
+ @property
4079
+ def ContentSafetyCode(self):
4080
+ """10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,
4081
+ 24005-社会
4082
+ 注意:此字段可能返回 null,表示取不到有效值。
4083
+ :rtype: int
4084
+ """
4085
+ return self._ContentSafetyCode
4086
+
4087
+ @ContentSafetyCode.setter
4088
+ def ContentSafetyCode(self, ContentSafetyCode):
4089
+ self._ContentSafetyCode = ContentSafetyCode
4090
+
4091
+
4092
+ def _deserialize(self, params):
4093
+ self._SharingId = params.get("SharingId")
4094
+ self._SharingUrl = params.get("SharingUrl")
4095
+ if params.get("SharingConfig") is not None:
4096
+ self._SharingConfig = ConsoleSharingConfig()
4097
+ self._SharingConfig._deserialize(params.get("SharingConfig"))
4098
+ self._ExpiredTime = params.get("ExpiredTime")
4099
+ self._CreateTime = params.get("CreateTime")
4100
+ self._UpdateTime = params.get("UpdateTime")
4101
+ self._Status = params.get("Status")
4102
+ self._ContentSafetyCode = params.get("ContentSafetyCode")
4103
+ memeber_set = set(params.keys())
4104
+ for name, value in vars(self).items():
4105
+ property_name = name[1:]
4106
+ if property_name in memeber_set:
4107
+ memeber_set.remove(property_name)
4108
+ if len(memeber_set) > 0:
4109
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
4110
+
4111
+
4112
+
3880
4113
  class ConsoleSharingParam(AbstractModel):
3881
4114
  """控制台分享链接params参数
3882
4115
 
@@ -4875,7 +5108,7 @@ class CreateAlarmNoticeRequest(AbstractModel):
4875
5108
 
4876
5109
  def __init__(self):
4877
5110
  r"""
4878
- :param _Name: 通知渠道组名称。
5111
+ :param _Name: 通知渠道组名称。最大支持255个字节。 不支持 '|'。
4879
5112
  :type Name: str
4880
5113
  :param _Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持50个标签键值对,并且不能有重复的键值对。
4881
5114
  :type Tags: list of Tag
@@ -4921,7 +5154,7 @@ class CreateAlarmNoticeRequest(AbstractModel):
4921
5154
 
4922
5155
  @property
4923
5156
  def Name(self):
4924
- """通知渠道组名称。
5157
+ """通知渠道组名称。最大支持255个字节。 不支持 '|'。
4925
5158
  :rtype: str
4926
5159
  """
4927
5160
  return self._Name
@@ -5135,7 +5368,7 @@ class CreateAlarmRequest(AbstractModel):
5135
5368
 
5136
5369
  def __init__(self):
5137
5370
  r"""
5138
- :param _Name: 告警策略名称
5371
+ :param _Name: 告警策略名称。最大支持255个字节。 不支持 '|'。
5139
5372
  :type Name: str
5140
5373
  :param _AlarmTargets: 监控对象列表。
5141
5374
  :type AlarmTargets: list of AlarmTarget
@@ -5145,9 +5378,9 @@ class CreateAlarmRequest(AbstractModel):
5145
5378
  :type TriggerCount: int
5146
5379
  :param _AlarmPeriod: 告警重复的周期,单位是分钟。取值范围是0~1440。
5147
5380
  :type AlarmPeriod: int
5148
- :param _AlarmNoticeIds: 关联的告警通知模板列表。
5381
+ :param _AlarmNoticeIds: 关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表
5149
5382
  :type AlarmNoticeIds: list of str
5150
- :param _Condition: 触发条件
5383
+ :param _Condition: 告警发送通知的触发条件
5151
5384
  注意:
5152
5385
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
5153
5386
 
@@ -5218,7 +5451,7 @@ Classifications元素的Value长度不能超过200个字符。
5218
5451
 
5219
5452
  @property
5220
5453
  def Name(self):
5221
- """告警策略名称
5454
+ """告警策略名称。最大支持255个字节。 不支持 '|'。
5222
5455
  :rtype: str
5223
5456
  """
5224
5457
  return self._Name
@@ -5273,7 +5506,7 @@ Classifications元素的Value长度不能超过200个字符。
5273
5506
 
5274
5507
  @property
5275
5508
  def AlarmNoticeIds(self):
5276
- """关联的告警通知模板列表。
5509
+ """关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表
5277
5510
  :rtype: list of str
5278
5511
  """
5279
5512
  return self._AlarmNoticeIds
@@ -5284,7 +5517,7 @@ Classifications元素的Value长度不能超过200个字符。
5284
5517
 
5285
5518
  @property
5286
5519
  def Condition(self):
5287
- """触发条件
5520
+ """告警发送通知的触发条件
5288
5521
  注意:
5289
5522
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
5290
5523
 
@@ -5561,11 +5794,11 @@ class CreateAlarmShieldRequest(AbstractModel):
5561
5794
 
5562
5795
  def __init__(self):
5563
5796
  r"""
5564
- :param _AlarmNoticeId: 通知渠道组id
5797
+ :param _AlarmNoticeId: 通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取通知渠道组id
5565
5798
  :type AlarmNoticeId: str
5566
- :param _StartTime: 屏蔽开始时间(秒级时间戳)。
5799
+ :param _StartTime: 屏蔽规则开始时间,秒级(s)时间戳。
5567
5800
  :type StartTime: int
5568
- :param _EndTime: 屏蔽结束时间(秒级时间戳)。
5801
+ :param _EndTime: 屏蔽规则结束时间,秒级(s)时间戳。结束时间需要大于当前时间
5569
5802
  :type EndTime: int
5570
5803
  :param _Type: 屏蔽类型。1:屏蔽所有通知,2:按照Rule参数屏蔽匹配规则的通知。
5571
5804
  :type Type: int
@@ -5583,7 +5816,7 @@ class CreateAlarmShieldRequest(AbstractModel):
5583
5816
 
5584
5817
  @property
5585
5818
  def AlarmNoticeId(self):
5586
- """通知渠道组id
5819
+ """通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取通知渠道组id
5587
5820
  :rtype: str
5588
5821
  """
5589
5822
  return self._AlarmNoticeId
@@ -5594,7 +5827,7 @@ class CreateAlarmShieldRequest(AbstractModel):
5594
5827
 
5595
5828
  @property
5596
5829
  def StartTime(self):
5597
- """屏蔽开始时间(秒级时间戳)。
5830
+ """屏蔽规则开始时间,秒级(s)时间戳。
5598
5831
  :rtype: int
5599
5832
  """
5600
5833
  return self._StartTime
@@ -5605,7 +5838,7 @@ class CreateAlarmShieldRequest(AbstractModel):
5605
5838
 
5606
5839
  @property
5607
5840
  def EndTime(self):
5608
- """屏蔽结束时间(秒级时间戳)。
5841
+ """屏蔽规则结束时间,秒级(s)时间戳。结束时间需要大于当前时间
5609
5842
  :rtype: int
5610
5843
  """
5611
5844
  return self._EndTime
@@ -5716,12 +5949,13 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5716
5949
  def __init__(self):
5717
5950
  r"""
5718
5951
  :param _InstanceId: 实例ID
5952
+ - 通过各个接入云产品官方文档获取
5719
5953
  :type InstanceId: str
5720
5954
  :param _AssumerName: 云产品标识,支持枚举:CDS、CWP、CDB、TDSQL-C、MongoDB、TDStore、DCDB、MariaDB、PostgreSQL、BH、APIS
5721
5955
  :type AssumerName: str
5722
5956
  :param _LogType: 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
5723
5957
  :type LogType: str
5724
- :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
5958
+ :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
5725
5959
  - CDS所有日志类型:ap-guangzhou
5726
5960
  - CDB-AUDIT: gz
5727
5961
  - TDSQL-C-AUDIT: gz
@@ -5736,16 +5970,19 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5736
5970
  - APIS所有日志类型:gz
5737
5971
  :type CloudProductRegion: str
5738
5972
  :param _ClsRegion: CLS目标地域
5973
+ - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
5739
5974
  :type ClsRegion: str
5740
5975
  :param _LogsetName: 日志集名称,未填LogsetId时必填。若日志集不存在, 将自动创建
5741
5976
  :type LogsetName: str
5742
5977
  :param _TopicName: 日志主题名称,在未填TopicId时必填。 若日志主题不存在,将自动创建
5743
5978
  :type TopicName: str
5744
- :param _Extend: 日志配置拓展信息, 一般用于存储额外的日志投递配置
5979
+ :param _Extend: 日志配置扩展信息, 一般用于存储额外的日志投递配置
5745
5980
  :type Extend: str
5746
5981
  :param _LogsetId: 日志集id
5982
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
5747
5983
  :type LogsetId: str
5748
5984
  :param _TopicId: 日志主题id
5985
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5749
5986
  :type TopicId: str
5750
5987
  """
5751
5988
  self._InstanceId = None
@@ -5762,6 +5999,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5762
5999
  @property
5763
6000
  def InstanceId(self):
5764
6001
  """实例ID
6002
+ - 通过各个接入云产品官方文档获取
5765
6003
  :rtype: str
5766
6004
  """
5767
6005
  return self._InstanceId
@@ -5794,7 +6032,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5794
6032
 
5795
6033
  @property
5796
6034
  def CloudProductRegion(self):
5797
- """云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
6035
+ """云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
5798
6036
  - CDS所有日志类型:ap-guangzhou
5799
6037
  - CDB-AUDIT: gz
5800
6038
  - TDSQL-C-AUDIT: gz
@@ -5818,6 +6056,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5818
6056
  @property
5819
6057
  def ClsRegion(self):
5820
6058
  """CLS目标地域
6059
+ - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
5821
6060
  :rtype: str
5822
6061
  """
5823
6062
  return self._ClsRegion
@@ -5850,7 +6089,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5850
6089
 
5851
6090
  @property
5852
6091
  def Extend(self):
5853
- """日志配置拓展信息, 一般用于存储额外的日志投递配置
6092
+ """日志配置扩展信息, 一般用于存储额外的日志投递配置
5854
6093
  :rtype: str
5855
6094
  """
5856
6095
  return self._Extend
@@ -5862,6 +6101,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5862
6101
  @property
5863
6102
  def LogsetId(self):
5864
6103
  """日志集id
6104
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
5865
6105
  :rtype: str
5866
6106
  """
5867
6107
  return self._LogsetId
@@ -5873,6 +6113,7 @@ class CreateCloudProductLogCollectionRequest(AbstractModel):
5873
6113
  @property
5874
6114
  def TopicId(self):
5875
6115
  """日志主题id
6116
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5876
6117
  :rtype: str
5877
6118
  """
5878
6119
  return self._TopicId
@@ -6421,8 +6662,11 @@ class CreateConfigRequest(AbstractModel):
6421
6662
  def __init__(self):
6422
6663
  r"""
6423
6664
  :param _Name: 采集配置名称
6665
+ - 名称种不得包含特殊字符|
6666
+ - 名称最长255字符,超过截断
6424
6667
  :type Name: str
6425
6668
  :param _Output: 采集配置所属日志主题ID即TopicId
6669
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6426
6670
  :type Output: str
6427
6671
  :param _Path: 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
6428
6672
  :type Path: str
@@ -6465,6 +6709,8 @@ class CreateConfigRequest(AbstractModel):
6465
6709
  @property
6466
6710
  def Name(self):
6467
6711
  """采集配置名称
6712
+ - 名称种不得包含特殊字符|
6713
+ - 名称最长255字符,超过截断
6468
6714
  :rtype: str
6469
6715
  """
6470
6716
  return self._Name
@@ -6476,6 +6722,7 @@ class CreateConfigRequest(AbstractModel):
6476
6722
  @property
6477
6723
  def Output(self):
6478
6724
  """采集配置所属日志主题ID即TopicId
6725
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6479
6726
  :rtype: str
6480
6727
  """
6481
6728
  return self._Output
@@ -6739,7 +6986,9 @@ class CreateConsumerRequest(AbstractModel):
6739
6986
 
6740
6987
  def __init__(self):
6741
6988
  r"""
6742
- :param _TopicId: 投递任务绑定的日志主题 ID
6989
+ :param _TopicId: 投递任务绑定的日志主题Id。
6990
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
6991
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
6743
6992
  :type TopicId: str
6744
6993
  :param _NeedContent: 是否投递日志的元数据信息,默认为 true。
6745
6994
  当NeedContent为true时:字段Content有效。
@@ -6760,7 +7009,9 @@ class CreateConsumerRequest(AbstractModel):
6760
7009
 
6761
7010
  @property
6762
7011
  def TopicId(self):
6763
- """投递任务绑定的日志主题 ID
7012
+ """投递任务绑定的日志主题Id。
7013
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
7014
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
6764
7015
  :rtype: str
6765
7016
  """
6766
7017
  return self._TopicId
@@ -7117,10 +7368,21 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7117
7368
  def __init__(self):
7118
7369
  r"""
7119
7370
  :param _Name: 仪表盘订阅名称。
7371
+ 输入限制:
7372
+ - 不能为空
7373
+ - 长度不能超过128字节
7374
+ - 不能包含字符'|'
7120
7375
  :type Name: str
7121
- :param _DashboardId: 仪表盘id
7376
+ :param _DashboardId: 仪表盘Id
7377
+ - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
7122
7378
  :type DashboardId: str
7123
- :param _Cron: 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。<br><li/>{秒数} 取值范围: 0 ~ 59 <br><li/>{分钟} 取值范围: 0 ~ 59 <br><li/>{小时} 取值范围: 0 ~ 23 <br><li/>{日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L) <br><li/>{月份} 取值范围: 1 ~ 12 <br><li/>{星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
7379
+ :param _Cron: 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。
7380
+ - {秒数} 取值范围: 0 ~ 59
7381
+ - {分钟} 取值范围: 0 ~ 59
7382
+ - {小时} 取值范围: 0 ~ 23
7383
+ - {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L)
7384
+ - {月份} 取值范围: 1 ~ 12
7385
+ - {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
7124
7386
  :type Cron: str
7125
7387
  :param _SubscribeData: 仪表盘订阅数据。
7126
7388
  :type SubscribeData: :class:`tencentcloud.cls.v20201016.models.DashboardSubscribeData`
@@ -7133,6 +7395,10 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7133
7395
  @property
7134
7396
  def Name(self):
7135
7397
  """仪表盘订阅名称。
7398
+ 输入限制:
7399
+ - 不能为空
7400
+ - 长度不能超过128字节
7401
+ - 不能包含字符'|'
7136
7402
  :rtype: str
7137
7403
  """
7138
7404
  return self._Name
@@ -7143,7 +7409,8 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7143
7409
 
7144
7410
  @property
7145
7411
  def DashboardId(self):
7146
- """仪表盘id
7412
+ """仪表盘Id
7413
+ - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
7147
7414
  :rtype: str
7148
7415
  """
7149
7416
  return self._DashboardId
@@ -7154,7 +7421,13 @@ class CreateDashboardSubscribeRequest(AbstractModel):
7154
7421
 
7155
7422
  @property
7156
7423
  def Cron(self):
7157
- """订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。<br><li/>{秒数} 取值范围: 0 ~ 59 <br><li/>{分钟} 取值范围: 0 ~ 59 <br><li/>{小时} 取值范围: 0 ~ 23 <br><li/>{日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L) <br><li/>{月份} 取值范围: 1 ~ 12 <br><li/>{星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
7424
+ """订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。
7425
+ - {秒数} 取值范围: 0 ~ 59
7426
+ - {分钟} 取值范围: 0 ~ 59
7427
+ - {小时} 取值范围: 0 ~ 23
7428
+ - {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L)
7429
+ - {月份} 取值范围: 1 ~ 12
7430
+ - {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
7158
7431
  :rtype: str
7159
7432
  """
7160
7433
  return self._Cron
@@ -7448,17 +7721,22 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7448
7721
 
7449
7722
  def __init__(self):
7450
7723
  r"""
7451
- :param _TopicId: 投递规则属于的 topic id
7724
+ :param _TopicId: 投递规则属于的TopicId。
7725
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
7726
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7452
7727
  :type TopicId: str
7453
7728
  :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))
7729
+ 通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。
7454
7730
  :type FunctionName: str
7455
- :param _Namespace: 命名空间
7731
+ :param _Namespace: 命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
7732
+ - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
7456
7733
  :type Namespace: str
7457
- :param _Qualifier: 函数版本
7734
+ :param _Qualifier: 函数版本。
7735
+ - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
7458
7736
  :type Qualifier: str
7459
- :param _Timeout: 投递最长等待时间,单位:秒
7737
+ :param _Timeout: 投递最长等待时间,单位:秒。 默认:60
7460
7738
  :type Timeout: int
7461
- :param _MaxMsgNum: 投递最大消息数
7739
+ :param _MaxMsgNum: 投递最大消息数。默认为100。支持范围[1,10000]
7462
7740
  :type MaxMsgNum: int
7463
7741
  """
7464
7742
  self._TopicId = None
@@ -7470,7 +7748,9 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7470
7748
 
7471
7749
  @property
7472
7750
  def TopicId(self):
7473
- """投递规则属于的 topic id
7751
+ """投递规则属于的TopicId。
7752
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
7753
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7474
7754
  :rtype: str
7475
7755
  """
7476
7756
  return self._TopicId
@@ -7482,6 +7762,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7482
7762
  @property
7483
7763
  def FunctionName(self):
7484
7764
  """投递的云函数名字。仅支持[事件函数](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))
7765
+ 通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。
7485
7766
  :rtype: str
7486
7767
  """
7487
7768
  return self._FunctionName
@@ -7492,7 +7773,8 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7492
7773
 
7493
7774
  @property
7494
7775
  def Namespace(self):
7495
- """命名空间
7776
+ """命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
7777
+ - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
7496
7778
  :rtype: str
7497
7779
  """
7498
7780
  return self._Namespace
@@ -7503,7 +7785,8 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7503
7785
 
7504
7786
  @property
7505
7787
  def Qualifier(self):
7506
- """函数版本
7788
+ """函数版本。
7789
+ - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
7507
7790
  :rtype: str
7508
7791
  """
7509
7792
  return self._Qualifier
@@ -7514,7 +7797,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7514
7797
 
7515
7798
  @property
7516
7799
  def Timeout(self):
7517
- """投递最长等待时间,单位:秒
7800
+ """投递最长等待时间,单位:秒。 默认:60
7518
7801
  :rtype: int
7519
7802
  """
7520
7803
  return self._Timeout
@@ -7525,7 +7808,7 @@ class CreateDeliverCloudFunctionRequest(AbstractModel):
7525
7808
 
7526
7809
  @property
7527
7810
  def MaxMsgNum(self):
7528
- """投递最大消息数
7811
+ """投递最大消息数。默认为100。支持范围[1,10000]
7529
7812
  :rtype: int
7530
7813
  """
7531
7814
  return self._MaxMsgNum
@@ -7587,7 +7870,8 @@ class CreateExportRequest(AbstractModel):
7587
7870
 
7588
7871
  def __init__(self):
7589
7872
  r"""
7590
- :param _TopicId: 日志主题ID
7873
+ :param _TopicId: 日志主题Id
7874
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7591
7875
  :type TopicId: str
7592
7876
  :param _Count: 日志导出数量, 最大值5000万
7593
7877
  :type Count: int
@@ -7619,7 +7903,8 @@ class CreateExportRequest(AbstractModel):
7619
7903
 
7620
7904
  @property
7621
7905
  def TopicId(self):
7622
- """日志主题ID
7906
+ """日志主题Id
7907
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7623
7908
  :rtype: str
7624
7909
  """
7625
7910
  return self._TopicId
@@ -7926,7 +8211,9 @@ class CreateKafkaRechargeRequest(AbstractModel):
7926
8211
 
7927
8212
  def __init__(self):
7928
8213
  r"""
7929
- :param _TopicId: 导入CLS目标topic ID
8214
+ :param _TopicId: 导入CLS目标TopicId。
8215
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
8216
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7930
8217
  :type TopicId: str
7931
8218
  :param _Name: Kafka导入配置名称
7932
8219
  :type Name: str
@@ -7939,6 +8226,7 @@ class CreateKafkaRechargeRequest(AbstractModel):
7939
8226
  :param _LogRechargeRule: 日志导入规则。
7940
8227
  :type LogRechargeRule: :class:`tencentcloud.cls.v20201016.models.LogRechargeRuleInfo`
7941
8228
  :param _KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填。
8229
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
7942
8230
  :type KafkaInstance: str
7943
8231
  :param _ServerAddr: 服务地址,KafkaType为1时必填。
7944
8232
  :type ServerAddr: str
@@ -7947,7 +8235,8 @@ class CreateKafkaRechargeRequest(AbstractModel):
7947
8235
  :param _Protocol: 加密访问协议。
7948
8236
  KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
7949
8237
  :type Protocol: :class:`tencentcloud.cls.v20201016.models.KafkaProtocolInfo`
7950
- :param _ConsumerGroupName: 用户Kafka消费组名称
8238
+ :param _ConsumerGroupName: 用户Kafka消费组名称。
8239
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
7951
8240
  :type ConsumerGroupName: str
7952
8241
  """
7953
8242
  self._TopicId = None
@@ -7964,7 +8253,9 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
7964
8253
 
7965
8254
  @property
7966
8255
  def TopicId(self):
7967
- """导入CLS目标topic ID
8256
+ """导入CLS目标TopicId。
8257
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
8258
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
7968
8259
  :rtype: str
7969
8260
  """
7970
8261
  return self._TopicId
@@ -8031,6 +8322,7 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
8031
8322
  @property
8032
8323
  def KafkaInstance(self):
8033
8324
  """腾讯云CKafka实例ID,KafkaType为0时必填。
8325
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
8034
8326
  :rtype: str
8035
8327
  """
8036
8328
  return self._KafkaInstance
@@ -8075,7 +8367,8 @@ KafkaType为1并且IsEncryptionAddr为true时Protocol必填。
8075
8367
 
8076
8368
  @property
8077
8369
  def ConsumerGroupName(self):
8078
- """用户Kafka消费组名称
8370
+ """用户Kafka消费组名称。
8371
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
8079
8372
  :rtype: str
8080
8373
  """
8081
8374
  return self._ConsumerGroupName
@@ -8279,7 +8572,10 @@ class CreateMachineGroupRequest(AbstractModel):
8279
8572
 
8280
8573
  def __init__(self):
8281
8574
  r"""
8282
- :param _GroupName: 机器组名字,不能重复
8575
+ :param _GroupName: 机器组名字。
8576
+ 输入限制:
8577
+ - 最大支持255个字符,不能为空字符串
8578
+ - 不能包含字符'|'
8283
8579
  :type GroupName: str
8284
8580
  :param _MachineGroupType: 创建机器组类型。取值如下:
8285
8581
  - Type:ip,Values中为ip字符串列表创建机器组
@@ -8290,12 +8586,16 @@ class CreateMachineGroupRequest(AbstractModel):
8290
8586
  :param _AutoUpdate: 是否开启机器组自动更新。默认false
8291
8587
  :type AutoUpdate: bool
8292
8588
  :param _UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
8589
+ 时间格式:HH:mm:ss
8293
8590
  :type UpdateStartTime: str
8294
8591
  :param _UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
8592
+ 时间格式:HH:mm:ss
8295
8593
  :type UpdateEndTime: str
8296
8594
  :param _ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费。默认false
8297
8595
  :type ServiceLogging: bool
8298
8596
  :param _DelayCleanupTime: 机器组中机器离线清理时间。单位:天
8597
+
8598
+ - 大于0时生效。
8299
8599
  :type DelayCleanupTime: int
8300
8600
  :param _MetaTags: 机器组元数据信息列表
8301
8601
  :type MetaTags: list of MetaTagInfo
@@ -8317,7 +8617,10 @@ class CreateMachineGroupRequest(AbstractModel):
8317
8617
 
8318
8618
  @property
8319
8619
  def GroupName(self):
8320
- """机器组名字,不能重复
8620
+ """机器组名字。
8621
+ 输入限制:
8622
+ - 最大支持255个字符,不能为空字符串
8623
+ - 不能包含字符'|'
8321
8624
  :rtype: str
8322
8625
  """
8323
8626
  return self._GroupName
@@ -8364,6 +8667,7 @@ class CreateMachineGroupRequest(AbstractModel):
8364
8667
  @property
8365
8668
  def UpdateStartTime(self):
8366
8669
  """升级开始时间,建议业务低峰期升级LogListener
8670
+ 时间格式:HH:mm:ss
8367
8671
  :rtype: str
8368
8672
  """
8369
8673
  return self._UpdateStartTime
@@ -8375,6 +8679,7 @@ class CreateMachineGroupRequest(AbstractModel):
8375
8679
  @property
8376
8680
  def UpdateEndTime(self):
8377
8681
  """升级结束时间,建议业务低峰期升级LogListener
8682
+ 时间格式:HH:mm:ss
8378
8683
  :rtype: str
8379
8684
  """
8380
8685
  return self._UpdateEndTime
@@ -8397,6 +8702,8 @@ class CreateMachineGroupRequest(AbstractModel):
8397
8702
  @property
8398
8703
  def DelayCleanupTime(self):
8399
8704
  """机器组中机器离线清理时间。单位:天
8705
+
8706
+ - 大于0时生效。
8400
8707
  :rtype: int
8401
8708
  """
8402
8709
  return self._DelayCleanupTime
@@ -8513,7 +8820,7 @@ class CreateNoticeContentRequest(AbstractModel):
8513
8820
 
8514
8821
  def __init__(self):
8515
8822
  r"""
8516
- :param _Name: 模板名称。
8823
+ :param _Name: 模板名称。最大支持255个字节
8517
8824
  :type Name: str
8518
8825
  :param _Type: 模板内容语言。0:中文1:英文
8519
8826
  :type Type: int
@@ -8526,7 +8833,7 @@ class CreateNoticeContentRequest(AbstractModel):
8526
8833
 
8527
8834
  @property
8528
8835
  def Name(self):
8529
- """模板名称。
8836
+ """模板名称。最大支持255个字节
8530
8837
  :rtype: str
8531
8838
  """
8532
8839
  return self._Name
@@ -8627,9 +8934,9 @@ class CreateScheduledSqlRequest(AbstractModel):
8627
8934
 
8628
8935
  def __init__(self):
8629
8936
  r"""
8630
- :param _SrcTopicId: 源日志主题
8937
+ :param _SrcTopicId: 源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8631
8938
  :type SrcTopicId: str
8632
- :param _Name: 任务名称
8939
+ :param _Name: 任务名称,0~255字符
8633
8940
  :type Name: str
8634
8941
  :param _EnableFlag: 任务启动状态. 1开启, 2关闭
8635
8942
  :type EnableFlag: int
@@ -8641,13 +8948,13 @@ class CreateScheduledSqlRequest(AbstractModel):
8641
8948
  :type ProcessStartTime: int
8642
8949
  :param _ProcessType: 调度类型,1:持续运行 2:指定时间范围
8643
8950
  :type ProcessType: int
8644
- :param _ProcessPeriod: 调度周期(分钟)
8951
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
8645
8952
  :type ProcessPeriod: int
8646
8953
  :param _ProcessTimeWindow: 单次查询的时间窗口,如果您的目标主题为指标主题,建议该参数的大小不超过30分钟,否则可能转指标失败。
8647
8954
  :type ProcessTimeWindow: str
8648
- :param _ProcessDelay: 执行延迟(秒)
8955
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
8649
8956
  :type ProcessDelay: int
8650
- :param _SrcTopicRegion: 源topicId的地域信息
8957
+ :param _SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
8651
8958
  :type SrcTopicRegion: str
8652
8959
  :param _ProcessEndTime: 调度结束时间,当ProcessType=2时为必传字段, Unix时间戳,单位ms
8653
8960
  :type ProcessEndTime: int
@@ -8670,7 +8977,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8670
8977
 
8671
8978
  @property
8672
8979
  def SrcTopicId(self):
8673
- """源日志主题
8980
+ """源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8674
8981
  :rtype: str
8675
8982
  """
8676
8983
  return self._SrcTopicId
@@ -8681,7 +8988,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8681
8988
 
8682
8989
  @property
8683
8990
  def Name(self):
8684
- """任务名称
8991
+ """任务名称,0~255字符
8685
8992
  :rtype: str
8686
8993
  """
8687
8994
  return self._Name
@@ -8747,7 +9054,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8747
9054
 
8748
9055
  @property
8749
9056
  def ProcessPeriod(self):
8750
- """调度周期(分钟)
9057
+ """调度周期(分钟),1~1440分钟
8751
9058
  :rtype: int
8752
9059
  """
8753
9060
  return self._ProcessPeriod
@@ -8769,7 +9076,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8769
9076
 
8770
9077
  @property
8771
9078
  def ProcessDelay(self):
8772
- """执行延迟(秒)
9079
+ """执行延迟(秒),0~120秒,默认60秒
8773
9080
  :rtype: int
8774
9081
  """
8775
9082
  return self._ProcessDelay
@@ -8780,7 +9087,7 @@ class CreateScheduledSqlRequest(AbstractModel):
8780
9087
 
8781
9088
  @property
8782
9089
  def SrcTopicRegion(self):
8783
- """源topicId的地域信息
9090
+ """源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
8784
9091
  :rtype: str
8785
9092
  """
8786
9093
  return self._SrcTopicRegion
@@ -9206,8 +9513,14 @@ class CreateTopicRequest(AbstractModel):
9206
9513
  def __init__(self):
9207
9514
  r"""
9208
9515
  :param _LogsetId: 日志集ID
9516
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
9209
9517
  :type LogsetId: str
9210
9518
  :param _TopicName: 日志主题名称
9519
+ 名称限制
9520
+ - 不能为空字符串
9521
+ - 不能包含字符'|'
9522
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
9523
+
9211
9524
  :type TopicName: str
9212
9525
  :param _PartitionCount: 日志主题分区个数。默认创建1个,最大支持创建10个分区。
9213
9526
  :type PartitionCount: int
@@ -9256,6 +9569,7 @@ class CreateTopicRequest(AbstractModel):
9256
9569
  @property
9257
9570
  def LogsetId(self):
9258
9571
  """日志集ID
9572
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
9259
9573
  :rtype: str
9260
9574
  """
9261
9575
  return self._LogsetId
@@ -9267,6 +9581,11 @@ class CreateTopicRequest(AbstractModel):
9267
9581
  @property
9268
9582
  def TopicName(self):
9269
9583
  """日志主题名称
9584
+ 名称限制
9585
+ - 不能为空字符串
9586
+ - 不能包含字符'|'
9587
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
9588
+
9270
9589
  :rtype: str
9271
9590
  """
9272
9591
  return self._TopicName
@@ -9485,7 +9804,7 @@ class CreateWebCallbackRequest(AbstractModel):
9485
9804
 
9486
9805
  def __init__(self):
9487
9806
  r"""
9488
- :param _Name: 通知内容名称。
9807
+ :param _Name: 通知内容名称。最大支持255个字节
9489
9808
  :type Name: str
9490
9809
  :param _Type: 渠道类型。
9491
9810
 
@@ -9497,7 +9816,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调。
9497
9816
 
9498
9817
  当Type为Http时,必填。
9499
9818
  :type Method: str
9500
- :param _Key: 秘钥。
9819
+ :param _Key: 秘钥。最大支持1024个字节
9501
9820
  :type Key: str
9502
9821
  """
9503
9822
  self._Name = None
@@ -9508,7 +9827,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调。
9508
9827
 
9509
9828
  @property
9510
9829
  def Name(self):
9511
- """通知内容名称。
9830
+ """通知内容名称。最大支持255个字节
9512
9831
  :rtype: str
9513
9832
  """
9514
9833
  return self._Name
@@ -9556,7 +9875,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调。
9556
9875
 
9557
9876
  @property
9558
9877
  def Key(self):
9559
- """秘钥。
9878
+ """秘钥。最大支持1024个字节
9560
9879
  :rtype: str
9561
9880
  """
9562
9881
  return self._Key
@@ -9930,7 +10249,9 @@ class DashboardNoticeMode(AbstractModel):
9930
10249
  <li/>Uin:腾讯云用户<br>
9931
10250
  <li/>Group:腾讯云用户组<br>
9932
10251
  <li/>Email:自定义Email<br>
9933
- <li/>WeCom: 企业微信回调
10252
+ <li/>WeCom: 企业微信回调<br>
10253
+ <li/>DingTalk:钉钉<br>
10254
+ <li/>Lark:飞书
9934
10255
  :type ReceiverType: str
9935
10256
  :param _Values: 知方式对应的值。
9936
10257
  <br> <li/> 当ReceiverType不是 WeCom 时,Values必填。
@@ -9956,7 +10277,9 @@ class DashboardNoticeMode(AbstractModel):
9956
10277
  <li/>Uin:腾讯云用户<br>
9957
10278
  <li/>Group:腾讯云用户组<br>
9958
10279
  <li/>Email:自定义Email<br>
9959
- <li/>WeCom: 企业微信回调
10280
+ <li/>WeCom: 企业微信回调<br>
10281
+ <li/>DingTalk:钉钉<br>
10282
+ <li/>Lark:飞书
9960
10283
  :rtype: str
9961
10284
  """
9962
10285
  return self._ReceiverType
@@ -10630,14 +10953,14 @@ class DeleteAlarmNoticeRequest(AbstractModel):
10630
10953
 
10631
10954
  def __init__(self):
10632
10955
  r"""
10633
- :param _AlarmNoticeId: 通知渠道组ID
10956
+ :param _AlarmNoticeId: 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
10634
10957
  :type AlarmNoticeId: str
10635
10958
  """
10636
10959
  self._AlarmNoticeId = None
10637
10960
 
10638
10961
  @property
10639
10962
  def AlarmNoticeId(self):
10640
- """通知渠道组ID
10963
+ """通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
10641
10964
  :rtype: str
10642
10965
  """
10643
10966
  return self._AlarmNoticeId
@@ -10758,9 +11081,9 @@ class DeleteAlarmShieldRequest(AbstractModel):
10758
11081
 
10759
11082
  def __init__(self):
10760
11083
  r"""
10761
- :param _TaskId: 屏蔽规则id
11084
+ :param _TaskId: 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
10762
11085
  :type TaskId: str
10763
- :param _AlarmNoticeId: 通知渠道组id
11086
+ :param _AlarmNoticeId: 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
10764
11087
  :type AlarmNoticeId: str
10765
11088
  """
10766
11089
  self._TaskId = None
@@ -10768,7 +11091,7 @@ class DeleteAlarmShieldRequest(AbstractModel):
10768
11091
 
10769
11092
  @property
10770
11093
  def TaskId(self):
10771
- """屏蔽规则id
11094
+ """屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
10772
11095
  :rtype: str
10773
11096
  """
10774
11097
  return self._TaskId
@@ -10779,7 +11102,7 @@ class DeleteAlarmShieldRequest(AbstractModel):
10779
11102
 
10780
11103
  @property
10781
11104
  def AlarmNoticeId(self):
10782
- """通知渠道组id
11105
+ """通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
10783
11106
  :rtype: str
10784
11107
  """
10785
11108
  return self._AlarmNoticeId
@@ -10843,7 +11166,7 @@ class DeleteCloudProductLogCollectionRequest(AbstractModel):
10843
11166
  :type AssumerName: str
10844
11167
  :param _LogType: 日志类型,支持枚举:CDS-AUDIT、CDS-RISK、CDB-AUDIT、TDSQL-C-AUDIT、MongoDB-AUDIT、MongoDB-SlowLog、MongoDB-ErrorLog、TDMYSQL-SLOW、DCDB-AUDIT、DCDB-SLOW、DCDB-ERROR、MariaDB-AUDIT、MariaDB-SLOW、MariaDB-ERROR、PostgreSQL-SLOW、PostgreSQL-ERROR、PostgreSQL-AUDIT、BH-FILELOG、BH-COMMANDLOG、APIS-ACCESS
10845
11168
  :type LogType: str
10846
- :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
11169
+ :param _CloudProductRegion: 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
10847
11170
  - CDS所有日志类型:ap-guangzhou
10848
11171
  - CDB-AUDIT: gz
10849
11172
  - TDSQL-C-AUDIT: gz
@@ -10898,7 +11221,7 @@ class DeleteCloudProductLogCollectionRequest(AbstractModel):
10898
11221
 
10899
11222
  @property
10900
11223
  def CloudProductRegion(self):
10901
- """云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
11224
+ """云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
10902
11225
  - CDS所有日志类型:ap-guangzhou
10903
11226
  - CDB-AUDIT: gz
10904
11227
  - TDSQL-C-AUDIT: gz
@@ -10986,6 +11309,7 @@ class DeleteConfigExtraRequest(AbstractModel):
10986
11309
  def __init__(self):
10987
11310
  r"""
10988
11311
  :param _ConfigExtraId: 特殊采集规则扩展配置ID
11312
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
10989
11313
  :type ConfigExtraId: str
10990
11314
  """
10991
11315
  self._ConfigExtraId = None
@@ -10993,6 +11317,7 @@ class DeleteConfigExtraRequest(AbstractModel):
10993
11317
  @property
10994
11318
  def ConfigExtraId(self):
10995
11319
  """特殊采集规则扩展配置ID
11320
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
10996
11321
  :rtype: str
10997
11322
  """
10998
11323
  return self._ConfigExtraId
@@ -11050,8 +11375,10 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11050
11375
  def __init__(self):
11051
11376
  r"""
11052
11377
  :param _GroupId: 机器组ID
11378
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
11053
11379
  :type GroupId: str
11054
11380
  :param _ConfigId: 采集配置ID
11381
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11055
11382
  :type ConfigId: str
11056
11383
  """
11057
11384
  self._GroupId = None
@@ -11060,6 +11387,7 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11060
11387
  @property
11061
11388
  def GroupId(self):
11062
11389
  """机器组ID
11390
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
11063
11391
  :rtype: str
11064
11392
  """
11065
11393
  return self._GroupId
@@ -11071,6 +11399,7 @@ class DeleteConfigFromMachineGroupRequest(AbstractModel):
11071
11399
  @property
11072
11400
  def ConfigId(self):
11073
11401
  """采集配置ID
11402
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11074
11403
  :rtype: str
11075
11404
  """
11076
11405
  return self._ConfigId
@@ -11128,14 +11457,16 @@ class DeleteConfigRequest(AbstractModel):
11128
11457
 
11129
11458
  def __init__(self):
11130
11459
  r"""
11131
- :param _ConfigId: 采集规则配置ID
11460
+ :param _ConfigId: 采集配置ID
11461
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11132
11462
  :type ConfigId: str
11133
11463
  """
11134
11464
  self._ConfigId = None
11135
11465
 
11136
11466
  @property
11137
11467
  def ConfigId(self):
11138
- """采集规则配置ID
11468
+ """采集配置ID
11469
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
11139
11470
  :rtype: str
11140
11471
  """
11141
11472
  return self._ConfigId
@@ -11192,14 +11523,18 @@ class DeleteConsoleSharingRequest(AbstractModel):
11192
11523
 
11193
11524
  def __init__(self):
11194
11525
  r"""
11195
- :param _SharingId: 免密分享Id
11526
+ :param _SharingId: 免密分享Id
11527
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
11528
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
11196
11529
  :type SharingId: str
11197
11530
  """
11198
11531
  self._SharingId = None
11199
11532
 
11200
11533
  @property
11201
11534
  def SharingId(self):
11202
- """免密分享Id
11535
+ """免密分享Id
11536
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
11537
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
11203
11538
  :rtype: str
11204
11539
  """
11205
11540
  return self._SharingId
@@ -11256,14 +11591,18 @@ class DeleteConsumerRequest(AbstractModel):
11256
11591
 
11257
11592
  def __init__(self):
11258
11593
  r"""
11259
- :param _TopicId: 投递任务绑定的日志主题 ID
11594
+ :param _TopicId: 投递任务绑定的日志主题Id。
11595
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
11596
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
11260
11597
  :type TopicId: str
11261
11598
  """
11262
11599
  self._TopicId = None
11263
11600
 
11264
11601
  @property
11265
11602
  def TopicId(self):
11266
- """投递任务绑定的日志主题 ID
11603
+ """投递任务绑定的日志主题Id。
11604
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
11605
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
11267
11606
  :rtype: str
11268
11607
  """
11269
11608
  return self._TopicId
@@ -11467,14 +11806,14 @@ class DeleteDataTransformRequest(AbstractModel):
11467
11806
 
11468
11807
  def __init__(self):
11469
11808
  r"""
11470
- :param _TaskId: 数据加工任务id
11809
+ :param _TaskId: 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
11471
11810
  :type TaskId: str
11472
11811
  """
11473
11812
  self._TaskId = None
11474
11813
 
11475
11814
  @property
11476
11815
  def TaskId(self):
11477
- """数据加工任务id
11816
+ """数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
11478
11817
  :rtype: str
11479
11818
  """
11480
11819
  return self._TaskId
@@ -11531,14 +11870,18 @@ class DeleteExportRequest(AbstractModel):
11531
11870
 
11532
11871
  def __init__(self):
11533
11872
  r"""
11534
- :param _ExportId: 日志导出ID
11873
+ :param _ExportId: 日志导出任务Id
11874
+ - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
11875
+
11535
11876
  :type ExportId: str
11536
11877
  """
11537
11878
  self._ExportId = None
11538
11879
 
11539
11880
  @property
11540
11881
  def ExportId(self):
11541
- """日志导出ID
11882
+ """日志导出任务Id
11883
+ - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
11884
+
11542
11885
  :rtype: str
11543
11886
  """
11544
11887
  return self._ExportId
@@ -11812,7 +12155,8 @@ class DeleteMachineGroupInfoRequest(AbstractModel):
11812
12155
 
11813
12156
  def __init__(self):
11814
12157
  r"""
11815
- :param _GroupId: 机器组ID
12158
+ :param _GroupId: 机器组Id
12159
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11816
12160
  :type GroupId: str
11817
12161
  :param _MachineGroupType: 机器组类型
11818
12162
  目前type支持 ip 和 label
@@ -11823,7 +12167,8 @@ class DeleteMachineGroupInfoRequest(AbstractModel):
11823
12167
 
11824
12168
  @property
11825
12169
  def GroupId(self):
11826
- """机器组ID
12170
+ """机器组Id
12171
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11827
12172
  :rtype: str
11828
12173
  """
11829
12174
  return self._GroupId
@@ -11895,14 +12240,16 @@ class DeleteMachineGroupRequest(AbstractModel):
11895
12240
 
11896
12241
  def __init__(self):
11897
12242
  r"""
11898
- :param _GroupId: 机器组ID
12243
+ :param _GroupId: 机器组Id
12244
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11899
12245
  :type GroupId: str
11900
12246
  """
11901
12247
  self._GroupId = None
11902
12248
 
11903
12249
  @property
11904
12250
  def GroupId(self):
11905
- """机器组ID
12251
+ """机器组Id
12252
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
11906
12253
  :rtype: str
11907
12254
  """
11908
12255
  return self._GroupId
@@ -11959,14 +12306,14 @@ class DeleteNoticeContentRequest(AbstractModel):
11959
12306
 
11960
12307
  def __init__(self):
11961
12308
  r"""
11962
- :param _NoticeContentId: 通知内容模板ID
12309
+ :param _NoticeContentId: 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
11963
12310
  :type NoticeContentId: str
11964
12311
  """
11965
12312
  self._NoticeContentId = None
11966
12313
 
11967
12314
  @property
11968
12315
  def NoticeContentId(self):
11969
- """通知内容模板ID
12316
+ """通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
11970
12317
  :rtype: str
11971
12318
  """
11972
12319
  return self._NoticeContentId
@@ -12023,9 +12370,9 @@ class DeleteScheduledSqlRequest(AbstractModel):
12023
12370
 
12024
12371
  def __init__(self):
12025
12372
  r"""
12026
- :param _TaskId: 任务ID
12373
+ :param _TaskId: 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12027
12374
  :type TaskId: str
12028
- :param _SrcTopicId: 源日志主题ID
12375
+ :param _SrcTopicId: 源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12029
12376
  :type SrcTopicId: str
12030
12377
  """
12031
12378
  self._TaskId = None
@@ -12033,7 +12380,7 @@ class DeleteScheduledSqlRequest(AbstractModel):
12033
12380
 
12034
12381
  @property
12035
12382
  def TaskId(self):
12036
- """任务ID
12383
+ """任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12037
12384
  :rtype: str
12038
12385
  """
12039
12386
  return self._TaskId
@@ -12044,7 +12391,7 @@ class DeleteScheduledSqlRequest(AbstractModel):
12044
12391
 
12045
12392
  @property
12046
12393
  def SrcTopicId(self):
12047
- """源日志主题ID
12394
+ """源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
12048
12395
  :rtype: str
12049
12396
  """
12050
12397
  return self._SrcTopicId
@@ -12169,6 +12516,7 @@ class DeleteTopicRequest(AbstractModel):
12169
12516
  def __init__(self):
12170
12517
  r"""
12171
12518
  :param _TopicId: 日志主题ID
12519
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
12172
12520
  :type TopicId: str
12173
12521
  """
12174
12522
  self._TopicId = None
@@ -12176,6 +12524,7 @@ class DeleteTopicRequest(AbstractModel):
12176
12524
  @property
12177
12525
  def TopicId(self):
12178
12526
  """日志主题ID
12527
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
12179
12528
  :rtype: str
12180
12529
  """
12181
12530
  return self._TopicId
@@ -12232,14 +12581,14 @@ class DeleteWebCallbackRequest(AbstractModel):
12232
12581
 
12233
12582
  def __init__(self):
12234
12583
  r"""
12235
- :param _WebCallbackId: 告警渠道回调配置ID
12584
+ :param _WebCallbackId: 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
12236
12585
  :type WebCallbackId: str
12237
12586
  """
12238
12587
  self._WebCallbackId = None
12239
12588
 
12240
12589
  @property
12241
12590
  def WebCallbackId(self):
12242
- """告警渠道回调配置ID
12591
+ """告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
12243
12592
  :rtype: str
12244
12593
  """
12245
12594
  return self._WebCallbackId
@@ -12306,7 +12655,7 @@ ap-nanjing 南京地域。
12306
12655
 
12307
12656
  https://cloud.tencent.com/document/product/614/18940
12308
12657
  :type Region: str
12309
- :param _TopicId: 日志主题ID
12658
+ :param _TopicId: 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
12310
12659
  :type TopicId: str
12311
12660
  :param _Scope: 投递数据范围。
12312
12661
 
@@ -12340,7 +12689,7 @@ https://cloud.tencent.com/document/product/614/18940
12340
12689
 
12341
12690
  @property
12342
12691
  def TopicId(self):
12343
- """日志主题ID
12692
+ """日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
12344
12693
  :rtype: str
12345
12694
  """
12346
12695
  return self._TopicId
@@ -12389,18 +12738,22 @@ class DescribeAlarmNoticesRequest(AbstractModel):
12389
12738
  :param _Filters: <li> name
12390
12739
  按照【通知渠道组名称】进行过滤。
12391
12740
  类型:String
12741
+ 示例:"Filters":[{"Key":"name","Values":["test-notice"]}]
12392
12742
  必选:否</li>
12393
12743
  <li> alarmNoticeId
12394
12744
  按照【通知渠道组ID】进行过滤。
12395
12745
  类型:String
12746
+ 示例:"Filters": [{Key: "alarmNoticeId", Values: ["notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f"]}]
12396
12747
  必选:否</li>
12397
12748
  <li> uid
12398
12749
  按照【接收用户ID】进行过滤。
12399
12750
  类型:String
12751
+ 示例:"Filters": [{Key: "uid", Values: ["1137546"]}]
12400
12752
  必选:否</li>
12401
12753
  <li> groupId
12402
12754
  按照【接收用户组ID】进行过滤。
12403
12755
  类型:String
12756
+ 示例:"Filters": [{Key: "groupId", Values: ["344098"]}]
12404
12757
  必选:否</li>
12405
12758
 
12406
12759
  <li> deliverFlag
@@ -12408,7 +12761,7 @@ class DescribeAlarmNoticesRequest(AbstractModel):
12408
12761
  类型:String
12409
12762
  必选:否
12410
12763
  可选值: "1":未启用, "2": 已启用, "3":投递异常</li>
12411
-
12764
+ 示例:"Filters":[{"Key":"deliverFlag","Values":["2"]}]
12412
12765
  每次请求的Filters的上限为10,Filter.Values的上限为5。
12413
12766
  :type Filters: list of Filter
12414
12767
  :param _Offset: 分页的偏移量,默认值为0。
@@ -12425,18 +12778,22 @@ class DescribeAlarmNoticesRequest(AbstractModel):
12425
12778
  """<li> name
12426
12779
  按照【通知渠道组名称】进行过滤。
12427
12780
  类型:String
12781
+ 示例:"Filters":[{"Key":"name","Values":["test-notice"]}]
12428
12782
  必选:否</li>
12429
12783
  <li> alarmNoticeId
12430
12784
  按照【通知渠道组ID】进行过滤。
12431
12785
  类型:String
12786
+ 示例:"Filters": [{Key: "alarmNoticeId", Values: ["notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f"]}]
12432
12787
  必选:否</li>
12433
12788
  <li> uid
12434
12789
  按照【接收用户ID】进行过滤。
12435
12790
  类型:String
12791
+ 示例:"Filters": [{Key: "uid", Values: ["1137546"]}]
12436
12792
  必选:否</li>
12437
12793
  <li> groupId
12438
12794
  按照【接收用户组ID】进行过滤。
12439
12795
  类型:String
12796
+ 示例:"Filters": [{Key: "groupId", Values: ["344098"]}]
12440
12797
  必选:否</li>
12441
12798
 
12442
12799
  <li> deliverFlag
@@ -12444,7 +12801,7 @@ class DescribeAlarmNoticesRequest(AbstractModel):
12444
12801
  类型:String
12445
12802
  必选:否
12446
12803
  可选值: "1":未启用, "2": 已启用, "3":投递异常</li>
12447
-
12804
+ 示例:"Filters":[{"Key":"deliverFlag","Values":["2"]}]
12448
12805
  每次请求的Filters的上限为10,Filter.Values的上限为5。
12449
12806
  :rtype: list of Filter
12450
12807
  """
@@ -12723,22 +13080,26 @@ class DescribeAlarmsRequest(AbstractModel):
12723
13080
  - 按照【告警策略名称】进行过滤。
12724
13081
  - 类型:String
12725
13082
  - 必选:否
13083
+ - 示例:test-alarm
12726
13084
 
12727
13085
  alarmId
12728
13086
  - 按照【告警策略ID】进行过滤。
12729
13087
  - 类型:String
12730
13088
  - 必选:否
13089
+ - 示例:alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751
12731
13090
 
12732
13091
  topicId
12733
13092
  - 按照【监控对象的日志主题ID】进行过滤。
12734
13093
  - 类型:String
12735
13094
  - 必选:否
13095
+ - 示例:6766f83d-659e-xxxx-a8f7-9104a1012743
12736
13096
 
12737
13097
  enable
12738
13098
  - 按照【启用状态】进行过滤。
12739
13099
  - 类型:String
12740
13100
  - 备注:enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.
12741
13101
  - 必选:否
13102
+ - 示例:true
12742
13103
 
12743
13104
  每次请求的Filters的上限为10,Filter.Values的上限为5。
12744
13105
  :type Filters: list of Filter
@@ -12757,22 +13118,26 @@ enable
12757
13118
  - 按照【告警策略名称】进行过滤。
12758
13119
  - 类型:String
12759
13120
  - 必选:否
13121
+ - 示例:test-alarm
12760
13122
 
12761
13123
  alarmId
12762
13124
  - 按照【告警策略ID】进行过滤。
12763
13125
  - 类型:String
12764
13126
  - 必选:否
13127
+ - 示例:alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751
12765
13128
 
12766
13129
  topicId
12767
13130
  - 按照【监控对象的日志主题ID】进行过滤。
12768
13131
  - 类型:String
12769
13132
  - 必选:否
13133
+ - 示例:6766f83d-659e-xxxx-a8f7-9104a1012743
12770
13134
 
12771
13135
  enable
12772
13136
  - 按照【启用状态】进行过滤。
12773
13137
  - 类型:String
12774
13138
  - 备注:enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.
12775
13139
  - 必选:否
13140
+ - 示例:true
12776
13141
 
12777
13142
  每次请求的Filters的上限为10,Filter.Values的上限为5。
12778
13143
  :rtype: list of Filter
@@ -12895,9 +13260,9 @@ class DescribeAlertRecordHistoryRequest(AbstractModel):
12895
13260
 
12896
13261
  def __init__(self):
12897
13262
  r"""
12898
- :param _From: 查询时间范围启始时间,毫秒级unix时间戳
13263
+ :param _From: 查询时间范围启始时间,毫秒级unix时间戳(ms)
12899
13264
  :type From: int
12900
- :param _To: 查询时间范围结束时间,毫秒级unix时间戳
13265
+ :param _To: 查询时间范围结束时间,毫秒级unix时间戳(ms)
12901
13266
  :type To: int
12902
13267
  :param _Offset: 分页的偏移量,默认值为0。
12903
13268
  :type Offset: int
@@ -12919,7 +13284,7 @@ class DescribeAlertRecordHistoryRequest(AbstractModel):
12919
13284
 
12920
13285
  @property
12921
13286
  def From(self):
12922
- """查询时间范围启始时间,毫秒级unix时间戳
13287
+ """查询时间范围启始时间,毫秒级unix时间戳(ms)
12923
13288
  :rtype: int
12924
13289
  """
12925
13290
  return self._From
@@ -12930,7 +13295,7 @@ class DescribeAlertRecordHistoryRequest(AbstractModel):
12930
13295
 
12931
13296
  @property
12932
13297
  def To(self):
12933
- """查询时间范围结束时间,毫秒级unix时间戳
13298
+ """查询时间范围结束时间,毫秒级unix时间戳(ms)
12934
13299
  :rtype: int
12935
13300
  """
12936
13301
  return self._To
@@ -13233,18 +13598,22 @@ class DescribeConfigExtrasRequest(AbstractModel):
13233
13598
  name
13234
13599
  - 按照【特殊采集配置名称】进行模糊匹配过滤。
13235
13600
  - 类型:String
13601
+ - 示例:test-config
13236
13602
 
13237
13603
  configExtraId
13238
13604
  - 按照【特殊采集配置ID】进行过滤。
13239
13605
  - 类型:String
13606
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13240
13607
 
13241
13608
  topicId
13242
13609
  - 按照【日志主题】进行过滤。
13243
13610
  - 类型:String
13611
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13244
13612
 
13245
13613
  machineGroupId
13246
13614
  - 按照【机器组ID】进行过滤。
13247
13615
  - 类型:String
13616
+ - 示例:f948972f-a063-408c-a59f-8c3230bddaf6
13248
13617
 
13249
13618
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13250
13619
  :type Filters: list of Filter
@@ -13263,18 +13632,22 @@ machineGroupId
13263
13632
  name
13264
13633
  - 按照【特殊采集配置名称】进行模糊匹配过滤。
13265
13634
  - 类型:String
13635
+ - 示例:test-config
13266
13636
 
13267
13637
  configExtraId
13268
13638
  - 按照【特殊采集配置ID】进行过滤。
13269
13639
  - 类型:String
13640
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13270
13641
 
13271
13642
  topicId
13272
13643
  - 按照【日志主题】进行过滤。
13273
13644
  - 类型:String
13645
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13274
13646
 
13275
13647
  machineGroupId
13276
13648
  - 按照【机器组ID】进行过滤。
13277
13649
  - 类型:String
13650
+ - 示例:f948972f-a063-408c-a59f-8c3230bddaf6
13278
13651
 
13279
13652
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13280
13653
  :rtype: list of Filter
@@ -13400,6 +13773,7 @@ class DescribeConfigMachineGroupsRequest(AbstractModel):
13400
13773
  def __init__(self):
13401
13774
  r"""
13402
13775
  :param _ConfigId: 采集配置ID
13776
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
13403
13777
  :type ConfigId: str
13404
13778
  """
13405
13779
  self._ConfigId = None
@@ -13407,6 +13781,7 @@ class DescribeConfigMachineGroupsRequest(AbstractModel):
13407
13781
  @property
13408
13782
  def ConfigId(self):
13409
13783
  """采集配置ID
13784
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
13410
13785
  :rtype: str
13411
13786
  """
13412
13787
  return self._ConfigId
@@ -13489,16 +13864,20 @@ class DescribeConfigsRequest(AbstractModel):
13489
13864
  - 按照【采集配置名称】进行模糊匹配过滤。
13490
13865
  - 类型:String
13491
13866
  - 必选:否
13867
+ - 示例:test-config
13492
13868
 
13493
13869
  configId
13494
13870
  - 按照【采集配置ID】进行过滤。
13495
13871
  - 类型:String
13496
13872
  - 必选:否
13873
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13497
13874
 
13498
13875
  topicId
13499
13876
  - 按照【日志主题】进行过滤。
13500
13877
  - 类型:String
13501
13878
  - 必选:否
13879
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13880
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
13502
13881
 
13503
13882
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13504
13883
  :type Filters: list of Filter
@@ -13517,16 +13896,20 @@ topicId
13517
13896
  - 按照【采集配置名称】进行模糊匹配过滤。
13518
13897
  - 类型:String
13519
13898
  - 必选:否
13899
+ - 示例:test-config
13520
13900
 
13521
13901
  configId
13522
13902
  - 按照【采集配置ID】进行过滤。
13523
13903
  - 类型:String
13524
13904
  - 必选:否
13905
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
13525
13906
 
13526
13907
  topicId
13527
13908
  - 按照【日志主题】进行过滤。
13528
13909
  - 类型:String
13529
13910
  - 必选:否
13911
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
13912
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
13530
13913
 
13531
13914
  每次请求的Filters的上限为10,Filter.Values的上限为5。
13532
13915
  :rtype: list of Filter
@@ -13659,10 +14042,13 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13659
14042
  r"""
13660
14043
  :param _TotalCount: 分页的总数目
13661
14044
  :type TotalCount: int
14045
+ :param _ConsoleSharingInfos: 控制台免密分享列表
14046
+ :type ConsoleSharingInfos: list of ConsoleSharingInfo
13662
14047
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13663
14048
  :type RequestId: str
13664
14049
  """
13665
14050
  self._TotalCount = None
14051
+ self._ConsoleSharingInfos = None
13666
14052
  self._RequestId = None
13667
14053
 
13668
14054
  @property
@@ -13676,6 +14062,17 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13676
14062
  def TotalCount(self, TotalCount):
13677
14063
  self._TotalCount = TotalCount
13678
14064
 
14065
+ @property
14066
+ def ConsoleSharingInfos(self):
14067
+ """控制台免密分享列表
14068
+ :rtype: list of ConsoleSharingInfo
14069
+ """
14070
+ return self._ConsoleSharingInfos
14071
+
14072
+ @ConsoleSharingInfos.setter
14073
+ def ConsoleSharingInfos(self, ConsoleSharingInfos):
14074
+ self._ConsoleSharingInfos = ConsoleSharingInfos
14075
+
13679
14076
  @property
13680
14077
  def RequestId(self):
13681
14078
  """唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
@@ -13690,6 +14087,12 @@ class DescribeConsoleSharingListResponse(AbstractModel):
13690
14087
 
13691
14088
  def _deserialize(self, params):
13692
14089
  self._TotalCount = params.get("TotalCount")
14090
+ if params.get("ConsoleSharingInfos") is not None:
14091
+ self._ConsoleSharingInfos = []
14092
+ for item in params.get("ConsoleSharingInfos"):
14093
+ obj = ConsoleSharingInfo()
14094
+ obj._deserialize(item)
14095
+ self._ConsoleSharingInfos.append(obj)
13693
14096
  self._RequestId = params.get("RequestId")
13694
14097
 
13695
14098
 
@@ -13700,14 +14103,18 @@ class DescribeConsumerRequest(AbstractModel):
13700
14103
 
13701
14104
  def __init__(self):
13702
14105
  r"""
13703
- :param _TopicId: 投递任务绑定的日志主题 ID
14106
+ :param _TopicId: 投递任务绑定的日志主题Id。
14107
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
14108
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
13704
14109
  :type TopicId: str
13705
14110
  """
13706
14111
  self._TopicId = None
13707
14112
 
13708
14113
  @property
13709
14114
  def TopicId(self):
13710
- """投递任务绑定的日志主题 ID
14115
+ """投递任务绑定的日志主题Id。
14116
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
14117
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
13711
14118
  :rtype: str
13712
14119
  """
13713
14120
  return self._TopicId
@@ -14506,7 +14913,8 @@ class DescribeExportsRequest(AbstractModel):
14506
14913
 
14507
14914
  def __init__(self):
14508
14915
  r"""
14509
- :param _TopicId: 日志主题ID
14916
+ :param _TopicId: 日志主题Id
14917
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14510
14918
  :type TopicId: str
14511
14919
  :param _Offset: 分页的偏移量,默认值为0
14512
14920
  :type Offset: int
@@ -14519,7 +14927,8 @@ class DescribeExportsRequest(AbstractModel):
14519
14927
 
14520
14928
  @property
14521
14929
  def TopicId(self):
14522
- """日志主题ID
14930
+ """日志主题Id
14931
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14523
14932
  :rtype: str
14524
14933
  """
14525
14934
  return self._TopicId
@@ -14807,14 +15216,18 @@ class DescribeKafkaConsumerRequest(AbstractModel):
14807
15216
 
14808
15217
  def __init__(self):
14809
15218
  r"""
14810
- :param _FromTopicId: 日志主题ID
15219
+ :param _FromTopicId: 日志主题Id。
15220
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
15221
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
14811
15222
  :type FromTopicId: str
14812
15223
  """
14813
15224
  self._FromTopicId = None
14814
15225
 
14815
15226
  @property
14816
15227
  def FromTopicId(self):
14817
- """日志主题ID
15228
+ """日志主题Id。
15229
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
15230
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
14818
15231
  :rtype: str
14819
15232
  """
14820
15233
  return self._FromTopicId
@@ -14933,11 +15346,14 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14933
15346
 
14934
15347
  def __init__(self):
14935
15348
  r"""
14936
- :param _TopicId: 日志主题 ID
15349
+ :param _TopicId: 日志主题Id。
15350
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14937
15351
  :type TopicId: str
14938
- :param _Id: 导入配置ID
15352
+ :param _Id: 导入配置Id。
15353
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
15354
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
14939
15355
  :type Id: str
14940
- :param _Status: 状态 status 1: 运行中, 2: 暂停...
15356
+ :param _Status: 状态。1: 运行中,2: 暂停,3:错误
14941
15357
  :type Status: int
14942
15358
  """
14943
15359
  self._TopicId = None
@@ -14946,7 +15362,8 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14946
15362
 
14947
15363
  @property
14948
15364
  def TopicId(self):
14949
- """日志主题 ID
15365
+ """日志主题Id。
15366
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
14950
15367
  :rtype: str
14951
15368
  """
14952
15369
  return self._TopicId
@@ -14957,7 +15374,9 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14957
15374
 
14958
15375
  @property
14959
15376
  def Id(self):
14960
- """导入配置ID
15377
+ """导入配置Id。
15378
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
15379
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
14961
15380
  :rtype: str
14962
15381
  """
14963
15382
  return self._Id
@@ -14968,7 +15387,7 @@ class DescribeKafkaRechargesRequest(AbstractModel):
14968
15387
 
14969
15388
  @property
14970
15389
  def Status(self):
14971
- """状态 status 1: 运行中, 2: 暂停...
15390
+ """状态。1: 运行中,2: 暂停,3:错误
14972
15391
  :rtype: int
14973
15392
  """
14974
15393
  return self._Status
@@ -15318,9 +15737,12 @@ class DescribeLogHistogramRequest(AbstractModel):
15318
15737
  :type From: int
15319
15738
  :param _To: 要查询的日志的结束时间,Unix时间戳,单位ms
15320
15739
  :type To: int
15321
- :param _Query: 查询语句
15740
+ :param _Query: 检索分析语句。
15741
+ 语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。
15742
+ 使用*或空字符串可查询所有日志。
15322
15743
  :type Query: str
15323
15744
  :param _TopicId: 要查询的日志主题ID
15745
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
15324
15746
  :type TopicId: str
15325
15747
  :param _Interval: 时间间隔: 单位ms 限制性条件:(To-From) / interval <= 200
15326
15748
  :type Interval: int
@@ -15360,7 +15782,9 @@ class DescribeLogHistogramRequest(AbstractModel):
15360
15782
 
15361
15783
  @property
15362
15784
  def Query(self):
15363
- """查询语句
15785
+ """检索分析语句。
15786
+ 语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。
15787
+ 使用*或空字符串可查询所有日志。
15364
15788
  :rtype: str
15365
15789
  """
15366
15790
  return self._Query
@@ -15372,6 +15796,7 @@ class DescribeLogHistogramRequest(AbstractModel):
15372
15796
  @property
15373
15797
  def TopicId(self):
15374
15798
  """要查询的日志主题ID
15799
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
15375
15800
  :rtype: str
15376
15801
  """
15377
15802
  return self._TopicId
@@ -15684,6 +16109,7 @@ class DescribeMachineGroupConfigsRequest(AbstractModel):
15684
16109
  def __init__(self):
15685
16110
  r"""
15686
16111
  :param _GroupId: 机器组ID
16112
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
15687
16113
  :type GroupId: str
15688
16114
  """
15689
16115
  self._GroupId = None
@@ -15691,6 +16117,7 @@ class DescribeMachineGroupConfigsRequest(AbstractModel):
15691
16117
  @property
15692
16118
  def GroupId(self):
15693
16119
  """机器组ID
16120
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
15694
16121
  :rtype: str
15695
16122
  """
15696
16123
  return self._GroupId
@@ -15769,7 +16196,8 @@ class DescribeMachineGroupsRequest(AbstractModel):
15769
16196
 
15770
16197
  def __init__(self):
15771
16198
  r"""
15772
- :param _Filters: machineGroupName
16199
+ :param _Filters: 过滤条件
16200
+ machineGroupName
15773
16201
  - 按照【机器组名称】进行过滤。
15774
16202
  - 类型:String
15775
16203
  - 必选:否
@@ -15780,7 +16208,7 @@ machineGroupId
15780
16208
  - 必选:否
15781
16209
 
15782
16210
  osType
15783
- - 按照【操作系统类型】进行过滤。
16211
+ - 按照【操作系统类型】进行过滤。0: Linux;1: Windows
15784
16212
  - 类型:Int
15785
16213
  - 必选:否
15786
16214
 
@@ -15807,7 +16235,8 @@ tag:tagKey
15807
16235
 
15808
16236
  @property
15809
16237
  def Filters(self):
15810
- """machineGroupName
16238
+ """过滤条件
16239
+ machineGroupName
15811
16240
  - 按照【机器组名称】进行过滤。
15812
16241
  - 类型:String
15813
16242
  - 必选:否
@@ -15818,7 +16247,7 @@ machineGroupId
15818
16247
  - 必选:否
15819
16248
 
15820
16249
  osType
15821
- - 按照【操作系统类型】进行过滤。
16250
+ - 按照【操作系统类型】进行过滤。0: Linux;1: Windows
15822
16251
  - 类型:Int
15823
16252
  - 必选:否
15824
16253
 
@@ -16389,14 +16818,16 @@ class DescribePartitionsRequest(AbstractModel):
16389
16818
 
16390
16819
  def __init__(self):
16391
16820
  r"""
16392
- :param _TopicId: 日志主题ID
16821
+ :param _TopicId: 日志主题Id
16822
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
16393
16823
  :type TopicId: str
16394
16824
  """
16395
16825
  self._TopicId = None
16396
16826
 
16397
16827
  @property
16398
16828
  def TopicId(self):
16399
- """日志主题ID
16829
+ """日志主题Id
16830
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
16400
16831
  :rtype: str
16401
16832
  """
16402
16833
  return self._TopicId
@@ -16481,15 +16912,14 @@ class DescribeScheduledSqlInfoRequest(AbstractModel):
16481
16912
  :type Name: str
16482
16913
  :param _TaskId: 任务id。
16483
16914
  :type TaskId: str
16484
- :param _Filters: <li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16485
- <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16486
- <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>
16487
- <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>
16488
- <li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>
16489
- <li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>
16490
- <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16491
- <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>
16492
-
16915
+ :param _Filters: - srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题1 ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
16916
+ - dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题 2,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
16917
+ - srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否。示例:a4478687-2382-4486-9692-de7986350f6b ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
16918
+ - dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否。示例:bd4d3375-d72a-4cd2-988d-d8eda2bd62b0,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
16919
+ - bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否
16920
+ - status按照【任务状态】进行过滤,1:运行;2:停止;3:异常。类型:String。必选:否
16921
+ - taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否。示例:metricTask ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。
16922
+ - taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否。示例:9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。
16493
16923
  :type Filters: list of Filter
16494
16924
  """
16495
16925
  self._Offset = None
@@ -16544,15 +16974,14 @@ class DescribeScheduledSqlInfoRequest(AbstractModel):
16544
16974
 
16545
16975
  @property
16546
16976
  def Filters(self):
16547
- """<li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16548
- <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16549
- <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>
16550
- <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>
16551
- <li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>
16552
- <li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>
16553
- <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>
16554
- <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>
16555
-
16977
+ """- srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题1 ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
16978
+ - dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题 2,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
16979
+ - srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否。示例:a4478687-2382-4486-9692-de7986350f6b ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
16980
+ - dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否。示例:bd4d3375-d72a-4cd2-988d-d8eda2bd62b0,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
16981
+ - bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否
16982
+ - status按照【任务状态】进行过滤,1:运行;2:停止;3:异常。类型:String。必选:否
16983
+ - taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否。示例:metricTask ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。
16984
+ - taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否。示例:9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。
16556
16985
  :rtype: list of Filter
16557
16986
  """
16558
16987
  return self._Filters
@@ -16955,7 +17384,7 @@ class DescribeTopicsRequest(AbstractModel):
16955
17384
  :param _Filters: <ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16956
17385
  <li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16957
17386
  <li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>
16958
- <li>logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用 CreateLogset 创建新的日志集。类型:String。必选:否</li>
17387
+ <li>logsetId 按照【日志集ID】进行过滤,可通过调用 <a href="https://cloud.tencent.com/document/product/614/58624">DescribeLogsets</a> 查询已创建的日志集列表或登录控制台进行查看;也可以调用<a href="https://cloud.tencent.com/document/product/614/58626">CreateLogset</a> 创建新的日志集。类型:String。必选:否</li>
16959
17388
  <li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>
16960
17389
  <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>
16961
17390
  <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>
@@ -16987,7 +17416,7 @@ class DescribeTopicsRequest(AbstractModel):
16987
17416
  """<ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16988
17417
  <li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
16989
17418
  <li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>
16990
- <li>logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用 CreateLogset 创建新的日志集。类型:String。必选:否</li>
17419
+ <li>logsetId 按照【日志集ID】进行过滤,可通过调用 <a href="https://cloud.tencent.com/document/product/614/58624">DescribeLogsets</a> 查询已创建的日志集列表或登录控制台进行查看;也可以调用<a href="https://cloud.tencent.com/document/product/614/58626">CreateLogset</a> 创建新的日志集。类型:String。必选:否</li>
16991
17420
  <li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>
16992
17421
  <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>
16993
17422
  <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>
@@ -17156,7 +17585,7 @@ class DescribeWebCallbacksRequest(AbstractModel):
17156
17585
  按照【告警渠道回调配置渠道类型】进行过滤。
17157
17586
  类型:String
17158
17587
  必选:否
17159
-
17588
+ 枚举值:WeCom,DingTalk,Lark,Http
17160
17589
  每次请求的Filters的上限为10,Filter.Values的上限为100。
17161
17590
  :type Filters: list of Filter
17162
17591
  :param _Offset: 分页的偏移量,默认值为0。
@@ -17184,7 +17613,7 @@ class DescribeWebCallbacksRequest(AbstractModel):
17184
17613
  按照【告警渠道回调配置渠道类型】进行过滤。
17185
17614
  类型:String
17186
17615
  必选:否
17187
-
17616
+ 枚举值:WeCom,DingTalk,Lark,Http
17188
17617
  每次请求的Filters的上限为10,Filter.Values的上限为100。
17189
17618
  :rtype: list of Filter
17190
17619
  """
@@ -17479,9 +17908,12 @@ class EventLog(AbstractModel):
17479
17908
  - ALL 所有日志
17480
17909
 
17481
17910
  :type EventChannel: str
17482
- :param _TimeType: 时间类型,1:用户自定义,2:当前时间
17911
+ :param _TimeType: 时间字段(Timestamp)支持的类型
17912
+ - 1(用户自定义时间)
17913
+ - 2(当前时间)
17483
17914
  :type TimeType: int
17484
17915
  :param _Timestamp: 时间,用户选择自定义时间类型时,需要指定时间,单位秒
17916
+ 格式:时间戳,1754897446
17485
17917
  :type Timestamp: int
17486
17918
  :param _EventIDs: 事件ID过滤列表
17487
17919
 
@@ -17514,7 +17946,9 @@ class EventLog(AbstractModel):
17514
17946
 
17515
17947
  @property
17516
17948
  def TimeType(self):
17517
- """时间类型,1:用户自定义,2:当前时间
17949
+ """时间字段(Timestamp)支持的类型
17950
+ - 1(用户自定义时间)
17951
+ - 2(当前时间)
17518
17952
  :rtype: int
17519
17953
  """
17520
17954
  return self._TimeType
@@ -17526,6 +17960,7 @@ class EventLog(AbstractModel):
17526
17960
  @property
17527
17961
  def Timestamp(self):
17528
17962
  """时间,用户选择自定义时间类型时,需要指定时间,单位秒
17963
+ 格式:时间戳,1754897446
17529
17964
  :rtype: int
17530
17965
  """
17531
17966
  return self._Timestamp
@@ -17641,13 +18076,14 @@ class ExportInfo(AbstractModel):
17641
18076
  :type Count: int
17642
18077
  :param _Status: 日志下载状态。Processing:导出正在进行中,Completed:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期), Queuing 排队中
17643
18078
  :type Status: str
17644
- :param _From: 日志导出起始时间
18079
+ :param _From: 日志导出起始时间,毫秒时间戳
17645
18080
  :type From: int
17646
- :param _To: 日志导出结束时间
18081
+ :param _To: 日志导出结束时间,毫秒时间戳
17647
18082
  :type To: int
17648
18083
  :param _CosPath: 日志导出路径,有效期一个小时,请尽快使用该路径下载。
17649
18084
  :type CosPath: str
17650
18085
  :param _CreateTime: 日志导出创建时间
18086
+ 时间格式:yyyy-MM-dd HH:mm:ss
17651
18087
  :type CreateTime: str
17652
18088
  :param _SyntaxRule: 语法规则。 默认值为0。
17653
18089
  0:Lucene语法,1:CQL语法。
@@ -17772,7 +18208,7 @@ class ExportInfo(AbstractModel):
17772
18208
 
17773
18209
  @property
17774
18210
  def From(self):
17775
- """日志导出起始时间
18211
+ """日志导出起始时间,毫秒时间戳
17776
18212
  :rtype: int
17777
18213
  """
17778
18214
  return self._From
@@ -17783,7 +18219,7 @@ class ExportInfo(AbstractModel):
17783
18219
 
17784
18220
  @property
17785
18221
  def To(self):
17786
- """日志导出结束时间
18222
+ """日志导出结束时间,毫秒时间戳
17787
18223
  :rtype: int
17788
18224
  """
17789
18225
  return self._To
@@ -17806,6 +18242,7 @@ class ExportInfo(AbstractModel):
17806
18242
  @property
17807
18243
  def CreateTime(self):
17808
18244
  """日志导出创建时间
18245
+ 时间格式:yyyy-MM-dd HH:mm:ss
17809
18246
  :rtype: str
17810
18247
  """
17811
18248
  return self._CreateTime
@@ -17871,9 +18308,10 @@ class ExtractRuleInfo(AbstractModel):
17871
18308
 
17872
18309
  def __init__(self):
17873
18310
  r"""
17874
- :param _TimeKey: 时间字段的key名字,TikeKey和TimeFormat必须成对出现
18311
+ :param _TimeKey: 时间字段的key名字,TimeKey和TimeFormat必须成对出现
17875
18312
  :type TimeKey: str
17876
18313
  :param _TimeFormat: 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
18314
+ - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
17877
18315
  :type TimeFormat: str
17878
18316
  :param _Delimiter: 分隔符类型日志的分隔符,只有LogType为delimiter_log时有效
17879
18317
  :type Delimiter: str
@@ -17978,7 +18416,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
17978
18416
 
17979
18417
  @property
17980
18418
  def TimeKey(self):
17981
- """时间字段的key名字,TikeKey和TimeFormat必须成对出现
18419
+ """时间字段的key名字,TimeKey和TimeFormat必须成对出现
17982
18420
  :rtype: str
17983
18421
  """
17984
18422
  return self._TimeKey
@@ -17990,6 +18428,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
17990
18428
  @property
17991
18429
  def TimeFormat(self):
17992
18430
  """时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
18431
+ - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
17993
18432
  :rtype: str
17994
18433
  """
17995
18434
  return self._TimeFormat
@@ -18542,7 +18981,9 @@ class GetAlarmLogRequest(AbstractModel):
18542
18981
  :type To: int
18543
18982
  :param _Query: 查询过滤条件,例如:
18544
18983
  - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
18984
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
18545
18985
  - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
18986
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
18546
18987
  - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
18547
18988
  - 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c") AND (monitored_object:"3c514e84-6f1f-46ec-xxxx-05de6163f7fe") AND NOT condition_evaluate_result: "Skip" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1`
18548
18989
  :type Query: str
@@ -18597,7 +19038,9 @@ false:代表使用老的检索结果返回方式,输出AnalysisResults和Col
18597
19038
  def Query(self):
18598
19039
  """查询过滤条件,例如:
18599
19040
  - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
19041
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
18600
19042
  - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
19043
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
18601
19044
  - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
18602
19045
  - 按告警策略ID及监控对象ID查询支持SQL语句:`(alert_id:"alarm-5ce45495-09e8-4d58-xxxx-768134bf330c") AND (monitored_object:"3c514e84-6f1f-46ec-xxxx-05de6163f7fe") AND NOT condition_evaluate_result: "Skip" AND condition_evaluate_result:[* TO *] | SELECT count(*) as top50StatisticsTotalCount, count_if(condition_evaluate_result='ProcessError') as top50StatisticsFailureCount, count_if(notification_send_result!='NotSend') as top50NoticeTotalCount, count_if(notification_send_result='SendPartFail' or notification_send_result='SendFail') as top50NoticeFailureCount, alert_id, alert_name, monitored_object, topic_type, happen_threshold, alert_threshold, notify_template group by alert_id, alert_name, monitored_object,topic_type, happen_threshold, alert_threshold, notify_template order by top50StatisticsTotalCount desc limit 1`
18603
19046
  :rtype: str
@@ -19307,10 +19750,22 @@ class KafkaProtocolInfo(AbstractModel):
19307
19750
  def __init__(self):
19308
19751
  r"""
19309
19752
  :param _Protocol: 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
19310
- 入参必填
19753
+
19754
+ - 当IsEncryptionAddr为true时,Protocol必填。
19755
+ - 支持的协议类型如下:
19756
+ - plaintext:纯文本无加密协议
19757
+ - sasl_ssl:SASL 认证 + SSL 加密
19758
+ - ssl:纯 SSL/TLS 加密协议
19759
+ - sasl_plaintext:SASL 认证 + 非加密通道
19760
+
19311
19761
  :type Protocol: str
19312
19762
  :param _Mechanism: 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
19313
- 当Protocol为sasl_plaintext或sasl_ssl时必填
19763
+
19764
+ - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。
19765
+ - 支持加密类型如下
19766
+ - PLAIN:明文认证
19767
+ - SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法
19768
+ - SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法
19314
19769
  :type Mechanism: str
19315
19770
  :param _UserName: 用户名。
19316
19771
  当Protocol为sasl_plaintext或sasl_ssl时必填
@@ -19327,7 +19782,14 @@ class KafkaProtocolInfo(AbstractModel):
19327
19782
  @property
19328
19783
  def Protocol(self):
19329
19784
  """协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
19330
- 入参必填
19785
+
19786
+ - 当IsEncryptionAddr为true时,Protocol必填。
19787
+ - 支持的协议类型如下:
19788
+ - plaintext:纯文本无加密协议
19789
+ - sasl_ssl:SASL 认证 + SSL 加密
19790
+ - ssl:纯 SSL/TLS 加密协议
19791
+ - sasl_plaintext:SASL 认证 + 非加密通道
19792
+
19331
19793
  :rtype: str
19332
19794
  """
19333
19795
  return self._Protocol
@@ -19339,7 +19801,12 @@ class KafkaProtocolInfo(AbstractModel):
19339
19801
  @property
19340
19802
  def Mechanism(self):
19341
19803
  """加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
19342
- 当Protocol为sasl_plaintext或sasl_ssl时必填
19804
+
19805
+ - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。
19806
+ - 支持加密类型如下
19807
+ - PLAIN:明文认证
19808
+ - SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法
19809
+ - SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法
19343
19810
  :rtype: str
19344
19811
  """
19345
19812
  return self._Mechanism
@@ -20239,7 +20706,7 @@ class LogRechargeRuleInfo(AbstractModel):
20239
20706
  :type RechargeType: str
20240
20707
  :param _EncodingFormat: 解析编码格式,0: UTF-8(默认值),1: GBK
20241
20708
  :type EncodingFormat: int
20242
- :param _DefaultTimeSwitch: 使用默认时间,true:开启(默认值), flase:关闭
20709
+ :param _DefaultTimeSwitch: 使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true
20243
20710
  :type DefaultTimeSwitch: bool
20244
20711
  :param _LogRegex: 整条日志匹配规则,只有RechargeType为fullregex_log时有效
20245
20712
  :type LogRegex: str
@@ -20251,13 +20718,101 @@ class LogRechargeRuleInfo(AbstractModel):
20251
20718
  :type UnMatchLogTimeSrc: int
20252
20719
  :param _DefaultTimeSrc: 默认时间来源,0: 系统当前时间,1: Kafka消息时间戳
20253
20720
  :type DefaultTimeSrc: int
20254
- :param _TimeKey: 时间字段
20721
+ :param _TimeKey: 时间字段,日志中代表时间的字段名。
20722
+
20723
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。
20255
20724
  :type TimeKey: str
20256
- :param _TimeRegex: 时间提取正则表达式
20725
+ :param _TimeRegex: 时间提取正则表达式。
20726
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时, TimeRegex不能为空。
20727
+ - 仅需输入日志中代表时间的字段的正则表达式即可;若匹配到多个字段,将使用第一个。
20728
+ 例:日志原文为:message with time 2022-08-08 14:20:20,则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d
20729
+
20257
20730
  :type TimeRegex: str
20258
- :param _TimeFormat: 时间字段格式
20731
+ :param _TimeFormat: 时间字段格式。
20732
+ - 当DefaultTimeSwitch为false时, TimeFormat不能为空。
20259
20733
  :type TimeFormat: str
20260
- :param _TimeZone: 时间字段时区
20734
+ :param _TimeZone: 时间字段时区。
20735
+ - 当DefaultTimeSwitch为false时, TimeZone不能为空。
20736
+ - 时区格式规则
20737
+ ​前缀​:使用 GMT 或 UTC 作为时区基准
20738
+ ​偏移量​:
20739
+ - `-` 表示西时区(比基准时间晚)
20740
+ - `+` 表示东时区(比基准时间早)
20741
+ - 格式为 ±HH:MM(小时:分钟)
20742
+
20743
+ - 当前支持:
20744
+ ```
20745
+ "GMT-12:00"
20746
+ "GMT-11:00"
20747
+ "GMT-10:00"
20748
+ "GMT-09:30"
20749
+ "GMT-09:00"
20750
+ "GMT-08:00"
20751
+ "GMT-07:00"
20752
+ "GMT-06:00"
20753
+ "GMT-05:00"
20754
+ "GMT-04:00"
20755
+ "GMT-03:30"
20756
+ "GMT-03:00"
20757
+ "GMT-02:00"
20758
+ "GMT-01:00"
20759
+ "GMT+00:00"
20760
+ "GMT+01:00"
20761
+ "GMT+02:00"
20762
+ "GMT+03:30"
20763
+ "GMT+04:00"
20764
+ "GMT+04:30"
20765
+ "GMT+05:00"
20766
+ "GMT+05:30"
20767
+ "GMT+05:45"
20768
+ "GMT+06:00"
20769
+ "GMT+06:30"
20770
+ "GMT+07:00"
20771
+ "GMT+08:00"
20772
+ "GMT+09:00"
20773
+ "GMT+09:30"
20774
+ "GMT+10:00"
20775
+ "GMT+10:30"
20776
+ "GMT+11:00"
20777
+ "GMT+11:30"
20778
+ "GMT+12:00"
20779
+ "GMT+12:45"
20780
+ "GMT+13:00"
20781
+ "GMT+14:00"
20782
+ "UTC-11:00"
20783
+ "UTC-10:00"
20784
+ "UTC-09:00"
20785
+ "UTC-08:00"
20786
+ "UTC-12:00"
20787
+ "UTC-07:00"
20788
+ "UTC-06:00"
20789
+ "UTC-05:00"
20790
+ "UTC-04:30"
20791
+ "UTC-04:00"
20792
+ "UTC-03:30"
20793
+ "UTC-03:00"
20794
+ "UTC-02:00"
20795
+ "UTC-01:00"
20796
+ "UTC+00:00"
20797
+ "UTC+01:00"
20798
+ "UTC+02:00"
20799
+ "UTC+03:00"
20800
+ "UTC+03:30"
20801
+ "UTC+04:00"
20802
+ "UTC+04:30"
20803
+ "UTC+05:00"
20804
+ "UTC+05:45"
20805
+ "UTC+06:00"
20806
+ "UTC+06:30"
20807
+ "UTC+07:00"
20808
+ "UTC+08:00"
20809
+ "UTC+09:00"
20810
+ "UTC+09:30"
20811
+ "UTC+10:00"
20812
+ "UTC+11:00"
20813
+ "UTC+12:00"
20814
+ "UTC+13:00"
20815
+ ```
20261
20816
  :type TimeZone: str
20262
20817
  :param _Metadata: 元数据信息,Kafka导入支持kafka_topic,kafka_partition,kafka_offset,kafka_timestamp
20263
20818
  :type Metadata: list of str
@@ -20306,7 +20861,7 @@ class LogRechargeRuleInfo(AbstractModel):
20306
20861
 
20307
20862
  @property
20308
20863
  def DefaultTimeSwitch(self):
20309
- """使用默认时间,true:开启(默认值), flase:关闭
20864
+ """使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true
20310
20865
  :rtype: bool
20311
20866
  """
20312
20867
  return self._DefaultTimeSwitch
@@ -20372,7 +20927,9 @@ class LogRechargeRuleInfo(AbstractModel):
20372
20927
 
20373
20928
  @property
20374
20929
  def TimeKey(self):
20375
- """时间字段
20930
+ """时间字段,日志中代表时间的字段名。
20931
+
20932
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。
20376
20933
  :rtype: str
20377
20934
  """
20378
20935
  return self._TimeKey
@@ -20383,7 +20940,11 @@ class LogRechargeRuleInfo(AbstractModel):
20383
20940
 
20384
20941
  @property
20385
20942
  def TimeRegex(self):
20386
- """时间提取正则表达式
20943
+ """时间提取正则表达式。
20944
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时, TimeRegex不能为空。
20945
+ - 仅需输入日志中代表时间的字段的正则表达式即可;若匹配到多个字段,将使用第一个。
20946
+ 例:日志原文为:message with time 2022-08-08 14:20:20,则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d
20947
+
20387
20948
  :rtype: str
20388
20949
  """
20389
20950
  return self._TimeRegex
@@ -20394,7 +20955,8 @@ class LogRechargeRuleInfo(AbstractModel):
20394
20955
 
20395
20956
  @property
20396
20957
  def TimeFormat(self):
20397
- """时间字段格式
20958
+ """时间字段格式。
20959
+ - 当DefaultTimeSwitch为false时, TimeFormat不能为空。
20398
20960
  :rtype: str
20399
20961
  """
20400
20962
  return self._TimeFormat
@@ -20405,7 +20967,88 @@ class LogRechargeRuleInfo(AbstractModel):
20405
20967
 
20406
20968
  @property
20407
20969
  def TimeZone(self):
20408
- """时间字段时区
20970
+ """时间字段时区。
20971
+ - 当DefaultTimeSwitch为false时, TimeZone不能为空。
20972
+ - 时区格式规则
20973
+ ​前缀​:使用 GMT 或 UTC 作为时区基准
20974
+ ​偏移量​:
20975
+ - `-` 表示西时区(比基准时间晚)
20976
+ - `+` 表示东时区(比基准时间早)
20977
+ - 格式为 ±HH:MM(小时:分钟)
20978
+
20979
+ - 当前支持:
20980
+ ```
20981
+ "GMT-12:00"
20982
+ "GMT-11:00"
20983
+ "GMT-10:00"
20984
+ "GMT-09:30"
20985
+ "GMT-09:00"
20986
+ "GMT-08:00"
20987
+ "GMT-07:00"
20988
+ "GMT-06:00"
20989
+ "GMT-05:00"
20990
+ "GMT-04:00"
20991
+ "GMT-03:30"
20992
+ "GMT-03:00"
20993
+ "GMT-02:00"
20994
+ "GMT-01:00"
20995
+ "GMT+00:00"
20996
+ "GMT+01:00"
20997
+ "GMT+02:00"
20998
+ "GMT+03:30"
20999
+ "GMT+04:00"
21000
+ "GMT+04:30"
21001
+ "GMT+05:00"
21002
+ "GMT+05:30"
21003
+ "GMT+05:45"
21004
+ "GMT+06:00"
21005
+ "GMT+06:30"
21006
+ "GMT+07:00"
21007
+ "GMT+08:00"
21008
+ "GMT+09:00"
21009
+ "GMT+09:30"
21010
+ "GMT+10:00"
21011
+ "GMT+10:30"
21012
+ "GMT+11:00"
21013
+ "GMT+11:30"
21014
+ "GMT+12:00"
21015
+ "GMT+12:45"
21016
+ "GMT+13:00"
21017
+ "GMT+14:00"
21018
+ "UTC-11:00"
21019
+ "UTC-10:00"
21020
+ "UTC-09:00"
21021
+ "UTC-08:00"
21022
+ "UTC-12:00"
21023
+ "UTC-07:00"
21024
+ "UTC-06:00"
21025
+ "UTC-05:00"
21026
+ "UTC-04:30"
21027
+ "UTC-04:00"
21028
+ "UTC-03:30"
21029
+ "UTC-03:00"
21030
+ "UTC-02:00"
21031
+ "UTC-01:00"
21032
+ "UTC+00:00"
21033
+ "UTC+01:00"
21034
+ "UTC+02:00"
21035
+ "UTC+03:00"
21036
+ "UTC+03:30"
21037
+ "UTC+04:00"
21038
+ "UTC+04:30"
21039
+ "UTC+05:00"
21040
+ "UTC+05:45"
21041
+ "UTC+06:00"
21042
+ "UTC+06:30"
21043
+ "UTC+07:00"
21044
+ "UTC+08:00"
21045
+ "UTC+09:00"
21046
+ "UTC+09:30"
21047
+ "UTC+10:00"
21048
+ "UTC+11:00"
21049
+ "UTC+12:00"
21050
+ "UTC+13:00"
21051
+ ```
20409
21052
  :rtype: str
20410
21053
  """
20411
21054
  return self._TimeZone
@@ -20619,18 +21262,21 @@ class MachineGroupInfo(AbstractModel):
20619
21262
  :param _MachineGroupType: 机器组类型
20620
21263
  :type MachineGroupType: :class:`tencentcloud.cls.v20201016.models.MachineGroupTypeInfo`
20621
21264
  :param _CreateTime: 创建时间
21265
+ 时间格式:yyyy-MM-dd HH:mm:ss
20622
21266
  :type CreateTime: str
20623
21267
  :param _Tags: 机器组绑定的标签列表
20624
21268
  :type Tags: list of Tag
20625
21269
  :param _AutoUpdate: 是否开启机器组自动更新
20626
21270
  :type AutoUpdate: str
20627
21271
  :param _UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
21272
+ 时间格式:HH:mm:ss
20628
21273
  :type UpdateStartTime: str
20629
21274
  :param _UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
21275
+ 时间格式:HH:mm:ss
20630
21276
  :type UpdateEndTime: str
20631
21277
  :param _ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
20632
21278
  :type ServiceLogging: bool
20633
- :param _DelayCleanupTime: 机器组中机器离线定期清理时间
21279
+ :param _DelayCleanupTime: 机器组中机器离线定期清理时间,单位天,默认设置30天。
20634
21280
  :type DelayCleanupTime: int
20635
21281
  :param _MetaTags: 机器组元数据信息列表
20636
21282
  :type MetaTags: list of MetaTagInfo
@@ -20686,6 +21332,7 @@ class MachineGroupInfo(AbstractModel):
20686
21332
  @property
20687
21333
  def CreateTime(self):
20688
21334
  """创建时间
21335
+ 时间格式:yyyy-MM-dd HH:mm:ss
20689
21336
  :rtype: str
20690
21337
  """
20691
21338
  return self._CreateTime
@@ -20719,6 +21366,7 @@ class MachineGroupInfo(AbstractModel):
20719
21366
  @property
20720
21367
  def UpdateStartTime(self):
20721
21368
  """升级开始时间,建议业务低峰期升级LogListener
21369
+ 时间格式:HH:mm:ss
20722
21370
  :rtype: str
20723
21371
  """
20724
21372
  return self._UpdateStartTime
@@ -20730,6 +21378,7 @@ class MachineGroupInfo(AbstractModel):
20730
21378
  @property
20731
21379
  def UpdateEndTime(self):
20732
21380
  """升级结束时间,建议业务低峰期升级LogListener
21381
+ 时间格式:HH:mm:ss
20733
21382
  :rtype: str
20734
21383
  """
20735
21384
  return self._UpdateEndTime
@@ -20751,7 +21400,7 @@ class MachineGroupInfo(AbstractModel):
20751
21400
 
20752
21401
  @property
20753
21402
  def DelayCleanupTime(self):
20754
- """机器组中机器离线定期清理时间
21403
+ """机器组中机器离线定期清理时间,单位天,默认设置30天。
20755
21404
  :rtype: int
20756
21405
  """
20757
21406
  return self._DelayCleanupTime
@@ -21040,9 +21689,10 @@ class MergePartitionRequest(AbstractModel):
21040
21689
 
21041
21690
  def __init__(self):
21042
21691
  r"""
21043
- :param _TopicId: 日志主题ID
21692
+ :param _TopicId: 日志主题Id
21693
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
21044
21694
  :type TopicId: str
21045
- :param _PartitionId: 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Staus:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)
21695
+ :param _PartitionId: 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Status:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)
21046
21696
 
21047
21697
  1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);
21048
21698
  2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);
@@ -21054,7 +21704,8 @@ class MergePartitionRequest(AbstractModel):
21054
21704
 
21055
21705
  @property
21056
21706
  def TopicId(self):
21057
- """日志主题ID
21707
+ """日志主题Id
21708
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
21058
21709
  :rtype: str
21059
21710
  """
21060
21711
  return self._TopicId
@@ -21065,7 +21716,7 @@ class MergePartitionRequest(AbstractModel):
21065
21716
 
21066
21717
  @property
21067
21718
  def PartitionId(self):
21068
- """合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Staus:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)
21719
+ """合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Status:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)
21069
21720
 
21070
21721
  1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);
21071
21722
  2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);
@@ -21249,7 +21900,7 @@ class ModifyAlarmNoticeRequest(AbstractModel):
21249
21900
 
21250
21901
  def __init__(self):
21251
21902
  r"""
21252
- :param _AlarmNoticeId: 通知渠道组ID
21903
+ :param _AlarmNoticeId: 通知渠道组ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知渠道组ID
21253
21904
  :type AlarmNoticeId: str
21254
21905
  :param _Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的通知渠道组。最大支持10个标签键值对,并且不能有重复的键值对。
21255
21906
  :type Tags: list of Tag
@@ -21304,7 +21955,7 @@ class ModifyAlarmNoticeRequest(AbstractModel):
21304
21955
 
21305
21956
  @property
21306
21957
  def AlarmNoticeId(self):
21307
- """通知渠道组ID
21958
+ """通知渠道组ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知渠道组ID
21308
21959
  :rtype: str
21309
21960
  """
21310
21961
  return self._AlarmNoticeId
@@ -21521,13 +22172,13 @@ class ModifyAlarmRequest(AbstractModel):
21521
22172
 
21522
22173
  def __init__(self):
21523
22174
  r"""
21524
- :param _AlarmId: 告警策略ID
22175
+ :param _AlarmId: 告警策略ID。-通过[获取告警策略列表](https://cloud.tencent.com/document/product/614/56461)获取告警策略ID
21525
22176
  :type AlarmId: str
21526
- :param _Name: 告警策略名称
22177
+ :param _Name: 告警策略名称。最大支持255个字节,不支持 '|'。
21527
22178
  :type Name: str
21528
22179
  :param _MonitorTime: 监控任务运行时间点。
21529
22180
  :type MonitorTime: :class:`tencentcloud.cls.v20201016.models.MonitorTime`
21530
- :param _Condition: 触发条件。
22181
+ :param _Condition: 告警信息发送的触发条件。
21531
22182
 
21532
22183
  注意:
21533
22184
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
@@ -21548,7 +22199,7 @@ class ModifyAlarmRequest(AbstractModel):
21548
22199
  :type TriggerCount: int
21549
22200
  :param _AlarmPeriod: 告警重复的周期。单位是分钟。取值范围是0~1440。
21550
22201
  :type AlarmPeriod: int
21551
- :param _AlarmNoticeIds: 关联的告警通知模板列表。
22202
+ :param _AlarmNoticeIds: 关联的告警通知渠道列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取告警通知渠道列表
21552
22203
  :type AlarmNoticeIds: list of str
21553
22204
  :param _AlarmTargets: 监控对象列表。
21554
22205
  :type AlarmTargets: list of AlarmTarget
@@ -21601,7 +22252,7 @@ Classifications元素的Value长度不能超过200个字符。
21601
22252
 
21602
22253
  @property
21603
22254
  def AlarmId(self):
21604
- """告警策略ID
22255
+ """告警策略ID。-通过[获取告警策略列表](https://cloud.tencent.com/document/product/614/56461)获取告警策略ID
21605
22256
  :rtype: str
21606
22257
  """
21607
22258
  return self._AlarmId
@@ -21612,7 +22263,7 @@ Classifications元素的Value长度不能超过200个字符。
21612
22263
 
21613
22264
  @property
21614
22265
  def Name(self):
21615
- """告警策略名称
22266
+ """告警策略名称。最大支持255个字节,不支持 '|'。
21616
22267
  :rtype: str
21617
22268
  """
21618
22269
  return self._Name
@@ -21634,7 +22285,7 @@ Classifications元素的Value长度不能超过200个字符。
21634
22285
 
21635
22286
  @property
21636
22287
  def Condition(self):
21637
- """触发条件。
22288
+ """告警信息发送的触发条件。
21638
22289
 
21639
22290
  注意:
21640
22291
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
@@ -21700,7 +22351,7 @@ Classifications元素的Value长度不能超过200个字符。
21700
22351
 
21701
22352
  @property
21702
22353
  def AlarmNoticeIds(self):
21703
- """关联的告警通知模板列表。
22354
+ """关联的告警通知渠道列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取告警通知渠道列表
21704
22355
  :rtype: list of str
21705
22356
  """
21706
22357
  return self._AlarmNoticeIds
@@ -21935,13 +22586,13 @@ class ModifyAlarmShieldRequest(AbstractModel):
21935
22586
 
21936
22587
  def __init__(self):
21937
22588
  r"""
21938
- :param _TaskId: 屏蔽规则ID
22589
+ :param _TaskId: 屏蔽规则ID。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
21939
22590
  :type TaskId: str
21940
- :param _AlarmNoticeId: 通知渠道组id
22591
+ :param _AlarmNoticeId: 通知渠道组id。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
21941
22592
  :type AlarmNoticeId: str
21942
- :param _StartTime: 屏蔽开始时间(秒级时间戳)。
22593
+ :param _StartTime: 屏蔽开始时间,秒级(s)时间戳。
21943
22594
  :type StartTime: int
21944
- :param _EndTime: 屏蔽结束时间(秒级时间戳)。
22595
+ :param _EndTime: 屏蔽结束时间,秒级(s)时间戳。
21945
22596
  :type EndTime: int
21946
22597
  :param _Type: 屏蔽类型。1:屏蔽所有通知,2:按照Rule参数屏蔽匹配规则的通知。
21947
22598
  :type Type: int
@@ -21950,6 +22601,7 @@ class ModifyAlarmShieldRequest(AbstractModel):
21950
22601
  :param _Reason: 屏蔽原因。
21951
22602
  :type Reason: str
21952
22603
  :param _Status: 规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2)。
22604
+ 枚举:0(未生效),1(生效中),2(已失效)
21953
22605
  :type Status: int
21954
22606
  """
21955
22607
  self._TaskId = None
@@ -21963,7 +22615,7 @@ class ModifyAlarmShieldRequest(AbstractModel):
21963
22615
 
21964
22616
  @property
21965
22617
  def TaskId(self):
21966
- """屏蔽规则ID
22618
+ """屏蔽规则ID。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
21967
22619
  :rtype: str
21968
22620
  """
21969
22621
  return self._TaskId
@@ -21974,7 +22626,7 @@ class ModifyAlarmShieldRequest(AbstractModel):
21974
22626
 
21975
22627
  @property
21976
22628
  def AlarmNoticeId(self):
21977
- """通知渠道组id
22629
+ """通知渠道组id。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
21978
22630
  :rtype: str
21979
22631
  """
21980
22632
  return self._AlarmNoticeId
@@ -21985,7 +22637,7 @@ class ModifyAlarmShieldRequest(AbstractModel):
21985
22637
 
21986
22638
  @property
21987
22639
  def StartTime(self):
21988
- """屏蔽开始时间(秒级时间戳)。
22640
+ """屏蔽开始时间,秒级(s)时间戳。
21989
22641
  :rtype: int
21990
22642
  """
21991
22643
  return self._StartTime
@@ -21996,7 +22648,7 @@ class ModifyAlarmShieldRequest(AbstractModel):
21996
22648
 
21997
22649
  @property
21998
22650
  def EndTime(self):
21999
- """屏蔽结束时间(秒级时间戳)。
22651
+ """屏蔽结束时间,秒级(s)时间戳。
22000
22652
  :rtype: int
22001
22653
  """
22002
22654
  return self._EndTime
@@ -22041,6 +22693,7 @@ class ModifyAlarmShieldRequest(AbstractModel):
22041
22693
  @property
22042
22694
  def Status(self):
22043
22695
  """规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2)。
22696
+ 枚举:0(未生效),1(生效中),2(已失效)
22044
22697
  :rtype: int
22045
22698
  """
22046
22699
  return self._Status
@@ -22643,6 +23296,8 @@ class ModifyConfigRequest(AbstractModel):
22643
23296
  :param _ConfigId: 采集规则配置ID,通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)返回信息获取。
22644
23297
  :type ConfigId: str
22645
23298
  :param _Name: 采集规则配置名称
23299
+ - 不能包含特殊字符|
23300
+ - 长度不能超过255字符,超过会被截断
22646
23301
  :type Name: str
22647
23302
  :param _Path: 日志采集路径,包含文件名
22648
23303
  :type Path: str
@@ -22664,6 +23319,7 @@ class ModifyConfigRequest(AbstractModel):
22664
23319
  :param _ExcludePaths: 采集黑名单路径列表
22665
23320
  :type ExcludePaths: list of ExcludePathInfo
22666
23321
  :param _Output: 采集配置关联的日志主题(TopicId)
23322
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22667
23323
  :type Output: str
22668
23324
  :param _UserDefineRule: 用户自定义解析字符串,Json格式序列化的字符串。
22669
23325
  :type UserDefineRule: str
@@ -22699,6 +23355,8 @@ class ModifyConfigRequest(AbstractModel):
22699
23355
  @property
22700
23356
  def Name(self):
22701
23357
  """采集规则配置名称
23358
+ - 不能包含特殊字符|
23359
+ - 长度不能超过255字符,超过会被截断
22702
23360
  :rtype: str
22703
23361
  """
22704
23362
  return self._Name
@@ -22765,6 +23423,7 @@ class ModifyConfigRequest(AbstractModel):
22765
23423
  @property
22766
23424
  def Output(self):
22767
23425
  """采集配置关联的日志主题(TopicId)
23426
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
22768
23427
  :rtype: str
22769
23428
  """
22770
23429
  return self._Output
@@ -22863,7 +23522,9 @@ class ModifyConsoleSharingRequest(AbstractModel):
22863
23522
 
22864
23523
  def __init__(self):
22865
23524
  r"""
22866
- :param _SharingId: 免密分享链接Id
23525
+ :param _SharingId: 免密分享Id
23526
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
23527
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
22867
23528
  :type SharingId: str
22868
23529
  :param _DurationMilliseconds: 指定分享链接有效期,单位:毫秒,最长可设定有效期为30天
22869
23530
  :type DurationMilliseconds: int
@@ -22873,7 +23534,9 @@ class ModifyConsoleSharingRequest(AbstractModel):
22873
23534
 
22874
23535
  @property
22875
23536
  def SharingId(self):
22876
- """免密分享链接Id
23537
+ """免密分享Id
23538
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
23539
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
22877
23540
  :rtype: str
22878
23541
  """
22879
23542
  return self._SharingId
@@ -22942,7 +23605,9 @@ class ModifyConsumerRequest(AbstractModel):
22942
23605
 
22943
23606
  def __init__(self):
22944
23607
  r"""
22945
- :param _TopicId: 投递任务绑定的日志主题 ID
23608
+ :param _TopicId: 投递任务绑定的日志主题Id。
23609
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
23610
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
22946
23611
  :type TopicId: str
22947
23612
  :param _Effective: 投递任务是否生效,默认不生效
22948
23613
  :type Effective: bool
@@ -22966,7 +23631,9 @@ class ModifyConsumerRequest(AbstractModel):
22966
23631
 
22967
23632
  @property
22968
23633
  def TopicId(self):
22969
- """投递任务绑定的日志主题 ID
23634
+ """投递任务绑定的日志主题Id。
23635
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
23636
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
22970
23637
  :rtype: str
22971
23638
  """
22972
23639
  return self._TopicId
@@ -23748,9 +24415,11 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23748
24415
 
23749
24416
  def __init__(self):
23750
24417
  r"""
23751
- :param _FromTopicId: 日志主题ID
24418
+ :param _FromTopicId: 日志主题Id。
24419
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
24420
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
23752
24421
  :type FromTopicId: str
23753
- :param _Compression: 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
24422
+ :param _Compression: 压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
23754
24423
  :type Compression: int
23755
24424
  :param _ConsumerContent: kafka协议消费数据格式
23756
24425
  :type ConsumerContent: :class:`tencentcloud.cls.v20201016.models.KafkaConsumerContent`
@@ -23761,7 +24430,9 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23761
24430
 
23762
24431
  @property
23763
24432
  def FromTopicId(self):
23764
- """日志主题ID
24433
+ """日志主题Id。
24434
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
24435
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
23765
24436
  :rtype: str
23766
24437
  """
23767
24438
  return self._FromTopicId
@@ -23772,7 +24443,7 @@ class ModifyKafkaConsumerRequest(AbstractModel):
23772
24443
 
23773
24444
  @property
23774
24445
  def Compression(self):
23775
- """压缩方式[0:NONE;2:SNAPPY;3:LZ4]
24446
+ """压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
23776
24447
  :rtype: int
23777
24448
  """
23778
24449
  return self._Compression
@@ -23844,15 +24515,20 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23844
24515
 
23845
24516
  def __init__(self):
23846
24517
  r"""
23847
- :param _Id: Kafka导入配置ID
24518
+ :param _Id: 导入配置Id。
24519
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
24520
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
23848
24521
  :type Id: str
23849
- :param _TopicId: 导入CLS目标topic ID
24522
+ :param _TopicId: 导入CLS目标TopicId。
24523
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
24524
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。
23850
24525
  :type TopicId: str
23851
24526
  :param _Name: Kafka导入配置名称
23852
24527
  :type Name: str
23853
24528
  :param _KafkaType: 导入Kafka类型,0:腾讯云CKafka:1:用户自建Kafka。
23854
24529
  :type KafkaType: int
23855
24530
  :param _KafkaInstance: 腾讯云CKafka实例ID,KafkaType为0时必填。
24531
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
23856
24532
  :type KafkaInstance: str
23857
24533
  :param _ServerAddr: 服务地址,KafkaType为1时必填。
23858
24534
  :type ServerAddr: str
@@ -23860,13 +24536,15 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23860
24536
  :type IsEncryptionAddr: bool
23861
24537
  :param _Protocol: 加密访问协议,KafkaType参数为1并且IsEncryptionAddr参数为true时必填。
23862
24538
  :type Protocol: :class:`tencentcloud.cls.v20201016.models.KafkaProtocolInfo`
23863
- :param _UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
24539
+ :param _UserKafkaTopics: 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
24540
+
24541
+ - Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
23864
24542
  :type UserKafkaTopics: str
23865
24543
  :param _ConsumerGroupName: 用户Kafka消费组名称
23866
24544
  :type ConsumerGroupName: str
23867
24545
  :param _LogRechargeRule: 日志导入规则
23868
24546
  :type LogRechargeRule: :class:`tencentcloud.cls.v20201016.models.LogRechargeRuleInfo`
23869
- :param _StatusControl: 导入控制,1:暂停;2:继续。
24547
+ :param _StatusControl: 导入控制,1:暂停;2:启动。
23870
24548
  :type StatusControl: int
23871
24549
  """
23872
24550
  self._Id = None
@@ -23884,7 +24562,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23884
24562
 
23885
24563
  @property
23886
24564
  def Id(self):
23887
- """Kafka导入配置ID
24565
+ """导入配置Id。
24566
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
24567
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
23888
24568
  :rtype: str
23889
24569
  """
23890
24570
  return self._Id
@@ -23895,7 +24575,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23895
24575
 
23896
24576
  @property
23897
24577
  def TopicId(self):
23898
- """导入CLS目标topic ID
24578
+ """导入CLS目标TopicId。
24579
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
24580
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。
23899
24581
  :rtype: str
23900
24582
  """
23901
24583
  return self._TopicId
@@ -23929,6 +24611,7 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23929
24611
  @property
23930
24612
  def KafkaInstance(self):
23931
24613
  """腾讯云CKafka实例ID,KafkaType为0时必填。
24614
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
23932
24615
  :rtype: str
23933
24616
  """
23934
24617
  return self._KafkaInstance
@@ -23972,7 +24655,9 @@ class ModifyKafkaRechargeRequest(AbstractModel):
23972
24655
 
23973
24656
  @property
23974
24657
  def UserKafkaTopics(self):
23975
- """用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
24658
+ """用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
24659
+
24660
+ - Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
23976
24661
  :rtype: str
23977
24662
  """
23978
24663
  return self._UserKafkaTopics
@@ -24005,7 +24690,7 @@ class ModifyKafkaRechargeRequest(AbstractModel):
24005
24690
 
24006
24691
  @property
24007
24692
  def StatusControl(self):
24008
- """导入控制,1:暂停;2:继续。
24693
+ """导入控制,1:暂停;2:启动。
24009
24694
  :rtype: int
24010
24695
  """
24011
24696
  return self._StatusControl
@@ -24176,9 +24861,13 @@ class ModifyMachineGroupRequest(AbstractModel):
24176
24861
 
24177
24862
  def __init__(self):
24178
24863
  r"""
24179
- :param _GroupId: 机器组ID
24864
+ :param _GroupId: 机器组Id
24865
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
24180
24866
  :type GroupId: str
24181
24867
  :param _GroupName: 机器组名称
24868
+ 输入限制:
24869
+ - 不能为空字符串
24870
+ - 不能包含字符'|'
24182
24871
  :type GroupName: str
24183
24872
  :param _MachineGroupType: 机器组类型。
24184
24873
  Type:ip,Values中为ip字符串列表机器组;
@@ -24189,8 +24878,10 @@ Type:label,Values中为标签字符串列表机器组。
24189
24878
  :param _AutoUpdate: 是否开启机器组自动更新
24190
24879
  :type AutoUpdate: bool
24191
24880
  :param _UpdateStartTime: 升级开始时间,建议业务低峰期升级LogListener
24881
+ 时间格式:HH:mm:ss
24192
24882
  :type UpdateStartTime: str
24193
24883
  :param _UpdateEndTime: 升级结束时间,建议业务低峰期升级LogListener
24884
+ 时间格式:HH:mm:ss
24194
24885
  :type UpdateEndTime: str
24195
24886
  :param _ServiceLogging: 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
24196
24887
  :type ServiceLogging: bool
@@ -24212,7 +24903,8 @@ Type:label,Values中为标签字符串列表机器组。
24212
24903
 
24213
24904
  @property
24214
24905
  def GroupId(self):
24215
- """机器组ID
24906
+ """机器组Id
24907
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
24216
24908
  :rtype: str
24217
24909
  """
24218
24910
  return self._GroupId
@@ -24224,6 +24916,9 @@ Type:label,Values中为标签字符串列表机器组。
24224
24916
  @property
24225
24917
  def GroupName(self):
24226
24918
  """机器组名称
24919
+ 输入限制:
24920
+ - 不能为空字符串
24921
+ - 不能包含字符'|'
24227
24922
  :rtype: str
24228
24923
  """
24229
24924
  return self._GroupName
@@ -24270,6 +24965,7 @@ Type:label,Values中为标签字符串列表机器组。
24270
24965
  @property
24271
24966
  def UpdateStartTime(self):
24272
24967
  """升级开始时间,建议业务低峰期升级LogListener
24968
+ 时间格式:HH:mm:ss
24273
24969
  :rtype: str
24274
24970
  """
24275
24971
  return self._UpdateStartTime
@@ -24281,6 +24977,7 @@ Type:label,Values中为标签字符串列表机器组。
24281
24977
  @property
24282
24978
  def UpdateEndTime(self):
24283
24979
  """升级结束时间,建议业务低峰期升级LogListener
24980
+ 时间格式:HH:mm:ss
24284
24981
  :rtype: str
24285
24982
  """
24286
24983
  return self._UpdateEndTime
@@ -24391,7 +25088,7 @@ class ModifyNoticeContentRequest(AbstractModel):
24391
25088
 
24392
25089
  def __init__(self):
24393
25090
  r"""
24394
- :param _NoticeContentId: 通知内容模板ID
25091
+ :param _NoticeContentId: 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
24395
25092
  :type NoticeContentId: str
24396
25093
  :param _Name: 通知内容模板名称。
24397
25094
  :type Name: str
@@ -24409,7 +25106,7 @@ class ModifyNoticeContentRequest(AbstractModel):
24409
25106
 
24410
25107
  @property
24411
25108
  def NoticeContentId(self):
24412
- """通知内容模板ID
25109
+ """通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
24413
25110
  :rtype: str
24414
25111
  """
24415
25112
  return self._NoticeContentId
@@ -24509,9 +25206,9 @@ class ModifyScheduledSqlRequest(AbstractModel):
24509
25206
 
24510
25207
  def __init__(self):
24511
25208
  r"""
24512
- :param _TaskId: 任务ID
25209
+ :param _TaskId: 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24513
25210
  :type TaskId: str
24514
- :param _SrcTopicId: 源日志主题
25211
+ :param _SrcTopicId: 源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24515
25212
  :type SrcTopicId: str
24516
25213
  :param _EnableFlag: 任务启动状态. 1开启, 2关闭
24517
25214
  :type EnableFlag: int
@@ -24519,15 +25216,15 @@ class ModifyScheduledSqlRequest(AbstractModel):
24519
25216
  :type DstResource: :class:`tencentcloud.cls.v20201016.models.ScheduledSqlResouceInfo`
24520
25217
  :param _ScheduledSqlContent: 查询语句
24521
25218
  :type ScheduledSqlContent: str
24522
- :param _ProcessPeriod: 调度周期(分钟)
25219
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
24523
25220
  :type ProcessPeriod: int
24524
25221
  :param _ProcessTimeWindow: 单次查询的时间窗口. 例子中为近15分钟
24525
25222
  :type ProcessTimeWindow: str
24526
- :param _ProcessDelay: 执行延迟(秒)
25223
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
24527
25224
  :type ProcessDelay: int
24528
- :param _SrcTopicRegion: 源topicId的地域信息
25225
+ :param _SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
24529
25226
  :type SrcTopicRegion: str
24530
- :param _Name: 任务名称
25227
+ :param _Name: 任务名称,0~255字符
24531
25228
  :type Name: str
24532
25229
  :param _SyntaxRule: 语法规则。 默认值为0。 0:Lucene语法,1:CQL语法
24533
25230
  :type SyntaxRule: int
@@ -24546,7 +25243,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24546
25243
 
24547
25244
  @property
24548
25245
  def TaskId(self):
24549
- """任务ID
25246
+ """任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24550
25247
  :rtype: str
24551
25248
  """
24552
25249
  return self._TaskId
@@ -24557,7 +25254,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24557
25254
 
24558
25255
  @property
24559
25256
  def SrcTopicId(self):
24560
- """源日志主题
25257
+ """源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
24561
25258
  :rtype: str
24562
25259
  """
24563
25260
  return self._SrcTopicId
@@ -24601,7 +25298,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24601
25298
 
24602
25299
  @property
24603
25300
  def ProcessPeriod(self):
24604
- """调度周期(分钟)
25301
+ """调度周期(分钟),1~1440分钟
24605
25302
  :rtype: int
24606
25303
  """
24607
25304
  return self._ProcessPeriod
@@ -24623,7 +25320,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24623
25320
 
24624
25321
  @property
24625
25322
  def ProcessDelay(self):
24626
- """执行延迟(秒)
25323
+ """执行延迟(秒),0~120秒,默认60秒
24627
25324
  :rtype: int
24628
25325
  """
24629
25326
  return self._ProcessDelay
@@ -24634,7 +25331,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24634
25331
 
24635
25332
  @property
24636
25333
  def SrcTopicRegion(self):
24637
- """源topicId的地域信息
25334
+ """源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
24638
25335
  :rtype: str
24639
25336
  """
24640
25337
  return self._SrcTopicRegion
@@ -24645,7 +25342,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
24645
25342
 
24646
25343
  @property
24647
25344
  def Name(self):
24648
- """任务名称
25345
+ """任务名称,0~255字符
24649
25346
  :rtype: str
24650
25347
  """
24651
25348
  return self._Name
@@ -25011,8 +25708,13 @@ class ModifyTopicRequest(AbstractModel):
25011
25708
  def __init__(self):
25012
25709
  r"""
25013
25710
  :param _TopicId: 日志主题ID
25711
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
25014
25712
  :type TopicId: str
25015
25713
  :param _TopicName: 日志主题名称
25714
+ 输入限制:
25715
+ - 不能为空字符串
25716
+ - 不能包含字符'|'
25717
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
25016
25718
  :type TopicName: str
25017
25719
  :param _Tags: 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,并且不能有重复的键值对。
25018
25720
  :type Tags: list of Tag
@@ -25021,7 +25723,8 @@ class ModifyTopicRequest(AbstractModel):
25021
25723
  :type Status: bool
25022
25724
  :param _AutoSplit: 是否开启自动分裂
25023
25725
  :type AutoSplit: bool
25024
- :param _MaxSplitPartitions: 若开启最大分裂,该主题能够能够允许的最大分区数
25726
+ :param _MaxSplitPartitions: 若开启最大分裂,该主题能够能够允许的最大分区数;
25727
+ 默认为50;必须为正数
25025
25728
  :type MaxSplitPartitions: int
25026
25729
  :param _Period: 生命周期,单位天,标准存储取值范围1\~3600,低频存储取值范围7\~3600。取值为3640时代表永久保存
25027
25730
  :type Period: int
@@ -25035,9 +25738,15 @@ class ModifyTopicRequest(AbstractModel):
25035
25738
  :type IsWebTracking: bool
25036
25739
  :param _Extends: 日志主题扩展信息
25037
25740
  :type Extends: :class:`tencentcloud.cls.v20201016.models.TopicExtendInfo`
25038
- :param _PartitionCount: 日志主题分区数量
25741
+ :param _PartitionCount: 日志主题分区数量。
25742
+ 默认为1;
25743
+ 取值范围及约束:
25744
+ - 当输入值<=0,系统自动调整为1。
25745
+ - 如果未传MaxSplitPartitions,需要PartitionCount<=50;
25746
+ - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
25039
25747
  :type PartitionCount: int
25040
25748
  :param _CancelTopicAsyncTaskID: 取消切换存储任务的id
25749
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
25041
25750
  :type CancelTopicAsyncTaskID: str
25042
25751
  """
25043
25752
  self._TopicId = None
@@ -25057,6 +25766,7 @@ class ModifyTopicRequest(AbstractModel):
25057
25766
  @property
25058
25767
  def TopicId(self):
25059
25768
  """日志主题ID
25769
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
25060
25770
  :rtype: str
25061
25771
  """
25062
25772
  return self._TopicId
@@ -25068,6 +25778,10 @@ class ModifyTopicRequest(AbstractModel):
25068
25778
  @property
25069
25779
  def TopicName(self):
25070
25780
  """日志主题名称
25781
+ 输入限制:
25782
+ - 不能为空字符串
25783
+ - 不能包含字符'|'
25784
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
25071
25785
  :rtype: str
25072
25786
  """
25073
25787
  return self._TopicName
@@ -25112,7 +25826,8 @@ class ModifyTopicRequest(AbstractModel):
25112
25826
 
25113
25827
  @property
25114
25828
  def MaxSplitPartitions(self):
25115
- """若开启最大分裂,该主题能够能够允许的最大分区数
25829
+ """若开启最大分裂,该主题能够能够允许的最大分区数;
25830
+ 默认为50;必须为正数
25116
25831
  :rtype: int
25117
25832
  """
25118
25833
  return self._MaxSplitPartitions
@@ -25180,7 +25895,12 @@ class ModifyTopicRequest(AbstractModel):
25180
25895
 
25181
25896
  @property
25182
25897
  def PartitionCount(self):
25183
- """日志主题分区数量
25898
+ """日志主题分区数量。
25899
+ 默认为1;
25900
+ 取值范围及约束:
25901
+ - 当输入值<=0,系统自动调整为1。
25902
+ - 如果未传MaxSplitPartitions,需要PartitionCount<=50;
25903
+ - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
25184
25904
  :rtype: int
25185
25905
  """
25186
25906
  return self._PartitionCount
@@ -25192,6 +25912,7 @@ class ModifyTopicRequest(AbstractModel):
25192
25912
  @property
25193
25913
  def CancelTopicAsyncTaskID(self):
25194
25914
  """取消切换存储任务的id
25915
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
25195
25916
  :rtype: str
25196
25917
  """
25197
25918
  return self._CancelTopicAsyncTaskID
@@ -25267,9 +25988,9 @@ class ModifyWebCallbackRequest(AbstractModel):
25267
25988
 
25268
25989
  def __init__(self):
25269
25990
  r"""
25270
- :param _WebCallbackId: 告警渠道回调配置ID
25991
+ :param _WebCallbackId: 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
25271
25992
  :type WebCallbackId: str
25272
- :param _Name: 告警渠道回调配置名称。
25993
+ :param _Name: 告警渠道回调配置名称。最大支持255个字节
25273
25994
  :type Name: str
25274
25995
  :param _Type: 渠道类型
25275
25996
 
@@ -25283,7 +26004,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
25283
26004
 
25284
26005
  注意:当Type为Http时,必填。
25285
26006
  :type Method: str
25286
- :param _Key: 秘钥信息。
26007
+ :param _Key: 秘钥信息。最大支持1024个字节
25287
26008
  :type Key: str
25288
26009
  """
25289
26010
  self._WebCallbackId = None
@@ -25295,7 +26016,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
25295
26016
 
25296
26017
  @property
25297
26018
  def WebCallbackId(self):
25298
- """告警渠道回调配置ID
26019
+ """告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
25299
26020
  :rtype: str
25300
26021
  """
25301
26022
  return self._WebCallbackId
@@ -25306,7 +26027,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
25306
26027
 
25307
26028
  @property
25308
26029
  def Name(self):
25309
- """告警渠道回调配置名称。
26030
+ """告警渠道回调配置名称。最大支持255个字节
25310
26031
  :rtype: str
25311
26032
  """
25312
26033
  return self._Name
@@ -25356,7 +26077,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
25356
26077
 
25357
26078
  @property
25358
26079
  def Key(self):
25359
- """秘钥信息。
26080
+ """秘钥信息。最大支持1024个字节
25360
26081
  :rtype: str
25361
26082
  """
25362
26083
  return self._Key
@@ -25427,7 +26148,7 @@ class MonitorTime(AbstractModel):
25427
26148
  :param _Time: 执行的周期,或者定制执行的时间节点。单位为分钟,取值范围为1~1440。
25428
26149
  当type为`Period`,`Fixed`时,time字段生效。
25429
26150
  :type Time: int
25430
- :param _CronExpression: 执行的周期cron表达式。示例:`"*/1 * * * *"` 从左到右每个field的含义 Minutes field, Hours field,Day of month field,Month field,Day of week field, 不支持秒级别。
26151
+ :param _CronExpression: 执行的周期cron表达式。示例:`"*/1 * * * *"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期), 不支持秒级别。
25431
26152
  当type为`Cron`时,CronExpression字段生效。
25432
26153
  :type CronExpression: str
25433
26154
  """
@@ -25464,7 +26185,7 @@ class MonitorTime(AbstractModel):
25464
26185
 
25465
26186
  @property
25466
26187
  def CronExpression(self):
25467
- """执行的周期cron表达式。示例:`"*/1 * * * *"` 从左到右每个field的含义 Minutes field, Hours field,Day of month field,Month field,Day of week field, 不支持秒级别。
26188
+ """执行的周期cron表达式。示例:`"*/1 * * * *"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期), 不支持秒级别。
25468
26189
  当type为`Cron`时,CronExpression字段生效。
25469
26190
  :rtype: str
25470
26191
  """
@@ -25677,7 +26398,7 @@ class NoticeContentInfo(AbstractModel):
25677
26398
  def __init__(self):
25678
26399
  r"""
25679
26400
  :param _Title: 通知内容模板标题信息。
25680
- 部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
26401
+ 部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
25681
26402
  :type Title: str
25682
26403
  :param _Content: 通知内容模板正文信息。
25683
26404
  :type Content: str
@@ -25692,7 +26413,7 @@ class NoticeContentInfo(AbstractModel):
25692
26413
  @property
25693
26414
  def Title(self):
25694
26415
  """通知内容模板标题信息。
25695
- 部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
26416
+ 部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
25696
26417
  :rtype: str
25697
26418
  """
25698
26419
  return self._Title
@@ -25766,9 +26487,9 @@ class NoticeContentTemplate(AbstractModel):
25766
26487
  :type Uin: int
25767
26488
  :param _SubUin: 创建/修改者子账号。
25768
26489
  :type SubUin: int
25769
- :param _CreateTime: 创建时间 秒级时间戳。
26490
+ :param _CreateTime: 创建时间 秒级(s)时间戳。
25770
26491
  :type CreateTime: int
25771
- :param _UpdateTime: 更新时间 秒级时间戳。
26492
+ :param _UpdateTime: 更新时间 秒级(s)时间戳。
25772
26493
  :type UpdateTime: int
25773
26494
  """
25774
26495
  self._NoticeContentId = None
@@ -25866,7 +26587,7 @@ class NoticeContentTemplate(AbstractModel):
25866
26587
 
25867
26588
  @property
25868
26589
  def CreateTime(self):
25869
- """创建时间 秒级时间戳。
26590
+ """创建时间 秒级(s)时间戳。
25870
26591
  :rtype: int
25871
26592
  """
25872
26593
  return self._CreateTime
@@ -25877,7 +26598,7 @@ class NoticeContentTemplate(AbstractModel):
25877
26598
 
25878
26599
  @property
25879
26600
  def UpdateTime(self):
25880
- """更新时间 秒级时间戳。
26601
+ """更新时间 秒级(s)时间戳。
25881
26602
  :rtype: int
25882
26603
  """
25883
26604
  return self._UpdateTime
@@ -25934,7 +26655,7 @@ class NoticeReceiver(AbstractModel):
25934
26655
  - WeChat - 微信
25935
26656
  - Phone - 电话
25936
26657
  :type ReceiverChannels: list of str
25937
- :param _NoticeContentId: 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)
26658
+ :param _NoticeContentId: 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID
25938
26659
  :type NoticeContentId: str
25939
26660
  :param _StartTime: 允许接收信息的开始时间。格式:`15:04:05`。必填
25940
26661
  :type StartTime: str
@@ -25998,7 +26719,7 @@ class NoticeReceiver(AbstractModel):
25998
26719
 
25999
26720
  @property
26000
26721
  def NoticeContentId(self):
26001
- """通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)
26722
+ """通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID
26002
26723
  :rtype: str
26003
26724
  """
26004
26725
  return self._NoticeContentId
@@ -26327,7 +27048,9 @@ class OpenKafkaConsumerRequest(AbstractModel):
26327
27048
 
26328
27049
  def __init__(self):
26329
27050
  r"""
26330
- :param _FromTopicId: 日志主题ID
27051
+ :param _FromTopicId: 日志主题Id。
27052
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27053
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
26331
27054
  :type FromTopicId: str
26332
27055
  :param _Compression: 压缩方式[0:NONE;2:SNAPPY;3:LZ4],默认:0
26333
27056
  :type Compression: int
@@ -26340,7 +27063,9 @@ class OpenKafkaConsumerRequest(AbstractModel):
26340
27063
 
26341
27064
  @property
26342
27065
  def FromTopicId(self):
26343
- """日志主题ID
27066
+ """日志主题Id。
27067
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27068
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
26344
27069
  :rtype: str
26345
27070
  """
26346
27071
  return self._FromTopicId
@@ -26554,8 +27279,10 @@ class PartitionInfo(AbstractModel):
26554
27279
  :param _ExclusiveEndKey: 分区哈希键结束key
26555
27280
  :type ExclusiveEndKey: str
26556
27281
  :param _CreateTime: 分区创建时间
27282
+ 时间格式:yyyy-MM-dd HH:mm:ss
26557
27283
  :type CreateTime: str
26558
27284
  :param _LastWriteTime: 只读分区数据停止写入时间
27285
+ 时间格式:yyyy-MM-dd HH:mm:ss
26559
27286
  注意:此字段可能返回 null,表示取不到有效值。
26560
27287
  :type LastWriteTime: str
26561
27288
  """
@@ -26613,6 +27340,7 @@ class PartitionInfo(AbstractModel):
26613
27340
  @property
26614
27341
  def CreateTime(self):
26615
27342
  """分区创建时间
27343
+ 时间格式:yyyy-MM-dd HH:mm:ss
26616
27344
  :rtype: str
26617
27345
  """
26618
27346
  return self._CreateTime
@@ -26624,6 +27352,7 @@ class PartitionInfo(AbstractModel):
26624
27352
  @property
26625
27353
  def LastWriteTime(self):
26626
27354
  """只读分区数据停止写入时间
27355
+ 时间格式:yyyy-MM-dd HH:mm:ss
26627
27356
  注意:此字段可能返回 null,表示取不到有效值。
26628
27357
  :rtype: str
26629
27358
  """
@@ -27029,8 +27758,10 @@ class QueryMetricRequest(AbstractModel):
27029
27758
  def __init__(self):
27030
27759
  r"""
27031
27760
  :param _Query: 查询语句,使用PromQL语法
27761
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27032
27762
  :type Query: str
27033
27763
  :param _TopicId: 指标主题ID
27764
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27034
27765
  :type TopicId: str
27035
27766
  :param _Time: 查询时间,秒级Unix时间戳。为空时代表当前时间戳。
27036
27767
 
@@ -27043,6 +27774,7 @@ class QueryMetricRequest(AbstractModel):
27043
27774
  @property
27044
27775
  def Query(self):
27045
27776
  """查询语句,使用PromQL语法
27777
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27046
27778
  :rtype: str
27047
27779
  """
27048
27780
  return self._Query
@@ -27054,6 +27786,7 @@ class QueryMetricRequest(AbstractModel):
27054
27786
  @property
27055
27787
  def TopicId(self):
27056
27788
  """指标主题ID
27789
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27057
27790
  :rtype: str
27058
27791
  """
27059
27792
  return self._TopicId
@@ -27096,7 +27829,11 @@ class QueryMetricResponse(AbstractModel):
27096
27829
 
27097
27830
  def __init__(self):
27098
27831
  r"""
27099
- :param _ResultType: 指标查询结果类型
27832
+ :param _ResultType: 指标查询结果类型,支持
27833
+ - scalar 标量值
27834
+ - string 字符串值
27835
+ - vector 瞬时向量
27836
+ - matrix 区间向量
27100
27837
  :type ResultType: str
27101
27838
  :param _Result: 指标查询结果
27102
27839
  :type Result: str
@@ -27109,7 +27846,11 @@ class QueryMetricResponse(AbstractModel):
27109
27846
 
27110
27847
  @property
27111
27848
  def ResultType(self):
27112
- """指标查询结果类型
27849
+ """指标查询结果类型,支持
27850
+ - scalar 标量值
27851
+ - string 字符串值
27852
+ - vector 瞬时向量
27853
+ - matrix 区间向量
27113
27854
  :rtype: str
27114
27855
  """
27115
27856
  return self._ResultType
@@ -27155,8 +27896,10 @@ class QueryRangeMetricRequest(AbstractModel):
27155
27896
  def __init__(self):
27156
27897
  r"""
27157
27898
  :param _TopicId: 指标主题ID
27899
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27158
27900
  :type TopicId: str
27159
27901
  :param _Query: 查询语句,使用PromQL语法
27902
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27160
27903
  :type Query: str
27161
27904
  :param _Start: 查询起始时间,秒级Unix时间戳
27162
27905
  :type Start: int
@@ -27174,6 +27917,7 @@ class QueryRangeMetricRequest(AbstractModel):
27174
27917
  @property
27175
27918
  def TopicId(self):
27176
27919
  """指标主题ID
27920
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
27177
27921
  :rtype: str
27178
27922
  """
27179
27923
  return self._TopicId
@@ -27185,6 +27929,7 @@ class QueryRangeMetricRequest(AbstractModel):
27185
27929
  @property
27186
27930
  def Query(self):
27187
27931
  """查询语句,使用PromQL语法
27932
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
27188
27933
  :rtype: str
27189
27934
  """
27190
27935
  return self._Query
@@ -27250,7 +27995,11 @@ class QueryRangeMetricResponse(AbstractModel):
27250
27995
 
27251
27996
  def __init__(self):
27252
27997
  r"""
27253
- :param _ResultType: 指标查询结果类型
27998
+ :param _ResultType: 指标查询结果类型,支持
27999
+ - scalar 标量值
28000
+ - string 字符串值
28001
+ - vector 瞬时向量
28002
+ - matrix 区间向量
27254
28003
  :type ResultType: str
27255
28004
  :param _Result: 指标查询结果
27256
28005
  :type Result: str
@@ -27263,7 +28012,11 @@ class QueryRangeMetricResponse(AbstractModel):
27263
28012
 
27264
28013
  @property
27265
28014
  def ResultType(self):
27266
- """指标查询结果类型
28015
+ """指标查询结果类型,支持
28016
+ - scalar 标量值
28017
+ - string 字符串值
28018
+ - vector 瞬时向量
28019
+ - matrix 区间向量
27267
28020
  :rtype: str
27268
28021
  """
27269
28022
  return self._ResultType
@@ -27606,9 +28359,9 @@ class ScheduledSqlResouceInfo(AbstractModel):
27606
28359
 
27607
28360
  def __init__(self):
27608
28361
  r"""
27609
- :param _TopicId: 目标主题id
28362
+ :param _TopicId: 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27610
28363
  :type TopicId: str
27611
- :param _Region: 主题的地域信息
28364
+ :param _Region: 主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
27612
28365
  :type Region: str
27613
28366
  :param _BizType: 主题类型:0为日志主题,1为指标主题
27614
28367
  :type BizType: int
@@ -27636,7 +28389,7 @@ BizType为1时,优先使用MetricNames字段多指标只能填充到MetricName
27636
28389
 
27637
28390
  @property
27638
28391
  def TopicId(self):
27639
- """目标主题id
28392
+ """通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
27640
28393
  :rtype: str
27641
28394
  """
27642
28395
  return self._TopicId
@@ -27647,7 +28400,7 @@ BizType为1时,优先使用MetricNames字段多指标只能填充到MetricName
27647
28400
 
27648
28401
  @property
27649
28402
  def Region(self):
27650
- """主题的地域信息
28403
+ """主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
27651
28404
  :rtype: str
27652
28405
  """
27653
28406
  return self._Region
@@ -27766,9 +28519,9 @@ class ScheduledSqlTaskInfo(AbstractModel):
27766
28519
  :type SrcTopicName: str
27767
28520
  :param _DstResource: 定时SQL分析目标主题
27768
28521
  :type DstResource: :class:`tencentcloud.cls.v20201016.models.ScheduledSqlResouceInfo`
27769
- :param _CreateTime: 任务创建时间
28522
+ :param _CreateTime: 任务创建时间。格式:yyyy-MM-dd HH:mm:ss
27770
28523
  :type CreateTime: str
27771
- :param _UpdateTime: 任务更新时间
28524
+ :param _UpdateTime: 任务更新时间,格式:yyyy-MM-dd HH:mm:ss
27772
28525
  :type UpdateTime: str
27773
28526
  :param _Status: 任务状态,1:运行 2:停止 3:异常-找不到源日志主题 4:异常-找不到目标主题
27774
28527
 
@@ -27778,19 +28531,19 @@ class ScheduledSqlTaskInfo(AbstractModel):
27778
28531
  :type EnableFlag: int
27779
28532
  :param _ScheduledSqlContent: 查询语句
27780
28533
  :type ScheduledSqlContent: str
27781
- :param _ProcessStartTime: 调度开始时间
28534
+ :param _ProcessStartTime: 调度开始时间,格式:yyyy-MM-dd HH:mm:ss
27782
28535
  :type ProcessStartTime: str
27783
28536
  :param _ProcessType: 调度类型,1:持续运行 2:指定时间范围
27784
28537
  :type ProcessType: int
27785
- :param _ProcessEndTime: 调度结束时间,当process_type=2时为必传字段
28538
+ :param _ProcessEndTime: 调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段
27786
28539
  :type ProcessEndTime: str
27787
- :param _ProcessPeriod: 调度周期(分钟)
28540
+ :param _ProcessPeriod: 调度周期(分钟),1~1440分钟
27788
28541
  :type ProcessPeriod: int
27789
28542
  :param _ProcessTimeWindow: 查询的时间窗口. @m-15m, @m,意为近15分钟
27790
28543
  :type ProcessTimeWindow: str
27791
- :param _ProcessDelay: 执行延迟(秒)
28544
+ :param _ProcessDelay: 执行延迟(秒),0~120秒,默认60秒
27792
28545
  :type ProcessDelay: int
27793
- :param _SrcTopicRegion: 源topicId的地域信息
28546
+ :param _SrcTopicRegion: 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
27794
28547
  :type SrcTopicRegion: str
27795
28548
  :param _SyntaxRule: 语法规则,0:Lucene语法,1:CQL语法
27796
28549
  :type SyntaxRule: int
@@ -27877,7 +28630,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27877
28630
 
27878
28631
  @property
27879
28632
  def CreateTime(self):
27880
- """任务创建时间
28633
+ """任务创建时间。格式:yyyy-MM-dd HH:mm:ss
27881
28634
  :rtype: str
27882
28635
  """
27883
28636
  return self._CreateTime
@@ -27888,7 +28641,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27888
28641
 
27889
28642
  @property
27890
28643
  def UpdateTime(self):
27891
- """任务更新时间
28644
+ """任务更新时间,格式:yyyy-MM-dd HH:mm:ss
27892
28645
  :rtype: str
27893
28646
  """
27894
28647
  return self._UpdateTime
@@ -27934,7 +28687,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27934
28687
 
27935
28688
  @property
27936
28689
  def ProcessStartTime(self):
27937
- """调度开始时间
28690
+ """调度开始时间,格式:yyyy-MM-dd HH:mm:ss
27938
28691
  :rtype: str
27939
28692
  """
27940
28693
  return self._ProcessStartTime
@@ -27956,7 +28709,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27956
28709
 
27957
28710
  @property
27958
28711
  def ProcessEndTime(self):
27959
- """调度结束时间,当process_type=2时为必传字段
28712
+ """调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段
27960
28713
  :rtype: str
27961
28714
  """
27962
28715
  return self._ProcessEndTime
@@ -27967,7 +28720,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27967
28720
 
27968
28721
  @property
27969
28722
  def ProcessPeriod(self):
27970
- """调度周期(分钟)
28723
+ """调度周期(分钟),1~1440分钟
27971
28724
  :rtype: int
27972
28725
  """
27973
28726
  return self._ProcessPeriod
@@ -27989,7 +28742,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
27989
28742
 
27990
28743
  @property
27991
28744
  def ProcessDelay(self):
27992
- """执行延迟(秒)
28745
+ """执行延迟(秒),0~120秒,默认60秒
27993
28746
  :rtype: int
27994
28747
  """
27995
28748
  return self._ProcessDelay
@@ -28000,7 +28753,7 @@ class ScheduledSqlTaskInfo(AbstractModel):
28000
28753
 
28001
28754
  @property
28002
28755
  def SrcTopicRegion(self):
28003
- """源topicId的地域信息
28756
+ """源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
28004
28757
  :rtype: str
28005
28758
  """
28006
28759
  return self._SrcTopicRegion
@@ -30006,6 +30759,7 @@ class TopicInfo(AbstractModel):
30006
30759
  :param _AssumerName: 云产品标识,主题由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
30007
30760
  :type AssumerName: str
30008
30761
  :param _CreateTime: 创建时间
30762
+ 时间格式:yyyy-MM-dd HH:mm:ss
30009
30763
  :type CreateTime: str
30010
30764
  :param _Status: 主题是否开启采集,true:开启采集;false:关闭采集。
30011
30765
  创建日志主题时默认开启,可通过SDK调用ModifyTopic修改此字段。
@@ -30044,8 +30798,13 @@ HotPeriod=0为没有开启日志沉降。
30044
30798
  :param _TopicAsyncTaskID: 异步迁移任务ID
30045
30799
  :type TopicAsyncTaskID: str
30046
30800
  :param _MigrationStatus: 异步迁移状态
30801
+ - 1:进行中
30802
+ - 2:已完成
30803
+ - 3:失败
30804
+ - 4:已取消
30047
30805
  :type MigrationStatus: int
30048
30806
  :param _EffectiveDate: 异步迁移完成后,预计生效日期
30807
+ 时间格式:yyyy-MM-dd HH:mm:ss
30049
30808
  :type EffectiveDate: str
30050
30809
  """
30051
30810
  self._LogsetId = None
@@ -30140,6 +30899,7 @@ HotPeriod=0为没有开启日志沉降。
30140
30899
  @property
30141
30900
  def CreateTime(self):
30142
30901
  """创建时间
30902
+ 时间格式:yyyy-MM-dd HH:mm:ss
30143
30903
  :rtype: str
30144
30904
  """
30145
30905
  return self._CreateTime
@@ -30304,6 +31064,10 @@ HotPeriod=0为没有开启日志沉降。
30304
31064
  @property
30305
31065
  def MigrationStatus(self):
30306
31066
  """异步迁移状态
31067
+ - 1:进行中
31068
+ - 2:已完成
31069
+ - 3:失败
31070
+ - 4:已取消
30307
31071
  :rtype: int
30308
31072
  """
30309
31073
  return self._MigrationStatus
@@ -30315,6 +31079,7 @@ HotPeriod=0为没有开启日志沉降。
30315
31079
  @property
30316
31080
  def EffectiveDate(self):
30317
31081
  """异步迁移完成后,预计生效日期
31082
+ 时间格式:yyyy-MM-dd HH:mm:ss
30318
31083
  :rtype: str
30319
31084
  """
30320
31085
  return self._EffectiveDate
@@ -30578,15 +31343,15 @@ class WebCallback(AbstractModel):
30578
31343
  def __init__(self):
30579
31344
  r"""
30580
31345
  :param _CallbackType: 回调的类型。可选值:
30581
- - Http
30582
- - WeCom
30583
- - DingTalk
30584
- - Lark
31346
+ - Http(自定义接口回调)
31347
+ - WeCom(企业微信)
31348
+ - DingTalk(钉钉)
31349
+ - Lark(飞书)
30585
31350
  :type CallbackType: str
30586
31351
  :param _Url: 回调地址,最大支持1024个字节。
30587
31352
  也可使用WebCallbackId引用集成配置中的URL,此时该字段请填写为空字符串。
30588
31353
  :type Url: str
30589
- :param _WebCallbackId: 集成配置ID
31354
+ :param _WebCallbackId: 集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID
30590
31355
  :type WebCallbackId: str
30591
31356
  :param _Method: 回调方法。可选值:
30592
31357
  - POST(默认值)
@@ -30630,10 +31395,10 @@ class WebCallback(AbstractModel):
30630
31395
  @property
30631
31396
  def CallbackType(self):
30632
31397
  """回调的类型。可选值:
30633
- - Http
30634
- - WeCom
30635
- - DingTalk
30636
- - Lark
31398
+ - Http(自定义接口回调)
31399
+ - WeCom(企业微信)
31400
+ - DingTalk(钉钉)
31401
+ - Lark(飞书)
30637
31402
  :rtype: str
30638
31403
  """
30639
31404
  return self._CallbackType
@@ -30656,7 +31421,7 @@ class WebCallback(AbstractModel):
30656
31421
 
30657
31422
  @property
30658
31423
  def WebCallbackId(self):
30659
- """集成配置ID
31424
+ """集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID
30660
31425
  :rtype: str
30661
31426
  """
30662
31427
  return self._WebCallbackId
@@ -30819,9 +31584,9 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
30819
31584
  :type Uin: int
30820
31585
  :param _SubUin: 子账号。
30821
31586
  :type SubUin: int
30822
- :param _CreateTime: 创建时间。秒级时间戳
31587
+ :param _CreateTime: 创建时间。秒(s)级时间戳
30823
31588
  :type CreateTime: int
30824
- :param _UpdateTime: 更新时间。秒级时间戳
31589
+ :param _UpdateTime: 更新时间。秒(s)级时间戳
30825
31590
  :type UpdateTime: int
30826
31591
  """
30827
31592
  self._WebCallbackId = None
@@ -30927,7 +31692,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
30927
31692
 
30928
31693
  @property
30929
31694
  def CreateTime(self):
30930
- """创建时间。秒级时间戳
31695
+ """创建时间。秒(s)级时间戳
30931
31696
  :rtype: int
30932
31697
  """
30933
31698
  return self._CreateTime
@@ -30938,7 +31703,7 @@ WeCom:企业微信;DingTalk:钉钉;Lark:飞书;Http:自定义回调;
30938
31703
 
30939
31704
  @property
30940
31705
  def UpdateTime(self):
30941
- """更新时间。秒级时间戳
31706
+ """更新时间。秒(s)级时间戳
30942
31707
  :rtype: int
30943
31708
  """
30944
31709
  return self._UpdateTime