tencentcloud-sdk-nodejs 4.0.721 → 4.0.722
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 +123 -0
- package/SERVICE_CHANGELOG.md +141 -115
- package/package.json +1 -1
- package/products.md +9 -9
- package/src/common/sdk_version.ts +1 -1
- package/src/services/cvm/v20170312/cvm_models.ts +7 -7
- package/src/services/essbasic/v20210526/essbasic_client.ts +19 -5
- package/src/services/essbasic/v20210526/essbasic_models.ts +126 -94
- package/src/services/sqlserver/v20180328/sqlserver_client.ts +5 -4
- package/src/services/sqlserver/v20180328/sqlserver_models.ts +108 -43
- package/src/services/tdmq/v20200217/tdmq_client.ts +36 -20
- package/src/services/tdmq/v20200217/tdmq_models.ts +226 -73
- package/src/services/thpc/v20230321/thpc_models.ts +4 -0
- package/src/services/vpc/v20170312/vpc_client.ts +0 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +7 -7
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +18 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +18 -4
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +126 -94
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.d.ts +4 -4
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_client.js +3 -3
- package/tencentcloud/services/sqlserver/v20180328/sqlserver_models.d.ts +107 -43
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +11 -7
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +15 -9
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +220 -73
- package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +4 -0
- package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +0 -1
- package/tencentcloud/services/vpc/v20170312/vpc_client.js +0 -1
- package/test/tdmq.v20200217.test.js +22 -12
|
@@ -460,6 +460,16 @@ export interface DeleteClusterResponse {
|
|
|
460
460
|
RequestId?: string
|
|
461
461
|
}
|
|
462
462
|
|
|
463
|
+
/**
|
|
464
|
+
* ResetRocketMQConsumerOffSet返回参数结构体
|
|
465
|
+
*/
|
|
466
|
+
export interface ResetRocketMQConsumerOffSetResponse {
|
|
467
|
+
/**
|
|
468
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
469
|
+
*/
|
|
470
|
+
RequestId?: string
|
|
471
|
+
}
|
|
472
|
+
|
|
463
473
|
/**
|
|
464
474
|
* DescribeTopicMsgs返回参数结构体
|
|
465
475
|
*/
|
|
@@ -583,9 +593,13 @@ export interface DescribeRocketMQMigratingTopicListRequest {
|
|
|
583
593
|
}
|
|
584
594
|
|
|
585
595
|
/**
|
|
586
|
-
*
|
|
596
|
+
* ModifyCluster返回参数结构体
|
|
587
597
|
*/
|
|
588
|
-
export interface
|
|
598
|
+
export interface ModifyClusterResponse {
|
|
599
|
+
/**
|
|
600
|
+
* Pulsar 集群的ID
|
|
601
|
+
*/
|
|
602
|
+
ClusterId: string
|
|
589
603
|
/**
|
|
590
604
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
591
605
|
*/
|
|
@@ -2619,6 +2633,80 @@ export interface DescribeCmqSubscriptionDetailResponse {
|
|
|
2619
2633
|
RequestId?: string
|
|
2620
2634
|
}
|
|
2621
2635
|
|
|
2636
|
+
/**
|
|
2637
|
+
* Pulsar专业版实例信息
|
|
2638
|
+
*/
|
|
2639
|
+
export interface PulsarProInstance {
|
|
2640
|
+
/**
|
|
2641
|
+
* 实例id
|
|
2642
|
+
*/
|
|
2643
|
+
InstanceId: string
|
|
2644
|
+
/**
|
|
2645
|
+
* 实例名称
|
|
2646
|
+
*/
|
|
2647
|
+
InstanceName: string
|
|
2648
|
+
/**
|
|
2649
|
+
* 实例版本
|
|
2650
|
+
*/
|
|
2651
|
+
InstanceVersion: string
|
|
2652
|
+
/**
|
|
2653
|
+
* 实例状态,0-创建中,1-正常,2-隔离中,3-已销毁,4 - 异常, 5 - 发货失败,6-变配中,7-变配失败
|
|
2654
|
+
*/
|
|
2655
|
+
Status: number
|
|
2656
|
+
/**
|
|
2657
|
+
* 实例配置规格名称
|
|
2658
|
+
*/
|
|
2659
|
+
ConfigDisplay: string
|
|
2660
|
+
/**
|
|
2661
|
+
* 峰值TPS
|
|
2662
|
+
*/
|
|
2663
|
+
MaxTps: number
|
|
2664
|
+
/**
|
|
2665
|
+
* 存储容量,GB为单位
|
|
2666
|
+
*/
|
|
2667
|
+
MaxStorage: number
|
|
2668
|
+
/**
|
|
2669
|
+
* 实例到期时间,毫秒为单位
|
|
2670
|
+
*/
|
|
2671
|
+
ExpireTime: number
|
|
2672
|
+
/**
|
|
2673
|
+
* 自动续费标记,0表示默认状态(用户未设置,即初始状态即手动续费), 1表示自动续费,2表示明确不自动续费(用户设置)
|
|
2674
|
+
*/
|
|
2675
|
+
AutoRenewFlag: number
|
|
2676
|
+
/**
|
|
2677
|
+
* 0-后付费,1-预付费
|
|
2678
|
+
*/
|
|
2679
|
+
PayMode: number
|
|
2680
|
+
/**
|
|
2681
|
+
* 备注信息
|
|
2682
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2683
|
+
*/
|
|
2684
|
+
Remark: string
|
|
2685
|
+
/**
|
|
2686
|
+
* 实例配置ID
|
|
2687
|
+
*/
|
|
2688
|
+
SpecName: string
|
|
2689
|
+
/**
|
|
2690
|
+
* 规格外弹性TPS
|
|
2691
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2692
|
+
*/
|
|
2693
|
+
ScalableTps: number
|
|
2694
|
+
/**
|
|
2695
|
+
* VPC的id
|
|
2696
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2697
|
+
*/
|
|
2698
|
+
VpcId: string
|
|
2699
|
+
/**
|
|
2700
|
+
* 子网id
|
|
2701
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2702
|
+
*/
|
|
2703
|
+
SubnetId: string
|
|
2704
|
+
/**
|
|
2705
|
+
* 峰值带宽。单位:mbps
|
|
2706
|
+
*/
|
|
2707
|
+
MaxBandWidth: number
|
|
2708
|
+
}
|
|
2709
|
+
|
|
2622
2710
|
/**
|
|
2623
2711
|
* vcp绑定记录
|
|
2624
2712
|
*/
|
|
@@ -4208,17 +4296,19 @@ export interface DescribeRocketMQClustersRequest {
|
|
|
4208
4296
|
}
|
|
4209
4297
|
|
|
4210
4298
|
/**
|
|
4211
|
-
*
|
|
4299
|
+
* 消费信息
|
|
4212
4300
|
*/
|
|
4213
|
-
export interface
|
|
4301
|
+
export interface ConsumerLogs {
|
|
4214
4302
|
/**
|
|
4215
|
-
*
|
|
4303
|
+
* 记录数。
|
|
4304
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4216
4305
|
*/
|
|
4217
|
-
|
|
4306
|
+
TotalCount: number
|
|
4218
4307
|
/**
|
|
4219
|
-
*
|
|
4308
|
+
* 消费日志。
|
|
4309
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4220
4310
|
*/
|
|
4221
|
-
|
|
4311
|
+
ConsumerLogSets: Array<ConsumerLog>
|
|
4222
4312
|
}
|
|
4223
4313
|
|
|
4224
4314
|
/**
|
|
@@ -4884,77 +4974,28 @@ export interface CreateCmqQueueResponse {
|
|
|
4884
4974
|
}
|
|
4885
4975
|
|
|
4886
4976
|
/**
|
|
4887
|
-
*
|
|
4977
|
+
* DescribeMsgTrace返回参数结构体
|
|
4888
4978
|
*/
|
|
4889
|
-
export interface
|
|
4890
|
-
/**
|
|
4891
|
-
* 实例id
|
|
4892
|
-
*/
|
|
4893
|
-
InstanceId: string
|
|
4894
|
-
/**
|
|
4895
|
-
* 实例名称
|
|
4896
|
-
*/
|
|
4897
|
-
InstanceName: string
|
|
4898
|
-
/**
|
|
4899
|
-
* 实例版本
|
|
4900
|
-
*/
|
|
4901
|
-
InstanceVersion: string
|
|
4902
|
-
/**
|
|
4903
|
-
* 实例状态,0-创建中,1-正常,2-隔离中,3-已销毁,4 - 异常, 5 - 发货失败,6-变配中,7-变配失败
|
|
4904
|
-
*/
|
|
4905
|
-
Status: number
|
|
4906
|
-
/**
|
|
4907
|
-
* 实例配置规格名称
|
|
4908
|
-
*/
|
|
4909
|
-
ConfigDisplay: string
|
|
4910
|
-
/**
|
|
4911
|
-
* 峰值TPS
|
|
4912
|
-
*/
|
|
4913
|
-
MaxTps: number
|
|
4914
|
-
/**
|
|
4915
|
-
* 存储容量,GB为单位
|
|
4916
|
-
*/
|
|
4917
|
-
MaxStorage: number
|
|
4979
|
+
export interface DescribeMsgTraceResponse {
|
|
4918
4980
|
/**
|
|
4919
|
-
*
|
|
4920
|
-
*/
|
|
4921
|
-
ExpireTime: number
|
|
4922
|
-
/**
|
|
4923
|
-
* 自动续费标记,0表示默认状态(用户未设置,即初始状态即手动续费), 1表示自动续费,2表示明确不自动续费(用户设置)
|
|
4924
|
-
*/
|
|
4925
|
-
AutoRenewFlag: number
|
|
4926
|
-
/**
|
|
4927
|
-
* 0-后付费,1-预付费
|
|
4928
|
-
*/
|
|
4929
|
-
PayMode: number
|
|
4930
|
-
/**
|
|
4931
|
-
* 备注信息
|
|
4981
|
+
* 生产信息。
|
|
4932
4982
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4933
4983
|
*/
|
|
4934
|
-
|
|
4984
|
+
ProducerLog: ProducerLog
|
|
4935
4985
|
/**
|
|
4936
|
-
*
|
|
4937
|
-
*/
|
|
4938
|
-
SpecName: string
|
|
4939
|
-
/**
|
|
4940
|
-
* 规格外弹性TPS
|
|
4941
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4942
|
-
*/
|
|
4943
|
-
ScalableTps: number
|
|
4944
|
-
/**
|
|
4945
|
-
* VPC的id
|
|
4986
|
+
* 服务方信息。
|
|
4946
4987
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4947
4988
|
*/
|
|
4948
|
-
|
|
4989
|
+
ServerLog: ServerLog
|
|
4949
4990
|
/**
|
|
4950
|
-
*
|
|
4991
|
+
* 消费信息。
|
|
4951
4992
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4952
4993
|
*/
|
|
4953
|
-
|
|
4994
|
+
ConsumerLogs: ConsumerLogs
|
|
4954
4995
|
/**
|
|
4955
|
-
*
|
|
4996
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4956
4997
|
*/
|
|
4957
|
-
|
|
4998
|
+
RequestId?: string
|
|
4958
4999
|
}
|
|
4959
5000
|
|
|
4960
5001
|
/**
|
|
@@ -5900,17 +5941,37 @@ export interface DescribeRocketMQSubscriptionsRequest {
|
|
|
5900
5941
|
}
|
|
5901
5942
|
|
|
5902
5943
|
/**
|
|
5903
|
-
*
|
|
5944
|
+
* 消费日志
|
|
5904
5945
|
*/
|
|
5905
|
-
export interface
|
|
5946
|
+
export interface ConsumerLog {
|
|
5906
5947
|
/**
|
|
5907
|
-
*
|
|
5948
|
+
* 消息ID。
|
|
5908
5949
|
*/
|
|
5909
|
-
|
|
5950
|
+
MsgId: string
|
|
5910
5951
|
/**
|
|
5911
|
-
*
|
|
5952
|
+
* 消费组。
|
|
5912
5953
|
*/
|
|
5913
|
-
|
|
5954
|
+
ConsumerGroup: string
|
|
5955
|
+
/**
|
|
5956
|
+
* 消费组名称。
|
|
5957
|
+
*/
|
|
5958
|
+
ConsumerName: string
|
|
5959
|
+
/**
|
|
5960
|
+
* 消费时间。
|
|
5961
|
+
*/
|
|
5962
|
+
ConsumeTime: string
|
|
5963
|
+
/**
|
|
5964
|
+
* 消费者客户端地址。
|
|
5965
|
+
*/
|
|
5966
|
+
ConsumerAddr: string
|
|
5967
|
+
/**
|
|
5968
|
+
* 消费耗时(毫秒)。
|
|
5969
|
+
*/
|
|
5970
|
+
ConsumeUseTime: number
|
|
5971
|
+
/**
|
|
5972
|
+
* 消费状态。
|
|
5973
|
+
*/
|
|
5974
|
+
Status: string
|
|
5914
5975
|
}
|
|
5915
5976
|
|
|
5916
5977
|
/**
|
|
@@ -6132,6 +6193,20 @@ export interface DeleteCmqSubscribeRequest {
|
|
|
6132
6193
|
SubscriptionName: string
|
|
6133
6194
|
}
|
|
6134
6195
|
|
|
6196
|
+
/**
|
|
6197
|
+
* 服务方信息
|
|
6198
|
+
*/
|
|
6199
|
+
export interface ServerLog {
|
|
6200
|
+
/**
|
|
6201
|
+
* 存储时间。
|
|
6202
|
+
*/
|
|
6203
|
+
SaveTime: string
|
|
6204
|
+
/**
|
|
6205
|
+
* 状态。
|
|
6206
|
+
*/
|
|
6207
|
+
Status: string
|
|
6208
|
+
}
|
|
6209
|
+
|
|
6135
6210
|
/**
|
|
6136
6211
|
* DescribeAMQPClusters返回参数结构体
|
|
6137
6212
|
*/
|
|
@@ -6790,6 +6865,20 @@ export interface QueueQuota {
|
|
|
6790
6865
|
UsedQueue?: number
|
|
6791
6866
|
}
|
|
6792
6867
|
|
|
6868
|
+
/**
|
|
6869
|
+
* 排序器
|
|
6870
|
+
*/
|
|
6871
|
+
export interface Sort {
|
|
6872
|
+
/**
|
|
6873
|
+
* 排序字段
|
|
6874
|
+
*/
|
|
6875
|
+
Name: string
|
|
6876
|
+
/**
|
|
6877
|
+
* 升序ASC,降序DESC
|
|
6878
|
+
*/
|
|
6879
|
+
Order: string
|
|
6880
|
+
}
|
|
6881
|
+
|
|
6793
6882
|
/**
|
|
6794
6883
|
* CreateRole返回参数结构体
|
|
6795
6884
|
*/
|
|
@@ -7479,6 +7568,40 @@ export interface DescribeRocketMQTopicMsgsRequest {
|
|
|
7479
7568
|
QueryDeadLetterMessage?: boolean
|
|
7480
7569
|
}
|
|
7481
7570
|
|
|
7571
|
+
/**
|
|
7572
|
+
* DescribeMsgTrace请求参数结构体
|
|
7573
|
+
*/
|
|
7574
|
+
export interface DescribeMsgTraceRequest {
|
|
7575
|
+
/**
|
|
7576
|
+
* 环境(命名空间)。
|
|
7577
|
+
*/
|
|
7578
|
+
EnvironmentId: string
|
|
7579
|
+
/**
|
|
7580
|
+
* 消息ID。
|
|
7581
|
+
*/
|
|
7582
|
+
MsgId: string
|
|
7583
|
+
/**
|
|
7584
|
+
* 消息生产时间。
|
|
7585
|
+
*/
|
|
7586
|
+
ProduceTime: string
|
|
7587
|
+
/**
|
|
7588
|
+
* 起始下标,不填默认为0。
|
|
7589
|
+
*/
|
|
7590
|
+
Offset?: number
|
|
7591
|
+
/**
|
|
7592
|
+
* 返回数量,不填则默认为10,最大值为20。
|
|
7593
|
+
*/
|
|
7594
|
+
Limit?: number
|
|
7595
|
+
/**
|
|
7596
|
+
* 消费组名称模糊匹配。
|
|
7597
|
+
*/
|
|
7598
|
+
SubscriptionName?: string
|
|
7599
|
+
/**
|
|
7600
|
+
* Pulsar 集群的ID
|
|
7601
|
+
*/
|
|
7602
|
+
ClusterId?: string
|
|
7603
|
+
}
|
|
7604
|
+
|
|
7482
7605
|
/**
|
|
7483
7606
|
* ImportRocketMQConsumerGroups返回参数结构体
|
|
7484
7607
|
*/
|
|
@@ -8200,6 +8323,36 @@ export interface TraceResult {
|
|
|
8200
8323
|
Data: string
|
|
8201
8324
|
}
|
|
8202
8325
|
|
|
8326
|
+
/**
|
|
8327
|
+
* 消息生产信息
|
|
8328
|
+
*/
|
|
8329
|
+
export interface ProducerLog {
|
|
8330
|
+
/**
|
|
8331
|
+
* 消息ID。
|
|
8332
|
+
*/
|
|
8333
|
+
MsgId: string
|
|
8334
|
+
/**
|
|
8335
|
+
* 生产者名称。
|
|
8336
|
+
*/
|
|
8337
|
+
ProducerName: string
|
|
8338
|
+
/**
|
|
8339
|
+
* 消息生产时间。
|
|
8340
|
+
*/
|
|
8341
|
+
ProduceTime: string
|
|
8342
|
+
/**
|
|
8343
|
+
* 生产者客户端。
|
|
8344
|
+
*/
|
|
8345
|
+
ProducerAddr: string
|
|
8346
|
+
/**
|
|
8347
|
+
* 生产耗时(秒)。
|
|
8348
|
+
*/
|
|
8349
|
+
ProduceUseTime: number
|
|
8350
|
+
/**
|
|
8351
|
+
* 状态。
|
|
8352
|
+
*/
|
|
8353
|
+
Status: string
|
|
8354
|
+
}
|
|
8355
|
+
|
|
8203
8356
|
/**
|
|
8204
8357
|
* DeleteRabbitMQVipInstance请求参数结构体
|
|
8205
8358
|
*/
|
|
@@ -856,6 +856,10 @@ export interface ManagerNode {
|
|
|
856
856
|
* 实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/651/78725) 的返回值中的 projectId 字段来获取。不填为默认项目。
|
|
857
857
|
*/
|
|
858
858
|
ProjectId?: number
|
|
859
|
+
/**
|
|
860
|
+
* 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务、自动化助手服务。
|
|
861
|
+
*/
|
|
862
|
+
EnhancedService?: EnhancedService
|
|
859
863
|
}
|
|
860
864
|
|
|
861
865
|
/**
|
|
@@ -3106,7 +3106,6 @@ export class Client extends AbstractClient {
|
|
|
3106
3106
|
* 支持CVM实例,弹性网卡上的EIP解绑
|
|
3107
3107
|
* 不支持NAT上的EIP解绑。NAT上的EIP解绑请参考[DisassociateNatGatewayAddress](https://cloud.tencent.com/document/api/215/36716)
|
|
3108
3108
|
* 只有状态为 BIND 和 BIND_ENI 的 EIP 才能进行解绑定操作。
|
|
3109
|
-
* EIP 如果被封堵,则不能进行解绑定操作。
|
|
3110
3109
|
*/
|
|
3111
3110
|
async DisassociateAddress(
|
|
3112
3111
|
req: DisassociateAddressRequest,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const sdkVersion = "4.0.
|
|
1
|
+
export declare const sdkVersion = "4.0.722";
|
|
@@ -4807,33 +4807,33 @@ export interface ReservedInstancePriceItem {
|
|
|
4807
4807
|
/**
|
|
4808
4808
|
* 付费类型,如:"All Upfront","Partial Upfront","No Upfront"
|
|
4809
4809
|
*/
|
|
4810
|
-
OfferingType
|
|
4810
|
+
OfferingType?: string;
|
|
4811
4811
|
/**
|
|
4812
4812
|
* 预支合计费用,单位:元。
|
|
4813
4813
|
*/
|
|
4814
|
-
FixedPrice
|
|
4814
|
+
FixedPrice?: number;
|
|
4815
4815
|
/**
|
|
4816
4816
|
* 后续合计费用,单位:元/小时
|
|
4817
4817
|
*/
|
|
4818
|
-
UsagePrice
|
|
4818
|
+
UsagePrice?: number;
|
|
4819
4819
|
/**
|
|
4820
4820
|
* 预留实例配置ID
|
|
4821
4821
|
*/
|
|
4822
|
-
ReservedInstancesOfferingId
|
|
4822
|
+
ReservedInstancesOfferingId?: string;
|
|
4823
4823
|
/**
|
|
4824
4824
|
* 预留实例计费可购买的可用区。
|
|
4825
4825
|
*/
|
|
4826
|
-
Zone
|
|
4826
|
+
Zone?: string;
|
|
4827
4827
|
/**
|
|
4828
4828
|
* 预留实例计费【有效期】即预留实例计费购买时长。形如:31536000。
|
|
4829
4829
|
计量单位:秒
|
|
4830
4830
|
*/
|
|
4831
|
-
Duration
|
|
4831
|
+
Duration?: number;
|
|
4832
4832
|
/**
|
|
4833
4833
|
* 预留实例计费的平台描述(即操作系统)。形如:Linux。
|
|
4834
4834
|
返回项: Linux 。
|
|
4835
4835
|
*/
|
|
4836
|
-
ProductDescription
|
|
4836
|
+
ProductDescription?: string;
|
|
4837
4837
|
}
|
|
4838
4838
|
/**
|
|
4839
4839
|
* ConfigureChcAssistVpc返回参数结构体
|
|
@@ -577,8 +577,8 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
577
577
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
578
578
|
|
|
579
579
|
注:
|
|
580
|
-
1.
|
|
581
|
-
2.
|
|
580
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
581
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**,正式环境需要设置为**file.ess.tencent.cn**,代码示例
|
|
582
582
|
```
|
|
583
583
|
HttpProfile httpProfile = new HttpProfile();
|
|
584
584
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
@@ -701,7 +701,17 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
701
701
|
CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
|
|
702
702
|
/**
|
|
703
703
|
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
704
|
-
|
|
704
|
+
|
|
705
|
+
- **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
706
|
+
|
|
707
|
+
- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
708
|
+
|
|
709
|
+

|
|
710
|
+
|
|
711
|
+
**注**:
|
|
712
|
+
- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
713
|
+
- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
714
|
+
- 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
705
715
|
*/
|
|
706
716
|
SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
|
|
707
717
|
/**
|
|
@@ -804,7 +814,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
804
814
|
*/
|
|
805
815
|
ChannelCreateEmbedWebUrl(req: ChannelCreateEmbedWebUrlRequest, cb?: (error: string, rep: ChannelCreateEmbedWebUrlResponse) => void): Promise<ChannelCreateEmbedWebUrlResponse>;
|
|
806
816
|
/**
|
|
807
|
-
*
|
|
817
|
+
* 此接口用于查询合同或者合同组的详情信息,支持查询多个(数量不能超过100)。
|
|
818
|
+
|
|
819
|
+
适用场景:可用于主动查询某个合同或者合同组的详情信息。
|
|
820
|
+
|
|
821
|
+
注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
|
808
822
|
*/
|
|
809
823
|
DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
|
|
810
824
|
/**
|
|
@@ -691,8 +691,8 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
691
691
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
692
692
|
|
|
693
693
|
注:
|
|
694
|
-
1.
|
|
695
|
-
2.
|
|
694
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
695
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**,正式环境需要设置为**file.ess.tencent.cn**,代码示例
|
|
696
696
|
```
|
|
697
697
|
HttpProfile httpProfile = new HttpProfile();
|
|
698
698
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
@@ -825,7 +825,17 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
825
825
|
}
|
|
826
826
|
/**
|
|
827
827
|
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
828
|
-
|
|
828
|
+
|
|
829
|
+
- **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
830
|
+
|
|
831
|
+
- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
832
|
+
|
|
833
|
+

|
|
834
|
+
|
|
835
|
+
**注**:
|
|
836
|
+
- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
837
|
+
- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
838
|
+
- 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
829
839
|
*/
|
|
830
840
|
async SyncProxyOrganizationOperators(req, cb) {
|
|
831
841
|
return this.request("SyncProxyOrganizationOperators", req, cb);
|
|
@@ -940,7 +950,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
940
950
|
return this.request("ChannelCreateEmbedWebUrl", req, cb);
|
|
941
951
|
}
|
|
942
952
|
/**
|
|
943
|
-
*
|
|
953
|
+
* 此接口用于查询合同或者合同组的详情信息,支持查询多个(数量不能超过100)。
|
|
954
|
+
|
|
955
|
+
适用场景:可用于主动查询某个合同或者合同组的详情信息。
|
|
956
|
+
|
|
957
|
+
注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
|
944
958
|
*/
|
|
945
959
|
async DescribeFlowDetailInfo(req, cb) {
|
|
946
960
|
return this.request("DescribeFlowDetailInfo", req, cb);
|