tencentcloud-sdk-nodejs 4.0.556 → 4.0.558

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 (44) hide show
  1. package/CHANGELOG.md +250 -0
  2. package/SERVICE_CHANGELOG.md +165 -301
  3. package/package.json +1 -1
  4. package/products.md +15 -15
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cdb/v20170320/cdb_models.ts +23 -23
  7. package/src/services/ckafka/v20190819/ckafka_models.ts +12 -0
  8. package/src/services/cwp/v20180228/cwp_models.ts +8 -8
  9. package/src/services/dnspod/v20210323/dnspod_models.ts +6 -0
  10. package/src/services/ess/v20201111/ess_client.ts +3 -2
  11. package/src/services/ess/v20201111/ess_models.ts +3 -3
  12. package/src/services/essbasic/v20210526/essbasic_client.ts +26 -10
  13. package/src/services/essbasic/v20210526/essbasic_models.ts +1 -0
  14. package/src/services/keewidb/v20220308/keewidb_models.ts +2 -2
  15. package/src/services/lcic/v20220817/lcic_client.ts +30 -18
  16. package/src/services/lcic/v20220817/lcic_models.ts +25 -0
  17. package/src/services/monitor/v20180724/monitor_models.ts +11 -0
  18. package/src/services/tdmq/v20200217/tdmq_client.ts +34 -22
  19. package/src/services/tdmq/v20200217/tdmq_models.ts +77 -0
  20. package/src/services/teo/v20220106/teo_client.ts +16 -8
  21. package/tencentcloud/common/sdk_version.d.ts +1 -1
  22. package/tencentcloud/common/sdk_version.js +1 -1
  23. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +23 -23
  24. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +10 -0
  25. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +8 -8
  26. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +5 -0
  27. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +3 -2
  28. package/tencentcloud/services/ess/v20201111/ess_client.js +3 -2
  29. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +3 -3
  30. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +21 -5
  31. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +21 -5
  32. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1 -0
  33. package/tencentcloud/services/keewidb/v20220308/keewidb_models.d.ts +2 -2
  34. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +11 -7
  35. package/tencentcloud/services/lcic/v20220817/lcic_client.js +15 -9
  36. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +22 -0
  37. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +9 -0
  38. package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +13 -9
  39. package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +18 -12
  40. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +64 -0
  41. package/tencentcloud/services/teo/v20220106/teo_client.d.ts +12 -4
  42. package/tencentcloud/services/teo/v20220106/teo_client.js +12 -4
  43. package/test/lcic.v20220817.test.js +16 -6
  44. package/test/tdmq.v20200217.test.js +24 -14
@@ -8968,6 +8968,11 @@ export interface DescribePrometheusConfigResponse {
8968
8968
  */
8969
8969
  RawJobs?: Array<PrometheusConfigItem>
8970
8970
 
8971
+ /**
8972
+ * Probes
8973
+ */
8974
+ Probes?: Array<PrometheusConfigItem>
8975
+
8971
8976
  /**
8972
8977
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
8973
8978
  */
@@ -10586,6 +10591,12 @@ abnormal = 异常
10586
10591
  注意:此字段可能返回 null,表示取不到有效值。
10587
10592
  */
10588
10593
  FailedReason: string
10594
+
10595
+ /**
10596
+ * agent名称
10597
+ 注意:此字段可能返回 null,表示取不到有效值。
10598
+ */
10599
+ Name?: string
10589
10600
  }
10590
10601
 
10591
10602
  /**
@@ -42,6 +42,7 @@ import {
42
42
  RocketMQVipInstance,
43
43
  RabbitMQVipInstance,
44
44
  DescribeCmqQueuesResponse,
45
+ CreateRabbitMQVipInstanceRequest,
45
46
  DescribeAllTenantsResponse,
46
47
  DescribeRabbitMQNodeListRequest,
47
48
  DescribeNamespaceBundlesOptResponse,
@@ -187,6 +188,7 @@ import {
187
188
  CreateCmqTopicResponse,
188
189
  CmqDeadLetterSource,
189
190
  ClearCmqSubscriptionFilterTagsResponse,
191
+ CreateRabbitMQVipInstanceResponse,
190
192
  DescribeCmqTopicsRequest,
191
193
  Filter,
192
194
  AMQPExchange,
@@ -479,13 +481,13 @@ export class Client extends AbstractClient {
479
481
  }
480
482
 
481
483
  /**
482
- * 修改环境角色授权。
484
+ * 创建RocketMQ消费组
483
485
  */
484
- async ModifyEnvironmentRole(
485
- req: ModifyEnvironmentRoleRequest,
486
- cb?: (error: string, rep: ModifyEnvironmentRoleResponse) => void
487
- ): Promise<ModifyEnvironmentRoleResponse> {
488
- return this.request("ModifyEnvironmentRole", req, cb)
486
+ async CreateRocketMQGroup(
487
+ req: CreateRocketMQGroupRequest,
488
+ cb?: (error: string, rep: CreateRocketMQGroupResponse) => void
489
+ ): Promise<CreateRocketMQGroupResponse> {
490
+ return this.request("CreateRocketMQGroup", req, cb)
489
491
  }
490
492
 
491
493
  /**
@@ -938,6 +940,16 @@ export class Client extends AbstractClient {
938
940
  return this.request("DescribeAMQPClusters", req, cb)
939
941
  }
940
942
 
943
+ /**
944
+ * 创建RabbitMQ专享版实例
945
+ */
946
+ async CreateRabbitMQVipInstance(
947
+ req: CreateRabbitMQVipInstanceRequest,
948
+ cb?: (error: string, rep: CreateRabbitMQVipInstanceResponse) => void
949
+ ): Promise<CreateRabbitMQVipInstanceResponse> {
950
+ return this.request("CreateRabbitMQVipInstance", req, cb)
951
+ }
952
+
941
953
  /**
942
954
  * 产品下线了,对应的接口也要下线。
943
955
 
@@ -1138,6 +1150,16 @@ BatchReceivePolicy 的接口会一次性返回多条消息:
1138
1150
  return this.request("DescribeRocketMQTopics", req, cb)
1139
1151
  }
1140
1152
 
1153
+ /**
1154
+ * 修改环境角色授权。
1155
+ */
1156
+ async ModifyEnvironmentRole(
1157
+ req: ModifyEnvironmentRoleRequest,
1158
+ cb?: (error: string, rep: ModifyEnvironmentRoleResponse) => void
1159
+ ): Promise<ModifyEnvironmentRoleResponse> {
1160
+ return this.request("ModifyEnvironmentRole", req, cb)
1161
+ }
1162
+
1141
1163
  /**
1142
1164
  * 获取RocketMQ集群列表
1143
1165
  */
@@ -1303,13 +1325,13 @@ BatchReceivePolicy 的接口会一次性返回多条消息:
1303
1325
  }
1304
1326
 
1305
1327
  /**
1306
- * 创建RocketMQ消费组
1328
+ * 删除cmq订阅
1307
1329
  */
1308
- async CreateRocketMQGroup(
1309
- req: CreateRocketMQGroupRequest,
1310
- cb?: (error: string, rep: CreateRocketMQGroupResponse) => void
1311
- ): Promise<CreateRocketMQGroupResponse> {
1312
- return this.request("CreateRocketMQGroup", req, cb)
1330
+ async DeleteCmqSubscribe(
1331
+ req: DeleteCmqSubscribeRequest,
1332
+ cb?: (error: string, rep: DeleteCmqSubscribeResponse) => void
1333
+ ): Promise<DeleteCmqSubscribeResponse> {
1334
+ return this.request("DeleteCmqSubscribe", req, cb)
1313
1335
  }
1314
1336
 
1315
1337
  /**
@@ -1322,16 +1344,6 @@ BatchReceivePolicy 的接口会一次性返回多条消息:
1322
1344
  return this.request("ModifyRole", req, cb)
1323
1345
  }
1324
1346
 
1325
- /**
1326
- * 删除cmq订阅
1327
- */
1328
- async DeleteCmqSubscribe(
1329
- req: DeleteCmqSubscribeRequest,
1330
- cb?: (error: string, rep: DeleteCmqSubscribeResponse) => void
1331
- ): Promise<DeleteCmqSubscribeResponse> {
1332
- return this.request("DeleteCmqSubscribe", req, cb)
1333
- }
1334
-
1335
1347
  /**
1336
1348
  * 获取某个租户的虚拟集群列表
1337
1349
  */
@@ -730,6 +730,61 @@ export interface DescribeCmqQueuesResponse {
730
730
  RequestId?: string
731
731
  }
732
732
 
733
+ /**
734
+ * CreateRabbitMQVipInstance请求参数结构体
735
+ */
736
+ export interface CreateRabbitMQVipInstanceRequest {
737
+ /**
738
+ * 可用区
739
+ */
740
+ ZoneIds: Array<number>
741
+
742
+ /**
743
+ * 私有网络VpcId
744
+ */
745
+ VpcId: string
746
+
747
+ /**
748
+ * 私有网络SubnetId
749
+ */
750
+ SubnetId: string
751
+
752
+ /**
753
+ * 集群名称
754
+ */
755
+ ClusterName: string
756
+
757
+ /**
758
+ * 节点规格,基础型rabbit-vip-basic-1,标准型rabbit-vip-basic-2,高阶1型rabbit-vip-basic-3,高阶2型rabbit-vip-basic-4。不传默认为基础型
759
+ */
760
+ NodeSpec?: string
761
+
762
+ /**
763
+ * 节点数量,多可用区最少为3节点。不传默认单可用区为1,多可用区为3
764
+ */
765
+ NodeNum?: number
766
+
767
+ /**
768
+ * 单节点存储规格,不传默认为200G
769
+ */
770
+ StorageSize?: number
771
+
772
+ /**
773
+ * 镜像队列,不传默认为false
774
+ */
775
+ EnableCreateDefaultHaMirrorQueue?: boolean
776
+
777
+ /**
778
+ * 自动续费,不传默认为true
779
+ */
780
+ AutoRenewFlag?: boolean
781
+
782
+ /**
783
+ * 购买时长,不传默认为1(月)
784
+ */
785
+ TimeSpan?: number
786
+ }
787
+
733
788
  /**
734
789
  * DescribeAllTenants返回参数结构体
735
790
  */
@@ -4747,6 +4802,28 @@ export interface ClearCmqSubscriptionFilterTagsResponse {
4747
4802
  RequestId?: string
4748
4803
  }
4749
4804
 
4805
+ /**
4806
+ * CreateRabbitMQVipInstance返回参数结构体
4807
+ */
4808
+ export interface CreateRabbitMQVipInstanceResponse {
4809
+ /**
4810
+ * 订单号Id
4811
+ 注意:此字段可能返回 null,表示取不到有效值。
4812
+ */
4813
+ TranId?: string
4814
+
4815
+ /**
4816
+ * 实例Id
4817
+ 注意:此字段可能返回 null,表示取不到有效值。
4818
+ */
4819
+ InstanceId?: string
4820
+
4821
+ /**
4822
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4823
+ */
4824
+ RequestId?: string
4825
+ }
4826
+
4750
4827
  /**
4751
4828
  * DescribeCmqTopics请求参数结构体
4752
4829
  */
@@ -565,8 +565,10 @@ export class Client extends AbstractClient {
565
565
  }
566
566
 
567
567
  /**
568
- * 本接口(DescribeOverviewL7Data)用于查询七层监控类时序流量数据。
569
- */
568
+ * 接口已经不兼容升级,故作下线处理
569
+
570
+ 本接口(DescribeOverviewL7Data)用于查询七层监控类时序流量数据。
571
+ */
570
572
  async DescribeOverviewL7Data(
571
573
  req: DescribeOverviewL7DataRequest,
572
574
  cb?: (error: string, rep: DescribeOverviewL7DataResponse) => void
@@ -675,8 +677,10 @@ export class Client extends AbstractClient {
675
677
  }
676
678
 
677
679
  /**
678
- * 查询waf攻击top数据
679
- */
680
+ * 此版本的接口已经废弃
681
+
682
+ 查询waf攻击top数据
683
+ */
680
684
  async DescribeWebManagedRulesTopData(
681
685
  req: DescribeWebManagedRulesTopDataRequest,
682
686
  cb?: (error: string, rep: DescribeWebManagedRulesTopDataResponse) => void
@@ -755,8 +759,10 @@ export class Client extends AbstractClient {
755
759
  }
756
760
 
757
761
  /**
758
- * 四层时序流量数据查询
759
- */
762
+ * 旧版本的接口已经不兼容,故作下线处理
763
+
764
+ 四层时序流量数据查询
765
+ */
760
766
  async DescribeTimingL4Data(
761
767
  req: DescribeTimingL4DataRequest,
762
768
  cb?: (error: string, rep: DescribeTimingL4DataResponse) => void
@@ -1175,8 +1181,10 @@ export class Client extends AbstractClient {
1175
1181
  }
1176
1182
 
1177
1183
  /**
1178
- * 查询DDos主攻击事件
1179
- */
1184
+ * 此接口已经做不兼容变更,所以此版本的接口已经无法调用,故作下线处理
1185
+
1186
+ 查询DDos主攻击事件
1187
+ */
1180
1188
  async DescribeDDosMajorAttackEvent(
1181
1189
  req: DescribeDDosMajorAttackEventRequest,
1182
1190
  cb?: (error: string, rep: DescribeDDosMajorAttackEventResponse) => void
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.556";
1
+ export declare const sdkVersion = "4.0.558";
@@ -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.556";
4
+ exports.sdkVersion = "4.0.558";
@@ -2030,11 +2030,11 @@ export interface DescribeBinlogsResponse {
2030
2030
  /**
2031
2031
  * 符合查询条件的日志文件总数。
2032
2032
  */
2033
- TotalCount: number;
2033
+ TotalCount?: number;
2034
2034
  /**
2035
2035
  * 符合查询条件的二进制日志文件详情。
2036
2036
  */
2037
- Items: Array<BinlogInfo>;
2037
+ Items?: Array<BinlogInfo>;
2038
2038
  /**
2039
2039
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2040
2040
  */
@@ -2696,11 +2696,11 @@ export interface DescribeBackupsResponse {
2696
2696
  /**
2697
2697
  * 符合查询条件的实例总数。
2698
2698
  */
2699
- TotalCount: number;
2699
+ TotalCount?: number;
2700
2700
  /**
2701
2701
  * 符合查询条件的备份信息详情。
2702
2702
  */
2703
- Items: Array<BackupInfo>;
2703
+ Items?: Array<BackupInfo>;
2704
2704
  /**
2705
2705
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2706
2706
  */
@@ -2799,79 +2799,79 @@ export interface DescribeBackupConfigResponse {
2799
2799
  /**
2800
2800
  * 自动备份开始的最早时间点,单位为时刻。例如,2 - 凌晨 2:00。(该字段已废弃,建议使用 BackupTimeWindow 字段)
2801
2801
  */
2802
- StartTimeMin: number;
2802
+ StartTimeMin?: number;
2803
2803
  /**
2804
2804
  * 自动备份开始的最晚时间点,单位为时刻。例如,6 - 凌晨 6:00。(该字段已废弃,建议使用 BackupTimeWindow 字段)
2805
2805
  */
2806
- StartTimeMax: number;
2806
+ StartTimeMax?: number;
2807
2807
  /**
2808
2808
  * 备份文件保留时间,单位为天。
2809
2809
  */
2810
- BackupExpireDays: number;
2810
+ BackupExpireDays?: number;
2811
2811
  /**
2812
2812
  * 备份方式,可能的值为:physical - 物理备份,logical - 逻辑备份。
2813
2813
  */
2814
- BackupMethod: string;
2814
+ BackupMethod?: string;
2815
2815
  /**
2816
2816
  * Binlog 文件保留时间,单位为天。
2817
2817
  */
2818
- BinlogExpireDays: number;
2818
+ BinlogExpireDays?: number;
2819
2819
  /**
2820
2820
  * 实例自动备份的时间窗。
2821
2821
  */
2822
- BackupTimeWindow: CommonTimeWindow;
2822
+ BackupTimeWindow?: CommonTimeWindow;
2823
2823
  /**
2824
2824
  * 定期保留开关,off - 不开启定期保留策略,on - 开启定期保留策略,默认为off
2825
2825
  */
2826
- EnableBackupPeriodSave: string;
2826
+ EnableBackupPeriodSave?: string;
2827
2827
  /**
2828
2828
  * 定期保留最长天数,最小值:90,最大值:3650,默认值:1080
2829
2829
  */
2830
- BackupPeriodSaveDays: number;
2830
+ BackupPeriodSaveDays?: number;
2831
2831
  /**
2832
2832
  * 定期保留策略周期,可取值:weekly - 周,monthly - 月, quarterly - 季度,yearly - 年,默认为monthly
2833
2833
  */
2834
- BackupPeriodSaveInterval: string;
2834
+ BackupPeriodSaveInterval?: string;
2835
2835
  /**
2836
2836
  * 定期保留的备份数量,最小值为1,最大值不超过定期保留策略周期内常规备份个数,默认值为1
2837
2837
  */
2838
- BackupPeriodSaveCount: number;
2838
+ BackupPeriodSaveCount?: number;
2839
2839
  /**
2840
2840
  * 定期保留策略周期起始日期,格式:YYYY-MM-dd HH:mm:ss
2841
2841
  */
2842
- StartBackupPeriodSaveDate: string;
2842
+ StartBackupPeriodSaveDate?: string;
2843
2843
  /**
2844
2844
  * 是否开启数据备份归档策略,off-关闭,on-打开,默认为off
2845
2845
  */
2846
- EnableBackupArchive: string;
2846
+ EnableBackupArchive?: string;
2847
2847
  /**
2848
2848
  * 数据备份归档起始天数,数据备份达到归档起始天数时进行归档,最小为180天,不得大于数据备份保留天数
2849
2849
  */
2850
- BackupArchiveDays: number;
2850
+ BackupArchiveDays?: number;
2851
2851
  /**
2852
2852
  * 是否开启日志备份归档策略,off-关闭,on-打开,默认为off
2853
2853
  */
2854
- EnableBinlogArchive: string;
2854
+ EnableBinlogArchive?: string;
2855
2855
  /**
2856
2856
  * 日志备份归档起始天数,日志备份达到归档起始天数时进行归档,最小为180天,不得大于日志备份保留天数
2857
2857
  */
2858
- BinlogArchiveDays: number;
2858
+ BinlogArchiveDays?: number;
2859
2859
  /**
2860
2860
  * 是否开启数据备份标准存储策略,off-关闭,on-打开,默认为off
2861
2861
  */
2862
- EnableBackupStandby: string;
2862
+ EnableBackupStandby?: string;
2863
2863
  /**
2864
2864
  * 数据备份标准存储起始天数,数据备份达到标准存储起始天数时进行转换,最小为30天,不得大于数据备份保留天数。如果开启备份归档,不得大于等于备份归档天数
2865
2865
  */
2866
- BackupStandbyDays: number;
2866
+ BackupStandbyDays?: number;
2867
2867
  /**
2868
2868
  * 是否开启日志备份标准存储策略,off-关闭,on-打开,默认为off
2869
2869
  */
2870
- EnableBinlogStandby: string;
2870
+ EnableBinlogStandby?: string;
2871
2871
  /**
2872
2872
  * 日志备份标准存储起始天数,日志备份达到标准存储起始天数时进行转换,最小为30天,不得大于日志备份保留天数。如果开启备份归档,不得大于等于备份归档天数
2873
2873
  */
2874
- BinlogStandbyDays: number;
2874
+ BinlogStandbyDays?: number;
2875
2875
  /**
2876
2876
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2877
2877
  */
@@ -63,6 +63,11 @@ export interface TopicDetail {
63
63
  注意:此字段可能返回 null,表示取不到有效值。
64
64
  */
65
65
  Status: number;
66
+ /**
67
+ * 标签列表
68
+ 注意:此字段可能返回 null,表示取不到有效值。
69
+ */
70
+ Tags: Array<Tag>;
66
71
  }
67
72
  /**
68
73
  * DeleteAcl请求参数结构体
@@ -5773,6 +5778,11 @@ export interface TopicAttributesResponse {
5773
5778
  注意:此字段可能返回 null,表示取不到有效值。
5774
5779
  */
5775
5780
  QuotaConfig: InstanceQuotaConfigResp;
5781
+ /**
5782
+ * 副本数
5783
+ 注意:此字段可能返回 null,表示取不到有效值。
5784
+ */
5785
+ ReplicaNum: number;
5776
5786
  }
5777
5787
  /**
5778
5788
  * Ckafka配置
@@ -5796,11 +5796,11 @@ export interface DescribeBaselineDownloadListResponse {
5796
5796
  /**
5797
5797
  * 无
5798
5798
  */
5799
- List: Array<BaselineDownload>;
5799
+ List?: Array<BaselineDownload>;
5800
5800
  /**
5801
5801
  * 总数
5802
5802
  */
5803
- Total: number;
5803
+ Total?: number;
5804
5804
  /**
5805
5805
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
5806
5806
  */
@@ -6594,11 +6594,11 @@ export interface DescribeBaselineFixListResponse {
6594
6594
  /**
6595
6595
  * 无
6596
6596
  */
6597
- List: Array<BaselineFix>;
6597
+ List?: Array<BaselineFix>;
6598
6598
  /**
6599
6599
  * 总数
6600
6600
  */
6601
- Total: number;
6601
+ Total?: number;
6602
6602
  /**
6603
6603
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6604
6604
  */
@@ -8548,7 +8548,7 @@ export interface BaselineItemDetect {
8548
8548
  */
8549
8549
  export interface DescribeBaselineFixListRequest {
8550
8550
  /**
8551
- * <li>ItemName- string - 是否必填:否 - 项名称</i>
8551
+ * <li>ItemName- string - 是否必填:否 - 项名称</li>
8552
8552
  */
8553
8553
  Filters?: Array<Filter>;
8554
8554
  /**
@@ -11271,7 +11271,7 @@ export interface DescribeBaselineItemIgnoreListRequest {
11271
11271
  */
11272
11272
  Offset?: number;
11273
11273
  /**
11274
- * <li>CatgoryId - int64 - 是否必填:否 - 规则Id</i>
11274
+ * <li>CatgoryId - int64 - 是否必填:否 - 规则Id</li>
11275
11275
  */
11276
11276
  Filters?: Array<Filter>;
11277
11277
  /**
@@ -16079,11 +16079,11 @@ export interface DescribeBaselineItemIgnoreListResponse {
16079
16079
  /**
16080
16080
  * 无
16081
16081
  */
16082
- List: Array<BaselineItemInfo>;
16082
+ List?: Array<BaselineItemInfo>;
16083
16083
  /**
16084
16084
  * 总数
16085
16085
  */
16086
- Total: number;
16086
+ Total?: number;
16087
16087
  /**
16088
16088
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
16089
16089
  */
@@ -1062,6 +1062,11 @@ export interface BatchRecordInfo {
1062
1062
  注意:此字段可能返回 null,表示取不到有效值。
1063
1063
  */
1064
1064
  MX: number;
1065
+ /**
1066
+ * 记录权重
1067
+ 注意:此字段可能返回 null,表示取不到有效值。
1068
+ */
1069
+ Weight?: number;
1065
1070
  }
1066
1071
  /**
1067
1072
  * 线路分组信息
@@ -145,7 +145,7 @@ callbackinfo包含: 回调地址和签名key
145
145
  */
146
146
  DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
147
147
  /**
148
- * 创建签署链接,需要联系运营人员开白后才可使用
148
+ * 创建签署链接,请联系客户经理申请使用
149
149
  */
150
150
  CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
151
151
  /**
@@ -161,13 +161,14 @@ callbackinfo包含: 回调地址和签名key
161
161
  /**
162
162
  * 此接口(UploadFiles)用于文件上传。
163
163
  适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
164
+ 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。
164
165
  调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,并设置参数Version/版本号为2020-12-22
165
166
  */
166
167
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
167
168
  /**
168
169
  * 指定需要批量催办的签署流程Id,批量催办合同,最多100个; 接口失败后返回错误信息
169
170
  注意:
170
- 该接口不可直接调用,需要联系运营开通后方可调用。
171
+ 该接口不可直接调用,请联系客户经理申请使用
171
172
  */
172
173
  CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
173
174
  /**
@@ -219,7 +219,7 @@ callbackinfo包含: 回调地址和签名key
219
219
  return this.request("DescribeIntegrationEmployees", req, cb);
220
220
  }
221
221
  /**
222
- * 创建签署链接,需要联系运营人员开白后才可使用
222
+ * 创建签署链接,请联系客户经理申请使用
223
223
  */
224
224
  async CreateFlowSignUrl(req, cb) {
225
225
  return this.request("CreateFlowSignUrl", req, cb);
@@ -241,6 +241,7 @@ callbackinfo包含: 回调地址和签名key
241
241
  /**
242
242
  * 此接口(UploadFiles)用于文件上传。
243
243
  适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
244
+ 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。
244
245
  调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,并设置参数Version/版本号为2020-12-22
245
246
  */
246
247
  async UploadFiles(req, cb) {
@@ -249,7 +250,7 @@ callbackinfo包含: 回调地址和签名key
249
250
  /**
250
251
  * 指定需要批量催办的签署流程Id,批量催办合同,最多100个; 接口失败后返回错误信息
251
252
  注意:
252
- 该接口不可直接调用,需要联系运营开通后方可调用。
253
+ 该接口不可直接调用,请联系客户经理申请使用
253
254
  */
254
255
  async CreateFlowReminds(req, cb) {
255
256
  return this.request("CreateFlowReminds", req, cb);
@@ -1242,7 +1242,7 @@ export interface CreateFlowSignUrlResponse {
1242
1242
  /**
1243
1243
  * 签署人签署链接信息
1244
1244
  */
1245
- FlowApproverUrlInfos: Array<FlowApproverUrlInfo>;
1245
+ FlowApproverUrlInfos?: Array<FlowApproverUrlInfo>;
1246
1246
  /**
1247
1247
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1248
1248
  */
@@ -1924,11 +1924,11 @@ export interface UploadFilesResponse {
1924
1924
  /**
1925
1925
  * 文件id数组
1926
1926
  */
1927
- FileIds: Array<string>;
1927
+ FileIds?: Array<string>;
1928
1928
  /**
1929
1929
  * 上传成功文件数量
1930
1930
  */
1931
- TotalCount: number;
1931
+ TotalCount?: number;
1932
1932
  /**
1933
1933
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1934
1934
  */
@@ -24,7 +24,7 @@ export declare class Client extends AbstractClient {
24
24
  */
25
25
  ChannelCreateMultiFlowSignQRCode(req: ChannelCreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCreateMultiFlowSignQRCodeResponse) => void): Promise<ChannelCreateMultiFlowSignQRCodeResponse>;
26
26
  /**
27
- * 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,需要运营申请
27
+ * 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
28
28
  */
29
29
  ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
30
30
  /**
@@ -73,9 +73,17 @@ export declare class Client extends AbstractClient {
73
73
  跳转小程序的几种方式:主要是设置不同的EndPoint
74
74
  1. 通过链接Url直接跳转到小程序,不需要返回
75
75
  设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
76
+
76
77
  2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
77
78
  设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
79
+
78
80
  3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
81
+ 跳转到小程序的实现,参考官方文档
82
+ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
83
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
84
+ 使用CreateSignUrls,设置EndPoint为APP,得到path。
85
+
86
+ 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
79
87
  跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
80
88
  全屏方式:
81
89
  (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
@@ -83,8 +91,6 @@ export declare class Client extends AbstractClient {
83
91
  (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
84
92
  其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
85
93
  使用CreateSignUrls,设置EndPoint为APP,得到path。
86
- 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
87
- 实现方式同App跳小程序。
88
94
  */
89
95
  CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
90
96
  /**
@@ -100,6 +106,10 @@ export declare class Client extends AbstractClient {
100
106
  ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
101
107
  /**
102
108
  * 创建预发起合同
109
+ 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
110
+ 可指定合同信息不可更改,签署人信息不可更改
111
+ 合同发起后,填写及签署流程与现有操作流程一致
112
+ 注意:目前仅支持模版发起
103
113
  */
104
114
  ChannelCreatePrepareFlow(req: ChannelCreatePrepareFlowRequest, cb?: (error: string, rep: ChannelCreatePrepareFlowResponse) => void): Promise<ChannelCreatePrepareFlowResponse>;
105
115
  /**
@@ -134,7 +144,10 @@ export declare class Client extends AbstractClient {
134
144
  */
135
145
  GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
136
146
  /**
137
- * 创建签署链接,需要联系运营人员开白后才可使用
147
+ * 创建签署链接,请联系客户经理申请使用
148
+ 该接口用于发起合同后,生成C端签署人的签署链接,点击跳转小程序完成签署
149
+ 注意:该接口目前签署人类型仅支持个人签署方(PERSON)
150
+ 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
138
151
  */
139
152
  ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
140
153
  /**
@@ -176,6 +189,7 @@ export declare class Client extends AbstractClient {
176
189
  DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
177
190
  /**
178
191
  * 此接口(UploadFiles)用于文件上传。
192
+ 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。
179
193
  调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。
180
194
  代码示例:
181
195
  HttpProfile httpProfile = new HttpProfile();
@@ -185,7 +199,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
185
199
  /**
186
200
  * 指定需要批量催办的签署流程Id,批量催办合同,最多100个;接口失败后返回错误信息
187
201
  注意:
188
- 该接口不可直接调用,请联系电子签运营开通后方可调用。
202
+ 该接口不可直接调用,请联系客户经理申请使用
189
203
  */
190
204
  ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
191
205
  /**
@@ -215,6 +229,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
215
229
  ChannelCreateFlowGroupByFiles(req: ChannelCreateFlowGroupByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void): Promise<ChannelCreateFlowGroupByFilesResponse>;
216
230
  /**
217
231
  * 本接口(ChannelCreateEmbedWebUrl)用于创建嵌入web的链接
232
+ 本接口支持创建:创建印章,创建模版,修改模版,预览模版,预览合同流程的web链接
233
+ 进入web连接后与当前控制台操作保持一致
218
234
  */
219
235
  ChannelCreateEmbedWebUrl(req: ChannelCreateEmbedWebUrlRequest, cb?: (error: string, rep: ChannelCreateEmbedWebUrlResponse) => void): Promise<ChannelCreateEmbedWebUrlResponse>;
220
236
  /**