tencentcloud-sdk-nodejs 4.1.302 → 4.1.304
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/es/common/sdk_version.js +1 -1
- package/es/services/cynosdb/v20190107/cynosdb_client.js +3 -0
- package/es/services/emr/v20190103/emr_client.js +3 -0
- package/es/services/ess/v20201111/ess_client.js +3 -0
- package/es/services/essbasic/v20210526/essbasic_client.js +5 -2
- package/es/services/ioa/v20220601/ioa_client.js +3 -0
- package/es/services/monitor/v20230616/monitor_client.js +32 -2
- package/es/services/mps/v20190612/mps_client.js +21 -6
- package/es/services/postgres/v20170312/postgres_client.js +16 -4
- package/es/services/sms/v20210111/sms_client.js +7 -4
- package/es/services/tcb/v20180608/tcb_client.js +10 -7
- package/es/services/tcr/v20190924/tcr_client.js +6 -0
- package/es/services/teo/v20220901/teo_client.js +3 -0
- package/es/services/thpc/v20230321/thpc_client.js +38 -11
- package/es/services/vod/v20180717/vod_client.js +26 -8
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/adp/v20260520/adp_models.d.ts +32 -3
- package/tencentcloud/services/asr/v20190614/asr_client.d.ts +1 -1
- package/tencentcloud/services/asr/v20190614/asr_client.js +1 -1
- package/tencentcloud/services/bi/v20220105/bi_models.d.ts +48 -34
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +23 -27
- package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +8 -0
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +111 -45
- package/tencentcloud/services/clb/v20180317/clb_client.d.ts +2 -0
- package/tencentcloud/services/clb/v20180317/clb_client.js +2 -0
- package/tencentcloud/services/clb/v20180317/clb_models.d.ts +117 -1
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +2 -2
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -0
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +36 -5
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +5 -5
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +17 -22
- package/tencentcloud/services/emr/v20190103/emr_client.d.ts +5 -1
- package/tencentcloud/services/emr/v20190103/emr_client.js +6 -0
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +35 -5
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +135 -32
- package/tencentcloud/services/ess/v20201111/ess_client.js +136 -31
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +55 -42
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +129 -6
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +131 -6
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +55 -37
- package/tencentcloud/services/fwm/v20250611/fwm_models.d.ts +48 -28
- package/tencentcloud/services/goosefs/v20220519/goosefs_models.d.ts +20 -4
- package/tencentcloud/services/ioa/v20220601/ioa_client.d.ts +5 -1
- package/tencentcloud/services/ioa/v20220601/ioa_client.js +6 -0
- package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +127 -28
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +92 -57
- package/tencentcloud/services/live/v20180801/live_models.d.ts +13 -17
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +67 -63
- package/tencentcloud/services/monitor/v20230616/monitor_client.d.ts +43 -3
- package/tencentcloud/services/monitor/v20230616/monitor_client.js +63 -3
- package/tencentcloud/services/monitor/v20230616/monitor_models.d.ts +591 -74
- package/tencentcloud/services/mps/v20190612/mps_client.d.ts +27 -7
- package/tencentcloud/services/mps/v20190612/mps_client.js +39 -9
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +497 -319
- package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts +15 -7
- package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +23 -7
- package/tencentcloud/services/postgres/v20170312/postgres_client.js +32 -8
- package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +278 -98
- package/tencentcloud/services/smh/v20210712/smh_models.d.ts +55 -13
- package/tencentcloud/services/sms/v20210111/sms_client.d.ts +11 -7
- package/tencentcloud/services/sms/v20210111/sms_client.js +14 -8
- package/tencentcloud/services/sms/v20210111/sms_models.d.ts +87 -0
- package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +15 -11
- package/tencentcloud/services/tcb/v20180608/tcb_client.js +20 -14
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +181 -37
- package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +9 -1
- package/tencentcloud/services/tcr/v20190924/tcr_client.js +12 -0
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +186 -24
- package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +13 -23
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +4 -4
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +4 -4
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +44 -32
- package/tencentcloud/services/tdmysql/v20211122/tdmysql_models.d.ts +46 -3
- package/tencentcloud/services/teo/v20220901/teo_client.d.ts +6 -1
- package/tencentcloud/services/teo/v20220901/teo_client.js +7 -0
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +140 -0
- package/tencentcloud/services/thpc/v20220401/thpc_models.d.ts +5 -0
- package/tencentcloud/services/thpc/v20230321/thpc_client.d.ts +51 -15
- package/tencentcloud/services/thpc/v20230321/thpc_client.js +74 -20
- package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +625 -224
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +42 -18
- package/tencentcloud/services/vod/v20180717/vod_client.js +57 -21
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +1294 -358
- package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +122 -120
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +1 -1
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +164 -136
- package/tencentcloud/services/wedata/v20250806/wedata_models.d.ts +73 -163
|
@@ -6705,6 +6705,19 @@ export interface ReplayInstanceAuditLogRequest {
|
|
|
6705
6705
|
*/
|
|
6706
6706
|
EndTime: string;
|
|
6707
6707
|
}
|
|
6708
|
+
/**
|
|
6709
|
+
* ModifyClusterLevel请求参数结构体
|
|
6710
|
+
*/
|
|
6711
|
+
export interface ModifyClusterLevelRequest {
|
|
6712
|
+
/**
|
|
6713
|
+
* <p>集群ID</p>
|
|
6714
|
+
*/
|
|
6715
|
+
ClusterId: string;
|
|
6716
|
+
/**
|
|
6717
|
+
* <p>集群级别</p>
|
|
6718
|
+
*/
|
|
6719
|
+
ClusterLevel: string;
|
|
6720
|
+
}
|
|
6708
6721
|
/**
|
|
6709
6722
|
* 同步库表对象
|
|
6710
6723
|
*/
|
|
@@ -7954,6 +7967,11 @@ export interface Package {
|
|
|
7954
7967
|
CCU-计算资源包,DISK-存储资源包
|
|
7955
7968
|
*/
|
|
7956
7969
|
PackageType?: string;
|
|
7970
|
+
/**
|
|
7971
|
+
* 资源包套餐版本
|
|
7972
|
+
base-基础,common-通用,enterprise-企业
|
|
7973
|
+
*/
|
|
7974
|
+
PackageVersion?: string;
|
|
7957
7975
|
/**
|
|
7958
7976
|
* 资源包使用地域
|
|
7959
7977
|
china-中国内地通用,overseas-港澳台及海外通用
|
|
@@ -11141,6 +11159,19 @@ export interface CreateAuditRuleTemplateRequest {
|
|
|
11141
11159
|
*/
|
|
11142
11160
|
AlarmPolicy?: number;
|
|
11143
11161
|
}
|
|
11162
|
+
/**
|
|
11163
|
+
* ModifyClusterLevel返回参数结构体
|
|
11164
|
+
*/
|
|
11165
|
+
export interface ModifyClusterLevelResponse {
|
|
11166
|
+
/**
|
|
11167
|
+
* <p>任务ID</p>
|
|
11168
|
+
*/
|
|
11169
|
+
TaskId?: number;
|
|
11170
|
+
/**
|
|
11171
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
11172
|
+
*/
|
|
11173
|
+
RequestId?: string;
|
|
11174
|
+
}
|
|
11144
11175
|
/**
|
|
11145
11176
|
* PauseServerless请求参数结构体
|
|
11146
11177
|
*/
|
|
@@ -12349,15 +12380,15 @@ export interface DescribeAccountPrivilegesRequest {
|
|
|
12349
12380
|
*/
|
|
12350
12381
|
Host: string;
|
|
12351
12382
|
/**
|
|
12352
|
-
*
|
|
12383
|
+
* 数据库名。为*时,忽略Type/TableName,表示查询用户全局权限;不传时默认为*。
|
|
12353
12384
|
*/
|
|
12354
|
-
Db
|
|
12385
|
+
Db?: string;
|
|
12355
12386
|
/**
|
|
12356
|
-
* 指定数据库下的对象类型,可选"table"
|
|
12387
|
+
* 指定数据库下的对象类型,可选"table"、"*"。不传时默认为*;Type为table时,必须指定TableName。
|
|
12357
12388
|
*/
|
|
12358
|
-
Type
|
|
12389
|
+
Type?: string;
|
|
12359
12390
|
/**
|
|
12360
|
-
* 当Type="table"
|
|
12391
|
+
* 当Type="table"时,用来指定表名;Type为table时必填。
|
|
12361
12392
|
*/
|
|
12362
12393
|
TableName?: string;
|
|
12363
12394
|
}
|
|
@@ -2824,11 +2824,11 @@ export interface ModifySparkAppResponse {
|
|
|
2824
2824
|
*/
|
|
2825
2825
|
export interface CreatePartitionRequest {
|
|
2826
2826
|
/**
|
|
2827
|
-
* <p>交易类型:purchase
|
|
2827
|
+
* <p>交易类型:purchase-新购</p>
|
|
2828
2828
|
*/
|
|
2829
2829
|
ActionType: string;
|
|
2830
2830
|
/**
|
|
2831
|
-
* <p>付费模式:
|
|
2831
|
+
* <p>付费模式:1-预付费</p>
|
|
2832
2832
|
*/
|
|
2833
2833
|
PayMode: number;
|
|
2834
2834
|
/**
|
|
@@ -2836,11 +2836,11 @@ export interface CreatePartitionRequest {
|
|
|
2836
2836
|
*/
|
|
2837
2837
|
ResourceQuotaList: Array<ResourceQuota>;
|
|
2838
2838
|
/**
|
|
2839
|
-
* <p
|
|
2839
|
+
* <p>时间大小,预付费时为购买月数</p>
|
|
2840
2840
|
*/
|
|
2841
2841
|
TimeSpan: number;
|
|
2842
2842
|
/**
|
|
2843
|
-
* <p>时间单位,预付费为m
|
|
2843
|
+
* <p>时间单位,预付费为m(月)</p>
|
|
2844
2844
|
*/
|
|
2845
2845
|
TimeUnit: string;
|
|
2846
2846
|
/**
|
|
@@ -2852,7 +2852,7 @@ export interface CreatePartitionRequest {
|
|
|
2852
2852
|
*/
|
|
2853
2853
|
Name?: string;
|
|
2854
2854
|
/**
|
|
2855
|
-
* <p
|
|
2855
|
+
* <p>资源包描述</p>
|
|
2856
2856
|
*/
|
|
2857
2857
|
Description?: string;
|
|
2858
2858
|
}
|
|
@@ -368,29 +368,27 @@ export interface ResumeSyncJobRequest {
|
|
|
368
368
|
*/
|
|
369
369
|
export interface ModifySubscribeObjectsRequest {
|
|
370
370
|
/**
|
|
371
|
-
*
|
|
371
|
+
* <p>数据订阅实例的ID,可通过<a href="https://cloud.tencent.com/document/product/571/102943">DescribeSubscribeJobs</a>接口获取。</p>
|
|
372
372
|
*/
|
|
373
373
|
SubscribeId: string;
|
|
374
374
|
/**
|
|
375
|
-
*
|
|
375
|
+
* <p>数据订阅的类型,非mongo任务的枚举值:0-全实例更新;1-数据更新;2-结构更新;3-数据更新+结构更新。mongo任务的枚举值:0-全实例更新;4-订阅单库;5-订阅单集合</p>
|
|
376
376
|
*/
|
|
377
377
|
SubscribeObjectType: number;
|
|
378
378
|
/**
|
|
379
|
-
*
|
|
379
|
+
* <p>修改后的订阅数据库表信息。会覆盖原来的订阅对象,所以除非 SubscribeObjectType = 0或2,否则该字段必填。</p>
|
|
380
380
|
*/
|
|
381
381
|
Objects?: Array<ModifiedSubscribeObject>;
|
|
382
382
|
/**
|
|
383
|
-
* kafka
|
|
383
|
+
* <p>kafka分区策略。如果不填,默认不修改。如果填了,会覆盖原来的策略。</p>
|
|
384
384
|
*/
|
|
385
385
|
DistributeRules?: Array<DistributeRule>;
|
|
386
386
|
/**
|
|
387
|
-
*
|
|
388
|
-
非mongo产品支持的默认策略: table-按表名分区,pk-按表名+主键分区。mongo的默认策略仅支持:collection-按集合名分区。
|
|
389
|
-
该字段与DistributeRules搭配使用。如果配置了DistributeRules,该字段也必填。如果配置了该字段,视为配置了一条DistributeRules,原来的分区策略也会被覆盖。
|
|
387
|
+
* <p>默认分区策略。不满足DistributeRules中正则表达式的数据,将按照默认分区策略计算分区。<br>非mongo产品支持的默认策略: table-按表名分区,pk-按表名+主键分区。mongo的默认策略仅支持:collection-按集合名分区。<br>该字段与DistributeRules搭配使用。如果配置了DistributeRules,该字段也必填。如果配置了该字段,视为配置了一条DistributeRules,原来的分区策略也会被覆盖。</p>
|
|
390
388
|
*/
|
|
391
389
|
DefaultRuleType?: string;
|
|
392
390
|
/**
|
|
393
|
-
* mongo输出聚合设置,mongo
|
|
391
|
+
* <p>mongo输出聚合设置,mongo任务可选。如果不填,默认不修改。</p>
|
|
394
392
|
*/
|
|
395
393
|
PipelineInfo?: Array<PipelineInfo>;
|
|
396
394
|
}
|
|
@@ -5298,50 +5296,47 @@ export interface Endpoint {
|
|
|
5298
5296
|
*/
|
|
5299
5297
|
export interface ConfigureSubscribeJobRequest {
|
|
5300
5298
|
/**
|
|
5301
|
-
*
|
|
5299
|
+
* <p>数据订阅实例的 ID,可通过<a href="https://cloud.tencent.com/document/product/571/82103">DescribeSyncJobs</a>接口获取。</p>
|
|
5302
5300
|
*/
|
|
5303
5301
|
SubscribeId: string;
|
|
5304
5302
|
/**
|
|
5305
|
-
*
|
|
5303
|
+
* <p>数据订阅的类型,当 DatabaseType 不为 mongodb 时,枚举值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 DatabaseType 为 mongodb 时,枚举值为 all-全实例更新;database-订阅单库;collection-订阅单集合</p>
|
|
5306
5304
|
*/
|
|
5307
5305
|
SubscribeMode: string;
|
|
5308
5306
|
/**
|
|
5309
|
-
*
|
|
5307
|
+
* <p>源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力</p>
|
|
5310
5308
|
*/
|
|
5311
5309
|
AccessType: string;
|
|
5312
5310
|
/**
|
|
5313
|
-
*
|
|
5311
|
+
* <p>数据库节点信息</p>
|
|
5314
5312
|
*/
|
|
5315
5313
|
Endpoints: Array<EndpointItem>;
|
|
5316
5314
|
/**
|
|
5317
|
-
* Kafka
|
|
5315
|
+
* <p>Kafka配置</p>
|
|
5318
5316
|
*/
|
|
5319
5317
|
KafkaConfig: SubscribeKafkaConfig;
|
|
5320
5318
|
/**
|
|
5321
|
-
*
|
|
5319
|
+
* <p>订阅的数据库表信息,当 SubscribeMode 不为 all和ddl 时,SubscribeObjects 为必选参数</p>
|
|
5322
5320
|
*/
|
|
5323
5321
|
SubscribeObjects?: Array<SubscribeObject>;
|
|
5324
5322
|
/**
|
|
5325
|
-
*
|
|
5323
|
+
* <p>订阅数据格式,如:protobuf、json、avro。注意具体可选值依赖当前链路支持能力,数据格式详情参考官网的消费demo文档</p>
|
|
5326
5324
|
*/
|
|
5327
5325
|
Protocol?: string;
|
|
5328
5326
|
/**
|
|
5329
|
-
* mongo
|
|
5327
|
+
* <p>mongo选填参数:输出聚合设置。</p>
|
|
5330
5328
|
*/
|
|
5331
5329
|
PipelineInfo?: Array<PipelineInfo>;
|
|
5332
5330
|
/**
|
|
5333
|
-
*
|
|
5334
|
-
mysql选填参数:ProcessXA-是否处理XA事务,填true处理,不填或填其他值不处理。
|
|
5335
|
-
mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream,不填也是默认changeStream。
|
|
5336
|
-
其他业务暂没有可选参数。
|
|
5331
|
+
* <p>为业务添加的额外信息。参数名作key,参数值作value。<br>mysql选填参数:ProcessXA-是否处理XA事务,填true处理,不填或填其他值不处理。<br>mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream,不填也是默认changeStream。<br>其他业务暂没有可选参数。</p>
|
|
5337
5332
|
*/
|
|
5338
5333
|
ExtraAttr?: Array<KeyValuePairOption>;
|
|
5339
5334
|
/**
|
|
5340
|
-
* vpc id
|
|
5335
|
+
* <p>vpc id</p>
|
|
5341
5336
|
*/
|
|
5342
5337
|
ConsumerVpcId?: string;
|
|
5343
5338
|
/**
|
|
5344
|
-
* subnet id
|
|
5339
|
+
* <p>subnet id</p>
|
|
5345
5340
|
*/
|
|
5346
5341
|
ConsumerSubnetId?: string;
|
|
5347
5342
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { AddNodeResourceConfigRequest, TerminateTasksRequest, DescribeEMREventListResponse, DescribeEmrApplicationStaticsRequest, DescribeTrinoQueryInfoResponse, DescribeDynamicInstanceDetailResponse, ResetYarnConfigRequest, DescribeServiceNodeInfosResponse, AttachDisksRequest, AddUsersForUserManagerResponse, DeleteNodeResourceConfigRequest, TerminateTasksResponse, DescribeSparkQueriesResponse, InstallSoftwareRequest, DescribeInspectionTaskResultRequest, InquiryPriceCreateInstanceResponse, DescribeHDFSStorageInfoRequest, DescribeGlobalConfigResponse, ModifyResourceRequest, DescribeBootScriptResponse, DescribeHBaseTableRequestMetricRequest, ModifyInspectionSettingsResponse, ScaleOutClusterRequest, DescribeHiveQueriesRequest, CreateClusterResponse, DescribeCvmQuotaResponse, AddMetricScaleStrategyResponse, DescribeNodeResourceConfigFastRequest, SyncPodStateRequest, DescribeSLInstanceListResponse, ModifyDynamicInstanceResponse, DescribeServiceConfGroupInfosRequest, InquiryPriceUpdateInstanceRequest, DescribeDynamicInstanceDetailRequest, AttachDisksResponse, DescribeSparkQueriesRequest, DescribeInstancesResponse, DescribeUsersForUserManagerResponse, DescribeResourceScheduleDiffDetailRequest, InquirePriceRenewEmrResponse, DescribeSLInstanceRequest, ModifyAutoRenewFlagRequest, AddNodeResourceConfigResponse, ModifyResourceScheduleConfigRequest, DeleteAutoScaleStrategyResponse, DescribeStarRocksQueryInfoResponse, ModifyResourceSchedulerResponse, DescribeAutoScaleRecordsRequest, DescribeHBaseTableRequestMetricResponse, DescribeJobFlowResponse, DescribeEmrOverviewMetricsRequest, ModifyResourceResponse, ModifyUserGroupResponse, DescribeHDFSStorageInfoResponse, ModifyPodNumResponse, ModifyGlobalConfigResponse, CreateGroupsSTDResponse, ModifySLInstanceBasicRequest, CreateCloudInstanceResponse, ModifyAutoScaleStrategyRequest, DescribeGroupsSTDRequest, DescribeKyuubiQueryInfoResponse, DescribeBootScriptRequest, DescribeServiceConfGroupInfosResponse, DescribeInstanceOplogRequest, ModifyYarnDeployRequest, DescribeClusterFlowStatusDetailRequest, DescribeDAGInfoResponse, RunJobFlowResponse, DescribeHiveQueriesResponse, CreateDynamicInstanceRequest, DescribeInstanceRenewNodesResponse, CreateClusterRequest, CreateSLInstanceResponse, DescribeClusterNodesResponse, DescribeYarnApplicationsRequest, ModifyBootScriptResponse, DeleteUserManagerUserListRequest, DescribeResourceScheduleResponse, DescribeKyuubiQueryInfoRequest, DescribeNodeResourceConfigFastResponse, DescribeInsightListResponse, DescribeAutoScaleRecordsResponse, DescribeInspectionTaskResultResponse, DescribeCvmQuotaRequest, CreateInstanceRequest, InstallSoftwareResponse, ModifyUsersOfGroupSTDRequest, DeleteAutoScaleStrategyRequest, DescribeInstancesListResponse, ModifyResourcePoolsResponse, DescribeInstanceRenewNodesRequest, DescribeYarnApplicationsResponse, InquiryPriceCreateInstanceRequest, DescribeSLInstanceResponse, ModifySLInstanceResponse, ModifyGlobalConfigRequest, DescribeHBaseTableStoreSizeMetricResponse, DescribeImpalaQueriesResponse, SetNodeResourceConfigDefaultResponse, DescribeDynamicInstanceListRequest, ModifyInstanceBasicResponse, DescribeTrinoQueryInfoRequest, ModifyResourcePoolsRequest, TerminateInstanceResponse, DescribeSparkApplicationsResponse, ScaleOutInstanceResponse, ModifyUserManagerPwdResponse, TerminateDynamicInstancesRequest, CreateInstanceResponse, DescribeServiceNodeInfosRequest, DescribeHBaseTableStoreSizeMetricRequest, TerminateDynamicInstancesResponse, DescribeInstanceOplogResponse, DescribeAutoScaleGroupGlobalConfRequest, ModifyResourceScheduleConfigResponse, DescribeEMREventListRequest, DescribeDynamicInstanceListResponse, DescribeResourceScheduleDiffDetailResponse, DescribeYarnQueueResponse, CreateGroupsSTDRequest, ConvertPreToPostClusterRequest, DescribeNodeDataDisksRequest, DescribeJobFlowRequest, ModifyBootScriptRequest, ModifyYarnDeployResponse, DescribeUsersForUserManagerRequest, DescribeNodeSpecRequest, DescribeYarnScheduleHistoryRequest, StartStopServiceOrMonitorResponse, DescribeYarnQueueRequest, ModifyAutoRenewFlagResponse, DescribeYarnScheduleHistoryResponse, DescribeInsightListRequest, ModifyResourcesTagsRequest, TerminateClusterNodesResponse, DescribeSLInstanceListRequest, DeleteGroupsSTDResponse, DescribeImpalaQueriesRequest, ModifyPodNumRequest, ModifyUserGroupRequest, DescribeInstancesRequest, DeployYarnConfRequest, DescribeGroupsSTDResponse, DescribeNodeDataDisksResponse, DescribeInstancesListRequest, ModifyInstanceBasicRequest, AddUsersForUserManagerRequest, TerminateInstanceRequest, TerminateSLInstanceRequest, DescribeNodeSpecResponse, DescribeStarRocksQueryInfoRequest, ResizeDataDisksResponse, ModifySLInstanceBasicResponse, ResizeDataDisksRequest, ScaleOutClusterResponse, CreateSLInstanceRequest, DescribeGlobalConfigRequest, ScaleOutInstanceRequest, DescribeHBaseTableOverviewRequest, DescribeClusterFlowStatusDetailResponse, DescribeSparkApplicationsRequest, SyncPodStateResponse, ModifyDynamicInstanceRequest, ModifyUserManagerPwdRequest, RunJobFlowRequest, DescribeHBaseTableOverviewResponse, AddMetricScaleStrategyRequest, ModifyUsersOfGroupSTDResponse, ResetYarnConfigResponse, InquiryPriceRenewInstanceResponse, StartStopServiceOrMonitorRequest, DescribeResourceScheduleRequest, DeleteNodeResourceConfigResponse, ConvertPreToPostClusterResponse, ModifyResourcesTagsResponse, SetNodeResourceConfigDefaultRequest, DescribeDAGInfoRequest, DescribeAutoScaleGroupGlobalConfResponse, InquiryPriceUpdateInstanceResponse, ModifyYarnQueueV2Response, ModifyInspectionSettingsRequest, ModifyResourceSchedulerRequest, ModifySLInstanceRequest, CreateCloudInstanceRequest, ModifyYarnQueueV2Request, DescribeClusterNodesRequest, DescribeEmrOverviewMetricsResponse, TerminateSLInstanceResponse, DescribeAutoScaleStrategiesRequest, DeployYarnConfResponse, DeleteUserManagerUserListResponse, InquiryPriceRenewInstanceRequest, DeleteGroupsSTDRequest, DescribeAutoScaleStrategiesResponse, CreateDynamicInstanceResponse, ModifyAutoScaleStrategyResponse, InquiryPriceScaleOutInstanceRequest, DescribeEmrApplicationStaticsResponse, InquirePriceRenewEmrRequest, InquiryPriceScaleOutInstanceResponse, TerminateClusterNodesRequest } from "./emr_models";
|
|
3
|
+
import { AddNodeResourceConfigRequest, TerminateTasksRequest, DescribeEMREventListResponse, DescribeEmrApplicationStaticsRequest, DescribeTrinoQueryInfoResponse, DescribeDynamicInstanceDetailResponse, ResetYarnConfigRequest, DescribeServiceNodeInfosResponse, AttachDisksRequest, AddUsersForUserManagerResponse, DeleteNodeResourceConfigRequest, TerminateTasksResponse, DescribeSparkQueriesResponse, InstallSoftwareRequest, DescribeInspectionTaskResultRequest, InquiryPriceCreateInstanceResponse, DescribeHDFSStorageInfoRequest, DescribeMetaDBInfoResponse, DescribeGlobalConfigResponse, ModifyResourceRequest, DescribeBootScriptResponse, DescribeHBaseTableRequestMetricRequest, ModifyInspectionSettingsResponse, ScaleOutClusterRequest, DescribeHiveQueriesRequest, CreateClusterResponse, DescribeCvmQuotaResponse, AddMetricScaleStrategyResponse, DescribeNodeResourceConfigFastRequest, SyncPodStateRequest, DescribeSLInstanceListResponse, ModifyDynamicInstanceResponse, DescribeServiceConfGroupInfosRequest, InquiryPriceUpdateInstanceRequest, DescribeDynamicInstanceDetailRequest, AttachDisksResponse, DescribeSparkQueriesRequest, DescribeInstancesResponse, DescribeUsersForUserManagerResponse, DescribeResourceScheduleDiffDetailRequest, InquirePriceRenewEmrResponse, DescribeSLInstanceRequest, ModifyAutoRenewFlagRequest, AddNodeResourceConfigResponse, ModifyResourceScheduleConfigRequest, DeleteAutoScaleStrategyResponse, DescribeStarRocksQueryInfoResponse, ModifyResourceSchedulerResponse, DescribeAutoScaleRecordsRequest, DescribeHBaseTableRequestMetricResponse, DescribeJobFlowResponse, DescribeEmrOverviewMetricsRequest, ModifyResourceResponse, ModifyUserGroupResponse, DescribeHDFSStorageInfoResponse, ModifyPodNumResponse, ModifyGlobalConfigResponse, CreateGroupsSTDResponse, ModifySLInstanceBasicRequest, CreateCloudInstanceResponse, ModifyAutoScaleStrategyRequest, DescribeGroupsSTDRequest, DescribeKyuubiQueryInfoResponse, DescribeBootScriptRequest, DescribeServiceConfGroupInfosResponse, DescribeInstanceOplogRequest, ModifyYarnDeployRequest, DescribeClusterFlowStatusDetailRequest, DescribeDAGInfoResponse, RunJobFlowResponse, DescribeHiveQueriesResponse, CreateDynamicInstanceRequest, DescribeInstanceRenewNodesResponse, CreateClusterRequest, CreateSLInstanceResponse, DescribeClusterNodesResponse, DescribeYarnApplicationsRequest, ModifyBootScriptResponse, DeleteUserManagerUserListRequest, DescribeResourceScheduleResponse, DescribeKyuubiQueryInfoRequest, DescribeNodeResourceConfigFastResponse, DescribeInsightListResponse, DescribeAutoScaleRecordsResponse, DescribeInspectionTaskResultResponse, DescribeCvmQuotaRequest, CreateInstanceRequest, InstallSoftwareResponse, ModifyUsersOfGroupSTDRequest, DeleteAutoScaleStrategyRequest, DescribeInstancesListResponse, ModifyResourcePoolsResponse, DescribeInstanceRenewNodesRequest, DescribeYarnApplicationsResponse, InquiryPriceCreateInstanceRequest, DescribeSLInstanceResponse, ModifySLInstanceResponse, ModifyGlobalConfigRequest, DescribeHBaseTableStoreSizeMetricResponse, DescribeImpalaQueriesResponse, SetNodeResourceConfigDefaultResponse, DescribeDynamicInstanceListRequest, ModifyInstanceBasicResponse, DescribeTrinoQueryInfoRequest, ModifyResourcePoolsRequest, TerminateInstanceResponse, DescribeSparkApplicationsResponse, ScaleOutInstanceResponse, ModifyUserManagerPwdResponse, TerminateDynamicInstancesRequest, CreateInstanceResponse, DescribeServiceNodeInfosRequest, DescribeHBaseTableStoreSizeMetricRequest, TerminateDynamicInstancesResponse, DescribeInstanceOplogResponse, DescribeAutoScaleGroupGlobalConfRequest, ModifyResourceScheduleConfigResponse, DescribeEMREventListRequest, DescribeDynamicInstanceListResponse, DescribeResourceScheduleDiffDetailResponse, DescribeYarnQueueResponse, CreateGroupsSTDRequest, ConvertPreToPostClusterRequest, DescribeNodeDataDisksRequest, DescribeJobFlowRequest, ModifyBootScriptRequest, ModifyYarnDeployResponse, DescribeMetaDBInfoRequest, DescribeUsersForUserManagerRequest, DescribeNodeSpecRequest, DescribeYarnScheduleHistoryRequest, StartStopServiceOrMonitorResponse, DescribeYarnQueueRequest, ModifyAutoRenewFlagResponse, DescribeYarnScheduleHistoryResponse, DescribeInsightListRequest, ModifyResourcesTagsRequest, TerminateClusterNodesResponse, DescribeSLInstanceListRequest, DeleteGroupsSTDResponse, DescribeImpalaQueriesRequest, ModifyPodNumRequest, ModifyUserGroupRequest, DescribeInstancesRequest, DeployYarnConfRequest, DescribeGroupsSTDResponse, DescribeNodeDataDisksResponse, DescribeInstancesListRequest, ModifyInstanceBasicRequest, AddUsersForUserManagerRequest, TerminateInstanceRequest, TerminateSLInstanceRequest, DescribeNodeSpecResponse, DescribeStarRocksQueryInfoRequest, ResizeDataDisksResponse, ModifySLInstanceBasicResponse, ResizeDataDisksRequest, ScaleOutClusterResponse, CreateSLInstanceRequest, DescribeGlobalConfigRequest, ScaleOutInstanceRequest, DescribeHBaseTableOverviewRequest, DescribeClusterFlowStatusDetailResponse, DescribeSparkApplicationsRequest, SyncPodStateResponse, ModifyDynamicInstanceRequest, ModifyUserManagerPwdRequest, RunJobFlowRequest, DescribeHBaseTableOverviewResponse, AddMetricScaleStrategyRequest, ModifyUsersOfGroupSTDResponse, ResetYarnConfigResponse, InquiryPriceRenewInstanceResponse, StartStopServiceOrMonitorRequest, DescribeResourceScheduleRequest, DeleteNodeResourceConfigResponse, ConvertPreToPostClusterResponse, ModifyResourcesTagsResponse, SetNodeResourceConfigDefaultRequest, DescribeDAGInfoRequest, DescribeAutoScaleGroupGlobalConfResponse, InquiryPriceUpdateInstanceResponse, ModifyYarnQueueV2Response, ModifyInspectionSettingsRequest, ModifyResourceSchedulerRequest, ModifySLInstanceRequest, CreateCloudInstanceRequest, ModifyYarnQueueV2Request, DescribeClusterNodesRequest, DescribeEmrOverviewMetricsResponse, TerminateSLInstanceResponse, DescribeAutoScaleStrategiesRequest, DeployYarnConfResponse, DeleteUserManagerUserListResponse, InquiryPriceRenewInstanceRequest, DeleteGroupsSTDRequest, DescribeAutoScaleStrategiesResponse, CreateDynamicInstanceResponse, ModifyAutoScaleStrategyResponse, InquiryPriceScaleOutInstanceRequest, DescribeEmrApplicationStaticsResponse, InquirePriceRenewEmrRequest, InquiryPriceScaleOutInstanceResponse, TerminateClusterNodesRequest } from "./emr_models";
|
|
4
4
|
/**
|
|
5
5
|
* emr client
|
|
6
6
|
* @class
|
|
@@ -366,6 +366,10 @@ export declare class Client extends AbstractClient {
|
|
|
366
366
|
* 查询EMR任务运行详情状态
|
|
367
367
|
*/
|
|
368
368
|
DescribeClusterFlowStatusDetail(req: DescribeClusterFlowStatusDetailRequest, cb?: (error: string, rep: DescribeClusterFlowStatusDetailResponse) => void): Promise<DescribeClusterFlowStatusDetailResponse>;
|
|
369
|
+
/**
|
|
370
|
+
* 集群metadb数据
|
|
371
|
+
*/
|
|
372
|
+
DescribeMetaDBInfo(req: DescribeMetaDBInfoRequest, cb?: (error: string, rep: DescribeMetaDBInfoResponse) => void): Promise<DescribeMetaDBInfoResponse>;
|
|
369
373
|
/**
|
|
370
374
|
* 查询集群实例信息
|
|
371
375
|
*/
|
|
@@ -562,6 +562,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
562
562
|
async DescribeClusterFlowStatusDetail(req, cb) {
|
|
563
563
|
return this.request("DescribeClusterFlowStatusDetail", req, cb);
|
|
564
564
|
}
|
|
565
|
+
/**
|
|
566
|
+
* 集群metadb数据
|
|
567
|
+
*/
|
|
568
|
+
async DescribeMetaDBInfo(req, cb) {
|
|
569
|
+
return this.request("DescribeMetaDBInfo", req, cb);
|
|
570
|
+
}
|
|
565
571
|
/**
|
|
566
572
|
* 查询集群实例信息
|
|
567
573
|
*/
|
|
@@ -989,6 +989,19 @@ export interface JobFlowResourceSpec {
|
|
|
989
989
|
*/
|
|
990
990
|
CommonResourceSpec?: JobFlowResource;
|
|
991
991
|
}
|
|
992
|
+
/**
|
|
993
|
+
* DescribeMetaDBInfo返回参数结构体
|
|
994
|
+
*/
|
|
995
|
+
export interface DescribeMetaDBInfoResponse {
|
|
996
|
+
/**
|
|
997
|
+
* <p>自定义db数据</p>
|
|
998
|
+
*/
|
|
999
|
+
MetaDBGroupInfo?: Array<CustomMetaDBInfo>;
|
|
1000
|
+
/**
|
|
1001
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1002
|
+
*/
|
|
1003
|
+
RequestId?: string;
|
|
1004
|
+
}
|
|
992
1005
|
/**
|
|
993
1006
|
* WebUI访问信息
|
|
994
1007
|
*/
|
|
@@ -4433,6 +4446,10 @@ export interface CreateClusterRequest {
|
|
|
4433
4446
|
* <p>系统盘是否加密</p>
|
|
4434
4447
|
*/
|
|
4435
4448
|
EnableCbsSysEncryptFlag?: boolean;
|
|
4449
|
+
/**
|
|
4450
|
+
* <p>自定义metadb数据</p>
|
|
4451
|
+
*/
|
|
4452
|
+
MetaDBGroupInfo?: Array<CustomMetaDBInfo>;
|
|
4436
4453
|
}
|
|
4437
4454
|
/**
|
|
4438
4455
|
* CreateSLInstance返回参数结构体
|
|
@@ -7311,6 +7328,15 @@ export interface ModifyYarnDeployResponse {
|
|
|
7311
7328
|
*/
|
|
7312
7329
|
RequestId?: string;
|
|
7313
7330
|
}
|
|
7331
|
+
/**
|
|
7332
|
+
* DescribeMetaDBInfo请求参数结构体
|
|
7333
|
+
*/
|
|
7334
|
+
export interface DescribeMetaDBInfoRequest {
|
|
7335
|
+
/**
|
|
7336
|
+
* <p>集群id</p>
|
|
7337
|
+
*/
|
|
7338
|
+
InstanceId: string;
|
|
7339
|
+
}
|
|
7314
7340
|
/**
|
|
7315
7341
|
* 用户管理中用户的简要信息
|
|
7316
7342
|
*/
|
|
@@ -11223,21 +11249,25 @@ export interface PriceResource {
|
|
|
11223
11249
|
*/
|
|
11224
11250
|
export interface ModifySLInstanceRequest {
|
|
11225
11251
|
/**
|
|
11226
|
-
*
|
|
11252
|
+
* <p>实例唯一标识符(字符串表示)。</p>
|
|
11227
11253
|
*/
|
|
11228
11254
|
InstanceId: string;
|
|
11229
11255
|
/**
|
|
11230
|
-
*
|
|
11256
|
+
* <p>需要变更的区域名称。</p>
|
|
11231
11257
|
*/
|
|
11232
11258
|
Zone: string;
|
|
11233
11259
|
/**
|
|
11234
|
-
*
|
|
11260
|
+
* <p>该区域变配后的目标节点数量,所有区域节点总数应大于等于3,小于等于50。</p>
|
|
11235
11261
|
*/
|
|
11236
|
-
NodeNum
|
|
11262
|
+
NodeNum?: number;
|
|
11237
11263
|
/**
|
|
11238
|
-
*
|
|
11264
|
+
* <p>唯一随机标识,时效性为5分钟,需要调用者指定 防止客户端重复创建资源,例如 a9a90aa6-<strong><strong>-</strong></strong>-****-fae360632808</p>
|
|
11239
11265
|
*/
|
|
11240
11266
|
ClientToken?: string;
|
|
11267
|
+
/**
|
|
11268
|
+
* <p>存储空间大小,需要是100的倍数,且不允许比当前存储空间小(只允许扩容)</p><p>单位:GB</p>
|
|
11269
|
+
*/
|
|
11270
|
+
DiskSize?: number;
|
|
11241
11271
|
}
|
|
11242
11272
|
/**
|
|
11243
11273
|
* 容器额外配置
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { CreateOrganizationGroupInvitationLinkRequest, DescribeCancelFlowsTaskResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeContractReviewWebUrlRequest, DescribeInformationExtractionTaskRequest, CreateDynamicFlowApproverRequest, DisableUserAutoSignRequest, UploadFilesRequest, CreateFileConvertTaskRequest, OperateSealsResponse, CancelUserAutoSignEnableUrlResponse, CreateContractDiffTaskWebUrlResponse, VerifyDigitFileRequest, CreateFlowEvidenceReportRequest, CreateBatchSignUrlResponse, DescribeUserAutoSignStatusResponse, DescribeContractReviewChecklistWebUrlResponse, CreateFlowForwardsResponse, DescribeFlowEvidenceReportRequest, ModifyPartnerAuthorizationResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, ModifySingleSignOnEmployeesResponse, CreateWebThemeConfigResponse, DescribeFlowInfoRequest, ArchiveDynamicFlowResponse, CreateLegalSealQrCodeRequest, DescribeSingleSignOnEmployeesRequest, CreateUserNameChangeUrlRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateBatchInformationExtractionTaskRequest, CreateFlowByFilesRequest, DescribeContractReviewChecklistRequest, OperateSealsRequest, DescribeFileUrlsResponse, CreateBatchAdminChangeInvitationsUrlResponse, CreateSingleSignOnEmployeesRequest, ModifyIntegrationRoleRequest, DescribeUserVerifyStatusRequest, CancelOrganizationFlowsRequest, VerifyPdfRequest, CreateEmployeeChangeUrlRequest, DescribeSingleSignOnEmployeesResponse, CreateUserAutoSignEnableUrlRequest, CreateBatchOrganizationRegistrationTasksRequest, CreateContractComparisonTaskRequest, DescribeBatchOrganizationRegistrationTasksResponse, CreatePrepareFlowResponse, DescribeOrganizationVerifyStatusRequest, CancelMultiFlowSignQRCodeRequest, CreateSealResponse, CreateFlowGroupRemindsRequest, VerifyDigitalDataSignRequest, DescribeIntegrationRolesResponse, ModifyExtendedServiceResponse, DescribeBillUsageDetailResponse, DescribeFlowBriefsResponse, DescribeRiskIdentificationTaskFeedbackRequest, CreateBatchAdminChangeInvitationsRequest, DescribeFlowTemplatesResponse, DescribePersonCertificateRequest, CreateBatchOrganizationAuthorizationUrlResponse, ModifyPartnerAutoSignAuthUrlResponse, CreateIntegrationSubOrganizationActiveRecordRequest, CreateFileConvertTaskResponse, CreateOrganizationInfoChangeUrlRequest, DescribePersonCertificateResponse, CreateBatchAdminChangeInvitationsResponse, DescribeFileCounterSignResultRequest, CreateContractDiffTaskWebUrlRequest, DescribeContractReviewTaskRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, ModifyExtendedServiceRequest, CreateDraftContractByPromptsTaskRequest, CreateLMInformationExtractionTaskFieldFeedbackRequest, CreateContractReviewWebUrlResponse, DisableUserAutoSignResponse, DescribeContractReviewChecklistsWebUrlRequest, CreateContractComparisonTaskResponse, DescribeFileUrlsRequest, CreateMiniAppPrepareFlowResponse, ImportContractReviewChecklistResponse, CreateConvertTaskApiRequest, OperateTemplateRequest, CreateBatchQuickSignUrlResponse, CreateArchiveFlowTaskRequest, DeleteSingleSignOnEmployeesResponse, CreateUserMobileChangeUrlResponse, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateRiskIdentificationTaskFeedbackResponse, ExportContractReviewResultResponse, CreateBatchContractReviewTaskRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, CreateBatchInitOrganizationUrlRequest, DeleteOrganizationAuthorizationsResponse, CreateFlowForwardsRequest, CreateIntegrationDepartmentResponse, DeleteSealPoliciesResponse, DescribeOrganizationAuthStatusResponse, DescribeBatchOrganizationRegistrationTasksRequest, CreateSealPolicyResponse, CreateSchemeUrlResponse, CreateFlowSignUrlResponse, RenewAutoSignLicenseResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, VerifyDigitFileResponse, CreateContractReviewChecklistWebUrlResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreatePartnerAuthorizationLinkRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeContractReviewChecklistsWebUrlResponse, DescribeBillUsageResponse, ModifyIntegrationDepartmentRequest, CreateOrganizationBatchSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, CreatePartnerAuthorizationLinkResponse, CreateExtendedServiceAuthInfosResponse, DescribeDraftContractByPromptsTaskResponse, CreateOrganizationBatchSignUrlRequest, CreateDraftContractByPromptsTaskResponse, DeleteIntegrationDepartmentRequest, ExportContractReviewResultRequest, DescribeFileCounterSignResultResponse, CreateFlowGroupRemindsResponse, CreateBatchSignUrlRequest, CreateBatchInformationExtractionTaskResponse, DescribeContractComparisonTaskRequest, DescribeFlowBriefsRequest, CreateInformationExtractionWebUrlResponse, CreateFlowGroupSignReviewRequest, ExportContractComparisonTaskResponse, DescribeContractReviewChecklistResponse, DescribeContractReviewMarkedRiskExportTaskRequest, DescribeContractComparisonTaskResponse, DescribeArchiveFlowTaskRequest, CreateModifyAdminAuthorizationUrlResponse, CreateOrganizationInfoChangeUrlResponse, CreateFlowResponse, CreateUserNameChangeUrlResponse, ModifySingleSignOnEmployeesRequest, DeleteSingleSignOnEmployeesRequest, CancelMultiFlowSignQRCodeResponse, DescribeUserFlowTypeResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, DescribeIntegrationDepartmentsResponse, CreateFileCounterSignRequest, DescribeOrganizationVerifyStatusResponse, DeleteExtendedServiceAuthInfosResponse, DescribeEnterpriseContractReviewChecklistsResponse, ModifyApplicationCallbackInfoResponse, CreateUserVerifyUrlRequest, DescribeLMInformationExtractionTaskFieldFeedbackRequest, CreateIntegrationEmployeesRequest, DescribeContractDiffTaskWebUrlResponse, CreateOrganizationAuthUrlRequest, CreateIntegrationRoleRequest, CancelOrganizationFlowsResponse, DescribeIntegrationRolesRequest, CreateFlowGroupSignReviewResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFileConvertTaskRequest, DescribeBatchOrganizationRegistrationUrlsRequest, DescribeEnterpriseContractReviewChecklistsRequest, CreateDocumentResponse, CreateIntegrationUserRolesResponse, CreateEmbedWebUrlResponse, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, DescribeExtendedServiceAuthDetailRequest, CreateOrganizationAuthFileRequest, ModifyPartnerAuthorizationRequest, CreateIntegrationSubOrganizationActiveRecordResponse, CreatePersonAuthCertificateImageResponse, DescribeLMInformationExtractionTaskFieldFeedbackResponse, CreateLMInformationExtractionTaskFieldFeedbackResponse, DescribeIntegrationEmployeesResponse, ModifyFlowDeadlineResponse, CreateBatchCancelFlowUrlResponse, CreateUserAutoSignEnableUrlResponse, CreatePartnerAutoSignAuthUrlResponse, ArchiveDynamicFlowRequest, ModifyIntegrationRoleResponse, CreateSingleSignOnEmployeesResponse, CreateFlowEvidenceReportResponse, OperateTemplateResponse, CreateOrganizationGroupInvitationLinkResponse, DeleteIntegrationRoleUsersResponse, CreateFlowGroupByFilesRequest, CreatePreparedPersonalEsignResponse, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateArchiveFlowTaskResponse, CreateFlowSignReviewResponse, RenewAutoSignLicenseRequest, CreateWebThemeConfigRequest, CreateEmployeeQualificationSealQrCodeResponse, CreateUserVerifyUrlResponse, GetTaskResultApiResponse, CreatePrepareFlowGroupRequest, CreateFileCounterSignResponse, CreatePrepareFlowRequest, DescribeCancelFlowsTaskRequest, DescribeContractReviewMarkedRiskExportTaskResponse, CreateSealPolicyRequest, DescribeContractReviewTaskResponse, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, UpdateIntegrationEmployeesRequest, CreateFlowGroupByTemplatesRequest, CreateBatchContractReviewTaskResponse, DescribeSignFaceVideoRequest, DescribeOrganizationSealsRequest, CreateBatchOrganizationAuthorizationUrlRequest, CreateDigitalDataSignRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DeleteExtendedServiceAuthInfosRequest, DescribeFlowInfoResponse, DescribeUserAutoSignStatusRequest, CreateFlowBlockchainEvidenceUrlRequest, CreateBatchQuickSignUrlRequest, DescribeExtendedServiceAuthInfosResponse, UpdateIntegrationEmployeesResponse, ModifyPartnerAutoSignAuthUrlRequest, DescribeInformationExtractionWebUrlResponse, CreateExtendedServiceAuthInfosRequest, CreatePrepareFlowGroupResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateBatchInitOrganizationUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateDigitalDataSignResponse, CreateOrganizationAuthFileResponse, StartFlowResponse, DescribeRiskIdentificationTaskFeedbackResponse, DescribeInformationExtractionWebUrlRequest, DescribeFlowComponentsResponse, DescribeContractReviewWebUrlResponse, OperateFlowRemarksResponse, DescribeIntegrationEmployeesRequest, DescribeContractReviewTaskListWebUrlResponse, CreateFlowRequest, CreateContractReviewWebUrlRequest, CreateDynamicFlowApproverResponse, CreateBatchOrganizationRegistrationTasksResponse, DescribeOrganizationSealsResponse, DescribeBillUsageDetailRequest, CreateBatchAdminChangeInvitationsUrlRequest, CreateUserAutoSignSealUrlResponse, CreateEmployeeQualificationSealQrCodeRequest, OperateFlowRemarksRequest, DescribeInformationExtractionTaskResponse, CreateEmployeeChangeUrlResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateOrganizationAuthUrlResponse, DescribeOrganizationAuthStatusRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ExportContractComparisonTaskRequest, CreatePreparedPersonalEsignRequest, ImportContractReviewChecklistRequest, CreateMiniAppPrepareFlowRequest, CreateIntegrationDepartmentRequest, CreateFlowBlockchainEvidenceUrlResponse, CreateDocumentRequest, CreateContractReviewChecklistWebUrlRequest, CreateUserMobileChangeUrlRequest, CreateEmbedWebUrlRequest, ExportContractReviewMarkedRiskResponse, CreateFlowGroupByFilesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, DescribeFileConvertTaskResponse, VerifyDigitalDataSignResponse, CreateModifyAdminAuthorizationUrlRequest, DeleteOrganizationAuthorizationsRequest, CancelUserAutoSignEnableUrlRequest, DescribeUserVerifyStatusResponse, ExportContractReviewMarkedRiskRequest, DescribeArchiveFlowTaskResponse, DescribeBillUsageRequest, ModifyApplicationCallbackInfoRequest, DescribeContractDiffTaskWebUrlRequest, StartFlowRequest, DeleteIntegrationEmployeesResponse, DescribeContractReviewChecklistWebUrlRequest, CreateFlowRemindsRequest, DescribeDraftContractByPromptsTaskRequest, DescribeSignFaceVideoResponse, VerifyPdfResponse, DescribeBatchOrganizationRegistrationUrlsResponse, CreateInformationExtractionWebUrlRequest, CreateRiskIdentificationTaskFeedbackRequest, DescribeUserFlowTypeRequest, DescribeContractReviewTaskListWebUrlRequest, DescribeOrganizationGroupOrganizationsResponse } from "./ess_models";
|
|
3
|
+
import { CreateOrganizationGroupInvitationLinkRequest, DescribeCancelFlowsTaskResponse, CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeContractReviewWebUrlRequest, DescribeInformationExtractionTaskRequest, CreateDynamicFlowApproverRequest, DisableUserAutoSignRequest, UploadFilesRequest, CreateFileConvertTaskRequest, OperateSealsResponse, CancelUserAutoSignEnableUrlResponse, CreateContractDiffTaskWebUrlResponse, VerifyDigitFileRequest, CreateFlowEvidenceReportRequest, CreateBatchSignUrlResponse, DescribeUserAutoSignStatusResponse, DescribeContractReviewChecklistWebUrlResponse, CreateFlowForwardsResponse, DescribeFlowEvidenceReportRequest, ModifyPartnerAuthorizationResponse, DeleteSealPoliciesRequest, CreateFlowGroupByTemplatesResponse, ModifySingleSignOnEmployeesResponse, CreateWebThemeConfigResponse, DescribeFlowInfoRequest, ArchiveDynamicFlowResponse, CreateLegalSealQrCodeRequest, DescribeSingleSignOnEmployeesRequest, CreateUserNameChangeUrlRequest, CreateRequestWithEncryptionRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateBatchInformationExtractionTaskRequest, CreateFlowByFilesRequest, DescribeContractReviewChecklistRequest, OperateSealsRequest, DescribeFileUrlsResponse, CreateBatchAdminChangeInvitationsUrlResponse, CreateSingleSignOnEmployeesRequest, ModifyIntegrationRoleRequest, DescribeUserVerifyStatusRequest, CancelOrganizationFlowsRequest, VerifyPdfRequest, CreateEmployeeChangeUrlRequest, DescribeSingleSignOnEmployeesResponse, CreateUserAutoSignEnableUrlRequest, CreateBatchOrganizationRegistrationTasksRequest, CreateContractComparisonTaskRequest, DescribeBatchOrganizationRegistrationTasksResponse, CreatePrepareFlowResponse, DescribeOrganizationVerifyStatusRequest, CancelMultiFlowSignQRCodeRequest, CreateSealResponse, CreateFlowGroupRemindsRequest, VerifyDigitalDataSignRequest, DescribeIntegrationRolesResponse, ModifyExtendedServiceResponse, DescribeBillUsageDetailResponse, DescribeFlowBriefsResponse, DescribeRiskIdentificationTaskFeedbackRequest, CreateBatchAdminChangeInvitationsRequest, DescribeFlowTemplatesResponse, DescribePersonCertificateRequest, CreateBatchOrganizationAuthorizationUrlResponse, ModifyPartnerAutoSignAuthUrlResponse, CreateIntegrationSubOrganizationActiveRecordRequest, CreateFileConvertTaskResponse, CreateOrganizationInfoChangeUrlRequest, DescribePersonCertificateResponse, CreateBatchAdminChangeInvitationsResponse, DescribeFileCounterSignResultRequest, CreateContractDiffTaskWebUrlRequest, DescribeContractReviewTaskRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, ModifyExtendedServiceRequest, CreateDraftContractByPromptsTaskRequest, CreateLMInformationExtractionTaskFieldFeedbackRequest, CreateContractReviewWebUrlResponse, DisableUserAutoSignResponse, DescribeContractReviewChecklistsWebUrlRequest, CreateContractComparisonTaskResponse, DescribeFileUrlsRequest, CreateMiniAppPrepareFlowResponse, ImportContractReviewChecklistResponse, CreateConvertTaskApiRequest, OperateTemplateRequest, CreateBatchQuickSignUrlResponse, CreateArchiveFlowTaskRequest, DeleteSingleSignOnEmployeesResponse, CreateUserMobileChangeUrlResponse, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateRiskIdentificationTaskFeedbackResponse, ExportContractReviewResultResponse, CreateBatchContractReviewTaskRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, CreateBatchInitOrganizationUrlRequest, DeleteOrganizationAuthorizationsResponse, CreateFlowForwardsRequest, CreateIntegrationDepartmentResponse, DeleteSealPoliciesResponse, DescribeOrganizationAuthStatusResponse, DescribeBatchOrganizationRegistrationTasksRequest, CreateSealPolicyResponse, CreateSchemeUrlResponse, CreateFlowSignUrlResponse, RenewAutoSignLicenseResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, VerifyDigitFileResponse, CreateContractReviewChecklistWebUrlResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreatePartnerAuthorizationLinkRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, DescribeContractReviewChecklistsWebUrlResponse, DescribeBillUsageResponse, ModifyIntegrationDepartmentRequest, CreateOrganizationBatchSignUrlResponse, CreatePartnerAutoSignAuthUrlRequest, CreatePartnerAuthorizationLinkResponse, CreateExtendedServiceAuthInfosResponse, DescribeDraftContractByPromptsTaskResponse, CreateOrganizationBatchSignUrlRequest, CreateDraftContractByPromptsTaskResponse, DeleteIntegrationDepartmentRequest, ExportContractReviewResultRequest, DescribeFileCounterSignResultResponse, CreateFlowGroupRemindsResponse, CreateBatchSignUrlRequest, CreateBatchInformationExtractionTaskResponse, DescribeContractComparisonTaskRequest, DescribeFlowBriefsRequest, CreateInformationExtractionWebUrlResponse, CreateFlowGroupSignReviewRequest, ExportContractComparisonTaskResponse, DescribeContractReviewChecklistResponse, DescribeContractReviewMarkedRiskExportTaskRequest, DescribeContractComparisonTaskResponse, DescribeArchiveFlowTaskRequest, CreateModifyAdminAuthorizationUrlResponse, CreateOrganizationInfoChangeUrlResponse, CreateFlowResponse, CreateUserNameChangeUrlResponse, ModifySingleSignOnEmployeesRequest, DeleteSingleSignOnEmployeesRequest, CancelMultiFlowSignQRCodeResponse, DescribeUserFlowTypeResponse, DescribeExtendedServiceAuthDetailResponse, CreateLegalSealQrCodeResponse, DescribeIntegrationDepartmentsResponse, CreateFileCounterSignRequest, DescribeOrganizationVerifyStatusResponse, DeleteExtendedServiceAuthInfosResponse, DescribeEnterpriseContractReviewChecklistsResponse, ModifyApplicationCallbackInfoResponse, CreateUserVerifyUrlRequest, DescribeLMInformationExtractionTaskFieldFeedbackRequest, CreateIntegrationEmployeesRequest, DescribeContractDiffTaskWebUrlResponse, CreateOrganizationAuthUrlRequest, CreateIntegrationRoleRequest, CancelOrganizationFlowsResponse, DescribeIntegrationRolesRequest, CreateFlowGroupSignReviewResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFileConvertTaskRequest, DescribeBatchOrganizationRegistrationUrlsRequest, DescribeEnterpriseContractReviewChecklistsRequest, CreateDocumentResponse, CreateIntegrationUserRolesResponse, CreateEmbedWebUrlResponse, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, DescribeExtendedServiceAuthDetailRequest, CreateOrganizationAuthFileRequest, ModifyPartnerAuthorizationRequest, CreateIntegrationSubOrganizationActiveRecordResponse, CreatePersonAuthCertificateImageResponse, DescribeLMInformationExtractionTaskFieldFeedbackResponse, CreateLMInformationExtractionTaskFieldFeedbackResponse, DescribeIntegrationEmployeesResponse, ModifyFlowDeadlineResponse, CreateBatchCancelFlowUrlResponse, CreateUserAutoSignEnableUrlResponse, CreatePartnerAutoSignAuthUrlResponse, ArchiveDynamicFlowRequest, ModifyIntegrationRoleResponse, CreateSingleSignOnEmployeesResponse, CreateFlowEvidenceReportResponse, OperateTemplateResponse, CreateOrganizationGroupInvitationLinkResponse, DeleteIntegrationRoleUsersResponse, CreateFlowGroupByFilesRequest, CreatePreparedPersonalEsignResponse, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreateArchiveFlowTaskResponse, CreateFlowSignReviewResponse, RenewAutoSignLicenseRequest, CreateWebThemeConfigRequest, CreateEmployeeQualificationSealQrCodeResponse, CreateUserVerifyUrlResponse, GetTaskResultApiResponse, CreatePrepareFlowGroupRequest, CreateFileCounterSignResponse, CreatePrepareFlowRequest, DescribeCancelFlowsTaskRequest, DescribeContractReviewMarkedRiskExportTaskResponse, CreateSealPolicyRequest, DescribeContractReviewTaskResponse, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, UpdateIntegrationEmployeesRequest, CreateFlowGroupByTemplatesRequest, CreateBatchContractReviewTaskResponse, DescribeSignFaceVideoRequest, DescribeOrganizationSealsRequest, CreateBatchOrganizationAuthorizationUrlRequest, CreateDigitalDataSignRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DeleteExtendedServiceAuthInfosRequest, DescribeFlowInfoResponse, DescribeUserAutoSignStatusRequest, CreateFlowBlockchainEvidenceUrlRequest, CreateBatchQuickSignUrlRequest, DescribeExtendedServiceAuthInfosResponse, UpdateIntegrationEmployeesResponse, ModifyPartnerAutoSignAuthUrlRequest, DescribeInformationExtractionWebUrlResponse, CreateExtendedServiceAuthInfosRequest, CreatePrepareFlowGroupResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateBatchInitOrganizationUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateDigitalDataSignResponse, CreateOrganizationAuthFileResponse, StartFlowResponse, DescribeRiskIdentificationTaskFeedbackResponse, DescribeInformationExtractionWebUrlRequest, DescribeFlowComponentsResponse, DescribeContractReviewWebUrlResponse, OperateFlowRemarksResponse, CreateRequestWithEncryptionResponse, DescribeIntegrationEmployeesRequest, DescribeContractReviewTaskListWebUrlResponse, CreateFlowRequest, CreateContractReviewWebUrlRequest, CreateDynamicFlowApproverResponse, CreateBatchOrganizationRegistrationTasksResponse, DescribeOrganizationSealsResponse, DescribeBillUsageDetailRequest, CreateBatchAdminChangeInvitationsUrlRequest, CreateUserAutoSignSealUrlResponse, CreateEmployeeQualificationSealQrCodeRequest, OperateFlowRemarksRequest, DescribeInformationExtractionTaskResponse, CreateEmployeeChangeUrlResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateOrganizationAuthUrlResponse, DescribeOrganizationAuthStatusRequest, CreateUserAutoSignSealUrlRequest, ModifyFlowDeadlineRequest, CreateFlowApproversRequest, ExportContractComparisonTaskRequest, CreatePreparedPersonalEsignRequest, ImportContractReviewChecklistRequest, CreateMiniAppPrepareFlowRequest, CreateIntegrationDepartmentRequest, CreateFlowBlockchainEvidenceUrlResponse, CreateDocumentRequest, CreateContractReviewChecklistWebUrlRequest, CreateUserMobileChangeUrlRequest, CreateEmbedWebUrlRequest, ExportContractReviewMarkedRiskResponse, CreateFlowGroupByFilesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, DescribeFileConvertTaskResponse, VerifyDigitalDataSignResponse, CreateModifyAdminAuthorizationUrlRequest, DeleteOrganizationAuthorizationsRequest, CancelUserAutoSignEnableUrlRequest, DescribeUserVerifyStatusResponse, ExportContractReviewMarkedRiskRequest, DescribeArchiveFlowTaskResponse, DescribeBillUsageRequest, ModifyApplicationCallbackInfoRequest, DescribeContractDiffTaskWebUrlRequest, StartFlowRequest, DeleteIntegrationEmployeesResponse, DescribeContractReviewChecklistWebUrlRequest, CreateFlowRemindsRequest, DescribeDraftContractByPromptsTaskRequest, DescribeSignFaceVideoResponse, VerifyPdfResponse, DescribeBatchOrganizationRegistrationUrlsResponse, CreateInformationExtractionWebUrlRequest, CreateRiskIdentificationTaskFeedbackRequest, DescribeUserFlowTypeRequest, DescribeContractReviewTaskListWebUrlRequest, DescribeOrganizationGroupOrganizationsResponse } from "./ess_models";
|
|
4
4
|
/**
|
|
5
5
|
* ess client
|
|
6
6
|
* @class
|
|
@@ -852,43 +852,26 @@ export declare class Client extends AbstractClient {
|
|
|
852
852
|
* 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
|
|
853
853
|
适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
|
|
854
854
|
|
|
855
|
-
|
|
856
|
-
<thead>
|
|
857
|
-
<tr>
|
|
858
|
-
<th>签署人类别</th>
|
|
859
|
-
<th>需要提前准备的信息</th>
|
|
860
|
-
</tr>
|
|
861
|
-
</thead>
|
|
862
|
-
<tbody>
|
|
863
|
-
<tr>
|
|
864
|
-
<td>自己企业的员工签署(未认证加入或已认证加入)</td>
|
|
865
|
-
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
|
|
866
|
-
</tr>
|
|
867
|
-
<tr>
|
|
868
|
-
<td>自己企业的员工签署(已认证加入)</td>
|
|
869
|
-
<td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
|
|
870
|
-
</tr>
|
|
871
|
-
<tr>
|
|
872
|
-
<td>其他企业的员工签署</td>
|
|
873
|
-
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
|
|
874
|
-
</tr>
|
|
875
|
-
<tr>
|
|
876
|
-
<td>个人(自然人)签署</td>
|
|
877
|
-
<td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
|
|
878
|
-
</tr>
|
|
879
|
-
</tbody>
|
|
880
|
-
</table>
|
|
881
|
-
|
|
855
|
+
## 传参方式指引
|
|
882
856
|
|
|
857
|
+
| 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
|
|
858
|
+
|------|------|------|------|
|
|
859
|
+
| 本企业员工(未认证加入) | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
|
|
860
|
+
| 本企业员工(已认证加入) | 0 | 签署企业名、员工在电子签平台的 ID(UserId) | OrganizationName + UserId |
|
|
861
|
+
| 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
|
|
862
|
+
| 个人(自然人) | 1 | 个人真实姓名、个人触达手机号、身份证号(非必传) | ApproverName + ApproverMobile |
|
|
883
863
|
|
|
884
|
-
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>
|
|
885
864
|
|
|
865
|
+
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源)<br/>
|
|
886
866
|
|
|
887
|
-
|
|
867
|
+
## 整体流程图
|
|
868
|
+

|
|
888
869
|
|
|
889
870
|
注:
|
|
890
|
-
-
|
|
891
|
-
-
|
|
871
|
+
- 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
|
|
872
|
+
- 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
|
|
873
|
+
- 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
|
|
874
|
+

|
|
892
875
|
|
|
893
876
|
|
|
894
877
|
<font color="red">相关视频指引</font> <br>
|
|
@@ -925,6 +908,126 @@ export declare class Client extends AbstractClient {
|
|
|
925
908
|
5. <font color="red">操作链接过期时间默认为生成链接后7天。</font>
|
|
926
909
|
*/
|
|
927
910
|
CreateBatchInitOrganizationUrl(req: CreateBatchInitOrganizationUrlRequest, cb?: (error: string, rep: CreateBatchInitOrganizationUrlResponse) => void): Promise<CreateBatchInitOrganizationUrlResponse>;
|
|
911
|
+
/**
|
|
912
|
+
* 该接口支持对请求内容进行加密传输。调用方需使用约定的 AES-CBC 或 SM4-CBC 算法对请求内容进行加密,并使用 HMAC-SHA256 或 HMAC-SM3 算法对 IV 和加密后的数据进行完整性校验,防止请求内容被篡改。
|
|
913
|
+
|
|
914
|
+

|
|
915
|
+
|
|
916
|
+
**请求端加密流程**
|
|
917
|
+
1. 每次请求使用密码学安全的随机源生成 16 字节 的 IV。每次请求必须重新生成,严禁复用。
|
|
918
|
+
2. 使用约定的 AES-CBC 或 SM4-CBC 算法对原始请求体进行加密,使用 PKCS#7 Padding。
|
|
919
|
+
3. 将加密后的密文原始字节进行标准 Base64 编码,作为 EncryptedData 参数。
|
|
920
|
+
4. 将 IV 原始字节进行标准 Base64 编码,作为 IV 参数。
|
|
921
|
+
5. 对 IV 原始字节和密文原始字节直接拼接(不添加分隔符),计算 HMAC-SHA256 或 HMAC-SM4:HMAC(Key, IVBytes || CiphertextBytes)
|
|
922
|
+
6. 将 HMAC 的结果进行 标准 Base64 编码,作为 EncryptionSignature 参数。
|
|
923
|
+
|
|
924
|
+
**响应端解密流程**
|
|
925
|
+
1. 先判断本接口自身是否返回外层错误,此时错误为明文(标准腾讯云错误体),有则直接失败处理。
|
|
926
|
+
2. 分别对 IV、EncryptedData、EncryptionSignature 做标准 Base64 解码,得到原始字节。
|
|
927
|
+
3. 将 IV 与密文原始字节直接拼接(无分隔符),计算 HMAC-SHA256 或 HMAC-SM4:HMAC(Key, IVBytes || CiphertextBytes)。
|
|
928
|
+
4. 与响应中 EncryptionSignature 解码后的字节做恒定时间比较,不一致立即失败,不得继续解密。
|
|
929
|
+
5. 使用约定的 AES-CBC 或 SM4-CBC,以 IV 和密钥解密 EncryptedData,去除 PKCS#7 Padding 得到明文。
|
|
930
|
+
6. 先用腾讯云标准错误体反序列化明文,判断被加密业务接口是否返回 Error。
|
|
931
|
+
7. 无业务错误时,再用目标业务接口的响应结构体反序列化明文,取出实际业务参数。
|
|
932
|
+
|
|
933
|
+
**响应端错误处理**
|
|
934
|
+
1. 外层错误(本接口本身调用失败):返回标准腾讯云错误 JSON(含 Error.Code / Error.Message),无 EncryptedData,不需要解密即可处理。
|
|
935
|
+
2. 内层错误(业务接口执行失败):外层成功,但解密后的明文里包含 Error.Code / Error.Message,按目标业务接口的错误规范处理。
|
|
936
|
+
|
|
937
|
+
**处理过程示例**
|
|
938
|
+
```
|
|
939
|
+
# ========== 前置约定 ==========
|
|
940
|
+
AESKey : 加密 密钥(AES 32 字节,SM4 16 字节)
|
|
941
|
+
HMACKey : HMAC 密钥(与加密密钥需要不同)
|
|
942
|
+
ALGO : AES-CBC 或 SM4-CBC,双方约定
|
|
943
|
+
HMAC : ALGO == AES-CBC ? HMAC-SHA256 : HMAC-SM3
|
|
944
|
+
|
|
945
|
+
# ========== 请求端:加密并调用 ==========
|
|
946
|
+
function CallWithEncryption(bizAction, bizRequestObj):
|
|
947
|
+
# 1. 序列化业务请求
|
|
948
|
+
plaintext = JSON.stringify(bizRequestObj)
|
|
949
|
+
# 2. 生成 16 字节随机 IV(每次新生成,禁止复用)
|
|
950
|
+
iv = SecureRandom(16)
|
|
951
|
+
# 3. 对称加密(PKCS#7 Padding)
|
|
952
|
+
ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
|
|
953
|
+
# 4. 计算完整性签名:HMAC(Key, IV || Ciphertext)
|
|
954
|
+
signature = HMAC(HMACKey, concat(iv, ciphertext))
|
|
955
|
+
# 5. 组装外层请求参数
|
|
956
|
+
encReq = {
|
|
957
|
+
RequestAction: bizAction,
|
|
958
|
+
IV: Base64(iv),
|
|
959
|
+
EncryptedData: Base64(ciphertext),
|
|
960
|
+
EncryptionSignature: Base64(signature),
|
|
961
|
+
}
|
|
962
|
+
# 6. 调用 CreateRequestWithEncryption
|
|
963
|
+
# TC3-HMAC-SHA256 鉴权由官方 SDK 自动完成
|
|
964
|
+
encResp = CloudAPI.CreateRequestWithEncryption(encReq)
|
|
965
|
+
# 7. 外层错误:明文,直接抛出
|
|
966
|
+
if encResp.Error != nil:
|
|
967
|
+
raise OuterError(encResp.Error)
|
|
968
|
+
# 8. 解密并返回业务响应
|
|
969
|
+
return DecryptResponse(encResp.Response)
|
|
970
|
+
|
|
971
|
+
# ========== 响应端:校验并解密 ==========
|
|
972
|
+
function DecryptResponse(resp):
|
|
973
|
+
# 1. Base64 解码
|
|
974
|
+
ivBytes = Base64Decode(resp.IV)
|
|
975
|
+
ctBytes = Base64Decode(resp.EncryptedData)
|
|
976
|
+
sigBytes = Base64Decode(resp.EncryptionSignature)
|
|
977
|
+
# 2. 重新计算 HMAC
|
|
978
|
+
expected = HMAC(HMACKey, concat(ivBytes, ctBytes))
|
|
979
|
+
# 3. 恒定时间比较,失败立即终止(不得继续解密)
|
|
980
|
+
if not ConstantTimeEqual(expected, sigBytes):
|
|
981
|
+
raise SignatureMismatch
|
|
982
|
+
# 4. 对称解密,去除 PKCS#7 Padding
|
|
983
|
+
plaintext = SymmetricDecrypt(ALGO, AESKey, ivBytes, ctBytes)
|
|
984
|
+
# 5. 先按腾讯云错误体解析,判断业务是否失败
|
|
985
|
+
bizErr = TryParseTencentCloudError(plaintext)
|
|
986
|
+
if bizErr != nil:
|
|
987
|
+
raise BusinessError(bizErr)
|
|
988
|
+
# 6. 按目标业务接口的响应结构反序列化
|
|
989
|
+
return JSON.parse(plaintext, BizResponseSchema)
|
|
990
|
+
```
|
|
991
|
+
|
|
992
|
+
**AES-CBC 示例**
|
|
993
|
+
|
|
994
|
+
以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
|
|
995
|
+
|
|
996
|
+
加密密钥:AES-CBC-Key-1234
|
|
997
|
+
签名密钥:AES-HMAC-Key-123
|
|
998
|
+
IV:1234567890abcdef
|
|
999
|
+
请求内容:{"Request": "This is a test."}
|
|
1000
|
+
|
|
1001
|
+
最终请求参数:
|
|
1002
|
+
```
|
|
1003
|
+
{
|
|
1004
|
+
"RequestAction": "DescribeFlowComponents",
|
|
1005
|
+
"IV": "MTIzNDU2Nzg5MGFiY2RlZg==",
|
|
1006
|
+
"EncryptedData": "Iqp2W1jislwMNmE7bH9dKZZiMQsfkAPyvAAqDFRnWLw=",
|
|
1007
|
+
"EncryptionSignature": "4TT3PUCZgZT7YmEPtXDm5PDcM6xT7FoYHfMW8xunB5I="
|
|
1008
|
+
}
|
|
1009
|
+
```
|
|
1010
|
+
|
|
1011
|
+
**SM4-CBC 示例**
|
|
1012
|
+
|
|
1013
|
+
以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
|
|
1014
|
+
|
|
1015
|
+
加密密钥:SM4-CBC-Key-1234
|
|
1016
|
+
签名密钥:SM4-HMAC-Key-123
|
|
1017
|
+
IV:fedcba0987654321
|
|
1018
|
+
请求内容:{"Request": "This is a test."}
|
|
1019
|
+
|
|
1020
|
+
最终请求参数:
|
|
1021
|
+
```
|
|
1022
|
+
{
|
|
1023
|
+
"RequestAction": "DescribeFlowComponents",
|
|
1024
|
+
"IV": "ZmVkY2JhMDk4NzY1NDMyMQ==",
|
|
1025
|
+
"EncryptedData": "GwUovQhNUPaUnVM/UDXMtPOYTpTSi2B1oyZDFbyyvns=",
|
|
1026
|
+
"EncryptionSignature": "nHB/v/AvOaDCQ66esFNnp12lHKcGkwaLGid0Warl/KE="
|
|
1027
|
+
}
|
|
1028
|
+
```
|
|
1029
|
+
*/
|
|
1030
|
+
CreateRequestWithEncryption(req: CreateRequestWithEncryptionRequest, cb?: (error: string, rep: CreateRequestWithEncryptionResponse) => void): Promise<CreateRequestWithEncryptionResponse>;
|
|
928
1031
|
/**
|
|
929
1032
|
* 用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接,撤销生成的链接失效。
|
|
930
1033
|
|