tencentcloud-sdk-nodejs 4.0.846 → 4.0.848

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 (119) hide show
  1. package/CHANGELOG.md +409 -0
  2. package/SERVICE_CHANGELOG.md +490 -11
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/bma/index.ts +2 -2
  7. package/src/services/btoe/index.ts +2 -2
  8. package/src/services/cdb/v20170320/cdb_client.ts +38 -2
  9. package/src/services/cdb/v20170320/cdb_models.ts +128 -40
  10. package/src/services/cdn/v20180606/cdn_client.ts +1 -1
  11. package/src/services/clb/v20180317/clb_models.ts +8 -0
  12. package/src/services/cls/v20201016/cls_models.ts +251 -54
  13. package/src/services/csip/v20221121/csip_models.ts +68 -0
  14. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  15. package/src/services/cwp/v20180228/cwp_client.ts +1 -15
  16. package/src/services/cwp/v20180228/cwp_models.ts +20 -104
  17. package/src/services/cynosdb/v20190107/cynosdb_models.ts +1 -1
  18. package/src/services/dbbrain/index.ts +2 -2
  19. package/src/services/dts/index.ts +2 -2
  20. package/src/services/eis/index.ts +2 -2
  21. package/src/services/ess/v20201111/ess_models.ts +4 -0
  22. package/src/services/essbasic/index.ts +2 -2
  23. package/src/services/essbasic/v20210526/essbasic_models.ts +10 -1
  24. package/src/services/facefusion/index.ts +2 -2
  25. package/src/services/hunyuan/v20230901/hunyuan_models.ts +2 -2
  26. package/src/services/iotcloud/index.ts +2 -2
  27. package/src/services/iotvideo/index.ts +2 -2
  28. package/src/services/mgobe/index.ts +2 -2
  29. package/src/services/monitor/v20180724/monitor_models.ts +36 -36
  30. package/src/services/ocr/v20181119/ocr_client.ts +2 -4
  31. package/src/services/organization/index.ts +2 -2
  32. package/src/services/rum/v20210622/rum_models.ts +19 -19
  33. package/src/services/sms/index.ts +2 -2
  34. package/src/services/ssl/v20191205/ssl_models.ts +2 -2
  35. package/src/services/tbp/index.ts +2 -2
  36. package/src/services/tdmq/v20200217/tdmq_models.ts +56 -1
  37. package/src/services/teo/index.ts +2 -2
  38. package/src/services/teo/v20220901/teo_client.ts +17 -2
  39. package/src/services/teo/v20220901/teo_models.ts +31 -1
  40. package/src/services/tke/index.ts +2 -2
  41. package/src/services/trtc/v20190722/trtc_client.ts +3 -3
  42. package/src/services/trtc/v20190722/trtc_models.ts +15 -5
  43. package/src/services/tsf/v20180326/tsf_models.ts +54 -37
  44. package/src/services/vpc/v20170312/vpc_client.ts +2 -2
  45. package/src/services/vpc/v20170312/vpc_models.ts +18 -13
  46. package/src/services/wedata/v20210820/wedata_client.ts +12 -8
  47. package/src/services/wedata/v20210820/wedata_models.ts +341 -104
  48. package/src/services/yunsou/index.ts +2 -2
  49. package/tencentcloud/common/sdk_version.d.ts +1 -1
  50. package/tencentcloud/common/sdk_version.js +1 -1
  51. package/tencentcloud/services/bma/index.d.ts +4 -4
  52. package/tencentcloud/services/bma/index.js +2 -2
  53. package/tencentcloud/services/btoe/index.d.ts +4 -4
  54. package/tencentcloud/services/btoe/index.js +2 -2
  55. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +13 -1
  56. package/tencentcloud/services/cdb/v20170320/cdb_client.js +18 -0
  57. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +122 -40
  58. package/tencentcloud/services/cdn/v20180606/cdn_client.d.ts +1 -1
  59. package/tencentcloud/services/cdn/v20180606/cdn_client.js +1 -1
  60. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +8 -0
  61. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +251 -54
  62. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +68 -0
  63. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  64. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +1 -7
  65. package/tencentcloud/services/cwp/v20180228/cwp_client.js +0 -8
  66. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +20 -102
  67. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +1 -1
  68. package/tencentcloud/services/dbbrain/index.d.ts +4 -4
  69. package/tencentcloud/services/dbbrain/index.js +2 -2
  70. package/tencentcloud/services/dts/index.d.ts +4 -4
  71. package/tencentcloud/services/dts/index.js +2 -2
  72. package/tencentcloud/services/eis/index.d.ts +4 -4
  73. package/tencentcloud/services/eis/index.js +2 -2
  74. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +4 -0
  75. package/tencentcloud/services/essbasic/index.d.ts +4 -4
  76. package/tencentcloud/services/essbasic/index.js +2 -2
  77. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +10 -1
  78. package/tencentcloud/services/facefusion/index.d.ts +4 -4
  79. package/tencentcloud/services/facefusion/index.js +2 -2
  80. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +2 -2
  81. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  82. package/tencentcloud/services/iotcloud/index.js +2 -2
  83. package/tencentcloud/services/iotvideo/index.d.ts +4 -4
  84. package/tencentcloud/services/iotvideo/index.js +2 -2
  85. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  86. package/tencentcloud/services/mgobe/index.js +2 -2
  87. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +36 -36
  88. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +0 -2
  89. package/tencentcloud/services/ocr/v20181119/ocr_client.js +0 -2
  90. package/tencentcloud/services/organization/index.d.ts +4 -4
  91. package/tencentcloud/services/organization/index.js +2 -2
  92. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +19 -19
  93. package/tencentcloud/services/sms/index.d.ts +4 -4
  94. package/tencentcloud/services/sms/index.js +2 -2
  95. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +2 -2
  96. package/tencentcloud/services/tbp/index.d.ts +4 -4
  97. package/tencentcloud/services/tbp/index.js +2 -2
  98. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +56 -1
  99. package/tencentcloud/services/teo/index.d.ts +4 -4
  100. package/tencentcloud/services/teo/index.js +2 -2
  101. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +9 -2
  102. package/tencentcloud/services/teo/v20220901/teo_client.js +10 -1
  103. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +29 -1
  104. package/tencentcloud/services/tke/index.d.ts +4 -4
  105. package/tencentcloud/services/tke/index.js +2 -2
  106. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +3 -3
  107. package/tencentcloud/services/trtc/v20190722/trtc_client.js +3 -3
  108. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +15 -5
  109. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +54 -37
  110. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +2 -2
  111. package/tencentcloud/services/vpc/v20170312/vpc_client.js +2 -2
  112. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +18 -13
  113. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +1 -1
  114. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +335 -102
  115. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  116. package/tencentcloud/services/yunsou/index.js +2 -2
  117. package/test/cdb.v20170320.test.js +30 -0
  118. package/test/cwp.v20180228.test.js +0 -10
  119. package/test/teo.v20220901.test.js +10 -0
@@ -1135,7 +1135,12 @@ export interface ModifyDataTransformRequest {
1135
1135
  */
1136
1136
  Name?: string;
1137
1137
  /**
1138
- * 加工语句
1138
+ * 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
1139
+
1140
+ 其他参考文档:
1141
+
1142
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
1143
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
1139
1144
  */
1140
1145
  EtlContent?: string;
1141
1146
  /**
@@ -1391,7 +1396,111 @@ export interface NoticeRule {
1391
1396
  */
1392
1397
  WebCallbacks?: Array<WebCallback>;
1393
1398
  /**
1394
- * 匹配规则。
1399
+ * 匹配规则 JSON串。
1400
+ **rule格式为如下嵌套结构体JSON字符串**
1401
+ ```
1402
+ {
1403
+ "Value": "AND",
1404
+ "Type": "Operation",
1405
+ "Children": [
1406
+ {
1407
+ "Value": "OR",
1408
+ "Type": "Operation",
1409
+ "Children": [
1410
+ {
1411
+ "Type": "Condition",
1412
+ "Value": "Level",
1413
+ "Children": [
1414
+ {
1415
+ "Value": "In",
1416
+ "Type": "Compare"
1417
+ },
1418
+ {
1419
+ "Value": "[1,0]",
1420
+ "Type": "Value"
1421
+ }
1422
+ ]
1423
+ },
1424
+ {
1425
+ "Type": "Condition",
1426
+ "Value": "Level",
1427
+ "Children": [
1428
+ {
1429
+ "Value": "NotIn",
1430
+ "Type": "Compare"
1431
+ },
1432
+ {
1433
+ "Value": "[2]",
1434
+ "Type": "Value"
1435
+ }
1436
+ ]
1437
+ }
1438
+ ]
1439
+ }
1440
+ ]
1441
+ }
1442
+ ```
1443
+ **rule规则树限制规则如下**:
1444
+ - 顶层rule中Type可取值:`Condition`,`Operation`
1445
+ - Type为`Operation`的子节点支持的Type可取值:`Condition`,`Operation`
1446
+ - Type为`Condition`的子节点支持的Type可取值:`String`,`Compare`,`Array`,`TimeRange`,`Value`,`Key`
1447
+ - 其他Type无子节点
1448
+ - 当rule Type为`Operation`时,value可取值:`AND`,`OR`
1449
+ - 当rule Type为`Condition`时,value不可为空,子节点个数不能小于2
1450
+ - 当子节点Type为 `Compare` 时,value可取值:`>`,`<`,`>=`,`<=`,`=`,`!=`,`Between`,`NotBetween`,`=~`,`!=~`,`In`,`NotIn`
1451
+ - value为`Between`,`NotBetween`时,下一个子节点value必须是长度为2的数组
1452
+ - value为`=~`,`!=~`时,下一个子节点value必须是一个正则表达式
1453
+ - value为`In`,`NotIn`时, 下一个子节点value必须是一个数组
1454
+
1455
+ **业务参数含义**:
1456
+ - Type:Condition 表示是规则条件,Value:Level 表示告警等级
1457
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
1458
+ - 下一个子节点value支持的值:0(警告),1(提醒),2 (紧急)
1459
+ 以下示例表示:告警等级属于提醒
1460
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]}]}
1461
+ `
1462
+
1463
+ - Type:Condition 表示是规则条件,Value:NotifyType 表示通知类型
1464
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
1465
+ - 下一个子节点value支持的值:1(告警通知),2 (恢复通知)
1466
+ 以下示例表示:通知类型属于告警通知或通知类型不属于恢复通知
1467
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[2]\",\"Type\":\"Value\"}]}]}]}
1468
+ `
1469
+
1470
+ - Type:Condition 表示是规则条件,Value:AlarmID 表示告警策略
1471
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
1472
+ - 下一个子节点value支持的值:告警策略id数组
1473
+ 以下示例表示:告警策略属于alarm-53af048c-254b-4c73-bb48-xxx,alarm-6dfa8bc5-08da-4d64-b6cb-xxx或告警策略不属于alarm-1036314c-1e49-4cee-a8fb-xxx
1474
+ `"{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-53af048c-254b-4c73-bb48-xxx\\\",\\\"alarm-6dfa8bc5-08da-4d64-b6cb-xxx\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmID\",\"Children\":[{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"alarm-1036314c-1e49-4cee-a8fb-xxx\\\"]\",\"Type\":\"Value\"}]}]}]}"
1475
+ `
1476
+
1477
+ - Type:Condition 表示是规则条件,Value:AlarmName 表示告警策略名称
1478
+ - 子节点Type支持`Compare`,Value支持`=~`,`!=~`
1479
+ - 下一个子节点value支持的值:必须是正则表达式
1480
+ 以下示例表示:告警策略名称正则匹配^test$或告警策略名称正则不匹配^hahaha$
1481
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"AlarmName\",\"Children\":[{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}
1482
+ `
1483
+
1484
+ - Type:Condition 表示是规则条件,Value:Label 表示告警分类字段
1485
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`,`=~`,`!=~`
1486
+ - 下一个子节点value支持的值:`In`,`NotIn` 时value是数组,`=~`,`!=~`时value是正则表达式
1487
+ 以下示例表示:告警分类字段key1属于v1或告警分类字段key2不属于v2或告警分类字段key3正则匹配^test$或告警分类字段key4正则不匹配^hahaha$
1488
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key1\",\"Type\":\"Key\"},{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v1\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key2\",\"Type\":\"Key\"},{\"Value\":\"NotIn\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"v2\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key3\",\"Type\":\"Key\"},{\"Value\":\"=~\",\"Type\":\"Compare\"},{\"Value\":\"^test$\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Label\",\"Children\":[{\"Value\":\"key4\",\"Type\":\"Key\"},{\"Value\":\"!=~\",\"Type\":\"Compare\"},{\"Value\":\"^hahaha$\",\"Type\":\"Value\"}]}]}]}
1489
+ `
1490
+
1491
+ - Type:Condition 表示是规则条件,Value:NotifyTime 表示通知时间
1492
+ - 子节点Type支持`Compare`,Value支持`Between `,`NotBetween `
1493
+ - 下一个子节点value支持的值:长度为2,格式为`14:20:36`的字符串数组
1494
+ 以下示例表示:通知时间在指定范围内14:18:36至14:33:36或通知时间不在指定范围内14:20:36至14:30:36
1495
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"Between\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:18:36\\\",\\\"14:33:36\\\"]\",\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"NotifyTime\",\"Children\":[{\"Value\":\"NotBetween\",\"Type\":\"Compare\"},{\"Value\":\"[\\\"14:20:36\\\",\\\"14:30:36\\\"]\",\"Type\":\"Value\"}]}]}]}
1496
+ `
1497
+
1498
+ - Type:Condition 表示是规则条件,Value:Duration 表示告警持续时间
1499
+ - 子节点Type支持`Compare`,Value支持`>`,`<`,`>=`,`<=`
1500
+ - 下一个子节点value支持的值:整型值单位分钟
1501
+ 以下示例表示:告警持续时间大于1分钟或告警持续时间大于等于2分钟或告警持续时间小于3分钟或告警持续时间小于等于4分钟
1502
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Value\":\"OR\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">\",\"Type\":\"Compare\"},{\"Value\":1,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\">=\",\"Type\":\"Compare\"},{\"Value\":2,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<\",\"Type\":\"Compare\"},{\"Value\":3,\"Type\":\"Value\"}]},{\"Type\":\"Condition\",\"Value\":\"Duration\",\"Children\":[{\"Value\":\"<=\",\"Type\":\"Compare\"},{\"Value\":4,\"Type\":\"Value\"}]}]}]}
1503
+ `
1395
1504
  注意:此字段可能返回 null,表示取不到有效值。
1396
1505
  */
1397
1506
  Rule?: string;
@@ -1536,6 +1645,11 @@ export interface ScheduledSqlTaskInfo {
1536
1645
  注意:此字段可能返回 null,表示取不到有效值。
1537
1646
  */
1538
1647
  SyntaxRule?: number;
1648
+ /**
1649
+ * 是否开启投递服务日志。1:关闭,2:开启。
1650
+ 注意:此字段可能返回 null,表示取不到有效值。
1651
+ */
1652
+ HasServicesLog?: number;
1539
1653
  }
1540
1654
  /**
1541
1655
  * DescribeConfigMachineGroups请求参数结构体
@@ -1665,7 +1779,7 @@ export interface ExtractRuleInfo {
1665
1779
  */
1666
1780
  UnMatchUpLoadSwitch?: boolean;
1667
1781
  /**
1668
- * 失败日志的key
1782
+ * 失败日志的key,当UnMatchUpLoadSwitch为true时必填
1669
1783
  注意:此字段可能返回 null,表示取不到有效值。
1670
1784
  */
1671
1785
  UnMatchLogKey?: string;
@@ -1678,18 +1792,20 @@ export interface ExtractRuleInfo {
1678
1792
  Backtracking?: number;
1679
1793
  /**
1680
1794
  * 是否为Gbk编码。 0:否;1:是。
1681
- 注意:
1795
+ 注意
1796
+ - 目前取0值时,表示UTF-8编码
1682
1797
  - COS导入不支持此字段。
1683
1798
  注意:此字段可能返回 null,表示取不到有效值。
1684
1799
  */
1685
1800
  IsGBK?: number;
1686
1801
  /**
1687
1802
  * 是否为标准json。 0:否; 1:是。
1803
+ - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
1688
1804
  注意:此字段可能返回 null,表示取不到有效值。
1689
1805
  */
1690
1806
  JsonStandard?: number;
1691
1807
  /**
1692
- * syslog传输协议,取值为tcp或者udp
1808
+ * syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
1693
1809
  注意:
1694
1810
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
1695
1811
  - COS导入不支持此字段。
@@ -1697,7 +1813,7 @@ export interface ExtractRuleInfo {
1697
1813
  */
1698
1814
  Protocol?: string;
1699
1815
  /**
1700
- * syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000
1816
+ * syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
1701
1817
  注意:
1702
1818
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
1703
1819
  - COS导入不支持此字段。
@@ -1708,6 +1824,7 @@ export interface ExtractRuleInfo {
1708
1824
  * rfc3164:指定系统日志采集使用RFC3164协议解析日志。
1709
1825
  rfc5424:指定系统日志采集使用RFC5424协议解析日志。
1710
1826
  auto:自动匹配rfc3164或者rfc5424其中一种协议。
1827
+ 只有在LogType为service_syslog时生效,其余类型无需填写。
1711
1828
  注意:
1712
1829
  - 该字段适用于:创建采集规则配置、修改采集规则配置
1713
1830
  - COS导入不支持此字段。
@@ -1736,9 +1853,7 @@ export interface ExtractRuleInfo {
1736
1853
  */
1737
1854
  MetaTags?: Array<MetaTagInfo>;
1738
1855
  /**
1739
- * Windows事件日志采集。
1740
- 注意:
1741
- - COS导入不支持此字段。
1856
+ * Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
1742
1857
  */
1743
1858
  EventLogRules?: Array<EventLog>;
1744
1859
  }
@@ -3729,7 +3844,7 @@ export interface DescribeMachineGroupsResponse {
3729
3844
  */
3730
3845
  export interface DeleteConfigExtraRequest {
3731
3846
  /**
3732
- * 采集规则扩展配置ID
3847
+ * 特殊采集规则扩展配置ID
3733
3848
  */
3734
3849
  ConfigExtraId: string;
3735
3850
  }
@@ -3967,20 +4082,24 @@ export interface DeleteAlarmResponse {
3967
4082
  */
3968
4083
  export interface WebCallback {
3969
4084
  /**
3970
- * 回调地址。
4085
+ * 回调地址。最大支持1024个字节数。
3971
4086
  */
3972
4087
  Url: string;
3973
4088
  /**
3974
4089
  * 回调的类型。可选值:
3975
- <li> WeCom
3976
- <li> Http
4090
+ - WeCom
4091
+ - Http
4092
+ - DingTalk
4093
+ - Lark
3977
4094
  */
3978
4095
  CallbackType: string;
3979
4096
  /**
3980
4097
  * 回调方法。可选值:
3981
- <li> POST
3982
- <li> PUT
3983
- 默认值为POST。CallbackType为Http时为必选。
4098
+ - POST(默认值)
4099
+ - PUT
4100
+
4101
+ 注意:
4102
+ - 参数CallbackType为Http时为必选。
3984
4103
  注意:此字段可能返回 null,表示取不到有效值。
3985
4104
  */
3986
4105
  Method?: string;
@@ -3997,7 +4116,9 @@ export interface WebCallback {
3997
4116
  */
3998
4117
  Body?: string;
3999
4118
  /**
4000
- * 序号
4119
+ * 序号。
4120
+ - 入参无效。
4121
+ - 出参有效。
4001
4122
  */
4002
4123
  Index?: number;
4003
4124
  }
@@ -4053,7 +4174,7 @@ export interface CreateConfigRequest {
4053
4174
  */
4054
4175
  Output: string;
4055
4176
  /**
4056
- * 日志采集路径,包含文件名
4177
+ * 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
4057
4178
  */
4058
4179
  Path?: string;
4059
4180
  /**
@@ -4178,7 +4299,7 @@ export interface PreviewLogStatistic {
4178
4299
  */
4179
4300
  LogContent: string;
4180
4301
  /**
4181
- * 行号
4302
+ * 行号。从0开始
4182
4303
  */
4183
4304
  LineNum: number;
4184
4305
  /**
@@ -4186,16 +4307,20 @@ export interface PreviewLogStatistic {
4186
4307
  */
4187
4308
  DstTopicId?: string;
4188
4309
  /**
4189
- * 失败错误码, 空字符串""表示正常
4310
+ * 失败错误信息, 空字符串""表示正常
4190
4311
  */
4191
4312
  FailReason?: string;
4192
4313
  /**
4193
- * 日志时间戳
4314
+ * 日志时间,格式:`2024-05-07 17:13:17.105`
4315
+
4316
+ - 入参时无效
4317
+ - 出参时有效,为日志中的时间格式
4194
4318
  */
4195
4319
  Time?: string;
4196
4320
  /**
4197
4321
  * 目标topic-name
4198
4322
  注意:此字段可能返回 null,表示取不到有效值。
4323
+ * @deprecated
4199
4324
  */
4200
4325
  DstTopicName?: string;
4201
4326
  }
@@ -4911,15 +5036,24 @@ export interface CreateConfigExtraRequest {
4911
5036
  */
4912
5037
  TopicId: string;
4913
5038
  /**
4914
- * 类型:container_stdoutcontainer_filehost_file
5039
+ * 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。
4915
5040
  */
4916
5041
  Type: string;
4917
5042
  /**
4918
- * 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
5043
+ * 采集的日志类型,默认为minimalist_log。支持以下类型:
5044
+ - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
5045
+ - delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
5046
+ - minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
5047
+ - fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
5048
+ - multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
5049
+ - multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
5050
+ - user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
4919
5051
  */
4920
5052
  LogType: string;
4921
5053
  /**
4922
- * 采集配置标
5054
+ * 采集配置标记。
5055
+ - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
5056
+
4923
5057
  */
4924
5058
  ConfigFlag: string;
4925
5059
  /**
@@ -4935,19 +5069,21 @@ export interface CreateConfigExtraRequest {
4935
5069
  */
4936
5070
  TopicName: string;
4937
5071
  /**
4938
- * 节点文件配置信息
5072
+ * 节点文件路径类型配置。
4939
5073
  */
4940
5074
  HostFile?: HostFileInfo;
4941
5075
  /**
4942
- * 容器文件路径信息
5076
+ * 容器文件路径类型配置。
4943
5077
  */
4944
5078
  ContainerFile?: ContainerFileInfo;
4945
5079
  /**
4946
- * 容器标准输出信息
5080
+ * 容器标准输出类型配置。
4947
5081
  */
4948
5082
  ContainerStdout?: ContainerStdoutInfo;
4949
5083
  /**
4950
- * 日志格式化方式
5084
+ * 日志格式化方式,用于容器采集场景。
5085
+ - stdout-docker-json:用于docker容器采集场景
5086
+ - stdout-containerd:用于containerd容器采集场景
4951
5087
  */
4952
5088
  LogFormat?: string;
4953
5089
  /**
@@ -4959,7 +5095,9 @@ export interface CreateConfigExtraRequest {
4959
5095
  */
4960
5096
  ExcludePaths?: Array<ExcludePathInfo>;
4961
5097
  /**
4962
- * 用户自定义采集规则,Json格式序列化的字符串
5098
+ * 组合解析采集规则,用于复杂场景下的日志采集。
5099
+ - 取值参考:[使用组合解析提取模式采集日志
5100
+ ](https://cloud.tencent.com/document/product/614/61310)
4963
5101
  */
4964
5102
  UserDefineRule?: string;
4965
5103
  /**
@@ -4979,7 +5117,8 @@ export interface CreateConfigExtraRequest {
4979
5117
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
4980
5118
  - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
4981
5119
  - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
4982
- 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
5120
+ - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
5121
+
4983
5122
  */
4984
5123
  AdvancedConfig?: string;
4985
5124
  }
@@ -5721,33 +5860,38 @@ export declare type DeleteDashboardSubscribeRequest = null;
5721
5860
  export interface NoticeReceiver {
5722
5861
  /**
5723
5862
  * 接受者类型。可选值:
5724
- <br><li> Uin - 用户ID
5725
- <br><li> Group - 用户组ID
5863
+ - Uin - 用户ID
5864
+ - Group - 用户组ID
5726
5865
  暂不支持其余接收者类型。
5727
5866
  */
5728
5867
  ReceiverType: string;
5729
5868
  /**
5730
5869
  * 接收者。
5870
+ 当ReceiverType为Uin时,ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)
5871
+ 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
5731
5872
  */
5732
5873
  ReceiverIds: Array<number | bigint>;
5733
5874
  /**
5734
5875
  * 通知接收渠道。
5735
- <br><li> Email - 邮件
5736
- <br><li> Sms - 短信
5737
- <br><li> WeChat - 微信
5738
- <br><li> Phone - 电话
5876
+ - Email - 邮件
5877
+ - Sms - 短信
5878
+ - WeChat - 微信
5879
+ - Phone - 电话
5739
5880
  */
5740
5881
  ReceiverChannels: Array<string>;
5741
5882
  /**
5742
- * 允许接收信息的开始时间。
5883
+ * 允许接收信息的开始时间。格式:`15:04:05`,必填。
5743
5884
  */
5744
5885
  StartTime?: string;
5745
5886
  /**
5746
- * 允许接收信息的结束时间。
5887
+ * 允许接收信息的结束时间。格式:`15:04:05`,必填。
5747
5888
  */
5748
5889
  EndTime?: string;
5749
5890
  /**
5750
- * 位序
5891
+ * 位序。
5892
+
5893
+ - 入参时无效。
5894
+ - 出参时有效。
5751
5895
  */
5752
5896
  Index?: number;
5753
5897
  }
@@ -6085,7 +6229,9 @@ export interface CreateMachineGroupRequest {
6085
6229
  */
6086
6230
  GroupName: string;
6087
6231
  /**
6088
- * 创建机器组类型。Type:ip,Values中为ip字符串列表创建机器组;Type:label,Values中为标签字符串列表创建机器组。
6232
+ * 创建机器组类型。取值如下:
6233
+ - Type:ip,Values中为ip字符串列表创建机器组
6234
+ - Type:label,Values中为标签字符串列表创建机器组
6089
6235
  */
6090
6236
  MachineGroupType: MachineGroupTypeInfo;
6091
6237
  /**
@@ -6117,7 +6263,9 @@ export interface CreateMachineGroupRequest {
6117
6263
  */
6118
6264
  MetaTags?: Array<MetaTagInfo>;
6119
6265
  /**
6120
- * 系统类型,默认0,0:Linux,1: Windows
6266
+ * 系统类型,取值如下:
6267
+ - 0:Linux (默认值)
6268
+ - 1:Windows
6121
6269
  */
6122
6270
  OSType?: number;
6123
6271
  }
@@ -6297,7 +6445,24 @@ export interface CsvInfo {
6297
6445
  */
6298
6446
  export interface DescribeConfigExtrasRequest {
6299
6447
  /**
6300
- * 支持的key: topicId,name, configExtraId, machineGroupId
6448
+ * 过滤器,支持如下选项:
6449
+ name
6450
+ - 按照【特殊采集配置名称】进行模糊匹配过滤。
6451
+ - 类型:String
6452
+
6453
+ configExtraId
6454
+ - 按照【特殊采集配置ID】进行过滤。
6455
+ - 类型:String
6456
+
6457
+ topicId
6458
+ - 按照【日志主题】进行过滤。
6459
+ - 类型:String
6460
+
6461
+ machineGroupId
6462
+ - 按照【机器组ID】进行过滤。
6463
+ - 类型:String
6464
+
6465
+ 每次请求的Filters的上限为10,Filter.Values的上限为5。
6301
6466
  */
6302
6467
  Filters?: Array<Filter>;
6303
6468
  /**
@@ -6319,25 +6484,39 @@ export interface CreateAlarmNoticeRequest {
6319
6484
  Name: string;
6320
6485
  /**
6321
6486
  * 通知类型。可选值:
6322
- <li> Trigger - 告警触发 </li>
6323
- <li> Recovery - 告警恢复</li>
6324
- <li> All - 告警触发和告警恢复</li>
6487
+ - Trigger - 告警触发
6488
+ - Recovery - 告警恢复
6489
+ - All - 告警触发和告警恢复
6490
+
6491
+
6492
+ 注意:
6493
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6494
+ - 2组rule配置互斥
6495
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6325
6496
  */
6326
6497
  Type?: string;
6327
6498
  /**
6328
6499
  * 通知接收对象。
6500
+ 注意:
6501
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6502
+ - 2组rule配置互斥
6503
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6329
6504
  */
6330
6505
  NoticeReceivers?: Array<NoticeReceiver>;
6331
6506
  /**
6332
6507
  * 接口回调信息(包括企业微信)。
6508
+ 注意:
6509
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6510
+ - 2组rule配置互斥
6511
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6333
6512
  */
6334
6513
  WebCallbacks?: Array<WebCallback>;
6335
6514
  /**
6336
6515
  * 通知规则。
6337
-
6338
6516
  注意:
6339
-
6340
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。
6517
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6518
+ - 2组rule配置互斥
6519
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6341
6520
 
6342
6521
 
6343
6522
  */
@@ -6427,7 +6606,8 @@ export interface ModifyConfigExtraRequest {
6427
6606
  */
6428
6607
  HostFile?: HostFileInfo;
6429
6608
  /**
6430
- * 容器文件路径信息
6609
+ * 采集配置标记。
6610
+ - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
6431
6611
  */
6432
6612
  ContainerFile?: ContainerFileInfo;
6433
6613
  /**
@@ -6435,11 +6615,20 @@ export interface ModifyConfigExtraRequest {
6435
6615
  */
6436
6616
  ContainerStdout?: ContainerStdoutInfo;
6437
6617
  /**
6438
- * 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
6618
+ * 采集的日志类型,默认为minimalist_log。支持以下类型:
6619
+ - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
6620
+ - delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
6621
+ - minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
6622
+ - fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
6623
+ - multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
6624
+ - multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
6625
+ - user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
6439
6626
  */
6440
6627
  LogType?: string;
6441
6628
  /**
6442
- * 日志格式化方式
6629
+ * 日志格式化方式,用于容器采集场景。
6630
+ - stdout-docker-json:用于docker容器采集场景
6631
+ - stdout-containerd:用于containerd容器采集场景
6443
6632
  */
6444
6633
  LogFormat?: string;
6445
6634
  /**
@@ -6451,7 +6640,9 @@ export interface ModifyConfigExtraRequest {
6451
6640
  */
6452
6641
  ExcludePaths?: Array<ExcludePathInfo>;
6453
6642
  /**
6454
- * 用户自定义采集规则,Json格式序列化的字符串
6643
+ * 组合解析采集规则,用于复杂场景下的日志采集。
6644
+ - 取值参考:[使用组合解析提取模式采集日志
6645
+ ](https://cloud.tencent.com/document/product/614/61310)
6455
6646
  */
6456
6647
  UserDefineRule?: string;
6457
6648
  /**
@@ -6483,7 +6674,8 @@ export interface ModifyConfigExtraRequest {
6483
6674
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
6484
6675
  - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
6485
6676
  - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
6486
- 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
6677
+ - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
6678
+
6487
6679
  */
6488
6680
  AdvancedConfig?: string;
6489
6681
  }
@@ -6557,7 +6749,12 @@ export interface CreateDataTransformRequest {
6557
6749
  */
6558
6750
  Name: string;
6559
6751
  /**
6560
- * 加工语句。[创建加工任务](https://cloud.tencent.com/document/product/614/63940) [函数总览](https://cloud.tencent.com/document/product/614/70395)
6752
+ * 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
6753
+
6754
+ 其他参考文档:
6755
+
6756
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
6757
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
6561
6758
  */
6562
6759
  EtlContent: string;
6563
6760
  /**