tencentcloud-sdk-nodejs 4.0.650 → 4.0.652

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 (89) hide show
  1. package/CHANGELOG.md +559 -0
  2. package/SERVICE_CHANGELOG.md +599 -138
  3. package/package.json +1 -1
  4. package/products.md +31 -31
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apigateway/v20180808/apigateway_client.ts +1 -16
  7. package/src/services/apigateway/v20180808/apigateway_models.ts +8 -54
  8. package/src/services/bma/v20221115/bma_models.ts +7 -2
  9. package/src/services/cam/v20190116/cam_models.ts +12 -12
  10. package/src/services/ccc/v20200210/ccc_models.ts +10 -0
  11. package/src/services/cfs/v20190719/cfs_models.ts +8 -0
  12. package/src/services/cls/v20201016/cls_client.ts +17 -2
  13. package/src/services/cls/v20201016/cls_models.ts +198 -26
  14. package/src/services/cwp/v20180228/cwp_models.ts +37 -32
  15. package/src/services/cynosdb/v20190107/cynosdb_models.ts +9 -1
  16. package/src/services/dnspod/v20210323/dnspod_models.ts +4 -0
  17. package/src/services/dts/v20211206/dts_models.ts +1 -1
  18. package/src/services/ess/v20201111/ess_client.ts +70 -19
  19. package/src/services/ess/v20201111/ess_models.ts +281 -102
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +23 -10
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +401 -355
  22. package/src/services/facefusion/v20181201/facefusion_client.ts +4 -1
  23. package/src/services/facefusion/v20181201/facefusion_models.ts +62 -20
  24. package/src/services/facefusion/v20220927/facefusion_client.ts +3 -0
  25. package/src/services/facefusion/v20220927/facefusion_models.ts +39 -1
  26. package/src/services/gaap/v20180529/gaap_models.ts +2 -2
  27. package/src/services/iotvideo/v20211125/iotvideo_models.ts +10 -0
  28. package/src/services/lcic/v20220817/lcic_models.ts +20 -2
  29. package/src/services/live/v20180801/live_models.ts +1 -1
  30. package/src/services/ocr/v20181119/ocr_client.ts +2 -2
  31. package/src/services/ocr/v20181119/ocr_models.ts +4 -0
  32. package/src/services/postgres/v20170312/postgres_models.ts +50 -34
  33. package/src/services/tcss/v20201101/tcss_client.ts +2 -0
  34. package/src/services/tcss/v20201101/tcss_models.ts +105 -25
  35. package/src/services/trtc/v20190722/trtc_models.ts +9 -1
  36. package/src/services/tsf/v20180326/tsf_models.ts +11 -11
  37. package/src/services/tts/v20190823/tts_models.ts +4 -4
  38. package/src/services/vpc/v20170312/vpc_client.ts +15 -1
  39. package/src/services/vpc/v20170312/vpc_models.ts +133 -6
  40. package/src/services/waf/v20180125/waf_client.ts +20 -7
  41. package/src/services/waf/v20180125/waf_models.ts +79 -16
  42. package/tencentcloud/common/sdk_version.d.ts +1 -1
  43. package/tencentcloud/common/sdk_version.js +1 -1
  44. package/tencentcloud/services/apigateway/v20180808/apigateway_client.d.ts +1 -7
  45. package/tencentcloud/services/apigateway/v20180808/apigateway_client.js +0 -8
  46. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +8 -51
  47. package/tencentcloud/services/bma/v20221115/bma_models.d.ts +7 -2
  48. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +12 -12
  49. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +10 -0
  50. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +8 -0
  51. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +5 -1
  52. package/tencentcloud/services/cls/v20201016/cls_client.js +6 -0
  53. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +193 -26
  54. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +37 -32
  55. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +9 -1
  56. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +4 -0
  57. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  58. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +34 -9
  59. package/tencentcloud/services/ess/v20201111/ess_client.js +41 -10
  60. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +273 -102
  61. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +9 -5
  62. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -5
  63. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +393 -350
  64. package/tencentcloud/services/facefusion/v20181201/facefusion_models.d.ts +59 -20
  65. package/tencentcloud/services/facefusion/v20220927/facefusion_models.d.ts +36 -1
  66. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +2 -2
  67. package/tencentcloud/services/iotvideo/v20211125/iotvideo_models.d.ts +10 -0
  68. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +20 -2
  69. package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -1
  70. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +2 -2
  71. package/tencentcloud/services/ocr/v20181119/ocr_client.js +2 -2
  72. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +4 -0
  73. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +50 -34
  74. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +103 -25
  75. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +9 -1
  76. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +11 -11
  77. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +4 -4
  78. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  79. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  80. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +129 -6
  81. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +7 -3
  82. package/tencentcloud/services/waf/v20180125/waf_client.js +9 -3
  83. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +76 -16
  84. package/test/apigateway.v20180808.test.js +0 -10
  85. package/test/cls.v20201016.test.js +10 -0
  86. package/test/ess.v20201111.test.js +34 -4
  87. package/test/essbasic.v20210526.test.js +12 -2
  88. package/test/vpc.v20170312.test.js +10 -0
  89. package/test/waf.v20180125.test.js +12 -2
@@ -482,6 +482,64 @@ export interface CreateScheduledSqlResponse {
482
482
  */
483
483
  RequestId?: string;
484
484
  }
485
+ /**
486
+ * DescribeDashboards请求参数结构体
487
+ */
488
+ export interface DescribeDashboardsRequest {
489
+ /**
490
+ * 分页的偏移量,默认值为0。
491
+ */
492
+ Offset?: number;
493
+ /**
494
+ * 分页单页限制数目,默认值为20,最大值100。
495
+ */
496
+ Limit?: number;
497
+ /**
498
+ * <br><li> dashboardId
499
+
500
+ 按照【仪表盘id】进行过滤。
501
+ 类型:String
502
+
503
+ 必选:否
504
+
505
+ <br><li> dashboardName
506
+
507
+ 按照【仪表盘名字】进行模糊搜索过滤。
508
+ 类型:String
509
+
510
+ 必选:否
511
+
512
+ <br><li> dashboardRegion
513
+
514
+ 按照【仪表盘地域】进行过滤,为了兼容老的仪表盘,通过云API创建的仪表盘没有地域属性
515
+ 类型:String
516
+
517
+ 必选:否
518
+
519
+ <br><li> tagKey
520
+
521
+ 按照【标签键】进行过滤。
522
+
523
+ 类型:String
524
+
525
+ 必选:否
526
+
527
+ <br><li> tag:tagKey
528
+
529
+ 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。
530
+
531
+ 类型:String
532
+
533
+ 必选:否
534
+
535
+ 每次请求的Filters的上限为10,Filter.Values的上限为100。
536
+ */
537
+ Filters?: Array<Filter>;
538
+ /**
539
+ * 按照topicId和regionId过滤。
540
+ */
541
+ TopicIdRegionFilter?: Array<TopicIdAndRegion>;
542
+ }
485
543
  /**
486
544
  * 日志中的KV对
487
545
  */
@@ -703,6 +761,20 @@ export interface DescribeShippersResponse {
703
761
  */
704
762
  RequestId?: string;
705
763
  }
764
+ /**
765
+ * 仪表盘 topic与地域信息
766
+ */
767
+ export interface TopicIdAndRegion {
768
+ /**
769
+ * 日志主题id
770
+ */
771
+ TopicId: string;
772
+ /**
773
+ * 日志主题id 所在的地域id
774
+ 地域ID - 访问链接查看详情:https://iwiki.woa.com/pages/viewpage.action?pageId=780556968#id-地域码表-一.region大区(标准地域)
775
+ */
776
+ RegionId: number;
777
+ }
706
778
  /**
707
779
  * CreateConfigExtra返回参数结构体
708
780
  */
@@ -890,9 +962,17 @@ export interface ScheduledSqlResouceInfo {
890
962
  */
891
963
  TopicId: string;
892
964
  /**
893
- * topic的地域信息
965
+ * 主题的的地域信息
894
966
  */
895
967
  Region?: string;
968
+ /**
969
+ * 主题类型:0为日志主题,1为指标主题
970
+ */
971
+ BizType?: number;
972
+ /**
973
+ * 指标名称
974
+ */
975
+ MetricName?: string;
896
976
  }
897
977
  /**
898
978
  * DescribeIndex请求参数结构体
@@ -2071,6 +2151,15 @@ export interface DescribeMachineGroupsRequest {
2071
2151
  */
2072
2152
  Limit?: number;
2073
2153
  }
2154
+ /**
2155
+ * DescribeConsumer请求参数结构体
2156
+ */
2157
+ export interface DescribeConsumerRequest {
2158
+ /**
2159
+ * 投递任务绑定的日志主题 ID
2160
+ */
2161
+ TopicId: string;
2162
+ }
2074
2163
  /**
2075
2164
  * CreateIndex请求参数结构体
2076
2165
  */
@@ -2593,13 +2682,17 @@ export interface LogsetInfo {
2593
2682
  RoleName: string;
2594
2683
  }
2595
2684
  /**
2596
- * DescribeConsumer请求参数结构体
2685
+ * 仪表盘关联的topic信息
2597
2686
  */
2598
- export interface DescribeConsumerRequest {
2687
+ export interface DashboardTopicInfo {
2599
2688
  /**
2600
- * 投递任务绑定的日志主题 ID
2689
+ * 主题id
2601
2690
  */
2602
2691
  TopicId: string;
2692
+ /**
2693
+ * topic所在的地域
2694
+ */
2695
+ Region: string;
2603
2696
  }
2604
2697
  /**
2605
2698
  * DeleteConfig请求参数结构体
@@ -3207,6 +3300,36 @@ export interface AlarmAnalysisConfig {
3207
3300
  */
3208
3301
  Value: string;
3209
3302
  }
3303
+ /**
3304
+ * 预览数据详情
3305
+ */
3306
+ export interface PreviewLogStatistic {
3307
+ /**
3308
+ * 日志内容
3309
+ */
3310
+ LogContent: string;
3311
+ /**
3312
+ * 行号
3313
+ */
3314
+ LineNum: number;
3315
+ /**
3316
+ * 目标日志主题
3317
+ */
3318
+ DstTopicId?: string;
3319
+ /**
3320
+ * 失败错误码, 空字符串""表示正常
3321
+ */
3322
+ FailReason?: string;
3323
+ /**
3324
+ * 日志时间戳
3325
+ */
3326
+ Time?: string;
3327
+ /**
3328
+ * 目标topic-name
3329
+ 注意:此字段可能返回 null,表示取不到有效值。
3330
+ */
3331
+ DstTopicName?: string;
3332
+ }
3210
3333
  /**
3211
3334
  * ModifyIndex请求参数结构体
3212
3335
  */
@@ -3964,6 +4087,63 @@ export interface ModifyAlarmNoticeResponse {
3964
4087
  */
3965
4088
  RequestId?: string;
3966
4089
  }
4090
+ /**
4091
+ * 仪表盘信息
4092
+ */
4093
+ export interface DashboardInfo {
4094
+ /**
4095
+ * 仪表盘id
4096
+ */
4097
+ DashboardId: string;
4098
+ /**
4099
+ * 仪表盘名字
4100
+ */
4101
+ DashboardName: string;
4102
+ /**
4103
+ * 仪表盘数据
4104
+ 注意:此字段可能返回 null,表示取不到有效值。
4105
+ */
4106
+ Data: string;
4107
+ /**
4108
+ * 创建仪表盘的时间
4109
+ */
4110
+ CreateTime: string;
4111
+ /**
4112
+ * AssumerUin非空则表示创建该日志主题的服务方Uin
4113
+ 注意:此字段可能返回 null,表示取不到有效值。
4114
+ */
4115
+ AssumerUin: number;
4116
+ /**
4117
+ * RoleName非空则表示创建该日志主题的服务方使用的角色
4118
+ 注意:此字段可能返回 null,表示取不到有效值。
4119
+ */
4120
+ RoleName: string;
4121
+ /**
4122
+ * AssumerName非空则表示创建该日志主题的服务方名称
4123
+ 注意:此字段可能返回 null,表示取不到有效值。
4124
+ */
4125
+ AssumerName: string;
4126
+ /**
4127
+ * 日志主题绑定的标签信息
4128
+ 注意:此字段可能返回 null,表示取不到有效值。
4129
+ */
4130
+ Tags: Array<Tag>;
4131
+ /**
4132
+ * 仪表盘所在地域: 为了兼容老的地域。
4133
+ 注意:此字段可能返回 null,表示取不到有效值。
4134
+ */
4135
+ DashboardRegion: string;
4136
+ /**
4137
+ * 修改仪表盘的时间
4138
+ 注意:此字段可能返回 null,表示取不到有效值。
4139
+ */
4140
+ UpdateTime: string;
4141
+ /**
4142
+ * 仪表盘对应的topic相关信息
4143
+ 注意:此字段可能返回 null,表示取不到有效值。
4144
+ */
4145
+ DashboardTopicInfos: Array<DashboardTopicInfo>;
4146
+ }
3967
4147
  /**
3968
4148
  * 数据加工任务基本详情
3969
4149
  */
@@ -4064,34 +4244,21 @@ export interface ModifyCosRechargeResponse {
4064
4244
  RequestId?: string;
4065
4245
  }
4066
4246
  /**
4067
- * 预览数据详情
4247
+ * DescribeDashboards返回参数结构体
4068
4248
  */
4069
- export interface PreviewLogStatistic {
4070
- /**
4071
- * 日志内容
4072
- */
4073
- LogContent: string;
4074
- /**
4075
- * 行号
4076
- */
4077
- LineNum: number;
4249
+ export interface DescribeDashboardsResponse {
4078
4250
  /**
4079
- * 目标日志主题
4080
- */
4081
- DstTopicId?: string;
4082
- /**
4083
- * 失败错误码, 空字符串""表示正常
4251
+ * 仪表盘的数量
4084
4252
  */
4085
- FailReason?: string;
4253
+ TotalCount: number;
4086
4254
  /**
4087
- * 日志时间戳
4255
+ * 仪表盘详细明细
4088
4256
  */
4089
- Time?: string;
4257
+ DashboardInfos: Array<DashboardInfo>;
4090
4258
  /**
4091
- * 目标topic-name
4092
- 注意:此字段可能返回 null,表示取不到有效值。
4259
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4093
4260
  */
4094
- DstTopicName?: string;
4261
+ RequestId?: string;
4095
4262
  }
4096
4263
  /**
4097
4264
  * 投递日志的压缩配置
@@ -4157,7 +4324,7 @@ export interface MachineGroupTypeInfo {
4157
4324
  /**
4158
4325
  * 机器描述列表
4159
4326
  */
4160
- Values: Array<string>;
4327
+ Values?: Array<string>;
4161
4328
  }
4162
4329
  /**
4163
4330
  * DeleteConfigFromMachineGroup请求参数结构体
@@ -7194,7 +7194,7 @@ export interface Machine {
7194
7194
  * 备注信息
7195
7195
  注意:此字段可能返回 null,表示取不到有效值。
7196
7196
  */
7197
- Remark: string;
7197
+ Remark?: string;
7198
7198
  }
7199
7199
  /**
7200
7200
  * 授权机器信息
@@ -12181,65 +12181,70 @@ export interface LicenseDetail {
12181
12181
  /**
12182
12182
  * 授权ID
12183
12183
  */
12184
- LicenseId: number;
12184
+ LicenseId?: number;
12185
12185
  /**
12186
12186
  * 授权类型,0 专业版-按量计费, 1专业版-包年包月 , 2 旗舰版-包年包月
12187
12187
  */
12188
- LicenseType: number;
12188
+ LicenseType?: number;
12189
12189
  /**
12190
12190
  * 授权状态 0 未使用,1 部分使用, 2 已用完, 3 不可用
12191
12191
  注意:此字段可能返回 null,表示取不到有效值。
12192
12192
  */
12193
- LicenseStatus: number;
12193
+ LicenseStatus?: number;
12194
12194
  /**
12195
12195
  * 总授权数
12196
12196
  */
12197
- LicenseCnt: number;
12197
+ LicenseCnt?: number;
12198
12198
  /**
12199
12199
  * 已使用授权数
12200
12200
  */
12201
- UsedLicenseCnt: number;
12201
+ UsedLicenseCnt?: number;
12202
12202
  /**
12203
12203
  * 订单状态 1 正常 2隔离, 3销毁
12204
12204
  */
12205
- OrderStatus: number;
12205
+ OrderStatus?: number;
12206
12206
  /**
12207
12207
  * 截止日期
12208
12208
  */
12209
- Deadline: string;
12209
+ Deadline?: string;
12210
12210
  /**
12211
12211
  * 订单资源ID
12212
12212
  */
12213
- ResourceId: string;
12213
+ ResourceId?: string;
12214
12214
  /**
12215
12215
  * 0 初始化,1 自动续费,2 不自动续费
12216
12216
  */
12217
- AutoRenewFlag: number;
12217
+ AutoRenewFlag?: number;
12218
12218
  /**
12219
12219
  * 项目ID
12220
12220
  */
12221
- ProjectId: number;
12221
+ ProjectId?: number;
12222
12222
  /**
12223
12223
  * 任务ID ,默认0 ,查询绑定进度用
12224
12224
  */
12225
- TaskId: number;
12225
+ TaskId?: number;
12226
12226
  /**
12227
12227
  * 购买时间
12228
12228
  */
12229
- BuyTime: string;
12229
+ BuyTime?: string;
12230
12230
  /**
12231
12231
  * 是否试用订单.
12232
12232
  */
12233
- SourceType: number;
12233
+ SourceType?: number;
12234
12234
  /**
12235
12235
  * 资源别名
12236
12236
  */
12237
- Alias: string;
12237
+ Alias?: string;
12238
12238
  /**
12239
12239
  * 平台标签
12240
12240
  注意:此字段可能返回 null,表示取不到有效值。
12241
12241
  */
12242
- Tags: Array<Tags>;
12242
+ Tags?: Array<Tags>;
12243
+ /**
12244
+ * 冻结数,当为0时 为未冻结,非0 则表示冻结授权数额
12245
+ 注意:此字段可能返回 null,表示取不到有效值。
12246
+ */
12247
+ FreezeNum?: number;
12243
12248
  }
12244
12249
  /**
12245
12250
  * 本地提权规则
@@ -12882,12 +12887,12 @@ export interface DescribeImportMachineInfoResponse {
12882
12887
  * 有效的机器信息列表:机器名称、机器公网/内网ip、机器标签
12883
12888
  注意:此字段可能返回 null,表示取不到有效值。
12884
12889
  */
12885
- EffectiveMachineInfoList: Array<EffectiveMachineInfo>;
12890
+ EffectiveMachineInfoList?: Array<EffectiveMachineInfo>;
12886
12891
  /**
12887
12892
  * 用户批量导入失败的机器列表(例如机器不存在等...)
12888
12893
  注意:此字段可能返回 null,表示取不到有效值。
12889
12894
  */
12890
- InvalidMachineList: Array<string>;
12895
+ InvalidMachineList?: Array<string>;
12891
12896
  /**
12892
12897
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
12893
12898
  */
@@ -16652,62 +16657,62 @@ export interface DescribeGeneralStatResponse {
16652
16657
  /**
16653
16658
  * 云主机总数
16654
16659
  */
16655
- MachinesAll: number;
16660
+ MachinesAll?: number;
16656
16661
  /**
16657
16662
  * 云主机没有安装主机安全客户端的总数
16658
16663
  */
16659
- MachinesUninstalled: number;
16664
+ MachinesUninstalled?: number;
16660
16665
  /**
16661
16666
  * 主机安全客户端总数的总数
16662
16667
  */
16663
- AgentsAll: number;
16668
+ AgentsAll?: number;
16664
16669
  /**
16665
16670
  * 主机安全客户端在线的总数
16666
16671
  */
16667
- AgentsOnline: number;
16672
+ AgentsOnline?: number;
16668
16673
  /**
16669
16674
  * 主机安全客户端 离线+关机 的总数
16670
16675
  */
16671
- AgentsOffline: number;
16676
+ AgentsOffline?: number;
16672
16677
  /**
16673
16678
  * 主机安全客户端专业版的总数
16674
16679
  */
16675
- AgentsPro: number;
16680
+ AgentsPro?: number;
16676
16681
  /**
16677
16682
  * 主机安全客户端基础版的总数
16678
16683
  */
16679
- AgentsBasic: number;
16684
+ AgentsBasic?: number;
16680
16685
  /**
16681
16686
  * 7天内到期的预付费专业版总数
16682
16687
  */
16683
- AgentsProExpireWithInSevenDays: number;
16688
+ AgentsProExpireWithInSevenDays?: number;
16684
16689
  /**
16685
16690
  * 风险主机总数
16686
16691
  */
16687
- RiskMachine: number;
16692
+ RiskMachine?: number;
16688
16693
  /**
16689
16694
  * 已关机总数
16690
16695
  */
16691
- Shutdown: number;
16696
+ Shutdown?: number;
16692
16697
  /**
16693
16698
  * 已离线总数
16694
16699
  */
16695
- Offline: number;
16700
+ Offline?: number;
16696
16701
  /**
16697
16702
  * 旗舰版主机数
16698
16703
  注意:此字段可能返回 null,表示取不到有效值。
16699
16704
  */
16700
- FlagshipMachineCnt: number;
16705
+ FlagshipMachineCnt?: number;
16701
16706
  /**
16702
16707
  * 保护天数
16703
16708
  注意:此字段可能返回 null,表示取不到有效值。
16704
16709
  */
16705
- ProtectDays: number;
16710
+ ProtectDays?: number;
16706
16711
  /**
16707
16712
  * 15天内新增的主机数
16708
16713
  注意:此字段可能返回 null,表示取不到有效值。
16709
16714
  */
16710
- AddedOnTheFifteen: number;
16715
+ AddedOnTheFifteen?: number;
16711
16716
  /**
16712
16717
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
16713
16718
  */
@@ -5209,6 +5209,14 @@ export interface ExportInstanceSlowQueriesRequest {
5209
5209
  * 文件类型,可选值:csv, original
5210
5210
  */
5211
5211
  FileType?: string;
5212
+ /**
5213
+ * 排序字段,可选值: QueryTime,LockTime,RowsExamined,RowsSent
5214
+ */
5215
+ OrderBy?: string;
5216
+ /**
5217
+ * 排序类型,可选值:asc,desc
5218
+ */
5219
+ OrderByType?: string;
5212
5220
  }
5213
5221
  /**
5214
5222
  * ModifyAccountDescription请求参数结构体
@@ -6791,7 +6799,7 @@ export interface ExportInstanceSlowQueriesResponse {
6791
6799
  /**
6792
6800
  * 慢查询导出内容
6793
6801
  */
6794
- FileContent: string;
6802
+ FileContent?: string;
6795
6803
  /**
6796
6804
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6797
6805
  */
@@ -46,6 +46,10 @@ export interface CreateRecordRequest {
46
46
  * 记录初始状态,取值范围为 ENABLE 和 DISABLE 。默认为 ENABLE ,如果传入 DISABLE,解析不会生效,也不会验证负载均衡的限制。
47
47
  */
48
48
  Status?: string;
49
+ /**
50
+ * 备注
51
+ */
52
+ Remark?: string;
49
53
  }
50
54
  /**
51
55
  * DescribeRecordFilterList返回参数结构体
@@ -1034,7 +1034,7 @@ export interface MigrateOption {
1034
1034
  IsDstReadOnly?: boolean;
1035
1035
  /**
1036
1036
  * 其他附加信息,对于特定库可设置额外参数,Redis可定义如下的参数:
1037
- ["ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120, 复制超时时间(秒) ]
1037
+ ["DstWriteMode":normal, 目标库写入模式,可取值clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作) "IsDstReadOnly":true, 是否在迁移时设置目标库只读,true(设置只读)、false(不设置只读) "ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB) "ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB) "ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒) "ReplBacklogSize":512, 环形缓冲区容量限制(MB) "ReplTimeout":120, 复制超时时间(秒) ]
1038
1038
  注意:此字段可能返回 null,表示取不到有效值。
1039
1039
  */
1040
1040
  ExtraAttr?: Array<KeyValuePairOption>;
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateChannelSubOrganizationModifyQrCodeRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateChannelSubOrganizationModifyQrCodeResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, DescribeIntegrationMainOrganizationUserResponse, CancelUserAutoSignEnableUrlRequest, DeleteSealPoliciesRequest, CreateFlowByFilesRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
+ import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateChannelSubOrganizationModifyQrCodeRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateChannelSubOrganizationModifyQrCodeResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, DescribeIntegrationMainOrganizationUserResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -31,8 +31,18 @@ callbackinfo包含: 回调地址和签名key
31
31
  */
32
32
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
33
33
  /**
34
- * 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。<br/>
35
- 该接口常用来配合“创建电子文档”接口作为前置的接口使用。<br/>
34
+ * 本接口用于查询本企业模板列表。
35
+
36
+ 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
37
+
38
+ > **适用场景**
39
+ > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
40
+ > 一个模板通常会包含以下结构信息
41
+ >- 模板基本信息
42
+ >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
43
+ >- 填写控件 Components
44
+ >- 签署控件 SignComponents
45
+ >- 生成模板的文件基础信息 FileInfos
36
46
  */
37
47
  DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
38
48
  /**
@@ -53,9 +63,9 @@ callbackinfo包含: 回调地址和签名key
53
63
  */
54
64
  CreateSealPolicy(req: CreateSealPolicyRequest, cb?: (error: string, rep: CreateSealPolicyResponse) => void): Promise<CreateSealPolicyResponse>;
55
65
  /**
56
- * 此API接口用户查询加入集团的成员企业
66
+ * 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
57
67
  */
58
- DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
68
+ CreateEmbedWebUrl(req: CreateEmbedWebUrlRequest, cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void): Promise<CreateEmbedWebUrlResponse>;
59
69
  /**
60
70
  * 对流程的合同文件进行验证,判断文件是否合法。
61
71
  */
@@ -210,8 +220,10 @@ callbackinfo包含: 回调地址和签名key
210
220
  */
211
221
  DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
212
222
  /**
213
- * 创建个人H5签署链接,请联系客户经理申请使用 <br/>
214
- 该接口用于发起合同后,生成C端签署人的签署链接 <br/>
223
+ * 创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
224
+
225
+ 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
226
+
215
227
  注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
216
228
  注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
217
229
  注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
@@ -242,9 +254,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
242
254
  */
243
255
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
244
256
  /**
245
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
257
+ * 通过此接口,创建企业批量签署链接,企业员工点击链接即可跳转控制台进行批量签署。
258
+ 如果没有UserId,Name和Mobile必填,对应的员工必须在企业下已经实名,且该员工为批量签署合同中的签署方。
246
259
  */
247
- DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
260
+ CreateOrganizationBatchSignUrl(req: CreateOrganizationBatchSignUrlRequest, cb?: (error: string, rep: CreateOrganizationBatchSignUrlResponse) => void): Promise<CreateOrganizationBatchSignUrlResponse>;
248
261
  /**
249
262
  * 指定需要批量催办的签署流程Id,批量催办合同,最多100个; 接口失败后返回错误信息
250
263
  注意:
@@ -253,6 +266,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
253
266
  发起合同时,签署人的NotifyType需设置为sms,否则无法催办
254
267
  */
255
268
  CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
269
+ /**
270
+ * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息
271
+ */
272
+ DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
256
273
  /**
257
274
  * 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
258
275
 
@@ -263,6 +280,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
263
280
  * 通过AuthCode查询用户是否实名
264
281
  */
265
282
  DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
283
+ /**
284
+ * 用来创建页面主题配置
285
+ */
286
+ CreateWebThemeConfig(req: CreateWebThemeConfigRequest, cb?: (error: string, rep: CreateWebThemeConfigResponse) => void): Promise<CreateWebThemeConfigResponse>;
266
287
  /**
267
288
  * 查询企业印章的列表,需要操作者具有查询印章权限
268
289
  客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
@@ -300,6 +321,10 @@ PDF资源Id 通过上传文件接口获取
300
321
  此接口合同组中的子合同必须都是文件发起的合同
301
322
  */
302
323
  CreateFlowGroupByFiles(req: CreateFlowGroupByFilesRequest, cb?: (error: string, rep: CreateFlowGroupByFilesResponse) => void): Promise<CreateFlowGroupByFilesResponse>;
324
+ /**
325
+ * 此API接口用户查询加入集团的成员企业
326
+ */
327
+ DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
303
328
  /**
304
329
  * 创建员工,此接口会发送提醒员工实名的短信
305
330
  */