tccli 3.0.1240.1__py2.py3-none-any.whl → 3.0.1241.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/apm/v20210622/api.json +66 -69
- tccli/services/apm/v20210622/examples.json +26 -26
- tccli/services/autoscaling/v20180419/api.json +12 -1
- tccli/services/batch/v20170312/api.json +11 -11
- tccli/services/billing/v20180709/api.json +20 -0
- tccli/services/cam/v20190116/api.json +1 -1
- tccli/services/car/v20220110/api.json +1 -1
- tccli/services/car/v20220110/examples.json +3 -3
- tccli/services/cdb/v20170320/api.json +582 -579
- tccli/services/cdb/v20170320/examples.json +9 -9
- tccli/services/cdwdoris/v20211228/api.json +40 -0
- tccli/services/cfg/v20210820/api.json +11 -0
- tccli/services/chdfs/v20201112/api.json +10 -10
- tccli/services/chdfs/v20201112/examples.json +1 -1
- tccli/services/cls/v20201016/api.json +1 -1
- tccli/services/cmq/v20190304/api.json +77 -77
- tccli/services/cvm/cvm_client.py +60 -325
- tccli/services/cvm/v20170312/api.json +618 -1401
- tccli/services/cvm/v20170312/examples.json +8 -48
- tccli/services/cwp/cwp_client.py +0 -53
- tccli/services/cwp/v20180228/api.json +0 -34
- tccli/services/cwp/v20180228/examples.json +0 -8
- tccli/services/cynosdb/v20190107/api.json +452 -458
- tccli/services/cynosdb/v20190107/examples.json +23 -23
- tccli/services/dbbrain/v20191016/api.json +16 -4
- tccli/services/dbbrain/v20191016/examples.json +5 -5
- tccli/services/dbbrain/v20210527/api.json +44 -44
- tccli/services/dbbrain/v20210527/examples.json +8 -8
- tccli/services/dts/v20180330/api.json +30 -30
- tccli/services/dts/v20180330/examples.json +4 -4
- tccli/services/dts/v20211206/api.json +19 -9
- tccli/services/dts/v20211206/examples.json +5 -5
- tccli/services/ecm/v20190719/api.json +55 -48
- tccli/services/ecm/v20190719/examples.json +7 -7
- tccli/services/emr/emr_client.py +493 -16
- tccli/services/emr/v20190103/api.json +1323 -246
- tccli/services/emr/v20190103/examples.json +72 -0
- tccli/services/ess/v20201111/api.json +13 -4
- tccli/services/essbasic/v20210526/api.json +11 -2
- tccli/services/essbasic/v20210526/examples.json +12 -0
- tccli/services/faceid/v20180301/api.json +3 -3
- tccli/services/gaap/v20180529/api.json +181 -183
- tccli/services/gaap/v20180529/examples.json +31 -37
- tccli/services/gs/v20191118/api.json +3 -3
- tccli/services/gs/v20191118/examples.json +3 -3
- tccli/services/iai/iai_client.py +53 -0
- tccli/services/iai/v20200303/api.json +80 -0
- tccli/services/iai/v20200303/examples.json +14 -0
- tccli/services/iotexplorer/v20190423/api.json +10 -0
- tccli/services/keewidb/v20220308/api.json +188 -190
- tccli/services/live/v20180801/api.json +323 -222
- tccli/services/live/v20180801/examples.json +79 -79
- tccli/services/mna/v20210119/api.json +20 -20
- tccli/services/mps/v20190612/api.json +40 -0
- tccli/services/oceanus/v20190422/api.json +407 -39
- tccli/services/oceanus/v20190422/examples.json +1 -1
- tccli/services/ocr/v20181119/api.json +50 -0
- tccli/services/sqlserver/v20180328/api.json +235 -139
- tccli/services/sqlserver/v20180328/examples.json +2 -2
- tccli/services/ssl/v20191205/api.json +777 -779
- tccli/services/ssl/v20191205/examples.json +8 -8
- tccli/services/tbaas/v20180416/api.json +118 -82
- tccli/services/tbaas/v20180416/examples.json +7 -7
- tccli/services/tcb/v20180608/api.json +18 -18
- tccli/services/tcb/v20180608/examples.json +2 -2
- tccli/services/tcm/v20210413/api.json +6 -6
- tccli/services/tcm/v20210413/examples.json +1 -1
- tccli/services/tcr/v20190924/api.json +17 -12
- tccli/services/tdmq/v20200217/api.json +18 -0
- tccli/services/tem/v20210701/api.json +439 -280
- tccli/services/tem/v20210701/examples.json +39 -39
- tccli/services/tke/v20180525/api.json +50 -39
- tccli/services/tke/v20180525/examples.json +51 -21
- tccli/services/trro/v20220325/api.json +27 -27
- tccli/services/trro/v20220325/examples.json +1 -1
- tccli/services/tse/v20201207/api.json +46 -9
- tccli/services/tse/v20201207/examples.json +31 -31
- tccli/services/tsf/v20180326/api.json +448 -434
- tccli/services/tsf/v20180326/examples.json +122 -122
- tccli/services/tts/v20190823/api.json +1 -1
- tccli/services/vpc/v20170312/api.json +278 -37
- tccli/services/vpc/v20170312/examples.json +56 -8
- tccli/services/vpc/vpc_client.py +159 -0
- tccli/services/waf/v20180125/api.json +303 -4
- tccli/services/waf/v20180125/examples.json +25 -1
- tccli/services/waf/waf_client.py +163 -4
- {tccli-3.0.1240.1.dist-info → tccli-3.0.1241.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1240.1.dist-info → tccli-3.0.1241.1.dist-info}/RECORD +92 -92
- {tccli-3.0.1240.1.dist-info → tccli-3.0.1241.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1240.1.dist-info → tccli-3.0.1241.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1240.1.dist-info → tccli-3.0.1241.1.dist-info}/license_files/LICENSE +0 -0
@@ -8,6 +8,14 @@
|
|
8
8
|
"title": "添加扩缩容规则成功示例"
|
9
9
|
}
|
10
10
|
],
|
11
|
+
"AddNodeResourceConfig": [
|
12
|
+
{
|
13
|
+
"document": "",
|
14
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddNodeResourceConfig\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ResourceType\": \"abc\",\n \"IsDefault\": \"abc\",\n \"ResourceConfig\": {\n \"Spec\": \"abc\",\n \"StorageType\": 0,\n \"DiskType\": \"abc\",\n \"RootSize\": 0,\n \"MemSize\": 0,\n \"Cpu\": 0,\n \"DiskSize\": 0,\n \"MultiDisks\": [\n {\n \"DiskType\": \"abc\",\n \"Volume\": 0,\n \"Count\": 0\n }\n ],\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"InstanceType\": \"abc\",\n \"LocalDiskNum\": 1,\n \"DiskNum\": 1\n },\n \"PayMode\": 0,\n \"ZoneId\": 0,\n \"MultipleResourceConfig\": [\n {\n \"Spec\": \"abc\",\n \"StorageType\": 0,\n \"DiskType\": \"abc\",\n \"RootSize\": 0,\n \"MemSize\": 0,\n \"Cpu\": 0,\n \"DiskSize\": 0,\n \"MultiDisks\": [\n {\n \"DiskType\": \"abc\",\n \"Volume\": 0,\n \"Count\": 0\n }\n ],\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"InstanceType\": \"abc\",\n \"LocalDiskNum\": 1,\n \"DiskNum\": 1\n }\n ],\n \"ResourceBaseType\": \"abc\",\n \"ComputeResourceId\": \"abc\"\n}",
|
15
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"f0f11d21-6d0d-4f73-9177-8ae4ec456068\"\n }\n}",
|
16
|
+
"title": "增加当前集群的节点规格配置"
|
17
|
+
}
|
18
|
+
],
|
11
19
|
"AddUsersForUserManager": [
|
12
20
|
{
|
13
21
|
"document": "",
|
@@ -16,6 +24,14 @@
|
|
16
24
|
"title": "test"
|
17
25
|
}
|
18
26
|
],
|
27
|
+
"AttachDisks": [
|
28
|
+
{
|
29
|
+
"document": "",
|
30
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AttachDisks\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-xxxx\",\n \"DiskIds\": [\n \"disk-xxx1\",\n \"disk-xxx2\"\n ]\n}",
|
31
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"95eb9120-0883-407c-aa5a-43b4e2c250d1\"\n }\n}",
|
32
|
+
"title": "云盘挂载"
|
33
|
+
}
|
34
|
+
],
|
19
35
|
"CreateCloudInstance": [
|
20
36
|
{
|
21
37
|
"document": "创建EMR容器实例",
|
@@ -56,6 +72,14 @@
|
|
56
72
|
"title": "删除弹性扩缩容规则示例"
|
57
73
|
}
|
58
74
|
],
|
75
|
+
"DeleteNodeResourceConfig": [
|
76
|
+
{
|
77
|
+
"document": "",
|
78
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteNodeResourceConfig\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ResourceType\": \"abc\",\n \"ResourceConfigId\": 1,\n \"ResourceBaseType\": \"abc\",\n \"ComputeResourceId\": \"abc\"\n}",
|
79
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"8c2ff02e-5f38-494a-8d2d-68a7dec6efcd\"\n }\n}",
|
80
|
+
"title": "输入输出例子"
|
81
|
+
}
|
82
|
+
],
|
59
83
|
"DeleteUserManagerUserList": [
|
60
84
|
{
|
61
85
|
"document": "test",
|
@@ -224,6 +248,22 @@
|
|
224
248
|
"title": "DescribeKyuubiQueryInfo"
|
225
249
|
}
|
226
250
|
],
|
251
|
+
"DescribeNodeDataDisks": [
|
252
|
+
{
|
253
|
+
"document": "",
|
254
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeNodeDataDisks\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-xxxxxxx\",\n \"CvmInstanceIds\": [\n \"ins-xxxxxxxx\"\n ]\n}",
|
255
|
+
"output": "{\n \"Response\": {\n \"CBSList\": [\n {\n \"DeleteWithInstance\": true,\n \"DiskChargeType\": \"POSTPAID_BY_HOUR\",\n \"DiskId\": \"disk-xxxxxxxx\",\n \"DiskName\": \"未命名_1\",\n \"DiskSize\": 100,\n \"DiskState\": \"ATTACHED\",\n \"DiskType\": \"CLOUD_SSD\",\n \"DiskUsage\": \"DATA_DISK\",\n \"DeadlineTime\": \"\"\n },\n {\n \"DeleteWithInstance\": true,\n \"DiskChargeType\": \"POSTPAID_BY_HOUR\",\n \"DiskId\": \"disk-xxxxxxxx\",\n \"DiskName\": \"未命名_0\",\n \"DiskSize\": 50,\n \"DiskState\": \"ATTACHED\",\n \"DiskType\": \"CLOUD_SSD\",\n \"DiskUsage\": \"SYSTEM_DISK\",\n \"DeadlineTime\": \"\"\n }\n ],\n \"RequestId\": \"9dd6b795-aed5-4a09-b493-f460c1f1a0c5\",\n \"TotalCount\": 2\n }\n}",
|
256
|
+
"title": "查询节点数据盘信息"
|
257
|
+
}
|
258
|
+
],
|
259
|
+
"DescribeNodeResourceConfigFast": [
|
260
|
+
{
|
261
|
+
"document": "",
|
262
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeNodeResourceConfigFast\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-laoxdz4n\",\n \"ResourceType\": \"ALL\",\n \"PayMode\": 0\n}",
|
263
|
+
"output": "{\n \"Response\": {\n \"Data\": [\n {\n \"ResourceData\": [\n {\n \"CreateTime\": \"2024-03-25 17:52:23\",\n \"IsDefault\": \"DEFAULT\",\n \"MaxResourceNum\": 0,\n \"Resource\": {\n \"Cpu\": 4,\n \"DiskNum\": 1,\n \"DiskSize\": 200,\n \"DiskType\": \"CLOUD_SSD\",\n \"InstanceType\": \"SA2.LARGE8\",\n \"LocalDiskNum\": 0,\n \"MemSize\": 8192,\n \"MultiDisks\": [],\n \"RootSize\": 70,\n \"Spec\": \"CVM.SA2\",\n \"StorageType\": 4,\n \"Tags\": null\n },\n \"ResourceConfigId\": 20332,\n \"UpdateTime\": \"2024-03-25 17:52:23\"\n }\n ],\n \"ResourceType\": \"CORE\"\n },\n {\n \"ResourceData\": [\n {\n \"CreateTime\": \"2024-04-08 15:13:04\",\n \"IsDefault\": \"DEFAULT\",\n \"MaxResourceNum\": 0,\n \"Resource\": {\n \"Cpu\": 8,\n \"DiskNum\": 1,\n \"DiskSize\": 200,\n \"DiskType\": \"CLOUD_HSSD\",\n \"InstanceType\": \"S6.2XLARGE32\",\n \"LocalDiskNum\": 0,\n \"MemSize\": 32768,\n \"MultiDisks\": [],\n \"RootSize\": 70,\n \"Spec\": \"CVM.S6\",\n \"StorageType\": 6,\n \"Tags\": null\n },\n \"ResourceConfigId\": 20560,\n \"UpdateTime\": \"2024-04-08 15:13:04\"\n }\n ],\n \"ResourceType\": \"TASK\"\n },\n {\n \"ResourceData\": [\n {\n \"CreateTime\": \"2024-04-08 22:04:42\",\n \"IsDefault\": \"DEFAULT\",\n \"MaxResourceNum\": 0,\n \"Resource\": {\n \"Cpu\": 4,\n \"DiskNum\": 1,\n \"DiskSize\": 200,\n \"DiskType\": \"CLOUD_HSSD\",\n \"InstanceType\": \"SA2.LARGE8\",\n \"LocalDiskNum\": 0,\n \"MemSize\": 8192,\n \"MultiDisks\": [],\n \"RootSize\": 70,\n \"Spec\": \"CVM.SA2\",\n \"StorageType\": 6,\n \"Tags\": null\n },\n \"ResourceConfigId\": 20563,\n \"UpdateTime\": \"2024-04-08 22:04:42\"\n }\n ],\n \"ResourceType\": \"ROUTER\"\n }\n ],\n \"RequestId\": \"638ef562-a954-4963-ae70-b54c2dd2bf94\"\n }\n}",
|
264
|
+
"title": "DescribeNodeResourceConfigFast示例"
|
265
|
+
}
|
266
|
+
],
|
227
267
|
"DescribeResourceSchedule": [
|
228
268
|
{
|
229
269
|
"document": "",
|
@@ -384,6 +424,14 @@
|
|
384
424
|
"title": "修改YARN资源调度的全局配置"
|
385
425
|
}
|
386
426
|
],
|
427
|
+
"ModifyInstanceBasic": [
|
428
|
+
{
|
429
|
+
"document": "",
|
430
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceBasic\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ClusterName\": \"abc\",\n \"ResourceBaseType\": \"abc\",\n \"ComputeResourceId\": \"abc\"\n}",
|
431
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"abc\"\n }\n}",
|
432
|
+
"title": "ModifyInstanceBasic"
|
433
|
+
}
|
434
|
+
],
|
387
435
|
"ModifyPodNum": [
|
388
436
|
{
|
389
437
|
"document": "调整容器集群Pod数量",
|
@@ -392,6 +440,14 @@
|
|
392
440
|
"title": "调整容器集群Pod数量"
|
393
441
|
}
|
394
442
|
],
|
443
|
+
"ModifyResource": [
|
444
|
+
{
|
445
|
+
"document": "",
|
446
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyResource\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-3ap64zl6\",\n \"PayMode\": \"0\",\n \"NewCpu\": \"8\",\n \"NewMem\": \"32\"\n}",
|
447
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"ef0a7e45-2f47-4379-bbc8-9594f51cb95f\"\n }\n}",
|
448
|
+
"title": "变配实例"
|
449
|
+
}
|
450
|
+
],
|
395
451
|
"ModifyResourcePools": [
|
396
452
|
{
|
397
453
|
"document": "",
|
@@ -464,6 +520,14 @@
|
|
464
520
|
"title": "yarn资源调度-重置"
|
465
521
|
}
|
466
522
|
],
|
523
|
+
"ResizeDataDisks": [
|
524
|
+
{
|
525
|
+
"document": "",
|
526
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResizeDataDisks\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-xxxx\",\n \"CvmInstanceIds\": [\n \"ins-xx\"\n ],\n \"DiskIds\": [\n \"disk-xxx1\",\n \"disk-xxx2\"\n ],\n \"DiskSize\": 500\n}",
|
527
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"95eb9120-0883-407c-aa5a-43b4e2c250d1\"\n }\n}",
|
528
|
+
"title": "云盘扩容"
|
529
|
+
}
|
530
|
+
],
|
467
531
|
"RunJobFlow": [
|
468
532
|
{
|
469
533
|
"document": "",
|
@@ -488,6 +552,14 @@
|
|
488
552
|
"title": "集群扩容"
|
489
553
|
}
|
490
554
|
],
|
555
|
+
"SetNodeResourceConfigDefault": [
|
556
|
+
{
|
557
|
+
"document": "",
|
558
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetNodeResourceConfigDefault\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ResourceType\": \"abc\",\n \"ResourceConfigId\": 1,\n \"ResourceBaseType\": \"abc\",\n \"ComputeResourceId\": \"abc\"\n}",
|
559
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"8c2ff02e-5f38-494a-8d2d-68a7dec6efcd\"\n }\n}",
|
560
|
+
"title": "输出输入参数"
|
561
|
+
}
|
562
|
+
],
|
491
563
|
"StartStopServiceOrMonitor": [
|
492
564
|
{
|
493
565
|
"document": "启停服务接口",
|
@@ -1077,6 +1077,15 @@
|
|
1077
1077
|
"name": "FlowReadLimit",
|
1078
1078
|
"required": false,
|
1079
1079
|
"type": "string"
|
1080
|
+
},
|
1081
|
+
{
|
1082
|
+
"disabled": false,
|
1083
|
+
"document": "禁止在签署过程中添加签署日期控件\n <br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):\n<ul>\n<li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>\n<li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>\n</ul>",
|
1084
|
+
"example": "false",
|
1085
|
+
"member": "bool",
|
1086
|
+
"name": "ForbidAddSignDate",
|
1087
|
+
"required": false,
|
1088
|
+
"type": "bool"
|
1080
1089
|
}
|
1081
1090
|
],
|
1082
1091
|
"usage": "in"
|
@@ -6232,7 +6241,7 @@
|
|
6232
6241
|
"member": "CcInfo",
|
6233
6242
|
"name": "CcInfos",
|
6234
6243
|
"required": false,
|
6235
|
-
"type": "
|
6244
|
+
"type": "list"
|
6236
6245
|
},
|
6237
6246
|
{
|
6238
6247
|
"disabled": false,
|
@@ -8980,7 +8989,7 @@
|
|
8980
8989
|
},
|
8981
8990
|
{
|
8982
8991
|
"disabled": false,
|
8983
|
-
"document": "
|
8992
|
+
"document": "搜索过滤的条件,本字段允许您通过指定模板 ID 或模板名称来进行查询。\n<ul><li><strong>模板 ID</strong>:<strong>Key</strong>设置为 <code>template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>:<strong>Key</strong>设置为 <code>share-template-id</code> ,<strong>Values</strong>为您想要查询的 <a href=\"https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png\" target=\"_blank\">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下,子企业的模板信息,在此情境下,参数 <strong>Agent.ProxyOrganizationId</strong>(子企业的组织ID)为必填项。</li> <li><strong>模板名称</strong>:<strong>Key</strong>设置为 <code>template-name</code> ,<strong>Values</strong>为您想要查询的<a href=\"https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png\" target=\"_blank\">模板名称</a>列表。</li></ul>",
|
8984
8993
|
"example": "Filters",
|
8985
8994
|
"member": "Filter",
|
8986
8995
|
"name": "Filters",
|
@@ -9007,7 +9016,7 @@
|
|
9007
9016
|
},
|
9008
9017
|
{
|
9009
9018
|
"disabled": false,
|
9010
|
-
"document": "
|
9019
|
+
"document": "通过指定[第三方应用的应用号(ApplicationId)](https://qcloudimg.tencent-cloud.cn/raw/60efa1e9049732e5246b20a268882b1a.png),您可以查询<a href=\"https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png\" target=\"_blank\">【应用模板库管理】</a>中某个第三方应用下的模板。\n\n<p><strong>注意事项:</strong></p>\n<ul><li>当 <strong>ApplicationId</strong> 为空时(默认),系统将查询<a href=\"https://qcloudimg.tencent-cloud.cn/raw/376943a1d472393dd5388592f2e85ee5.png\" target=\"_blank\">平台企业的所有模板</a>(自建应用使用的模板)。</li><li>当 <strong>ApplicationId</strong> 不为空时,系统将从<a href=\"https://qcloudimg.tencent-cloud.cn/raw/18319e5e77f7d47eab493d43d47827d3.png\" target=\"_blank\">【应用模板库管理】</a>中查询该特定应用下的模板(分享给第三方应用子企业的模板)。</li></ul>",
|
9011
9020
|
"example": "无",
|
9012
9021
|
"member": "string",
|
9013
9022
|
"name": "ApplicationId",
|
@@ -9043,7 +9052,7 @@
|
|
9043
9052
|
},
|
9044
9053
|
{
|
9045
9054
|
"disabled": false,
|
9046
|
-
"document": "
|
9055
|
+
"document": "是否获取模板预览链接。\n\n<ul><li><strong>false</strong>:不获取(默认)</li><li><strong>true</strong>:需要获取</li></ul>\n设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。",
|
9047
9056
|
"example": "无",
|
9048
9057
|
"member": "bool",
|
9049
9058
|
"name": "WithPreviewUrl",
|
@@ -761,6 +761,15 @@
|
|
761
761
|
"name": "FlowReadLimit",
|
762
762
|
"required": false,
|
763
763
|
"type": "string"
|
764
|
+
},
|
765
|
+
{
|
766
|
+
"disabled": false,
|
767
|
+
"document": "禁止在签署过程中添加签署日期控件\n <br/>前置条件:文件发起合同时,指定SignBeanTag=1(可以在签署过程中添加签署控件):\n<ul>\n<li> 默认值:false,在开启:签署过程中添加签署控件时,添加签署控件会默认自带签署日期控件</li>\n<li> 可选值:true,在开启:签署过程中添加签署控件时,添加签署控件不会自带签署日期控件</li>\n</ul>",
|
768
|
+
"example": "false",
|
769
|
+
"member": "bool",
|
770
|
+
"name": "ForbidAddSignDate",
|
771
|
+
"required": false,
|
772
|
+
"type": "bool"
|
764
773
|
}
|
765
774
|
],
|
766
775
|
"usage": "in"
|
@@ -1982,7 +1991,7 @@
|
|
1982
1991
|
},
|
1983
1992
|
{
|
1984
1993
|
"disabled": false,
|
1985
|
-
"document": "
|
1994
|
+
"document": "<font color=\"red\">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 \n\n参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。",
|
1986
1995
|
"example": "无",
|
1987
1996
|
"member": "string",
|
1988
1997
|
"name": "UrlUseEnv",
|
@@ -7903,7 +7912,7 @@
|
|
7903
7912
|
},
|
7904
7913
|
{
|
7905
7914
|
"disabled": false,
|
7906
|
-
"document": "
|
7915
|
+
"document": "<font color=\"red\">仅公众号 H5 跳转电子签小程序时</font>,如需签署完成的“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。在用户点击“返回应用”按钮之后,会返回到公众号 H5。 \n\n参考 [公众号 H5 跳转电子签小程序](https://qian.tencent.com/developers/company/openwxminiprogram/#23-%E5%85%AC%E4%BC%97%E5%8F%B7-h5-%E4%B8%AD%E8%B7%B3%E8%BD%AC)。",
|
7907
7916
|
"example": "无",
|
7908
7917
|
"member": "string",
|
7909
7918
|
"name": "UrlUseEnv",
|
@@ -176,6 +176,12 @@
|
|
176
176
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n \"OpenId\": \"test_open_id\",\n \"OrganizationOpenId\": \"test_org_open_id\",\n \"Name\": \"\",\n \"NotifyType\": \"SMS\",\n \"Mobile\": \"\",\n \"OrganizationName\": \"\",\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"FlowIds\": [\n \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n ]\n}",
|
177
177
|
"output": "{\n \"Response\": {\n \"ExpiredTime\": 1684899114,\n \"RequestId\": \"5beb5f54-cf3d-4c26-a4ee-a97c85196a3e\",\n \"SignUrl\": \"https://ess.url.cn/FuP**Swc\",\n \"MiniAppPath\": \"pages/guide/index?shortKey=FuP3**wc\"\n }\n}",
|
178
178
|
"title": "生成子客经办人小程序批量签署链接"
|
179
|
+
},
|
180
|
+
{
|
181
|
+
"document": "按照合同发起时候返回的合同信息生成批量签署链接,通过FlowIds参数对用户可以批签的合同进行限制,并指定批量领取的动态签署方,预设了平台子客企业OpenId后进入领取链接只能以该平台子客企业企业身份去领取并签署合同",
|
182
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ChannelCreateBatchSignUrl\n<公共请求参数>\n\n{\n \"Agent\": {\n \"ProxyOperator\": {\n \"OpenId\": \"test_open_id\"\n },\n \"ProxyOrganizationOpenId\": \"test_org_open_id\",\n \"AppId\": \"yDxbWUyKQ*******4zjEB8mxCcDjAyF\"\n },\n \"FlowIds\": [\n \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"yDR1AUUgygj******uO4zjE8gTG7xvgH\"\n ],\n \"FlowBatchUrlInfo\": {\n \"FlowBatchApproverInfos\": [\n {\n \"FlowId\": \"yDwFdUUckpsw******yQ0af8bHosXQtb\",\n \"RecipientId\": \"yDC5yUUckpwexozwUuoHfkTwB00zdfLo\"\n },\n {\n \"FlowId\": \"yDR1AUUgygj******uO4zjE8gTG7xvgH\",\n \"RecipientId\": \"yDCY3UUckp7tpp8rUEGRbNoRjQJ7t9bd\"\n }\n ]\n },\n \"OrganizationOpenId\": \"test_org_open_id\"\n}",
|
183
|
+
"output": "{\n \"Response\": {\n \"ExpiredTime\": 1735801457,\n \"MiniAppPath\": \"pages/guide/index?shortKey=yDCYSUx7LAQNwHZxaR93\",\n \"RequestId\": \"s1735196657684290155\",\n \"SignUrl\": \"https://essurl.cn/exssUH2TNe\"\n }\n}",
|
184
|
+
"title": "生成动态签署人批量领取链接-并且预设平台子客企业OpenId"
|
179
185
|
}
|
180
186
|
],
|
181
187
|
"ChannelCreateBoundFlows": [
|
@@ -1052,6 +1058,12 @@
|
|
1052
1058
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSignUrls\n<公共请求参数>\n\n{\n \"FlowIds\": [\n \"yDwhGUUfe5g******CX8ZwTiSg8gISocy\"\n ],\n \"RecipientIds\": [\n \"yDwJDUUckpkv98zbUEF1GNmv6ln4ga9W\"\n ],\n \"OrganizationOpenId\": \"dian_zi_qian\",\n \"GenerateType\": \"RECIPIENT\",\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"1000***8062\",\n \"ProxyOperator\": {\n \"OpenId\": \"yDR3L****eTdCt5TVx\"\n },\n \"AppId\": \"125***319\"\n },\n \"Endpoint\": \"\"\n}",
|
1053
1059
|
"output": "{\n \"Response\": {\n \"ErrorMessages\": [],\n \"RequestId\": \"s1696937862717144539\",\n \"SignUrlInfos\": [\n {\n \"ApproverType\": \"\",\n \"CustomUserId\": \"\",\n \"Deadline\": 0,\n \"FlowGroupId\": \"\",\n \"FlowId\": \"yDwhGUUfe5g******CX8ZwTiSg8gISocy\",\n \"IdCardNumber\": \"\",\n \"Mobile\": \"\",\n \"Name\": \"\",\n \"OpenId\": \"\",\n \"OrganizationName\": \"\",\n \"SignId\": \"\",\n \"SignOrder\": 0,\n \"SignQrcodeUrl\": \"https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06dcbe2797f**************69ee4e24cd976dd8376dbd41c6ff227c803c4c561c\",\n \"SignUrl\": \"https://test.essurl.cn/gGI***nZC\"\n }\n ]\n }\n}",
|
1054
1060
|
"title": "获取动态签署人补充链接, 并且预设平台子客企业OpenId"
|
1061
|
+
},
|
1062
|
+
{
|
1063
|
+
"document": "获取动态签署人补充链接,创建合同组时未指定具体签署人,可获取链接后推送给指定的人进行补充\n注: \n`1.参数GenerateType需传值为RECIPIENT` \n`2.需指定对应的合同组FlowGroupUrlInfo签署方角色编号(即RecipientId)` \n`3.通过参数OrganizationOpenId 指定要以那个平台子企业身份进行补充` \n",
|
1064
|
+
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateSignUrls\n<公共请求参数>\n\n{\n \"FlowGroupId\": \"yDCVAUUckpwa592pUxoLjOlRVS9Zgusf\",\n \"FlowGroupUrlInfo\": {\n \"FlowGroupApproverInfos\": [\n {\n \"FlowId\": \"yDCVAUUckpwa59rcUxoLjOlEctyesTzj\",\n \"RecipientId\": \"yDCVAUUckpwa59riUxoLjOluu9cf6B3s\"\n },\n {\n \"FlowId\": \"yDCVAUUckpwa592dUxoLjOl8StWKvg9K\",\n \"RecipientId\": \"yDCVAUUckpwa59r6UxoLjOlCC6ZHk7rL\"\n }\n ]\n },\n \"GenerateType\": \"RECIPIENT\",\n \"OrganizationOpenId\": \"dian_zi_qian\",\n \"Agent\": {\n \"ProxyOrganizationOpenId\": \"1000***8062\",\n \"ProxyOperator\": {\n \"OpenId\": \"yDR3L****eTdCt5TVx\"\n },\n \"AppId\": \"125***319\"\n }\n}",
|
1065
|
+
"output": "{\n \"Response\": {\n \"ErrorMessages\": [],\n \"RequestId\": \"s1735197391369377331\",\n \"SignUrlInfos\": [\n {\n \"ApproverType\": \"\",\n \"CustomUserId\": \"\",\n \"Deadline\": 0,\n \"FlowGroupId\": \"\",\n \"FlowId\": \"yDCVAUUckpwa592pUxoLjOlRVS9Zgusf\",\n \"IdCardNumber\": \"\",\n \"Mobile\": \"\",\n \"Name\": \"\",\n \"OpenId\": \"\",\n \"OrganizationName\": \"\",\n \"SignId\": \"\",\n \"SignOrder\": 0,\n \"SignQrcodeUrl\": \"https://file.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=5d92f0db15e6bbba6aea641f64c5c06d80c4246fb57d8a524d6bfe32b7434ba9f1xxxxxx1dc3aff08c747a658df2039a153bf6256b31d292522a4231\",\n \"SignUrl\": \"https://essurl.cn/pazAUBJ4vi\"\n }\n ]\n }\n}",
|
1066
|
+
"title": "获取合同组动态签署人补充链接, 并且预设平台子客企业OpenId"
|
1055
1067
|
}
|
1056
1068
|
],
|
1057
1069
|
"DeleteOrganizationAuthorizations": [
|
@@ -4601,7 +4601,7 @@
|
|
4601
4601
|
},
|
4602
4602
|
{
|
4603
4603
|
"disabled": false,
|
4604
|
-
"document": "类型。\n- 取值范围:\n01:身份证。 \n03 :中国护照。\n04 :军官证。\n05 :武警证。\n06:港澳通行证 。\n07 :台胞证 。\n08:外国护照 。\n09 :士兵证。\
|
4604
|
+
"document": "类型。\n- 取值范围:\n01:身份证。 \n03 :中国护照。\n04 :军官证。\n05 :武警证。\n06:港澳通行证 。\n07 :台胞证 。\n08:外国护照 。\n09 :士兵证。\n10 :临时身份证。\n11:户口本 。\n12 :警官证 。\n13:外国人永久居留证。\n14:港澳台居民居住证。\n15:回乡证。\n16:大陆居民来往台湾通行证。\n99:其他证件。\n注意:此字段可能返回 null,表示取不到有效值。",
|
4605
4605
|
"example": "01",
|
4606
4606
|
"member": "string",
|
4607
4607
|
"name": "IdType",
|
@@ -4661,8 +4661,8 @@
|
|
4661
4661
|
},
|
4662
4662
|
{
|
4663
4663
|
"disabled": false,
|
4664
|
-
"document": "旅行证件类的核验结果。\n- JSON格式如下:\n{\"result_issuer \":\"签发者证书合法性验证结果 \",\"result_pape r\":\"
|
4665
|
-
"example": "
|
4664
|
+
"document": "旅行证件类的核验结果。\n- JSON格式如下:\n{\"result_issuer \":\"签发者证书合法性验证结果 \",\"result_pape r\":\"证件安全对象合法性验证结果 \",\"result_data\" :\"防数据篡改验证结果 \",\"result_chip\" :\"防证书件芯片被复制验证结果\"} 。\n- 取值范围: 0:验证通过,1: 验证不通过,2: 未验证,3:部分通过,当4项核验结果都为0时,表示证件为真。\n注意:此字段可能返回 null,表示取不到有效值。",
|
4665
|
+
"example": "无",
|
4666
4666
|
"member": "string",
|
4667
4667
|
"name": "CheckMRTD",
|
4668
4668
|
"output_required": true,
|