tencentcloud-sdk-nodejs 4.0.847 → 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 (83) hide show
  1. package/CHANGELOG.md +173 -0
  2. package/SERVICE_CHANGELOG.md +197 -129
  3. package/package.json +1 -1
  4. package/products.md +16 -16
  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/cdn/v20180606/cdn_client.ts +1 -1
  9. package/src/services/cls/v20201016/cls_models.ts +195 -44
  10. package/src/services/dbbrain/index.ts +2 -2
  11. package/src/services/dts/index.ts +2 -2
  12. package/src/services/eis/index.ts +2 -2
  13. package/src/services/ess/v20201111/ess_models.ts +4 -0
  14. package/src/services/essbasic/index.ts +2 -2
  15. package/src/services/essbasic/v20210526/essbasic_models.ts +10 -1
  16. package/src/services/facefusion/index.ts +2 -2
  17. package/src/services/hunyuan/v20230901/hunyuan_models.ts +2 -2
  18. package/src/services/iotcloud/index.ts +2 -2
  19. package/src/services/iotvideo/index.ts +2 -2
  20. package/src/services/mgobe/index.ts +2 -2
  21. package/src/services/monitor/v20180724/monitor_models.ts +36 -36
  22. package/src/services/organization/index.ts +2 -2
  23. package/src/services/rum/v20210622/rum_models.ts +11 -11
  24. package/src/services/sms/index.ts +2 -2
  25. package/src/services/tbp/index.ts +2 -2
  26. package/src/services/tdmq/v20200217/tdmq_models.ts +56 -1
  27. package/src/services/teo/index.ts +2 -2
  28. package/src/services/teo/v20220901/teo_client.ts +17 -2
  29. package/src/services/teo/v20220901/teo_models.ts +30 -0
  30. package/src/services/tke/index.ts +2 -2
  31. package/src/services/trtc/v20190722/trtc_client.ts +3 -3
  32. package/src/services/trtc/v20190722/trtc_models.ts +15 -5
  33. package/src/services/yunsou/index.ts +2 -2
  34. package/tencentcloud/common/sdk_version.d.ts +1 -1
  35. package/tencentcloud/common/sdk_version.js +1 -1
  36. package/tencentcloud/services/bma/index.d.ts +4 -4
  37. package/tencentcloud/services/bma/index.js +2 -2
  38. package/tencentcloud/services/btoe/index.d.ts +4 -4
  39. package/tencentcloud/services/btoe/index.js +2 -2
  40. package/tencentcloud/services/cdn/v20180606/cdn_client.d.ts +1 -1
  41. package/tencentcloud/services/cdn/v20180606/cdn_client.js +1 -1
  42. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +195 -44
  43. package/tencentcloud/services/dbbrain/index.d.ts +4 -4
  44. package/tencentcloud/services/dbbrain/index.js +2 -2
  45. package/tencentcloud/services/dts/index.d.ts +4 -4
  46. package/tencentcloud/services/dts/index.js +2 -2
  47. package/tencentcloud/services/eis/index.d.ts +4 -4
  48. package/tencentcloud/services/eis/index.js +2 -2
  49. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +4 -0
  50. package/tencentcloud/services/essbasic/index.d.ts +4 -4
  51. package/tencentcloud/services/essbasic/index.js +2 -2
  52. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +10 -1
  53. package/tencentcloud/services/facefusion/index.d.ts +4 -4
  54. package/tencentcloud/services/facefusion/index.js +2 -2
  55. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +2 -2
  56. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  57. package/tencentcloud/services/iotcloud/index.js +2 -2
  58. package/tencentcloud/services/iotvideo/index.d.ts +4 -4
  59. package/tencentcloud/services/iotvideo/index.js +2 -2
  60. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  61. package/tencentcloud/services/mgobe/index.js +2 -2
  62. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +36 -36
  63. package/tencentcloud/services/organization/index.d.ts +4 -4
  64. package/tencentcloud/services/organization/index.js +2 -2
  65. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +11 -11
  66. package/tencentcloud/services/sms/index.d.ts +4 -4
  67. package/tencentcloud/services/sms/index.js +2 -2
  68. package/tencentcloud/services/tbp/index.d.ts +4 -4
  69. package/tencentcloud/services/tbp/index.js +2 -2
  70. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +56 -1
  71. package/tencentcloud/services/teo/index.d.ts +4 -4
  72. package/tencentcloud/services/teo/index.js +2 -2
  73. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +9 -2
  74. package/tencentcloud/services/teo/v20220901/teo_client.js +10 -1
  75. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +28 -0
  76. package/tencentcloud/services/tke/index.d.ts +4 -4
  77. package/tencentcloud/services/tke/index.js +2 -2
  78. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +3 -3
  79. package/tencentcloud/services/trtc/v20190722/trtc_client.js +3 -3
  80. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +15 -5
  81. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  82. package/tencentcloud/services/yunsou/index.js +2 -2
  83. package/test/teo.v20220901.test.js +10 -0
@@ -603,13 +603,13 @@ peakCurrentUsers:峰值同时在线人数。
603
603
 
604
604
  /**
605
605
  * 接口说明:
606
- 启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面混流一路。
606
+ 启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面合流混成一路。
607
607
 
608
608
  您可以通过此接口实现如下目标:
609
609
  * 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。
610
610
  * 指定录制存储参数(StorageParams)来指定上传到您希望的云存储,目前支持腾讯云(云点播VOD、对象存储COS)和第三方AWS
611
- * 指定混流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等
612
- * 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
611
+ * 指定合流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等
612
+ * 指定合流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。
613
613
 
614
614
  关键名词:
615
615
  * 单流录制:分别录制房间的订阅UserId的音频和视频,录制服务会实时将录制文件上传至您指定的云存储。
@@ -1597,7 +1597,7 @@ export interface StartMCUMixTranscodeRequest {
1597
1597
  }
1598
1598
 
1599
1599
  /**
1600
- * 页面录制视频参数
1600
+ * 页面录制控制参数
1601
1601
  */
1602
1602
  export interface WebRecordVideoParams {
1603
1603
  /**
@@ -1613,6 +1613,12 @@ export interface WebRecordVideoParams {
1613
1613
 
1614
1614
  */
1615
1615
  Format?: string
1616
+ /**
1617
+ * 如果是aac或者mp4文件格式,超过长度限制后,系统会自动拆分视频文件。单位:分钟。默认为1440min(24h),取值范围为1-1440。【单文件限制最大为2G,满足文件大小 >2G 或录制时长度 > 24h任意一个条件,文件都会自动切分】
1618
+ Hls 格式录制此参数不生效。
1619
+ 示例值:1440
1620
+ */
1621
+ MaxMediaFileDuration?: number
1616
1622
  }
1617
1623
 
1618
1624
  /**
@@ -2371,11 +2377,11 @@ export interface CreateCloudRecordingRequest {
2371
2377
  */
2372
2378
  RoomIdType?: number
2373
2379
  /**
2374
- * 混流的转码参数,录制模式为混流的时候可以设置。
2380
+ * 合流的转码参数,录制模式为合流的时候可以设置。
2375
2381
  */
2376
2382
  MixTranscodeParams?: MixTranscodeParams
2377
2383
  /**
2378
- * 混流的布局参数,录制模式为混流的时候可以设置。
2384
+ * 合流的布局参数,录制模式为合流的时候可以设置。
2379
2385
  */
2380
2386
  MixLayoutParams?: MixLayoutParams
2381
2387
  /**
@@ -3276,7 +3282,7 @@ export interface RecordParams {
3276
3282
  /**
3277
3283
  * 录制模式:
3278
3284
  1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件上传至云存储;
3279
- 2:混流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件上传至云存储;
3285
+ 2:合流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件上传至云存储;
3280
3286
  */
3281
3287
  RecordMode: number
3282
3288
  /**
@@ -3301,7 +3307,7 @@ export interface RecordParams {
3301
3307
  */
3302
3308
  OutputFormat?: number
3303
3309
  /**
3304
- * 单流录制模式下,用户的音视频是否合并,0:单流音视频不合并(默认)。1:单流音视频合并成一个ts。混流录制此参数无需设置,默认音视频合并。
3310
+ * 单流录制模式下,用户的音视频是否合并,0:单流音视频不合并(默认)。1:单流音视频合并成一个ts。合流录制此参数无需设置,默认音视频合并。
3305
3311
  */
3306
3312
  AvMerge?: number
3307
3313
  /**
@@ -3313,6 +3319,10 @@ Hls 格式录制此参数不生效。
3313
3319
  * 指定录制主辅流,0:主流+辅流(默认);1:主流;2:辅流。
3314
3320
  */
3315
3321
  MediaId?: number
3322
+ /**
3323
+ * 上行视频停止时,录制的补帧类型,0:补最后一帧 1:补黑帧
3324
+ */
3325
+ FillType?: number
3316
3326
  }
3317
3327
 
3318
3328
  /**
@@ -1,7 +1,7 @@
1
- import { v20191115 } from "./v20191115"
2
1
  import { v20180504 } from "./v20180504"
2
+ import { v20191115 } from "./v20191115"
3
3
 
4
4
  export const yunsou = {
5
- v20191115: v20191115,
6
5
  v20180504: v20180504,
6
+ v20191115: v20191115,
7
7
  }
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.847";
1
+ export declare const sdkVersion = "4.0.848";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.847";
4
+ exports.sdkVersion = "4.0.848";
@@ -1,10 +1,10 @@
1
1
  export declare const bma: {
2
- v20210624: {
3
- Client: typeof import("./v20210624/bma_client").Client;
4
- Models: typeof import("./v20210624/bma_models");
5
- };
6
2
  v20221115: {
7
3
  Client: typeof import("./v20221115/bma_client").Client;
8
4
  Models: typeof import("./v20221115/bma_models");
9
5
  };
6
+ v20210624: {
7
+ Client: typeof import("./v20210624/bma_client").Client;
8
+ Models: typeof import("./v20210624/bma_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.bma = void 0;
4
- const v20210624_1 = require("./v20210624");
5
4
  const v20221115_1 = require("./v20221115");
5
+ const v20210624_1 = require("./v20210624");
6
6
  exports.bma = {
7
- v20210624: v20210624_1.v20210624,
8
7
  v20221115: v20221115_1.v20221115,
8
+ v20210624: v20210624_1.v20210624,
9
9
  };
@@ -1,10 +1,10 @@
1
1
  export declare const btoe: {
2
- v20210514: {
3
- Client: typeof import("./v20210514/btoe_client").Client;
4
- Models: typeof import("./v20210514/btoe_models");
5
- };
6
2
  v20210303: {
7
3
  Client: typeof import("./v20210303/btoe_client").Client;
8
4
  Models: typeof import("./v20210303/btoe_models");
9
5
  };
6
+ v20210514: {
7
+ Client: typeof import("./v20210514/btoe_client").Client;
8
+ Models: typeof import("./v20210514/btoe_models");
9
+ };
10
10
  };
@@ -1,9 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.btoe = void 0;
4
- const v20210514_1 = require("./v20210514");
5
4
  const v20210303_1 = require("./v20210303");
5
+ const v20210514_1 = require("./v20210514");
6
6
  exports.btoe = {
7
- v20210514: v20210514_1.v20210514,
8
7
  v20210303: v20210303_1.v20210303,
8
+ v20210514: v20210514_1.v20210514,
9
9
  };
@@ -272,7 +272,7 @@ ListDiagnoseReport 用于获取用户诊断URL访问后各个子任务的简要
272
272
  /**
273
273
  * UpdateDomainConfig 用于修改内容分发网络加速域名配置信息。
274
274
  注意:如果需要更新复杂类型的配置项,必须传递整个对象的所有属性,未传递的属性将使用默认值,建议通过查询接口获取配置属性后,直接修改后传递给本接口。
275
- 云审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到云审计。
275
+ 操作审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到操作审计。
276
276
  */
277
277
  UpdateDomainConfig(req: UpdateDomainConfigRequest, cb?: (error: string, rep: UpdateDomainConfigResponse) => void): Promise<UpdateDomainConfigResponse>;
278
278
  /**
@@ -396,7 +396,7 @@ ListDiagnoseReport 用于获取用户诊断URL访问后各个子任务的简要
396
396
  /**
397
397
  * UpdateDomainConfig 用于修改内容分发网络加速域名配置信息。
398
398
  注意:如果需要更新复杂类型的配置项,必须传递整个对象的所有属性,未传递的属性将使用默认值,建议通过查询接口获取配置属性后,直接修改后传递给本接口。
399
- 云审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到云审计。
399
+ 操作审计相关:接口的入参可能包含密钥等敏感信息,所以此接口的入参不会上报到操作审计。
400
400
  */
401
401
  async UpdateDomainConfig(req, cb) {
402
402
  return this.request("UpdateDomainConfig", req, cb);
@@ -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
  /**
@@ -1392,11 +1397,110 @@ export interface NoticeRule {
1392
1397
  WebCallbacks?: Array<WebCallback>;
1393
1398
  /**
1394
1399
  * 匹配规则 JSON串。
1395
- `{\"Value\":\"AND\",\"Type\":\"Operation\",\"Children\":[{\"Type\":\"Condition\",\"Value\":\"NotifyType\",\"Children\":[{\"Value\":\"In\",\"Type\":\"Compare\"},{\"Value\":\"[1,2]\",\"Type\":\"Value\"}]}]}
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\"}]}]}]}
1396
1503
  `
1397
- 以上示例表示:
1398
- 规则:
1399
- 通知类型属于告警通知,恢复通知
1400
1504
  注意:此字段可能返回 null,表示取不到有效值。
1401
1505
  */
1402
1506
  Rule?: string;
@@ -1541,6 +1645,11 @@ export interface ScheduledSqlTaskInfo {
1541
1645
  注意:此字段可能返回 null,表示取不到有效值。
1542
1646
  */
1543
1647
  SyntaxRule?: number;
1648
+ /**
1649
+ * 是否开启投递服务日志。1:关闭,2:开启。
1650
+ 注意:此字段可能返回 null,表示取不到有效值。
1651
+ */
1652
+ HasServicesLog?: number;
1544
1653
  }
1545
1654
  /**
1546
1655
  * DescribeConfigMachineGroups请求参数结构体
@@ -1691,7 +1800,6 @@ export interface ExtractRuleInfo {
1691
1800
  IsGBK?: number;
1692
1801
  /**
1693
1802
  * 是否为标准json。 0:否; 1:是。
1694
-
1695
1803
  - 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
1696
1804
  注意:此字段可能返回 null,表示取不到有效值。
1697
1805
  */
@@ -3987,9 +4095,11 @@ export interface WebCallback {
3987
4095
  CallbackType: string;
3988
4096
  /**
3989
4097
  * 回调方法。可选值:
3990
- - POST
4098
+ - POST(默认值)
3991
4099
  - PUT
3992
- 默认值为POST。CallbackType为Http时为必选。
4100
+
4101
+ 注意:
4102
+ - 参数CallbackType为Http时为必选。
3993
4103
  注意:此字段可能返回 null,表示取不到有效值。
3994
4104
  */
3995
4105
  Method?: string;
@@ -4189,7 +4299,7 @@ export interface PreviewLogStatistic {
4189
4299
  */
4190
4300
  LogContent: string;
4191
4301
  /**
4192
- * 行号
4302
+ * 行号。从0开始
4193
4303
  */
4194
4304
  LineNum: number;
4195
4305
  /**
@@ -4197,16 +4307,20 @@ export interface PreviewLogStatistic {
4197
4307
  */
4198
4308
  DstTopicId?: string;
4199
4309
  /**
4200
- * 失败错误码, 空字符串""表示正常
4310
+ * 失败错误信息, 空字符串""表示正常
4201
4311
  */
4202
4312
  FailReason?: string;
4203
4313
  /**
4204
- * 日志时间戳
4314
+ * 日志时间,格式:`2024-05-07 17:13:17.105`
4315
+
4316
+ - 入参时无效
4317
+ - 出参时有效,为日志中的时间格式
4205
4318
  */
4206
4319
  Time?: string;
4207
4320
  /**
4208
4321
  * 目标topic-name
4209
4322
  注意:此字段可能返回 null,表示取不到有效值。
4323
+ * @deprecated
4210
4324
  */
4211
4325
  DstTopicName?: string;
4212
4326
  }
@@ -4922,15 +5036,24 @@ export interface CreateConfigExtraRequest {
4922
5036
  */
4923
5037
  TopicId: string;
4924
5038
  /**
4925
- * 类型:container_stdoutcontainer_filehost_file
5039
+ * 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。
4926
5040
  */
4927
5041
  Type: string;
4928
5042
  /**
4929
- * 采集的日志类型,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))。
4930
5051
  */
4931
5052
  LogType: string;
4932
5053
  /**
4933
- * 采集配置标
5054
+ * 采集配置标记。
5055
+ - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
5056
+
4934
5057
  */
4935
5058
  ConfigFlag: string;
4936
5059
  /**
@@ -4946,19 +5069,21 @@ export interface CreateConfigExtraRequest {
4946
5069
  */
4947
5070
  TopicName: string;
4948
5071
  /**
4949
- * 节点文件配置信息
5072
+ * 节点文件路径类型配置。
4950
5073
  */
4951
5074
  HostFile?: HostFileInfo;
4952
5075
  /**
4953
- * 容器文件路径信息
5076
+ * 容器文件路径类型配置。
4954
5077
  */
4955
5078
  ContainerFile?: ContainerFileInfo;
4956
5079
  /**
4957
- * 容器标准输出信息
5080
+ * 容器标准输出类型配置。
4958
5081
  */
4959
5082
  ContainerStdout?: ContainerStdoutInfo;
4960
5083
  /**
4961
- * 日志格式化方式
5084
+ * 日志格式化方式,用于容器采集场景。
5085
+ - stdout-docker-json:用于docker容器采集场景
5086
+ - stdout-containerd:用于containerd容器采集场景
4962
5087
  */
4963
5088
  LogFormat?: string;
4964
5089
  /**
@@ -4970,7 +5095,9 @@ export interface CreateConfigExtraRequest {
4970
5095
  */
4971
5096
  ExcludePaths?: Array<ExcludePathInfo>;
4972
5097
  /**
4973
- * 用户自定义采集规则,Json格式序列化的字符串
5098
+ * 组合解析采集规则,用于复杂场景下的日志采集。
5099
+ - 取值参考:[使用组合解析提取模式采集日志
5100
+ ](https://cloud.tencent.com/document/product/614/61310)
4974
5101
  */
4975
5102
  UserDefineRule?: string;
4976
5103
  /**
@@ -4990,7 +5117,8 @@ export interface CreateConfigExtraRequest {
4990
5117
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
4991
5118
  - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
4992
5119
  - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
4993
- 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
5120
+ - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
5121
+
4994
5122
  */
4995
5123
  AdvancedConfig?: string;
4996
5124
  }
@@ -5752,17 +5880,17 @@ export interface NoticeReceiver {
5752
5880
  */
5753
5881
  ReceiverChannels: Array<string>;
5754
5882
  /**
5755
- * 允许接收信息的开始时间。
5883
+ * 允许接收信息的开始时间。格式:`15:04:05`,必填。
5756
5884
  */
5757
5885
  StartTime?: string;
5758
5886
  /**
5759
- * 允许接收信息的结束时间。
5887
+ * 允许接收信息的结束时间。格式:`15:04:05`,必填。
5760
5888
  */
5761
5889
  EndTime?: string;
5762
5890
  /**
5763
5891
  * 位序。
5764
5892
 
5765
- - 入参无效。
5893
+ - 入参时无效。
5766
5894
  - 出参时有效。
5767
5895
  */
5768
5896
  Index?: number;
@@ -6101,7 +6229,9 @@ export interface CreateMachineGroupRequest {
6101
6229
  */
6102
6230
  GroupName: string;
6103
6231
  /**
6104
- * 创建机器组类型。Type:ip,Values中为ip字符串列表创建机器组;Type:label,Values中为标签字符串列表创建机器组。
6232
+ * 创建机器组类型。取值如下:
6233
+ - Type:ip,Values中为ip字符串列表创建机器组
6234
+ - Type:label,Values中为标签字符串列表创建机器组
6105
6235
  */
6106
6236
  MachineGroupType: MachineGroupTypeInfo;
6107
6237
  /**
@@ -6133,7 +6263,9 @@ export interface CreateMachineGroupRequest {
6133
6263
  */
6134
6264
  MetaTags?: Array<MetaTagInfo>;
6135
6265
  /**
6136
- * 系统类型,默认0,0:Linux,1: Windows
6266
+ * 系统类型,取值如下:
6267
+ - 0:Linux (默认值)
6268
+ - 1:Windows
6137
6269
  */
6138
6270
  OSType?: number;
6139
6271
  }
@@ -6313,25 +6445,22 @@ export interface CsvInfo {
6313
6445
  */
6314
6446
  export interface DescribeConfigExtrasRequest {
6315
6447
  /**
6316
- * name
6448
+ * 过滤器,支持如下选项:
6449
+ name
6317
6450
  - 按照【特殊采集配置名称】进行模糊匹配过滤。
6318
6451
  - 类型:String
6319
- - 必选:否
6320
6452
 
6321
6453
  configExtraId
6322
6454
  - 按照【特殊采集配置ID】进行过滤。
6323
6455
  - 类型:String
6324
- - 必选:否
6325
6456
 
6326
6457
  topicId
6327
6458
  - 按照【日志主题】进行过滤。
6328
6459
  - 类型:String
6329
- - 必选:否
6330
6460
 
6331
6461
  machineGroupId
6332
6462
  - 按照【机器组ID】进行过滤。
6333
6463
  - 类型:String
6334
- - 必选:否
6335
6464
 
6336
6465
  每次请求的Filters的上限为10,Filter.Values的上限为5。
6337
6466
  */
@@ -6361,29 +6490,33 @@ export interface CreateAlarmNoticeRequest {
6361
6490
 
6362
6491
 
6363
6492
  注意:
6364
- - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6365
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6493
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6494
+ - 2组rule配置互斥
6495
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6366
6496
  */
6367
6497
  Type?: string;
6368
6498
  /**
6369
6499
  * 通知接收对象。
6370
6500
  注意:
6371
- - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6372
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6501
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6502
+ - 2组rule配置互斥
6503
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6373
6504
  */
6374
6505
  NoticeReceivers?: Array<NoticeReceiver>;
6375
6506
  /**
6376
6507
  * 接口回调信息(包括企业微信)。
6377
6508
  注意:
6378
- - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6379
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6509
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6510
+ - 2组rule配置互斥
6511
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6380
6512
  */
6381
6513
  WebCallbacks?: Array<WebCallback>;
6382
6514
  /**
6383
6515
  * 通知规则。
6384
6516
  注意:
6385
- - Type、NoticeReceivers和WebCallbacks是一组配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空,NoticeRules是另一组配置,其中rule不许为空,2组配置互斥。
6386
- - Type、NoticeReceivers和WebCallbacks是一组配置,NoticeRules是另一组配置,必须填写一组配置。
6517
+ - Type、NoticeReceivers和WebCallbacks是一组rule配置,其中Type必填,NoticeReceivers和WebCallbacks至少一个不为空;NoticeRules是另一组rule配置,其中rule不许为空
6518
+ - 2组rule配置互斥
6519
+ - rule配置 与 deliver配置(DeliverStatus与DeliverConfig)至少填写一组配置
6387
6520
 
6388
6521
 
6389
6522
  */
@@ -6473,7 +6606,8 @@ export interface ModifyConfigExtraRequest {
6473
6606
  */
6474
6607
  HostFile?: HostFileInfo;
6475
6608
  /**
6476
- * 容器文件路径信息
6609
+ * 采集配置标记。
6610
+ - 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置
6477
6611
  */
6478
6612
  ContainerFile?: ContainerFileInfo;
6479
6613
  /**
@@ -6481,11 +6615,20 @@ export interface ModifyConfigExtraRequest {
6481
6615
  */
6482
6616
  ContainerStdout?: ContainerStdoutInfo;
6483
6617
  /**
6484
- * 采集的日志类型,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))。
6485
6626
  */
6486
6627
  LogType?: string;
6487
6628
  /**
6488
- * 日志格式化方式
6629
+ * 日志格式化方式,用于容器采集场景。
6630
+ - stdout-docker-json:用于docker容器采集场景
6631
+ - stdout-containerd:用于containerd容器采集场景
6489
6632
  */
6490
6633
  LogFormat?: string;
6491
6634
  /**
@@ -6497,7 +6640,9 @@ export interface ModifyConfigExtraRequest {
6497
6640
  */
6498
6641
  ExcludePaths?: Array<ExcludePathInfo>;
6499
6642
  /**
6500
- * 用户自定义采集规则,Json格式序列化的字符串
6643
+ * 组合解析采集规则,用于复杂场景下的日志采集。
6644
+ - 取值参考:[使用组合解析提取模式采集日志
6645
+ ](https://cloud.tencent.com/document/product/614/61310)
6501
6646
  */
6502
6647
  UserDefineRule?: string;
6503
6648
  /**
@@ -6529,7 +6674,8 @@ export interface ModifyConfigExtraRequest {
6529
6674
  - ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
6530
6675
  - ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
6531
6676
  - ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
6532
- 样例:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}
6677
+ - ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0
6678
+
6533
6679
  */
6534
6680
  AdvancedConfig?: string;
6535
6681
  }
@@ -6603,7 +6749,12 @@ export interface CreateDataTransformRequest {
6603
6749
  */
6604
6750
  Name: string;
6605
6751
  /**
6606
- * 加工语句。[创建加工任务](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)
6607
6758
  */
6608
6759
  EtlContent: string;
6609
6760
  /**
@@ -1,10 +1,10 @@
1
1
  export declare const dbbrain: {
2
- v20210527: {
3
- Client: typeof import("./v20210527/dbbrain_client").Client;
4
- Models: typeof import("./v20210527/dbbrain_models");
5
- };
6
2
  v20191016: {
7
3
  Client: typeof import("./v20191016/dbbrain_client").Client;
8
4
  Models: typeof import("./v20191016/dbbrain_models");
9
5
  };
6
+ v20210527: {
7
+ Client: typeof import("./v20210527/dbbrain_client").Client;
8
+ Models: typeof import("./v20210527/dbbrain_models");
9
+ };
10
10
  };