tencentcloud-sdk-nodejs 4.0.710 → 4.0.712
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 +364 -0
- package/SERVICE_CHANGELOG.md +396 -68
- package/package.json +1 -1
- package/products.md +27 -27
- package/src/common/sdk_version.ts +1 -1
- package/src/services/billing/v20180709/billing_models.ts +8 -0
- package/src/services/bsca/v20210811/bsca_client.ts +2 -1
- package/src/services/bsca/v20210811/bsca_models.ts +55 -22
- package/src/services/btoe/index.ts +2 -2
- package/src/services/cdb/v20170320/cdb_client.ts +29 -4
- package/src/services/cdb/v20170320/cdb_models.ts +149 -46
- package/src/services/cdn/v20180606/cdn_client.ts +1 -1
- package/src/services/cdn/v20180606/cdn_models.ts +11 -12
- package/src/services/cdwpg/v20201230/cdwpg_client.ts +17 -2
- package/src/services/cdwpg/v20201230/cdwpg_models.ts +203 -37
- package/src/services/cii/index.ts +2 -2
- package/src/services/clb/v20180317/clb_models.ts +5 -3
- package/src/services/cloudstudio/index.ts +2 -2
- package/src/services/cwp/v20180228/cwp_models.ts +11 -3
- package/src/services/cynosdb/v20190107/cynosdb_models.ts +86 -81
- package/src/services/dlc/v20210125/dlc_client.ts +28 -3
- package/src/services/dlc/v20210125/dlc_models.ts +104 -27
- package/src/services/dts/index.ts +2 -2
- package/src/services/dts/v20211206/dts_client.ts +12 -0
- package/src/services/dts/v20211206/dts_models.ts +25 -1
- package/src/services/ecm/v20190719/ecm_models.ts +10 -4
- package/src/services/ess/v20201111/ess_models.ts +16 -4
- package/src/services/essbasic/v20210526/essbasic_client.ts +3 -1
- package/src/services/essbasic/v20210526/essbasic_models.ts +83 -58
- package/src/services/facefusion/index.ts +2 -2
- package/src/services/iai/v20200303/iai_client.ts +1 -1
- package/src/services/iotcloud/index.ts +2 -2
- package/src/services/iotvideo/index.ts +2 -2
- package/src/services/irp/index.ts +2 -2
- package/src/services/lcic/v20220817/lcic_models.ts +63 -0
- package/src/services/lighthouse/v20200324/lighthouse_models.ts +5 -15
- package/src/services/live/v20180801/live_models.ts +23 -11
- package/src/services/mgobe/index.ts +2 -2
- package/src/services/monitor/v20180724/monitor_models.ts +1 -1
- package/src/services/mps/v20190612/mps_client.ts +9 -4
- package/src/services/mps/v20190612/mps_models.ts +135 -45
- package/src/services/mrs/v20200910/mrs_client.ts +2 -1
- package/src/services/mrs/v20200910/mrs_models.ts +50 -19
- package/src/services/oceanus/v20190422/oceanus_client.ts +21 -6
- package/src/services/oceanus/v20190422/oceanus_models.ts +280 -26
- package/src/services/ssl/v20191205/ssl_client.ts +4 -1
- package/src/services/ssl/v20191205/ssl_models.ts +83 -7
- package/src/services/tat/v20201028/tat_models.ts +3 -3
- package/src/services/tbp/index.ts +2 -2
- package/src/services/teo/index.ts +2 -2
- package/src/services/tsw/index.ts +2 -2
- package/src/services/vm/index.ts +2 -2
- package/src/services/wedata/v20210820/wedata_models.ts +7 -5
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/billing/v20180709/billing_models.d.ts +8 -0
- package/tencentcloud/services/bsca/v20210811/bsca_client.d.ts +1 -1
- package/tencentcloud/services/bsca/v20210811/bsca_client.js +1 -1
- package/tencentcloud/services/bsca/v20210811/bsca_models.d.ts +54 -22
- package/tencentcloud/services/btoe/index.d.ts +4 -4
- package/tencentcloud/services/btoe/index.js +2 -2
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +9 -1
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +12 -0
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +143 -45
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +11 -12
- package/tencentcloud/services/cdwpg/v20201230/cdwpg_client.d.ts +5 -1
- package/tencentcloud/services/cdwpg/v20201230/cdwpg_client.js +6 -0
- package/tencentcloud/services/cdwpg/v20201230/cdwpg_models.d.ts +198 -37
- package/tencentcloud/services/cii/index.d.ts +4 -4
- package/tencentcloud/services/cii/index.js +2 -2
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +5 -3
- package/tencentcloud/services/cloudstudio/index.d.ts +4 -4
- package/tencentcloud/services/cloudstudio/index.js +2 -2
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +11 -3
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +86 -81
- package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +9 -1
- package/tencentcloud/services/dlc/v20210125/dlc_client.js +12 -0
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +99 -27
- package/tencentcloud/services/dts/index.d.ts +4 -4
- package/tencentcloud/services/dts/index.js +2 -2
- package/tencentcloud/services/dts/v20211206/dts_client.d.ts +5 -1
- package/tencentcloud/services/dts/v20211206/dts_client.js +6 -0
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +23 -1
- package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +10 -4
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +16 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +83 -58
- package/tencentcloud/services/facefusion/index.d.ts +4 -4
- package/tencentcloud/services/facefusion/index.js +2 -2
- package/tencentcloud/services/iai/v20200303/iai_client.d.ts +1 -1
- package/tencentcloud/services/iai/v20200303/iai_client.js +1 -1
- package/tencentcloud/services/iotcloud/index.d.ts +4 -4
- package/tencentcloud/services/iotcloud/index.js +2 -2
- package/tencentcloud/services/iotvideo/index.d.ts +4 -4
- package/tencentcloud/services/iotvideo/index.js +2 -2
- package/tencentcloud/services/irp/index.d.ts +4 -4
- package/tencentcloud/services/irp/index.js +2 -2
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +63 -0
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +5 -15
- package/tencentcloud/services/live/v20180801/live_models.d.ts +23 -11
- package/tencentcloud/services/mgobe/index.d.ts +4 -4
- package/tencentcloud/services/mgobe/index.js +2 -2
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +1 -1
- package/tencentcloud/services/mps/v20190612/mps_client.d.ts +1 -1
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +130 -45
- package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +49 -19
- package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +7 -3
- package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +9 -3
- package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +275 -26
- package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +80 -7
- package/tencentcloud/services/tat/v20201028/tat_models.d.ts +3 -3
- package/tencentcloud/services/tbp/index.d.ts +4 -4
- package/tencentcloud/services/tbp/index.js +2 -2
- package/tencentcloud/services/teo/index.d.ts +4 -4
- package/tencentcloud/services/teo/index.js +2 -2
- package/tencentcloud/services/tsw/index.d.ts +4 -4
- package/tencentcloud/services/tsw/index.js +2 -2
- package/tencentcloud/services/vm/index.d.ts +4 -4
- package/tencentcloud/services/vm/index.js +2 -2
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +7 -5
- package/test/cdb.v20170320.test.js +20 -0
- package/test/cdwpg.v20201230.test.js +10 -0
- package/test/dlc.v20210125.test.js +20 -0
- package/test/dts.v20211206.test.js +10 -0
- package/test/oceanus.v20190422.test.js +12 -2
|
@@ -744,6 +744,16 @@ export interface CreateScriptResponse {
|
|
|
744
744
|
RequestId?: string
|
|
745
745
|
}
|
|
746
746
|
|
|
747
|
+
/**
|
|
748
|
+
* ModifyWorkGroup返回参数结构体
|
|
749
|
+
*/
|
|
750
|
+
export interface ModifyWorkGroupResponse {
|
|
751
|
+
/**
|
|
752
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
753
|
+
*/
|
|
754
|
+
RequestId?: string
|
|
755
|
+
}
|
|
756
|
+
|
|
747
757
|
/**
|
|
748
758
|
* CreateTasksInOrder返回参数结构体
|
|
749
759
|
*/
|
|
@@ -1212,6 +1222,20 @@ export interface CrontabResumeSuspendStrategy {
|
|
|
1212
1222
|
SuspendStrategy?: number
|
|
1213
1223
|
}
|
|
1214
1224
|
|
|
1225
|
+
/**
|
|
1226
|
+
* SwitchDataEngineImage请求参数结构体
|
|
1227
|
+
*/
|
|
1228
|
+
export interface SwitchDataEngineImageRequest {
|
|
1229
|
+
/**
|
|
1230
|
+
* 引擎ID
|
|
1231
|
+
*/
|
|
1232
|
+
DataEngineId: string
|
|
1233
|
+
/**
|
|
1234
|
+
* 新镜像版本ID
|
|
1235
|
+
*/
|
|
1236
|
+
NewImageVersionId: string
|
|
1237
|
+
}
|
|
1238
|
+
|
|
1215
1239
|
/**
|
|
1216
1240
|
* AlterDMSTable返回参数结构体
|
|
1217
1241
|
*/
|
|
@@ -2113,26 +2137,9 @@ export interface AlterDMSPartitionRequest {
|
|
|
2113
2137
|
}
|
|
2114
2138
|
|
|
2115
2139
|
/**
|
|
2116
|
-
*
|
|
2140
|
+
* DescribeAdvancedStoreLocation请求参数结构体
|
|
2117
2141
|
*/
|
|
2118
|
-
export
|
|
2119
|
-
/**
|
|
2120
|
-
* 该视图所属数据库名字
|
|
2121
|
-
*/
|
|
2122
|
-
DatabaseName: string
|
|
2123
|
-
/**
|
|
2124
|
-
* 视图名称
|
|
2125
|
-
*/
|
|
2126
|
-
ViewName: string
|
|
2127
|
-
/**
|
|
2128
|
-
* 视图创建人昵称
|
|
2129
|
-
*/
|
|
2130
|
-
UserAlias?: string
|
|
2131
|
-
/**
|
|
2132
|
-
* 视图创建人ID
|
|
2133
|
-
*/
|
|
2134
|
-
UserSubUin?: string
|
|
2135
|
-
}
|
|
2142
|
+
export type DescribeAdvancedStoreLocationRequest = null
|
|
2136
2143
|
|
|
2137
2144
|
/**
|
|
2138
2145
|
* CheckLockMetaData请求参数结构体
|
|
@@ -3330,6 +3337,33 @@ export interface DescribeNotebookSessionRequest {
|
|
|
3330
3337
|
SessionId: string
|
|
3331
3338
|
}
|
|
3332
3339
|
|
|
3340
|
+
/**
|
|
3341
|
+
* DescribeAdvancedStoreLocation返回参数结构体
|
|
3342
|
+
*/
|
|
3343
|
+
export interface DescribeAdvancedStoreLocationResponse {
|
|
3344
|
+
/**
|
|
3345
|
+
* 是否启用高级设置:0-否,1-是
|
|
3346
|
+
*/
|
|
3347
|
+
Enable: number
|
|
3348
|
+
/**
|
|
3349
|
+
* 查询结果保存cos路径
|
|
3350
|
+
*/
|
|
3351
|
+
StoreLocation: string
|
|
3352
|
+
/**
|
|
3353
|
+
* 是否有托管存储权限
|
|
3354
|
+
*/
|
|
3355
|
+
HasLakeFs: boolean
|
|
3356
|
+
/**
|
|
3357
|
+
* 托管存储状态,HasLakeFs等于true时,该值才有意义
|
|
3358
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3359
|
+
*/
|
|
3360
|
+
LakeFsStatus: string
|
|
3361
|
+
/**
|
|
3362
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3363
|
+
*/
|
|
3364
|
+
RequestId?: string
|
|
3365
|
+
}
|
|
3366
|
+
|
|
3333
3367
|
/**
|
|
3334
3368
|
* UpgradeDataEngineImage请求参数结构体
|
|
3335
3369
|
*/
|
|
@@ -3638,17 +3672,17 @@ export interface AddUsersToWorkGroupResponse {
|
|
|
3638
3672
|
}
|
|
3639
3673
|
|
|
3640
3674
|
/**
|
|
3641
|
-
*
|
|
3675
|
+
* ModifyAdvancedStoreLocation请求参数结构体
|
|
3642
3676
|
*/
|
|
3643
|
-
export interface
|
|
3677
|
+
export interface ModifyAdvancedStoreLocationRequest {
|
|
3644
3678
|
/**
|
|
3645
|
-
*
|
|
3679
|
+
* 查询结果保存cos路径
|
|
3646
3680
|
*/
|
|
3647
|
-
|
|
3681
|
+
StoreLocation: string
|
|
3648
3682
|
/**
|
|
3649
|
-
*
|
|
3683
|
+
* 是否启用高级设置:0-否,1-是
|
|
3650
3684
|
*/
|
|
3651
|
-
|
|
3685
|
+
Enable: number
|
|
3652
3686
|
}
|
|
3653
3687
|
|
|
3654
3688
|
/**
|
|
@@ -4182,9 +4216,9 @@ export interface AttachWorkGroupPolicyResponse {
|
|
|
4182
4216
|
}
|
|
4183
4217
|
|
|
4184
4218
|
/**
|
|
4185
|
-
*
|
|
4219
|
+
* ModifyAdvancedStoreLocation返回参数结构体
|
|
4186
4220
|
*/
|
|
4187
|
-
export interface
|
|
4221
|
+
export interface ModifyAdvancedStoreLocationResponse {
|
|
4188
4222
|
/**
|
|
4189
4223
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4190
4224
|
*/
|
|
@@ -6132,6 +6166,28 @@ export interface DMSPartition {
|
|
|
6132
6166
|
Sds?: DMSSds
|
|
6133
6167
|
}
|
|
6134
6168
|
|
|
6169
|
+
/**
|
|
6170
|
+
* 视图基本配置信息
|
|
6171
|
+
*/
|
|
6172
|
+
export interface ViewBaseInfo {
|
|
6173
|
+
/**
|
|
6174
|
+
* 该视图所属数据库名字
|
|
6175
|
+
*/
|
|
6176
|
+
DatabaseName: string
|
|
6177
|
+
/**
|
|
6178
|
+
* 视图名称
|
|
6179
|
+
*/
|
|
6180
|
+
ViewName: string
|
|
6181
|
+
/**
|
|
6182
|
+
* 视图创建人昵称
|
|
6183
|
+
*/
|
|
6184
|
+
UserAlias?: string
|
|
6185
|
+
/**
|
|
6186
|
+
* 视图创建人ID
|
|
6187
|
+
*/
|
|
6188
|
+
UserSubUin?: string
|
|
6189
|
+
}
|
|
6190
|
+
|
|
6135
6191
|
/**
|
|
6136
6192
|
* 数据库对象
|
|
6137
6193
|
*/
|
|
@@ -6338,6 +6394,11 @@ export interface CreateSparkSessionBatchSQLResponse {
|
|
|
6338
6394
|
* 批任务唯一标识
|
|
6339
6395
|
*/
|
|
6340
6396
|
BatchId?: string
|
|
6397
|
+
/**
|
|
6398
|
+
* Statement任务列表信息
|
|
6399
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
6400
|
+
*/
|
|
6401
|
+
Statements?: Array<StatementInformation>
|
|
6341
6402
|
/**
|
|
6342
6403
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6343
6404
|
*/
|
|
@@ -7801,6 +7862,22 @@ export interface CheckDataEngineImageCanBeUpgradeRequest {
|
|
|
7801
7862
|
DataEngineId: string
|
|
7802
7863
|
}
|
|
7803
7864
|
|
|
7865
|
+
/**
|
|
7866
|
+
* statement信息
|
|
7867
|
+
*/
|
|
7868
|
+
export interface StatementInformation {
|
|
7869
|
+
/**
|
|
7870
|
+
* SQL任务唯一ID
|
|
7871
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7872
|
+
*/
|
|
7873
|
+
TaskId?: string
|
|
7874
|
+
/**
|
|
7875
|
+
* SQL内容
|
|
7876
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7877
|
+
*/
|
|
7878
|
+
SQL?: string
|
|
7879
|
+
}
|
|
7880
|
+
|
|
7804
7881
|
/**
|
|
7805
7882
|
* SQL查询任务
|
|
7806
7883
|
*/
|
|
@@ -58,6 +58,7 @@ import {
|
|
|
58
58
|
ResumeSyncJobResponse,
|
|
59
59
|
ModifyCompareTaskNameResponse,
|
|
60
60
|
StartSyncJobRequest,
|
|
61
|
+
ModifyMigrateRuntimeAttributeResponse,
|
|
61
62
|
PauseSyncJobRequest,
|
|
62
63
|
CreateMigrateCheckJobResponse,
|
|
63
64
|
ModifySyncJobConfigRequest,
|
|
@@ -167,6 +168,7 @@ import {
|
|
|
167
168
|
RecoverMigrateJobRequest,
|
|
168
169
|
OnlineDDL,
|
|
169
170
|
DatabaseTableObject,
|
|
171
|
+
ModifyMigrateRuntimeAttributeRequest,
|
|
170
172
|
PauseMigrateJobResponse,
|
|
171
173
|
Table,
|
|
172
174
|
CompareDetailInfo,
|
|
@@ -213,6 +215,16 @@ export class Client extends AbstractClient {
|
|
|
213
215
|
return this.request("DescribeSyncJobs", req, cb)
|
|
214
216
|
}
|
|
215
217
|
|
|
218
|
+
/**
|
|
219
|
+
* 修改任务运行时属性,此接口不同于配置类接口,不会进行状态机判断。
|
|
220
|
+
*/
|
|
221
|
+
async ModifyMigrateRuntimeAttribute(
|
|
222
|
+
req: ModifyMigrateRuntimeAttributeRequest,
|
|
223
|
+
cb?: (error: string, rep: ModifyMigrateRuntimeAttributeResponse) => void
|
|
224
|
+
): Promise<ModifyMigrateRuntimeAttributeResponse> {
|
|
225
|
+
return this.request("ModifyMigrateRuntimeAttribute", req, cb)
|
|
226
|
+
}
|
|
227
|
+
|
|
216
228
|
/**
|
|
217
229
|
* 购买迁移任务。购买成功后会返回随机生成的迁移任务id列表,也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意,一旦购买成功后源及目标数据库类型,源及目标实例地域不可修改。
|
|
218
230
|
*/
|
|
@@ -747,6 +747,16 @@ export interface StartSyncJobRequest {
|
|
|
747
747
|
JobId?: string
|
|
748
748
|
}
|
|
749
749
|
|
|
750
|
+
/**
|
|
751
|
+
* ModifyMigrateRuntimeAttribute返回参数结构体
|
|
752
|
+
*/
|
|
753
|
+
export interface ModifyMigrateRuntimeAttributeResponse {
|
|
754
|
+
/**
|
|
755
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
756
|
+
*/
|
|
757
|
+
RequestId?: string
|
|
758
|
+
}
|
|
759
|
+
|
|
750
760
|
/**
|
|
751
761
|
* PauseSyncJob请求参数结构体
|
|
752
762
|
*/
|
|
@@ -1008,7 +1018,7 @@ export interface DBEndpointInfo {
|
|
|
1008
1018
|
*/
|
|
1009
1019
|
DatabaseType: string
|
|
1010
1020
|
/**
|
|
1011
|
-
* 节点类型,为空或者"simple"
|
|
1021
|
+
* 节点类型,为空或者"simple"表示普通节点、"cluster"表示集群节点;对于mongo业务,取值为replicaset(mongodb副本集)、standalone(mongodb单节点)、cluster(mongodb集群)
|
|
1012
1022
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1013
1023
|
*/
|
|
1014
1024
|
NodeType: string
|
|
@@ -3896,6 +3906,20 @@ export interface DatabaseTableObject {
|
|
|
3896
3906
|
AdvancedObjects?: Array<string>
|
|
3897
3907
|
}
|
|
3898
3908
|
|
|
3909
|
+
/**
|
|
3910
|
+
* ModifyMigrateRuntimeAttribute请求参数结构体
|
|
3911
|
+
*/
|
|
3912
|
+
export interface ModifyMigrateRuntimeAttributeRequest {
|
|
3913
|
+
/**
|
|
3914
|
+
* 迁移任务id,如:dts-2rgv0f09
|
|
3915
|
+
*/
|
|
3916
|
+
JobId: string
|
|
3917
|
+
/**
|
|
3918
|
+
* 需要修改的属性,此结构设计为通用结构,用于屏蔽多个业务的定制属性。<br>例如对于Redis:<br>{<br> "Key": "DstWriteMode", //目标库写入模式<br> "Value": "normal" //clearData(清空目标实例数据)、overwrite(以覆盖写的方式执行任务)、normal(跟正常流程一样,不做额外动作,默认为此值) <br>},<br>{<br/> "Key": "IsDstReadOnly", //是否在迁移时设置目标库只读<br/> "Value": "true" //true(设置只读)、false(不设置只读) <br/>}
|
|
3919
|
+
*/
|
|
3920
|
+
OtherOptions: Array<KeyValuePairOption>
|
|
3921
|
+
}
|
|
3922
|
+
|
|
3899
3923
|
/**
|
|
3900
3924
|
* PauseMigrateJob返回参数结构体
|
|
3901
3925
|
*/
|
|
@@ -7115,19 +7115,25 @@ export interface ISPCounter {
|
|
|
7115
7115
|
/**
|
|
7116
7116
|
* 运营商名称
|
|
7117
7117
|
*/
|
|
7118
|
-
ProviderName
|
|
7118
|
+
ProviderName?: string
|
|
7119
7119
|
/**
|
|
7120
7120
|
* 节点数量
|
|
7121
7121
|
*/
|
|
7122
|
-
ProviderNodeNum
|
|
7122
|
+
ProviderNodeNum?: number
|
|
7123
7123
|
/**
|
|
7124
7124
|
* 实例数量
|
|
7125
|
+
* @deprecated
|
|
7125
7126
|
*/
|
|
7126
|
-
ProvederInstanceNum
|
|
7127
|
+
ProvederInstanceNum?: number
|
|
7127
7128
|
/**
|
|
7128
7129
|
* Zone实例信息结构体数组
|
|
7129
7130
|
*/
|
|
7130
|
-
ZoneInstanceInfoSet
|
|
7131
|
+
ZoneInstanceInfoSet?: Array<ZoneInstanceInfo>
|
|
7132
|
+
/**
|
|
7133
|
+
* 实例数量
|
|
7134
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
7135
|
+
*/
|
|
7136
|
+
ProviderInstanceNum?: number
|
|
7131
7137
|
}
|
|
7132
7138
|
|
|
7133
7139
|
/**
|
|
@@ -2058,6 +2058,10 @@ Key:template-id Values:需要查询的模板Id列表
|
|
|
2058
2058
|
* @deprecated
|
|
2059
2059
|
*/
|
|
2060
2060
|
GenerateSource?: number
|
|
2061
|
+
/**
|
|
2062
|
+
* 是否获取模板预览链接
|
|
2063
|
+
*/
|
|
2064
|
+
WithPreviewUrl?: boolean
|
|
2061
2065
|
}
|
|
2062
2066
|
|
|
2063
2067
|
/**
|
|
@@ -5599,7 +5603,14 @@ export interface UploadFile {
|
|
|
5599
5603
|
}
|
|
5600
5604
|
|
|
5601
5605
|
/**
|
|
5602
|
-
*
|
|
5606
|
+
* 此结构体 (Component) 用于描述控件属性。
|
|
5607
|
+
|
|
5608
|
+
在通过文件发起合同时,对应的component有三种定位方式
|
|
5609
|
+
1. 绝对定位方式
|
|
5610
|
+
2. 表单域(FIELD)定位方式
|
|
5611
|
+
3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
|
|
5612
|
+
可以参考官网说明
|
|
5613
|
+
https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
|
|
5603
5614
|
*/
|
|
5604
5615
|
export interface Component {
|
|
5605
5616
|
/**
|
|
@@ -5794,9 +5805,10 @@ SIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取
|
|
|
5794
5805
|
*/
|
|
5795
5806
|
ComponentValue?: string
|
|
5796
5807
|
/**
|
|
5797
|
-
*
|
|
5798
|
-
|
|
5799
|
-
|
|
5808
|
+
* 控件生成的方式:
|
|
5809
|
+
NORMAL - 普通控件
|
|
5810
|
+
FIELD - 表单域
|
|
5811
|
+
KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
|
|
5800
5812
|
*/
|
|
5801
5813
|
GenerateMode?: string
|
|
5802
5814
|
/**
|
|
@@ -233,7 +233,9 @@ export class Client extends AbstractClient {
|
|
|
233
233
|
}
|
|
234
234
|
|
|
235
235
|
/**
|
|
236
|
-
* 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
236
|
+
* 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
237
|
+
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
|
|
238
|
+
常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
237
239
|
|
|
238
240
|
**本接口适用于发起方没有填写控件的 B2C或者单C模板**
|
|
239
241
|
|
|
@@ -59,7 +59,7 @@ export interface ChannelCreateFlowRemindsResponse {
|
|
|
59
59
|
在通过文件发起合同时,对应的component有三种定位方式
|
|
60
60
|
1. 绝对定位方式
|
|
61
61
|
2. 表单域(FIELD)定位方式
|
|
62
|
-
3. 关键字(KEYWORD)
|
|
62
|
+
3. 关键字(KEYWORD)定位方式,使用关键字定位时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找
|
|
63
63
|
可以参考官网说明
|
|
64
64
|
https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
|
|
65
65
|
*/
|
|
@@ -123,7 +123,7 @@ SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
|
|
|
123
123
|
* 控件生成的方式:
|
|
124
124
|
NORMAL - 普通控件
|
|
125
125
|
FIELD - 表单域
|
|
126
|
-
KEYWORD -
|
|
126
|
+
KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
|
|
127
127
|
*/
|
|
128
128
|
GenerateMode?: string
|
|
129
129
|
/**
|
|
@@ -185,7 +185,7 @@ ComponentType为SIGN_DATE时,支持以下参数:
|
|
|
185
185
|
|
|
186
186
|
ComponentType为SIGN_SEAL类型时,支持以下参数:
|
|
187
187
|
1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
|
|
188
|
-
参数样例: "ComponentExtra":"{"
|
|
188
|
+
参数样例: "ComponentExtra":"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"
|
|
189
189
|
*/
|
|
190
190
|
ComponentExtra?: string
|
|
191
191
|
/**
|
|
@@ -484,13 +484,15 @@ SIGN_REJECT:拒签(流程结束)
|
|
|
484
484
|
*/
|
|
485
485
|
export interface AuthFailMessage {
|
|
486
486
|
/**
|
|
487
|
-
*
|
|
487
|
+
* 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
|
|
488
|
+
|
|
489
|
+
一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
|
|
488
490
|
*/
|
|
489
|
-
ProxyOrganizationOpenId
|
|
491
|
+
ProxyOrganizationOpenId?: string
|
|
490
492
|
/**
|
|
491
493
|
* 错误信息
|
|
492
494
|
*/
|
|
493
|
-
Message
|
|
495
|
+
Message?: string
|
|
494
496
|
}
|
|
495
497
|
|
|
496
498
|
/**
|
|
@@ -706,27 +708,33 @@ export interface OperateChannelTemplateResponse {
|
|
|
706
708
|
*/
|
|
707
709
|
AppId?: string
|
|
708
710
|
/**
|
|
709
|
-
*
|
|
711
|
+
* 合同模板ID,为32位字符串。此处为第三方应用平台模板库模板ID,非子客模板ID。
|
|
710
712
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
711
713
|
*/
|
|
712
714
|
TemplateId?: string
|
|
713
715
|
/**
|
|
714
716
|
* 描述模板可见性更改的结果,和参数中Available无关。
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
717
|
+
<ul>
|
|
718
|
+
<li>全部成功-"all-success"</li>
|
|
719
|
+
<li>部分成功-"part-success"</li>
|
|
720
|
+
<li>全部失败-"fail",失败的会在FailMessageList中展示</li>
|
|
721
|
+
</ul>
|
|
718
722
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
719
723
|
*/
|
|
720
724
|
OperateResult?: string
|
|
721
725
|
/**
|
|
722
726
|
* 模板可见性,
|
|
723
|
-
|
|
724
|
-
|
|
727
|
+
<ul>
|
|
728
|
+
<li>全部可见-"all"</li>
|
|
729
|
+
<li>部分可见-"part"</li>
|
|
730
|
+
</ul>
|
|
725
731
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
726
732
|
*/
|
|
727
733
|
AuthTag?: string
|
|
728
734
|
/**
|
|
729
|
-
*
|
|
735
|
+
* 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
|
|
736
|
+
|
|
737
|
+
一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
|
|
730
738
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
731
739
|
*/
|
|
732
740
|
ProxyOrganizationOpenIds?: Array<string>
|
|
@@ -3567,37 +3575,45 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
|
|
|
3567
3575
|
*/
|
|
3568
3576
|
export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
3569
3577
|
/**
|
|
3570
|
-
*
|
|
3571
|
-
|
|
3578
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3579
|
+
|
|
3580
|
+
此接口下面信息必填。
|
|
3581
|
+
<ul>
|
|
3582
|
+
<li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
|
|
3583
|
+
<li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
|
|
3584
|
+
<li>第三方平台子客企业中的员工标识: Agent.AppId</li>
|
|
3585
|
+
</ul>
|
|
3572
3586
|
*/
|
|
3573
3587
|
Agent: Agent
|
|
3574
3588
|
/**
|
|
3575
|
-
*
|
|
3589
|
+
* 合同模板ID,为32位字符串。
|
|
3590
|
+
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
3576
3591
|
*/
|
|
3577
3592
|
TemplateId: string
|
|
3578
3593
|
/**
|
|
3579
|
-
*
|
|
3594
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
|
|
3580
3595
|
*/
|
|
3581
3596
|
FlowName: string
|
|
3582
3597
|
/**
|
|
3583
|
-
*
|
|
3584
|
-
<br/>默认5份
|
|
3585
|
-
<br/>备注:发起签署流程数量超过此上限后,二维码自动失效。
|
|
3598
|
+
* 通过此二维码可发起的流程最大限额,如未明确指定,默认为5份。 一旦发起流程数超越该限制,该二维码将自动失效。
|
|
3586
3599
|
*/
|
|
3587
3600
|
MaxFlowNum?: number
|
|
3588
3601
|
/**
|
|
3589
|
-
*
|
|
3602
|
+
* 合同流程的签署有效期限,若未设定签署截止日期,则默认为自合同流程创建起的7天内截止。 若在签署截止日期前未完成签署,合同状态将变更为已过期,从而导致合同无效。 最长设定期限不得超过30天。
|
|
3590
3603
|
*/
|
|
3591
3604
|
FlowEffectiveDay?: number
|
|
3592
3605
|
/**
|
|
3593
|
-
*
|
|
3606
|
+
* 二维码的有效期限,默认为7天,最高设定不得超过90天。 一旦超过二维码的有效期限,该二维码将自动失效。
|
|
3594
3607
|
*/
|
|
3595
3608
|
QrEffectiveDay?: number
|
|
3596
3609
|
/**
|
|
3597
|
-
*
|
|
3598
|
-
<br/>指定后,只允许知道的人操作和签署
|
|
3610
|
+
* 指定签署人信息。 在指定签署人后,仅允许特定签署人通过扫描二维码进行签署。
|
|
3599
3611
|
*/
|
|
3600
3612
|
Restrictions?: Array<ApproverRestriction>
|
|
3613
|
+
/**
|
|
3614
|
+
* 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
|
|
3615
|
+
*/
|
|
3616
|
+
ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>
|
|
3601
3617
|
/**
|
|
3602
3618
|
* 已废弃,回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
|
|
3603
3619
|
<br/> 通过一码多扫二维码发起的合同,回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
|
|
@@ -3615,28 +3631,24 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
3615
3631
|
* @deprecated
|
|
3616
3632
|
*/
|
|
3617
3633
|
Operator?: UserInfo
|
|
3618
|
-
/**
|
|
3619
|
-
* 指定签署方经办人控件类型是个人印章签署控件(SIGN_SIGNATURE) 时,可选的签名方式。
|
|
3620
|
-
*/
|
|
3621
|
-
ApproverComponentLimitTypes?: Array<ApproverComponentLimitType>
|
|
3622
3634
|
}
|
|
3623
3635
|
|
|
3624
3636
|
/**
|
|
3625
|
-
*
|
|
3637
|
+
* 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
|
|
3626
3638
|
*/
|
|
3627
3639
|
export interface SignQrCode {
|
|
3628
3640
|
/**
|
|
3629
|
-
* 二维码
|
|
3641
|
+
* 二维码ID,为32位字符串。
|
|
3630
3642
|
*/
|
|
3631
|
-
QrCodeId
|
|
3643
|
+
QrCodeId?: string
|
|
3632
3644
|
/**
|
|
3633
|
-
* 二维码
|
|
3645
|
+
* 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
|
|
3634
3646
|
*/
|
|
3635
|
-
QrCodeUrl
|
|
3647
|
+
QrCodeUrl?: string
|
|
3636
3648
|
/**
|
|
3637
|
-
*
|
|
3649
|
+
* 二维码的有截止时间,格式为Unix标准时间戳(秒)。 一旦超过二维码的有效期限,该二维码将自动失效。
|
|
3638
3650
|
*/
|
|
3639
|
-
ExpiredTime
|
|
3651
|
+
ExpiredTime?: number
|
|
3640
3652
|
}
|
|
3641
3653
|
|
|
3642
3654
|
/**
|
|
@@ -4643,11 +4655,11 @@ export interface ChannelCreateFlowGroupByFilesResponse {
|
|
|
4643
4655
|
*/
|
|
4644
4656
|
export interface ChannelCreateMultiFlowSignQRCodeResponse {
|
|
4645
4657
|
/**
|
|
4646
|
-
*
|
|
4658
|
+
* 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
|
|
4647
4659
|
*/
|
|
4648
4660
|
QrCode?: SignQrCode
|
|
4649
4661
|
/**
|
|
4650
|
-
*
|
|
4662
|
+
* 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
|
|
4651
4663
|
*/
|
|
4652
4664
|
SignUrls?: SignUrl
|
|
4653
4665
|
/**
|
|
@@ -5114,21 +5126,21 @@ export interface ChannelCreateFlowGroupByTemplatesRequest {
|
|
|
5114
5126
|
}
|
|
5115
5127
|
|
|
5116
5128
|
/**
|
|
5117
|
-
*
|
|
5129
|
+
* 流程签署二维码的签署信息,适用于客户系统整合二维码功能。 通过链接,用户可直接访问电子签名小程序并签署合同。
|
|
5118
5130
|
*/
|
|
5119
5131
|
export interface SignUrl {
|
|
5120
5132
|
/**
|
|
5121
|
-
*
|
|
5133
|
+
* 跳转至电子签名小程序签署的链接地址。 适用于客户端APP及小程序直接唤起电子签名小程序。
|
|
5122
5134
|
*/
|
|
5123
|
-
AppSignUrl
|
|
5135
|
+
AppSignUrl?: string
|
|
5124
5136
|
/**
|
|
5125
|
-
*
|
|
5137
|
+
* 签署链接有效时间,格式类似"2022-08-05 15:55:01"
|
|
5126
5138
|
*/
|
|
5127
|
-
EffectiveTime
|
|
5139
|
+
EffectiveTime?: string
|
|
5128
5140
|
/**
|
|
5129
|
-
*
|
|
5141
|
+
* 跳转至电子签名小程序签署的链接地址,格式类似于https://essurl.cn/xxx。 打开此链接将会展示H5中间页面,随后唤起电子签名小程序以进行合同签署。
|
|
5130
5142
|
*/
|
|
5131
|
-
HttpSignUrl
|
|
5143
|
+
HttpSignUrl?: string
|
|
5132
5144
|
}
|
|
5133
5145
|
|
|
5134
5146
|
/**
|
|
@@ -5497,38 +5509,51 @@ export interface ChannelCreateBatchCancelFlowUrlResponse {
|
|
|
5497
5509
|
*/
|
|
5498
5510
|
export interface OperateChannelTemplateRequest {
|
|
5499
5511
|
/**
|
|
5500
|
-
*
|
|
5501
|
-
|
|
5512
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5513
|
+
|
|
5514
|
+
此接口下面信息必填。
|
|
5515
|
+
<ul>
|
|
5516
|
+
<li>第三方平台子客企业中的员工标识: Agent.AppId</li>
|
|
5517
|
+
</ul>
|
|
5502
5518
|
*/
|
|
5503
5519
|
Agent: Agent
|
|
5504
5520
|
/**
|
|
5505
5521
|
* 操作类型,
|
|
5506
|
-
|
|
5507
|
-
|
|
5508
|
-
|
|
5522
|
+
<ul>
|
|
5523
|
+
<li>查询:"SELECT"</li>
|
|
5524
|
+
<li>删除:"DELETE"</li>
|
|
5525
|
+
<li>更新:"UPDATE"</li>
|
|
5526
|
+
</ul>
|
|
5509
5527
|
*/
|
|
5510
5528
|
OperateType: string
|
|
5511
5529
|
/**
|
|
5512
|
-
*
|
|
5530
|
+
* 合同模板ID,为32位字符串。此处为第三方应用平台模板库模板ID,非子客模板ID。
|
|
5513
5531
|
*/
|
|
5514
5532
|
TemplateId: string
|
|
5515
5533
|
/**
|
|
5516
|
-
*
|
|
5517
|
-
|
|
5534
|
+
* 第三方平台子客企业的唯一标识,长度不能超过64,只能由字母和数字组成。开发者可自定义此字段的值,并需要保存此 ID 以便进行后续操作。
|
|
5535
|
+
|
|
5536
|
+
一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
|
|
5518
5537
|
*/
|
|
5519
5538
|
ProxyOrganizationOpenIds?: string
|
|
5520
5539
|
/**
|
|
5521
5540
|
* 模板可见性,
|
|
5522
|
-
|
|
5523
|
-
|
|
5541
|
+
<ul>
|
|
5542
|
+
<li>全部可见-"all"</li>
|
|
5543
|
+
<li>部分可见-"part"</li>
|
|
5544
|
+
</ul>
|
|
5524
5545
|
*/
|
|
5525
5546
|
AuthTag?: string
|
|
5526
5547
|
/**
|
|
5527
5548
|
* 当OperateType=UPDATE时,可以通过设置此字段对模板启停用状态进行操作。
|
|
5528
|
-
|
|
5529
|
-
|
|
5530
|
-
|
|
5531
|
-
|
|
5549
|
+
<ul>
|
|
5550
|
+
<li>若此字段值为0,则不会修改模板Available</li>
|
|
5551
|
+
<li>1为启用模板</li>
|
|
5552
|
+
<li>2为停用模板</li>
|
|
5553
|
+
</ul>
|
|
5554
|
+
启用后模板可以正常领取。
|
|
5555
|
+
停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
|
|
5556
|
+
如果Available更新失败,会直接返回错误。
|
|
5532
5557
|
*/
|
|
5533
5558
|
Available?: number
|
|
5534
5559
|
/**
|
|
@@ -492,7 +492,7 @@ export class Client extends AbstractClient {
|
|
|
492
492
|
}
|
|
493
493
|
|
|
494
494
|
/**
|
|
495
|
-
* 检测给定图片中的人脸(Face)的位置、相应的面部属性和人脸质量信息,位置包括 (x,y,w,h),面部属性包括性别(gender)、年龄(age)、表情(expression)、魅力(beauty)、眼镜(glass)、发型(hair)、口罩(mask)和姿态 (pitch,roll,yaw)
|
|
495
|
+
* 检测给定图片中的人脸(Face)的位置、相应的面部属性和人脸质量信息,位置包括 (x,y,w,h),面部属性包括性别(gender)、年龄(age)、表情(expression)、魅力(beauty)、眼镜(glass)、发型(hair)、口罩(mask)和姿态 (pitch,roll,yaw)。
|
|
496
496
|
|
|
497
497
|
|
|
498
498
|
其中,人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时,建议您对输入的人脸图片进行质量检测,提升后续业务处理的效果。该功能的应用场景包括:
|