tencentcloud-sdk-nodejs 4.1.97 → 4.1.99

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/lighthouse/v20200324/lighthouse_client.js +6 -0
  3. package/es/services/lke/v20231130/lke_client.js +0 -3
  4. package/es/services/postgres/v20170312/postgres_client.js +6 -15
  5. package/es/services/trocket/v20230308/trocket_client.js +7 -4
  6. package/es/services/trtc/v20190722/trtc_client.js +9 -0
  7. package/es/services/waf/v20180125/waf_client.js +28 -7
  8. package/package.json +1 -1
  9. package/tencentcloud/common/sdk_version.d.ts +1 -1
  10. package/tencentcloud/common/sdk_version.js +1 -1
  11. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +25 -35
  12. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +5 -5
  13. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +12 -12
  14. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +124 -15
  15. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +4 -4
  16. package/tencentcloud/services/cls/v20201016/cls_client.js +4 -4
  17. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +508 -166
  18. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +5 -1
  19. package/tencentcloud/services/es/v20180416/es_models.d.ts +8 -0
  20. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +3 -1
  21. package/tencentcloud/services/ess/v20201111/ess_client.js +3 -1
  22. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +1 -1
  23. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -1
  24. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -1
  25. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1 -1
  26. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +6 -0
  27. package/tencentcloud/services/keewidb/v20220308/keewidb_models.d.ts +23 -23
  28. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +23 -8
  29. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.d.ts +16 -1
  30. package/tencentcloud/services/lighthouse/v20200324/lighthouse_client.js +19 -0
  31. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +197 -42
  32. package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -5
  33. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +1 -5
  34. package/tencentcloud/services/lke/v20231130/lke_client.js +0 -6
  35. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +8 -38
  36. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +2 -2
  37. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +2 -2
  38. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +18 -0
  39. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +22 -8
  40. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +19 -20
  41. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +8 -26
  42. package/tencentcloud/services/postgres/v20170312/postgres_client.js +10 -34
  43. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +75 -424
  44. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +1 -1
  45. package/tencentcloud/services/sts/v20180813/sts_client.d.ts +21 -7
  46. package/tencentcloud/services/sts/v20180813/sts_client.js +21 -7
  47. package/tencentcloud/services/tcbr/v20220217/tcbr_models.d.ts +37 -0
  48. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +12 -0
  49. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +7 -7
  50. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +5 -1
  51. package/tencentcloud/services/trabbit/v20230418/trabbit_models.d.ts +16 -0
  52. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +11 -5
  53. package/tencentcloud/services/trocket/v20230308/trocket_client.js +14 -6
  54. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +93 -0
  55. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +13 -1
  56. package/tencentcloud/services/trtc/v20190722/trtc_client.js +18 -0
  57. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +130 -1
  58. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +8 -0
  59. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +18 -18
  60. package/tencentcloud/services/tsf/v20180326/tsf_client.js +18 -18
  61. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +815 -632
  62. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -0
  63. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -0
  64. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +24 -5
  65. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +2 -2
  66. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  67. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +6 -1
  68. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +37 -9
  69. package/tencentcloud/services/waf/v20180125/waf_client.js +54 -12
  70. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +349 -31
  71. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +60 -0
  72. package/tencentcloud/services/wsa/v20250508/wsa_models.d.ts +14 -3
@@ -6,18 +6,22 @@ export interface DescribeAlarmNoticesRequest {
6
6
  * <li> name
7
7
  按照【通知渠道组名称】进行过滤。
8
8
  类型:String
9
+ 示例:"Filters":[{"Key":"name","Values":["test-notice"]}]
9
10
  必选:否</li>
10
11
  <li> alarmNoticeId
11
12
  按照【通知渠道组ID】进行过滤。
12
13
  类型:String
14
+ 示例:"Filters": [{Key: "alarmNoticeId", Values: ["notice-5281f1d2-6275-4e56-9ec3-a1eb19d8bc2f"]}]
13
15
  必选:否</li>
14
16
  <li> uid
15
17
  按照【接收用户ID】进行过滤。
16
18
  类型:String
19
+ 示例:"Filters": [{Key: "uid", Values: ["1137546"]}]
17
20
  必选:否</li>
18
21
  <li> groupId
19
22
  按照【接收用户组ID】进行过滤。
20
23
  类型:String
24
+ 示例:"Filters": [{Key: "groupId", Values: ["344098"]}]
21
25
  必选:否</li>
22
26
 
23
27
  <li> deliverFlag
@@ -25,7 +29,7 @@ export interface DescribeAlarmNoticesRequest {
25
29
  类型:String
26
30
  必选:否
27
31
  可选值: "1":未启用, "2": 已启用, "3":投递异常</li>
28
-
32
+ 示例:"Filters":[{"Key":"deliverFlag","Values":["2"]}]
29
33
  每次请求的Filters的上限为10,Filter.Values的上限为5。
30
34
  */
31
35
  Filters?: Array<Filter>;
@@ -68,7 +72,7 @@ export interface AlarmInfo {
68
72
  */
69
73
  MonitorTime?: MonitorTime;
70
74
  /**
71
- * 单触发条件。与MultiConditions参数互斥。
75
+ * 是否触发告警的单触发条件。与MultiConditions参数互斥。
72
76
  */
73
77
  Condition?: string;
74
78
  /**
@@ -92,11 +96,11 @@ export interface AlarmInfo {
92
96
  */
93
97
  AlarmId?: string;
94
98
  /**
95
- * 创建时间。
99
+ * 创建时间。格式: YYYY-MM-DD HH:MM:SS
96
100
  */
97
101
  CreateTime?: string;
98
102
  /**
99
- * 最近更新时间。
103
+ * 最近更新时间。格式: YYYY-MM-DD HH:MM:SS
100
104
  */
101
105
  UpdateTime?: string;
102
106
  /**
@@ -217,11 +221,14 @@ export interface DescribeLogHistogramRequest {
217
221
  */
218
222
  To: number;
219
223
  /**
220
- * 查询语句
224
+ * 检索分析语句。
225
+ 语句由 [检索条件] | [SQL语句]构成,无需对日志进行统计分析时,可省略其中的管道符 | 及SQL语句。
226
+ 使用*或空字符串可查询所有日志。
221
227
  */
222
228
  Query: string;
223
229
  /**
224
230
  * 要查询的日志主题ID
231
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
225
232
  */
226
233
  TopicId?: string;
227
234
  /**
@@ -240,11 +247,11 @@ export interface DescribeLogHistogramRequest {
240
247
  */
241
248
  export interface DeleteAlarmShieldRequest {
242
249
  /**
243
- * 屏蔽规则id
250
+ * 屏蔽规则id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
244
251
  */
245
252
  TaskId: string;
246
253
  /**
247
- * 通知渠道组id
254
+ * 通知渠道组id。通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
248
255
  */
249
256
  AlarmNoticeId: string;
250
257
  }
@@ -313,11 +320,11 @@ export interface DeleteShipperRequest {
313
320
  */
314
321
  export interface DeleteScheduledSqlRequest {
315
322
  /**
316
- * 任务ID
323
+ * 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
317
324
  */
318
325
  TaskId: string;
319
326
  /**
320
- * 源日志主题ID
327
+ * 源日志主题ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
321
328
  */
322
329
  SrcTopicId: string;
323
330
  }
@@ -397,11 +404,17 @@ export interface DescribeShipperTasksResponse {
397
404
  */
398
405
  export interface CheckFunctionRequest {
399
406
  /**
400
- * 用户输入的加工语句
407
+ * 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
408
+
409
+ 其他参考文档:
410
+
411
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
412
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
401
413
  */
402
414
  EtlContent: string;
403
415
  /**
404
- * 加工任务目的topic_id以及别名
416
+ * 加工任务目标topic_id以及别名,当 FuncType 为 1 时,必填。
417
+ 目标日志主题ID通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
405
418
  */
406
419
  DstResources?: Array<DataTransformResouceInfo>;
407
420
  /**
@@ -591,7 +604,9 @@ export interface ConsoleSharingConfig {
591
604
  */
592
605
  export interface DeleteConsoleSharingRequest {
593
606
  /**
594
- * 免密分享Id
607
+ * 免密分享Id
608
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
609
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
595
610
  */
596
611
  SharingId: string;
597
612
  }
@@ -790,6 +805,7 @@ export interface DeleteNoticeContentResponse {
790
805
  export interface DeleteTopicRequest {
791
806
  /**
792
807
  * 日志主题ID
808
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
793
809
  */
794
810
  TopicId: string;
795
811
  }
@@ -798,7 +814,8 @@ export interface DeleteTopicRequest {
798
814
  */
799
815
  export interface DescribePartitionsRequest {
800
816
  /**
801
- * 日志主题ID
817
+ * 日志主题Id
818
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
802
819
  */
803
820
  TopicId: string;
804
821
  }
@@ -891,10 +908,12 @@ export interface ConfigInfo {
891
908
  Output?: string;
892
909
  /**
893
910
  * 更新时间
911
+ - 时间格式:yyyy-MM-dd HH:mm:ss
894
912
  */
895
913
  UpdateTime?: string;
896
914
  /**
897
915
  * 创建时间
916
+ - 时间格式:yyyy-MM-dd HH:mm:ss
898
917
  */
899
918
  CreateTime?: string;
900
919
  /**
@@ -919,10 +938,12 @@ export interface ConfigInfo {
919
938
  export interface QueryRangeMetricRequest {
920
939
  /**
921
940
  * 指标主题ID
941
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
922
942
  */
923
943
  TopicId: string;
924
944
  /**
925
945
  * 查询语句,使用PromQL语法
946
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
926
947
  */
927
948
  Query: string;
928
949
  /**
@@ -1002,7 +1023,7 @@ export interface DeleteCloudProductLogCollectionRequest {
1002
1023
  */
1003
1024
  LogType: string;
1004
1025
  /**
1005
- * 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
1026
+ * 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
1006
1027
  - CDS所有日志类型:ap-guangzhou
1007
1028
  - CDB-AUDIT: gz
1008
1029
  - TDSQL-C-AUDIT: gz
@@ -1024,6 +1045,7 @@ export interface DeleteCloudProductLogCollectionRequest {
1024
1045
  export interface CreateCloudProductLogCollectionRequest {
1025
1046
  /**
1026
1047
  * 实例ID
1048
+ - 通过各个接入云产品官方文档获取
1027
1049
  */
1028
1050
  InstanceId: string;
1029
1051
  /**
@@ -1035,7 +1057,7 @@ export interface CreateCloudProductLogCollectionRequest {
1035
1057
  */
1036
1058
  LogType: string;
1037
1059
  /**
1038
- * 云产品地域。 不同日志类型(LogType)地域入參格式存在差异, 请参考如下示例:
1060
+ * 云产品地域。 不同日志类型(LogType)地域入参格式存在差异, 请参考如下示例:
1039
1061
  - CDS所有日志类型:ap-guangzhou
1040
1062
  - CDB-AUDIT: gz
1041
1063
  - TDSQL-C-AUDIT: gz
@@ -1052,6 +1074,7 @@ export interface CreateCloudProductLogCollectionRequest {
1052
1074
  CloudProductRegion: string;
1053
1075
  /**
1054
1076
  * CLS目标地域
1077
+ - 支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
1055
1078
  */
1056
1079
  ClsRegion: string;
1057
1080
  /**
@@ -1063,15 +1086,17 @@ export interface CreateCloudProductLogCollectionRequest {
1063
1086
  */
1064
1087
  TopicName?: string;
1065
1088
  /**
1066
- * 日志配置拓展信息, 一般用于存储额外的日志投递配置
1089
+ * 日志配置扩展信息, 一般用于存储额外的日志投递配置
1067
1090
  */
1068
1091
  Extend?: string;
1069
1092
  /**
1070
1093
  * 日志集id
1094
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
1071
1095
  */
1072
1096
  LogsetId?: string;
1073
1097
  /**
1074
1098
  * 日志主题id
1099
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
1075
1100
  */
1076
1101
  TopicId?: string;
1077
1102
  }
@@ -1469,11 +1494,11 @@ export interface AlarmClassification {
1469
1494
  */
1470
1495
  export interface ScheduledSqlResouceInfo {
1471
1496
  /**
1472
- * 目标主题id
1497
+ * 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
1473
1498
  */
1474
1499
  TopicId: string;
1475
1500
  /**
1476
- * 主题的地域信息
1501
+ * 主题的地域信息,当前不支持跨地域,支持地域参考 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
1477
1502
  */
1478
1503
  Region?: string;
1479
1504
  /**
@@ -1587,6 +1612,7 @@ export interface MachineGroupInfo {
1587
1612
  MachineGroupType?: MachineGroupTypeInfo;
1588
1613
  /**
1589
1614
  * 创建时间
1615
+ 时间格式:yyyy-MM-dd HH:mm:ss
1590
1616
  */
1591
1617
  CreateTime?: string;
1592
1618
  /**
@@ -1599,10 +1625,12 @@ export interface MachineGroupInfo {
1599
1625
  AutoUpdate?: string;
1600
1626
  /**
1601
1627
  * 升级开始时间,建议业务低峰期升级LogListener
1628
+ 时间格式:HH:mm:ss
1602
1629
  */
1603
1630
  UpdateStartTime?: string;
1604
1631
  /**
1605
1632
  * 升级结束时间,建议业务低峰期升级LogListener
1633
+ 时间格式:HH:mm:ss
1606
1634
  */
1607
1635
  UpdateEndTime?: string;
1608
1636
  /**
@@ -1610,7 +1638,7 @@ export interface MachineGroupInfo {
1610
1638
  */
1611
1639
  ServiceLogging?: boolean;
1612
1640
  /**
1613
- * 机器组中机器离线定期清理时间
1641
+ * 机器组中机器离线定期清理时间,单位天,默认设置30天。
1614
1642
  */
1615
1643
  DelayCleanupTime?: number;
1616
1644
  /**
@@ -1627,7 +1655,8 @@ export interface MachineGroupInfo {
1627
1655
  */
1628
1656
  export interface DeleteMachineGroupInfoRequest {
1629
1657
  /**
1630
- * 机器组ID
1658
+ * 机器组Id
1659
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
1631
1660
  */
1632
1661
  GroupId: string;
1633
1662
  /**
@@ -1751,7 +1780,9 @@ export interface DashboardNoticeMode {
1751
1780
  <li/>Uin:腾讯云用户<br>
1752
1781
  <li/>Group:腾讯云用户组<br>
1753
1782
  <li/>Email:自定义Email<br>
1754
- <li/>WeCom: 企业微信回调
1783
+ <li/>WeCom: 企业微信回调<br>
1784
+ <li/>DingTalk:钉钉<br>
1785
+ <li/>Lark:飞书
1755
1786
  */
1756
1787
  ReceiverType: string;
1757
1788
  /**
@@ -1779,12 +1810,24 @@ export interface DashboardNoticeMode {
1779
1810
  export interface KafkaProtocolInfo {
1780
1811
  /**
1781
1812
  * 协议类型,支持的协议类型包括 plaintext、sasl_plaintext 或 sasl_ssl。建议使用 sasl_ssl,此协议会进行连接加密同时需要用户认证。
1782
- 入参必填
1813
+
1814
+ - 当IsEncryptionAddr为true时,Protocol必填。
1815
+ - 支持的协议类型如下:
1816
+ - plaintext:纯文本无加密协议
1817
+ - sasl_ssl:SASL 认证 + SSL 加密
1818
+ - ssl:纯 SSL/TLS 加密协议
1819
+ - sasl_plaintext:SASL 认证 + 非加密通道
1820
+
1783
1821
  */
1784
1822
  Protocol?: string;
1785
1823
  /**
1786
1824
  * 加密类型,支持 PLAIN、SCRAM-SHA-256 或 SCRAM-SHA-512。
1787
- 当Protocol为sasl_plaintext或sasl_ssl时必填
1825
+
1826
+ - 当Protocol为 `sasl_plaintext` 或 `sasl_ssl` 时 Mechanism 必填。
1827
+ - 支持加密类型如下
1828
+ - PLAIN:明文认证
1829
+ - SCRAM-SHA-256:基于挑战-响应机制,使用PBKDF2-HMAC-SHA256算法
1830
+ - SCRAM-SHA-512:增强版SCRAM,使用PBKDF2-HMAC-SHA512算法
1788
1831
  */
1789
1832
  Mechanism?: string;
1790
1833
  /**
@@ -1823,11 +1866,11 @@ export interface ScheduledSqlTaskInfo {
1823
1866
  */
1824
1867
  DstResource?: ScheduledSqlResouceInfo;
1825
1868
  /**
1826
- * 任务创建时间
1869
+ * 任务创建时间。格式:yyyy-MM-dd HH:mm:ss
1827
1870
  */
1828
1871
  CreateTime?: string;
1829
1872
  /**
1830
- * 任务更新时间
1873
+ * 任务更新时间,格式:yyyy-MM-dd HH:mm:ss
1831
1874
  */
1832
1875
  UpdateTime?: string;
1833
1876
  /**
@@ -1845,7 +1888,7 @@ export interface ScheduledSqlTaskInfo {
1845
1888
  */
1846
1889
  ScheduledSqlContent?: string;
1847
1890
  /**
1848
- * 调度开始时间
1891
+ * 调度开始时间,格式:yyyy-MM-dd HH:mm:ss
1849
1892
  */
1850
1893
  ProcessStartTime?: string;
1851
1894
  /**
@@ -1853,11 +1896,11 @@ export interface ScheduledSqlTaskInfo {
1853
1896
  */
1854
1897
  ProcessType?: number;
1855
1898
  /**
1856
- * 调度结束时间,当process_type=2时为必传字段
1899
+ * 调度结束时间,格式:yyyy-MM-dd HH:mm:ss,当process_type=2时为必传字段
1857
1900
  */
1858
1901
  ProcessEndTime?: string;
1859
1902
  /**
1860
- * 调度周期(分钟)
1903
+ * 调度周期(分钟),1~1440分钟
1861
1904
  */
1862
1905
  ProcessPeriod?: number;
1863
1906
  /**
@@ -1865,11 +1908,11 @@ export interface ScheduledSqlTaskInfo {
1865
1908
  */
1866
1909
  ProcessTimeWindow?: string;
1867
1910
  /**
1868
- * 执行延迟(秒)
1911
+ * 执行延迟(秒),0~120秒,默认60秒
1869
1912
  */
1870
1913
  ProcessDelay?: number;
1871
1914
  /**
1872
- * 源topicId的地域信息
1915
+ * 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档。
1873
1916
  */
1874
1917
  SrcTopicRegion?: string;
1875
1918
  /**
@@ -1891,6 +1934,7 @@ export interface ScheduledSqlTaskInfo {
1891
1934
  export interface DescribeConfigMachineGroupsRequest {
1892
1935
  /**
1893
1936
  * 采集配置ID
1937
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
1894
1938
  */
1895
1939
  ConfigId: string;
1896
1940
  }
@@ -1913,10 +1957,15 @@ export interface MetaTagInfo {
1913
1957
  export interface ModifyTopicRequest {
1914
1958
  /**
1915
1959
  * 日志主题ID
1960
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
1916
1961
  */
1917
1962
  TopicId: string;
1918
1963
  /**
1919
1964
  * 日志主题名称
1965
+ 输入限制:
1966
+ - 不能为空字符串
1967
+ - 不能包含字符'|'
1968
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
1920
1969
  */
1921
1970
  TopicName?: string;
1922
1971
  /**
@@ -1933,7 +1982,8 @@ export interface ModifyTopicRequest {
1933
1982
  */
1934
1983
  AutoSplit?: boolean;
1935
1984
  /**
1936
- * 若开启最大分裂,该主题能够能够允许的最大分区数
1985
+ * 若开启最大分裂,该主题能够能够允许的最大分区数;
1986
+ 默认为50;必须为正数
1937
1987
  */
1938
1988
  MaxSplitPartitions?: number;
1939
1989
  /**
@@ -1959,11 +2009,17 @@ export interface ModifyTopicRequest {
1959
2009
  */
1960
2010
  Extends?: TopicExtendInfo;
1961
2011
  /**
1962
- * 日志主题分区数量
2012
+ * 日志主题分区数量。
2013
+ 默认为1;
2014
+ 取值范围及约束:
2015
+ - 当输入值<=0,系统自动调整为1。
2016
+ - 如果未传MaxSplitPartitions,需要PartitionCount<=50;
2017
+ - 如果传递了MaxSplitPartitions,需要PartitionCount<=MaxSplitPartitions;
1963
2018
  */
1964
2019
  PartitionCount?: number;
1965
2020
  /**
1966
2021
  * 取消切换存储任务的id
2022
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取取消切换存储任务的id。
1967
2023
  */
1968
2024
  CancelTopicAsyncTaskID?: string;
1969
2025
  }
@@ -2094,7 +2150,9 @@ export interface DeleteConfigExtraResponse {
2094
2150
  */
2095
2151
  export interface ModifyConsumerRequest {
2096
2152
  /**
2097
- * 投递任务绑定的日志主题 ID
2153
+ * 投递任务绑定的日志主题Id。
2154
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
2155
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
2098
2156
  */
2099
2157
  TopicId: string;
2100
2158
  /**
@@ -2189,6 +2247,10 @@ export interface DescribeConsoleSharingListResponse {
2189
2247
  * 分页的总数目
2190
2248
  */
2191
2249
  TotalCount?: number;
2250
+ /**
2251
+ * 控制台免密分享列表
2252
+ */
2253
+ ConsoleSharingInfos?: Array<ConsoleSharingInfo>;
2192
2254
  /**
2193
2255
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2194
2256
  */
@@ -2231,14 +2293,25 @@ export interface DataTransformResouceInfo {
2231
2293
  export interface CreateDashboardSubscribeRequest {
2232
2294
  /**
2233
2295
  * 仪表盘订阅名称。
2296
+ 输入限制:
2297
+ - 不能为空
2298
+ - 长度不能超过128字节
2299
+ - 不能包含字符'|'
2234
2300
  */
2235
2301
  Name: string;
2236
2302
  /**
2237
- * 仪表盘id
2303
+ * 仪表盘Id
2304
+ - 通过[获取仪表盘](https://cloud.tencent.com/document/product/614/95636)获取仪表盘Id。
2238
2305
  */
2239
2306
  DashboardId: string;
2240
2307
  /**
2241
- * 订阅时间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星期六】
2308
+ * 订阅时间cron表达式,格式为:{秒数} {分钟} {小时} {日期} {月份} {星期};(有效数据为:{分钟} {小时} {日期} {月份} {星期})。
2309
+ - {秒数} 取值范围: 0 ~ 59
2310
+ - {分钟} 取值范围: 0 ~ 59
2311
+ - {小时} 取值范围: 0 ~ 23
2312
+ - {日期} 取值范围: 1 ~ 31 AND (dayOfMonth最后一天: L)
2313
+ - {月份} 取值范围: 1 ~ 12
2314
+ - {星期} 取值范围: 0 ~ 6 【0:星期日, 6星期六】
2242
2315
  */
2243
2316
  Cron: string;
2244
2317
  /**
@@ -2251,7 +2324,8 @@ export interface CreateDashboardSubscribeRequest {
2251
2324
  */
2252
2325
  export interface DeleteMachineGroupRequest {
2253
2326
  /**
2254
- * 机器组ID
2327
+ * 机器组Id
2328
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
2255
2329
  */
2256
2330
  GroupId: string;
2257
2331
  }
@@ -2279,7 +2353,11 @@ export interface FullTextInfo {
2279
2353
  */
2280
2354
  export interface QueryMetricResponse {
2281
2355
  /**
2282
- * 指标查询结果类型
2356
+ * 指标查询结果类型,支持
2357
+ - scalar 标量值
2358
+ - string 字符串值
2359
+ - vector 瞬时向量
2360
+ - matrix 区间向量
2283
2361
  */
2284
2362
  ResultType?: string;
2285
2363
  /**
@@ -2370,11 +2448,11 @@ export interface WebCallbackInfo {
2370
2448
  */
2371
2449
  SubUin?: number;
2372
2450
  /**
2373
- * 创建时间。秒级时间戳
2451
+ * 创建时间。秒(s)级时间戳
2374
2452
  */
2375
2453
  CreateTime?: number;
2376
2454
  /**
2377
- * 更新时间。秒级时间戳
2455
+ * 更新时间。秒(s)级时间戳
2378
2456
  */
2379
2457
  UpdateTime?: number;
2380
2458
  }
@@ -2440,11 +2518,11 @@ export interface DescribeConfigMachineGroupsResponse {
2440
2518
  */
2441
2519
  export interface ModifyAlarmRequest {
2442
2520
  /**
2443
- * 告警策略ID
2521
+ * 告警策略ID。-通过[获取告警策略列表](https://cloud.tencent.com/document/product/614/56461)获取告警策略ID
2444
2522
  */
2445
2523
  AlarmId: string;
2446
2524
  /**
2447
- * 告警策略名称
2525
+ * 告警策略名称。最大支持255个字节,不支持 '|'。
2448
2526
  */
2449
2527
  Name?: string;
2450
2528
  /**
@@ -2452,7 +2530,7 @@ export interface ModifyAlarmRequest {
2452
2530
  */
2453
2531
  MonitorTime?: MonitorTime;
2454
2532
  /**
2455
- * 触发条件。
2533
+ * 告警信息发送的触发条件。
2456
2534
 
2457
2535
  注意:
2458
2536
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
@@ -2483,7 +2561,7 @@ export interface ModifyAlarmRequest {
2483
2561
  */
2484
2562
  AlarmPeriod?: number;
2485
2563
  /**
2486
- * 关联的告警通知模板列表。
2564
+ * 关联的告警通知渠道列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取告警通知渠道列表
2487
2565
  */
2488
2566
  AlarmNoticeIds?: Array<string>;
2489
2567
  /**
@@ -2568,7 +2646,7 @@ export interface LogItems {
2568
2646
  */
2569
2647
  export interface ModifyAlarmNoticeRequest {
2570
2648
  /**
2571
- * 通知渠道组ID
2649
+ * 通知渠道组ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知渠道组ID
2572
2650
  */
2573
2651
  AlarmNoticeId: string;
2574
2652
  /**
@@ -2655,11 +2733,14 @@ export interface EventLog {
2655
2733
  */
2656
2734
  EventChannel: string;
2657
2735
  /**
2658
- * 时间类型,1:用户自定义,2:当前时间
2736
+ * 时间字段(Timestamp)支持的类型
2737
+ - 1(用户自定义时间)
2738
+ - 2(当前时间)
2659
2739
  */
2660
2740
  TimeType: number;
2661
2741
  /**
2662
2742
  * 时间,用户选择自定义时间类型时,需要指定时间,单位秒
2743
+ 格式:时间戳,1754897446
2663
2744
  */
2664
2745
  Timestamp?: number;
2665
2746
  /**
@@ -2676,7 +2757,7 @@ export interface EventLog {
2676
2757
  */
2677
2758
  export interface CreateAlarmRequest {
2678
2759
  /**
2679
- * 告警策略名称
2760
+ * 告警策略名称。最大支持255个字节。 不支持 '|'。
2680
2761
  */
2681
2762
  Name: string;
2682
2763
  /**
@@ -2696,11 +2777,11 @@ export interface CreateAlarmRequest {
2696
2777
  */
2697
2778
  AlarmPeriod: number;
2698
2779
  /**
2699
- * 关联的告警通知模板列表。
2780
+ * 关联的告警通知渠道组列表。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取关联的告警通知渠道组列表
2700
2781
  */
2701
2782
  AlarmNoticeIds: Array<string>;
2702
2783
  /**
2703
- * 触发条件
2784
+ * 告警发送通知的触发条件
2704
2785
  注意:
2705
2786
  - Condition和AlarmLevel是一组配置,MultiConditions是另一组配置,2组配置互斥。
2706
2787
 
@@ -2780,7 +2861,7 @@ export interface CreateAlarmRequest {
2780
2861
  */
2781
2862
  export interface DeleteDataTransformRequest {
2782
2863
  /**
2783
- * 数据加工任务id
2864
+ * 数据加工任务ID- 通过[获取数据加工任务列表基本信息](https://cloud.tencent.com/document/product/614/72182)获取数据加工任务Id。
2784
2865
  */
2785
2866
  TaskId: string;
2786
2867
  }
@@ -2862,10 +2943,12 @@ export interface PartitionInfo {
2862
2943
  ExclusiveEndKey?: string;
2863
2944
  /**
2864
2945
  * 分区创建时间
2946
+ 时间格式:yyyy-MM-dd HH:mm:ss
2865
2947
  */
2866
2948
  CreateTime?: string;
2867
2949
  /**
2868
2950
  * 只读分区数据停止写入时间
2951
+ 时间格式:yyyy-MM-dd HH:mm:ss
2869
2952
  注意:此字段可能返回 null,表示取不到有效值。
2870
2953
  */
2871
2954
  LastWriteTime?: string;
@@ -2909,11 +2992,11 @@ export interface NoticeContentTemplate {
2909
2992
  */
2910
2993
  SubUin?: number;
2911
2994
  /**
2912
- * 创建时间 秒级时间戳。
2995
+ * 创建时间 秒级(s)时间戳。
2913
2996
  */
2914
2997
  CreateTime?: number;
2915
2998
  /**
2916
- * 更新时间 秒级时间戳。
2999
+ * 更新时间 秒级(s)时间戳。
2917
3000
  */
2918
3001
  UpdateTime?: number;
2919
3002
  }
@@ -3109,7 +3192,10 @@ export interface ConfigExtraInfo {
3109
3192
  */
3110
3193
  TopicId?: string;
3111
3194
  /**
3112
- * 类型:container_stdout、container_file、host_file
3195
+ * 自建k8s集群日志采集类型,支持
3196
+ - container_stdout 标准输出
3197
+ - container_file 标准文件
3198
+ - host_file 节点文件
3113
3199
  */
3114
3200
  Type?: string;
3115
3201
  /**
@@ -3143,10 +3229,12 @@ export interface ConfigExtraInfo {
3143
3229
  ExcludePaths?: Array<ExcludePathInfo>;
3144
3230
  /**
3145
3231
  * 更新时间
3232
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3146
3233
  */
3147
3234
  UpdateTime?: string;
3148
3235
  /**
3149
3236
  * 创建时间
3237
+ - 时间格式:yyyy-MM-dd HH:mm:ss
3150
3238
  */
3151
3239
  CreateTime?: string;
3152
3240
  /**
@@ -3155,6 +3243,7 @@ export interface ConfigExtraInfo {
3155
3243
  UserDefineRule?: string;
3156
3244
  /**
3157
3245
  * 机器组ID
3246
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
3158
3247
  */
3159
3248
  GroupId?: string;
3160
3249
  /**
@@ -3163,6 +3252,7 @@ export interface ConfigExtraInfo {
3163
3252
  ConfigFlag?: string;
3164
3253
  /**
3165
3254
  * 日志集ID
3255
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/api/614/58624)获取日志集Id。
3166
3256
  */
3167
3257
  LogsetId?: string;
3168
3258
  /**
@@ -3272,15 +3362,15 @@ export interface CheckRechargeKafkaServerRequest {
3272
3362
  */
3273
3363
  export interface CreateAlarmShieldRequest {
3274
3364
  /**
3275
- * 通知渠道组id
3365
+ * 通知渠道组id。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/product/614/56462)获取通知渠道组id
3276
3366
  */
3277
3367
  AlarmNoticeId: string;
3278
3368
  /**
3279
- * 屏蔽开始时间(秒级时间戳)。
3369
+ * 屏蔽规则开始时间,秒级(s)时间戳。
3280
3370
  */
3281
3371
  StartTime: number;
3282
3372
  /**
3283
- * 屏蔽结束时间(秒级时间戳)。
3373
+ * 屏蔽规则结束时间,秒级(s)时间戳。结束时间需要大于当前时间
3284
3374
  */
3285
3375
  EndTime: number;
3286
3376
  /**
@@ -3349,7 +3439,9 @@ export interface DeleteAlarmShieldResponse {
3349
3439
  */
3350
3440
  export interface DescribeConsumerRequest {
3351
3441
  /**
3352
- * 投递任务绑定的日志主题 ID
3442
+ * 投递任务绑定的日志主题Id。
3443
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
3444
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
3353
3445
  */
3354
3446
  TopicId: string;
3355
3447
  }
@@ -3407,10 +3499,16 @@ export interface DescribeLogsetsResponse {
3407
3499
  export interface CreateTopicRequest {
3408
3500
  /**
3409
3501
  * 日志集ID
3502
+ - 通过[获取日志集列表](https://cloud.tencent.com/document/product/614/58624)获取日志集Id。
3410
3503
  */
3411
3504
  LogsetId: string;
3412
3505
  /**
3413
3506
  * 日志主题名称
3507
+ 名称限制
3508
+ - 不能为空字符串
3509
+ - 不能包含字符'|'
3510
+ - 不能使用以下名称["cls_service_log","loglistener_status","loglistener_alarm","loglistener_business","cls_service_metric"]
3511
+
3414
3512
  */
3415
3513
  TopicName: string;
3416
3514
  /**
@@ -3473,7 +3571,7 @@ export interface DescribeTopicsRequest {
3473
3571
  * <ul><li>topicName 按照【日志主题名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
3474
3572
  <li>logsetName 按照【日志集名称】进行过滤,默认为模糊匹配,可使用 PreciseSearch 参数设置为精确匹配。类型:String。必选:否</li>
3475
3573
  <li>topicId 按照【日志主题ID】进行过滤。类型:String。必选:否</li>
3476
- <li>logsetId 按照【日志集ID】进行过滤,可通过调用 DescribeLogsets 查询已创建的日志集列表或登录控制台进行查看;也可以调用 CreateLogset 创建新的日志集。类型:String。必选:否</li>
3574
+ <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>
3477
3575
  <li>tagKey 按照【标签键】进行过滤。类型:String。必选:否</li>
3478
3576
  <li>tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否</li>
3479
3577
  <li>storageType 按照【日志主题的存储类型】进行过滤。可选值 hot(标准存储),cold(低频存储)类型:String。必选:否</li></ul>
@@ -3589,7 +3687,8 @@ export interface CreateDashboardSubscribeResponse {
3589
3687
  */
3590
3688
  export interface DescribeExportsRequest {
3591
3689
  /**
3592
- * 日志主题ID
3690
+ * 日志主题Id
3691
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
3593
3692
  */
3594
3693
  TopicId: string;
3595
3694
  /**
@@ -3637,7 +3736,7 @@ export interface DescribeCosRechargesRequest {
3637
3736
  */
3638
3737
  export interface AlarmTarget {
3639
3738
  /**
3640
- * 日志主题ID
3739
+ * 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
3641
3740
  */
3642
3741
  TopicId: string;
3643
3742
  /**
@@ -3657,7 +3756,7 @@ export interface AlarmTarget {
3657
3756
  */
3658
3757
  EndTimeOffset: number;
3659
3758
  /**
3660
- * 日志集ID
3759
+ * 日志集ID。通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志集ID
3661
3760
  */
3662
3761
  LogsetId: string;
3663
3762
  /**
@@ -3694,11 +3793,11 @@ export interface CreateKafkaRechargeResponse {
3694
3793
  */
3695
3794
  export interface ModifyScheduledSqlRequest {
3696
3795
  /**
3697
- * 任务ID
3796
+ * 任务ID,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
3698
3797
  */
3699
3798
  TaskId: string;
3700
3799
  /**
3701
- * 源日志主题
3800
+ * 源日志主题,通过[获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519)获取
3702
3801
  */
3703
3802
  SrcTopicId?: string;
3704
3803
  /**
@@ -3714,7 +3813,7 @@ export interface ModifyScheduledSqlRequest {
3714
3813
  */
3715
3814
  ScheduledSqlContent?: string;
3716
3815
  /**
3717
- * 调度周期(分钟)
3816
+ * 调度周期(分钟),1~1440分钟
3718
3817
  */
3719
3818
  ProcessPeriod?: number;
3720
3819
  /**
@@ -3722,15 +3821,15 @@ export interface ModifyScheduledSqlRequest {
3722
3821
  */
3723
3822
  ProcessTimeWindow?: string;
3724
3823
  /**
3725
- * 执行延迟(秒)
3824
+ * 执行延迟(秒),0~120秒,默认60秒
3726
3825
  */
3727
3826
  ProcessDelay?: number;
3728
3827
  /**
3729
- * 源topicId的地域信息
3828
+ * 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
3730
3829
  */
3731
3830
  SrcTopicRegion?: string;
3732
3831
  /**
3733
- * 任务名称
3832
+ * 任务名称,0~255字符
3734
3833
  */
3735
3834
  Name?: string;
3736
3835
  /**
@@ -3787,27 +3886,32 @@ export interface ModifyAlarmShieldResponse {
3787
3886
  */
3788
3887
  export interface CreateDeliverCloudFunctionRequest {
3789
3888
  /**
3790
- * 投递规则属于的 topic id
3889
+ * 投递规则属于的TopicId。
3890
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
3891
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
3791
3892
  */
3792
3893
  TopicId: string;
3793
3894
  /**
3794
3895
  * 投递的云函数名字。仅支持[事件函数](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))
3896
+ 通过 [获取函数列表](https://cloud.tencent.com/document/product/583/18582) 获取函数信息。
3795
3897
  */
3796
3898
  FunctionName: string;
3797
3899
  /**
3798
- * 命名空间
3900
+ * 命名空间。参考 [命名空间管理](https://cloud.tencent.com/document/product/583/35913)
3901
+ - 通过 [列出命名空间列表](https://cloud.tencent.com/document/product/583/37158) 获取Name。
3799
3902
  */
3800
3903
  Namespace: string;
3801
3904
  /**
3802
- * 函数版本
3905
+ * 函数版本。
3906
+ - 通过 [查询函数版本 ](https://cloud.tencent.com/document/product/583/37162) 获取函数版本。
3803
3907
  */
3804
3908
  Qualifier: string;
3805
3909
  /**
3806
- * 投递最长等待时间,单位:秒
3910
+ * 投递最长等待时间,单位:秒。 默认:60
3807
3911
  */
3808
3912
  Timeout?: number;
3809
3913
  /**
3810
- * 投递最大消息数
3914
+ * 投递最大消息数。默认为100。支持范围[1,10000]
3811
3915
  */
3812
3916
  MaxMsgNum?: number;
3813
3917
  }
@@ -3825,7 +3929,9 @@ export interface ModifyCloudProductLogCollectionResponse {
3825
3929
  */
3826
3930
  export interface DeleteConsumerRequest {
3827
3931
  /**
3828
- * 投递任务绑定的日志主题 ID
3932
+ * 投递任务绑定的日志主题Id。
3933
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
3934
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
3829
3935
  */
3830
3936
  TopicId: string;
3831
3937
  }
@@ -3835,7 +3941,7 @@ export interface DeleteConsumerRequest {
3835
3941
  export interface NoticeContentInfo {
3836
3942
  /**
3837
3943
  * 通知内容模板标题信息。
3838
- 部分通知渠道类型不支持“标题”,请参照腾讯云控制台页面。
3944
+ 部分通知渠道类型不支持“标题”,请参照[腾讯云控制台页面](https://console.cloud.tencent.com/cls/alarm/notice-template)。
3839
3945
  */
3840
3946
  Title?: string;
3841
3947
  /**
@@ -3853,7 +3959,7 @@ export interface NoticeContentInfo {
3853
3959
  */
3854
3960
  export interface CreateWebCallbackRequest {
3855
3961
  /**
3856
- * 通知内容名称。
3962
+ * 通知内容名称。最大支持255个字节
3857
3963
  */
3858
3964
  Name: string;
3859
3965
  /**
@@ -3873,7 +3979,7 @@ export interface CreateWebCallbackRequest {
3873
3979
  */
3874
3980
  Method?: string;
3875
3981
  /**
3876
- * 秘钥。
3982
+ * 秘钥。最大支持1024个字节
3877
3983
  */
3878
3984
  Key?: string;
3879
3985
  }
@@ -3882,7 +3988,8 @@ export interface CreateWebCallbackRequest {
3882
3988
  */
3883
3989
  export interface DescribeMachineGroupsRequest {
3884
3990
  /**
3885
- * machineGroupName
3991
+ * 过滤条件
3992
+ machineGroupName
3886
3993
  - 按照【机器组名称】进行过滤。
3887
3994
  - 类型:String
3888
3995
  - 必选:否
@@ -3893,7 +4000,7 @@ export interface DescribeMachineGroupsRequest {
3893
4000
  - 必选:否
3894
4001
 
3895
4002
  osType
3896
- - 按照【操作系统类型】进行过滤。
4003
+ - 按照【操作系统类型】进行过滤。0: Linux;1: Windows
3897
4004
  - 类型:Int
3898
4005
  - 必选:否
3899
4006
 
@@ -3947,11 +4054,12 @@ export interface AnonymousInfo {
3947
4054
  */
3948
4055
  export interface ExtractRuleInfo {
3949
4056
  /**
3950
- * 时间字段的key名字,TikeKey和TimeFormat必须成对出现
4057
+ * 时间字段的key名字,TimeKey和TimeFormat必须成对出现
3951
4058
  */
3952
4059
  TimeKey?: string;
3953
4060
  /**
3954
4061
  * 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
4062
+ - 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
3955
4063
  */
3956
4064
  TimeFormat?: string;
3957
4065
  /**
@@ -4084,11 +4192,11 @@ export interface ModifyConsumerResponse {
4084
4192
  */
4085
4193
  export interface DescribeAlertRecordHistoryRequest {
4086
4194
  /**
4087
- * 查询时间范围启始时间,毫秒级unix时间戳
4195
+ * 查询时间范围启始时间,毫秒级unix时间戳(ms)
4088
4196
  */
4089
4197
  From: number;
4090
4198
  /**
4091
- * 查询时间范围结束时间,毫秒级unix时间戳
4199
+ * 查询时间范围结束时间,毫秒级unix时间戳(ms)
4092
4200
  */
4093
4201
  To: number;
4094
4202
  /**
@@ -4118,16 +4226,20 @@ export interface DescribeConfigsRequest {
4118
4226
  - 按照【采集配置名称】进行模糊匹配过滤。
4119
4227
  - 类型:String
4120
4228
  - 必选:否
4229
+ - 示例:test-config
4121
4230
 
4122
4231
  configId
4123
4232
  - 按照【采集配置ID】进行过滤。
4124
4233
  - 类型:String
4125
4234
  - 必选:否
4235
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
4126
4236
 
4127
4237
  topicId
4128
4238
  - 按照【日志主题】进行过滤。
4129
4239
  - 类型:String
4130
4240
  - 必选:否
4241
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
4242
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
4131
4243
 
4132
4244
  每次请求的Filters的上限为10,Filter.Values的上限为5。
4133
4245
  */
@@ -4261,7 +4373,8 @@ export interface DashboardTopicInfo {
4261
4373
  */
4262
4374
  export interface DeleteConfigRequest {
4263
4375
  /**
4264
- * 采集规则配置ID
4376
+ * 采集配置ID
4377
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
4265
4378
  */
4266
4379
  ConfigId: string;
4267
4380
  }
@@ -4274,7 +4387,8 @@ export interface AnalysisDimensional {
4274
4387
  */
4275
4388
  Name: string;
4276
4389
  /**
4277
- * 分析类型:query,field ,original
4390
+ * 分析类型:query(自定义检索分析),field(字段TOP5及占比统计) ,original(相关原始日志)
4391
+
4278
4392
  */
4279
4393
  Type: string;
4280
4394
  /**
@@ -4331,7 +4445,7 @@ export interface AnalysisDimensional {
4331
4445
  */
4332
4446
  export interface DeleteWebCallbackRequest {
4333
4447
  /**
4334
- * 告警渠道回调配置ID
4448
+ * 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
4335
4449
  */
4336
4450
  WebCallbackId: string;
4337
4451
  }
@@ -4348,7 +4462,7 @@ export interface LogRechargeRuleInfo {
4348
4462
  */
4349
4463
  EncodingFormat: number;
4350
4464
  /**
4351
- * 使用默认时间,true:开启(默认值), flase:关闭
4465
+ * 使用默认时间状态。true:开启后将使用系统当前时间或 Kafka 消息时间戳作为日志时间戳;false:关闭将使用日志中的时间字段作为日志时间戳。 默认:true
4352
4466
  */
4353
4467
  DefaultTimeSwitch: boolean;
4354
4468
  /**
@@ -4372,19 +4486,107 @@ export interface LogRechargeRuleInfo {
4372
4486
  */
4373
4487
  DefaultTimeSrc?: number;
4374
4488
  /**
4375
- * 时间字段
4489
+ * 时间字段,日志中代表时间的字段名。
4490
+
4491
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `json_log` JSON-文件日志 或 `fullregex_log` 单行完全正则-文件日志时, TimeKey不能为空。
4376
4492
  */
4377
4493
  TimeKey?: string;
4378
4494
  /**
4379
- * 时间提取正则表达式
4495
+ * 时间提取正则表达式。
4496
+ - 当DefaultTimeSwitch为false,且RechargeType数据提取模式为 `minimalist_log` 单行全文-文件日志时, TimeRegex不能为空。
4497
+ - 仅需输入日志中代表时间的字段的正则表达式即可;若匹配到多个字段,将使用第一个。
4498
+ 例:日志原文为:message with time 2022-08-08 14:20:20,则您可以设置提取时间正则为\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d
4499
+
4380
4500
  */
4381
4501
  TimeRegex?: string;
4382
4502
  /**
4383
- * 时间字段格式
4503
+ * 时间字段格式。
4504
+ - 当DefaultTimeSwitch为false时, TimeFormat不能为空。
4384
4505
  */
4385
4506
  TimeFormat?: string;
4386
4507
  /**
4387
- * 时间字段时区
4508
+ * 时间字段时区。
4509
+ - 当DefaultTimeSwitch为false时, TimeZone不能为空。
4510
+ - 时区格式规则
4511
+ ​前缀​:使用 GMT 或 UTC 作为时区基准
4512
+ ​偏移量​:
4513
+ - `-` 表示西时区(比基准时间晚)
4514
+ - `+` 表示东时区(比基准时间早)
4515
+ - 格式为 ±HH:MM(小时:分钟)
4516
+
4517
+ - 当前支持:
4518
+ ```
4519
+ "GMT-12:00"
4520
+ "GMT-11:00"
4521
+ "GMT-10:00"
4522
+ "GMT-09:30"
4523
+ "GMT-09:00"
4524
+ "GMT-08:00"
4525
+ "GMT-07:00"
4526
+ "GMT-06:00"
4527
+ "GMT-05:00"
4528
+ "GMT-04:00"
4529
+ "GMT-03:30"
4530
+ "GMT-03:00"
4531
+ "GMT-02:00"
4532
+ "GMT-01:00"
4533
+ "GMT+00:00"
4534
+ "GMT+01:00"
4535
+ "GMT+02:00"
4536
+ "GMT+03:30"
4537
+ "GMT+04:00"
4538
+ "GMT+04:30"
4539
+ "GMT+05:00"
4540
+ "GMT+05:30"
4541
+ "GMT+05:45"
4542
+ "GMT+06:00"
4543
+ "GMT+06:30"
4544
+ "GMT+07:00"
4545
+ "GMT+08:00"
4546
+ "GMT+09:00"
4547
+ "GMT+09:30"
4548
+ "GMT+10:00"
4549
+ "GMT+10:30"
4550
+ "GMT+11:00"
4551
+ "GMT+11:30"
4552
+ "GMT+12:00"
4553
+ "GMT+12:45"
4554
+ "GMT+13:00"
4555
+ "GMT+14:00"
4556
+ "UTC-11:00"
4557
+ "UTC-10:00"
4558
+ "UTC-09:00"
4559
+ "UTC-08:00"
4560
+ "UTC-12:00"
4561
+ "UTC-07:00"
4562
+ "UTC-06:00"
4563
+ "UTC-05:00"
4564
+ "UTC-04:30"
4565
+ "UTC-04:00"
4566
+ "UTC-03:30"
4567
+ "UTC-03:00"
4568
+ "UTC-02:00"
4569
+ "UTC-01:00"
4570
+ "UTC+00:00"
4571
+ "UTC+01:00"
4572
+ "UTC+02:00"
4573
+ "UTC+03:00"
4574
+ "UTC+03:30"
4575
+ "UTC+04:00"
4576
+ "UTC+04:30"
4577
+ "UTC+05:00"
4578
+ "UTC+05:45"
4579
+ "UTC+06:00"
4580
+ "UTC+06:30"
4581
+ "UTC+07:00"
4582
+ "UTC+08:00"
4583
+ "UTC+09:00"
4584
+ "UTC+09:30"
4585
+ "UTC+10:00"
4586
+ "UTC+11:00"
4587
+ "UTC+12:00"
4588
+ "UTC+13:00"
4589
+ ```
4388
4590
  */
4389
4591
  TimeZone?: string;
4390
4592
  /**
@@ -4465,7 +4667,9 @@ export interface ShipperTaskInfo {
4465
4667
  */
4466
4668
  export interface CloseKafkaConsumerRequest {
4467
4669
  /**
4468
- * 日志主题ID
4670
+ * 日志主题Id。
4671
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
4672
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
4469
4673
  */
4470
4674
  FromTopicId: string;
4471
4675
  }
@@ -4487,7 +4691,8 @@ export interface RuleTagInfo {
4487
4691
  */
4488
4692
  export interface CreateExportRequest {
4489
4693
  /**
4490
- * 日志主题ID
4694
+ * 日志主题Id
4695
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
4491
4696
  */
4492
4697
  TopicId: string;
4493
4698
  /**
@@ -4559,19 +4764,19 @@ export interface DescribeAlarmNoticesResponse {
4559
4764
  */
4560
4765
  export interface ModifyAlarmShieldRequest {
4561
4766
  /**
4562
- * 屏蔽规则ID
4767
+ * 屏蔽规则ID。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取屏蔽规则ID
4563
4768
  */
4564
4769
  TaskId: string;
4565
4770
  /**
4566
- * 通知渠道组id
4771
+ * 通知渠道组id。-通过[获取告警屏蔽配置规则](https://cloud.tencent.com/document/api/614/103650)获取通知渠道组id
4567
4772
  */
4568
4773
  AlarmNoticeId: string;
4569
4774
  /**
4570
- * 屏蔽开始时间(秒级时间戳)。
4775
+ * 屏蔽开始时间,秒级(s)时间戳。
4571
4776
  */
4572
4777
  StartTime?: number;
4573
4778
  /**
4574
- * 屏蔽结束时间(秒级时间戳)。
4779
+ * 屏蔽结束时间,秒级(s)时间戳。
4575
4780
  */
4576
4781
  EndTime?: number;
4577
4782
  /**
@@ -4588,6 +4793,7 @@ export interface ModifyAlarmShieldRequest {
4588
4793
  Reason?: string;
4589
4794
  /**
4590
4795
  * 规则状态。只有规则状态为生效中(status:1)时,才能将其修改为已失效(status:2)。
4796
+ 枚举:0(未生效),1(生效中),2(已失效)
4591
4797
  */
4592
4798
  Status?: number;
4593
4799
  }
@@ -4627,6 +4833,7 @@ export interface DescribeMachineGroupsResponse {
4627
4833
  export interface DeleteConfigExtraRequest {
4628
4834
  /**
4629
4835
  * 特殊采集规则扩展配置ID
4836
+ - 通过[获取特殊采集配置](https://cloud.tencent.com/document/api/614/71164)特殊采集规则扩展配置ID。
4630
4837
  */
4631
4838
  ConfigExtraId: string;
4632
4839
  }
@@ -4689,6 +4896,8 @@ export interface ModifyConfigRequest {
4689
4896
  ConfigId: string;
4690
4897
  /**
4691
4898
  * 采集规则配置名称
4899
+ - 不能包含特殊字符|
4900
+ - 长度不能超过255字符,超过会被截断
4692
4901
  */
4693
4902
  Name?: string;
4694
4903
  /**
@@ -4720,6 +4929,7 @@ export interface ModifyConfigRequest {
4720
4929
  ExcludePaths?: Array<ExcludePathInfo>;
4721
4930
  /**
4722
4931
  * 采集配置关联的日志主题(TopicId)
4932
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
4723
4933
  */
4724
4934
  Output?: string;
4725
4935
  /**
@@ -4741,7 +4951,8 @@ export interface ModifyConfigRequest {
4741
4951
  */
4742
4952
  export interface AddMachineGroupInfoRequest {
4743
4953
  /**
4744
- * 机器组ID
4954
+ * 机器组Id
4955
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
4745
4956
  */
4746
4957
  GroupId: string;
4747
4958
  /**
@@ -4755,15 +4966,18 @@ export interface AddMachineGroupInfoRequest {
4755
4966
  */
4756
4967
  export interface DescribeKafkaRechargesRequest {
4757
4968
  /**
4758
- * 日志主题 ID
4969
+ * 日志主题Id。
4970
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
4759
4971
  */
4760
4972
  TopicId: string;
4761
4973
  /**
4762
- * 导入配置ID
4974
+ * 导入配置Id。
4975
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
4976
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
4763
4977
  */
4764
4978
  Id?: string;
4765
4979
  /**
4766
- * 状态 status 1: 运行中, 2: 暂停...
4980
+ * 状态。1: 运行中,2: 暂停,3:错误
4767
4981
  */
4768
4982
  Status?: number;
4769
4983
  }
@@ -4795,7 +5009,9 @@ export interface JsonInfo {
4795
5009
  */
4796
5010
  export interface ModifyConsoleSharingRequest {
4797
5011
  /**
4798
- * 免密分享链接Id
5012
+ * 免密分享Id
5013
+ - 通过 [获取免密分享列表](https://cloud.tencent.com/document/product/614/109798) 获取免密分享Id。
5014
+ - 通过 [创建免密分享](https://cloud.tencent.com/document/product/614/109800) 获取免密分享Id。
4799
5015
  */
4800
5016
  SharingId: string;
4801
5017
  /**
@@ -4825,11 +5041,11 @@ export interface PreviewKafkaRechargeResponse {
4825
5041
  */
4826
5042
  export interface ModifyWebCallbackRequest {
4827
5043
  /**
4828
- * 告警渠道回调配置ID
5044
+ * 告警渠道回调配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/api/614/115229)获取告警渠道回调配置ID
4829
5045
  */
4830
5046
  WebCallbackId: string;
4831
5047
  /**
4832
- * 告警渠道回调配置名称。
5048
+ * 告警渠道回调配置名称。最大支持255个字节
4833
5049
  */
4834
5050
  Name?: string;
4835
5051
  /**
@@ -4851,7 +5067,7 @@ export interface ModifyWebCallbackRequest {
4851
5067
  */
4852
5068
  Method?: string;
4853
5069
  /**
4854
- * 秘钥信息。
5070
+ * 秘钥信息。最大支持1024个字节
4855
5071
  */
4856
5072
  Key?: string;
4857
5073
  }
@@ -4961,10 +5177,10 @@ export interface DeleteAlarmResponse {
4961
5177
  export interface WebCallback {
4962
5178
  /**
4963
5179
  * 回调的类型。可选值:
4964
- - Http
4965
- - WeCom
4966
- - DingTalk
4967
- - Lark
5180
+ - Http(自定义接口回调)
5181
+ - WeCom(企业微信)
5182
+ - DingTalk(钉钉)
5183
+ - Lark(飞书)
4968
5184
  */
4969
5185
  CallbackType: string;
4970
5186
  /**
@@ -4973,7 +5189,7 @@ export interface WebCallback {
4973
5189
  */
4974
5190
  Url: string;
4975
5191
  /**
4976
- * 集成配置ID
5192
+ * 集成配置ID。-通过[获取告警渠道回调配置列表](https://cloud.tencent.com/document/product/614/115229)获取集成配置ID
4977
5193
  */
4978
5194
  WebCallbackId?: string;
4979
5195
  /**
@@ -5066,10 +5282,13 @@ export interface DeleteConsoleSharingResponse {
5066
5282
  export interface CreateConfigRequest {
5067
5283
  /**
5068
5284
  * 采集配置名称
5285
+ - 名称种不得包含特殊字符|
5286
+ - 名称最长255字符,超过截断
5069
5287
  */
5070
5288
  Name: string;
5071
5289
  /**
5072
5290
  * 采集配置所属日志主题ID即TopicId
5291
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
5073
5292
  */
5074
5293
  Output: string;
5075
5294
  /**
@@ -5200,7 +5419,7 @@ export interface AlertHistoryRecord {
5200
5419
  */
5201
5420
  TriggerCount: number;
5202
5421
  /**
5203
- * 告警通知发送频率,单位为分钟
5422
+ * 告警通知发送频率,单位为分钟(min)
5204
5423
  */
5205
5424
  AlarmPeriod: number;
5206
5425
  /**
@@ -5208,7 +5427,7 @@ export interface AlertHistoryRecord {
5208
5427
  */
5209
5428
  Notices: Array<AlertHistoryNotice>;
5210
5429
  /**
5211
- * 告警持续时间,单位为分钟
5430
+ * 告警持续时间,单位为分钟(min)
5212
5431
  */
5213
5432
  Duration: number;
5214
5433
  /**
@@ -5216,7 +5435,7 @@ export interface AlertHistoryRecord {
5216
5435
  */
5217
5436
  Status: number;
5218
5437
  /**
5219
- * 告警发生时间,毫秒级Unix时间戳
5438
+ * 告警发生时间,毫秒级Unix时间戳(ms)
5220
5439
  */
5221
5440
  CreateTime: number;
5222
5441
  /**
@@ -5440,6 +5659,53 @@ export interface ValueInfo {
5440
5659
  */
5441
5660
  Alias?: string;
5442
5661
  }
5662
+ /**
5663
+ * 控制台分享信息
5664
+ */
5665
+ export interface ConsoleSharingInfo {
5666
+ /**
5667
+ * 分享ID
5668
+ */
5669
+ SharingId: string;
5670
+ /**
5671
+ * 分享链接
5672
+ 注意:此字段可能返回 null,表示取不到有效值。
5673
+ */
5674
+ SharingUrl?: string;
5675
+ /**
5676
+ * 匿名分享配置信息
5677
+ 注意:此字段可能返回 null,表示取不到有效值。
5678
+ */
5679
+ SharingConfig?: ConsoleSharingConfig;
5680
+ /**
5681
+ * 过期时间
5682
+ 注意:此字段可能返回 null,表示取不到有效值。
5683
+ */
5684
+ ExpiredTime?: number;
5685
+ /**
5686
+ * 创建时间
5687
+ 注意:此字段可能返回 null,表示取不到有效值。
5688
+ */
5689
+ CreateTime?: number;
5690
+ /**
5691
+ * 修改时间
5692
+ 注意:此字段可能返回 null,表示取不到有效值。
5693
+ */
5694
+ UpdateTime?: number;
5695
+ /**
5696
+ * 分享链接状态
5697
+ 1: 正常
5698
+ -1: 因内容安全审查异常导致被封禁(存在于使用公网域名分享时)
5699
+ 注意:此字段可能返回 null,表示取不到有效值。
5700
+ */
5701
+ Status?: number;
5702
+ /**
5703
+ * 10001-广告 20001-政治 20002-色情 20004-社会事件 20011-暴力 20012-低俗 20006-违法犯罪 20007-谩骂 20008-欺诈 20013-版权 20104-谣言 21000-其他, 10086-聚合, 24001-暴恐(天御独有恶意类型),20472-违法,
5704
+ 24005-社会
5705
+ 注意:此字段可能返回 null,表示取不到有效值。
5706
+ */
5707
+ ContentSafetyCode?: number;
5708
+ }
5443
5709
  /**
5444
5710
  * DescribeDataTransformInfo请求参数结构体
5445
5711
  */
@@ -5515,11 +5781,13 @@ export interface DeleteShipperResponse {
5515
5781
  */
5516
5782
  export interface ModifyKafkaConsumerRequest {
5517
5783
  /**
5518
- * 日志主题ID
5784
+ * 日志主题Id。
5785
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
5786
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
5519
5787
  */
5520
5788
  FromTopicId: string;
5521
5789
  /**
5522
- * 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
5790
+ * 压缩方式。0:不压缩;2:使用Snappy压缩;3:使用LZ4压缩
5523
5791
  */
5524
5792
  Compression?: number;
5525
5793
  /**
@@ -5581,11 +5849,11 @@ export interface ExportInfo {
5581
5849
  */
5582
5850
  Status?: string;
5583
5851
  /**
5584
- * 日志导出起始时间
5852
+ * 日志导出起始时间,毫秒时间戳
5585
5853
  */
5586
5854
  From?: number;
5587
5855
  /**
5588
- * 日志导出结束时间
5856
+ * 日志导出结束时间,毫秒时间戳
5589
5857
  */
5590
5858
  To?: number;
5591
5859
  /**
@@ -5594,6 +5862,7 @@ export interface ExportInfo {
5594
5862
  CosPath?: string;
5595
5863
  /**
5596
5864
  * 日志导出创建时间
5865
+ 时间格式:yyyy-MM-dd HH:mm:ss
5597
5866
  */
5598
5867
  CreateTime?: string;
5599
5868
  /**
@@ -5645,6 +5914,7 @@ export interface TopicInfo {
5645
5914
  AssumerName?: string;
5646
5915
  /**
5647
5916
  * 创建时间
5917
+ 时间格式:yyyy-MM-dd HH:mm:ss
5648
5918
  */
5649
5919
  CreateTime?: string;
5650
5920
  /**
@@ -5711,10 +5981,15 @@ export interface TopicInfo {
5711
5981
  TopicAsyncTaskID?: string;
5712
5982
  /**
5713
5983
  * 异步迁移状态
5984
+ - 1:进行中
5985
+ - 2:已完成
5986
+ - 3:失败
5987
+ - 4:已取消
5714
5988
  */
5715
5989
  MigrationStatus?: number;
5716
5990
  /**
5717
5991
  * 异步迁移完成后,预计生效日期
5992
+ 时间格式:yyyy-MM-dd HH:mm:ss
5718
5993
  */
5719
5994
  EffectiveDate?: string;
5720
5995
  }
@@ -5855,7 +6130,9 @@ export interface CheckFunctionResponse {
5855
6130
  */
5856
6131
  export interface DeleteExportRequest {
5857
6132
  /**
5858
- * 日志导出ID
6133
+ * 日志导出任务Id
6134
+ - 通过[获取日志下载任务列表](https://cloud.tencent.com/document/product/614/56449)获取日志导出任务Id。
6135
+
5859
6136
  */
5860
6137
  ExportId: string;
5861
6138
  }
@@ -6081,7 +6358,7 @@ export interface NoticeReceiver {
6081
6358
  */
6082
6359
  ReceiverChannels: Array<string>;
6083
6360
  /**
6084
- * 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)
6361
+ * 通知内容模板ID,使用Default-zh引用默认模板(中文),使用Default-en引用DefaultTemplate(English)。-通过[获取通知内容模板](https://cloud.tencent.com/document/product/614/111714)获取通知内容模板ID
6085
6362
  */
6086
6363
  NoticeContentId?: string;
6087
6364
  /**
@@ -6105,7 +6382,9 @@ export interface NoticeReceiver {
6105
6382
  */
6106
6383
  export interface CreateKafkaRechargeRequest {
6107
6384
  /**
6108
- * 导入CLS目标topic ID
6385
+ * 导入CLS目标TopicId。
6386
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
6387
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
6109
6388
  */
6110
6389
  TopicId: string;
6111
6390
  /**
@@ -6130,6 +6409,7 @@ export interface CreateKafkaRechargeRequest {
6130
6409
  LogRechargeRule: LogRechargeRuleInfo;
6131
6410
  /**
6132
6411
  * 腾讯云CKafka实例ID,KafkaType为0时必填。
6412
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
6133
6413
  */
6134
6414
  KafkaInstance?: string;
6135
6415
  /**
@@ -6146,7 +6426,8 @@ export interface CreateKafkaRechargeRequest {
6146
6426
  */
6147
6427
  Protocol?: KafkaProtocolInfo;
6148
6428
  /**
6149
- * 用户Kafka消费组名称
6429
+ * 用户Kafka消费组名称。
6430
+ - 消费组是 Kafka 提供的可扩展且具有容错性的消费者机制,一个消费组中存在多个消费者,组内的所有消费者共同消费订阅 Topic 中的消息。一个消费者可同时消费多个 Partition,但一个 Partition 只能被消费组内的一个消费者消费。
6150
6431
  */
6151
6432
  ConsumerGroupName?: string;
6152
6433
  }
@@ -6211,7 +6492,9 @@ export interface CreateConfigResponse {
6211
6492
  */
6212
6493
  export interface CreateConsumerRequest {
6213
6494
  /**
6214
- * 投递任务绑定的日志主题 ID
6495
+ * 投递任务绑定的日志主题Id。
6496
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
6497
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
6215
6498
  */
6216
6499
  TopicId: string;
6217
6500
  /**
@@ -6292,11 +6575,11 @@ export interface AlarmNotice {
6292
6575
  */
6293
6576
  AlarmNoticeDeliverConfig?: AlarmNoticeDeliverConfig;
6294
6577
  /**
6295
- * 创建时间。
6578
+ * 创建时间。格式: YYYY-MM-DD HH:MM:SS
6296
6579
  */
6297
6580
  CreateTime?: string;
6298
6581
  /**
6299
- * 最近更新时间。
6582
+ * 最近更新时间。格式: YYYY-MM-DD HH:MM:SS
6300
6583
  */
6301
6584
  UpdateTime?: string;
6302
6585
  }
@@ -6314,7 +6597,7 @@ export interface ModifyConfigResponse {
6314
6597
  */
6315
6598
  export interface ModifyNoticeContentRequest {
6316
6599
  /**
6317
- * 通知内容模板ID
6600
+ * 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
6318
6601
  */
6319
6602
  NoticeContentId: string;
6320
6603
  /**
@@ -6337,7 +6620,9 @@ export interface ModifyNoticeContentRequest {
6337
6620
  */
6338
6621
  export interface OpenKafkaConsumerRequest {
6339
6622
  /**
6340
- * 日志主题ID
6623
+ * 日志主题Id。
6624
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
6625
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
6341
6626
  */
6342
6627
  FromTopicId: string;
6343
6628
  /**
@@ -6354,7 +6639,11 @@ export interface OpenKafkaConsumerRequest {
6354
6639
  */
6355
6640
  export interface QueryRangeMetricResponse {
6356
6641
  /**
6357
- * 指标查询结果类型
6642
+ * 指标查询结果类型,支持
6643
+ - scalar 标量值
6644
+ - string 字符串值
6645
+ - vector 瞬时向量
6646
+ - matrix 区间向量
6358
6647
  */
6359
6648
  ResultType?: string;
6360
6649
  /**
@@ -6612,11 +6901,11 @@ export interface AlarmShieldInfo {
6612
6901
  */
6613
6902
  Status?: number;
6614
6903
  /**
6615
- * 规则创建时间。
6904
+ * 规则创建时间。秒级时间戳(s)
6616
6905
  */
6617
6906
  CreateTime?: number;
6618
6907
  /**
6619
- * 规则更新时间。
6908
+ * 规则更新时间。秒级时间戳(s)
6620
6909
  */
6621
6910
  UpdateTime?: number;
6622
6911
  }
@@ -6690,10 +6979,12 @@ export interface CreateCloudProductLogCollectionResponse {
6690
6979
  export interface DeleteConfigFromMachineGroupRequest {
6691
6980
  /**
6692
6981
  * 机器组ID
6982
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
6693
6983
  */
6694
6984
  GroupId: string;
6695
6985
  /**
6696
6986
  * 采集配置ID
6987
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
6697
6988
  */
6698
6989
  ConfigId: string;
6699
6990
  }
@@ -6744,22 +7035,26 @@ export interface DescribeAlarmsRequest {
6744
7035
  - 按照【告警策略名称】进行过滤。
6745
7036
  - 类型:String
6746
7037
  - 必选:否
7038
+ - 示例:test-alarm
6747
7039
 
6748
7040
  alarmId
6749
7041
  - 按照【告警策略ID】进行过滤。
6750
7042
  - 类型:String
6751
7043
  - 必选:否
7044
+ - 示例:alarm-b60cf034-c3d6-4b01-xxxx-4e877ebb4751
6752
7045
 
6753
7046
  topicId
6754
7047
  - 按照【监控对象的日志主题ID】进行过滤。
6755
7048
  - 类型:String
6756
7049
  - 必选:否
7050
+ - 示例:6766f83d-659e-xxxx-a8f7-9104a1012743
6757
7051
 
6758
7052
  enable
6759
7053
  - 按照【启用状态】进行过滤。
6760
7054
  - 类型:String
6761
7055
  - 备注:enable参数值范围: 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False。 其它值将返回参数错误信息.
6762
7056
  - 必选:否
7057
+ - 示例:true
6763
7058
 
6764
7059
  每次请求的Filters的上限为10,Filter.Values的上限为5。
6765
7060
  */
@@ -6779,10 +7074,12 @@ export interface DescribeAlarmsRequest {
6779
7074
  export interface QueryMetricRequest {
6780
7075
  /**
6781
7076
  * 查询语句,使用PromQL语法
7077
+ - 参考 [语法规则](https://cloud.tencent.com/document/product/614/90334) 文档
6782
7078
  */
6783
7079
  Query: string;
6784
7080
  /**
6785
7081
  * 指标主题ID
7082
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
6786
7083
  */
6787
7084
  TopicId: string;
6788
7085
  /**
@@ -6971,11 +7268,15 @@ export interface AddMachineGroupInfoResponse {
6971
7268
  */
6972
7269
  export interface ModifyMachineGroupRequest {
6973
7270
  /**
6974
- * 机器组ID
7271
+ * 机器组Id
7272
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/product/614/56438)获取机器组Id。
6975
7273
  */
6976
7274
  GroupId: string;
6977
7275
  /**
6978
7276
  * 机器组名称
7277
+ 输入限制:
7278
+ - 不能为空字符串
7279
+ - 不能包含字符'|'
6979
7280
  */
6980
7281
  GroupName?: string;
6981
7282
  /**
@@ -6994,10 +7295,12 @@ export interface ModifyMachineGroupRequest {
6994
7295
  AutoUpdate?: boolean;
6995
7296
  /**
6996
7297
  * 升级开始时间,建议业务低峰期升级LogListener
7298
+ 时间格式:HH:mm:ss
6997
7299
  */
6998
7300
  UpdateStartTime?: string;
6999
7301
  /**
7000
7302
  * 升级结束时间,建议业务低峰期升级LogListener
7303
+ 时间格式:HH:mm:ss
7001
7304
  */
7002
7305
  UpdateEndTime?: string;
7003
7306
  /**
@@ -7033,11 +7336,12 @@ export interface MachineGroupTypeInfo {
7033
7336
  */
7034
7337
  export interface MergePartitionRequest {
7035
7338
  /**
7036
- * 日志主题ID
7339
+ * 日志主题Id
7340
+ - 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
7037
7341
  */
7038
7342
  TopicId: string;
7039
7343
  /**
7040
- * 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Staus:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56469)
7344
+ * 合并的PartitionId(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等,且找到的分区必须是读写分区(Status:readwrite),入参PartitionId与找到的PartitionId设置为只读分区(Status:readonly),再新建一个新的读写分区) 。[获取分区列表](https://cloud.tencent.com/document/product/614/56470)
7041
7345
 
7042
7346
  1. 入参PartitionId只能是读写分区(Status的值有readonly,readwrite),且能找到入参PartitionId的下一个可读写分区(找到下一个分区InclusiveBeginKey与入参PartitionId对应的ExclusiveEndKey相等);
7043
7347
  2. 入参PartitionId不能是最后一个分区(PartitionId的ExclusiveEndKey不能是ffffffffffffffffffffffffffffffff);
@@ -7102,7 +7406,7 @@ export interface MetricLabel {
7102
7406
  */
7103
7407
  export interface CreateNoticeContentRequest {
7104
7408
  /**
7105
- * 模板名称。
7409
+ * 模板名称。最大支持255个字节
7106
7410
  */
7107
7411
  Name: string;
7108
7412
  /**
@@ -7119,27 +7423,41 @@ export interface CreateNoticeContentRequest {
7119
7423
  */
7120
7424
  export interface Ckafka {
7121
7425
  /**
7122
- * Ckafka 的 InstanceId
7426
+ * Ckafka 的 InstanceId
7427
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
7428
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取实例id。
7123
7429
  */
7124
7430
  InstanceId: string;
7125
7431
  /**
7126
- * Ckafka 的 TopicName
7432
+ * Ckafka 的 TopicName
7433
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicName。
7434
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicName。
7127
7435
  */
7128
7436
  TopicName: string;
7129
7437
  /**
7130
- * Ckafka 的 Vip
7438
+ * Ckafka 的 Vip
7439
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip信息。
7440
+ - 如果是通过 角色ARN 方式创建投递任务,则Vip字段可为空。
7131
7441
  */
7132
7442
  Vip?: string;
7133
7443
  /**
7134
- * Ckafka 的 Vport
7444
+ * Ckafka 的 Vport
7445
+ - 通过 [获取实例属性 ](https://cloud.tencent.com/document/product/597/40836) 获取vip port信息。
7446
+ - 如果是通过 角色ARN 方式创建投递任务,则Vport字段可为空。
7135
7447
  */
7136
7448
  Vport?: string;
7137
7449
  /**
7138
- * Ckafka 的 InstanceName
7450
+ * Ckafka 的 InstanceName
7451
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取InstanceName。
7452
+ - 通过 [创建实例](https://cloud.tencent.com/document/product/597/53207) 获取InstanceName。
7453
+ - 如果是通过 角色ARN 方式创建投递任务,则InstanceName字段可为空。
7139
7454
  */
7140
7455
  InstanceName?: string;
7141
7456
  /**
7142
- * Ckafka 的 TopicId
7457
+ * Ckafka 的 TopicId
7458
+ - 通过 [创建 Topic](https://cloud.tencent.com/document/product/597/73566) 获得TopicId。
7459
+ - 通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获得TopicId。
7460
+ - 如果是通过 角色ARN 方式创建投递任务,则TopicId字段可为空。
7143
7461
  */
7144
7462
  TopicId?: string;
7145
7463
  }
@@ -7213,7 +7531,7 @@ export interface MultiCondition {
7213
7531
  */
7214
7532
  export interface DeleteAlarmNoticeRequest {
7215
7533
  /**
7216
- * 通知渠道组ID
7534
+ * 通知渠道组ID。-通过[获取通知渠道组列表](https://cloud.tencent.com/document/api/614/56462)获取通知渠道组ID
7217
7535
  */
7218
7536
  AlarmNoticeId: string;
7219
7537
  }
@@ -7238,15 +7556,14 @@ export interface DescribeScheduledSqlInfoRequest {
7238
7556
  */
7239
7557
  TaskId?: string;
7240
7558
  /**
7241
- * <li>srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
7242
- <li>dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否</li>
7243
- <li>srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否</li>
7244
- <li>dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否</li>
7245
- <li>bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否</li>
7246
- <li>status按照【任务状态】进行过滤,1:运行;2:停止。类型:String。必选:否</li>
7247
- <li>taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否</li>
7248
- <li>taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否</li>
7249
-
7559
+ * - srcTopicName按照【源日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题1 ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
7560
+ - dstTopicName按照【目标日志主题名称】进行过滤,模糊匹配。类型:String。必选:否。示例:业务日志主题 2,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题名称。
7561
+ - srcTopicId按照【源日志主题ID】进行过滤。类型:String。必选:否。示例:a4478687-2382-4486-9692-de7986350f6b ,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
7562
+ - dstTopicId按照【目标日志主题ID】进行过滤。类型:String。必选:否。示例:bd4d3375-d72a-4cd2-988d-d8eda2bd62b0,通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题id。
7563
+ - bizType按照【主题类型】进行过滤,0:日志主题;1:指标主题。类型:String。必选:否
7564
+ - status按照【任务状态】进行过滤,1:运行;2:停止;3:异常。类型:String。必选:否
7565
+ - taskName按照【任务名称】进行过滤,模糊匹配。类型:String。必选:否。示例:metricTask ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务名称。
7566
+ - taskId按照【任务ID】进行过滤,模糊匹配。类型:String。必选:否。示例:9c64f9c1-a14e-4b59-b074-5b73cac3dd66 ,通过 [获取定时SQL分析任务列表](https://cloud.tencent.com/document/product/614/95519) 获取任务id。
7250
7567
  */
7251
7568
  Filters?: Array<Filter>;
7252
7569
  }
@@ -7329,7 +7646,7 @@ export interface MonitorTime {
7329
7646
  */
7330
7647
  Time?: number;
7331
7648
  /**
7332
- * 执行的周期cron表达式。示例:`"* /1 * * * *"` 从左到右每个field的含义 Minutes field, Hours field,Day of month field,Month field,Day of week field, 不支持秒级别。
7649
+ * 执行的周期cron表达式。示例:`"* /1 * * * *"` 从左到右每个field的含义 Minutes field(分钟), Hours field(小时),Day of month field(日期),Month field(月份),Day of week field(星期), 不支持秒级别。
7333
7650
  当type为`Cron`时,CronExpression字段生效。
7334
7651
  */
7335
7652
  CronExpression?: string;
@@ -7365,7 +7682,10 @@ export interface MultiTopicSearchInformation {
7365
7682
  */
7366
7683
  export interface CreateMachineGroupRequest {
7367
7684
  /**
7368
- * 机器组名字,不能重复
7685
+ * 机器组名字。
7686
+ 输入限制:
7687
+ - 最大支持255个字符,不能为空字符串
7688
+ - 不能包含字符'|'
7369
7689
  */
7370
7690
  GroupName: string;
7371
7691
  /**
@@ -7384,10 +7704,12 @@ export interface CreateMachineGroupRequest {
7384
7704
  AutoUpdate?: boolean;
7385
7705
  /**
7386
7706
  * 升级开始时间,建议业务低峰期升级LogListener
7707
+ 时间格式:HH:mm:ss
7387
7708
  */
7388
7709
  UpdateStartTime?: string;
7389
7710
  /**
7390
7711
  * 升级结束时间,建议业务低峰期升级LogListener
7712
+ 时间格式:HH:mm:ss
7391
7713
  */
7392
7714
  UpdateEndTime?: string;
7393
7715
  /**
@@ -7396,6 +7718,8 @@ export interface CreateMachineGroupRequest {
7396
7718
  ServiceLogging?: boolean;
7397
7719
  /**
7398
7720
  * 机器组中机器离线清理时间。单位:天
7721
+
7722
+ - 大于0时生效。
7399
7723
  */
7400
7724
  DelayCleanupTime?: number;
7401
7725
  /**
@@ -7442,11 +7766,11 @@ export interface DescribeExportsResponse {
7442
7766
  /**
7443
7767
  * 日志导出列表
7444
7768
  */
7445
- Exports: Array<ExportInfo>;
7769
+ Exports?: Array<ExportInfo>;
7446
7770
  /**
7447
7771
  * 总数目
7448
7772
  */
7449
- TotalCount: number;
7773
+ TotalCount?: number;
7450
7774
  /**
7451
7775
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7452
7776
  */
@@ -7458,10 +7782,12 @@ export interface DescribeExportsResponse {
7458
7782
  export interface ApplyConfigToMachineGroupRequest {
7459
7783
  /**
7460
7784
  * 采集配置ID
7785
+ - 通过[获取采集规则配置](https://cloud.tencent.com/document/product/614/58616)获取采集配置Id。
7461
7786
  */
7462
7787
  ConfigId: string;
7463
7788
  /**
7464
7789
  * 机器组ID
7790
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
7465
7791
  */
7466
7792
  GroupId: string;
7467
7793
  }
@@ -7561,18 +7887,22 @@ export interface DescribeConfigExtrasRequest {
7561
7887
  name
7562
7888
  - 按照【特殊采集配置名称】进行模糊匹配过滤。
7563
7889
  - 类型:String
7890
+ - 示例:test-config
7564
7891
 
7565
7892
  configExtraId
7566
7893
  - 按照【特殊采集配置ID】进行过滤。
7567
7894
  - 类型:String
7895
+ - 示例:3b83f9d6-3a4d-47f9-9b7f-285c868b2f9a
7568
7896
 
7569
7897
  topicId
7570
7898
  - 按照【日志主题】进行过滤。
7571
7899
  - 类型:String
7900
+ - 示例:3581a3be-aa41-423b-995a-54ec84da6264
7572
7901
 
7573
7902
  machineGroupId
7574
7903
  - 按照【机器组ID】进行过滤。
7575
7904
  - 类型:String
7905
+ - 示例:f948972f-a063-408c-a59f-8c3230bddaf6
7576
7906
 
7577
7907
  每次请求的Filters的上限为10,Filter.Values的上限为5。
7578
7908
  */
@@ -7621,7 +7951,7 @@ export interface DescribeCloudProductLogTasksRequest {
7621
7951
  */
7622
7952
  export interface CreateAlarmNoticeRequest {
7623
7953
  /**
7624
- * 通知渠道组名称。
7954
+ * 通知渠道组名称。最大支持255个字节。 不支持 '|'。
7625
7955
  */
7626
7956
  Name: string;
7627
7957
  /**
@@ -7729,11 +8059,11 @@ export interface HistogramInfo {
7729
8059
  /**
7730
8060
  * 统计周期内的日志条数
7731
8061
  */
7732
- Count: number;
8062
+ Count?: number;
7733
8063
  /**
7734
8064
  * 按 period 取整后的 unix timestamp: 单位毫秒
7735
8065
  */
7736
- BTime: number;
8066
+ BTime?: number;
7737
8067
  }
7738
8068
  /**
7739
8069
  * DescribeMachineGroupConfigs请求参数结构体
@@ -7741,6 +8071,7 @@ export interface HistogramInfo {
7741
8071
  export interface DescribeMachineGroupConfigsRequest {
7742
8072
  /**
7743
8073
  * 机器组ID
8074
+ - 通过[获取机器组列表](https://cloud.tencent.com/document/api/614/56438)获取机器组Id。
7744
8075
  */
7745
8076
  GroupId: string;
7746
8077
  }
@@ -7853,11 +8184,15 @@ export interface ModifyConfigExtraRequest {
7853
8184
  */
7854
8185
  export interface ModifyKafkaRechargeRequest {
7855
8186
  /**
7856
- * Kafka导入配置ID
8187
+ * 导入配置Id。
8188
+ - 通过 [创建Kafka数据订阅任务](https://cloud.tencent.com/document/product/614/94448)获取Kafka导入配置Id。
8189
+ - 通过 [获取Kafka数据订阅任务列表](https://cloud.tencent.com/document/product/614/94446)获取Kafka导入配置Id。
7857
8190
  */
7858
8191
  Id: string;
7859
8192
  /**
7860
- * 导入CLS目标topic ID
8193
+ * 导入CLS目标TopicId。
8194
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8195
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456)获取日志主题Id。
7861
8196
  */
7862
8197
  TopicId: string;
7863
8198
  /**
@@ -7870,6 +8205,7 @@ export interface ModifyKafkaRechargeRequest {
7870
8205
  KafkaType?: number;
7871
8206
  /**
7872
8207
  * 腾讯云CKafka实例ID,KafkaType为0时必填。
8208
+ - 通过 [获取实例列表信息](https://cloud.tencent.com/document/product/597/40835) 获取实例id。
7873
8209
  */
7874
8210
  KafkaInstance?: string;
7875
8211
  /**
@@ -7885,7 +8221,9 @@ export interface ModifyKafkaRechargeRequest {
7885
8221
  */
7886
8222
  Protocol?: KafkaProtocolInfo;
7887
8223
  /**
7888
- * 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开
8224
+ * 用户需要导入的Kafka相关topic列表,多个topic之间使用半角逗号隔开。
8225
+
8226
+ - Kafka类型为腾讯云CKafka时:通过 [获取主题列表](https://cloud.tencent.com/document/product/597/40847) 获取TopicName。
7889
8227
  */
7890
8228
  UserKafkaTopics?: string;
7891
8229
  /**
@@ -7897,7 +8235,7 @@ export interface ModifyKafkaRechargeRequest {
7897
8235
  */
7898
8236
  LogRechargeRule?: LogRechargeRuleInfo;
7899
8237
  /**
7900
- * 导入控制,1:暂停;2:继续。
8238
+ * 导入控制,1:暂停;2:启动。
7901
8239
  */
7902
8240
  StatusControl?: number;
7903
8241
  }
@@ -8286,7 +8624,7 @@ export interface DescribeWebCallbacksRequest {
8286
8624
  按照【告警渠道回调配置渠道类型】进行过滤。
8287
8625
  类型:String
8288
8626
  必选:否
8289
-
8627
+ 枚举值:WeCom,DingTalk,Lark,Http
8290
8628
  每次请求的Filters的上限为10,Filter.Values的上限为100。
8291
8629
  */
8292
8630
  Filters?: Array<Filter>;
@@ -8304,7 +8642,7 @@ export interface DescribeWebCallbacksRequest {
8304
8642
  */
8305
8643
  export interface DeleteNoticeContentRequest {
8306
8644
  /**
8307
- * 通知内容模板ID
8645
+ * 通知内容模板ID。-通过[获取通知内容模板](https://cloud.tencent.com/document/api/614/111714)获取通知内容模版ID
8308
8646
  */
8309
8647
  NoticeContentId: string;
8310
8648
  }
@@ -8313,7 +8651,9 @@ export interface DeleteNoticeContentRequest {
8313
8651
  */
8314
8652
  export interface DescribeKafkaConsumerRequest {
8315
8653
  /**
8316
- * 日志主题ID
8654
+ * 日志主题Id。
8655
+ - 通过 [获取日志主题列表](https://cloud.tencent.com/document/product/614/56454) 获取日志主题Id。
8656
+ - 通过 [创建日志主题](https://cloud.tencent.com/document/product/614/56456) 获取日志主题Id。
8317
8657
  */
8318
8658
  FromTopicId: string;
8319
8659
  }
@@ -8417,7 +8757,7 @@ export interface DeliverConfig {
8417
8757
  */
8418
8758
  Region: string;
8419
8759
  /**
8420
- * 日志主题ID
8760
+ * 日志主题ID。-通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题ID
8421
8761
  */
8422
8762
  TopicId: string;
8423
8763
  /**
@@ -8509,7 +8849,9 @@ export interface GetAlarmLogRequest {
8509
8849
  /**
8510
8850
  * 查询过滤条件,例如:
8511
8851
  - 按告警策略ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971"`
8852
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取告警策略ID
8512
8853
  - 按监控对象ID查询:`monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b" `
8854
+ - 通过[获取告警策略列表](https://cloud.tencent.com/document/api/614/56461)获取监控对象ID
8513
8855
  - 按告警策略ID及监控对象ID查询:`alert_id:"alarm-0745ec00-e605-xxxx-b50b-54afe61fc971" AND monitored_object:"823d8bfa-76a7-xxxx-8399-8cda74d4009b"`
8514
8856
  - 按告警策略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`
8515
8857
  */
@@ -8557,11 +8899,11 @@ export interface MergePartitionResponse {
8557
8899
  */
8558
8900
  export interface CreateScheduledSqlRequest {
8559
8901
  /**
8560
- * 源日志主题
8902
+ * 源日志主题ID- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
8561
8903
  */
8562
8904
  SrcTopicId: string;
8563
8905
  /**
8564
- * 任务名称
8906
+ * 任务名称,0~255字符
8565
8907
  */
8566
8908
  Name: string;
8567
8909
  /**
@@ -8585,7 +8927,7 @@ export interface CreateScheduledSqlRequest {
8585
8927
  */
8586
8928
  ProcessType: number;
8587
8929
  /**
8588
- * 调度周期(分钟)
8930
+ * 调度周期(分钟),1~1440分钟
8589
8931
  */
8590
8932
  ProcessPeriod: number;
8591
8933
  /**
@@ -8593,11 +8935,11 @@ export interface CreateScheduledSqlRequest {
8593
8935
  */
8594
8936
  ProcessTimeWindow: string;
8595
8937
  /**
8596
- * 执行延迟(秒)
8938
+ * 执行延迟(秒),0~120秒,默认60秒
8597
8939
  */
8598
8940
  ProcessDelay: number;
8599
8941
  /**
8600
- * 源topicId的地域信息
8942
+ * 源topicId的地域信息,支持地域见 [地域列表](https://cloud.tencent.com/document/api/614/56474#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) 文档
8601
8943
  */
8602
8944
  SrcTopicRegion: string;
8603
8945
  /**