tencentcloud-sdk-nodejs 4.0.269 → 4.0.273
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.
- package/CHANGELOG.md +840 -0
- package/SERVICE_CHANGELOG.md +803 -121
- package/package.json +1 -1
- package/products.md +35 -35
- package/src/common/sdk_version.ts +1 -1
- package/src/services/apigateway/v20180808/apigateway_models.ts +35 -0
- package/src/services/as/v20180419/as_models.ts +3 -3
- package/src/services/billing/v20180709/billing_models.ts +18 -0
- package/src/services/cbs/v20170312/cbs_client.ts +27 -11
- package/src/services/cbs/v20170312/cbs_models.ts +44 -14
- package/src/services/cdb/v20170320/cdb_client.ts +470 -278
- package/src/services/cdb/v20170320/cdb_models.ts +4797 -3830
- package/src/services/cdn/v20180606/cdn_models.ts +7 -5
- package/src/services/cfw/v20190904/cfw_models.ts +19 -2
- package/src/services/clb/v20180317/clb_client.ts +3 -0
- package/src/services/cvm/v20170312/cvm_client.ts +2 -1
- package/src/services/cvm/v20170312/cvm_models.ts +10 -0
- package/src/services/dcdb/v20180411/dcdb_client.ts +12 -0
- package/src/services/dcdb/v20180411/dcdb_models.ts +51 -5
- package/src/services/dlc/v20210125/dlc_models.ts +2 -2
- package/src/services/eiam/v20210420/eiam_client.ts +1 -1
- package/src/services/eiam/v20210420/eiam_models.ts +32 -32
- package/src/services/eis/v20210601/eis_models.ts +25 -0
- package/src/services/essbasic/v20210526/essbasic_client.ts +12 -19
- package/src/services/essbasic/v20210526/essbasic_models.ts +12 -7
- package/src/services/gaap/v20180529/gaap_models.ts +115 -1
- package/src/services/gs/v20191118/gs_client.ts +24 -0
- package/src/services/gs/v20191118/gs_models.ts +45 -0
- package/src/services/iotcloud/v20180614/iotcloud_client.ts +41 -2
- package/src/services/iotcloud/v20180614/iotcloud_models.ts +334 -28
- package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +542 -431
- package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +538 -64
- package/src/services/lighthouse/v20200324/lighthouse_client.ts +1 -0
- package/src/services/lighthouse/v20200324/lighthouse_models.ts +20 -0
- package/src/services/live/v20180801/live_models.ts +1 -0
- package/src/services/mariadb/v20170312/mariadb_client.ts +25 -1
- package/src/services/mariadb/v20170312/mariadb_models.ts +188 -26
- package/src/services/monitor/v20180724/monitor_models.ts +12 -0
- package/src/services/ocr/v20181119/ocr_client.ts +3 -1
- package/src/services/ocr/v20181119/ocr_models.ts +27 -17
- package/src/services/postgres/v20170312/postgres_client.ts +86 -13
- package/src/services/postgres/v20170312/postgres_models.ts +327 -10
- package/src/services/scf/v20180416/scf_models.ts +9 -3
- package/src/services/ses/v20201002/ses_models.ts +8 -3
- package/src/services/sms/v20190711/sms_client.ts +2 -1
- package/src/services/sms/v20190711/sms_models.ts +19 -15
- package/src/services/ssm/v20190923/ssm_client.ts +3 -2
- package/src/services/ssm/v20190923/ssm_models.ts +36 -14
- package/src/services/tat/v20201028/tat_models.ts +3 -3
- package/src/services/tcb/v20180608/tcb_client.ts +14 -0
- package/src/services/tcb/v20180608/tcb_models.ts +120 -0
- package/src/services/tcss/v20201101/tcss_models.ts +27 -12
- package/src/services/tdmq/v20200217/tdmq_models.ts +2 -2
- package/src/services/tem/v20210701/tem_models.ts +37 -3
- package/src/services/tke/v20180525/tke_models.ts +5 -0
- package/src/services/tms/v20201229/tms_client.ts +1 -1
- package/src/services/tms/v20201229/tms_models.ts +1 -1
- package/src/services/vod/v20180717/vod_models.ts +18 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +28 -0
- package/tencentcloud/services/as/v20180419/as_models.d.ts +3 -3
- package/tencentcloud/services/billing/v20180709/billing_models.d.ts +17 -0
- package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +14 -6
- package/tencentcloud/services/cbs/v20170312/cbs_client.js +16 -6
- package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +39 -13
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +76 -16
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +110 -20
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +4321 -3494
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +7 -5
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +16 -2
- package/tencentcloud/services/clb/v20180317/clb_client.d.ts +3 -0
- package/tencentcloud/services/clb/v20180317/clb_client.js +3 -0
- package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +2 -1
- package/tencentcloud/services/cvm/v20170312/cvm_client.js +2 -1
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +8 -0
- package/tencentcloud/services/dcdb/v20180411/dcdb_client.d.ts +5 -1
- package/tencentcloud/services/dcdb/v20180411/dcdb_client.js +6 -0
- package/tencentcloud/services/dcdb/v20180411/dcdb_models.d.ts +44 -5
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +2 -2
- package/tencentcloud/services/eiam/v20210420/eiam_models.d.ts +28 -28
- package/tencentcloud/services/eis/v20210601/eis_models.d.ts +20 -0
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +10 -17
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +10 -17
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +11 -7
- package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +102 -1
- package/tencentcloud/services/gs/v20191118/gs_client.d.ts +9 -1
- package/tencentcloud/services/gs/v20191118/gs_client.js +12 -0
- package/tencentcloud/services/gs/v20191118/gs_models.d.ts +40 -0
- package/tencentcloud/services/iotcloud/v20180614/iotcloud_client.d.ts +13 -1
- package/tencentcloud/services/iotcloud/v20180614/iotcloud_client.js +18 -0
- package/tencentcloud/services/iotcloud/v20180614/iotcloud_models.d.ts +282 -27
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +179 -143
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +267 -213
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +462 -59
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +17 -0
- package/tencentcloud/services/live/v20180801/live_models.d.ts +1 -0
- package/tencentcloud/services/mariadb/v20170312/mariadb_client.d.ts +9 -1
- package/tencentcloud/services/mariadb/v20170312/mariadb_client.js +12 -0
- package/tencentcloud/services/mariadb/v20170312/mariadb_models.d.ts +156 -21
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +10 -0
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +3 -1
- package/tencentcloud/services/ocr/v20181119/ocr_client.js +3 -1
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +25 -17
- package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +29 -5
- package/tencentcloud/services/postgres/v20170312/postgres_client.js +42 -6
- package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +276 -9
- package/tencentcloud/services/scf/v20180416/scf_models.d.ts +8 -3
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +7 -3
- package/tencentcloud/services/sms/v20190711/sms_client.d.ts +2 -1
- package/tencentcloud/services/sms/v20190711/sms_client.js +2 -1
- package/tencentcloud/services/sms/v20190711/sms_models.d.ts +19 -15
- package/tencentcloud/services/ssm/v20190923/ssm_client.d.ts +2 -1
- package/tencentcloud/services/ssm/v20190923/ssm_client.js +2 -1
- package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +33 -14
- package/tencentcloud/services/tat/v20201028/tat_models.d.ts +3 -3
- package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +5 -1
- package/tencentcloud/services/tcb/v20180608/tcb_client.js +6 -0
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +100 -0
- package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +22 -8
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +2 -2
- package/tencentcloud/services/tem/v20210701/tem_models.d.ts +31 -3
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +4 -0
- package/tencentcloud/services/tms/v20201229/tms_client.d.ts +1 -1
- package/tencentcloud/services/tms/v20201229/tms_client.js +1 -1
- package/tencentcloud/services/tms/v20201229/tms_models.d.ts +1 -1
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +17 -1
- package/test/cbs.v20170312.test.js +12 -2
- package/test/cdb.v20170320.test.js +168 -18
- package/test/dcdb.v20180411.test.js +10 -0
- package/test/gs.v20191118.test.js +20 -0
- package/test/iotcloud.v20180614.test.js +30 -0
- package/test/iotexplorer.v20190423.test.js +240 -150
- package/test/mariadb.v20170312.test.js +20 -0
- package/test/postgres.v20170312.test.js +64 -4
- package/test/tcb.v20180608.test.js +10 -0
|
@@ -3177,9 +3177,11 @@ export interface AddCdnDomainRequest {
|
|
|
3177
3177
|
Domain: string;
|
|
3178
3178
|
/**
|
|
3179
3179
|
* 加速域名业务类型
|
|
3180
|
-
web
|
|
3181
|
-
download
|
|
3182
|
-
media
|
|
3180
|
+
web:网页小文件
|
|
3181
|
+
download:下载大文件
|
|
3182
|
+
media:音视频点播
|
|
3183
|
+
hybrid: 动静加速
|
|
3184
|
+
dynamic: 动态加速
|
|
3183
3185
|
*/
|
|
3184
3186
|
ServiceType: string;
|
|
3185
3187
|
/**
|
|
@@ -3312,7 +3314,7 @@ global:全球加速
|
|
|
3312
3314
|
*/
|
|
3313
3315
|
OfflineCache?: OfflineCache;
|
|
3314
3316
|
/**
|
|
3315
|
-
*
|
|
3317
|
+
* Quic访问(收费服务,详见计费说明和产品文档)
|
|
3316
3318
|
*/
|
|
3317
3319
|
Quic?: Quic;
|
|
3318
3320
|
/**
|
|
@@ -3535,7 +3537,7 @@ global:全球加速
|
|
|
3535
3537
|
*/
|
|
3536
3538
|
OriginCombine?: OriginCombine;
|
|
3537
3539
|
/**
|
|
3538
|
-
*
|
|
3540
|
+
* Quic访问(收费服务,详见计费说明和产品文档)
|
|
3539
3541
|
*/
|
|
3540
3542
|
Quic?: Quic;
|
|
3541
3543
|
/**
|
|
@@ -6,12 +6,17 @@ export interface DescribeVpcRuleOverviewResponse {
|
|
|
6
6
|
* 阻断策略规则数量
|
|
7
7
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
8
8
|
*/
|
|
9
|
-
StrategyNum
|
|
9
|
+
StrategyNum: number;
|
|
10
10
|
/**
|
|
11
11
|
* 启用规则数量
|
|
12
12
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
13
13
|
*/
|
|
14
|
-
StartRuleNum
|
|
14
|
+
StartRuleNum: number;
|
|
15
|
+
/**
|
|
16
|
+
* 规则总量
|
|
17
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
18
|
+
*/
|
|
19
|
+
Total: number;
|
|
15
20
|
/**
|
|
16
21
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
17
22
|
*/
|
|
@@ -1558,6 +1563,10 @@ export interface ModifyResourceGroupRequest {
|
|
|
1558
1563
|
* CreateNatFwInstance返回参数结构体
|
|
1559
1564
|
*/
|
|
1560
1565
|
export interface CreateNatFwInstanceResponse {
|
|
1566
|
+
/**
|
|
1567
|
+
* 防火墙实例id
|
|
1568
|
+
*/
|
|
1569
|
+
CfwInsId: string;
|
|
1561
1570
|
/**
|
|
1562
1571
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1563
1572
|
*/
|
|
@@ -1731,6 +1740,11 @@ export interface SecurityGroupListData {
|
|
|
1731
1740
|
* CreateNatFwInstanceWithDomain返回参数结构体
|
|
1732
1741
|
*/
|
|
1733
1742
|
export interface CreateNatFwInstanceWithDomainResponse {
|
|
1743
|
+
/**
|
|
1744
|
+
* nat实例信息
|
|
1745
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1746
|
+
*/
|
|
1747
|
+
CfwInsId: string;
|
|
1734
1748
|
/**
|
|
1735
1749
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1736
1750
|
*/
|
|
@@ -310,6 +310,9 @@ export declare class Client extends AbstractClient {
|
|
|
310
310
|
不支持后端类型为 目标组、SCF云函数
|
|
311
311
|
个性化配置、重定向配置、安全组默认放通开关 将不会被克隆,须手工配置
|
|
312
312
|
|
|
313
|
+
权限说明:
|
|
314
|
+
调用克隆接口用户需要具有:CreateLoadBalancer、CreateLoadBalancerListeners、CreateListenerRules、BatchRegisterTargets、SetLoadBalancerSecurityGroups、ModifyLoadBalancerAttributes、SetLoadBalancerClsLog、DeleteLoadBalancer权限,其中DeleteLoadBalancer用于克隆失败回滚流程,如果没有该接口权限,克隆失败后可能会残留克隆失败的CLB数据。
|
|
315
|
+
|
|
313
316
|
通过接口调用:
|
|
314
317
|
BGP带宽包必须传带宽包id
|
|
315
318
|
独占集群克隆必须传对应的参数,否则按共享型创建
|
|
@@ -462,6 +462,9 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
462
462
|
不支持后端类型为 目标组、SCF云函数
|
|
463
463
|
个性化配置、重定向配置、安全组默认放通开关 将不会被克隆,须手工配置
|
|
464
464
|
|
|
465
|
+
权限说明:
|
|
466
|
+
调用克隆接口用户需要具有:CreateLoadBalancer、CreateLoadBalancerListeners、CreateListenerRules、BatchRegisterTargets、SetLoadBalancerSecurityGroups、ModifyLoadBalancerAttributes、SetLoadBalancerClsLog、DeleteLoadBalancer权限,其中DeleteLoadBalancer用于克隆失败回滚流程,如果没有该接口权限,克隆失败后可能会残留克隆失败的CLB数据。
|
|
467
|
+
|
|
465
468
|
通过接口调用:
|
|
466
469
|
BGP带宽包必须传带宽包id
|
|
467
470
|
独占集群克隆必须传对应的参数,否则按共享型创建
|
|
@@ -271,10 +271,11 @@ https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F
|
|
|
271
271
|
/**
|
|
272
272
|
* 本接口 (ResizeInstanceDisks) 用于扩容实例的数据盘。
|
|
273
273
|
|
|
274
|
-
*
|
|
274
|
+
* 目前只支持扩容非弹性盘([`DescribeDisks`](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性),且[数据盘类型](https://cloud.tencent.com/document/api/213/15753#DataDisk)为:`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`和[CDH](https://cloud.tencent.com/document/product/416)实例的`LOCAL_BASIC`、`LOCAL_SSD`类型数据盘。
|
|
275
275
|
* 对于包年包月实例,使用该接口会涉及扣费,请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。
|
|
276
276
|
* 目前只支持扩容一块数据盘。
|
|
277
277
|
* 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
|
|
278
|
+
* 如果是系统盘,目前只支持扩容,不支持缩容。
|
|
278
279
|
*/
|
|
279
280
|
ResizeInstanceDisks(req: ResizeInstanceDisksRequest, cb?: (error: string, rep: ResizeInstanceDisksResponse) => void): Promise<ResizeInstanceDisksResponse>;
|
|
280
281
|
/**
|
|
@@ -363,10 +363,11 @@ https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F
|
|
|
363
363
|
/**
|
|
364
364
|
* 本接口 (ResizeInstanceDisks) 用于扩容实例的数据盘。
|
|
365
365
|
|
|
366
|
-
*
|
|
366
|
+
* 目前只支持扩容非弹性盘([`DescribeDisks`](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性),且[数据盘类型](https://cloud.tencent.com/document/api/213/15753#DataDisk)为:`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`和[CDH](https://cloud.tencent.com/document/product/416)实例的`LOCAL_BASIC`、`LOCAL_SSD`类型数据盘。
|
|
367
367
|
* 对于包年包月实例,使用该接口会涉及扣费,请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。
|
|
368
368
|
* 目前只支持扩容一块数据盘。
|
|
369
369
|
* 实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
|
|
370
|
+
* 如果是系统盘,目前只支持扩容,不支持缩容。
|
|
370
371
|
*/
|
|
371
372
|
async ResizeInstanceDisks(req, cb) {
|
|
372
373
|
return this.request("ResizeInstanceDisks", req, cb);
|
|
@@ -4452,6 +4452,14 @@ export interface ResizeInstanceDisksRequest {
|
|
|
4452
4452
|
* 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机,然后再重置用户密码。取值范围:<br><li>TRUE:表示在正常关机失败后进行强制关机<br><li>FALSE:表示在正常关机失败后不进行强制关机<br><br>默认取值:FALSE。<br><br>强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。
|
|
4453
4453
|
*/
|
|
4454
4454
|
ForceStop?: boolean;
|
|
4455
|
+
/**
|
|
4456
|
+
* 待扩容的系统盘配置信息。只支持扩容云盘。
|
|
4457
|
+
*/
|
|
4458
|
+
SystemDisk?: SystemDisk;
|
|
4459
|
+
/**
|
|
4460
|
+
* 扩容云盘的方式是否为在线扩容。
|
|
4461
|
+
*/
|
|
4462
|
+
ResizeOnline?: boolean;
|
|
4455
4463
|
}
|
|
4456
4464
|
/**
|
|
4457
4465
|
* DescribeInstanceFamilyConfigs请求参数结构体
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { DescribeUserTasksResponse, InitDCDBInstancesResponse, UpgradeDCDBInstanceResponse, DescribeAccountPrivilegesResponse, DescribeDatabasesRequest, DescribeDBParametersRequest, DescribeAccountsRequest, ModifyRealServerAccessStrategyResponse, DescribeDCDBPriceResponse, AssociateSecurityGroupsRequest, FlushBinlogResponse, DescribeDBSecurityGroupsResponse, CancelDcnJobResponse, DescribeFileDownloadUrlRequest, DescribeDBSyncModeResponse, DescribeProjectSecurityGroupsRequest, DescribeDCDBUpgradePriceResponse, CreateAccountRequest, DescribeDBParametersResponse, DescribeFlowResponse, CloneAccountResponse, ModifyAccountDescriptionResponse, CloseDBExtranetAccessResponse, OpenDBExtranetAccessResponse, CreateDCDBInstanceResponse, ModifyDBInstancesProjectResponse, DescribeDCDBInstanceNodeInfoRequest, DescribeDBLogFilesRequest, DescribeOrdersResponse, CreateDedicatedClusterDCDBInstanceRequest, ResetAccountPasswordRequest, CopyAccountPrivilegesResponse, CloneAccountRequest, DescribeDCDBRenewalPriceRequest, DescribeDBSecurityGroupsRequest, DescribeDCDBPriceRequest, DescribeProjectSecurityGroupsResponse, DescribeSqlLogsRequest, ResetAccountPasswordResponse, DescribeDCDBSaleInfoRequest, ModifyRealServerAccessStrategyRequest, RenewDCDBInstanceRequest, DescribeDBLogFilesResponse, GrantAccountPrivilegesRequest, DescribeShardSpecRequest, DescribeDCDBShardsRequest, ModifyDBParametersRequest, ModifyDBInstanceSecurityGroupsRequest, DescribeDcnDetailRequest, DescribeFileDownloadUrlResponse, ModifyDBParametersResponse, CopyAccountPrivilegesRequest, DescribeDatabaseTableRequest, DescribeDCDBInstanceNodeInfoResponse, KillSessionRequest, DescribeDatabaseObjectsResponse, DescribeDcnDetailResponse, RenewDCDBInstanceResponse, DescribeShardSpecResponse, AssociateSecurityGroupsResponse, DescribeDCDBRenewalPriceResponse, DescribeDCDBShardsResponse, GrantAccountPrivilegesResponse, CancelDcnJobRequest, OpenDBExtranetAccessRequest, DescribeDCDBSaleInfoResponse, ModifyDBInstancesProjectRequest, ModifyDBInstanceSecurityGroupsResponse, DescribeDBSyncModeRequest, DestroyDCDBInstanceRequest, ModifyAccountDescriptionRequest, KillSessionResponse, DescribeDatabasesResponse, DescribeOrdersRequest, DestroyDCDBInstanceResponse, CloseDBExtranetAccessRequest, InitDCDBInstancesRequest, DescribeSqlLogsResponse, DeleteAccountRequest, DescribeDCDBInstancesResponse, DescribeFlowRequest, CreateDCDBInstanceRequest, DescribeDCDBUpgradePriceRequest, CreateDedicatedClusterDCDBInstanceResponse, DescribeProjectsRequest, ModifyDBSyncModeRequest, DescribeProjectsResponse, CreateAccountResponse, DescribeDatabaseObjectsRequest, UpgradeDCDBInstanceRequest, DestroyHourDCDBInstanceResponse, DisassociateSecurityGroupsRequest, DescribeDatabaseTableResponse, DescribeAccountPrivilegesRequest, DescribeAccountsResponse, DescribeDCDBInstancesRequest, DestroyHourDCDBInstanceRequest, FlushBinlogRequest, ModifyDBSyncModeResponse, DisassociateSecurityGroupsResponse, DescribeUserTasksRequest, DeleteAccountResponse } from "./dcdb_models";
|
|
3
|
+
import { DescribeUserTasksResponse, InitDCDBInstancesResponse, UpgradeDCDBInstanceResponse, DescribeAccountPrivilegesResponse, DescribeDatabasesRequest, DescribeDBParametersRequest, DescribeAccountsRequest, ModifyRealServerAccessStrategyResponse, DescribeDCDBPriceResponse, AssociateSecurityGroupsRequest, FlushBinlogResponse, DescribeDBSecurityGroupsResponse, CancelDcnJobResponse, DescribeFileDownloadUrlRequest, DescribeDBSyncModeResponse, DescribeProjectSecurityGroupsRequest, DescribeDCDBUpgradePriceResponse, CreateAccountRequest, DescribeDBParametersResponse, DescribeFlowResponse, CloneAccountResponse, ModifyAccountDescriptionResponse, CloseDBExtranetAccessResponse, OpenDBExtranetAccessResponse, CreateDCDBInstanceResponse, ModifyDBInstancesProjectResponse, DescribeDCDBInstanceNodeInfoRequest, DescribeDBLogFilesRequest, DescribeOrdersResponse, CreateDedicatedClusterDCDBInstanceRequest, ResetAccountPasswordRequest, CopyAccountPrivilegesResponse, CloneAccountRequest, DescribeDCDBRenewalPriceRequest, DescribeDBSecurityGroupsRequest, DescribeDCDBPriceRequest, SwitchDBInstanceHAResponse, DescribeProjectSecurityGroupsResponse, DescribeSqlLogsRequest, ResetAccountPasswordResponse, DescribeDCDBSaleInfoRequest, ModifyRealServerAccessStrategyRequest, RenewDCDBInstanceRequest, DescribeDBLogFilesResponse, GrantAccountPrivilegesRequest, DescribeShardSpecRequest, DescribeDCDBShardsRequest, SwitchDBInstanceHARequest, ModifyDBParametersRequest, ModifyDBInstanceSecurityGroupsRequest, DescribeDcnDetailRequest, DescribeFileDownloadUrlResponse, ModifyDBParametersResponse, CopyAccountPrivilegesRequest, DescribeDatabaseTableRequest, DescribeDCDBInstanceNodeInfoResponse, KillSessionRequest, DescribeDatabaseObjectsResponse, DescribeDcnDetailResponse, RenewDCDBInstanceResponse, DescribeShardSpecResponse, AssociateSecurityGroupsResponse, DescribeDCDBRenewalPriceResponse, DescribeDCDBShardsResponse, GrantAccountPrivilegesResponse, CancelDcnJobRequest, OpenDBExtranetAccessRequest, DescribeDCDBSaleInfoResponse, ModifyDBInstancesProjectRequest, ModifyDBInstanceSecurityGroupsResponse, DescribeDBSyncModeRequest, DestroyDCDBInstanceRequest, ModifyAccountDescriptionRequest, KillSessionResponse, DescribeDatabasesResponse, DescribeOrdersRequest, DestroyDCDBInstanceResponse, CloseDBExtranetAccessRequest, InitDCDBInstancesRequest, DescribeSqlLogsResponse, DeleteAccountRequest, DescribeDCDBInstancesResponse, DescribeFlowRequest, CreateDCDBInstanceRequest, DescribeDCDBUpgradePriceRequest, CreateDedicatedClusterDCDBInstanceResponse, DescribeProjectsRequest, ModifyDBSyncModeRequest, DescribeProjectsResponse, CreateAccountResponse, DescribeDatabaseObjectsRequest, UpgradeDCDBInstanceRequest, DestroyHourDCDBInstanceResponse, DisassociateSecurityGroupsRequest, DescribeDatabaseTableResponse, DescribeAccountPrivilegesRequest, DescribeAccountsResponse, DescribeDCDBInstancesRequest, DestroyHourDCDBInstanceRequest, FlushBinlogRequest, ModifyDBSyncModeResponse, DisassociateSecurityGroupsResponse, DescribeUserTasksRequest, DeleteAccountResponse } from "./dcdb_models";
|
|
4
4
|
/**
|
|
5
5
|
* dcdb client
|
|
6
6
|
* @class
|
|
@@ -76,6 +76,10 @@ export declare class Client extends AbstractClient {
|
|
|
76
76
|
* 本接口(DescribeFlow)用于查询流程状态
|
|
77
77
|
*/
|
|
78
78
|
DescribeFlow(req: DescribeFlowRequest, cb?: (error: string, rep: DescribeFlowResponse) => void): Promise<DescribeFlowResponse>;
|
|
79
|
+
/**
|
|
80
|
+
* 本接口(SwitchDBInstanceHA)用于实例主备切换。
|
|
81
|
+
*/
|
|
82
|
+
SwitchDBInstanceHA(req: SwitchDBInstanceHARequest, cb?: (error: string, rep: SwitchDBInstanceHAResponse) => void): Promise<SwitchDBInstanceHAResponse>;
|
|
79
83
|
/**
|
|
80
84
|
* 本接口(InitDCDBInstances)用于初始化云数据库实例,包括设置默认字符集、表名大小写敏感等。
|
|
81
85
|
*/
|
|
@@ -126,6 +126,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
126
126
|
async DescribeFlow(req, cb) {
|
|
127
127
|
return this.request("DescribeFlow", req, cb);
|
|
128
128
|
}
|
|
129
|
+
/**
|
|
130
|
+
* 本接口(SwitchDBInstanceHA)用于实例主备切换。
|
|
131
|
+
*/
|
|
132
|
+
async SwitchDBInstanceHA(req, cb) {
|
|
133
|
+
return this.request("SwitchDBInstanceHA", req, cb);
|
|
134
|
+
}
|
|
129
135
|
/**
|
|
130
136
|
* 本接口(InitDCDBInstances)用于初始化云数据库实例,包括设置默认字符集、表名大小写敏感等。
|
|
131
137
|
*/
|
|
@@ -851,6 +851,19 @@ export interface DescribeDCDBPriceRequest {
|
|
|
851
851
|
*/
|
|
852
852
|
Paymode?: string;
|
|
853
853
|
}
|
|
854
|
+
/**
|
|
855
|
+
* SwitchDBInstanceHA返回参数结构体
|
|
856
|
+
*/
|
|
857
|
+
export interface SwitchDBInstanceHAResponse {
|
|
858
|
+
/**
|
|
859
|
+
* 异步流程Id
|
|
860
|
+
*/
|
|
861
|
+
FlowId: number;
|
|
862
|
+
/**
|
|
863
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
864
|
+
*/
|
|
865
|
+
RequestId?: string;
|
|
866
|
+
}
|
|
854
867
|
/**
|
|
855
868
|
* DescribeProjectSecurityGroups返回参数结构体
|
|
856
869
|
*/
|
|
@@ -858,7 +871,11 @@ export interface DescribeProjectSecurityGroupsResponse {
|
|
|
858
871
|
/**
|
|
859
872
|
* 安全组详情。
|
|
860
873
|
*/
|
|
861
|
-
Groups
|
|
874
|
+
Groups: Array<SecurityGroup>;
|
|
875
|
+
/**
|
|
876
|
+
* 安全组个数。
|
|
877
|
+
*/
|
|
878
|
+
Total: number;
|
|
862
879
|
/**
|
|
863
880
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
864
881
|
*/
|
|
@@ -1138,6 +1155,19 @@ export interface DescribeDCDBShardsRequest {
|
|
|
1138
1155
|
*/
|
|
1139
1156
|
OrderByType?: string;
|
|
1140
1157
|
}
|
|
1158
|
+
/**
|
|
1159
|
+
* SwitchDBInstanceHA请求参数结构体
|
|
1160
|
+
*/
|
|
1161
|
+
export interface SwitchDBInstanceHARequest {
|
|
1162
|
+
/**
|
|
1163
|
+
* 实例Id,形如 tdsql-ow728lmc。
|
|
1164
|
+
*/
|
|
1165
|
+
InstanceId: string;
|
|
1166
|
+
/**
|
|
1167
|
+
* 切换的目标区域,会自动选择该可用区中延迟最低的节点。
|
|
1168
|
+
*/
|
|
1169
|
+
Zone: string;
|
|
1170
|
+
}
|
|
1141
1171
|
/**
|
|
1142
1172
|
* 云数据库参数信息。
|
|
1143
1173
|
*/
|
|
@@ -1407,6 +1437,11 @@ export interface DCDBInstanceInfo {
|
|
|
1407
1437
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1408
1438
|
*/
|
|
1409
1439
|
InstanceType: number;
|
|
1440
|
+
/**
|
|
1441
|
+
* 实例标签信息
|
|
1442
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1443
|
+
*/
|
|
1444
|
+
ResourceTags: Array<ResourceTag>;
|
|
1410
1445
|
}
|
|
1411
1446
|
/**
|
|
1412
1447
|
* ModifyDBInstanceSecurityGroups请求参数结构体
|
|
@@ -1756,14 +1791,14 @@ export interface TableColumn {
|
|
|
1756
1791
|
* 安全出入口规则
|
|
1757
1792
|
*/
|
|
1758
1793
|
export interface SecurityGroupBound {
|
|
1759
|
-
/**
|
|
1760
|
-
* 策略,ACCEPT 或者 DROP
|
|
1761
|
-
*/
|
|
1762
|
-
Action: string;
|
|
1763
1794
|
/**
|
|
1764
1795
|
* 来源 IP 或 IP 段,例如192.168.0.0/16
|
|
1765
1796
|
*/
|
|
1766
1797
|
CidrIp: string;
|
|
1798
|
+
/**
|
|
1799
|
+
* 策略,ACCEPT 或者 DROP
|
|
1800
|
+
*/
|
|
1801
|
+
Action: string;
|
|
1767
1802
|
/**
|
|
1768
1803
|
* 端口
|
|
1769
1804
|
*/
|
|
@@ -2312,6 +2347,10 @@ export interface CreateDCDBInstanceRequest {
|
|
|
2312
2347
|
* 自动续费标记,0表示默认状态(用户未设置,即初始状态即手动续费,用户开通了预付费不停服特权也会进行自动续费), 1表示自动续费,2表示明确不自动续费(用户设置),若业务无续费概念或无需自动续费,需要设置为0
|
|
2313
2348
|
*/
|
|
2314
2349
|
AutoRenewFlag?: number;
|
|
2350
|
+
/**
|
|
2351
|
+
* 安全组ids,安全组可以传数组形式,兼容之前SecurityGroupId参数
|
|
2352
|
+
*/
|
|
2353
|
+
SecurityGroupIds?: Array<string>;
|
|
2315
2354
|
}
|
|
2316
2355
|
/**
|
|
2317
2356
|
* DescribeDCDBUpgradePrice请求参数结构体
|
|
@@ -573,7 +573,7 @@ export interface CreateTaskRequest {
|
|
|
573
573
|
*/
|
|
574
574
|
Task: Task;
|
|
575
575
|
/**
|
|
576
|
-
*
|
|
576
|
+
* 数据库名称。如果SQL语句中有数据库名称,优先使用SQL语句中的数据库,否则使用该参数指定的数据库(注:当提交建库sql时,该字段传空字符串)。
|
|
577
577
|
*/
|
|
578
578
|
DatabaseName?: string;
|
|
579
579
|
/**
|
|
@@ -1529,7 +1529,7 @@ export interface Policy {
|
|
|
1529
1529
|
*/
|
|
1530
1530
|
export interface CreateTasksRequest {
|
|
1531
1531
|
/**
|
|
1532
|
-
* 数据库名称。如果SQL语句中有数据库名称,优先使用SQL
|
|
1532
|
+
* 数据库名称。如果SQL语句中有数据库名称,优先使用SQL语句中的数据库,否则使用该参数指定的数据库(注:当提交建库sql时,该字段传空字符串)。
|
|
1533
1533
|
*/
|
|
1534
1534
|
DatabaseName: string;
|
|
1535
1535
|
/**
|
|
@@ -564,6 +564,31 @@ export interface UserGroupInformationSearchCriteria {
|
|
|
564
564
|
*/
|
|
565
565
|
Keyword?: string;
|
|
566
566
|
}
|
|
567
|
+
/**
|
|
568
|
+
* 授权资源详情
|
|
569
|
+
*/
|
|
570
|
+
export interface AuthorizationResourceEntityInfo {
|
|
571
|
+
/**
|
|
572
|
+
* 授权关系的唯一ID
|
|
573
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
574
|
+
*/
|
|
575
|
+
ResourceId: string;
|
|
576
|
+
/**
|
|
577
|
+
* 资源授权类型
|
|
578
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
579
|
+
*/
|
|
580
|
+
ResourceType: string;
|
|
581
|
+
/**
|
|
582
|
+
* 授权的资源
|
|
583
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
584
|
+
*/
|
|
585
|
+
Resource: string;
|
|
586
|
+
/**
|
|
587
|
+
* 资源名称
|
|
588
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
589
|
+
*/
|
|
590
|
+
ResourceName: string;
|
|
591
|
+
}
|
|
567
592
|
/**
|
|
568
593
|
* 账号组查询参数
|
|
569
594
|
*/
|
|
@@ -690,7 +715,7 @@ export interface DescribeApplicationResponse {
|
|
|
690
715
|
*/
|
|
691
716
|
ClientId: string;
|
|
692
717
|
/**
|
|
693
|
-
*
|
|
718
|
+
* 应用类型,即创建应用时所选择的应用模板类型。
|
|
694
719
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
695
720
|
*/
|
|
696
721
|
ApplicationType: string;
|
|
@@ -796,7 +821,7 @@ export interface DescribeUserGroupResourcesAuthorizationResponse {
|
|
|
796
821
|
* 资源列表
|
|
797
822
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
798
823
|
*/
|
|
799
|
-
AuthorizationUserGroupResourceList: Array<
|
|
824
|
+
AuthorizationUserGroupResourceList: Array<AuthorizationResourceEntityInfo>;
|
|
800
825
|
/**
|
|
801
826
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
802
827
|
*/
|
|
@@ -1091,7 +1116,7 @@ export interface DescribeOrgResourcesAuthorizationResponse {
|
|
|
1091
1116
|
* 资源列表
|
|
1092
1117
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1093
1118
|
*/
|
|
1094
|
-
AuthorizationOrgResourceList: Array<
|
|
1119
|
+
AuthorizationOrgResourceList: Array<AuthorizationResourceEntityInfo>;
|
|
1095
1120
|
/**
|
|
1096
1121
|
* 资源数量
|
|
1097
1122
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
@@ -1534,31 +1559,6 @@ export interface ListAuthorizedApplicationsToUserResponse {
|
|
|
1534
1559
|
*/
|
|
1535
1560
|
RequestId?: string;
|
|
1536
1561
|
}
|
|
1537
|
-
/**
|
|
1538
|
-
* 授权资源详情
|
|
1539
|
-
*/
|
|
1540
|
-
export interface AuthorizationResouceEntityInfo {
|
|
1541
|
-
/**
|
|
1542
|
-
* 授权关系的唯一ID
|
|
1543
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1544
|
-
*/
|
|
1545
|
-
ResourceId: string;
|
|
1546
|
-
/**
|
|
1547
|
-
* 资源授权类型
|
|
1548
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1549
|
-
*/
|
|
1550
|
-
ResourceType: string;
|
|
1551
|
-
/**
|
|
1552
|
-
* 授权的资源
|
|
1553
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1554
|
-
*/
|
|
1555
|
-
Resource: string;
|
|
1556
|
-
/**
|
|
1557
|
-
* 资源名称
|
|
1558
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1559
|
-
*/
|
|
1560
|
-
ResourceName: string;
|
|
1561
|
-
}
|
|
1562
1562
|
/**
|
|
1563
1563
|
* ModifyApplication请求参数结构体
|
|
1564
1564
|
*/
|
|
@@ -59,6 +59,22 @@ export interface RuntimeMC {
|
|
|
59
59
|
* 正在运行的应用实例数量
|
|
60
60
|
*/
|
|
61
61
|
RunningInstanceCount: number;
|
|
62
|
+
/**
|
|
63
|
+
* 已使用cpu核数
|
|
64
|
+
*/
|
|
65
|
+
CpuUsed: number;
|
|
66
|
+
/**
|
|
67
|
+
* cpu核数上限
|
|
68
|
+
*/
|
|
69
|
+
CpuLimit: number;
|
|
70
|
+
/**
|
|
71
|
+
* 已使用内存 MB
|
|
72
|
+
*/
|
|
73
|
+
MemoryUsed: number;
|
|
74
|
+
/**
|
|
75
|
+
* 内存上限 MB
|
|
76
|
+
*/
|
|
77
|
+
MemoryLimit: number;
|
|
62
78
|
}
|
|
63
79
|
/**
|
|
64
80
|
* GetRuntimeResourceMonitorMetricMC返回参数结构体
|
|
@@ -287,4 +303,8 @@ export interface RuntimeDeployedInstanceMC {
|
|
|
287
303
|
* 应用实例部署更新时间
|
|
288
304
|
*/
|
|
289
305
|
UpdatedAt: number;
|
|
306
|
+
/**
|
|
307
|
+
* 应用类型:0:NormalApp普通应用 1:TemplateApp模版应用 2:LightApp轻应用 3:MicroConnTemplate微连接模板 4:MicroConnApp微连接应用
|
|
308
|
+
*/
|
|
309
|
+
ProjectType: number;
|
|
290
310
|
}
|
|
@@ -8,12 +8,12 @@ import { SyncProxyOrganizationResponse, PrepareFlowsResponse, GetDownloadFlowUrl
|
|
|
8
8
|
export declare class Client extends AbstractClient {
|
|
9
9
|
constructor(clientConfig: ClientConfig);
|
|
10
10
|
/**
|
|
11
|
-
* 接口(CreateFlowsByTemplates
|
|
11
|
+
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建流程。当前可批量发起合同(流程)数量最大为20个。
|
|
12
12
|
*/
|
|
13
13
|
CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
|
|
14
14
|
/**
|
|
15
|
-
* 此接口(GetDownloadFlowUrl
|
|
16
|
-
|
|
15
|
+
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载确认页面链接,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
16
|
+
当前接口限制最多合同(流程)50个.
|
|
17
17
|
*/
|
|
18
18
|
GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
|
|
19
19
|
/**
|
|
@@ -22,27 +22,20 @@ export declare class Client extends AbstractClient {
|
|
|
22
22
|
DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
|
|
23
23
|
/**
|
|
24
24
|
* 该接口 (PrepareFlows) 用于创建待发起文件
|
|
25
|
+
用户通过该接口进入流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
|
|
26
|
+
目前该接口只支持B2C。
|
|
25
27
|
*/
|
|
26
28
|
PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
|
|
27
29
|
/**
|
|
28
|
-
* 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置,
|
|
30
|
+
* 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
|
|
29
31
|
1、同步标识=select时:
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
输入规则:“可见标识”、“指定合作企业列表”非必填输入。
|
|
34
|
-
处理规则:
|
|
35
|
-
若“可见标识”=空,不做处理,返回当前的可见标识。
|
|
36
|
-
若“可见标识”=所有合作企业,不取“指定合作企业列表”的值处理。
|
|
37
|
-
若“可见标识”=指定合作企业,取“指定合作企业列表”的值进行更新/插入。
|
|
38
|
-
3、同步标识=delete时:
|
|
39
|
-
输入规则:“可见标识”、“指定合作企业列表”非必填输入。
|
|
40
|
-
处理规则:
|
|
41
|
-
仅取“指定合作企业列表”的值进行删除处理,为空时不做处。
|
|
32
|
+
返回渠道侧模板库当前模板的属性.
|
|
33
|
+
2、同步标识=update或者delete时:
|
|
34
|
+
对渠道子客进行模板库中模板授权,修改操作
|
|
42
35
|
*/
|
|
43
36
|
OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
|
|
44
37
|
/**
|
|
45
|
-
*
|
|
38
|
+
* 创建参与者签署短链
|
|
46
39
|
*/
|
|
47
40
|
CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
|
|
48
41
|
/**
|
|
@@ -28,14 +28,14 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
28
28
|
super("essbasic.tencentcloudapi.com", "2021-05-26", clientConfig);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
* 接口(CreateFlowsByTemplates
|
|
31
|
+
* 接口(CreateFlowsByTemplates)用于使用多个模板批量创建流程。当前可批量发起合同(流程)数量最大为20个。
|
|
32
32
|
*/
|
|
33
33
|
async CreateFlowsByTemplates(req, cb) {
|
|
34
34
|
return this.request("CreateFlowsByTemplates", req, cb);
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
* 此接口(GetDownloadFlowUrl
|
|
38
|
-
|
|
37
|
+
* 此接口(GetDownloadFlowUrl)用于创建电子签批量下载确认页面链接,支持客户合同(流程)按照自定义文件夹形式 分类下载。
|
|
38
|
+
当前接口限制最多合同(流程)50个.
|
|
39
39
|
*/
|
|
40
40
|
async GetDownloadFlowUrl(req, cb) {
|
|
41
41
|
return this.request("GetDownloadFlowUrl", req, cb);
|
|
@@ -48,31 +48,24 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
50
|
* 该接口 (PrepareFlows) 用于创建待发起文件
|
|
51
|
+
用户通过该接口进入流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
|
|
52
|
+
目前该接口只支持B2C。
|
|
51
53
|
*/
|
|
52
54
|
async PrepareFlows(req, cb) {
|
|
53
55
|
return this.request("PrepareFlows", req, cb);
|
|
54
56
|
}
|
|
55
57
|
/**
|
|
56
|
-
* 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置,
|
|
58
|
+
* 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
|
|
57
59
|
1、同步标识=select时:
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
输入规则:“可见标识”、“指定合作企业列表”非必填输入。
|
|
62
|
-
处理规则:
|
|
63
|
-
若“可见标识”=空,不做处理,返回当前的可见标识。
|
|
64
|
-
若“可见标识”=所有合作企业,不取“指定合作企业列表”的值处理。
|
|
65
|
-
若“可见标识”=指定合作企业,取“指定合作企业列表”的值进行更新/插入。
|
|
66
|
-
3、同步标识=delete时:
|
|
67
|
-
输入规则:“可见标识”、“指定合作企业列表”非必填输入。
|
|
68
|
-
处理规则:
|
|
69
|
-
仅取“指定合作企业列表”的值进行删除处理,为空时不做处。
|
|
60
|
+
返回渠道侧模板库当前模板的属性.
|
|
61
|
+
2、同步标识=update或者delete时:
|
|
62
|
+
对渠道子客进行模板库中模板授权,修改操作
|
|
70
63
|
*/
|
|
71
64
|
async OperateChannelTemplate(req, cb) {
|
|
72
65
|
return this.request("OperateChannelTemplate", req, cb);
|
|
73
66
|
}
|
|
74
67
|
/**
|
|
75
|
-
*
|
|
68
|
+
* 创建参与者签署短链
|
|
76
69
|
*/
|
|
77
70
|
async CreateSignUrls(req, cb) {
|
|
78
71
|
return this.request("CreateSignUrls", req, cb);
|
|
@@ -68,7 +68,7 @@ export interface FlowApproverInfo {
|
|
|
68
68
|
*/
|
|
69
69
|
PreReadTime?: number;
|
|
70
70
|
/**
|
|
71
|
-
* 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN
|
|
71
|
+
* 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
|
|
72
72
|
*/
|
|
73
73
|
ComponentLimitType?: Array<string>;
|
|
74
74
|
/**
|
|
@@ -78,11 +78,11 @@ export interface FlowApproverInfo {
|
|
|
78
78
|
/**
|
|
79
79
|
* 同一渠道下其他合作企业OpenId,签署人为非发起方企业员工场景下必传;
|
|
80
80
|
*/
|
|
81
|
-
|
|
81
|
+
OrganizationName?: string;
|
|
82
82
|
/**
|
|
83
|
-
* 同一渠道下其他合作企业OpenId
|
|
83
|
+
* 同一渠道下其他合作企业OpenId,签署人为非发起方企业员工场景下必传;
|
|
84
84
|
*/
|
|
85
|
-
|
|
85
|
+
OrganizationOpenId?: string;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
88
|
* PrepareFlows返回参数结构体
|
|
@@ -159,7 +159,7 @@ export interface TemplateInfo {
|
|
|
159
159
|
*/
|
|
160
160
|
CreatedOn: number;
|
|
161
161
|
/**
|
|
162
|
-
* 模板类型:1-静默签;2-静默签授权;3
|
|
162
|
+
* 模板类型:1-静默签;2-静默签授权;3-普通模板
|
|
163
163
|
*/
|
|
164
164
|
TemplateType: number;
|
|
165
165
|
/**
|
|
@@ -238,6 +238,10 @@ export interface Recipient {
|
|
|
238
238
|
* 签署顺序:数字越小优先级越高
|
|
239
239
|
*/
|
|
240
240
|
RoutingOrder?: number;
|
|
241
|
+
/**
|
|
242
|
+
* 是否是发起方
|
|
243
|
+
*/
|
|
244
|
+
IsPromoter?: boolean;
|
|
241
245
|
}
|
|
242
246
|
/**
|
|
243
247
|
* DescribeTemplates返回参数结构体
|
|
@@ -546,7 +550,7 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
546
550
|
*/
|
|
547
551
|
Operator?: UserInfo;
|
|
548
552
|
/**
|
|
549
|
-
* 控制台指定模块,文件/合同管理:"DOCUMENT"
|
|
553
|
+
* 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
|
|
550
554
|
*/
|
|
551
555
|
Module?: string;
|
|
552
556
|
/**
|
|
@@ -864,7 +868,7 @@ export interface OperateChannelTemplateRequest {
|
|
|
864
868
|
*/
|
|
865
869
|
AuthTag?: string;
|
|
866
870
|
/**
|
|
867
|
-
*
|
|
871
|
+
* 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
|
|
868
872
|
*/
|
|
869
873
|
ProxyOrganizationOpenIds?: string;
|
|
870
874
|
}
|