tencentcloud-sdk-nodejs 4.1.39 → 4.1.41

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 (49) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/mps/v20190612/mps_client.js +9 -0
  3. package/es/services/postgres/v20170312/postgres_client.js +8 -14
  4. package/es/services/tke/v20180525/tke_client.js +0 -3
  5. package/package.json +1 -1
  6. package/tencentcloud/common/sdk_version.d.ts +1 -1
  7. package/tencentcloud/common/sdk_version.js +1 -1
  8. package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +3 -3
  9. package/tencentcloud/services/cbs/v20170312/cbs_client.js +3 -3
  10. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +36 -29
  11. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +1 -1
  12. package/tencentcloud/services/cdb/v20170320/cdb_client.js +1 -1
  13. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +5 -0
  14. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +8 -0
  15. package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +2 -2
  16. package/tencentcloud/services/cfs/v20190719/cfs_client.js +2 -2
  17. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +24 -25
  18. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +1 -1
  19. package/tencentcloud/services/cfw/v20190904/cfw_client.js +1 -1
  20. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +1 -1
  21. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +18 -8
  22. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +66 -0
  23. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +5 -6
  24. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +4 -0
  25. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +20 -13
  26. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  27. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  28. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +13 -3
  29. package/tencentcloud/services/gs/v20191118/gs_models.d.ts +8 -0
  30. package/tencentcloud/services/hai/v20230812/hai_client.d.ts +8 -6
  31. package/tencentcloud/services/hai/v20230812/hai_client.js +8 -6
  32. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +36 -42
  33. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +183 -1
  34. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +14 -1
  35. package/tencentcloud/services/mps/v20190612/mps_client.js +19 -0
  36. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +276 -36
  37. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +9 -21
  38. package/tencentcloud/services/postgres/v20170312/postgres_client.js +12 -28
  39. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +64 -108
  40. package/tencentcloud/services/privatedns/v20201028/privatedns_models.d.ts +4 -4
  41. package/tencentcloud/services/pts/v20210728/pts_models.d.ts +4 -0
  42. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +88 -3
  43. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +5 -0
  44. package/tencentcloud/services/teo/v20220901/teo_client.js +5 -0
  45. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +1 -5
  46. package/tencentcloud/services/tke/v20180525/tke_client.js +0 -6
  47. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +4 -50
  48. package/tencentcloud/services/tms/v20201229/tms_models.d.ts +11 -2
  49. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +9 -9
@@ -480,7 +480,7 @@ export interface BindAutoSnapshotPolicyRequest {
480
480
  */
481
481
  export interface ModifyFileSystemAutoScaleUpRuleRequest {
482
482
  /**
483
- * 文件系统id
483
+ * 文件系统id,通过查询文件系统列表获取该参数
484
484
  */
485
485
  FileSystemId: string;
486
486
  /**
@@ -492,8 +492,7 @@ export interface ModifyFileSystemAutoScaleUpRuleRequest {
492
492
  */
493
493
  TargetThreshold: number;
494
494
  /**
495
- * 规则状态0:关闭,1 开启
496
-
495
+ * 规则状态0:关闭,1 开启;不传保留原状态
497
496
  */
498
497
  Status?: number;
499
498
  }
@@ -502,7 +501,7 @@ export interface ModifyFileSystemAutoScaleUpRuleRequest {
502
501
  */
503
502
  export interface ScaleUpFileSystemRequest {
504
503
  /**
505
- * 文件系统Id
504
+ * 文件系统Id,该参数通过查询文件系统列表接口获取
506
505
  */
507
506
  FileSystemId: string;
508
507
  /**
@@ -773,7 +772,7 @@ export interface SnapshotOperateLog {
773
772
  */
774
773
  export interface DeleteAutoSnapshotPolicyRequest {
775
774
  /**
776
- * 快照策略ID
775
+ * 快照策略ID,查询快照策略接口获取
777
776
  */
778
777
  AutoSnapshotPolicyId: string;
779
778
  }
@@ -1023,7 +1022,7 @@ export interface DeleteCfsFileSystemRequest {
1023
1022
  */
1024
1023
  export interface UpdateFileSystemBandwidthLimitRequest {
1025
1024
  /**
1026
- * 文件系统 ID
1025
+ * 文件系统 ID,通过查询文件系统列表获取
1027
1026
  */
1028
1027
  FileSystemId: string;
1029
1028
  /**
@@ -1100,7 +1099,7 @@ export interface PGroup {
1100
1099
  */
1101
1100
  export interface SetUserQuotaRequest {
1102
1101
  /**
1103
- * 文件系统 ID
1102
+ * 文件系统 ID,通过查询文件系统列表获取
1104
1103
  */
1105
1104
  FileSystemId: string;
1106
1105
  /**
@@ -1305,21 +1304,21 @@ export interface CreateAccessCertRequest {
1305
1304
  */
1306
1305
  export interface DescribeUserQuotaRequest {
1307
1306
  /**
1308
- * 文件系统 ID
1307
+ * 文件系统 ID,通过查询文件系统列表获取
1309
1308
  */
1310
1309
  FileSystemId: string;
1311
1310
  /**
1312
1311
  * 过滤条件。
1313
- UserType - Array of String - 是否必填:否 -(过滤条件)按配额类型过滤。(Uid|Gid|Dir )
1314
- UserId- Array of String - 是否必填:否 -(过滤条件)按id过滤。
1312
+ UserType - Array of String - 是否必填:否 -(过滤条件)按配额类型过滤。(Uid|Gid|Dir,分别对应用户,用户组,目录 )
1313
+ UserId- Array of String - 是否必填:否 -(过滤条件)按用户id过滤。
1315
1314
  */
1316
1315
  Filters?: Array<Filter>;
1317
1316
  /**
1318
- * Offset 分页码
1317
+ * Offset 分页码,默认值0
1319
1318
  */
1320
1319
  Offset?: number;
1321
1320
  /**
1322
- * Limit 页面大小,可填范围为大于0的整数
1321
+ * Limit 页面大小,可填范围为大于0的整数,默认值是10
1323
1322
  */
1324
1323
  Limit?: number;
1325
1324
  }
@@ -1501,11 +1500,11 @@ export interface CreateCfsFileSystemRequest {
1501
1500
  */
1502
1501
  NetInterface: string;
1503
1502
  /**
1504
- * 权限组 ID
1503
+ * 权限组 ID,pgroupbasic 是默认权限组
1505
1504
  */
1506
1505
  PGroupId: string;
1507
1506
  /**
1508
- * 文件系统协议类型, 值为 NFS、CIFS、TURBO ; 若留空则默认为 NFS协议,turbo系列必须选择turbo,不支持NFS、CIFS
1507
+ * 文件系统协议类型, 值为 NFS、CIFS、TURBO ; 若留空则默认为 NFS协议,turbo系列必须选择TURBO,不支持NFS、CIFS
1509
1508
  */
1510
1509
  Protocol?: string;
1511
1510
  /**
@@ -1513,11 +1512,11 @@ export interface CreateCfsFileSystemRequest {
1513
1512
  */
1514
1513
  StorageType?: string;
1515
1514
  /**
1516
- * 私有网络(VPC) ID,若网络类型选择的是VPC,该字段为必填。
1515
+ * 私有网络(VPC) ID,若网络类型选择的是VPC,该字段为必填.通过查询私有网络接口获取
1517
1516
  */
1518
1517
  VpcId?: string;
1519
1518
  /**
1520
- * 子网 ID,若网络类型选择的是VPC,该字段为必填。
1519
+ * 子网 ID,若网络类型选择的是VPC,该字段为必填。通过查询子网接口获取
1521
1520
  */
1522
1521
  SubnetId?: string;
1523
1522
  /**
@@ -1537,7 +1536,7 @@ export interface CreateCfsFileSystemRequest {
1537
1536
  */
1538
1537
  ClientToken?: string;
1539
1538
  /**
1540
- * 云联网ID, 若网络类型选择的是CCN,该字段为必填
1539
+ * 云联网ID, 若网络类型选择的是CCN,该字段为必填;通过查询云联网列表接口获取
1541
1540
  */
1542
1541
  CcnId?: string;
1543
1542
  /**
@@ -1549,15 +1548,15 @@ export interface CreateCfsFileSystemRequest {
1549
1548
  */
1550
1549
  Capacity?: number;
1551
1550
  /**
1552
- * 文件系统快照ID
1551
+ * 文件系统快照ID,通过查询快照列表获取该参数
1553
1552
  */
1554
1553
  SnapshotId?: string;
1555
1554
  /**
1556
- * 定期快照策略ID
1555
+ * 定期快照策略ID,通过查询快照策略信息获取
1557
1556
  */
1558
1557
  AutoSnapshotPolicyId?: string;
1559
1558
  /**
1560
- * 是否开启默认扩容,仅Turbo类型文件存储支持
1559
+ * 是否开启默认扩容,仅turbo类型文件存储支持
1561
1560
  */
1562
1561
  EnableAutoScaleUp?: boolean;
1563
1562
  /**
@@ -1731,13 +1730,13 @@ export interface DescribeCfsSnapshotsRequest {
1731
1730
  <br>FileSystemId - Array of String - 是否必填:否 -(过滤条件)按文件系统ID过滤。
1732
1731
  <br>FsName - Array of String - 是否必填:否 -(过滤条件)按文件系统名过滤。
1733
1732
  <br>Status - Array of String - 是否必填:否 -(过滤条件)按照快照状态过滤
1734
- (creating:表示创建中 | available:表示可用。| rollbacking:表示回滚。| rollbacking_new:表示由快照创建新文件系统中)
1733
+ (creating:表示创建中 | available:表示可用。| rollbacking:表示回滚。| rollbacking_new:表示由快照创建新文件系统中| create-failed 创建失败)
1735
1734
  <br>tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键进行过滤。
1736
1735
  <br>tag:tag-key - Array of String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
1737
1736
  */
1738
1737
  Filters?: Array<Filter>;
1739
1738
  /**
1740
- * 排序取值
1739
+ * 按创建时间排序取值CreationTime
1741
1740
  */
1742
1741
  OrderField?: string;
1743
1742
  /**
@@ -1800,7 +1799,7 @@ export interface UpdateCfsFileSystemSizeLimitRequest {
1800
1799
  */
1801
1800
  FsLimit: number;
1802
1801
  /**
1803
- * 文件系统ID,目前仅支持标准型文件系统。
1802
+ * 文件系统ID,目前仅支持标准型文件系统。该参数通过查询文件系统列表获取
1804
1803
  */
1805
1804
  FileSystemId: string;
1806
1805
  }
@@ -1917,7 +1916,7 @@ export interface SnapshotInfo {
1917
1916
  */
1918
1917
  AliveDay?: number;
1919
1918
  /**
1920
- * 快照进度百分比,1表示1%
1919
+ * 快照进度百分比,1表示1% 范围1-100
1921
1920
  */
1922
1921
  Percent?: number;
1923
1922
  /**
@@ -2035,7 +2034,7 @@ export interface DeleteAutoSnapshotPolicyResponse {
2035
2034
  /**
2036
2035
  * 快照策略ID
2037
2036
  */
2038
- AutoSnapshotPolicyId: string;
2037
+ AutoSnapshotPolicyId?: string;
2039
2038
  /**
2040
2039
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2041
2040
  */
@@ -241,7 +241,7 @@ VPC间规则需指定EdgeId。Nat边界规则需指定地域Region与Direction
241
241
  */
242
242
  ModifyAddressTemplate(req: ModifyAddressTemplateRequest, cb?: (error: string, rep: ModifyAddressTemplateResponse) => void): Promise<ModifyAddressTemplateResponse>;
243
243
  /**
244
- * 防火墙开关列表,已废弃,请使用DescribeFwEdgeIps
244
+ * 防火墙开关列表,请换用DescribeFwEdgeIps
245
245
  */
246
246
  DescribeSwitchLists(req: DescribeSwitchListsRequest, cb?: (error: string, rep: DescribeSwitchListsResponse) => void): Promise<DescribeSwitchListsResponse>;
247
247
  /**
@@ -375,7 +375,7 @@ VPC间规则需指定EdgeId。Nat边界规则需指定地域Region与Direction
375
375
  return this.request("ModifyAddressTemplate", req, cb);
376
376
  }
377
377
  /**
378
- * 防火墙开关列表,已废弃,请使用DescribeFwEdgeIps
378
+ * 防火墙开关列表,请换用DescribeFwEdgeIps
379
379
  */
380
380
  async DescribeSwitchLists(req, cb) {
381
381
  return this.request("DescribeSwitchLists", req, cb);
@@ -1620,7 +1620,7 @@ export interface SecurityGroupRule {
1620
1620
  */
1621
1621
  Id?: string;
1622
1622
  /**
1623
- * (入参时、Enable已弃用;由通用配置中新增规则启用状态控制)
1623
+ * (入参时Enable无意义;由通用配置中新增规则启用状态控制)
1624
1624
  规则状态,true表示启用,false表示禁用
1625
1625
  */
1626
1626
  Enable?: string;
@@ -4001,15 +4001,18 @@ export interface AssociateSecurityGroupsResponse {
4001
4001
  */
4002
4002
  export interface ImportImageRequest {
4003
4003
  /**
4004
- * 导入镜像的操作系统架构,`x86_64` 或 `i386`
4004
+ * 导入镜像的操作系统架构。
4005
+ 取值范围包括:`x86_64` 、`i386`、`arm_64`
4005
4006
  */
4006
4007
  Architecture: string;
4007
4008
  /**
4008
- * 导入镜像的操作系统类型,通过`DescribeImportImageOs`获取
4009
+ * 导入镜像的操作系统类型 。
4010
+ 可通过 [DescribeImportImageOs](https://cloud.tencent.com/document/api/213/15718) 接口返回值中的`ImportImageOsListSupported`获取。
4009
4011
  */
4010
4012
  OsType: string;
4011
4013
  /**
4012
- * 导入镜像的操作系统版本,通过`DescribeImportImageOs`获取
4014
+ * 导入镜像的操作系统版本。
4015
+ 可通过 [DescribeImportImageOs](https://cloud.tencent.com/document/api/213/15718) 接口返回值中的`ImportImageOsVersionSet`获取。
4013
4016
  */
4014
4017
  OsVersion: string;
4015
4018
  /**
@@ -4017,19 +4020,23 @@ export interface ImportImageRequest {
4017
4020
  */
4018
4021
  ImageUrl: string;
4019
4022
  /**
4020
- * 镜像名称
4023
+ * 镜像名称。
4024
+ 最多支持 60 个字符。
4021
4025
  */
4022
4026
  ImageName: string;
4023
4027
  /**
4024
- * 镜像描述
4028
+ * 镜像描述。
4029
+ 最多支持 256 个字符。
4025
4030
  */
4026
4031
  ImageDescription?: string;
4027
4032
  /**
4028
- * 只检查参数,不执行任务
4033
+ * 只检查参数,不执行任务。
4034
+ 默认值:false
4029
4035
  */
4030
4036
  DryRun?: boolean;
4031
4037
  /**
4032
4038
  * 是否强制导入,参考[强制导入镜像](https://cloud.tencent.com/document/product/213/12849)
4039
+ 默认值:false
4033
4040
  */
4034
4041
  Force?: boolean;
4035
4042
  /**
@@ -4038,13 +4045,16 @@ export interface ImportImageRequest {
4038
4045
  TagSpecification?: Array<TagSpecification>;
4039
4046
  /**
4040
4047
  * 导入镜像后,激活操作系统采用的许可证类型。
4041
- 可选项:
4048
+ 默认值:TencentCloud
4049
+ 取值范围:
4042
4050
  TencentCloud: 腾讯云官方许可
4043
4051
  BYOL: 自带许可(Bring Your Own License)
4044
4052
  */
4045
4053
  LicenseType?: string;
4046
4054
  /**
4047
- * 启动模式
4055
+ * 启动模式。
4056
+ 取值范围:`Legacy BIOS`、`UEFI`
4057
+ 默认值:Legacy BIOS
4048
4058
  */
4049
4059
  BootMode?: string;
4050
4060
  /**
@@ -1112,6 +1112,10 @@ export interface CynosdbInstance {
1112
1112
  * libradb 节点信息
1113
1113
  */
1114
1114
  NodeList?: Array<string>;
1115
+ /**
1116
+ * 全球数据库唯一标识
1117
+ */
1118
+ GdnId?: string;
1115
1119
  }
1116
1120
  /**
1117
1121
  * DescribeClusterPasswordComplexity返回参数结构体
@@ -1956,6 +1960,7 @@ export interface DescribeAuditLogsRequest {
1956
1960
  OrderBy?: string;
1957
1961
  /**
1958
1962
  * 已废弃。
1963
+ * @deprecated
1959
1964
  */
1960
1965
  Filter?: AuditLogFilter;
1961
1966
  /**
@@ -2179,6 +2184,14 @@ export interface CreateClustersRequest {
2179
2184
  * 实例初始化配置信息,主要用于购买集群时选不同规格实例
2180
2185
  */
2181
2186
  InstanceInitInfos?: Array<InstanceInitInfo>;
2187
+ /**
2188
+ * 全球数据库唯一标识
2189
+ */
2190
+ GdnId?: string;
2191
+ /**
2192
+ * 数据库代理配置
2193
+ */
2194
+ ProxyConfig?: ProxyConfig;
2182
2195
  }
2183
2196
  /**
2184
2197
  * DescribeClusterParamLogs请求参数结构体
@@ -3706,6 +3719,43 @@ export interface DescribeParamTemplatesResponse {
3706
3719
  */
3707
3720
  RequestId?: string;
3708
3721
  }
3722
+ /**
3723
+ * 访问代理配置
3724
+ */
3725
+ export interface ProxyConfig {
3726
+ /**
3727
+ * 数据库代理组节点个数(该参数不再建议使用,建议使用ProxyZones)
3728
+ */
3729
+ ProxyCount?: number;
3730
+ /**
3731
+ * cpu核数
3732
+ */
3733
+ Cpu?: number;
3734
+ /**
3735
+ * 内存
3736
+ */
3737
+ Mem?: number;
3738
+ /**
3739
+ * 连接池类型:SessionConnectionPool(会话级别连接池 )
3740
+ */
3741
+ ConnectionPoolType?: string;
3742
+ /**
3743
+ * 是否开启连接池,yes-开启,no-不开启
3744
+ */
3745
+ OpenConnectionPool?: string;
3746
+ /**
3747
+ * 连接池阈值:单位(秒)
3748
+ */
3749
+ ConnectionPoolTimeOut?: number;
3750
+ /**
3751
+ * 描述说明
3752
+ */
3753
+ Description?: string;
3754
+ /**
3755
+ * 数据库节点信息(该参数与ProxyCount需要任选一个输入)
3756
+ */
3757
+ ProxyZones?: Array<ProxyZone>;
3758
+ }
3709
3759
  /**
3710
3760
  * 数据库地址
3711
3761
  */
@@ -7172,6 +7222,10 @@ export interface CynosdbCluster {
7172
7222
  * 实例绑定资源包信息(此处只返回存储资源包,即packageType=DISK)
7173
7223
  */
7174
7224
  ResourcePackages?: Array<ResourcePackage>;
7225
+ /**
7226
+ * 全球数据库唯一标识
7227
+ */
7228
+ GdnId?: string;
7175
7229
  }
7176
7230
  /**
7177
7231
  * OpenWan返回参数结构体
@@ -7455,6 +7509,7 @@ export interface CreateAuditLogFileRequest {
7455
7509
  OrderBy?: string;
7456
7510
  /**
7457
7511
  * 已废弃。
7512
+ * @deprecated
7458
7513
  */
7459
7514
  Filter?: AuditLogFilter;
7460
7515
  /**
@@ -7763,6 +7818,17 @@ export interface CynosdbClusterDetail {
7763
7818
  * 版本标签
7764
7819
  */
7765
7820
  CynosVersionTag?: string;
7821
+ /**
7822
+ * 全球数据库网络唯一标识
7823
+ */
7824
+ GdnId?: string;
7825
+ /**
7826
+ * 集群在全球数据网络中的角色。
7827
+ 主集群- primary
7828
+ 从集群 - standby
7829
+ 如为空,该字段无效
7830
+ */
7831
+ GdnRole?: string;
7766
7832
  }
7767
7833
  /**
7768
7834
  * RestartInstance请求参数结构体
@@ -5028,20 +5028,19 @@ export interface BatchSearchRecordInfo {
5028
5028
  /**
5029
5029
  * 解析线路
5030
5030
  */
5031
- Area: string;
5031
+ Area?: string;
5032
5032
  /**
5033
5033
  * 记录备注
5034
- 注意:此字段可能返回 null,表示取不到有效值。
5035
5034
  */
5036
5035
  Remark?: string;
5037
5036
  /**
5038
5037
  * TTL(秒)
5039
5038
  */
5040
- TTL: number;
5039
+ TTL?: number;
5041
5040
  /**
5042
5041
  * 记录类型
5043
5042
  */
5044
- RecordType: string;
5043
+ RecordType?: string;
5045
5044
  /**
5046
5045
  * 记录是否启用
5047
5046
  */
@@ -5058,11 +5057,11 @@ export interface BatchSearchRecordInfo {
5058
5057
  /**
5059
5058
  * 子域名
5060
5059
  */
5061
- SubDomain: string;
5060
+ SubDomain?: string;
5062
5061
  /**
5063
5062
  * 解析值
5064
5063
  */
5065
- Value: string;
5064
+ Value?: string;
5066
5065
  /**
5067
5066
  * MX优先级
5068
5067
  注意:此字段可能返回 null,表示取不到有效值。
@@ -390,6 +390,10 @@ export interface DescribeClusterFlowStatusDetailResponse {
390
390
  注意:此字段可能返回 null,表示取不到有效值。
391
391
  */
392
392
  FlowExtraDetail?: Array<FlowExtraDetail>;
393
+ /**
394
+ * 流程描述
395
+ */
396
+ FlowInfo?: string;
393
397
  /**
394
398
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
395
399
  */
@@ -378,9 +378,7 @@ export interface CreatePreparedPersonalEsignRequest {
378
378
  */
379
379
  IdCardType?: string;
380
380
  /**
381
- * 印章图片的base64
382
- 注:已废弃
383
- 请先通过UploadFiles接口上传文件,获取 FileId
381
+ * 该字段已不再使用
384
382
  * @deprecated
385
383
  */
386
384
  SealImage?: string;
@@ -393,7 +391,7 @@ export interface CreatePreparedPersonalEsignRequest {
393
391
  */
394
392
  Mobile?: string;
395
393
  /**
396
- * 此字段已废弃,请勿继续使用。
394
+ * 该字段已不再使用
397
395
  */
398
396
  EnableAutoSign?: boolean;
399
397
  /**
@@ -1246,6 +1244,11 @@ export interface CreateFlowOption {
1246
1244
  - 签署控件 是否默认展示日期.
1247
1245
  */
1248
1246
  SignComponentConfig?: SignComponentConfig;
1247
+ /**
1248
+ * 是否禁止编辑(展示)水印控件属性
1249
+ <ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
1250
+ */
1251
+ ForbidEditWatermark?: boolean;
1249
1252
  }
1250
1253
  /**
1251
1254
  * CreateOrganizationAuthFile返回参数结构体
@@ -2751,7 +2754,7 @@ export interface CreateFlowRequest {
2751
2754
  */
2752
2755
  FlowType?: string;
2753
2756
  /**
2754
- * 已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
2757
+ * 该字段已不再使用
2755
2758
  */
2756
2759
  ClientToken?: string;
2757
2760
  /**
@@ -6133,7 +6136,7 @@ export interface CreateDocumentRequest {
6133
6136
  */
6134
6137
  Agent?: Agent;
6135
6138
  /**
6136
- * 已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
6139
+ * 该字段已不再使用
6137
6140
  */
6138
6141
  ClientToken?: string;
6139
6142
  }
@@ -7180,9 +7183,9 @@ export interface ApproverInfo {
7180
7183
  */
7181
7184
  ApproverRoleName?: string;
7182
7185
  /**
7183
- * <font coloe="red">【已废弃】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别
7186
+ * <font color="red">【已不再使用】</font>签署意愿确认渠道,默认为WEIXINAPP:人脸识别
7184
7187
 
7185
- 注: 将要废弃, ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
7188
+ 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
7186
7189
  */
7187
7190
  VerifyChannel?: Array<string>;
7188
7191
  /**
@@ -8301,7 +8304,7 @@ export interface CreatePrepareFlowRequest {
8301
8304
  */
8302
8305
  IntelligentStatus?: string;
8303
8306
  /**
8304
- * 该字段已废弃,请使用InitiatorComponents
8307
+ * 该字段已不再使用,请使用InitiatorComponents
8305
8308
  */
8306
8309
  Components?: Component;
8307
8310
  /**
@@ -8359,7 +8362,7 @@ export interface CreatePrepareFlowRequest {
8359
8362
  */
8360
8363
  FlowDisplayType?: number;
8361
8364
  /**
8362
- * <font color="red">此参数已经废弃,请使用 CreateFlowOption 里面的 SignComponentConfig</font>
8365
+ * <font color="red">此字段已不再使用,请使用 CreateFlowOption 里面的 SignComponentConfig</font>
8363
8366
  签署控件的配置信息,用在嵌入式发起的页面配置,
8364
8367
  包括
8365
8368
 
@@ -9778,9 +9781,7 @@ export interface UploadFilesRequest {
9778
9781
  */
9779
9782
  CoverRect?: boolean;
9780
9783
  /**
9781
- * 用户自定义ID数组,与上传文件一一对应
9782
-
9783
- 注: `历史遗留问题,已经废弃,调用接口时不用赋值`
9784
+ * 该字段已不再使用
9784
9785
  */
9785
9786
  CustomIds?: Array<string>;
9786
9787
  /**
@@ -9945,6 +9946,12 @@ export interface EmbedUrlOption {
9945
9946
  注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**,
9946
9947
  */
9947
9948
  SkipUploadFile?: boolean;
9949
+ /**
9950
+ * 是否禁止编辑(展示)水印控件属性
9951
+ <ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
9952
+
9953
+ */
9954
+ ForbidEditWatermark?: boolean;
9948
9955
  }
9949
9956
  /**
9950
9957
  * CreateBatchOrganizationAuthorizationUrl请求参数结构体
@@ -471,7 +471,7 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
471
471
  /**
472
472
  * 该接口 (PrepareFlows) 用于创建待发起文件
473
473
  用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
474
- 目前该接口只支持B2C,<font color='red'> **不建议使用,将会废弃**</font>。
474
+ 目前该接口只支持B2C,<font color='red'> **不建议使用**</font>。
475
475
  */
476
476
  PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
477
477
  /**
@@ -559,7 +559,7 @@ Agent参数中的OpenId 必须为审批者的openId,且链接必须由审批
559
559
  /**
560
560
  * 该接口 (PrepareFlows) 用于创建待发起文件
561
561
  用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
562
- 目前该接口只支持B2C,<font color='red'> **不建议使用,将会废弃**</font>。
562
+ 目前该接口只支持B2C,<font color='red'> **不建议使用**</font>。
563
563
  */
564
564
  async PrepareFlows(req, cb) {
565
565
  return this.request("PrepareFlows", req, cb);
@@ -1189,6 +1189,11 @@ export interface CreateFlowOption {
1189
1189
  - 签署控件 是否默认展示日期.
1190
1190
  */
1191
1191
  SignComponentConfig?: SignComponentConfig;
1192
+ /**
1193
+ * 是否禁止编辑(展示)水印控件属性
1194
+ <ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
1195
+ */
1196
+ ForbidEditWatermark?: boolean;
1192
1197
  }
1193
1198
  /**
1194
1199
  * ChannelCreateRole请求参数结构体
@@ -1630,7 +1635,7 @@ export interface ChannelCreateFlowSignUrlRequest {
1630
1635
  /**
1631
1636
  * 流程签署人列表,其中结构体的ApproverType必传。
1632
1637
  若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。
1633
- 若为子客企业签署方则需传OpenId、OrganizationOpenId,OrganizationName 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)
1638
+ 若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)
1634
1639
 
1635
1640
  此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:
1636
1641
  1. RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。
@@ -4755,7 +4760,7 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
4755
4760
  * 批量签署的流程签署人,其中姓名(ApproverName)、参与人类型(ApproverType)必传,手机号(ApproverMobile)和证件信息(ApproverIdCardType、ApproverIdCardNumber)可任选一种或全部传入。
4756
4761
  <ul>
4757
4762
  <li>若为个人参与方:ApproverType:"PERSON"</li>
4758
- <li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,还需要传 OpenId、OrganizationOpenId。</li>
4763
+ <li>若为企业参与方:ApproverType:"ORGANIZATION"。同时若签署方为saas企业员工, OrganizationName 参数需传入参与方企业名称。若签署方为渠道子客企业员工,除了 OrganizationName 还需要传 OpenId、OrganizationOpenId。(如果OrganizationOpenId对应子客企业已经认证激活,则可以省略OrganizationName参数)</li>
4759
4764
  </ul>
4760
4765
 
4761
4766
  注:
@@ -5910,7 +5915,7 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
5910
5915
  */
5911
5916
  Mobile?: string;
5912
5917
  /**
5913
- * 此字段已废弃,请勿继续使用。
5918
+ * 该字段已不再使用
5914
5919
  */
5915
5920
  EnableAutoSign?: boolean;
5916
5921
  /**
@@ -8927,6 +8932,11 @@ export interface EmbedUrlOption {
8927
8932
  注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**,
8928
8933
  */
8929
8934
  SkipUploadFile?: string;
8935
+ /**
8936
+ * 是否禁止编辑(展示)水印控件属性
8937
+ <ul><li>(默认) false -否</li> <li> true - 禁止编辑</li></ul>
8938
+ */
8939
+ ForbidEditWatermark?: boolean;
8930
8940
  }
8931
8941
  /**
8932
8942
  * CreateBatchOrganizationAuthorizationUrl请求参数结构体
@@ -1649,6 +1649,14 @@ export interface AndroidInstance {
1649
1649
  * 内网 IP
1650
1650
  */
1651
1651
  PrivateIP?: string;
1652
+ /**
1653
+ * 创建时间
1654
+ */
1655
+ CreateTime?: string;
1656
+ /**
1657
+ * 机箱 ID
1658
+ */
1659
+ HostServerSerialNumber?: string;
1652
1660
  }
1653
1661
  /**
1654
1662
  * RebootAndroidInstanceHosts请求参数结构体