tccli 3.0.1154.1__py2.py3-none-any.whl → 3.0.1156.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/autoscaling/v20180419/api.json +48 -20
- tccli/services/ccc/v20200210/api.json +11 -1
- tccli/services/ccc/v20200210/examples.json +1 -1
- tccli/services/cdb/v20170320/api.json +39 -2
- tccli/services/ckafka/ckafka_client.py +65 -12
- tccli/services/ckafka/v20190819/api.json +134 -0
- tccli/services/ckafka/v20190819/examples.json +8 -0
- tccli/services/cvm/cvm_client.py +110 -4
- tccli/services/cvm/v20170312/api.json +95 -0
- tccli/services/cvm/v20170312/examples.json +16 -0
- tccli/services/cynosdb/cynosdb_client.py +110 -4
- tccli/services/cynosdb/v20190107/api.json +192 -0
- tccli/services/cynosdb/v20190107/examples.json +16 -0
- tccli/services/es/v20180416/api.json +36 -0
- tccli/services/ess/ess_client.py +53 -0
- tccli/services/ess/v20201111/api.json +101 -10
- tccli/services/ess/v20201111/examples.json +8 -0
- tccli/services/essbasic/v20210526/api.json +16 -16
- tccli/services/essbasic/v20210526/examples.json +3 -3
- tccli/services/gaap/v20180529/api.json +17 -17
- tccli/services/gaap/v20180529/examples.json +7 -13
- tccli/services/hunyuan/v20230901/api.json +77 -2
- tccli/services/iss/v20230517/api.json +6 -6
- tccli/services/mna/mna_client.py +322 -4
- tccli/services/mna/v20210119/api.json +435 -0
- tccli/services/mna/v20210119/examples.json +48 -0
- tccli/services/mongodb/v20190725/api.json +6 -6
- tccli/services/monitor/v20180724/api.json +23 -23
- tccli/services/monitor/v20180724/examples.json +12 -12
- tccli/services/oceanus/v20190422/api.json +9 -0
- tccli/services/postgres/postgres_client.py +395 -24
- tccli/services/postgres/v20170312/api.json +549 -0
- tccli/services/postgres/v20170312/examples.json +92 -0
- tccli/services/rce/v20201103/api.json +78 -0
- tccli/services/tcr/v20190924/api.json +71 -45
- tccli/services/tcr/v20190924/examples.json +9 -9
- tccli/services/vpc/v20170312/api.json +10 -10
- tccli/services/waf/v20180125/api.json +421 -72
- tccli/services/waf/v20180125/examples.json +6 -6
- {tccli-3.0.1154.1.dist-info → tccli-3.0.1156.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1154.1.dist-info → tccli-3.0.1156.1.dist-info}/RECORD +45 -45
- {tccli-3.0.1154.1.dist-info → tccli-3.0.1156.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1154.1.dist-info → tccli-3.0.1156.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1154.1.dist-info → tccli-3.0.1156.1.dist-info}/license_files/LICENSE +0 -0
@@ -560,6 +560,13 @@
|
|
560
560
|
"output": "ExportInstanceSlowQueriesResponse",
|
561
561
|
"status": "online"
|
562
562
|
},
|
563
|
+
"ExportResourcePackageDeductDetails": {
|
564
|
+
"document": "资源包使用明细导出",
|
565
|
+
"input": "ExportResourcePackageDeductDetailsRequest",
|
566
|
+
"name": "资源包使用明细导出",
|
567
|
+
"output": "ExportResourcePackageDeductDetailsResponse",
|
568
|
+
"status": "online"
|
569
|
+
},
|
563
570
|
"GrantAccountPrivileges": {
|
564
571
|
"document": "批量授权账号权限",
|
565
572
|
"input": "GrantAccountPrivilegesRequest",
|
@@ -770,6 +777,13 @@
|
|
770
777
|
"output": "ModifyResourcePackageNameResponse",
|
771
778
|
"status": "online"
|
772
779
|
},
|
780
|
+
"ModifyResourcePackagesDeductionPriority": {
|
781
|
+
"document": "修改已绑定资源包抵扣优先级",
|
782
|
+
"input": "ModifyResourcePackagesDeductionPriorityRequest",
|
783
|
+
"name": "修改已绑定资源包抵扣优先级",
|
784
|
+
"output": "ModifyResourcePackagesDeductionPriorityResponse",
|
785
|
+
"status": "online"
|
786
|
+
},
|
773
787
|
"ModifyVipVport": {
|
774
788
|
"document": "修改实例组ip,端口",
|
775
789
|
"input": "ModifyVipVportRequest",
|
@@ -11870,6 +11884,115 @@
|
|
11870
11884
|
],
|
11871
11885
|
"type": "object"
|
11872
11886
|
},
|
11887
|
+
"ExportResourcePackageDeductDetailsRequest": {
|
11888
|
+
"document": "ExportResourcePackageDeductDetails请求参数结构体",
|
11889
|
+
"members": [
|
11890
|
+
{
|
11891
|
+
"disabled": false,
|
11892
|
+
"document": "需要导出的资源包ID",
|
11893
|
+
"example": "package-abcd1234",
|
11894
|
+
"member": "string",
|
11895
|
+
"name": "PackageId",
|
11896
|
+
"required": true,
|
11897
|
+
"type": "string"
|
11898
|
+
},
|
11899
|
+
{
|
11900
|
+
"disabled": false,
|
11901
|
+
"document": "使用资源包容量的cynos集群ID",
|
11902
|
+
"example": "无",
|
11903
|
+
"member": "string",
|
11904
|
+
"name": "ClusterIds",
|
11905
|
+
"required": false,
|
11906
|
+
"type": "list"
|
11907
|
+
},
|
11908
|
+
{
|
11909
|
+
"disabled": false,
|
11910
|
+
"document": "排序字段,目前支持:createTime(资源包被抵扣时间),successDeductSpec(资源包抵扣量)",
|
11911
|
+
"example": "createTime",
|
11912
|
+
"member": "string",
|
11913
|
+
"name": "OrderBy",
|
11914
|
+
"required": false,
|
11915
|
+
"type": "string"
|
11916
|
+
},
|
11917
|
+
{
|
11918
|
+
"disabled": false,
|
11919
|
+
"document": "排序类型,支持ASC、DESC、asc、desc",
|
11920
|
+
"example": "desc",
|
11921
|
+
"member": "string",
|
11922
|
+
"name": "OrderByType",
|
11923
|
+
"required": false,
|
11924
|
+
"type": "string"
|
11925
|
+
},
|
11926
|
+
{
|
11927
|
+
"disabled": false,
|
11928
|
+
"document": "开始时间",
|
11929
|
+
"example": "2022-01-01 01:01:01",
|
11930
|
+
"member": "string",
|
11931
|
+
"name": "StartTime",
|
11932
|
+
"required": false,
|
11933
|
+
"type": "string"
|
11934
|
+
},
|
11935
|
+
{
|
11936
|
+
"disabled": false,
|
11937
|
+
"document": "结束时间",
|
11938
|
+
"example": "2022-01-01 01:01:01",
|
11939
|
+
"member": "string",
|
11940
|
+
"name": "EndTime",
|
11941
|
+
"required": false,
|
11942
|
+
"type": "string"
|
11943
|
+
},
|
11944
|
+
{
|
11945
|
+
"disabled": false,
|
11946
|
+
"document": "单次最大导出数据行数,目前最大支持2000行",
|
11947
|
+
"example": "100",
|
11948
|
+
"member": "string",
|
11949
|
+
"name": "Limit",
|
11950
|
+
"required": false,
|
11951
|
+
"type": "string"
|
11952
|
+
},
|
11953
|
+
{
|
11954
|
+
"disabled": false,
|
11955
|
+
"document": "偏移量页数",
|
11956
|
+
"example": "10",
|
11957
|
+
"member": "string",
|
11958
|
+
"name": "Offset",
|
11959
|
+
"required": false,
|
11960
|
+
"type": "string"
|
11961
|
+
},
|
11962
|
+
{
|
11963
|
+
"disabled": false,
|
11964
|
+
"document": "导出数据格式,目前仅支持csv格式,留作扩展",
|
11965
|
+
"example": "csv",
|
11966
|
+
"member": "string",
|
11967
|
+
"name": "FileType",
|
11968
|
+
"required": false,
|
11969
|
+
"type": "string"
|
11970
|
+
}
|
11971
|
+
],
|
11972
|
+
"type": "object"
|
11973
|
+
},
|
11974
|
+
"ExportResourcePackageDeductDetailsResponse": {
|
11975
|
+
"document": "ExportResourcePackageDeductDetails返回参数结构体",
|
11976
|
+
"members": [
|
11977
|
+
{
|
11978
|
+
"disabled": false,
|
11979
|
+
"document": "文件详情",
|
11980
|
+
"example": "2022-01-01 01:01:01,package-abcd1234,200.00,1298.98,cynosdbmysql-cdba4312\\n",
|
11981
|
+
"member": "string",
|
11982
|
+
"name": "FileContent",
|
11983
|
+
"output_required": false,
|
11984
|
+
"type": "string",
|
11985
|
+
"value_allowed_null": false
|
11986
|
+
},
|
11987
|
+
{
|
11988
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
11989
|
+
"member": "string",
|
11990
|
+
"name": "RequestId",
|
11991
|
+
"type": "string"
|
11992
|
+
}
|
11993
|
+
],
|
11994
|
+
"type": "object"
|
11995
|
+
},
|
11873
11996
|
"GrantAccountPrivilegesRequest": {
|
11874
11997
|
"document": "GrantAccountPrivileges请求参数结构体",
|
11875
11998
|
"members": [
|
@@ -14909,6 +15032,51 @@
|
|
14909
15032
|
],
|
14910
15033
|
"type": "object"
|
14911
15034
|
},
|
15035
|
+
"ModifyResourcePackagesDeductionPriorityRequest": {
|
15036
|
+
"document": "ModifyResourcePackagesDeductionPriority请求参数结构体",
|
15037
|
+
"members": [
|
15038
|
+
{
|
15039
|
+
"disabled": false,
|
15040
|
+
"document": "需要修改优先级的资源包类型,CCU:计算资源包,DISK:存储资源包",
|
15041
|
+
"example": "CCU",
|
15042
|
+
"member": "string",
|
15043
|
+
"name": "PackageType",
|
15044
|
+
"required": true,
|
15045
|
+
"type": "string"
|
15046
|
+
},
|
15047
|
+
{
|
15048
|
+
"disabled": false,
|
15049
|
+
"document": "修改后的抵扣优先级对于哪个cynos资源生效",
|
15050
|
+
"example": "cynosdbmysql-abcd1234",
|
15051
|
+
"member": "string",
|
15052
|
+
"name": "ClusterId",
|
15053
|
+
"required": true,
|
15054
|
+
"type": "string"
|
15055
|
+
},
|
15056
|
+
{
|
15057
|
+
"disabled": false,
|
15058
|
+
"document": "资源包抵扣优先级",
|
15059
|
+
"example": "无",
|
15060
|
+
"member": "PackagePriority",
|
15061
|
+
"name": "DeductionPriorities",
|
15062
|
+
"required": true,
|
15063
|
+
"type": "list"
|
15064
|
+
}
|
15065
|
+
],
|
15066
|
+
"type": "object"
|
15067
|
+
},
|
15068
|
+
"ModifyResourcePackagesDeductionPriorityResponse": {
|
15069
|
+
"document": "ModifyResourcePackagesDeductionPriority返回参数结构体",
|
15070
|
+
"members": [
|
15071
|
+
{
|
15072
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
15073
|
+
"member": "string",
|
15074
|
+
"name": "RequestId",
|
15075
|
+
"type": "string"
|
15076
|
+
}
|
15077
|
+
],
|
15078
|
+
"type": "object"
|
15079
|
+
},
|
14912
15080
|
"ModifyVipVportRequest": {
|
14913
15081
|
"document": "ModifyVipVport请求参数结构体",
|
14914
15082
|
"members": [
|
@@ -15911,6 +16079,30 @@
|
|
15911
16079
|
],
|
15912
16080
|
"usage": "out"
|
15913
16081
|
},
|
16082
|
+
"PackagePriority": {
|
16083
|
+
"document": "资源包抵扣优先级",
|
16084
|
+
"members": [
|
16085
|
+
{
|
16086
|
+
"disabled": false,
|
16087
|
+
"document": "需要自定义抵扣优先级的资源包",
|
16088
|
+
"example": "package-abcd1234",
|
16089
|
+
"member": "string",
|
16090
|
+
"name": "PackageId",
|
16091
|
+
"required": false,
|
16092
|
+
"type": "string"
|
16093
|
+
},
|
16094
|
+
{
|
16095
|
+
"disabled": false,
|
16096
|
+
"document": "自定义的抵扣优先级",
|
16097
|
+
"example": "1",
|
16098
|
+
"member": "int64",
|
16099
|
+
"name": "DeductionPriority",
|
16100
|
+
"required": false,
|
16101
|
+
"type": "int"
|
16102
|
+
}
|
16103
|
+
],
|
16104
|
+
"usage": "in"
|
16105
|
+
},
|
15914
16106
|
"ParamDetail": {
|
15915
16107
|
"document": "实例参数详细描述",
|
15916
16108
|
"members": [
|
@@ -664,6 +664,14 @@
|
|
664
664
|
"title": "导出实例慢日志"
|
665
665
|
}
|
666
666
|
],
|
667
|
+
"ExportResourcePackageDeductDetails": [
|
668
|
+
{
|
669
|
+
"document": "资源包使用明细导出",
|
670
|
+
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ExportResourcePackageDeductDetails\n<公共请求参数>\n\n{\n \"PackageId\": \"package-abcd1234\",\n \"ClusterIds\": [\n \"cynosdbmysql-bcdz3214\"\n ],\n \"OrderBy\": \"createTime\",\n \"OrderByType\": \"desc\",\n \"StartTime\": \"2022-01-01 01:01:01\",\n \"EndTime\": \"2024-01-01 01:01:01\",\n \"Limit\": \"100\",\n \"Offset\": \"0\"\n}",
|
671
|
+
"output": "{\n \"Response\": {\n \"FileContent\": \"2022-01-01 01:01:01,package-abcd1234,200.00,1298.98,cynosdbmysql-cdba4312\\n2022-01-01 01:02:01,package-abcd1234,200.00,1498.98,cynosdbmysql-cdba4354\",\n \"RequestId\": \"abc\"\n }\n}",
|
672
|
+
"title": "ExportResourcePackageDeductDetails"
|
673
|
+
}
|
674
|
+
],
|
667
675
|
"GrantAccountPrivileges": [
|
668
676
|
{
|
669
677
|
"document": "批量授权账号权限",
|
@@ -904,6 +912,14 @@
|
|
904
912
|
"title": "修改资源包名称"
|
905
913
|
}
|
906
914
|
],
|
915
|
+
"ModifyResourcePackagesDeductionPriority": [
|
916
|
+
{
|
917
|
+
"document": "修改已绑定资源包抵扣优先级",
|
918
|
+
"input": "POST / HTTP/1.1\nHost: cynosdb.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyResourcePackagesDeductionPriority\n<公共请求参数>\n\n{\n \"PackageType\": \"CCU\",\n \"ClusterId\": \"cynosdbmysql-abcd1234\",\n \"DeductionPriorities\": [\n {\n \"PackageId\": \"package-abcd1234\",\n \"DeductionPriority\": 1\n }\n ]\n}",
|
919
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
|
920
|
+
"title": "ModifyResourcePackagesDeductionPriority"
|
921
|
+
}
|
922
|
+
],
|
907
923
|
"ModifyVipVport": [
|
908
924
|
{
|
909
925
|
"document": "",
|
@@ -8091,6 +8091,24 @@
|
|
8091
8091
|
"name": "CvmDelayOnlineTime",
|
8092
8092
|
"required": false,
|
8093
8093
|
"type": "int"
|
8094
|
+
},
|
8095
|
+
{
|
8096
|
+
"disabled": false,
|
8097
|
+
"document": "分片迁移并发数",
|
8098
|
+
"example": "2",
|
8099
|
+
"member": "uint64",
|
8100
|
+
"name": "ShardAllocationConcurrents",
|
8101
|
+
"required": false,
|
8102
|
+
"type": "int"
|
8103
|
+
},
|
8104
|
+
{
|
8105
|
+
"disabled": false,
|
8106
|
+
"document": "分片迁移并发速度",
|
8107
|
+
"example": "40",
|
8108
|
+
"member": "uint64",
|
8109
|
+
"name": "ShardAllocationBytes",
|
8110
|
+
"required": false,
|
8111
|
+
"type": "int"
|
8094
8112
|
}
|
8095
8113
|
],
|
8096
8114
|
"type": "object"
|
@@ -10165,6 +10183,24 @@
|
|
10165
10183
|
"name": "CvmDelayOnlineTime",
|
10166
10184
|
"required": false,
|
10167
10185
|
"type": "int"
|
10186
|
+
},
|
10187
|
+
{
|
10188
|
+
"disabled": false,
|
10189
|
+
"document": "分片迁移并发数",
|
10190
|
+
"example": "2",
|
10191
|
+
"member": "uint64",
|
10192
|
+
"name": "ShardAllocationConcurrents",
|
10193
|
+
"required": false,
|
10194
|
+
"type": "int"
|
10195
|
+
},
|
10196
|
+
{
|
10197
|
+
"disabled": false,
|
10198
|
+
"document": "分片迁移并发速度",
|
10199
|
+
"example": "40",
|
10200
|
+
"member": "uint64",
|
10201
|
+
"name": "ShardAllocationBytes",
|
10202
|
+
"required": false,
|
10203
|
+
"type": "int"
|
10168
10204
|
}
|
10169
10205
|
],
|
10170
10206
|
"type": "object"
|
tccli/services/ess/ess_client.py
CHANGED
@@ -693,6 +693,58 @@ def doCreateFlowGroupByTemplates(args, parsed_globals):
|
|
693
693
|
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
694
694
|
|
695
695
|
|
696
|
+
def doCreatePartnerAutoSignAuthUrl(args, parsed_globals):
|
697
|
+
g_param = parse_global_arg(parsed_globals)
|
698
|
+
|
699
|
+
if g_param[OptionsDefine.UseCVMRole.replace('-', '_')]:
|
700
|
+
cred = credential.CVMRoleCredential()
|
701
|
+
elif g_param[OptionsDefine.RoleArn.replace('-', '_')] and g_param[OptionsDefine.RoleSessionName.replace('-', '_')]:
|
702
|
+
cred = credential.STSAssumeRoleCredential(
|
703
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.RoleArn.replace('-', '_')],
|
704
|
+
g_param[OptionsDefine.RoleSessionName.replace('-', '_')], endpoint=g_param["sts_cred_endpoint"]
|
705
|
+
)
|
706
|
+
elif os.getenv(OptionsDefine.ENV_TKE_REGION) and os.getenv(OptionsDefine.ENV_TKE_PROVIDER_ID) and os.getenv(OptionsDefine.ENV_TKE_WEB_IDENTITY_TOKEN_FILE) and os.getenv(OptionsDefine.ENV_TKE_ROLE_ARN):
|
707
|
+
cred = credential.DefaultTkeOIDCRoleArnProvider().get_credentials()
|
708
|
+
else:
|
709
|
+
cred = credential.Credential(
|
710
|
+
g_param[OptionsDefine.SecretId], g_param[OptionsDefine.SecretKey], g_param[OptionsDefine.Token]
|
711
|
+
)
|
712
|
+
http_profile = HttpProfile(
|
713
|
+
reqTimeout=60 if g_param[OptionsDefine.Timeout] is None else int(g_param[OptionsDefine.Timeout]),
|
714
|
+
reqMethod="POST",
|
715
|
+
endpoint=g_param[OptionsDefine.Endpoint],
|
716
|
+
proxy=g_param[OptionsDefine.HttpsProxy.replace('-', '_')]
|
717
|
+
)
|
718
|
+
profile = ClientProfile(httpProfile=http_profile, signMethod="HmacSHA256")
|
719
|
+
if g_param[OptionsDefine.Language]:
|
720
|
+
profile.language = g_param[OptionsDefine.Language]
|
721
|
+
mod = CLIENT_MAP[g_param[OptionsDefine.Version]]
|
722
|
+
client = mod.EssClient(cred, g_param[OptionsDefine.Region], profile)
|
723
|
+
client._sdkVersion += ("_CLI_" + __version__)
|
724
|
+
models = MODELS_MAP[g_param[OptionsDefine.Version]]
|
725
|
+
model = models.CreatePartnerAutoSignAuthUrlRequest()
|
726
|
+
model.from_json_string(json.dumps(args))
|
727
|
+
start_time = time.time()
|
728
|
+
while True:
|
729
|
+
rsp = client.CreatePartnerAutoSignAuthUrl(model)
|
730
|
+
result = rsp.to_json_string()
|
731
|
+
try:
|
732
|
+
json_obj = json.loads(result)
|
733
|
+
except TypeError as e:
|
734
|
+
json_obj = json.loads(result.decode('utf-8')) # python3.3
|
735
|
+
if not g_param[OptionsDefine.Waiter] or search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj) == g_param['OptionsDefine.WaiterInfo']['to']:
|
736
|
+
break
|
737
|
+
cur_time = time.time()
|
738
|
+
if cur_time - start_time >= g_param['OptionsDefine.WaiterInfo']['timeout']:
|
739
|
+
raise ClientError('Request timeout, wait `%s` to `%s` timeout, last request is %s' %
|
740
|
+
(g_param['OptionsDefine.WaiterInfo']['expr'], g_param['OptionsDefine.WaiterInfo']['to'],
|
741
|
+
search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj)))
|
742
|
+
else:
|
743
|
+
print('Inquiry result is %s.' % search(g_param['OptionsDefine.WaiterInfo']['expr'], json_obj))
|
744
|
+
time.sleep(g_param['OptionsDefine.WaiterInfo']['interval'])
|
745
|
+
FormatOutput.output("action", json_obj, g_param[OptionsDefine.Output], g_param[OptionsDefine.Filter])
|
746
|
+
|
747
|
+
|
696
748
|
def doCreateFlowByFiles(args, parsed_globals):
|
697
749
|
g_param = parse_global_arg(parsed_globals)
|
698
750
|
|
@@ -4565,6 +4617,7 @@ ACTION_MAP = {
|
|
4565
4617
|
"CreateReleaseFlow": doCreateReleaseFlow,
|
4566
4618
|
"DescribeUserAutoSignStatus": doDescribeUserAutoSignStatus,
|
4567
4619
|
"CreateFlowGroupByTemplates": doCreateFlowGroupByTemplates,
|
4620
|
+
"CreatePartnerAutoSignAuthUrl": doCreatePartnerAutoSignAuthUrl,
|
4568
4621
|
"CreateFlowByFiles": doCreateFlowByFiles,
|
4569
4622
|
"DescribeIntegrationRoles": doDescribeIntegrationRoles,
|
4570
4623
|
"DescribeIntegrationEmployees": doDescribeIntegrationEmployees,
|
@@ -71,7 +71,7 @@
|
|
71
71
|
"status": "online"
|
72
72
|
},
|
73
73
|
"CreateEmbedWebUrl": {
|
74
|
-
"document": "本接口(CreateEmbedWebUrl
|
74
|
+
"document": "本接口(CreateEmbedWebUrl)用于创建可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中),支持以下类型的Web链接创建:\n1. 创建印章\n2. 创建模板\n3. 修改模板\n4. 预览模板\n5. 预览合同流程\n\n预览模板的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)\n\n预览合同流程的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/dc7af994e2f6da56bdad5975e927de34.png)",
|
75
75
|
"input": "CreateEmbedWebUrlRequest",
|
76
76
|
"name": "获取其他可嵌入web页面",
|
77
77
|
"output": "CreateEmbedWebUrlResponse",
|
@@ -225,7 +225,7 @@
|
|
225
225
|
"status": "online"
|
226
226
|
},
|
227
227
|
"CreateOrganizationBatchSignUrl": {
|
228
|
-
"document": "使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>\n
|
228
|
+
"document": "使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>\n\n注:\n<ul>\n<li>员工必须需作为批量签署合同的签署方,或者是或签合同的候选人之一。</li>\n<li><b>本方企业签署链接</b>:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。</li>\n<li><b>他方企业签署链接</b>:传RecipientIds,且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电子签系统。(<b>如果签署人没有加入对方企业则会引导加入;如果对方企业还没有注册认证,会引导企业注册和认证</b>)</li>\n<li>只支持待签署、待填写状态的合同生成签署链接。</li>\n</ul>\n\n签署的嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/a4754bc835a3f837ddec1e28b02ed9c0.png)",
|
229
229
|
"input": "CreateOrganizationBatchSignUrlRequest",
|
230
230
|
"name": "获取企业签署合同web页面",
|
231
231
|
"output": "CreateOrganizationBatchSignUrlResponse",
|
@@ -245,6 +245,13 @@
|
|
245
245
|
"output": "CreateOrganizationInfoChangeUrlResponse",
|
246
246
|
"status": "online"
|
247
247
|
},
|
248
|
+
"CreatePartnerAutoSignAuthUrl": {
|
249
|
+
"document": "创建他方自动签授权链接,通过该链接可进入小程序进行合作方企业的自动签授权,若当前企业未开通企业自动签,通过该链接会先引导开通本企业自动签。\n该接口效果同控制台: 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权\n\n\n\n注: \n1. <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId 需要传递超管或者法人的UserId)\n2. 已经在授权中或者授权成功的企业,无法重复授权",
|
250
|
+
"input": "CreatePartnerAutoSignAuthUrlRequest",
|
251
|
+
"name": "创建他方企业自动签授权链接",
|
252
|
+
"output": "CreatePartnerAutoSignAuthUrlResponse",
|
253
|
+
"status": "online"
|
254
|
+
},
|
248
255
|
"CreatePersonAuthCertificateImage": {
|
249
256
|
"document": "获取个人用户认证证书图片下载URL\n\n个人用户认证证书图片样式如下图\n\n![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)\n\n注: \n<ul>\n<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>\n<li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>\n</ul>",
|
250
257
|
"input": "CreatePersonAuthCertificateImageRequest",
|
@@ -253,7 +260,7 @@
|
|
253
260
|
"status": "online"
|
254
261
|
},
|
255
262
|
"CreatePrepareFlow": {
|
256
|
-
"document": "创建发起流程web
|
263
|
+
"document": "创建发起流程Web页面,通过该接口可以获取发起流程的可嵌入web页面的URL(此web页面可以通过iframe方式嵌入到贵方系统的网页中)。在页面上完成签署控件等信息的编辑与确认后,可快速发起流程。\n\n <br/>注意:调用接口后,<font color=\"red\">流程不会立即发起,需在嵌入页面上点击【发起合同】按钮来发起流程</font>。\n\n嵌入页面长相如下:\n![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)",
|
257
264
|
"input": "CreatePrepareFlowRequest",
|
258
265
|
"name": "创建发起流程web页面",
|
259
266
|
"output": "CreatePrepareFlowResponse",
|
@@ -547,9 +554,9 @@
|
|
547
554
|
"status": "online"
|
548
555
|
},
|
549
556
|
"ModifyFlowDeadline": {
|
550
|
-
"document": "
|
557
|
+
"document": "在已启动的签署流程中,可对签署截止日期进行延期操作,主要分为以下两个层面:\n1. <b> 合同(流程)层面</b>:仅需提供签署流程ID。此操作将对整个签署流程以及未单独设置签署截止时间的签署人进行延期。\n2. <b> 签署人层面</b> :需提供流程ID和签署人ID。此操作针对特定签署人进行延期,特别是对于有序合同(流程),签署截止时间不得超过后续签署人的流程截止时间。\n\n此接口存在以下限制:\n1. 执行操作的员工须为<font color=\"red\">发起方企业的超级管理员、法定代表人或签署流程发起人</font>。\n2. 延长整个签署流程时,<font color=\"red\">应至少有一方尚未签署</font>(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。\n3. 延长整个签署流程时,新的签署截止日期应晚于已设定的签署截止日期和当前日期。\n4. 延长签署方截止时间时,<font color=\"red\">签署方不能处于流程完结或已终止状态</font>(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。\n5. 延长签署方截止时间时,新的签署截止日期应晚于当前日期和已设定的截止日期。若为有序合同,还需早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。\n6. <font color=\"red\">不支持操作合同组合同</font>。\n\n合同(流程)层面 截止时间控制台展示的位置:\n![image](https://qcloudimg.tencent-cloud.cn/raw/265b130136bf6e8f01f5880438467dfb.png)",
|
551
558
|
"input": "ModifyFlowDeadlineRequest",
|
552
|
-
"name": "
|
559
|
+
"name": "修改签署流程截止时间",
|
553
560
|
"output": "ModifyFlowDeadlineResponse",
|
554
561
|
"status": "online"
|
555
562
|
},
|
@@ -867,7 +874,7 @@
|
|
867
874
|
},
|
868
875
|
{
|
869
876
|
"disabled": false,
|
870
|
-
"document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3
|
877
|
+
"document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>\n\n默认为1(人脸认证 ),2(签署密码),3(运营商三要素)\n\n注:\n1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>\n3. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/company/mobile_support)得到具体的支持说明",
|
871
878
|
"example": "[1,2,3]",
|
872
879
|
"member": "int64",
|
873
880
|
"name": "ApproverSignTypes",
|
@@ -2668,7 +2675,7 @@
|
|
2668
2675
|
"members": [
|
2669
2676
|
{
|
2670
2677
|
"disabled": false,
|
2671
|
-
"document": "执行本接口操作的员工信息。\n<br/>注:
|
2678
|
+
"document": "执行本接口操作的员工信息。\n<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
2672
2679
|
"example": "无",
|
2673
2680
|
"member": "UserInfo",
|
2674
2681
|
"name": "Operator",
|
@@ -2722,7 +2729,7 @@
|
|
2722
2729
|
},
|
2723
2730
|
{
|
2724
2731
|
"disabled": false,
|
2725
|
-
"document": "
|
2732
|
+
"document": "<ul> <li>目前仅支持EmbedType=CREATE_TEMPLATE时传入</li> <li>指定后,创建,编辑,删除模板时,回调都会携带该userData</li> <li>支持的格式:json字符串的BASE64编码字符串</li> <li>示例:<ul> <li>json字符串:{\"ComeFrom\":\"xxx\"},BASE64编码:eyJDb21lRnJvbSI6Inh4eCJ9</li> <li>eyJDb21lRnJvbSI6Inh4eCJ9,为符合要求的userData数据格式</li> </ul> </li> </ul>",
|
2726
2733
|
"example": "eyJDb21lRnJvbSI6IuadpeiHqnh4eOWFrOWPuOeahOaooeeJiCJ9",
|
2727
2734
|
"member": "string",
|
2728
2735
|
"name": "UserData",
|
@@ -4973,7 +4980,7 @@
|
|
4973
4980
|
},
|
4974
4981
|
{
|
4975
4982
|
"disabled": false,
|
4976
|
-
"document": "员工在腾讯电子签平台的独特身份标识,为32位字符串。\n您可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查阅某位员工的UserId(在页面中显示为用户ID)。\nUserId必须是传入合同(FlowId)中的签署人。\n
|
4983
|
+
"document": "员工在腾讯电子签平台的独特身份标识,为32位字符串。\n您可登录腾讯电子签控制台,在 \"更多能力\"->\"组织管理\" 中查阅某位员工的UserId(在页面中显示为用户ID)。\nUserId必须是传入合同(FlowId)中的签署人。\n\n<ul>\n<li>1. 若UserId为空,Name和Mobile 必须提供。</li>\n<li>2. 若UserId 与 Name,Mobile均存在,将优先采用UserId对应的员工。</li>\n</ul>",
|
4977
4984
|
"example": "无",
|
4978
4985
|
"member": "string",
|
4979
4986
|
"name": "UserId",
|
@@ -5183,6 +5190,90 @@
|
|
5183
5190
|
],
|
5184
5191
|
"type": "object"
|
5185
5192
|
},
|
5193
|
+
"CreatePartnerAutoSignAuthUrlRequest": {
|
5194
|
+
"document": "CreatePartnerAutoSignAuthUrl请求参数结构体",
|
5195
|
+
"members": [
|
5196
|
+
{
|
5197
|
+
"disabled": false,
|
5198
|
+
"document": "被授企业id",
|
5199
|
+
"example": "无",
|
5200
|
+
"member": "string",
|
5201
|
+
"name": "AuthorizedOrganizationId",
|
5202
|
+
"required": false,
|
5203
|
+
"type": "string"
|
5204
|
+
},
|
5205
|
+
{
|
5206
|
+
"disabled": false,
|
5207
|
+
"document": "指定印章类型,指定后只能选择该类型的印章进行授权支持以下印章类型:- OFFICIAL : 企业公章- CONTRACT : 合同专用章- FINANCE : 财务专用章- PERSONNEL : 人事专用章",
|
5208
|
+
"example": "无",
|
5209
|
+
"member": "string",
|
5210
|
+
"name": "SealTypes",
|
5211
|
+
"required": false,
|
5212
|
+
"type": "list"
|
5213
|
+
},
|
5214
|
+
{
|
5215
|
+
"disabled": false,
|
5216
|
+
"document": "代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。",
|
5217
|
+
"example": "无",
|
5218
|
+
"member": "Agent",
|
5219
|
+
"name": "Agent",
|
5220
|
+
"required": false,
|
5221
|
+
"type": "object"
|
5222
|
+
},
|
5223
|
+
{
|
5224
|
+
"disabled": false,
|
5225
|
+
"document": "执行本接口操作的员工信息。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`",
|
5226
|
+
"example": "无",
|
5227
|
+
"member": "UserInfo",
|
5228
|
+
"name": "Operator",
|
5229
|
+
"required": false,
|
5230
|
+
"type": "object"
|
5231
|
+
}
|
5232
|
+
],
|
5233
|
+
"type": "object"
|
5234
|
+
},
|
5235
|
+
"CreatePartnerAutoSignAuthUrlResponse": {
|
5236
|
+
"document": "CreatePartnerAutoSignAuthUrl返回参数结构体",
|
5237
|
+
"members": [
|
5238
|
+
{
|
5239
|
+
"disabled": false,
|
5240
|
+
"document": "授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。",
|
5241
|
+
"example": "无",
|
5242
|
+
"member": "string",
|
5243
|
+
"name": "Url",
|
5244
|
+
"output_required": false,
|
5245
|
+
"type": "string",
|
5246
|
+
"value_allowed_null": false
|
5247
|
+
},
|
5248
|
+
{
|
5249
|
+
"disabled": false,
|
5250
|
+
"document": "从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径",
|
5251
|
+
"example": "无",
|
5252
|
+
"member": "string",
|
5253
|
+
"name": "MiniAppPath",
|
5254
|
+
"output_required": false,
|
5255
|
+
"type": "string",
|
5256
|
+
"value_allowed_null": false
|
5257
|
+
},
|
5258
|
+
{
|
5259
|
+
"disabled": false,
|
5260
|
+
"document": "链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。",
|
5261
|
+
"example": "无",
|
5262
|
+
"member": "int64",
|
5263
|
+
"name": "ExpireTime",
|
5264
|
+
"output_required": false,
|
5265
|
+
"type": "int",
|
5266
|
+
"value_allowed_null": false
|
5267
|
+
},
|
5268
|
+
{
|
5269
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
5270
|
+
"member": "string",
|
5271
|
+
"name": "RequestId",
|
5272
|
+
"type": "string"
|
5273
|
+
}
|
5274
|
+
],
|
5275
|
+
"type": "object"
|
5276
|
+
},
|
5186
5277
|
"CreatePersonAuthCertificateImageRequest": {
|
5187
5278
|
"document": "CreatePersonAuthCertificateImage请求参数结构体",
|
5188
5279
|
"members": [
|
@@ -10238,7 +10329,7 @@
|
|
10238
10329
|
},
|
10239
10330
|
{
|
10240
10331
|
"disabled": false,
|
10241
|
-
"document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3
|
10332
|
+
"document": "您可以指定签署方签署合同的认证校验方式,可传递以下值:\n<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>\n<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>\n<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。(如果是港澳台客户,建议不要选择这个)</li></ul>\n注:\n<ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>\n<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>\n\n注:\n`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`",
|
10242
10333
|
"example": "[1,2]",
|
10243
10334
|
"member": "uint64",
|
10244
10335
|
"name": "ApproverSignTypes",
|
@@ -826,6 +826,14 @@
|
|
826
826
|
"title": "错误示例-变更类型不合法"
|
827
827
|
}
|
828
828
|
],
|
829
|
+
"CreatePartnerAutoSignAuthUrl": [
|
830
|
+
{
|
831
|
+
"document": "创建他方自动签授权链接\n",
|
832
|
+
"input": "POST / HTTP/1.1\nHost: ess.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePartnerAutoSignAuthUrl\n<公共请求参数>\n\n{\n \"Operator\": {\n \"UserId\": \"yDSxxxxxxxxxOnHtH51\"\n },\n \"AuthorizedOrganizationId\": \"yDRt2UUgygqxuvlqUuO4zjEySqVWqO9J\",\n \"SealTypes\": [\n \"OFFICIAL\"\n ]\n}",
|
833
|
+
"output": "{\n \"Response\": {\n \"ExpireTime\": 1721984586,\n \"MiniAppPath\": \"/pages/guide/index?shortKey=yDCpEUNqf8CyuealGCfc\",\n \"RequestId\": \"s1721379786690441960\",\n \"Url\": \"https://test.essurl.cn/g4sjUBHlHx\"\n }\n}",
|
834
|
+
"title": "创建他方自动签授权链接"
|
835
|
+
}
|
836
|
+
],
|
829
837
|
"CreatePersonAuthCertificateImage": [
|
830
838
|
{
|
831
839
|
"document": "创建个人用户证明证书图片",
|