tencentcloud-sdk-nodejs-cls 4.0.846 → 4.0.847

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-cls",
3
- "version": "4.0.846",
3
+ "version": "4.0.847",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -40,7 +40,7 @@
40
40
  | cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2024-03-20 01:09:28 |
41
41
  | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2024-03-21 01:09:20 |
42
42
  | ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2024-04-26 01:09:38 |
43
- | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-04-23 01:09:48 |
43
+ | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2024-05-07 01:10:17 |
44
44
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2024-03-20 01:10:04 |
45
45
  | cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2024-04-24 01:06:45 |
46
46
  | cds | [T-Sec-数据安全审计(DSA)](https://cloud.tencent.com/document/product/856) | 2024-04-22 01:10:25 |
@@ -56,23 +56,23 @@
56
56
  | cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 |
57
57
  | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 |
58
58
  | ckafka | [消息队列 CKafka 版](https://cloud.tencent.com/document/product/597) | 2024-04-17 01:08:31 |
59
- | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2024-03-28 01:11:53 |
59
+ | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2024-05-07 01:12:00 |
60
60
  | cloudaudit | [操作审计](https://cloud.tencent.com/document/product/629) | 2024-01-15 01:09:37 |
61
61
  | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2024-03-20 01:11:31 |
62
62
  | cloudstudio | [Cloud Studio(云端 IDE)](https://cloud.tencent.com/document/product/1039) | 2024-04-26 01:11:33 |
63
- | cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2024-05-01 01:13:17 |
63
+ | cls | [日志服务](https://cloud.tencent.com/document/product/614) | 2024-05-07 01:12:18 |
64
64
  | cme | [多媒体创作引擎](https://cloud.tencent.com/document/product/1156) | 2024-03-20 01:12:05 |
65
65
  | cmq | [消息队列 CMQ](https://cloud.tencent.com/document/product/406) | 2024-03-20 01:12:14 |
66
66
  | cms | [内容安全](https://cloud.tencent.com/document/product/669) | 2024-04-22 01:12:28 |
67
67
  | config | [配置审计](https://cloud.tencent.com/document/product/1579) | 2024-03-20 01:12:18 |
68
68
  | cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2023-09-21 02:09:54 |
69
69
  | cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
70
- | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2024-04-23 01:12:12 |
70
+ | csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2024-05-07 01:12:54 |
71
71
  | csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2024-03-20 01:12:25 |
72
- | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-04-22 01:12:38 |
73
- | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-04-22 01:12:53 |
72
+ | cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2024-05-07 01:13:09 |
73
+ | cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2024-05-07 01:13:25 |
74
74
  | cws | [漏洞扫描服务](https://cloud.tencent.com/document/product) | 2019-11-22 12:16:15 |
75
- | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-04-26 01:13:19 |
75
+ | cynosdb | [TDSQL-C MySQL 版](https://cloud.tencent.com/document/product/1003) | 2024-05-07 01:14:21 |
76
76
  | dasb | [T-Sec-堡垒机(BH)](https://cloud.tencent.com/document/product/1025) | 2024-04-22 01:14:04 |
77
77
  | dataintegration | [数据接入平台](https://cloud.tencent.com/document/product/1591) | 2022-07-26 15:32:15 |
78
78
  | dayu | [DDoS 高防包](https://cloud.tencent.com/document/product/1021) | 2023-05-18 01:20:11 |
@@ -152,10 +152,10 @@
152
152
  | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2024-04-01 01:22:02 |
153
153
  | msp | [迁移服务平台](https://cloud.tencent.com/document/product/659) | 2024-04-17 14:48:31 |
154
154
  | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 |
155
- | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2024-03-20 01:21:33 |
155
+ | nlp | [NLP 服务](https://cloud.tencent.com/document/product/271) | 2024-05-07 01:22:11 |
156
156
  | npp | [号码保护](https://cloud.tencent.com/document/product) | 2020-04-22 08:00:22 |
157
157
  | oceanus | [流计算 Oceanus](https://cloud.tencent.com/document/product/849) | 2024-04-19 01:23:09 |
158
- | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-04-29 01:21:11 |
158
+ | ocr | [文字识别](https://cloud.tencent.com/document/product/866) | 2024-05-07 01:22:19 |
159
159
  | omics | [腾讯健康组学平台](https://cloud.tencent.com/document/product/1643) | 2024-04-22 01:22:30 |
160
160
  | organization | [集团账号管理](https://cloud.tencent.com/document/product/850) | 2024-04-22 01:22:36 |
161
161
  | partners | [渠道合作伙伴](https://cloud.tencent.com/document/product/563) | 2024-03-20 01:22:23 |
@@ -168,7 +168,7 @@
168
168
  | region | [地域管理系统](https://cloud.tencent.com/document/product/1596) | 2024-04-22 01:23:34 |
169
169
  | rkp | [风险探针](https://cloud.tencent.com/document/product/1169) | 2023-12-25 00:16:39 |
170
170
  | rp | [注册保护](https://cloud.tencent.com/document/product/1191) | 2022-04-04 07:04:06 |
171
- | rum | [前端性能监控](https://cloud.tencent.com/document/product/1464) | 2024-04-30 01:23:43 |
171
+ | rum | [前端性能监控](https://cloud.tencent.com/document/product/1464) | 2024-05-07 01:23:32 |
172
172
  | scf | [云函数](https://cloud.tencent.com/document/product/583) | 2024-04-15 02:05:44 |
173
173
  | ses | [邮件推送](https://cloud.tencent.com/document/product/1288) | 2024-03-20 01:23:23 |
174
174
  | smh | [智能媒资托管](https://cloud.tencent.com/document/product/1339) | 2024-04-16 01:18:21 |
@@ -179,7 +179,7 @@
179
179
  | solar | [智汇零售](https://cloud.tencent.com/document/product) | 2020-03-19 08:01:59 |
180
180
  | sqlserver | [云数据库 SQL Server](https://cloud.tencent.com/document/product/238) | 2024-04-15 02:06:58 |
181
181
  | ssa | [安全运营中心](https://cloud.tencent.com/document/product/664) | 2023-11-15 02:18:28 |
182
- | ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2024-04-29 01:23:12 |
182
+ | ssl | [SSL 证书](https://cloud.tencent.com/document/product/400) | 2024-05-07 01:24:15 |
183
183
  | sslpod | [证书监控 SSLPod](https://cloud.tencent.com/document/product/1084) | 2024-03-20 01:24:03 |
184
184
  | ssm | [凭据管理系统](https://cloud.tencent.com/document/product/1140) | 2024-04-22 01:24:29 |
185
185
  | sts | [安全凭证服务](https://cloud.tencent.com/document/product/1312) | 2024-03-20 01:24:08 |
@@ -206,7 +206,7 @@
206
206
  | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2024-04-29 01:24:57 |
207
207
  | tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2024-04-22 01:26:50 |
208
208
  | tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2024-03-20 01:26:14 |
209
- | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-04-29 16:57:36 |
209
+ | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2024-05-07 01:26:42 |
210
210
  | thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2024-03-20 01:27:05 |
211
211
  | tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
212
212
  | tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 |
@@ -219,7 +219,7 @@
219
219
  | tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2024-03-20 01:28:56 |
220
220
  | tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
221
221
  | tms | [文本内容安全](https://cloud.tencent.com/document/product/1124) | 2024-04-29 01:26:41 |
222
- | tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2024-04-26 01:26:41 |
222
+ | tmt | [机器翻译](https://cloud.tencent.com/document/product/551) | 2024-05-06 15:48:46 |
223
223
  | tourism | [文旅客情大数据](https://cloud.tencent.com/document/product/1684) | 2024-03-20 01:28:59 |
224
224
  | trdp | [流量风险决策平台](https://cloud.tencent.com/document/product/1604) | 2023-05-18 02:01:19 |
225
225
  | trocket | [消息队列 RocketMQ 版](https://cloud.tencent.com/document/product/1493) | 2024-04-22 01:28:17 |
@@ -227,18 +227,18 @@
227
227
  | trro | [远程实时操控](https://cloud.tencent.com/document/product/1584) | 2024-03-20 01:29:13 |
228
228
  | trtc | [实时音视频](https://cloud.tencent.com/document/product/647) | 2024-04-22 19:56:18 |
229
229
  | tse | [微服务引擎](https://cloud.tencent.com/document/product/1364) | 2024-04-29 01:27:04 |
230
- | tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2024-03-20 01:29:39 |
230
+ | tsf | [微服务平台 TSF](https://cloud.tencent.com/document/product/649) | 2024-05-07 01:28:28 |
231
231
  | tsw | [微服务观测平台 TSW](https://cloud.tencent.com/document/product/1311) | 2024-03-20 01:30:06 |
232
232
  | tts | [语音合成](https://cloud.tencent.com/document/product/1073) | 2024-04-24 01:23:54 |
233
233
  | ump | [客流数字化平台](https://cloud.tencent.com/document/product/1320) | 2024-03-20 01:30:08 |
234
234
  | vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2024-03-20 01:30:12 |
235
235
  | vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2024-03-20 01:30:13 |
236
236
  | vod | [云点播](https://cloud.tencent.com/document/product/266) | 2024-04-19 01:30:53 |
237
- | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-04-29 01:28:19 |
237
+ | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2024-05-07 01:29:27 |
238
238
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2024-04-02 01:27:45 |
239
239
  | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2024-04-25 14:30:01 |
240
240
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2024-03-20 01:32:09 |
241
- | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2024-04-18 15:07:41 |
241
+ | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2024-05-07 01:30:27 |
242
242
  | weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2024-04-23 01:30:48 |
243
243
  | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
244
244
  | yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2024-03-20 01:33:11 |
@@ -1469,7 +1469,12 @@ export interface NoticeRule {
1469
1469
  */
1470
1470
  WebCallbacks?: Array<WebCallback>
1471
1471
  /**
1472
- * 匹配规则。
1472
+ * 匹配规则 JSON串。
1473
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}
1474
+ `
1475
+ 以上示例表示:
1476
+ 规则:
1477
+ 通知类型属于告警通知,恢复通知
1473
1478
  注意:此字段可能返回 null,表示取不到有效值。
1474
1479
  */
1475
1480
  Rule?: string
@@ -1751,7 +1756,7 @@ export interface ExtractRuleInfo {
1751
1756
  */
1752
1757
  UnMatchUpLoadSwitch?: boolean
1753
1758
  /**
1754
- * 失败日志的key
1759
+ * 失败日志的key,当UnMatchUpLoadSwitch为true时必填
1755
1760
  注意:此字段可能返回 null,表示取不到有效值。
1756
1761
  */
1757
1762
  UnMatchLogKey?: string
@@ -1764,18 +1769,21 @@ export interface ExtractRuleInfo {
1764
1769
  Backtracking?: number
1765
1770
  /**
1766
1771
  * 是否为Gbk编码。 0:否;1:是。
1767
- 注意:
1772
+ 注意
1773
+ - 目前取0值时,表示UTF-8编码
1768
1774
  - COS导入不支持此字段。
1769
1775
  注意:此字段可能返回 null,表示取不到有效值。
1770
1776
  */
1771
1777
  IsGBK?: number
1772
1778
  /**
1773
1779
  * 是否为标准json。 0:否; 1:是。
1780
+
1781
+ - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
1774
1782
  注意:此字段可能返回 null,表示取不到有效值。
1775
1783
  */
1776
1784
  JsonStandard?: number
1777
1785
  /**
1778
- * syslog传输协议,取值为tcp或者udp
1786
+ * syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
1779
1787
  注意:
1780
1788
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
1781
1789
  - COS导入不支持此字段。
@@ -1783,7 +1791,7 @@ export interface ExtractRuleInfo {
1783
1791
  */
1784
1792
  Protocol?: string
1785
1793
  /**
1786
- * syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000
1794
+ * syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
1787
1795
  注意:
1788
1796
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
1789
1797
  - COS导入不支持此字段。
@@ -1794,6 +1802,7 @@ export interface ExtractRuleInfo {
1794
1802
  * rfc3164:指定系统日志采集使用RFC3164协议解析日志。
1795
1803
  rfc5424:指定系统日志采集使用RFC5424协议解析日志。
1796
1804
  auto:自动匹配rfc3164或者rfc5424其中一种协议。
1805
+ 只有在LogType为service_syslog时生效,其余类型无需填写。
1797
1806
  注意:
1798
1807
  - 该字段适用于:创建采集规则配置、修改采集规则配置
1799
1808
  - COS导入不支持此字段。
@@ -1822,9 +1831,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
1822
1831
  */
1823
1832
  MetaTags?: Array<MetaTagInfo>
1824
1833
  /**
1825
- * Windows事件日志采集。
1826
- 注意:
1827
- - COS导入不支持此字段。
1834
+ * Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
1828
1835
  */
1829
1836
  EventLogRules?: Array<EventLog>
1830
1837
  }
@@ -3898,7 +3905,7 @@ export interface DescribeMachineGroupsResponse {
3898
3905
  */
3899
3906
  export interface DeleteConfigExtraRequest {
3900
3907
  /**
3901
- * 采集规则扩展配置ID
3908
+ * 特殊采集规则扩展配置ID
3902
3909
  */
3903
3910
  ConfigExtraId: string
3904
3911
  }
@@ -4146,19 +4153,21 @@ export interface DeleteAlarmResponse {
4146
4153
  */
4147
4154
  export interface WebCallback {
4148
4155
  /**
4149
- * 回调地址。
4156
+ * 回调地址。最大支持1024个字节数。
4150
4157
  */
4151
4158
  Url: string
4152
4159
  /**
4153
4160
  * 回调的类型。可选值:
4154
- <li> WeCom
4155
- <li> Http
4161
+ - WeCom
4162
+ - Http
4163
+ - DingTalk
4164
+ - Lark
4156
4165
  */
4157
4166
  CallbackType: string
4158
4167
  /**
4159
4168
  * 回调方法。可选值:
4160
- <li> POST
4161
- <li> PUT
4169
+ - POST
4170
+ - PUT
4162
4171
  默认值为POST。CallbackType为Http时为必选。
4163
4172
  注意:此字段可能返回 null,表示取不到有效值。
4164
4173
  */
@@ -4176,7 +4185,9 @@ export interface WebCallback {
4176
4185
  */
4177
4186
  Body?: string
4178
4187
  /**
4179
- * 序号
4188
+ * 序号。
4189
+ - 入参无效。
4190
+ - 出参有效。
4180
4191
  */
4181
4192
  Index?: number
4182
4193
  }
@@ -4236,7 +4247,7 @@ export interface CreateConfigRequest {
4236
4247
  */
4237
4248
  Output: string
4238
4249
  /**
4239
- * 日志采集路径,包含文件名
4250
+ * 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
4240
4251
  */
4241
4252
  Path?: string
4242
4253
  /**
@@ -5967,21 +5978,23 @@ export type DeleteDashboardSubscribeRequest = null
5967
5978
  export interface NoticeReceiver {
5968
5979
  /**
5969
5980
  * 接受者类型。可选值:
5970
- <br><li> Uin - 用户ID
5971
- <br><li> Group - 用户组ID
5981
+ - Uin - 用户ID
5982
+ - Group - 用户组ID
5972
5983
  暂不支持其余接收者类型。
5973
5984
  */
5974
5985
  ReceiverType: string
5975
5986
  /**
5976
5987
  * 接收者。
5988
+ 当ReceiverType为Uin时,ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)
5989
+ 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
5977
5990
  */
5978
5991
  ReceiverIds: Array<number | bigint>
5979
5992
  /**
5980
5993
  * 通知接收渠道。
5981
- <br><li> Email - 邮件
5982
- <br><li> Sms - 短信
5983
- <br><li> WeChat - 微信
5984
- <br><li> Phone - 电话
5994
+ - Email - 邮件
5995
+ - Sms - 短信
5996
+ - WeChat - 微信
5997
+ - Phone - 电话
5985
5998
  */
5986
5999
  ReceiverChannels: Array<string>
5987
6000
  /**
@@ -5993,7 +6006,10 @@ export interface NoticeReceiver {
5993
6006
  */
5994
6007
  EndTime?: string
5995
6008
  /**
5996
- * 位序
6009
+ * 位序。
6010
+
6011
+ - 入参无效。
6012
+ - 出参时有效。
5997
6013
  */
5998
6014
  Index?: number
5999
6015
  }
@@ -6565,7 +6581,27 @@ export interface CsvInfo {
6565
6581
  */
6566
6582
  export interface DescribeConfigExtrasRequest {
6567
6583
  /**
6568
- * 支持的key: topicId,name, configExtraId, machineGroupId
6584
+ * name
6585
+ - 按照【特殊采集配置名称】进行模糊匹配过滤。
6586
+ - 类型:String
6587
+ - 必选:否
6588
+
6589
+ configExtraId
6590
+ - 按照【特殊采集配置ID】进行过滤。
6591
+ - 类型:String
6592
+ - 必选:否
6593
+
6594
+ topicId
6595
+ - 按照【日志主题】进行过滤。
6596
+ - 类型:String
6597
+ - 必选:否
6598
+
6599
+ machineGroupId
6600
+ - 按照【机器组ID】进行过滤。
6601
+ - 类型:String
6602
+ - 必选:否
6603
+
6604
+ 每次请求的Filters的上限为10,Filter.Values的上限为5。
6569
6605
  */
6570
6606
  Filters?: Array<Filter>
6571
6607
  /**
@@ -6588,25 +6624,35 @@ export interface CreateAlarmNoticeRequest {
6588
6624
  Name: string
6589
6625
  /**
6590
6626
  * 通知类型。可选值:
6591
- <li> Trigger - 告警触发 </li>
6592
- <li> Recovery - 告警恢复</li>
6593
- <li> All - 告警触发和告警恢复</li>
6627
+ - Trigger - 告警触发
6628
+ - Recovery - 告警恢复
6629
+ - All - 告警触发和告警恢复
6630
+
6631
+
6632
+ 注意:
6633
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6634
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6594
6635
  */
6595
6636
  Type?: string
6596
6637
  /**
6597
6638
  * 通知接收对象。
6639
+ 注意:
6640
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6641
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6598
6642
  */
6599
6643
  NoticeReceivers?: Array<NoticeReceiver>
6600
6644
  /**
6601
6645
  * 接口回调信息(包括企业微信)。
6646
+ 注意:
6647
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6648
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6602
6649
  */
6603
6650
  WebCallbacks?: Array<WebCallback>
6604
6651
  /**
6605
6652
  * 通知规则。
6606
-
6607
6653
  注意:
6608
-
6609
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。
6654
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6655
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6610
6656
 
6611
6657
 
6612
6658
  */
@@ -1391,7 +1391,12 @@ export interface NoticeRule {
1391
1391
  */
1392
1392
  WebCallbacks?: Array<WebCallback>;
1393
1393
  /**
1394
- * 匹配规则。
1394
+ * 匹配规则 JSON串。
1395
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}
1396
+ `
1397
+ 以上示例表示:
1398
+ 规则:
1399
+ 通知类型属于告警通知,恢复通知
1395
1400
  注意:此字段可能返回 null,表示取不到有效值。
1396
1401
  */
1397
1402
  Rule?: string;
@@ -1665,7 +1670,7 @@ export interface ExtractRuleInfo {
1665
1670
  */
1666
1671
  UnMatchUpLoadSwitch?: boolean;
1667
1672
  /**
1668
- * 失败日志的key
1673
+ * 失败日志的key,当UnMatchUpLoadSwitch为true时必填
1669
1674
  注意:此字段可能返回 null,表示取不到有效值。
1670
1675
  */
1671
1676
  UnMatchLogKey?: string;
@@ -1678,18 +1683,21 @@ export interface ExtractRuleInfo {
1678
1683
  Backtracking?: number;
1679
1684
  /**
1680
1685
  * 是否为Gbk编码。 0:否;1:是。
1681
- 注意:
1686
+ 注意
1687
+ - 目前取0值时,表示UTF-8编码
1682
1688
  - COS导入不支持此字段。
1683
1689
  注意:此字段可能返回 null,表示取不到有效值。
1684
1690
  */
1685
1691
  IsGBK?: number;
1686
1692
  /**
1687
1693
  * 是否为标准json。 0:否; 1:是。
1694
+
1695
+ - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
1688
1696
  注意:此字段可能返回 null,表示取不到有效值。
1689
1697
  */
1690
1698
  JsonStandard?: number;
1691
1699
  /**
1692
- * syslog传输协议,取值为tcp或者udp
1700
+ * syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
1693
1701
  注意:
1694
1702
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
1695
1703
  - COS导入不支持此字段。
@@ -1697,7 +1705,7 @@ export interface ExtractRuleInfo {
1697
1705
  */
1698
1706
  Protocol?: string;
1699
1707
  /**
1700
- * syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000
1708
+ * syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
1701
1709
  注意:
1702
1710
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
1703
1711
  - COS导入不支持此字段。
@@ -1708,6 +1716,7 @@ export interface ExtractRuleInfo {
1708
1716
  * rfc3164:指定系统日志采集使用RFC3164协议解析日志。
1709
1717
  rfc5424:指定系统日志采集使用RFC5424协议解析日志。
1710
1718
  auto:自动匹配rfc3164或者rfc5424其中一种协议。
1719
+ 只有在LogType为service_syslog时生效,其余类型无需填写。
1711
1720
  注意:
1712
1721
  - 该字段适用于:创建采集规则配置、修改采集规则配置
1713
1722
  - COS导入不支持此字段。
@@ -1736,9 +1745,7 @@ export interface ExtractRuleInfo {
1736
1745
  */
1737
1746
  MetaTags?: Array<MetaTagInfo>;
1738
1747
  /**
1739
- * Windows事件日志采集。
1740
- 注意:
1741
- - COS导入不支持此字段。
1748
+ * Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
1742
1749
  */
1743
1750
  EventLogRules?: Array<EventLog>;
1744
1751
  }
@@ -3729,7 +3736,7 @@ export interface DescribeMachineGroupsResponse {
3729
3736
  */
3730
3737
  export interface DeleteConfigExtraRequest {
3731
3738
  /**
3732
- * 采集规则扩展配置ID
3739
+ * 特殊采集规则扩展配置ID
3733
3740
  */
3734
3741
  ConfigExtraId: string;
3735
3742
  }
@@ -3967,19 +3974,21 @@ export interface DeleteAlarmResponse {
3967
3974
  */
3968
3975
  export interface WebCallback {
3969
3976
  /**
3970
- * 回调地址。
3977
+ * 回调地址。最大支持1024个字节数。
3971
3978
  */
3972
3979
  Url: string;
3973
3980
  /**
3974
3981
  * 回调的类型。可选值:
3975
- <li> WeCom
3976
- <li> Http
3982
+ - WeCom
3983
+ - Http
3984
+ - DingTalk
3985
+ - Lark
3977
3986
  */
3978
3987
  CallbackType: string;
3979
3988
  /**
3980
3989
  * 回调方法。可选值:
3981
- <li> POST
3982
- <li> PUT
3990
+ - POST
3991
+ - PUT
3983
3992
  默认值为POST。CallbackType为Http时为必选。
3984
3993
  注意:此字段可能返回 null,表示取不到有效值。
3985
3994
  */
@@ -3997,7 +4006,9 @@ export interface WebCallback {
3997
4006
  */
3998
4007
  Body?: string;
3999
4008
  /**
4000
- * 序号
4009
+ * 序号。
4010
+ - 入参无效。
4011
+ - 出参有效。
4001
4012
  */
4002
4013
  Index?: number;
4003
4014
  }
@@ -4053,7 +4064,7 @@ export interface CreateConfigRequest {
4053
4064
  */
4054
4065
  Output: string;
4055
4066
  /**
4056
- * 日志采集路径,包含文件名
4067
+ * 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
4057
4068
  */
4058
4069
  Path?: string;
4059
4070
  /**
@@ -5721,21 +5732,23 @@ export declare type DeleteDashboardSubscribeRequest = null;
5721
5732
  export interface NoticeReceiver {
5722
5733
  /**
5723
5734
  * 接受者类型。可选值:
5724
- <br><li> Uin - 用户ID
5725
- <br><li> Group - 用户组ID
5735
+ - Uin - 用户ID
5736
+ - Group - 用户组ID
5726
5737
  暂不支持其余接收者类型。
5727
5738
  */
5728
5739
  ReceiverType: string;
5729
5740
  /**
5730
5741
  * 接收者。
5742
+ 当ReceiverType为Uin时,ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)
5743
+ 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
5731
5744
  */
5732
5745
  ReceiverIds: Array<number | bigint>;
5733
5746
  /**
5734
5747
  * 通知接收渠道。
5735
- <br><li> Email - 邮件
5736
- <br><li> Sms - 短信
5737
- <br><li> WeChat - 微信
5738
- <br><li> Phone - 电话
5748
+ - Email - 邮件
5749
+ - Sms - 短信
5750
+ - WeChat - 微信
5751
+ - Phone - 电话
5739
5752
  */
5740
5753
  ReceiverChannels: Array<string>;
5741
5754
  /**
@@ -5747,7 +5760,10 @@ export interface NoticeReceiver {
5747
5760
  */
5748
5761
  EndTime?: string;
5749
5762
  /**
5750
- * 位序
5763
+ * 位序。
5764
+
5765
+ - 入参无效。
5766
+ - 出参时有效。
5751
5767
  */
5752
5768
  Index?: number;
5753
5769
  }
@@ -6297,7 +6313,27 @@ export interface CsvInfo {
6297
6313
  */
6298
6314
  export interface DescribeConfigExtrasRequest {
6299
6315
  /**
6300
- * 支持的key: topicId,name, configExtraId, machineGroupId
6316
+ * name
6317
+ - 按照【特殊采集配置名称】进行模糊匹配过滤。
6318
+ - 类型:String
6319
+ - 必选:否
6320
+
6321
+ configExtraId
6322
+ - 按照【特殊采集配置ID】进行过滤。
6323
+ - 类型:String
6324
+ - 必选:否
6325
+
6326
+ topicId
6327
+ - 按照【日志主题】进行过滤。
6328
+ - 类型:String
6329
+ - 必选:否
6330
+
6331
+ machineGroupId
6332
+ - 按照【机器组ID】进行过滤。
6333
+ - 类型:String
6334
+ - 必选:否
6335
+
6336
+ 每次请求的Filters的上限为10,Filter.Values的上限为5。
6301
6337
  */
6302
6338
  Filters?: Array<Filter>;
6303
6339
  /**
@@ -6319,25 +6355,35 @@ export interface CreateAlarmNoticeRequest {
6319
6355
  Name: string;
6320
6356
  /**
6321
6357
  * 通知类型。可选值:
6322
- <li> Trigger - 告警触发 </li>
6323
- <li> Recovery - 告警恢复</li>
6324
- <li> All - 告警触发和告警恢复</li>
6358
+ - Trigger - 告警触发
6359
+ - Recovery - 告警恢复
6360
+ - All - 告警触发和告警恢复
6361
+
6362
+
6363
+ 注意:
6364
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6365
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6325
6366
  */
6326
6367
  Type?: string;
6327
6368
  /**
6328
6369
  * 通知接收对象。
6370
+ 注意:
6371
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6372
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6329
6373
  */
6330
6374
  NoticeReceivers?: Array<NoticeReceiver>;
6331
6375
  /**
6332
6376
  * 接口回调信息(包括企业微信)。
6377
+ 注意:
6378
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6379
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6333
6380
  */
6334
6381
  WebCallbacks?: Array<WebCallback>;
6335
6382
  /**
6336
6383
  * 通知规则。
6337
-
6338
6384
  注意:
6339
-
6340
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。
6385
+ - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6386
+ - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6341
6387
 
6342
6388
 
6343
6389
  */