tencentcloud-sdk-nodejs 4.0.651 → 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 (58) hide show
  1. package/CHANGELOG.md +267 -0
  2. package/SERVICE_CHANGELOG.md +332 -136
  3. package/package.json +1 -1
  4. package/products.md +20 -20
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/bma/v20221115/bma_models.ts +7 -2
  7. package/src/services/cam/v20190116/cam_models.ts +12 -12
  8. package/src/services/ccc/v20200210/ccc_models.ts +10 -0
  9. package/src/services/cls/v20201016/cls_client.ts +17 -2
  10. package/src/services/cls/v20201016/cls_models.ts +197 -25
  11. package/src/services/cwp/v20180228/cwp_models.ts +37 -32
  12. package/src/services/dnspod/v20210323/dnspod_models.ts +4 -0
  13. package/src/services/dts/v20211206/dts_models.ts +1 -1
  14. package/src/services/ess/v20201111/ess_client.ts +16 -4
  15. package/src/services/ess/v20201111/ess_models.ts +18 -8
  16. package/src/services/gaap/v20180529/gaap_models.ts +2 -2
  17. package/src/services/lcic/v20220817/lcic_models.ts +18 -0
  18. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  19. package/src/services/tcss/v20201101/tcss_client.ts +2 -0
  20. package/src/services/tcss/v20201101/tcss_models.ts +105 -25
  21. package/src/services/trtc/v20190722/trtc_models.ts +9 -1
  22. package/src/services/tsf/v20180326/tsf_models.ts +11 -11
  23. package/src/services/tts/v20190823/tts_models.ts +2 -2
  24. package/src/services/vpc/v20170312/vpc_client.ts +15 -1
  25. package/src/services/vpc/v20170312/vpc_models.ts +133 -6
  26. package/src/services/waf/v20180125/waf_client.ts +20 -7
  27. package/src/services/waf/v20180125/waf_models.ts +79 -16
  28. package/tencentcloud/common/sdk_version.d.ts +1 -1
  29. package/tencentcloud/common/sdk_version.js +1 -1
  30. package/tencentcloud/services/bma/v20221115/bma_models.d.ts +7 -2
  31. package/tencentcloud/services/cam/v20190116/cam_models.d.ts +12 -12
  32. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +10 -0
  33. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +5 -1
  34. package/tencentcloud/services/cls/v20201016/cls_client.js +6 -0
  35. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +192 -25
  36. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +37 -32
  37. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +4 -0
  38. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  39. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +16 -4
  40. package/tencentcloud/services/ess/v20201111/ess_client.js +16 -4
  41. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +18 -8
  42. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +2 -2
  43. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +18 -0
  44. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  45. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  46. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +103 -25
  47. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +9 -1
  48. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +11 -11
  49. package/tencentcloud/services/tts/v20190823/tts_models.d.ts +2 -2
  50. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  51. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  52. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +129 -6
  53. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +7 -3
  54. package/tencentcloud/services/waf/v20180125/waf_client.js +9 -3
  55. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +76 -16
  56. package/test/cls.v20201016.test.js +10 -0
  57. package/test/vpc.v20170312.test.js +10 -0
  58. package/test/waf.v20180125.test.js +12 -2
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { UploadLogResponse, CreateAlarmResponse, DeleteAlarmNoticeResponse, DescribeLogHistogramRequest, DescribeLogContextRequest, DeleteShipperRequest, DeleteScheduledSqlRequest, DeleteLogsetResponse, DescribeCosRechargesResponse, DescribeShipperTasksResponse, CreateMachineGroupResponse, DescribeConfigMachineGroupsRequest, ModifyConfigExtraResponse, ModifyLogsetRequest, CreateLogsetRequest, DescribeShippersRequest, CreateScheduledSqlResponse, SearchLogResponse, DeleteTopicRequest, DescribePartitionsRequest, ModifyAlarmResponse, DescribeShipperTasksRequest, DescribeAlarmsRequest, MergePartitionRequest, DescribeShippersResponse, CreateConfigExtraResponse, ModifyShipperResponse, DeleteKafkaRechargeResponse, DescribeConfigExtrasResponse, ModifyDataTransformRequest, DescribeScheduledSqlInfoResponse, OpenKafkaConsumerResponse, DescribeIndexRequest, ModifyScheduledSqlResponse, DescribeConfigsResponse, DeleteMachineGroupInfoRequest, CreateLogsetResponse, DeleteMachineGroupResponse, DescribeCosRechargesRequest, CreateCosRechargeRequest, DeleteDataTransformResponse, DeleteConfigExtraResponse, ModifyConsumerRequest, CreateIndexResponse, DeleteConfigFromMachineGroupResponse, CreateConsumerResponse, ModifyMachineGroupResponse, DeleteMachineGroupRequest, DescribePartitionsResponse, DescribeConfigMachineGroupsResponse, ModifyAlarmRequest, DescribeTopicsResponse, ModifyAlarmNoticeRequest, CreateAlarmRequest, DeleteExportResponse, DeleteScheduledSqlResponse, RetryShipperTaskResponse, SplitPartitionRequest, DescribeMachineGroupConfigsResponse, CheckRechargeKafkaServerRequest, DescribeLogHistogramResponse, CloseKafkaConsumerResponse, DescribeMachineGroupsRequest, CreateIndexRequest, DescribeLogsetsResponse, DeleteConsumerResponse, DescribeTopicsRequest, GetAlarmLogResponse, CreateTopicRequest, DescribeExportsRequest, CreateKafkaRechargeResponse, ModifyScheduledSqlRequest, DeleteConfigResponse, ModifyIndexResponse, DeleteConsumerRequest, DeleteIndexRequest, DescribeConsumerResponse, UploadLogRequest, ModifyConsumerResponse, DescribeAlertRecordHistoryRequest, DescribeConfigsRequest, DescribeConsumerRequest, DeleteConfigRequest, CloseKafkaConsumerRequest, CreateExportRequest, DescribeAlarmNoticesResponse, DeleteDataTransformRequest, DescribeMachineGroupsResponse, DeleteConfigExtraRequest, ModifyConfigRequest, AddMachineGroupInfoRequest, DescribeKafkaRechargesRequest, PreviewKafkaRechargeResponse, CreateShipperRequest, CreateTopicResponse, DeleteAlarmResponse, DescribeAlarmsResponse, CreateAlarmNoticeResponse, ModifyTopicResponse, CreateConfigRequest, CreateShipperResponse, DescribeKafkaRechargesResponse, DeleteIndexResponse, ModifyIndexRequest, DescribeDataTransformInfoRequest, DeleteShipperResponse, DescribeLogContextResponse, DeleteExportRequest, PreviewKafkaRechargeRequest, SplitPartitionResponse, CreateDataTransformResponse, ModifyShipperRequest, CreateKafkaRechargeRequest, DeleteKafkaRechargeRequest, CreateConfigExtraRequest, CreateConsumerRequest, ModifyConfigResponse, OpenKafkaConsumerRequest, ModifyKafkaRechargeResponse, ModifyAlarmNoticeResponse, DescribeMachinesResponse, ModifyCosRechargeResponse, ApplyConfigToMachineGroupResponse, DeleteAlarmRequest, CreateConfigResponse, DeleteConfigFromMachineGroupRequest, CreateCosRechargeResponse, DescribeAlertRecordHistoryResponse, AddMachineGroupInfoResponse, ModifyMachineGroupRequest, DescribeAlarmNoticesRequest, ModifyTopicRequest, DescribeMachinesRequest, DeleteAlarmNoticeRequest, DescribeScheduledSqlInfoRequest, DeleteLogsetRequest, ModifyLogsetResponse, SearchLogRequest, CreateMachineGroupRequest, DescribeExportsResponse, ApplyConfigToMachineGroupRequest, GetAlarmLogRequest, DescribeConfigExtrasRequest, CreateAlarmNoticeRequest, DescribeIndexResponse, DescribeMachineGroupConfigsRequest, ModifyConfigExtraRequest, ModifyKafkaRechargeRequest, CreateDataTransformRequest, DeleteMachineGroupInfoResponse, CheckRechargeKafkaServerResponse, ModifyCosRechargeRequest, DescribeLogsetsRequest, DeleteTopicResponse, ModifyDataTransformResponse, DescribeDataTransformInfoResponse, RetryShipperTaskRequest, CreateExportResponse, MergePartitionResponse, CreateScheduledSqlRequest } from "./cls_models";
3
+ import { UploadLogResponse, CreateAlarmResponse, DeleteAlarmNoticeResponse, DescribeLogHistogramRequest, DescribeLogContextRequest, DeleteShipperRequest, DeleteScheduledSqlRequest, DeleteLogsetResponse, DescribeCosRechargesResponse, DescribeShipperTasksResponse, CreateMachineGroupResponse, DescribeConfigMachineGroupsRequest, ModifyConfigExtraResponse, ModifyLogsetRequest, CreateLogsetRequest, DescribeShippersRequest, CreateScheduledSqlResponse, DescribeDashboardsRequest, SearchLogResponse, DeleteTopicRequest, DescribePartitionsRequest, ModifyAlarmResponse, DescribeShipperTasksRequest, DescribeAlarmsRequest, MergePartitionRequest, DescribeShippersResponse, CreateConfigExtraResponse, ModifyShipperResponse, DeleteKafkaRechargeResponse, DescribeConfigExtrasResponse, ModifyDataTransformRequest, DescribeScheduledSqlInfoResponse, OpenKafkaConsumerResponse, DescribeIndexRequest, ModifyScheduledSqlResponse, DescribeConfigsResponse, DeleteMachineGroupInfoRequest, CreateLogsetResponse, DeleteMachineGroupResponse, DescribeCosRechargesRequest, CreateCosRechargeRequest, DeleteDataTransformResponse, DeleteConfigExtraResponse, ModifyConsumerRequest, CreateIndexResponse, DeleteConfigFromMachineGroupResponse, CreateConsumerResponse, ModifyMachineGroupResponse, DeleteMachineGroupRequest, DescribePartitionsResponse, DescribeConfigMachineGroupsResponse, ModifyAlarmRequest, DescribeTopicsResponse, ModifyAlarmNoticeRequest, CreateAlarmRequest, DeleteExportResponse, DeleteScheduledSqlResponse, RetryShipperTaskResponse, SplitPartitionRequest, DescribeMachineGroupConfigsResponse, CheckRechargeKafkaServerRequest, DescribeLogHistogramResponse, CloseKafkaConsumerResponse, DescribeMachineGroupsRequest, DescribeConsumerRequest, CreateIndexRequest, DescribeLogsetsResponse, DeleteConsumerResponse, DescribeTopicsRequest, GetAlarmLogResponse, CreateTopicRequest, DescribeExportsRequest, CreateKafkaRechargeResponse, ModifyScheduledSqlRequest, DeleteConfigResponse, ModifyIndexResponse, DeleteConsumerRequest, DeleteIndexRequest, DescribeConsumerResponse, UploadLogRequest, ModifyConsumerResponse, DescribeAlertRecordHistoryRequest, DescribeConfigsRequest, DeleteConfigRequest, CloseKafkaConsumerRequest, CreateExportRequest, DescribeAlarmNoticesResponse, DeleteDataTransformRequest, DescribeMachineGroupsResponse, DeleteConfigExtraRequest, ModifyConfigRequest, AddMachineGroupInfoRequest, DescribeKafkaRechargesRequest, PreviewKafkaRechargeResponse, CreateShipperRequest, CreateTopicResponse, DeleteAlarmResponse, DescribeAlarmsResponse, CreateAlarmNoticeResponse, ModifyTopicResponse, CreateConfigRequest, CreateShipperResponse, DescribeKafkaRechargesResponse, DeleteIndexResponse, ModifyIndexRequest, DescribeDataTransformInfoRequest, DeleteShipperResponse, DescribeLogContextResponse, DeleteExportRequest, PreviewKafkaRechargeRequest, SplitPartitionResponse, CreateDataTransformResponse, ModifyShipperRequest, CreateKafkaRechargeRequest, DeleteKafkaRechargeRequest, CreateConfigExtraRequest, CreateConsumerRequest, ModifyConfigResponse, OpenKafkaConsumerRequest, ModifyKafkaRechargeResponse, ModifyAlarmNoticeResponse, DescribeMachinesResponse, ModifyCosRechargeResponse, DescribeDashboardsResponse, ApplyConfigToMachineGroupResponse, DeleteAlarmRequest, CreateConfigResponse, DeleteConfigFromMachineGroupRequest, CreateCosRechargeResponse, DescribeAlertRecordHistoryResponse, AddMachineGroupInfoResponse, ModifyMachineGroupRequest, DescribeAlarmNoticesRequest, ModifyTopicRequest, DescribeMachinesRequest, DeleteAlarmNoticeRequest, DescribeScheduledSqlInfoRequest, DeleteLogsetRequest, ModifyLogsetResponse, SearchLogRequest, CreateMachineGroupRequest, DescribeExportsResponse, ApplyConfigToMachineGroupRequest, GetAlarmLogRequest, DescribeConfigExtrasRequest, CreateAlarmNoticeRequest, DescribeIndexResponse, DescribeMachineGroupConfigsRequest, ModifyConfigExtraRequest, ModifyKafkaRechargeRequest, CreateDataTransformRequest, DeleteMachineGroupInfoResponse, CheckRechargeKafkaServerResponse, ModifyCosRechargeRequest, DescribeLogsetsRequest, DeleteTopicResponse, ModifyDataTransformResponse, DescribeDataTransformInfoResponse, RetryShipperTaskRequest, CreateExportResponse, MergePartitionResponse, CreateScheduledSqlRequest } from "./cls_models";
4
4
  /**
5
5
  * cls client
6
6
  * @class
@@ -338,6 +338,10 @@ cls.pb.cc cls.pb.h cls.proto
338
338
  * 该接口用于删除通知渠道组
339
339
  */
340
340
  DeleteAlarmNotice(req: DeleteAlarmNoticeRequest, cb?: (error: string, rep: DeleteAlarmNoticeResponse) => void): Promise<DeleteAlarmNoticeResponse>;
341
+ /**
342
+ * 本接口用于获取仪表盘
343
+ */
344
+ DescribeDashboards(req: DescribeDashboardsRequest, cb?: (error: string, rep: DescribeDashboardsResponse) => void): Promise<DescribeDashboardsResponse>;
341
345
  /**
342
346
  * 本接口用于构建日志数量直方图
343
347
  */
@@ -446,6 +446,12 @@ cls.pb.cc cls.pb.h cls.proto
446
446
  async DeleteAlarmNotice(req, cb) {
447
447
  return this.request("DeleteAlarmNotice", req, cb);
448
448
  }
449
+ /**
450
+ * 本接口用于获取仪表盘
451
+ */
452
+ async DescribeDashboards(req, cb) {
453
+ return this.request("DescribeDashboards", req, cb);
454
+ }
449
455
  /**
450
456
  * 本接口用于构建日志数量直方图
451
457
  */
@@ -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 {
4249
+ export interface DescribeDashboardsResponse {
4070
4250
  /**
4071
- * 日志内容
4251
+ * 仪表盘的数量
4072
4252
  */
4073
- LogContent: string;
4074
- /**
4075
- * 行号
4076
- */
4077
- LineNum: number;
4078
- /**
4079
- * 目标日志主题
4080
- */
4081
- DstTopicId?: string;
4082
- /**
4083
- * 失败错误码, 空字符串""表示正常
4084
- */
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
  * 投递日志的压缩配置
@@ -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
  */
@@ -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>;
@@ -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
  /**
@@ -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/>
@@ -59,8 +59,18 @@ callbackinfo包含: 回调地址和签名key
59
59
  return this.request("CancelFlow", req, cb);
60
60
  }
61
61
  /**
62
- * 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。<br/>
63
- 该接口常用来配合“创建电子文档”接口作为前置的接口使用。<br/>
62
+ * 本接口用于查询本企业模板列表。
63
+
64
+ 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
65
+
66
+ > **适用场景**
67
+ > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
68
+ > 一个模板通常会包含以下结构信息
69
+ >- 模板基本信息
70
+ >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
71
+ >- 填写控件 Components
72
+ >- 签署控件 SignComponents
73
+ >- 生成模板的文件基础信息 FileInfos
64
74
  */
65
75
  async DescribeFlowTemplates(req, cb) {
66
76
  return this.request("DescribeFlowTemplates", req, cb);
@@ -308,8 +318,10 @@ callbackinfo包含: 回调地址和签名key
308
318
  return this.request("DescribeIntegrationEmployees", req, cb);
309
319
  }
310
320
  /**
311
- * 创建个人H5签署链接,请联系客户经理申请使用 <br/>
312
- 该接口用于发起合同后,生成C端签署人的签署链接 <br/>
321
+ * 创建个人H5签署链接,请联系客户经理申请开通使用, 否则调用会返回失败 <br/>
322
+
323
+ 该接口用于发起合同后,生成个人签署人的签署链接, 暂时不支持企业端签署 <br/>
324
+
313
325
  注意:该接口目前签署人类型仅支持个人签署方(PERSON) <br/>
314
326
  注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
315
327
  注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
@@ -1386,31 +1386,39 @@ export interface CreateIntegrationDepartmentResponse {
1386
1386
  */
1387
1387
  export interface DescribeFlowTemplatesRequest {
1388
1388
  /**
1389
- * 调用方用户信息,userId 必填
1389
+ * 调用方员工/经办人信息
1390
+ UserId 必填,在企业控制台组织架构中可以查到员工的UserId
1391
+ 注:请保证对应
1390
1392
  */
1391
1393
  Operator: UserInfo;
1392
1394
  /**
1393
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1395
+ * 代理相关应用信息
1396
+ 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1394
1397
  */
1395
1398
  Agent?: Agent;
1396
1399
  /**
1397
- * 查询内容:0-模板列表及详情(默认),1-仅模板列表
1400
+ * 查询内容类型
1401
+ 0-模板列表及详情(默认)
1402
+ 1-仅模板列表
1398
1403
  */
1399
1404
  ContentType?: number;
1400
1405
  /**
1401
- * 搜索条件,具体参考Filter结构体。本接口取值:template-id:按照【 **模板唯一标识** 】进行过滤
1406
+ * 搜索条件,本字段用于指定模板Id进行查询。
1407
+ Key:template-id
1408
+ Values:需要查询的模板Id列表
1402
1409
  */
1403
1410
  Filters?: Array<Filter>;
1404
1411
  /**
1405
- * 查询偏移位置,默认0
1412
+ * 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
1406
1413
  */
1407
1414
  Offset?: number;
1408
1415
  /**
1409
- * 查询个数,默认20,最大200
1416
+ * 指定每页多少条数据,如果不传默认为20,单页最大200
1410
1417
  */
1411
1418
  Limit?: number;
1412
1419
  /**
1413
- * ApplicationId不为空,查询指定应用下的模板列表
1420
+ * 用于查询指定应用号下单模板列表。
1421
+ ApplicationId不为空,查询指定应用下的模板列表
1414
1422
  ApplicationId为空,查询所有应用下的模板列表
1415
1423
  */
1416
1424
  ApplicationId?: string;
@@ -2941,7 +2949,9 @@ export interface CreateFlowSignUrlRequest {
2941
2949
  */
2942
2950
  FlowId: string;
2943
2951
  /**
2944
- * 流程签署人,其中ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
2952
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
2953
+
2954
+ 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
2945
2955
  */
2946
2956
  FlowApproverInfos: Array<FlowCreateApprover>;
2947
2957
  /**