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
@@ -1200,7 +1200,12 @@ export interface ModifyDataTransformRequest {
1200
1200
  */
1201
1201
  Name?: string
1202
1202
  /**
1203
- * 加工语句
1203
+ * 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
1204
+
1205
+ 其他参考文档:
1206
+
1207
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
1208
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
1204
1209
  */
1205
1210
  EtlContent?: string
1206
1211
  /**
@@ -1469,7 +1474,111 @@ export interface NoticeRule {
1469
1474
  */
1470
1475
  WebCallbacks?: Array<WebCallback>
1471
1476
  /**
1472
- * 匹配规则。
1477
+ * 匹配规则 JSON串。
1478
+ **rule格式为如下嵌套结构体JSON字符串**
1479
+ ```
1480
+ {
1481
+ "Value": "AND",
1482
+ "Type": "Operation",
1483
+ "Children": [
1484
+ {
1485
+ "Value": "OR",
1486
+ "Type": "Operation",
1487
+ "Children": [
1488
+ {
1489
+ "Type": "Condition",
1490
+ "Value": "Level",
1491
+ "Children": [
1492
+ {
1493
+ "Value": "In",
1494
+ "Type": "Compare"
1495
+ },
1496
+ {
1497
+ "Value": "[1,0]",
1498
+ "Type": "Value"
1499
+ }
1500
+ ]
1501
+ },
1502
+ {
1503
+ "Type": "Condition",
1504
+ "Value": "Level",
1505
+ "Children": [
1506
+ {
1507
+ "Value": "NotIn",
1508
+ "Type": "Compare"
1509
+ },
1510
+ {
1511
+ "Value": "[2]",
1512
+ "Type": "Value"
1513
+ }
1514
+ ]
1515
+ }
1516
+ ]
1517
+ }
1518
+ ]
1519
+ }
1520
+ ```
1521
+ **rule规则树限制规则如下**:
1522
+ - 顶层rule中Type可取值:`Condition`,`Operation`
1523
+ - Type为`Operation`的子节点支持的Type可取值:`Condition`,`Operation`
1524
+ - Type为`Condition`的子节点支持的Type可取值:`String`,`Compare`,`Array`,`TimeRange`,`Value`,`Key`
1525
+ - 其他Type无子节点
1526
+ - 当rule Type为`Operation`时,value可取值:`AND`,`OR`
1527
+ - 当rule Type为`Condition`时,value不可为空,子节点个数不能小于2
1528
+ - 当子节点Type为 `Compare` 时,value可取值:`>`,`<`,`>=`,`<=`,`=`,`!=`,`Between`,`NotBetween`,`=~`,`!=~`,`In`,`NotIn`
1529
+ - value为`Between`,`NotBetween`时,下一个子节点value必须是长度为2的数组
1530
+ - value为`=~`,`!=~`时,下一个子节点value必须是一个正则表达式
1531
+ - value为`In`,`NotIn`时, 下一个子节点value必须是一个数组
1532
+
1533
+ **业务参数含义**:
1534
+ - Type:Condition 表示是规则条件,Value:Level 表示告警等级
1535
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
1536
+ - 下一个子节点value支持的值:0(警告),1(提醒),2 (紧急)
1537
+ 以下示例表示:告警等级属于提醒
1538
+ `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"Level\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1]\",\"Type\":\"Value\"}]}]}
1539
+ `
1540
+
1541
+ - Type:Condition 表示是规则条件,Value:NotifyType 表示通知类型
1542
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
1543
+ - 下一个子节点value支持的值:1(告警通知),2 (恢复通知)
1544
+ 以下示例表示:通知类型属于告警通知或通知类型不属于恢复通知
1545
+ `{\"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\"}]}]}]}
1546
+ `
1547
+
1548
+ - Type:Condition 表示是规则条件,Value:AlarmID 表示告警策略
1549
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`
1550
+ - 下一个子节点value支持的值:告警策略id数组
1551
+ 以下示例表示:告警策略属于alarm-53af048c-254b-4c73-bb48-xxx,alarm-6dfa8bc5-08da-4d64-b6cb-xxx或告警策略不属于alarm-1036314c-1e49-4cee-a8fb-xxx
1552
+ `"{\"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\"}]}]}]}"
1553
+ `
1554
+
1555
+ - Type:Condition 表示是规则条件,Value:AlarmName 表示告警策略名称
1556
+ - 子节点Type支持`Compare`,Value支持`=~`,`!=~`
1557
+ - 下一个子节点value支持的值:必须是正则表达式
1558
+ 以下示例表示:告警策略名称正则匹配^test$或告警策略名称正则不匹配^hahaha$
1559
+ `{\"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\"}]}]}]}
1560
+ `
1561
+
1562
+ - Type:Condition 表示是规则条件,Value:Label 表示告警分类字段
1563
+ - 子节点Type支持`Compare`,Value支持`In`,`NotIn`,`=~`,`!=~`
1564
+ - 下一个子节点value支持的值:`In`,`NotIn` 时value是数组,`=~`,`!=~`时value是正则表达式
1565
+ 以下示例表示:告警分类字段key1属于v1或告警分类字段key2不属于v2或告警分类字段key3正则匹配^test$或告警分类字段key4正则不匹配^hahaha$
1566
+ `{\"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\"}]}]}]}
1567
+ `
1568
+
1569
+ - Type:Condition 表示是规则条件,Value:NotifyTime 表示通知时间
1570
+ - 子节点Type支持`Compare`,Value支持`Between `,`NotBetween `
1571
+ - 下一个子节点value支持的值:长度为2,格式为`14:20:36`的字符串数组
1572
+ 以下示例表示:通知时间在指定范围内14:18:36至14:33:36或通知时间不在指定范围内14:20:36至14:30:36
1573
+ `{\"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\"}]}]}]}
1574
+ `
1575
+
1576
+ - Type:Condition 表示是规则条件,Value:Duration 表示告警持续时间
1577
+ - 子节点Type支持`Compare`,Value支持`>`,`<`,`>=`,`<=`
1578
+ - 下一个子节点value支持的值:整型值单位分钟
1579
+ 以下示例表示:告警持续时间大于1分钟或告警持续时间大于等于2分钟或告警持续时间小于3分钟或告警持续时间小于等于4分钟
1580
+ `{\"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\"}]}]}]}
1581
+ `
1473
1582
  注意:此字段可能返回 null,表示取不到有效值。
1474
1583
  */
1475
1584
  Rule?: string
@@ -1617,6 +1726,11 @@ export interface ScheduledSqlTaskInfo {
1617
1726
  注意:此字段可能返回 null,表示取不到有效值。
1618
1727
  */
1619
1728
  SyntaxRule?: number
1729
+ /**
1730
+ * 是否开启投递服务日志。1:关闭,2:开启。
1731
+ 注意:此字段可能返回 null,表示取不到有效值。
1732
+ */
1733
+ HasServicesLog?: number
1620
1734
  }
1621
1735
 
1622
1736
  /**
@@ -1751,7 +1865,7 @@ export interface ExtractRuleInfo {
1751
1865
  */
1752
1866
  UnMatchUpLoadSwitch?: boolean
1753
1867
  /**
1754
- * 失败日志的key
1868
+ * 失败日志的key,当UnMatchUpLoadSwitch为true时必填
1755
1869
  注意:此字段可能返回 null,表示取不到有效值。
1756
1870
  */
1757
1871
  UnMatchLogKey?: string
@@ -1764,18 +1878,20 @@ export interface ExtractRuleInfo {
1764
1878
  Backtracking?: number
1765
1879
  /**
1766
1880
  * 是否为Gbk编码。 0:否;1:是。
1767
- 注意:
1881
+ 注意
1882
+ - 目前取0值时,表示UTF-8编码
1768
1883
  - COS导入不支持此字段。
1769
1884
  注意:此字段可能返回 null,表示取不到有效值。
1770
1885
  */
1771
1886
  IsGBK?: number
1772
1887
  /**
1773
1888
  * 是否为标准json。 0:否; 1:是。
1889
+ - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
1774
1890
  注意:此字段可能返回 null,表示取不到有效值。
1775
1891
  */
1776
1892
  JsonStandard?: number
1777
1893
  /**
1778
- * syslog传输协议,取值为tcp或者udp
1894
+ * syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。
1779
1895
  注意:
1780
1896
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
1781
1897
  - COS导入不支持此字段。
@@ -1783,7 +1899,7 @@ export interface ExtractRuleInfo {
1783
1899
  */
1784
1900
  Protocol?: string
1785
1901
  /**
1786
- * syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000
1902
+ * syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。
1787
1903
  注意:
1788
1904
  - 该字段适用于:创建采集规则配置、修改采集规则配置。
1789
1905
  - COS导入不支持此字段。
@@ -1794,6 +1910,7 @@ export interface ExtractRuleInfo {
1794
1910
  * rfc3164:指定系统日志采集使用RFC3164协议解析日志。
1795
1911
  rfc5424:指定系统日志采集使用RFC5424协议解析日志。
1796
1912
  auto:自动匹配rfc3164或者rfc5424其中一种协议。
1913
+ 只有在LogType为service_syslog时生效,其余类型无需填写。
1797
1914
  注意:
1798
1915
  - 该字段适用于:创建采集规则配置、修改采集规则配置
1799
1916
  - COS导入不支持此字段。
@@ -1822,9 +1939,7 @@ auto:自动匹配rfc3164或者rfc5424其中一种协议。
1822
1939
  */
1823
1940
  MetaTags?: Array<MetaTagInfo>
1824
1941
  /**
1825
- * Windows事件日志采集。
1826
- 注意:
1827
- - COS导入不支持此字段。
1942
+ * Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。
1828
1943
  */
1829
1944
  EventLogRules?: Array<EventLog>
1830
1945
  }
@@ -3898,7 +4013,7 @@ export interface DescribeMachineGroupsResponse {
3898
4013
  */
3899
4014
  export interface DeleteConfigExtraRequest {
3900
4015
  /**
3901
- * 采集规则扩展配置ID
4016
+ * 特殊采集规则扩展配置ID
3902
4017
  */
3903
4018
  ConfigExtraId: string
3904
4019
  }
@@ -4146,20 +4261,24 @@ export interface DeleteAlarmResponse {
4146
4261
  */
4147
4262
  export interface WebCallback {
4148
4263
  /**
4149
- * 回调地址。
4264
+ * 回调地址。最大支持1024个字节数。
4150
4265
  */
4151
4266
  Url: string
4152
4267
  /**
4153
4268
  * 回调的类型。可选值:
4154
- <li> WeCom
4155
- <li> Http
4269
+ - WeCom
4270
+ - Http
4271
+ - DingTalk
4272
+ - Lark
4156
4273
  */
4157
4274
  CallbackType: string
4158
4275
  /**
4159
4276
  * 回调方法。可选值:
4160
- <li> POST
4161
- <li> PUT
4162
- 默认值为POST。CallbackType为Http时为必选。
4277
+ - POST(默认值)
4278
+ - PUT
4279
+
4280
+ 注意:
4281
+ - 参数CallbackType为Http时为必选。
4163
4282
  注意:此字段可能返回 null,表示取不到有效值。
4164
4283
  */
4165
4284
  Method?: string
@@ -4176,7 +4295,9 @@ export interface WebCallback {
4176
4295
  */
4177
4296
  Body?: string
4178
4297
  /**
4179
- * 序号
4298
+ * 序号。
4299
+ - 入参无效。
4300
+ - 出参有效。
4180
4301
  */
4181
4302
  Index?: number
4182
4303
  }
@@ -4236,7 +4357,7 @@ export interface CreateConfigRequest {
4236
4357
  */
4237
4358
  Output: string
4238
4359
  /**
4239
- * 日志采集路径,包含文件名
4360
+ * 日志采集路径,包含文件名,支持多个路径,多个路径之间英文逗号分隔,文件采集情况下必填
4240
4361
  */
4241
4362
  Path?: string
4242
4363
  /**
@@ -4367,7 +4488,7 @@ export interface PreviewLogStatistic {
4367
4488
  */
4368
4489
  LogContent: string
4369
4490
  /**
4370
- * 行号
4491
+ * 行号。从0开始
4371
4492
  */
4372
4493
  LineNum: number
4373
4494
  /**
@@ -4375,16 +4496,20 @@ export interface PreviewLogStatistic {
4375
4496
  */
4376
4497
  DstTopicId?: string
4377
4498
  /**
4378
- * 失败错误码, 空字符串""表示正常
4499
+ * 失败错误信息, 空字符串""表示正常
4379
4500
  */
4380
4501
  FailReason?: string
4381
4502
  /**
4382
- * 日志时间戳
4503
+ * 日志时间,格式:`2024-05-07 17:13:17.105`
4504
+
4505
+ - 入参时无效
4506
+ - 出参时有效,为日志中的时间格式
4383
4507
  */
4384
4508
  Time?: string
4385
4509
  /**
4386
4510
  * 目标topic-name
4387
4511
  注意:此字段可能返回 null,表示取不到有效值。
4512
+ * @deprecated
4388
4513
  */
4389
4514
  DstTopicName?: string
4390
4515
  }
@@ -5125,15 +5250,24 @@ export interface CreateConfigExtraRequest {
5125
5250
  */
5126
5251
  TopicId: string
5127
5252
  /**
5128
- * 类型:container_stdoutcontainer_filehost_file
5253
+ * 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。
5129
5254
  */
5130
5255
  Type: string
5131
5256
  /**
5132
- * 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
5257
+ * 采集的日志类型,默认为minimalist_log。支持以下类型:
5258
+ - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
5259
+ - delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
5260
+ - minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
5261
+ - fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
5262
+ - multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
5263
+ - multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
5264
+ - user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
5133
5265
  */
5134
5266
  LogType: string
5135
5267
  /**
5136
- * 采集配置标
5268
+ * 采集配置标记。
5269
+ - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
5270
+
5137
5271
  */
5138
5272
  ConfigFlag: string
5139
5273
  /**
@@ -5149,19 +5283,21 @@ export interface CreateConfigExtraRequest {
5149
5283
  */
5150
5284
  TopicName: string
5151
5285
  /**
5152
- * 节点文件配置信息
5286
+ * 节点文件路径类型配置。
5153
5287
  */
5154
5288
  HostFile?: HostFileInfo
5155
5289
  /**
5156
- * 容器文件路径信息
5290
+ * 容器文件路径类型配置。
5157
5291
  */
5158
5292
  ContainerFile?: ContainerFileInfo
5159
5293
  /**
5160
- * 容器标准输出信息
5294
+ * 容器标准输出类型配置。
5161
5295
  */
5162
5296
  ContainerStdout?: ContainerStdoutInfo
5163
5297
  /**
5164
- * 日志格式化方式
5298
+ * 日志格式化方式,用于容器采集场景。
5299
+ - stdout-docker-json:用于docker容器采集场景
5300
+ - stdout-containerd:用于containerd容器采集场景
5165
5301
  */
5166
5302
  LogFormat?: string
5167
5303
  /**
@@ -5173,7 +5309,9 @@ export interface CreateConfigExtraRequest {
5173
5309
  */
5174
5310
  ExcludePaths?: Array<ExcludePathInfo>
5175
5311
  /**
5176
- * 用户自定义采集规则,Json格式序列化的字符串
5312
+ * 组合解析采集规则,用于复杂场景下的日志采集。
5313
+ - 取值参考:[使用组合解析提取模式采集日志
5314
+ ](https://cloud.tencent.com/document/product/614/61310)
5177
5315
  */
5178
5316
  UserDefineRule?: string
5179
5317
  /**
@@ -5193,7 +5331,8 @@ export interface CreateConfigExtraRequest {
5193
5331
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
5194
5332
  - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
5195
5333
  - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
5196
- 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
5334
+ - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
5335
+
5197
5336
  */
5198
5337
  AdvancedConfig?: string
5199
5338
  }
@@ -5967,33 +6106,38 @@ export type DeleteDashboardSubscribeRequest = null
5967
6106
  export interface NoticeReceiver {
5968
6107
  /**
5969
6108
  * 接受者类型。可选值:
5970
- <br><li> Uin - 用户ID
5971
- <br><li> Group - 用户组ID
6109
+ - Uin - 用户ID
6110
+ - Group - 用户组ID
5972
6111
  暂不支持其余接收者类型。
5973
6112
  */
5974
6113
  ReceiverType: string
5975
6114
  /**
5976
6115
  * 接收者。
6116
+ 当ReceiverType为Uin时,ReceiverIds的值为用户id。[子用户信息查询](https://cloud.tencent.com/document/product/598/36258)
6117
+ 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
5977
6118
  */
5978
6119
  ReceiverIds: Array<number | bigint>
5979
6120
  /**
5980
6121
  * 通知接收渠道。
5981
- <br><li> Email - 邮件
5982
- <br><li> Sms - 短信
5983
- <br><li> WeChat - 微信
5984
- <br><li> Phone - 电话
6122
+ - Email - 邮件
6123
+ - Sms - 短信
6124
+ - WeChat - 微信
6125
+ - Phone - 电话
5985
6126
  */
5986
6127
  ReceiverChannels: Array<string>
5987
6128
  /**
5988
- * 允许接收信息的开始时间。
6129
+ * 允许接收信息的开始时间。格式:`15:04:05`,必填。
5989
6130
  */
5990
6131
  StartTime?: string
5991
6132
  /**
5992
- * 允许接收信息的结束时间。
6133
+ * 允许接收信息的结束时间。格式:`15:04:05`,必填。
5993
6134
  */
5994
6135
  EndTime?: string
5995
6136
  /**
5996
- * 位序
6137
+ * 位序。
6138
+
6139
+ - 入参时无效。
6140
+ - 出参时有效。
5997
6141
  */
5998
6142
  Index?: number
5999
6143
  }
@@ -6345,7 +6489,9 @@ export interface CreateMachineGroupRequest {
6345
6489
  */
6346
6490
  GroupName: string
6347
6491
  /**
6348
- * 创建机器组类型。Type:ip,Values中为ip字符串列表创建机器组;Type:label,Values中为标签字符串列表创建机器组。
6492
+ * 创建机器组类型。取值如下:
6493
+ - Type:ip,Values中为ip字符串列表创建机器组
6494
+ - Type:label,Values中为标签字符串列表创建机器组
6349
6495
  */
6350
6496
  MachineGroupType: MachineGroupTypeInfo
6351
6497
  /**
@@ -6377,7 +6523,9 @@ export interface CreateMachineGroupRequest {
6377
6523
  */
6378
6524
  MetaTags?: Array<MetaTagInfo>
6379
6525
  /**
6380
- * 系统类型,默认0,0:Linux,1: Windows
6526
+ * 系统类型,取值如下:
6527
+ - 0:Linux (默认值)
6528
+ - 1:Windows
6381
6529
  */
6382
6530
  OSType?: number
6383
6531
  }
@@ -6565,7 +6713,24 @@ export interface CsvInfo {
6565
6713
  */
6566
6714
  export interface DescribeConfigExtrasRequest {
6567
6715
  /**
6568
- * 支持的key: topicId,name, configExtraId, machineGroupId
6716
+ * 过滤器,支持如下选项:
6717
+ name
6718
+ - 按照【特殊采集配置名称】进行模糊匹配过滤。
6719
+ - 类型:String
6720
+
6721
+ configExtraId
6722
+ - 按照【特殊采集配置ID】进行过滤。
6723
+ - 类型:String
6724
+
6725
+ topicId
6726
+ - 按照【日志主题】进行过滤。
6727
+ - 类型:String
6728
+
6729
+ machineGroupId
6730
+ - 按照【机器组ID】进行过滤。
6731
+ - 类型:String
6732
+
6733
+ 每次请求的Filters的上限为10,Filter.Values的上限为5。
6569
6734
  */
6570
6735
  Filters?: Array<Filter>
6571
6736
  /**
@@ -6588,25 +6753,39 @@ export interface CreateAlarmNoticeRequest {
6588
6753
  Name: string
6589
6754
  /**
6590
6755
  * 通知类型。可选值:
6591
- <li> Trigger - 告警触发 </li>
6592
- <li> Recovery - 告警恢复</li>
6593
- <li> All - 告警触发和告警恢复</li>
6756
+ - Trigger - 告警触发
6757
+ - Recovery - 告警恢复
6758
+ - All - 告警触发和告警恢复
6759
+
6760
+
6761
+ 注意:
6762
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6763
+ - 2组rule配置互斥
6764
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6594
6765
  */
6595
6766
  Type?: string
6596
6767
  /**
6597
6768
  * 通知接收对象。
6769
+ 注意:
6770
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6771
+ - 2组rule配置互斥
6772
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6598
6773
  */
6599
6774
  NoticeReceivers?: Array<NoticeReceiver>
6600
6775
  /**
6601
6776
  * 接口回调信息(包括企业微信)。
6777
+ 注意:
6778
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6779
+ - 2组rule配置互斥
6780
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6602
6781
  */
6603
6782
  WebCallbacks?: Array<WebCallback>
6604
6783
  /**
6605
6784
  * 通知规则。
6606
-
6607
6785
  注意:
6608
-
6609
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,2组配置互斥。
6786
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6787
+ - 2组rule配置互斥
6788
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6610
6789
 
6611
6790
 
6612
6791
  */
@@ -6700,7 +6879,8 @@ export interface ModifyConfigExtraRequest {
6700
6879
  */
6701
6880
  HostFile?: HostFileInfo
6702
6881
  /**
6703
- * 容器文件路径信息
6882
+ * 采集配置标记。
6883
+ - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
6704
6884
  */
6705
6885
  ContainerFile?: ContainerFileInfo
6706
6886
  /**
@@ -6708,11 +6888,20 @@ export interface ModifyConfigExtraRequest {
6708
6888
  */
6709
6889
  ContainerStdout?: ContainerStdoutInfo
6710
6890
  /**
6711
- * 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
6891
+ * 采集的日志类型,默认为minimalist_log。支持以下类型:
6892
+ - json_log代表:JSON-文件日志(详见[使用 JSON 提取模式采集日志](https://cloud.tencent.com/document/product/614/17419));
6893
+ - delimiter_log代表:分隔符-文件日志(详见[使用分隔符提取模式采集日志](https://cloud.tencent.com/document/product/614/17420));
6894
+ - minimalist_log代表:单行全文-文件日志(详见[使用单行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17421));
6895
+ - fullregex_log代表:单行完全正则-文件日志(详见[使用单行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52365));
6896
+ - multiline_log代表:多行全文-文件日志(详见[使用多行全文提取模式采集日志](https://cloud.tencent.com/document/product/614/17422));
6897
+ - multiline_fullregex_log代表:多行完全正则-文件日志(详见[使用多行-完全正则提取模式采集日志](https://cloud.tencent.com/document/product/614/52366));
6898
+ - user_define_log代表:组合解析(适用于多格式嵌套的日志,详见[使用组合解析提取模式采集日志](https://cloud.tencent.com/document/product/614/61310))。
6712
6899
  */
6713
6900
  LogType?: string
6714
6901
  /**
6715
- * 日志格式化方式
6902
+ * 日志格式化方式,用于容器采集场景。
6903
+ - stdout-docker-json:用于docker容器采集场景
6904
+ - stdout-containerd:用于containerd容器采集场景
6716
6905
  */
6717
6906
  LogFormat?: string
6718
6907
  /**
@@ -6724,7 +6913,9 @@ export interface ModifyConfigExtraRequest {
6724
6913
  */
6725
6914
  ExcludePaths?: Array<ExcludePathInfo>
6726
6915
  /**
6727
- * 用户自定义采集规则,Json格式序列化的字符串
6916
+ * 组合解析采集规则,用于复杂场景下的日志采集。
6917
+ - 取值参考:[使用组合解析提取模式采集日志
6918
+ ](https://cloud.tencent.com/document/product/614/61310)
6728
6919
  */
6729
6920
  UserDefineRule?: string
6730
6921
  /**
@@ -6756,7 +6947,8 @@ export interface ModifyConfigExtraRequest {
6756
6947
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
6757
6948
  - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
6758
6949
  - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
6759
- 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
6950
+ - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
6951
+
6760
6952
  */
6761
6953
  AdvancedConfig?: string
6762
6954
  }
@@ -6832,7 +7024,12 @@ export interface CreateDataTransformRequest {
6832
7024
  */
6833
7025
  Name: string
6834
7026
  /**
6835
- * 加工语句。[创建加工任务](https://cloud.tencent.com/document/product/614/63940) [函数总览](https://cloud.tencent.com/document/product/614/70395)
7027
+ * 加工语句。 当FuncType为2时,EtlContent必须使用[log_auto_output](https://cloud.tencent.com/document/product/614/70733#b3c58797-4825-4807-bef4-68106e25024f)
7028
+
7029
+ 其他参考文档:
7030
+
7031
+ - [创建加工任务](https://cloud.tencent.com/document/product/614/63940)
7032
+ - [函数总览](https://cloud.tencent.com/document/product/614/70395)
6836
7033
  */
6837
7034
  EtlContent: string
6838
7035
  /**